### Get Available Roles Returns the roles a player can queue into the Looking For Group (LFG) system as. ```APIDOC ## GET /websites/wowprogramming/GetAvailableRoles ### Description Returns what roles the player is able to queue into the LFD system as. ### Method GET ### Endpoint /websites/wowprogramming/GetAvailableRoles ### Parameters (No parameters) ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **roles** (array) - A list of available roles (e.g., "Tank", "Healer", "DPS"). #### Response Example { "roles": ["Tank", "Healer"] } ``` -------------------------------- ### Camera Movement and Selection Functions to start and stop camera movement or selection actions. ```APIDOC ## CameraOrSelectOrMoveStart ### Description Begins camera movement or selection (equivalent to left-clicking in the 3-D world). ### Method Not specified (likely internal or event-driven) ### Endpoint Not specified ### Parameters None ### Request Example None ### Response None --- ## CameraOrSelectOrMoveStop ### Description Ends action initiated by `CameraOrSelectOrMoveStart`. ### Method Not specified (likely internal or event-driven) ### Endpoint Not specified ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### Tutorial Functions API Functions for managing contextual tutorials, including disabling, flagging, and resetting them. ```APIDOC ## ClearTutorials ### Description Disables contextual tutorial display. ### Method API ### Endpoint /websites/wowprogramming/tutorial/ClearTutorials ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if tutorials were cleared successfully. #### Response Example ```json { "success": true } ``` ## FlagTutorial ### Description Marks a contextual tutorial as displayed so it doesn't appear again. ### Method API ### Endpoint /websites/wowprogramming/tutorial/FlagTutorial ### Parameters #### Path Parameters None #### Query Parameters - **tutorialID** (string) - The ID of the tutorial to flag. #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the tutorial was flagged successfully. #### Response Example ```json { "success": true } ``` ## ResetTutorials ### Description Enables contextual tutorial display and clears the list of already displayed tutorials. ### Method API ### Endpoint /websites/wowprogramming/tutorial/ResetTutorials ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if tutorials were reset successfully. #### Response Example ```json { "success": true } ``` ``` -------------------------------- ### PvP Actions and Queueing Functions to initiate PvP actions, queue for battlegrounds, and manage PvP status. ```APIDOC ## PvP Actions and Queueing Endpoints ### Description These endpoints allow players to interact with PvP systems, including queueing for battlegrounds, managing PvP status, and performing zone exits. ### Endpoints - `POST /wow/pvp/queue` - `POST /wow/pvp/set` - `POST /wow/pvp/toggle` - `POST /wow/pvp/hearth` ### CanQueueForWintergrasp #### Description Returns whether the player can queue for Wintergrasp. #### Method GET #### Endpoint `/wow/wintergrasp/canQueue` #### Response ##### Success Response (200) - `canQueue` (boolean) - True if the player can queue for Wintergrasp. #### Response Example ```json { "canQueue": true } ``` ### SetPVP #### Description Enables or disables the player's desired PvP status. #### Method POST #### Endpoint `/wow/pvp/set` #### Request Body - **enabled** (boolean) - Required - Set to true to enable PvP, false to disable. #### Request Example ```json { "enabled": true } ``` #### Response ##### Success Response (200) - `status` (string) - "success" or "error". #### Response Example ```json { "status": "success" } ``` ### TogglePVP #### Description Switches the player's desired PvP status. #### Method POST #### Endpoint `/wow/pvp/toggle` #### Response ##### Success Response (200) - `status` (string) - "success" or "error". - `newState` (boolean) - The new PvP status (true for enabled, false for disabled). #### Response Example ```json { "status": "success", "newState": false } ``` ### CanHearthAndResurrectFromArea #### Description Returns whether the player is in a world PvP zone offering an exit option. #### Method GET #### Endpoint `/wow/pvp/exitArea/canHearth` #### Response ##### Success Response (200) - `canExit` (boolean) - True if the player can exit the current PvP zone. #### Response Example ```json { "canExit": true } ``` ### HearthAndResurrectFromArea #### Description Instantly exits the current world PvP zone, returning to the player's Hearthstone location. #### Method POST #### Endpoint `/wow/pvp/exitArea/hearth` #### Response ##### Success Response (200) - `status` (string) - "success" or "error". #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Get Faction Info By ID Retrieves information about a specific faction or header listing based on its ID. ```APIDOC ## GET /websites/wowprogramming/GetFactionInfoByID ### Description Returns information about a faction or header listing. ### Method GET ### Endpoint /websites/wowprogramming/GetFactionInfoByID ### Parameters #### Query Parameters - **factionID** (integer) - Required - The ID of the faction to retrieve information for. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **factionName** (string) - The name of the faction. - **isHeader** (boolean) - Indicates if this entry is a header. #### Response Example { "factionName": "Horde", "isHeader": false } ``` -------------------------------- ### Instance Management Functions Provides functions for managing and querying information about game instances, including difficulties, resets, and player status within instances. ```APIDOC ## Instance Management Functions ### CanShowResetInstances Returns whether the player can reset instances. ### Method GET ### Endpoint /websites/wowprogramming/instances/canShowResetInstances ### GetDungeonDifficulty Returns the 5 player selected dungeon difficulty. ### Method GET ### Endpoint /websites/wowprogramming/instances/getDungeonDifficulty ### GetInstanceBootTimeRemaining Returns the amount of time left until the player is removed from the current instance. ### Method GET ### Endpoint /websites/wowprogramming/instances/getInstanceBootTimeRemaining ### GetInstanceDifficulty Returns difficulty setting for the current dungeon/raid instance. ### Method GET ### Endpoint /websites/wowprogramming/instances/getInstanceDifficulty ### GetInstanceInfo Returns instance information about the current area. ### Method GET ### Endpoint /websites/wowprogramming/instances/getInstanceInfo ### GetInstanceLockTimeRemaining Returns time remaining before the player is saved to a recently entered instance. ### Method GET ### Endpoint /websites/wowprogramming/instances/getInstanceLockTimeRemaining ### GetNumSavedInstances Returns the number of instances to which the player is saved. ### Method GET ### Endpoint /websites/wowprogramming/instances/getNumSavedInstances ### GetNumWorldStateUI Returns the number of world state UI elements. ### Method GET ### Endpoint /websites/wowprogramming/instances/getNumWorldStateUI ### GetSavedInstanceInfo Returns information on a specific instance to which the player is saved. ### Method GET ### Endpoint /websites/wowprogramming/instances/getSavedInstanceInfo * **instanceID** (int) - Required - The ID of the instance to retrieve information for. ### GetWorldStateUIInfo Returns information about a world state UI element. ### Method GET ### Endpoint /websites/wowprogramming/instances/getWorldStateUIInfo * **uiID** (int) - Required - The ID of the world state UI element. ### IsInInstance Returns whether the player is in an instance (and its type if applicable). ### Method GET ### Endpoint /websites/wowprogramming/instances/isInInstance ### LFGTeleport Teleports the player to or from their current LFG dungeon. ### Method POST ### Endpoint /websites/wowprogramming/instances/lfgTeleport ### Request Example ```json { "teleportOut": true } ``` ### Request Body - **teleportOut** (boolean) - Required - Whether to teleport out of the dungeon. ### RequestRaidInfo Requests information about saved instances from the server. ### Method POST ### Endpoint /websites/wowprogramming/instances/requestRaidInfo * **server** (string) - Required - The server to request raid information from. ### ResetInstances Resets all non-saved instances associated with the player. ### Method POST ### Endpoint /websites/wowprogramming/instances/resetInstances ### RespondInstanceLock Allows leaving a recently entered instance to which the player would otherwise be saved. ### Method POST ### Endpoint /websites/wowprogramming/instances/respondInstanceLock ### SetDungeonDifficulty Sets the player's 5 player dungeon difficulty preference. ### Method POST ### Endpoint /websites/wowprogramming/instances/setDungeonDifficulty * **difficulty** (int) - Required - The desired dungeon difficulty. ### SetRaidDifficulty Sets the player's raid dungeon difficulty preference. ### Method POST ### Endpoint /websites/wowprogramming/instances/setRaidDifficulty * **difficulty** (int) - Required - The desired raid difficulty. ``` -------------------------------- ### Glyph Functions Functions related to glyphs, including getting links, socket information, and applying/removing glyphs. ```APIDOC ## Glyph Functions API ### GetGlyphLink #### Description Gets a hyperlink for the contents of a glyph socket. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ### GetGlyphSocketInfo #### Description Returns information about a glyph socket and its contents. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ### GetNumGlyphSockets #### Description Currently unused. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ### GlyphMatchesSocket #### Description Returns whether a socket is eligible for the glyph currently awaiting a target. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ### PlaceGlyphInSocket #### Description Applies the glyph currently awaiting a target to a socket. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ### RemoveGlyphFromSocket #### Description Removes the glyph from a socket. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ### SpellCanTargetGlyph #### Description Returns whether the spell currently awaiting a target requires a glyph slot to be chosen. ### Method Not specified (Likely a client-side function call) ### Endpoint N/A ``` -------------------------------- ### Battle.net Settings and Messaging Manage Battle.net settings and customize messages for friends. ```APIDOC ## Battle.net Settings and Messaging ### BNGetInfo Returns information about the player's RealID settings. ### Method GET ### Endpoint /battle.net/settings/info ### Response #### Success Response (200) - **settingsInfo** (object) - Information about RealID settings. ### BNGetMatureLanguageFilter Returns boolean for the Mature Language Filter option's state. ### Method GET ### Endpoint /battle.net/settings/mature-language-filter ### Response #### Success Response (200) - **filterEnabled** (boolean) - True if the filter is enabled, false otherwise. ### BNSetCustomMessage Sets the player's current RealID broadcast message. ### Method POST ### Endpoint /battle.net/settings/custom-message ### Parameters #### Request Body - **message** (string) - Required - The custom message to set. ### Request Example ```json { "message": "Hello everyone!" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates success or failure. ### BNSetFriendNote Changes the private note for a RealID friend. ### Method PUT ### Endpoint /battle.net/friend/note ### Parameters #### Request Body - **friendId** (string) - Required - The ID of the friend. - **note** (string) - Required - The new private note. ### Request Example ```json { "friendId": "user123", "note": "This is a good friend." } ``` ### Response #### Success Response (200) - **status** (string) - Indicates success or failure. ### BNSetMatureLanguageFilter Sets the Mature Language Filter option. ### Method PUT ### Endpoint /battle.net/settings/mature-language-filter ### Parameters #### Request Body - **enabled** (boolean) - Required - True to enable the filter, false to disable. ### Request Example ```json { "enabled": true } ``` ### Response #### Success Response (200) - **status** (string) - Indicates success or failure. ``` -------------------------------- ### Get Instance Lock Time Remaining Encounter Retrieves the remaining lock time for a specific encounter within an instance. ```APIDOC ## GET /websites/wowprogramming/GetInstanceLockTimeRemainingEncounter ### Description _This function is not yet documented_ ### Method GET ### Endpoint /websites/wowprogramming/GetInstanceLockTimeRemainingEncounter ### Parameters (No parameters specified as the function is undocumented) ### Request Example (No request body for GET requests) ### Response #### Success Response (200) (Response details not available as the function is undocumented) #### Response Example (Response example not available as the function is undocumented) ``` -------------------------------- ### Battleground Queueing Functions related to joining, leaving, and managing battleground queues. ```APIDOC ## POST /battlefield/join ### Description Joins the queue for a battleground instance. ### Method POST ### Endpoint /battlefield/join ### Parameters #### Request Body - **battlegroundId** (string) - Required - The ID of the battleground to join. ### Request Example ```json { "example": { "battlegroundId": "warsong_gulch" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating successful queue join. #### Response Example ```json { "example": { "message": "Successfully joined the queue for Warsong Gulch." } } ``` ``` ```APIDOC ## POST /battlefield/leave ### Description Immediately exits the current battleground instance. ### Method POST ### Endpoint /battlefield/leave ### Parameters None ### Request Example ```json { "example": "POST /battlefield/leave" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating successful exit from the battleground. #### Response Example ```json { "example": { "message": "Successfully left the current battleground." } } ``` ``` ```APIDOC ## POST /battlefield/group/join ### Description Returns whether the battleground for which the player is queueing supports joining as a group. ### Method POST ### Endpoint /battlefield/group/join ### Parameters #### Request Body - **battlegroundId** (string) - Required - The ID of the battleground to check. ### Request Example ```json { "example": { "battlegroundId": "arathi_basin" } } ``` ### Response #### Success Response (200) - **supportsGroupJoin** (boolean) - True if the battleground supports group joins, false otherwise. #### Response Example ```json { "example": { "supportsGroupJoin": true } } ``` ``` ```APIDOC ## POST /battlefield/port/accept ### Description Accepts the offered teleport to a battleground/arena or leaves the battleground/arena or queue. ### Method POST ### Endpoint /battlefield/port/accept ### Parameters #### Request Body - **action** (string) - Required - The action to perform ('accept' or 'leave'). ### Request Example ```json { "example": { "action": "accept" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of the action performed. #### Response Example ```json { "example": { "message": "Teleport accepted." } } ``` ``` ```APIDOC ## POST /battlefield/port/decline ### Description Declines the next upcoming periodic resurrection from a battleground spirit healer. ### Method POST ### Endpoint /battlefield/port/decline ### Parameters None ### Request Example ```json { "example": "POST /battlefield/port/decline" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the spirit healer resurrection has been declined. #### Response Example ```json { "example": { "message": "Periodic resurrection declined." } } ``` ``` ```APIDOC ## POST /battlefield/close ### Description Ends interaction with the battleground queueing UI. ### Method POST ### Endpoint /battlefield/close ### Parameters None ### Request Example ```json { "example": "POST /battlefield/close" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the UI has been closed. #### Response Example ```json { "example": { "message": "Battleground UI closed." } } ``` ``` -------------------------------- ### Battleground and Wintergrasp Specifics Functions related to battleground honor, Wintergrasp wait times, and world PvP queues. ```APIDOC ## Battleground and Wintergrasp Specifics Endpoints ### Description This section covers endpoints specifically for battleground honor calculations, Wintergrasp queueing and wait times, and world PvP queue status. ### Endpoints - `GET /wow/bg/honor/bonuses` - `GET /wow/wintergrasp/waitTime` - `GET /wow/pvp/worldQueue` ### GetHolidayBGHonorCurrencyBonuses #### Description Returns the awarded honor and arena points for a Call to Arms battleground win or loss. #### Method GET #### Endpoint `/wow/bg/honor/bonuses` #### Query Parameters - **bgType** (string) - Optional - The type of battleground (e.g., "CallToArms"). #### Response ##### Success Response (200) - `honorAwarded` (integer) - Honor points awarded. - `arenaPointsAwarded` (integer) - Arena points awarded. #### Response Example ```json { "honorAwarded": 500, "arenaPointsAwarded": 150 } ``` ### GetWintergraspWaitTime #### Description Returns the amount of time remaining until the next PvP event in the Wintergrasp zone. #### Method GET #### Endpoint `/wow/wintergrasp/waitTime` #### Response ##### Success Response (200) - `timeLeft` (integer) - Time remaining in seconds until the next Wintergrasp event. #### Response Example ```json { "timeLeft": 1800 } ``` ### GetWorldPVPQueueStatus #### Description Returns information on the players queue for a world PvP zone. #### Method GET #### Endpoint `/wow/pvp/worldQueue/status` #### Response ##### Success Response (200) - `inQueue` (boolean) - True if the player is currently in a world PvP queue. - `queuePosition` (integer) - The player's position in the queue (if applicable). - `estimatedWaitTime` (integer) - Estimated wait time in seconds (if applicable). #### Response Example ```json { "inQueue": true, "queuePosition": 5, "estimatedWaitTime": 600 } ``` ``` -------------------------------- ### Questgiver Interaction API Endpoints for interacting with questgivers, including getting quest text, selecting quests, and checking quest completion. ```APIDOC ## GetQuestMoneyToGet /websites/wowprogramming ### Description Returns the amount of money required to complete the quest presented by a questgiver. ### Method GET ### Endpoint /websites/wowprogramming/GetQuestMoneyToGet ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **moneyRequired** (number) - The amount of money required. #### Response Example { "moneyRequired": 50 } ## GetQuestText /websites/wowprogramming ### Description Returns the text for the quest offered by a questgiver. ### Method GET ### Endpoint /websites/wowprogramming/GetQuestText ### Parameters #### Path Parameters None #### Query Parameters - **questID** (number) - The ID of the quest. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **questText** (string) - The text of the quest. #### Response Example { "questText": "Bring me 5 wolf pelts." } ## GetSuggestedGroupNum /websites/wowprogramming ### Description Returns the suggested group size for attempting the quest currently offered by a questgiver. ### Method GET ### Endpoint /websites/wowprogramming/GetSuggestedGroupNum ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **suggestedGroupSize** (number) - The recommended number of players for the quest. #### Response Example { "suggestedGroupSize": 5 } ## GetTitleText /websites/wowprogramming ### Description Returns the title text for the quest presented by a questgiver. ### Method GET ### Endpoint /websites/wowprogramming/GetTitleText ### Parameters #### Path Parameters None #### Query Parameters - **questID** (number) - The ID of the quest. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **titleText** (string) - The title of the quest. #### Response Example { "titleText": "The Orcish Menace" } ## IsAvailableQuestTrivial /websites/wowprogramming ### Description Returns whether a quest available from the current Quest NPC is trivial at the player's level. ### Method GET ### Endpoint /websites/wowprogramming/IsAvailableQuestTrivial ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **isTrivial** (boolean) - True if the quest is trivial, false otherwise. #### Response Example { "isTrivial": false } ## SelectActiveQuest /websites/wowprogramming ### Description Selects a quest which can be turned in to the current Quest NPC. ### Method POST ### Endpoint /websites/wowprogramming/SelectActiveQuest ### Parameters #### Path Parameters None #### Query Parameters - **questID** (number) - The ID of the quest to select for turn-in. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - True if the quest was successfully selected. #### Response Example { "success": true } ## SelectAvailableQuest /websites/wowprogramming ### Description Chooses a quest available from the current Quest NPC. ### Method POST ### Endpoint /websites/wowprogramming/SelectAvailableQuest ### Parameters #### Path Parameters None #### Query Parameters - **questID** (number) - The ID of the quest to accept. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - True if the quest was ``` -------------------------------- ### Keybind Functions Manages keybindings for actions, spells, items, and macros, including setting, clearing, and retrieving binding information. ```APIDOC ## Keybind Functions API ### Description This API group provides functions for managing and querying keybindings, allowing users to associate keyboard shortcuts with various in-game actions. ### Endpoints #### ClearOverrideBindings - **Description**: Clears any registered override bindings for a specified owner. - **Method**: (Not specified, likely a function call within a script) #### GetBinding - **Description**: Retrieves information about a specific key binding. - **Method**: (Not specified, likely a function call within a script) #### GetBindingAction - **Description**: Returns the action associated with a key or key combination. - **Method**: (Not specified, likely a function call within a script) #### GetBindingByKey - **Description**: Returns the action bound to a given key or key combination. - **Method**: (Not specified, likely a function call within a script) #### GetBindingKey - **Description**: Returns the key combinations assigned to a given binding command. - **Method**: (Not specified, likely a function call within a script) #### GetCurrentBindingSet - **Description**: Returns the identifier for the key binding set currently in use. - **Method**: (Not specified, likely a function call within a script) #### GetNumBindings - **Description**: Returns the total number of entries in the key bindings list. - **Method**: (Not specified, likely a function call within a script) #### LoadBindings - **Description**: Loads a specified set of key bindings. - **Method**: (Not specified, likely a function call within a script) #### RunBinding - **Description**: Executes the script associated with a key binding action. - **Method**: (Not specified, likely a function call within a script) #### SaveBindings - **Description**: Saves the current set of key bindings. - **Method**: (Not specified, likely a function call within a script) #### SetBinding - **Description**: Binds a key combination to a specified binding command. - **Method**: (Not specified, likely a function call within a script) #### SetBindingClick - **Description**: Binds a key combination to perform a 'click' action on a Button object. - **Method**: (Not specified, likely a function call within a script) #### SetBindingItem - **Description**: Binds a key combination to use an item from the player's inventory. - **Method**: (Not specified, likely a function call within a script) #### SetBindingMacro - **Description**: Binds a key combination to execute a macro. - **Method**: (Not specified, likely a function call within a script) #### SetBindingSpell - **Description**: Binds a key combination to cast a specific spell. - **Method**: (Not specified, likely a function call within a script) #### SetMouselookOverrideBinding - **Description**: Overrides default mouselook bindings to perform another binding action using mouse buttons. - **Method**: (Not specified, likely a function call within a script) #### SetOverrideBinding - **Description**: Sets an override binding for a given binding command. - **Method**: (Not specified, likely a function call within a script) #### SetOverrideBindingClick - **Description**: Sets an override binding to perform a 'click' action on a Button object. - **Method**: (Not specified, likely a function call within a script) #### SetOverrideBindingItem - **Description**: Sets an override binding to use an item from the player's inventory. - **Method**: (Not specified, likely a function call within a script) #### SetOverrideBindingMacro - **Description**: Sets an override binding to execute a macro. - **Method**: (Not specified, likely a function call within a script) #### SetOverrideBindingSpell - **Description**: Sets an override binding to cast a specific spell. - **Method**: (Not specified, likely a function call within a script) ``` -------------------------------- ### Predefined and Saved Views Functions for navigating between predefined camera views and managing saved views. ```APIDOC ## NextView ### Description Moves the camera to the next predefined setting. ### Method Not specified ### Endpoint Not specified ### Parameters None ### Request Example None ### Response None --- ## PrevView ### Description Moves the camera to the previous predefined setting. ### Method Not specified ### Endpoint Not specified ### Parameters None ### Request Example None ### Response None --- ## ResetView ### Description Resets a saved camera setting to default values. ### Method Not specified ### Endpoint Not specified ### Parameters * **viewName** (string) - Optional - The name of the saved view to reset. ### Request Example None ### Response None --- ## SaveView ### Description Saves the current camera settings. ### Method Not specified ### Endpoint Not specified ### Parameters * **viewName** (string) - Required - The name to save the current view as. ### Request Example None ### Response None --- ## SetView ### Description Moves the camera to a saved camera setting. ### Method Not specified ### Endpoint Not specified ### Parameters * **viewName** (string) - Required - The name of the saved view to set. ### Request Example None ### Response None ``` -------------------------------- ### Knowledge Base Functions API This section details functions for interacting with the knowledge base, including loading articles, querying for information, and setting up KB data. ```APIDOC ## Knowledge Base Functions ### KBArticle_BeginLoading #### Description Requests a specific knowledge base article from the server. #### Parameters ##### Query Parameters - **server** (string) - Optional - The server to request the article from. #### Method GET #### Endpoint /websites/wowprogramming/kb/article/load ### KBArticle_GetData #### Description Returns information about the last requested knowledge base article. #### Method GET #### Endpoint /websites/wowprogramming/kb/article/data ### KBArticle_IsLoaded #### Description Returns whether the requested knowledge base article has been loaded. #### Method GET #### Endpoint /websites/wowprogramming/kb/article/loaded ### KBQuery_BeginLoading #### Description Queries the knowledge base server for articles. #### Parameters ##### Query Parameters - **server** (string) - Optional - The server to query. #### Method GET #### Endpoint /websites/wowprogramming/kb/query/load ### KBQuery_GetArticleHeaderCount #### Description Returns the number of articles on the current knowledge base search result page. #### Method GET #### Endpoint /websites/wowprogramming/kb/query/article_headers/count ### KBQuery_GetArticleHeaderData #### Description Returns information about an article returned in a knowledge base query. #### Method GET #### Endpoint /websites/wowprogramming/kb/query/article_headers/data ### KBQuery_GetTotalArticleCount #### Description Returns the total number of articles returned for the given query. #### Method GET #### Endpoint /websites/wowprogramming/kb/query/total_articles/count ### KBQuery_IsLoaded #### Description Returns whether results of a knowledge base query have been loaded. #### Method GET #### Endpoint /websites/wowprogramming/kb/query/loaded ### KBSetup_BeginLoading #### Description Loads a maximum number of "Top Issues" from a given page. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/load ### KBSetup_GetArticleHeaderCount #### Description Returns the number of "Top Issues" articles on the current page. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/article_headers/count ### KBSetup_GetArticleHeaderData #### Description Returns header information about a "Top Issue" article. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/article_headers/data ### KBSetup_GetCategoryCount #### Description Returns the number of available knowledge base categories. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/categories/count ### KBSetup_GetCategoryData #### Description Returns information about a knowledge base category. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/categories/data ### KBSetup_GetLanguageCount #### Description Returns the number of available knowledge base languages. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/languages/count ### KBSetup_GetLanguageData #### Description Returns information about a given knowledge base language. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/languages/data ### KBSetup_GetSubCategoryCount #### Description Returns the number of available subcategories for a given category. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/subcategories/count ### KBSetup_GetSubCategoryData #### Description Returns information a knowledge base subcategory. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/subcategories/data ### KBSetup_GetTotalArticleCount #### Description Returns the number of "Top Issues" articles. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/total_articles/count ### KBSetup_IsLoaded #### Description Returns whether the knowledge base default query has completed successfully. #### Method GET #### Endpoint /websites/wowprogramming/kb/setup/loaded ### KBSystem_GetMOTD #### Description Returns the currently knowledge base MOTD. #### Method GET #### Endpoint /websites/wowprogramming/kb/system/motd ### KBSystem_GetServerNotice #### Description Returns the text of the knowledge base server system notice. #### Method GET #### Endpoint /websites/wowprogramming/kb/system/server_notice ### KBSystem_GetServerStatus #### Description Returns the knowledge base server system status message. #### Method GET #### Endpoint /websites/wowprogramming/kb/system/server_status ``` -------------------------------- ### Utility Functions Miscellaneous utility functions, including mouse detection and creation of UI elements. ```APIDOC ## DetectWowMouse /websites/wowprogramming ### Description Detects the presence of a "WoW" compatible multi-button mouse. ### Method Not specified (likely a client-side function, no HTTP method applicable). ### Endpoint N/A ### Parameters None specified. ### Request Example N/A ### Response None specified. ``` ```APIDOC ## newproxy /websites/wowprogramming ### Description Creates a zero-length userdata with an optional metatable. ### Method Not specified (likely a client-side function, no HTTP method applicable). ### Endpoint N/A ### Parameters None specified. ### Request Example N/A ### Response None specified. ``` -------------------------------- ### UI/Visual Functions API Functions for interacting with the game's UI, including console messages, screen scaling, and visibility of player cloak and helm. ```APIDOC ## ConsoleAddMessage ### Description Prints text to the debug console. ### Method API ### Endpoint /websites/wowprogramming/ui/ConsoleAddMessage ### Parameters #### Path Parameters None #### Query Parameters - **message** (string) - The message to print to the console. #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the message was added successfully. #### Response Example ```json { "success": true } ``` ## ConsoleExec ### Description Runs a console command. ### Method API ### Endpoint /websites/wowprogramming/ui/ConsoleExec ### Parameters #### Path Parameters None #### Query Parameters - **command** (string) - The console command to execute. #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the command executed successfully. #### Response Example ```json { "success": true } ``` ## SetupFullscreenScale ### Description Sizes a frame to take up the entire screen regardless of screen resolution. ### Method API ### Endpoint /websites/wowprogramming/ui/SetupFullscreenScale ### Parameters #### Path Parameters None #### Query Parameters - **frameName** (string) - The name of the frame to scale. #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the frame scaling was set up successfully. #### Response Example ```json { "success": true } ``` ## ShowCloak ### Description Enables or disables display of the player's cloak. ### Method API ### Endpoint /websites/wowprogramming/ui/ShowCloak ### Parameters #### Path Parameters None #### Query Parameters - **show** (boolean) - True to show the cloak, false to hide it. #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the cloak visibility was set successfully. #### Response Example ```json { "success": true } ``` ## ShowHelm ### Description Enables or disables display of the player's headgear. ### Method API ### Endpoint /websites/wowprogramming/ui/ShowHelm ### Parameters #### Path Parameters None #### Query Parameters - **show** (boolean) - True to show the helm, false to hide it. #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the helm visibility was set successfully. #### Response Example ```json { "success": true } ``` ## ShowingCloak ### Description Returns whether the player's cloak is displayed. ### Method API ### Endpoint /websites/wowprogramming/ui/ShowingCloak ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **isShowing** (boolean) - True if the cloak is displayed, false otherwise. #### Response Example ```json { "isShowing": true } ``` ## ShowingHelm ### Description Returns whether the player's headgear is displayed. ### Method API ### Endpoint /websites/wowprogramming/ui/ShowingHelm ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **isShowing** (boolean) - True if the helm is displayed, false otherwise. #### Response Example ```json { "isShowing": true } ``` ```