No edit summary |
|||
| Line 1: | Line 1: | ||
| + | {{questbox |
||
| − | {{wowapi}} {{tocright}} |
||
| + | | name= To Legion Hold |
||
| − | The '''World of Warcraft API''', or '''WoW API''', is a set of functions provided by Blizzard to interact with and modify the ''World of Warcraft'' interface and behavior through the use of addons and macros. The list of functions below is incomplete and kept up to date by user contributions; you may also be interested in [[Global functions|an automatically-generated exhaustive list]] of all API functions present in the latest live client. |
||
| + | | faction= Alliance |
||
| + | | level= 69 |
||
| + | | levelreq = 67 |
||
| + | | type= |
||
| + | | category = Shadowmoon Valley |
||
| + | | start = [[Wing Commander Nuainn]] |
||
| + | | end = |
||
| + | | experience = 12300 ({{cost|7|38}} at level 70) |
||
| + | | rewards = |
||
| + | | reputation = |
||
| + | | previous = {{questlong|alliance|69|Besieged! (Alliance)|Besieged!}} |
||
| + | | next = {{questlong|alliance|69|Setting Up the Bomb (Alliance)|Setting Up the Bomb}} |
||
| + | | id = 10563 |
||
| + | }} |
||
| + | == Objectives == |
||
| + | Make your way to Legion Hold and locate the Legion Communication Device. While standing near the communication device, use your disguise and learn about the Legion's plans. Return to Wing Commander Nuainn at Wildhammer Stronghold when you've completed your mission. |
||
| + | *Discover Legion's Plans |
||
| + | {{item|Box o' Tricks||icon=}} (Provided) |
||
| + | == Description == |
||
| − | If you're considering contributing documentation, please read '''[[Wowpedia:How to edit API pages|How to edit API pages]]'''. In summary: update this page (and the linked pages) as needed, discuss any large-scale changes on the [[Talk:World of Warcraft API|{{discussiontab}} page]], and do not create ''empty'' stub pages. |
||
| + | The fortress of Legion Hold is nigh impregnable, and to be completely honest, I can't spare the forces for an assault. Our hopes are riding on you, <name>. |
||
| − | If you need help reading the documentation, see [[Wowpedia:API notation and conventions|API notation and conventions]]. You can also [[HOWTO: View Blizzard's Interface Code|examine the existing UI code]] to find examples of how the various functions are used by the default UI. Function names could be prefixed with the following tags: |
||
| − | * '''PROTECTED''' - This function can only be called from [[secure code]]. See the [[:Category:World of Warcraft API/Protected Functions|Protected Functions]] category. |
||
| − | ** '''NOCOMBAT''' - This function cannot be called from insecure code while in combat. |
||
| − | * '''HW''' - This function may only be called in response to a hardware event (from OnClick handlers). |
||
| − | * '''UI''' - This function is implemented in Lua (in [[:Category:FrameXML documentation|FrameXML]]) but was considered important enough to appear here. |
||
| − | * '''REMOVED''' - This function has been removed from the World of Warcraft API (and should also be removed from this list). For historical purposes, see the [[:Category:World of Warcraft API/Removed Functions|Removed Functions]] category. |
||
| + | What little information we've been able to gather indicates that the Legion stocks and prepares its infernals at the hold. With the help of a disguise I'll give you, you must sneak into Legion Hold and learn about the their plans. Your best hope is to intercept or overhear communication between their commanders. Good luck, <name>. |
||
| − | == Global Function Groups == |
||
| − | === Account Functions === |
||
| − | : [[API GetAccountExpansionLevel|GetAccountExpansionLevel]]() - Returns index of registered expansion. (0=WoW, 1=BC, 2=WotLK) |
||
| − | These functions only return meaningful values on Asian realms; all three relate to the play time limitation system. |
||
| − | : [[API GetBillingTimeRested|GetBillingTimeRested]]() - returns the time spent logged in in current billing unit. |
||
| − | : [[API PartialPlayTime|PartialPlayTime]]() - returns 1 if the player is currently "tired": reduced XP, loot. |
||
| − | : [[API NoPlayTime|NoPlayTime]]() - returns 1 if the player is currently "unhealthy": no XP, loot. |
||
| − | + | == Rewards == |
|
| + | You will receive: {{cost|4|10}} |
||
| − | These functions are only available in [[Patch 3.0]]. |
||
| + | == Progress == |
||
| − | : [[API AddTrackedAchievement|AddTrackedAchievement]](achievementId) - Add an achievement to tracking. |
||
| + | What did you discover? |
||
| − | : [[API CanShowAchievementUI|CanShowAchievementUI]]() - Returns if the AchievementUI can be displayed |
||
| − | : [[API ClearAchievementComparisonUnit|ClearAchievementComparisonUnit]]() - Remove the unit being compared. |
||
| − | : [[API GetAchievementCategory|GetAchievementCategory]](achievementID) - Return the category number the requested achievement belongs to. |
||
| − | : [[API GetAchievementComparisonInfo|GetAchievementComparisonInfo]](achievementID, comparisonNum) - Return the status of the achievement for the comparison player. |
||
| − | : [[API GetAchievementCriteriaInfo|GetAchievementCriteriaInfo]](achievementID, criteriaNum) - Return information about the requested criteria. |
||
| − | : [[API GetAchievementInfo|GetAchievementInfo]]((achievementID) or (category, offset) - Return information about the requested Achievement. |
||
| − | : [[API GetAchievementInfoFromCriteria|GetAchievementInfoFromCriteria]](id) - Return information about the requested Achievement. |
||
| − | : [[API GetAchievementLink|GetAchievementLink]](achievementID) - Returns a [[achievementLink]] for the specified Achievement. |
||
| − | : [[API GetAchievementNumCriteria|GetAchievementNumCriteria]](achievementID) - Return the number of criteria the requested Achievement has. |
||
| − | : [[API GetAchievementNumRewards|GetAchievementNumRewards]](achievementID) - Return the number of rewards the requested Achievement has. |
||
| − | : [[API GetCategoryInfo|GetCategoryInfo]](category) - Return information about the requested category |
||
| − | : [[API GetCategoryList|GetCategoryList]]() - Returns the list of Achievement categories. |
||
| − | : [[API GetCategoryNumAchievements|GetCategoryNumAchievements]](category) - Return the number of Achievements, and number completed for the specific category. |
||
| − | : [[API GetComparisonAchievementPoints|GetComparisonAchievementPoints]]() - Return the total number of achievement points the comparison unit has earned. |
||
| − | : [[API GetComparisonCategoryNumAchievements|GetComparisonCategoryNumAchievements]](achievementID) |
||
| − | : [[API GetComparisonStatistic|GetComparisonStatistic]](achievementID) - Return the value of the requested statistic for the comparison player. |
||
| − | : [[API GetLatestCompletedAchievements|GetLatestCompletedAchievements]]() - Return the ID's of the last 5 completed Achievements. |
||
| − | : [[API GetLatestCompletedComparisonAchievements|GetLatestCompletedComparisonAchievements]]() |
||
| − | : [[API GetLatestUpdatedComparisonStats|GetLatestUpdatedComparisonStats]]() |
||
| − | : [[API GetLatestUpdatedStats|GetLatestUpdatedStats]]() - Return the ID's of the last 5 updated Statistics. |
||
| − | : [[API GetNextAchievement|GetNextAchievement]](achievementID) |
||
| − | : [[API GetNumComparisonCompletedAchievements|GetNumComparisonCompletedAchievements]]() |
||
| − | : [[API GetNumCompletedAchievements|GetNumCompletedAchievements]]() - Return the total number of Achievements, and number completed. |
||
| − | : [[API GetPreviousAchievement|GetPreviousAchievement]](achievementID) - Return previous related achievements. |
||
| − | : [[API GetStatistic|GetStatistic]](achievementID) - Return the value of the requested statistic. |
||
| − | : [[API GetStatisticsCategoryList|GetStatisticsCategoryList]]() - Returns the list of Statistic categories. |
||
| − | : [[API GetTotalAchievementPoints|GetTotalAchievementPoints]]() - Return the total number of achievement points earned. |
||
| − | : [[API GetTrackedAchievements|GetTrackedAchievements]]() - Return the AchievementID of the currently tracked achievements |
||
| − | : [[API GetNumTrackedAchievements|GetNumTrackedAchievements]]() - Return the total number of the currently tracked achievements |
||
| − | : [[API RemoveTrackedAchievement|RemoveTrackedAchievement]](achievementID) - Stops an achievement from being tracked |
||
| − | : [[API SetAchievementComparisonUnit|SetAchievementComparisonUnit]](unitId) - Set the unit to be compared to. |
||
| − | + | == Completion == |
|
| + | <Wing Commander Nuainn listens to your report, growing more alarmed with each sentence.> |
||
| − | These functions are those which operate with the action buttons (General player actions are likely in the [[#Activity Functions|Activity Functions]] section below). |
||
| − | : PROTECTED UI [[API ActionButtonDown|ActionButtonDown]](id) - Press the specified action button. (2.0 Protected) |
||
| − | : PROTECTED UI [[API ActionButtonUp|ActionButtonUp]](id) - Release the specified action button. (2.0 Protected) |
||
| − | : [[API ActionHasRange|ActionHasRange]](slot) - Determine if the specified action is a range restriction (1 if yes, nil if no) |
||
| − | : UI [[API BonusActionButtonDown|BonusActionButtonDown]] - Trigger the specified bonus(pet or minion) action button. |
||
| − | : UI [[API BonusActionButtonUp|BonusActionButtonUp]] - Release the specified bonus(pet or minion) action button. |
||
| − | : PROTECTED [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]]([stickyFlag]) - End "Left click" in the 3D world. (1.10 - Protected) |
||
| − | : NOCOMBAT [[API ChangeActionBarPage|ChangeActionBarPage]](page) - Changes the current action bar page. |
||
| − | : [[API GetActionBarPage|GetActionBarPage]]() - Return the current action bar page. CURRENT_ACTIONBAR_PAGE is obsolete. |
||
| − | : [[API GetActionBarToggles|GetActionBarToggles]]() - Return the toggles for each action bar. |
||
| − | : [[API GetActionCooldown|GetActionCooldown]](slot) - This returns the cooldown values of the specified action.. |
||
| − | : [[API GetActionCount|GetActionCount]](slot) - Get the count (bandage/potion/etc) for an action, returns 0 if none or not applicable. |
||
| − | : [[API GetActionInfo|GetActionInfo]](slot) - Returns type, id, subtype. |
||
| − | : [[API GetActionText|GetActionText]](slot) - Get the text label (macros, etc) for an action, returns nil if none. |
||
| − | : [[API GetActionTexture|GetActionTexture]](slot) - Gets the texture path for the specified action. |
||
| − | : [[API GetBonusBarOffset|GetBonusBarOffset]]() - Determine which page of bonus actions to show. |
||
| − | : [[API GetMouseButtonClicked|GetMouseButtonClicked]]() -Returns the name of the button that triggered a mouse down/up/click/doubleclick event. (NEW 2.0.3) |
||
| − | : [[API GetMultiCastBarOffset|GetMultiCastBarOffset]]() - Returns the page offset of the multicast action IDs (NEW in 3.2) |
||
| − | : [[API GetPossessInfo|GetPossessInfo]](index) - Returns texture, name, enabled. |
||
| − | : [[API HasAction|HasAction]](slot) - Returns 1 if the player has an action in the specified slot, nil otherwise. |
||
| − | : [[API IsActionInRange|IsActionInRange]](slot,[unit]) - Test if an action is in range (1=yes, 0=no, nil=not applicable). |
||
| − | : [[API IsAttackAction|IsAttackAction]](slot) - Return 1 if an action is an 'attack' action (flashes during combat), nil otherwise. |
||
| − | : [[API IsAutoRepeatAction|IsAutoRepeatAction]](slot) - Return 1 if an action is auto-repeating, nil otherwise. |
||
| − | : [[API IsCurrentAction|IsCurrentAction]](slot) - Return 1 if an action is the one currently underway, nil otherwise. |
||
| − | : [[API IsConsumableAction|IsConsumableAction]](slot) - Return 1 if an action is consumable (i.e. has a count), nil otherwise. |
||
| − | : [[API IsEquippedAction|IsEquippedAction]](slot) - Return 1 if an action is equipped (i.e. connected to an item that must be equipped), nil otherwise. |
||
| − | : [[API IsUsableAction|IsUsableAction]](slot) - Return 1 if an action can be used at present, nil otherwise. |
||
| − | : [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar. |
||
| − | : NOCOMBAT [[API PickupAction|PickupAction]](slot) - Drags an action out of the specified quickbar slot and holds it on the cursor. |
||
| − | : NOCOMBAT [[API PickupPetAction|PickupPetAction]](slot) - Drags an action from the specified pet action bar slot into the cursor. |
||
| − | : [[API PlaceAction|PlaceAction]](slot) - Drops an action from the cursor into the specified quickbar slot. |
||
| − | : [[API SetActionBarToggles|SetActionBarToggles]](show1,show2,show3,show4[, alwaysShow]) - Set show toggle for each action bar - 'alwaysShow' added in 1.12 |
||
| − | : [[API StopAttack|StopAttack]]() - Turns off auto-attack, if currently active. Has no effect is the player does not currently have auto-attack active. |
||
| − | : PROTECTED [[API TurnOrActionStart|TurnOrActionStart]]() - Begin "Right Click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API TurnOrActionStop|TurnOrActionStop]]() - End "Right Click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API UseAction|UseAction]](slot[, checkCursor[, onSelf]]) - This instructs the interface to use the action associated with the specified ID, optionally on the player (regardless of target)(2.0 - Protected). |
||
| + | So you're saying they have more than enough infernals to intensify the bombardment? If we don't stop them before they can put the next phase of their plan into motion, Wildhammer Stronghold is finished. |
||
| − | === Activity Functions === |
||
| − | This section is for functions which make the player do something (and which aren't covered elsewhere, and which aren't simply confirmation steps) |
||
| + | == Gains == |
||
| − | : [[API AcceptDuel|AcceptDuel]]() - The player accepts the challenge to duel. |
||
| + | Upon completion of this quest you will gain: |
||
| − | : PROTECTED [[API AttackTarget|AttackTarget]]() - Attacks the targetted unit. |
||
| + | *12300 [[experience]] (or {{cost|7|38}} at level 70) |
||
| − | : [[API CancelDuel|CancelDuel]]() - Refuse the invitation to fight a duel. |
||
| − | : [[API CancelLogout|CancelLogout]]() - Cancels the logout timer (from camping or quitting). |
||
| − | : [[API ClearTutorials|ClearTutorials]]() |
||
| − | : [[API CancelSummon|CancelSummon]]() - Rejects a summon request. |
||
| − | : [[API ConfirmSummon|ConfirmSummon]]() - Accepts a summon request. |
||
| − | : PROTECTED [[API DescendStop|DescendStop]]() - The player stops descending (while swimming or flying) ''-- added in 2.1'' |
||
| − | : [[API Dismount|Dismount]]() - The player dismounts the current mount. ''-- added in 2.0.3'' |
||
| − | : [[API FlagTutorial|FlagTutorial]]("tutorial") |
||
| − | : [[API ForceQuit|ForceQuit]]() - Instantly quits the game, bypassing the timer. |
||
| − | : [[API GetPVPTimer|GetPVPTimer]]() - Returns the amount of time until your PvP flag fades. |
||
| − | : [[API GetSummonConfirmAreaName|GetSummonConfirmAreaName]]() - Returns the name of the area you're being summoned to. |
||
| − | : [[API GetSummonConfirmSummoner|GetSummonConfirmSummoner]]() - Returns the name of the player summoning you. |
||
| − | : [[API GetSummonConfirmTimeLeft|GetSummonConfirmTimeLeft]]() - Returns the amount of time left before the pending summon expires. |
||
| − | : [[API Logout|Logout]] - Logs the user out of the game. |
||
| − | : [[API Quit|Quit]] - Quits the game, '''not''' the Lua script. |
||
| − | : [[API RandomRoll|RandomRoll]](low, high) - Does a random roll between the two values. |
||
| − | : [[API SetPVP|SetPVP]](arg1) - Sets the players PVP mode (1 to enable, nil to toggle off eventually) |
||
| − | : PROTECTED [[API SitStandOrDescendStart|SitStandOrDescendStart]]() - The player sits, stands, or descends ''-- added in 2.1'' |
||
| − | : PROTECTED [[API StartDuel|StartDuel]]("name") - Challenge someone to a duel (by name) ''-- protected in 2.0'' |
||
| − | : [[API TogglePVP|TogglePVP]]() - Toggles PVP status |
||
| − | : [[API ToggleSheath|ToggleSheath]]() - Toggles sheathed or unsheathed weapons. |
||
| − | : [[API UseSoulstone|UseSoulstone]]() - Use an active soulstone to resurrect yourself after death. Also works for Shamans with Reincarnation available. |
||
| − | + | == Quest progression == |
|
| + | {{Besieged!}} |
||
| − | : [[API DisableAddOn|DisableAddOn]](index or "AddOnName") - Disable the specified AddOn for subsequent sessions. |
||
| − | : [[API DisableAllAddOns|DisableAllAddOns]]() - Disable all AddOns for subsequent sessions. |
||
| − | : [[API EnableAddOn|EnableAddOn]](index or "AddOnName") - Enable the specified AddOn for subsequent sessions. |
||
| − | : [[API EnableAllAddOns|EnableAllAddOns]]() - Enable all AddOns for subsequent sessions. |
||
| − | : [[API GetAddOnDependencies|GetAddOnDependencies]](index or "AddOnName") - Get dependency list for an AddOn. |
||
| − | : [[API GetAddOnInfo|GetAddOnInfo]](index or "AddOnName") - Get information about an AddOn. |
||
| − | : [[API GetAddOnMetadata|GetAddOnMetadata]](index or "name", "variable") - Retrieve metadata from addon's TOC file. |
||
| − | : [[API GetNumAddOns|GetNumAddOns]]() - Get the number of user supplied AddOns. |
||
| − | : [[API IsAddOnLoaded|IsAddOnLoaded]](index or "AddOnName") - Returns true if the specified AddOn is loaded. |
||
| − | : [[API IsAddOnLoadOnDemand|IsAddOnLoadOnDemand]](index or "AddOnName") - Test whether an AddOn is load-on-demand. |
||
| − | : [[API LoadAddOn|LoadAddOn]](index or "AddOnName") - Request loading of a Load-On-Demand AddOn. |
||
| − | : [[API ResetDisabledAddOns|ResetDisabledAddOns]]() - |
||
| + | ==External links== |
||
| − | === Arena Functions === |
||
| + | <!-- Read http://www.wowpedia.org/Wowpedia:External_links before posting your links here. |
||
| − | : [[API AcceptArenaTeam|AcceptArenaTeam]]() - Accepts a pending Arena team invitation. |
||
| + | Links that do not conform to the rules will be DELETED. |
||
| − | : [[API ArenaTeamInviteByName|ArenaTeamInviteByName]](teamIndex, playerName) - Invites the specified player to the specified arena team. |
||
| + | Repeat violations may result in a BAN. |
||
| − | : [[API ArenaTeamSetLeaderByName|ArenaTeamSetLeaderByName]](teamIndex, playerName) - Sets new Team Leader to the specified arena team. |
||
| + | Have a nice day. :) --> |
||
| − | : [[API ArenaTeamLeave|ArenaTeamLeave]](teamIndex) - Leaves the specified arena team. |
||
| + | {{Elinks-quest|10563}} |
||
| − | : [[API ArenaTeamRoster|ArenaTeamRoster]](teamIndex) - Sends a request to the server to request the most recent information on a specific Arena Team that you are in. |
||
| − | : [[API ArenaTeamUninviteByName|ArenaTeamUninviteByName]](teamIndex, playerName) - Removes the specified played from the specified arena team. |
||
| − | : [[API ArenaTeamDisband|ArenaTeamDisband]](teamIndex) - Disbands the arena team without any warning! Requires you to be the leader of the team. (Known to be implemented as of 2.1.3, but may have existed before). |
||
| − | : [[API DeclineArenaTeam|DeclineArenaTeam]]() - Declines a pending Arena team invitation. |
||
| − | : [[API GetArenaTeam|GetArenaTeam]](teamIndex) - Returns information regarding the players arena team, nil if the player is not in the passed team |
||
| − | : [[API GetArenaTeamGdfInfo|GetArenaTeamGdfInfo]]() - ? New in 3.0.8 |
||
| − | : [[API GetArenaTeamRosterInfo|GetArenaTeamRosterInfo]](teamIndex, playerIndex) - Returns information regarding a player from the specified team. This requires a call to [[API ArenaTeamRoster|ArenaTeamRoster]] you only need to do this when the player logins in, UI reloads will not effect the return. |
||
| − | : [[API GetBattlefieldTeamInfo|GetBattlefieldTeamInfo]](index) - Gets info about a registered Arena Team at the end of an arena match. |
||
| − | : [[API GetCurrentArenaSeason|GetCurrentArenaSeason]]() - Gets the current Arena season. |
||
| − | : [[API GetInspectArenaTeamData|GetInspectArenaTeamData]](index) - Retrieves all the data associated with the inspected player's arena team located at index. |
||
| − | : [[API GetNumArenaTeamMembers|GetNumArenaTeamMembers]](teamIndex[, showOffline]) - Gets the number of arena team members. This requires a call to [[API ArenaTeamRoster|ArenaTeamRoster]] you only need to do this when the player logins in, UI reloads will not effect the return. |
||
| − | : [[API GetPreviousArenaSeason|GetPreviousArenaSeason]]() - Gets the previous Arena season. |
||
| − | : [[API IsActiveBattlefieldArena|IsActiveBattlefieldArena]]() - Returns true if in an Arena Match, also Returns true for the second argument if it's a registered match. |
||
| − | : [[API IsArenaTeamCaptain|IsArenaTeamCaptain]](teamIndex) - Returns a value based on whether the player is the arena team captain. |
||
| − | : [[API IsInArenaTeam|IsInArenaTeam]]() - Returns true if you are a member of an arena team. |
||
| − | |||
| − | === Auction Functions === |
||
| − | : [[API CalculateAuctionDeposit|CalculateAuctionDeposit]](runTime, stackSize, numStacks) - Returns the required deposit for the current selling item given the specified duration (1=12h, 2=24h, 3=48h). |
||
| − | : [[API CanCancelAuction|CanCancelAuction]](index) - Returns 1 if auction can be canceled. |
||
| − | : [[API CancelSell|CancelSell]]() - Clears the auction house listing queue, not creating any additional auctions. (3.3.3) |
||
| − | : [[API CanSendAuctionQuery|CanSendAuctionQuery]]() - Return 1 if auction search button would be active, nil otherwise. |
||
| − | : [[API CancelAuction|CancelAuction]](index) - Cancel the specified auction (on the "owner" list). |
||
| − | : [[API ClickAuctionSellItemButton|ClickAuctionSellItemButton]]() - Puts the currently 'picked up' item into the 'create auction' slot. |
||
| − | : [[API CloseAuctionHouse|CloseAuctionHouse]]() - Will close the AuctionFrame if opened. |
||
| − | : [[API GetAuctionHouseDepositRate|GetAuctionHouseDepositRate]]() - Returns the deposit rate (percentage) for the currently open auction house (Possibly out-dated by [[API CalculateAuctionDeposit|CalculateAuctionDeposit]]). |
||
| − | : [[API GetAuctionInvTypes|GetAuctionInvTypes]](classIndex, subclassIndex) - Returns types of subcategories items. |
||
| − | : [[API GetAuctionItemClasses|GetAuctionItemClasses]]() - Returns major auction item categories. |
||
| − | : [[API GetAuctionItemInfo|GetAuctionItemInfo]]("type", index) - Returns details about the specified auction item. |
||
| − | : [[API GetAuctionItemLink|GetAuctionItemLink]]("type", index) - Returns an [[itemLink]] for the specified auction item. |
||
| − | : [[API GetAuctionItemSubClasses|GetAuctionItemSubClasses]](classIndex) - Returns subcategories in the nth auction category. |
||
| − | : [[API GetAuctionItemTimeLeft|GetAuctionItemTimeLeft]]("type", index) - Returns the time left status of the specified auction item. |
||
| − | : [[API GetAuctionSellItemInfo|GetAuctionSellItemInfo]]() - Returns information about the current selling item (or nil if none selected). |
||
| − | : [[API GetBidderAuctionItems|GetBidderAuctionItems]]([page]) - Returns details about an auction item on which the user is bidding (possibly out-dated by [[API GetAuctionItemInfo|GetAuctionItemInfo]]("bidder", item)) |
||
| − | : [[API GetNumAuctionItems|GetNumAuctionItems]]("type") - Returns the size of the specified auction item list. |
||
| − | : [[API GetOwnerAuctionItems|GetOwnerAuctionItems]]([page]) - Returns details about an auction item of which the user is the owner (possibly out-dated by [[API GetAuctionItemInfo|GetAuctionItemInfo]]("owner", item)) |
||
| − | : [[API GetSelectedAuctionItem|GetSelectedAuctionItem]]("type") - Returns the index (1-50) of the selected auction item or 0 if none is selected. |
||
| − | : [[API IsAuctionSortReversed|IsAuctionSortReversed]]("type", "sort") - Returns 1 if the specified auction list and sort is reversed, nil otherwise. |
||
| − | : [[API PlaceAuctionBid|PlaceAuctionBid]]("type", index, bid) - Place a bid on the selected auction item. |
||
| − | : [[API QueryAuctionItems|QueryAuctionItems]]("name", minLevel, maxLevel, invTypeIndex, classIndex, subclassIndex, page, isUsable, qualityIndex) - Performs a search of the auction house with the specified characteristics. |
||
| − | : [[API SetAuctionsTabShowing|SetAuctionsTabShowing]](showing) - Sets whether auction-related events should be delivered to the client. (3.3.3) |
||
| − | : [[API SetSelectedAuctionItem|SetSelectedAuctionItem]]("type", index) - Selects a specific item in the auction house. |
||
| − | : [[API SortAuctionItems|SortAuctionItems]]("type", "sort") - Request that the specified auction list be sorted by a specific column. |
||
| − | : [[API StartAuction|StartAuction]](minBid, buyoutPrice, runTime, stackSize, numStacks) - Starts the auction you have created in the Create Auction panel. |
||
| − | : UI [[API AuctionFrameAuctions.duration|AuctionFrameAuctions.duration]] - Set the amount of time the auction will run for in minutes. |
||
| − | |||
| − | === Bank Functions === |
||
| − | : [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](buttonID, isBag) - Returns the ID number of a bank button or bag in terms of inventory slot ID. |
||
| − | : [[API CloseBankFrame|CloseBankFrame]]() - Close the bank frame if it's open. |
||
| − | : [[API GetBankSlotCost|GetBankSlotCost]](numSlots) - Returns the cost of the next bank slot. |
||
| − | : [[API GetNumBankSlots|GetNumBankSlots]]() - Returns total purchased bank bag slots, and a flag indicating if it's full. |
||
| − | : [[API PurchaseSlot|PurchaseSlot]]() - Buys another bank slot if available. |
||
| − | |||
| − | === Barber Shop Functions === |
||
| − | These functions were introduced in [[Patch 3.0.2]]. |
||
| − | : [[API ApplyBarberShopStyle|ApplyBarberShopStyle]]() - Purchase and apply the cosmetic changes. |
||
| − | : [[API BarberShopReset|BarberShopReset]]() - Reset any changes made in the Barber Shop. |
||
| − | : [[API CancelBarberShop|CancelBarberShop]]() - Exit the Barber Shop chair. |
||
| − | : [[API GetBarberShopStyleInfo|GetBarberShopStyleInfo]](id) - Returns information about the currently selected style. |
||
| − | : [[API GetBarberShopTotalCost|GetBarberShopTotalCost]]() - Returns the total costs of the cosmetic changes. |
||
| − | : [[API GetFacialHairCustomization|GetFacialHairCustomization]]() - Returns the type of facial hair customization available to the character. |
||
| − | : [[API GetHairCustomization|GetHairCustomization]]() - Returns the type of haircut customization available to the character. |
||
| − | : [[API SetNextBarberShopStyle|SetNextBarberShopStyle]](id[, reverse]) - Alters style selection in a particular category. |
||
| − | |||
| − | === Battlefield Functions === |
||
| − | : [[API AcceptAreaSpiritHeal|AcceptAreaSpiritHeal]]() - Accept a spirit heal. |
||
| − | : [[API AcceptBattlefieldPort|AcceptBattlefieldPort]](index[, acceptFlag]) - Accept or reject an offered battlefield port. |
||
| − | : [[API CancelAreaSpiritHeal|CancelAreaSpiritHeal]]() - Cancel a spirit heal. |
||
| − | : [[API CanJoinBattlefieldAsGroup|CanJoinBattlefieldAsGroup]]() - returns nil if the player can not do a group join for a battlefield. |
||
| − | : [[API CheckSpiritHealerDist|CheckSpiritHealerDist]]() - Return true if you are in range with spirit healer while dead. |
||
| − | : [[API GetAreaSpiritHealerTime|GetAreaSpiritHealerTime]]() - Returns the time left until the next resurrection by the Sprit Guide. |
||
| − | : [[API GetBattlefieldEstimatedWaitTime|GetBattlefieldEstimatedWaitTime]](index) - Get the estimated wait for entry into the battlefield. |
||
| − | : [[API GetBattlefieldFlagPosition|GetBattlefieldFlagPosition]](index) - Get the map position and texture of the flag. |
||
| − | : [[API GetBattlefieldInstanceExpiration|GetBattlefieldInstanceExpiration]]() - Get shutdown timer for the battlefield instance. |
||
| − | : [[API GetBattlefieldInstanceRunTime|GetBattlefieldInstanceRunTime]]() - In milliseconds, the time since battleground started (seems to be queried from server because it is not in sync with time()). |
||
| − | : [[API GetBattlefieldMapIconScale|GetBattlefieldMapIconScale]]() - Scale of the landmark icons on the battlefield minimap. |
||
| − | : [[API GetBattlefieldPortExpiration|GetBattlefieldPortExpiration]](index) - Get the remaining seconds before the battlefield port expires. |
||
| − | : [[API GetBattlefieldPosition|GetBattlefieldPosition]](index) - Get the map position and name of a player in the battleground not in your raid. |
||
| − | : [[API GetBattlefieldScore|GetBattlefieldScore]](index) - Get score information about a player. |
||
| − | : [[API GetBattlefieldStatData|GetBattlefieldStatData]](playerIndex, slotIndex) - Get information for a player from a column thats specific to a battleground (like Warsong Gulch flag captures). |
||
| − | : [[API GetBattlefieldStatInfo|GetBattlefieldStatInfo]](index) - Get the battleground specific column for the score board. |
||
| − | : [[API GetBattlefieldStatus|GetBattlefieldStatus]](index) - Get the battlefield's current status. |
||
| − | : [[API GetBattlefieldTimeWaited|GetBattlefieldTimeWaited]](index) - Get time waited in queue in milliseconds. |
||
| − | : [[API GetBattlefieldWinner|GetBattlefieldWinner]]() - Get the battlefields winner. |
||
| − | : [[API GetBattlegroundInfo|GetBattlegroundInfo]]() - Returns information about a battleground type. |
||
| − | : [[API GetNumBattlefieldFlagPositions|GetNumBattlefieldFlagPositions]]() - Get the number of flag positions available from GetBattlefieldFlagPosition(). |
||
| − | : [[API GetNumBattlefieldPositions|GetNumBattlefieldPositions]]() - Get the number of positions available from GetBattlefieldPosition(). |
||
| − | : [[API GetNumBattlefieldScores|GetNumBattlefieldScores]]() - Returns the number of scores(players) listed in the battlefield scoreboard. |
||
| − | : [[API GetNumBattlefieldStats|GetNumBattlefieldStats]]() - Get the number of battleground specific columns. |
||
| − | : [[API GetNumWorldStateUI|GetNumWorldStateUI]]() - Get the number of WorldState UI's. |
||
| − | : [[API GetWintergraspWaitTime|GetWintergraspWaitTime]]() - Get the number of seconds until the next Wintergrasp battle. Returns nil if battle is in progress. |
||
| − | : [[API GetWorldStateUIInfo|GetWorldStateUIInfo]](i) - Get score and flag status within a battlefield. |
||
| − | : [[API IsPVPTimerRunning|IsPVPTimerRunning]]() |
||
| − | : [[API JoinBattlefield|JoinBattlefield]](index[, joinAs]) - Queue for a battleground either solo or as a group. |
||
| − | : [[API LeaveBattlefield|LeaveBattlefield]]() - Leave the current battlefield |
||
| − | : [[API ReportPlayerIsPVPAFK|ReportPlayerIsPVPAFK]]("[[unitId|unit]]") - Reports the specified player as AFK in a battleground. |
||
| − | : [[API RequestBattlefieldPositions|RequestBattlefieldPositions]]() - Request new data for GetBattlefieldPosition(). |
||
| − | : [[API RequestBattlefieldScoreData|RequestBattlefieldScoreData]]() - Request new data for GetBattlefieldScore(). |
||
| − | : [[API RequestBattlegroundInstanceInfo|RequestBattlegroundInstanceInfo]](index) - Requests data about the available instances of a battleground. |
||
| − | : [[API SetBattlefieldScoreFaction|SetBattlefieldScoreFaction]]([faction]) - Set the faction to show on the battlefield scoreboard. |
||
| − | |||
| − | === Binding Functions === |
||
| − | : [[API GetBinding|GetBinding]](index) - Get action and key bindings for that index. |
||
| − | : [[API GetBindingAction|GetBindingAction]]("KEY" [,checkOverride]) - Get the action bound to that key. |
||
| − | : [[API GetBindingKey|GetBindingKey]]("command") - Get the key(s) bound to that action. |
||
| − | : UI [[API GetBindingText|GetBindingText]]("key", "prefix", returnAbbr) - Gets the string value for the key. |
||
| − | : [[API GetCurrentBindingSet|GetCurrentBindingSet]]() - Queries if current set of key bindings is character or account specific |
||
| − | : [[API GetNumBindings|GetNumBindings]]() - Get total number key bindings and headers. |
||
| − | : [[API LoadBindings|LoadBindings]](which) - Loads default, account or character specific key binding set into memory from disk. |
||
| − | : [[API RunBinding|RunBinding]]("command"[, "up"]) - Executes the key binding named "command" |
||
| − | : [[API SaveBindings|SaveBindings]](which) - Saves account or character specific key bindings from memory to disk. |
||
| − | : NOCOMBAT [[API SetBinding|SetBinding]]("key"[, "command"[, mode]]) - Sets or unsets key bindings. (2.0 - Can not be used in combat.) |
||
| − | : NOCOMBAT [[API SetBindingSpell|SetBindingSpell]]("KEY", "Spell Name") - Set a key binding directly to a spell, uses the same spell name syntax as /cast. |
||
| − | : NOCOMBAT [[API SetBindingClick|SetBindingClick]]("KEY", "ButtonName" [,"mouseButton"]) - Set a key binding directly to a Button object. The click sends a mouse down when the key is pressed, and a mouse up when it is released. |
||
| − | : NOCOMBAT [[API SetBindingItem|SetBindingItem]]("KEY", "itemname") - |
||
| − | : NOCOMBAT [[API SetBindingMacro|SetBindingMacro]]("KEY", "macroname"|macroid) - |
||
| − | : [[API SetConsoleKey|SetConsoleKey]]("key") - Sets the console key (normally ~ ). |
||
| − | : NOCOMBAT [[API SetOverrideBinding|SetOverrideBinding]](owner, isPriority, "KEY" [,"COMMAND"]) - Set (or clear) an override key binding. |
||
| − | : NOCOMBAT [[API SetOverrideBindingSpell|SetOverrideBindingSpell]](owner, isPriority, "KEY", "spellname") - |
||
| − | : NOCOMBAT [[API SetOverrideBindingClick|SetOverrideBindingClick]](owner, isPriority, "key", "buttonName" [, "mouseClick"]) - Sets an override binding that acts like a mouse click on a button. |
||
| − | : NOCOMBAT [[API SetOverrideBindingItem|SetOverrideBindingItem]](owner, isPriority, "KEY", "itemname") - |
||
| − | : NOCOMBAT [[API SetOverrideBindingMacro|SetOverrideBindingMacro]](owner, isPriority, "KEY", "macroname"|macroid) - |
||
| − | : NOCOMBAT [[API ClearOverrideBindings|ClearOverrideBindings]](owner) - Reset all overrides belonging to an owner. |
||
| − | : [[API SetMouselookOverrideBinding|SetMouselookOverrideBinding]]("KEY" [,"COMMAND"]) - |
||
| − | : [[API IsModifierKeyDown|IsModifierKeyDown]]() - equivalent to (IsShiftKeyDown() or IsControlKeyDown() or IsAltKeyDown()). |
||
| − | : [[API IsModifiedClick|IsModifiedClick]]("action") - Returns 1 if the keys for the specified action are down, nil otherwise. |
||
| − | : [[API IsMouseButtonDown|IsMouseButtonDown]]([button or "button"]) - |
||
| − | |||
| − | === Buff/Debuff Functions === |
||
| − | : PROTECTED [[API CancelUnitBuff|CancelUnitBuff]]("unit", index or "spell" [,"filter" or "rank"]) - Removes a specific buff from the player. |
||
| − | : PROTECTED [[API CancelShapeshiftForm|CancelShapeshiftForm]]() - Cancels a druid's shapeshift form buff. |
||
| − | : PROTECTED [[API CancelItemTempEnchantment|CancelItemTempEnchantment]](weaponHand) - Cancels a temporary weapon enchant on ''weaponHand'' (1 for Main hand, 2 for Off hand). |
||
| − | : [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Return information about main and offhand weapon enchantments. |
||
| − | : [[API UnitAura|UnitAura]]("[[unitId|unit]]", index or "buffName" [,filter]) - Returns information about a buff/debuff of a certain unit. |
||
| − | : [[API UnitBuff|UnitBuff]]("[[unitId|unit]]", index or "buffName" [,castable]) - Retrieves info about a buff of a certain unit. |
||
| − | : [[API UnitDebuff|UnitDebuff]]("[[unitId|unit]]", index or "buffName" [,removable]) - Retrieves info about a debuff of a certain unit. |
||
| − | |||
| − | === Calendar Functions === |
||
| − | : HW [[API CalendarAddEvent|CalendarAddEvent]]() - Saves the selected event (new events only, requires hardware input to call) |
||
| − | : [[API CalendarCanAddEvent|CalendarCanAddEvent]]() - Returns true if player can add an event |
||
| − | : [[API CalendarCanSendInvite|CalendarCanSendInvite]]() - Returns true if player can send invites |
||
| − | : [[API CalendarCloseEvent|CalendarCloseEvent]]() - Closes the selected event without saving it |
||
| − | : [[API CalendarContextDeselectEvent|CalendarContextDeselectEvent]]() - New in 3.0.8 |
||
| − | : [[API CalendarContextEventCanComplain|CalendarContextEventCanComplain]](monthOffset, day, eventIndex) - Returns true if player can report the event as spam |
||
| − | : [[API CalendarContextEventCanEdit|CalendarContextEventCanEdit]](monthOffset, day, eventIndex) - Returns true if player can edit the event |
||
| − | : [[API CalendarContextEventClipboard|CalendarContextEventClipboard]]() |
||
| − | : [[API CalendarContextEventComplain|CalendarContextEventComplain]](monthOffset, day, eventIndex) - Reports the event as spam |
||
| − | : [[API CalendarContextEventCopy|CalendarContextEventCopy]](monthOffset, day, eventIndex) - Copies the event to the clipboard |
||
| − | : [[API CalendarContextEventGetCalendarType|CalendarContextEventGetCalendarType]]() - ? |
||
| − | : [[API CalendarContextEventPaste|CalendarContextEventPaste]](monthOffset, day) - Pastes the clipboard event to the date |
||
| − | : [[API CalendarContextEventRemove|CalendarContextEventRemove]](monthOffset, day, eventIndex) - Deletes the event |
||
| − | : [[API CalendarContextEventSignUp|CalendarContextEventSignUp]]() - ? |
||
| − | : [[API CalendarContextGetEventIndex|CalendarContextGetEventIndex]]() - New in 3.0.8 |
||
| − | : [[API CalendarContextInviteAvailable|CalendarContextInviteAvailable]](monthOffset, day, eventIndex) - Accepts the invitation to the event |
||
| − | : [[API CalendarContextInviteDecline|CalendarContextInviteDecline]](monthOffset, day, eventIndex) - Declines the invitation to the event |
||
| − | : [[API CalendarContextInviteIsPending|CalendarContextInviteIsPending]](monthOffset, day, eventIndex) - Returns true if the player hasn't responded to the event invite |
||
| − | : [[API CalendarContextInviteTentative|CalendarContextInviteTentative]]() - ? |
||
| − | : [[API CalendarContextInviteType|CalendarContextInviteType]] - ? |
||
| − | : [[API CalendarContextInviteModeratorStatus|CalendarContextInviteModeratorStatus]](monthOffset, day, eventIndex) - ? |
||
| − | : [[API CalendarContextInviteRemove|CalendarContextInviteRemove]](monthOffset, day, eventIndex) - Removes the event from the calendar |
||
| − | : [[API CalendarContextInviteStatus|CalendarContextInviteStatus]](monthOffset, day, eventIndex) - returns inviteStatus |
||
| − | : [[API CalendarContextSelectEvent|CalendarContextSelectEvent]](monthOffset, day, eventIndex) - New in 3.0.8 |
||
| − | : [[API CalendarDefaultGuildFilter|CalendarDefaultGuildFilter]]() - returns minLevel, maxLevel |
||
| − | : [[API CalendarEventAvailable|CalendarEventAvailable]]() - Accepts the inviation to the currently open event |
||
| − | : [[API CalendarEventCanEdit|CalendarEventCanEdit]]() - Returns true if the event can be edited |
||
| − | : [[API CalendarEventCanModerate|CalendarEventCanModerate]] - ? |
||
| − | : [[API CalendarEventClearAutoApprove|CalendarEventClearAutoApprove]]() - Turns off automatic confirmations |
||
| − | : [[API CalendarEventClearLocked|CalendarEventClearLocked]]() - Unlocks the event |
||
| − | : [[API CalendarEventClearModerator|CalendarEventClearModerator]]() |
||
| − | : [[API CalendarEventDecline|CalendarEventDecline]]() - Declines the invitation to the currently open event |
||
| − | : [[API CalendarEventGetCalendarType|CalendarEventGetCalendarType]]() - ? |
||
| − | : [[API CalendarEventGetInvite|CalendarEventGetInvite]](inviteeIndex) - Returns status information for an invitee for the currently opened event |
||
| − | : [[API CalendarEventGetInviteResponseTime|CalendarEventGetInviteResponseTime]](inviteIndex) - ? |
||
| − | : [[API CalendarEventGetInviteSortCriterion|CalendarEventGetInviteSortCriterion]]() - returns criterion, reverse |
||
| − | : [[API CalendarEventGetNumInvites|CalendarEventGetNumInvites]]() - Returns the number of invitees for the currently opened event |
||
| − | : [[API CalendarEventGetRepeatOptions|CalendarEventGetRepeatOptions]]() - Returns opt1, opt2 |
||
| − | : [[API CalendarEventGetSelectedInvite|CalendarEventGetSelectedInvite]]() - returns inviteIndex |
||
| − | : [[API CalendarEventGetStatusOptions|CalendarEventGetStatusOptions]]() - Returns ?? |
||
| − | : [[API CalendarEventGetTextures|CalendarEventGetTextures]](eventType) - Returns title1, tex1, expLvl1, title2, tex2, expLvl2, ... |
||
| − | : [[API CalendarEventGetTypes|CalendarEventGetTypes]]() - Returns name1, name2, ... |
||
| − | : [[API CalendarEventHasPendingInvite|CalendarEventHasPendingInvite]]() - Returns true if the player has an unanswered invitation to the currently selected event |
||
| − | : [[API CalendarEventHaveSettingsChanged|CalendarEventHaveSettingsChanged]]() - Returns true if the currently open event has been modified |
||
| − | : [[API CalendarEventInvite|CalendarEventInvite]]("Player") - Invite player to currently selected event |
||
| − | : [[API CalendarEventIsModerator|CalendarEventIsModerator]]() - ? |
||
| − | : [[API CalendarEventRemoveInvite|CalendarEventRemoveInvite]](inviteIndex) |
||
| − | : [[API CalendarEventSelectInvite|CalendarEventSelectInvite]](inviteIndex) |
||
| − | : [[API CalendarEventSetAutoApprove|CalendarEventSetAutoApprove]]() |
||
| − | : [[API CalendarEventSetDate|CalendarEventSetDate]](month, day, year) |
||
| − | : [[API CalendarEventSetDescription|CalendarEventSetDescription]](description) |
||
| − | : [[API CalendarEventSetLocked|CalendarEventSetLocked]]() |
||
| − | : [[API CalendarEventSetLockoutDate|CalendarEventSetLockoutDate]](lockoutDate) - ?? |
||
| − | : [[API CalendarEventSetLockoutTime|CalendarEventSetLockoutTime]](lockoutTime) - ?? |
||
| − | : [[API CalendarEventSetModerator|CalendarEventSetModerator]](index) |
||
| − | : [[API CalendarEventSetRepeatOption|CalendarEventSetRepeatOption]](repeatoption) |
||
| − | : [[API CalendarEventSetSize|CalendarEventSetSize]] - ?? |
||
| − | : [[API CalendarEventSetStatus|CalendarEventSetStatus]](index, status) - Sets the invitation status of a player to the current event |
||
| − | : [[API CalendarEventSetTextureID|CalendarEventSetTextureID]](textureIndex) |
||
| − | : [[API CalendarEventSetTime|CalendarEventSetTime]](hour, minute) |
||
| − | : [[API CalendarEventSetTitle|CalendarEventSetTitle]](title) |
||
| − | : [[API CalendarEventSetType|CalendarEventSetType]](type) |
||
| − | : [[API CalendarEventSignUp|CalendarEventSignUp]]() - ? |
||
| − | : [[API CalendarEventSortInvites|CalendarEventSortInvites]](criterion) |
||
| − | : [[API CalendarEventTentative|CalendarEventTentative]]() - ? |
||
| − | : [[API CalendarGetAbsMonth|CalendarGetAbsMonth]]() - returns month, year |
||
| − | : [[API CalendarGetDate|CalendarGetDate]]() - Call this only after PLAYER_ENTERING_WORLD event |
||
| − | : [[API CalendarGetDayEvent|CalendarGetDayEvent]](monthOffset, day, eventIndex) |
||
| − | : [[API CalendarGetDayEventSequenceInfo|CalendarGetDayEventSequenceInfo]] - Retrieve information about the specified event. |
||
| − | : [[API CalendarGetEventIndex|CalendarGetEventIndex]]() - returns monthOffset, day, index |
||
| − | : [[API CalendarGetEventInfo|CalendarGetEventInfo]]() - Returns detailed information about an event selected with CalendarOpenEvent() |
||
| − | : [[API CalendarGetFirstPendingInvite|CalendarGetFirstPendingInvite]](monthOffset, day) - returns eventIndex |
||
| − | : [[API CalendarGetHolidayInfo|CalendarGetHolidayInfo]](monthOffset, day, eventIndex) - Returns Holiday Name, Holiday Description, Calendar Icon |
||
| − | : [[API CalendarGetMaxCreateDate|CalendarGetMaxCreateDate]]() - returns maxWeekday, maxMonth, maxDay, maxYear |
||
| − | : [[API CalendarGetMaxDate|CalendarGetMaxDate]]() - returns maxWeekday, maxMonth, maxDay, maxYear |
||
| − | : [[API CalendarGetMinDate|CalendarGetMinDate]]() - returns minWeekday, minMonth, minDay, minYear |
||
| − | : [[API CalendarGetMinHistoryDate|CalendarGetMinHistoryDate]]() - returns minWeekday, minMonth, minDay, minYear |
||
| − | : [[API CalendarGetMonth|CalendarGetMonth]]([monthOffset]) - returns month, year |
||
| − | : [[API CalendarGetMonthNames|CalendarGetMonthNames]]() - returns a list of the month names |
||
| − | : [[API CalendarGetNumDayEvents|CalendarGetNumDayEvents]](monthOffset[, day]) |
||
| − | : [[API CalendarGetNumPendingInvites|CalendarGetNumPendingInvites]]() - returns count |
||
| − | : [[API CalendarGetRaidInfo|CalendarGetRaidInfo]] (monthOffset, day, eventIndex) - returns name, calendarType, raidID, hour, minute, difficulty |
||
| − | : [[API CalendarGetWeekdayNames|CalendarGetWeekdayNames]]() - returns a list of the weekday names |
||
| − | : [[API CalendarIsActionPending|CalendarIsActionPending]]() - returns isPending |
||
| − | : [[API CalendarMassInviteArenaTeam|CalendarMassInviteArenaTeam]](teamType) - ? |
||
| − | : [[API CalendarMassInviteGuild|CalendarMassInviteGuild]](minLevel, maxLevel, rank) - ? |
||
| − | : [[API CalendarNewEvent|CalendarNewEvent]]() - Creates and selected a new event |
||
| − | : [[API CalendarNewGuildAnnouncement|CalendarNewGuildAnnouncement]]() - ? |
||
| − | : [[API CalendarNewGuildEvent|CalendarNewGuildEvent]](minLevel, maxLevel, minRank) - Replaces the invite list of the selected new event with the specified guild members |
||
| − | : [[API CalendarOpenEvent|CalendarOpenEvent]](monthOffset, day, eventIndex) - Selects an existing event |
||
| − | : [[API CalendarRemoveEvent|CalendarRemoveEvent]]() - Removes the selected event from the calendar (invitees only) |
||
| − | : [[API CalendarSetAbsMonth|CalendarSetAbsMonth]](month, year) - Sets the reference month and year for functions which use a month offset |
||
| − | : [[API CalendarSetMonth|CalendarSetMonth]](monthOffset) |
||
| − | : [[API CalendarUpdateEvent|CalendarUpdateEvent]]() - Saves the selected event (existing events only, requires hardware input to call) |
||
| − | : [[API OpenCalendar|OpenCalendar]]() - Requests calendar information from the server. Does not open the calendar frame. (New in 3.0.8) |
||
| − | |||
| − | |||
| − | === Camera Functions === |
||
| − | ''Mouse Look'' refers to holding down the right mouse button and controlling the movement direction. Shifting the view by holding down the ''left'' mouse button is not covered by these APIs. |
||
| − | |||
| − | : PROTECTED [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]]([stickyFlag]) - End "Left click" in the 3D world. (1.10 - Protected) |
||
| − | : [[API CameraZoomIn|CameraZoomIn]](increment) - Zooms the camera into the viewplane by increment. |
||
| − | : [[API CameraZoomOut|CameraZoomOut]](increment) - Zooms the camera out of the viewplane by increment. |
||
| − | : [[API FlipCameraYaw|FlipCameraYaw]](degrees) - Rotates the camera about the Z-axis by the angle amount specified in degrees. |
||
| − | : [[API IsMouselooking|IsMouselooking]]() - Returns 1 if mouselook is currently active, nil otherwise. |
||
| − | : [[API MouselookStart|MouselookStart]]() - Enters mouse look mode; mouse movement is used to adjust movement/facing direction. |
||
| − | : [[API MouselookStop|MouselookStop]]() - Exits mouse look mode; mouse movement is used to move the mouse cursor. |
||
| − | : [[API MoveViewDownStart|MoveViewDownStart]]() - Begins rotating the camera downward. |
||
| − | : [[API MoveViewDownStop|MoveViewDownStop]]() - Stops rotating the camera after [[API MoveViewDownStart|MoveViewDownStart]]() is called. |
||
| − | : [[API MoveViewInStart|MoveViewInStart]]() - Begins zooming the camera in. |
||
| − | : [[API MoveViewInStop|MoveViewInStop]]() - Stops zooming the camera in after [[API MoveViewInStart|MoveViewInStart]]() is called. |
||
| − | : [[API MoveViewLeftStart|MoveViewLeftStart]]() - Begins rotating the camera to the Left. |
||
| − | : [[API MoveViewLeftStop|MoveViewLeftStop]]() - Stops rotating the camera after [[API MoveViewLeftStart|MoveViewLeftStart]]() is called. |
||
| − | : [[API MoveViewOutStart|MoveViewOutStart]]() - Begins zooming the camera out. |
||
| − | : [[API MoveViewOutStop|MoveViewOutStop]]() - Stops zooming the camera out after [[API MoveViewOutStart|MoveViewOutStart]]() is called. |
||
| − | : [[API MoveViewRightStart|MoveViewRightStart]]() - Begins rotating the camera to the Right. |
||
| − | : [[API MoveViewRightStop|MoveViewRightStop]]() - Stops rotating the camera after [[API MoveViewRightStart|MoveViewRightStart]]() is called. |
||
| − | : [[API MoveViewUpStart|MoveViewUpStart]]() - Begins rotating the camera upward. |
||
| − | : [[API MoveViewUpStop|MoveViewUpStop]]() - Stops rotating the camera after [[API MoveViewUpStart|MoveViewUpStart]]() is called. |
||
| − | : PROTECTED [[API PitchDownStart|PitchDownStart]]() - Begins pitching the camera Downward. |
||
| − | : PROTECTED [[API PitchDownStop|PitchDownStop]]() - Stops pitching the camera after [[API PitchDownStart|PitchDownStart]]() is called. |
||
| − | : PROTECTED [[API PitchUpStart|PitchUpStart]]() - Begins pitching the camera Upward. |
||
| − | : PROTECTED [[API PitchUpStop|PitchUpStop]]() - Stops pitching the camera after [[API PitchUpStart|PitchUpStart]]() is called. |
||
| − | : [[API NextView|NextView]]() - Cycles forward through the five predefined camera positions. |
||
| − | : [[API PrevView|PrevView]]() - Cycles backward through the five predefined camera positions. |
||
| − | : [[API ResetView|ResetView]](index) - Resets the specified (1-5) predefined camera position to it's default if it was changed using [[API SaveView|SaveView]](index). |
||
| − | : [[API SaveView|SaveView]](index) - Replaces the specified (1-5) predefined camera positions with the current camera position. |
||
| − | : [[API SetView|SetView]](index) - Sets camera position to a specified (1-5) predefined camera position. |
||
| − | |||
| − | === Channel Functions === |
||
| − | These are chat functions which are specific to channels. Also see the [[#Chat Window Functions|Chat Window Functions]] and [[#Communication Functions|Communication Functions]] sections. |
||
| − | |||
| − | : [[API AddChatWindowChannel|AddChatWindowChannel]](chatFrameIndex, "channel") - Make a chat channel visible in a specific ChatFrame. |
||
| − | : [[API ChannelBan|ChannelBan]]("channel", "name") - Bans a player from the specified channel. |
||
| − | : [[API ChannelInvite|ChannelInvite]]("channel", "name") - Invites the specified user to the channel. |
||
| − | : [[API ChannelKick|ChannelKick]]("channel", "name") - Kicks the specified user from the channel. |
||
| − | : [[API ChannelModerator|ChannelModerator]]("channel", "name") - Sets the specified player as the channel moderator. |
||
| − | : [[API ChannelMute|ChannelMute]]("channel", "name") - Turns off the specified player's ability to speak in a channel. |
||
| − | : [[API ChannelToggleAnnouncements|ChannelToggleAnnouncements]]("channel") - Toggles the channel to display announcements either on or off. |
||
| − | : [[API ChannelUnban|ChannelUnban]]("channel", "name") - Unbans a player from a channel. |
||
| − | : [[API ChannelUnmoderator|ChannelUnmoderator]]("channel", "name") - Takes the specified user away from the moderator status. |
||
| − | : [[API ChannelUnmute|ChannelUnmute]]("channel", "name") - Unmutes the specified user from the channel. |
||
| − | : [[API DisplayChannelOwner|DisplayChannelOwner]]("channel") - Displays the owner of the specified channel in the default chat. |
||
| − | : [[API DeclineInvite|DeclineInvite]]("channel") - Declines an invitation to join a chat channel. |
||
| − | : [[API EnumerateServerChannels|EnumerateServerChannels]]() - Retrieves all available server channels (zone dependent). |
||
| − | : [[API GetChannelList|GetChannelList]]() - Retrieves joined channels. |
||
| − | : [[API GetChannelName|GetChannelName]]("channel" or index) - Retrieves the name from a specific channel. |
||
| − | : [[API GetChatWindowChannels|GetChatWindowChannels]](index) - Get the chat channels received by a chat window. |
||
| − | : [[API JoinChannelByName|JoinChannelByName]]("channel"[, "password"[, frameId]]) - Join the specified chat channel (with optional password, and register for specified frame) (updated in 1.9). |
||
| − | : [[API LeaveChannelByName|LeaveChannelByName]]("channel") - Leaves the channel with the specified name. |
||
| − | : [[API ListChannelByName|ListChannelByName]](channelMatch) - Lists members in the given channel to the chat window. |
||
| − | : [[API ListChannels|ListChannels]]() - Lists all of the channels into the chat window. |
||
| − | : [[API RemoveChatWindowChannel|RemoveChatWindowChannel]](chatFrameIndex, "channel") - Make a chat channel invisible (hidden) in a specific ChatFrame. |
||
| − | : [[API SendChatMessage|SendChatMessage]]("msg",[ "chatType",[ "language",[ "channel"]]]) - Sends a chat message. |
||
| − | : [[API SetChannelOwner|SetChannelOwner]]("channel", "name") - Sets the channel owner. |
||
| − | : [[API SetChannelPassword|SetChannelPassword]]("channel", "password") - Changes the password of the current channel. |
||
| − | |||
| − | === Character Functions === |
||
| − | : [[API AcceptResurrect|AcceptResurrect]]() - The player accepts the request from another player to resurrect him/herself. |
||
| − | : [[API AcceptXPLoss|AcceptXPLoss]]() - Accept the durability loss to be reborn by a spirit healer. (The name is a remnant from when sprit res was an XP loss instead.) |
||
| − | : [[API CheckBinderDist|CheckBinderDist]]() - Check whether the player is close enough to interact with the Hearthstone binder. |
||
| − | : [[API ConfirmBinder|ConfirmBinder]]() - Confirm the request to set the binding of the player's Hearthstone. |
||
| − | : [[API DeclineResurrect|DeclineResurrect]]() - Decline the request from another player to resurrect him/herself. |
||
| − | : [[API DestroyTotem|DestroyTotem]](slot) |
||
| − | : [[API GetBindLocation|GetBindLocation]]() - Get the name of the location for your Hearthstone. |
||
| − | : [[API GetComboPoints|GetComboPoints]]() - Get the current number of combo points. |
||
| − | : [[API GetCorpseRecoveryDelay|GetCorpseRecoveryDelay]]() - Time left before a player can accept a resurrection |
||
| − | : [[API GetCurrentTitle|GetCurrentTitle]]() - Returns the player's current [[titleId]]. |
||
| − | : [[API GetMirrorTimerInfo|GetMirrorTimerInfo]](id) - returns information about a mirror timer (exhaustion, breath and feign death timers) |
||
| − | : [[API GetMirrorTimerProgress|GetMirrorTimerProgress]](id) - returns the current value of a mirror timer (exhaustion, breath and feign death timers) |
||
| − | : [[API GetMoney|GetMoney]]() - Returns an integer value of your held money in copper. |
||
| − | : [[API GetNumTitles|GetNumTitles]]() - Returns the maximum [[titleId]] |
||
| − | : [[API GetPlayerFacing|GetPlayerFacing]]() - Returns the direction the player is facing in radians ([-π, π] range, 0 is north, π/2 is east). (3.1) |
||
| − | : [[API GetPowerRegen|GetPowerRegen]]() - Returns normal and combat power regeneration rates |
||
| − | : [[API GetPVPDesired|GetPVPDesired]]() - Returns whether the player has permanently turned on their PvP flag. |
||
| − | : [[API GetRangedCritChance|GetRangedCritChance]]() - Returns the players ranged critical strike chance. |
||
| − | : [[API GetReleaseTimeRemaining|GetReleaseTimeRemaining]]() - Returns the amount of time left before your ghost is pulled from your body. |
||
| − | : [[API GetResSicknessDuration|GetResSicknessDuration]]() |
||
| − | : [[API GetRestState|GetRestState]]() - Returns information about a player's rest state (saved up experience bonus) |
||
| − | : [[API GetRuneCooldown|GetRuneCooldown]](id) - Returns cooldown information about a given rune. |
||
| − | : [[API GetRuneCount|GetRuneCount]](slot) - ? |
||
| − | : [[API GetRuneType|GetRuneType]](id) - Returns the type of rune with the given id. |
||
| − | : [[API GetTimeToWellRested|GetTimeToWellRested]]() - Defunct. |
||
| − | : [[API GetTitleName|GetTitleName]]([[titleId]]) - Returns the player's current title name |
||
| − | : [[API GetXPExhaustion|GetXPExhaustion]]() - Returns your character's current rested XP, nil if character is not rested. |
||
| − | : [[API HasFullControl|HasFullControl]]() |
||
| − | : [[API HasSoulstone|HasSoulstone]]() |
||
| − | : [[API IsFalling|IsFalling]]() - Returns 1 if your character is currently plummeting to their doom. |
||
| − | : [[API IsFlying|IsFlying]]() - Returns 1 if flying, otherwise nil. |
||
| − | : [[API IsFlyableArea|IsFlyableArea]]() - Returns 1 if it is possible to fly here, nil otherwise. |
||
| − | : [[API IsIndoors|IsIndoors]]() - Returns 1 if you are indoors, otherwise nil. Returns nil for indoor areas where you can still mount. |
||
| − | : [[API IsMounted|IsMounted]]() - Returns 1 if mounted, otherwise nil |
||
| − | : [[API IsOutdoors|IsOutdoors]]() - Returns 1 if you are outdoors, otherwise nil. Returns 1 for indoor areas where you can still mount. |
||
| − | : [[API IsOutOfBounds|IsOutOfBounds]]() - Returns 1 if you fell off the map. |
||
| − | : [[API IsResting|IsResting]]() - Returns 1 if your character is currently resting. |
||
| − | : [[API IsStealthed|IsStealthed]]() - Returns 1 if stealthed or shadowmeld, otherwise nil |
||
| − | : [[API IsSwimming|IsSwimming]]() - Returns 1 if your character is currently swimming. |
||
| − | : [[API IsTitleKnown|IsTitleKnown]](index) - Returns 1 if the title is valid for the player, otherwise 0. |
||
| − | : [[API IsXPUserDisabled|IsXPUserDisabled]]() - Returns 1 if the character has disabled experience gain. |
||
| − | : [[API NotWhileDeadError|NotWhileDeadError]]() - Generates an error message saying you cannot do that while dead. |
||
| − | : [[API ResurrectHasSickness|ResurrectHasSickness]]() - Appears to be used when accepting a resurrection will give you resurrection sickessness. |
||
| − | : [[API ResurrectHasTimer|ResurrectHasTimer]]() - Does the player have to wait before accepting a resurrection |
||
| − | : [[API ResurrectGetOfferer|ResurrectGetOfferer]]() - Returns the name of the person offering to resurrect you. |
||
| − | : [[API RetrieveCorpse|RetrieveCorpse]]() - Resurrects when near corpse. e.g., The "Accept" button one sees after running back to your body. |
||
| − | : HW [[API SetCurrentTitle|SetCurrentTitle]]([[titleId]]) - Sets the player's current title id |
||
| − | : [[API TargetTotem|TargetTotem]]() - New in 3.0.8 |
||
| − | |||
| − | === Character Statistics Functions === |
||
| − | : [[API GetArmorPenetration|GetArmorPenetration]]() - Returns percent of armor ignored by your physical attacks. |
||
| − | : [[API GetAttackPowerForStat|GetAttackPowerForStat]](stat, value) - Returns the amount of attack power contributed by a specified amount of a particular stat. |
||
| − | : [[API GetBlockChance|GetBlockChance]]() - Returns the player's percentage block chance. |
||
| − | : [[API GetCombatRating|GetCombatRating]](ratingID) - Returns the player's combat rating for a particular combat rating. (2.0) |
||
| − | : [[API GetCombatRatingBonus|GetCombatRatingBonus]](ratingID) - Returns the player's combat rating bonus for a particular combat rating. (2.0) |
||
| − | : [[API GetCritChance|GetCritChance]]() - Returns the player's melee critical hit chance |
||
| − | : [[API GetCritChanceFromAgility|GetCritChanceFromAgility]]("unit") - Returns the amount of your critical hit chance contributed by Agility. |
||
| − | : [[API GetDodgeChance|GetDodgeChance]]() - Returns the player's percentage dodge chance. |
||
| − | : [[API GetExpertise|GetExpertise]]() - Returns main hand and offhand expertise value. |
||
| − | : [[API GetExpertisePercent|GetExpertisePercent]]() - Returns reduction in dodge and parry chances for main hand and offhand attacks, in percent. |
||
| − | : [[API GetManaRegen|GetManaRegen]]() - Returns the player's mana regeneration rates. |
||
| − | : [[API GetMaxCombatRatingBonus|GetMaxCombatRatingBonus]](lowestRating) |
||
| − | : [[API GetParryChance|GetParryChance]]() - Returns the player's percentage parry chance. |
||
| − | : [[API GetPetSpellBonusDamage|GetPetSpellBonusDamage]] |
||
| − | : [[API GetSpellBonusDamage|GetSpellBonusDamage]](spellTreeID) - Returns the raw spell damage of the player for a given spell tree. |
||
| − | : [[API GetRangedCritChance|GetRangedCritChance]]() |
||
| − | : [[API GetSpellBonusHealing|GetSpellBonusHealing]]() - Returns the raw bonus healing of the player. |
||
| − | : [[API GetSpellCritChance|GetSpellCritChance]](school) - returns the players critical hit chance with a particular spell school. |
||
| − | : [[API GetShieldBlock|GetShieldBlock]]() |
||
| − | : [[API GetSpellCritChanceFromIntellect|GetSpellCritChanceFromIntellect]]("unit") |
||
| − | : [[API GetSpellPenetration|GetSpellPenetration]]() |
||
| − | |||
| − | === Chat Window Functions === |
||
| − | These are functions which are specific to chat ''window'' management. Also see the [[#Channel Functions|Channel Functions]] and [[#Communication Functions|Communication Functions]] sections. |
||
| − | <small>(→ [[World of Warcraft API/Mikk's spiel on chat windows|Mikk's spiel on chat windows]])</small> |
||
| − | |||
| − | : [[API AddChatWindowChannel|AddChatWindowChannel]](chatFrameIndex, "channel") - Make a chat channel visible in a specific ChatFrame. |
||
| − | : [[API AddChatWindowMessages|AddChatWindowMessages]] - Adds a messaging group to the specified chat window. |
||
| − | : [[API ChangeChatColor|ChangeChatColor]](channelname,r,g,b) - Update the color for a type of chat message. |
||
| − | : UI [[API ChatFrame_AddChannel|ChatFrame_AddChannel]](chatFrame, "channelName") - Activate channel in chatFrame. |
||
| − | : UI [[API ChatFrame_AddMessageEventFilter|ChatFrame_AddMessageEventFilter]]("event", filterFunc) - Add a chat message filtering function (new in 2.4) |
||
| − | : UI [[API ChatFrame_GetMessageEventFilters|ChatFrame_GetMessageEventFilters]]("event") - Retreive the list of chat message filtering functions. (new in 2.4) |
||
| − | : UI [[API ChatFrame_OnHyperlinkShow|ChatFrame_OnHyperlinkShow]](reference, link, button) - called when the user clicks on a chatlink. |
||
| − | : UI [[API ChatFrame_RemoveMessageEventFilter|ChatFrame_RemoveMessageEventFilter]]("event", filterFunc) - Unregister a chat message filtering function (new in 2.4) |
||
| − | : [[API GetAutoCompleteResults|GetAutoCompleteResults]]("text", include, exclude, maxResults[, cursorPosition]) - Returns possible player names matching a given prefix string and specified requirements. |
||
| − | : [[API GetChatTypeIndex|GetChatTypeIndex]](type) - Get the numeric ID of a type of chat message. |
||
| − | : [[API GetChatWindowChannels|GetChatWindowChannels]](index) - Get the chat channels received by a chat window. |
||
| − | : [[API GetChatWindowInfo|GetChatWindowInfo]](index) - Get setup information about a chat window. |
||
| − | : [[API GetChatWindowMessages|GetChatWindowMessages]](index) - Get the chat message types received by a chat window. |
||
| − | : [[API JoinChannelByName|JoinChannelByName]]("channel"[, "password"[, frameId]]) - Join the specified chat channel (with optional password, and register for specified frame) (updated in 1.9) |
||
| − | : [[API LoggingChat|LoggingChat]](newState) - Gets or sets whether logging chat to Logs\WoWChatLog.txt is enabled. |
||
| − | : [[API LoggingCombat|LoggingCombat]](newState) - Gets or sets whether logging combat to Logs\WoWCombatLog.txt is enabled. |
||
| − | : [[API RemoveChatWindowChannel|RemoveChatWindowChannel]](chatFrameIndex, "channel") - Make a chat channel invisible (hidden) in a specific ChatFrame. |
||
| − | : [[API RemoveChatWindowMessages|RemoveChatWindowMessages]](chatFrameIndex,"messageGroup") - Remove a set of chat messages from this window. |
||
| − | These functions get applied after reload ui (index 1 is General and index 2 is Combat Log): |
||
| − | : [[API SetChatWindowAlpha|SetChatWindowAlpha]](index,alpha) - Sets the Alpha value(transparency) of ChatFrame<index> (alpha - 0-100) |
||
| − | : [[API SetChatWindowColor|SetChatWindowColor]](index,r,g,b) - Sets the background color of a a chat window. (r/g/b - 0-255) |
||
| − | : [[API SetChatWindowDocked|SetChatWindowDocked]](index,docked) - Set whether a chat window is docked. (docked - 0/1) |
||
| − | : [[API SetChatWindowLocked|SetChatWindowLocked]](index,locked) - Sets ChatFrame<index> so that it is or is not movable. (locked - 0/1) |
||
| − | : [[API SetChatWindowName|SetChatWindowName]](index,"name") - Sets the name of ChatFrame<index> to <"name">. |
||
| − | : [[API SetChatWindowShown|SetChatWindowShown]](index,shown) - Shows or Hides ChatFrame<index> depending on value of <shown> (shown - 0/1) |
||
| − | : [[API SetChatWindowSize|SetChatWindowSize]](index,size) - Sets the font size of a chat window. (size - default 14) |
||
| − | : [[API SetChatWindowUninteractable|SetChatWindowUninteractable]](id, isUninteractable) - New in 3.0.8 |
||
| − | |||
| − | === Communication Functions === |
||
| − | These are the functions which communicate with other players. Also see the [[#Channel Functions|Channel Functions]] and [[#Chat Window Functions|Chat Window Functions]] sections. |
||
| − | |||
| − | : [[API DoEmote|DoEmote]]("emote",["target"]) - Perform a voice emote. |
||
| − | : [[API GetDefaultLanguage|GetDefaultLanguage]]("[[unitId|unit]]") - Returns the default language that the unit is speaking after logon. |
||
| − | : [[API GetLanguageByIndex|GetLanguageByIndex]](index) - Returns the language specified by the index. |
||
| − | : [[API GetNumLanguages|GetNumLanguages]]() - Returns the number of languages your character can speak (Renamed in 2.4, formerly mistyped GetNumLaguages). |
||
| − | : [[API RandomRoll|RandomRoll]](low, high) - Does a random roll between the two values. |
||
| − | : [[API SendAddonMessage|SendAddonMessage]]("prefix", "text", "type" [, "player"]) - Sends a message to hidden AddOn channels. - Added in 1.12 |
||
| − | : [[API SendChatMessage|SendChatMessage]]("msg",[ "chatType",[ "language",[ "channel"]]]) - Sends a chat message. |
||
| − | |||
| − | === Companion Functions === |
||
| − | These functions relate to companions -- mounts and non-combat pets. All functions were introduced in [[Patch 3.0]]. |
||
| − | : [[API CallCompanion|CallCompanion]]("type", slotid) - Summons a companion. |
||
| − | : [[API DismissCompanion|DismissCompanion]]("type") - Dismisses an active companion. |
||
| − | : [[API GetCompanionInfo|GetCompanionInfo]]("type", slotid) - Returns info about a selected companion. |
||
| − | : [[API GetNumCompanions|GetNumCompanions]]("type") - Get the number of companions of the specified type. |
||
| − | : [[API GetCompanionCooldown|GetCompanionCooldown]]("type", index) - Returns cooldown information. |
||
| − | : [[API PickupCompanion|PickupCompanion]]("type", index) - Picks up the indexed companion onto the mouse cursor. |
||
| − | : [[API SummonRandomCritter|SummonRandomCritter]]() - Summons a random critter companion. (New: 3.3.3) |
||
| − | |||
| − | === Container/Bag Functions === |
||
| − | These functions manage containers (bags, backpack). See also [[#Inventory Functions|Inventory Functions]] and [[#Bank Functions|Bank Functions]]. |
||
| − | |||
| − | : [[API ContainerIDToInventoryID|ContainerIDToInventoryID]]([[bagId|bagID]]) |
||
| − | : [[API GetBagName|GetBagName]]([[bagId|bagID]]) - Get the name of one of the player's bags. |
||
| − | : [[API GetContainerItemCooldown|GetContainerItemCooldown]]([[bagId|bagID]], slot) |
||
| − | : [[API GetContainerItemDurability|GetContainerItemDurability]](bag, slot) - Get current and maximum durability of an item in the character's bags. |
||
| − | : [[API GetContainerItemGems|GetContainerItemGems]](bag, slot) - Returns item IDs of gems inserted into the item in a specified container slot. |
||
| − | : [[API GetContainerItemID|GetContainerItemID]](bag, slot) - Returns the item ID of the item in a particular container slot. |
||
| − | : [[API GetContainerItemInfo|GetContainerItemInfo]]([[bagId|bagID]], slot) - Get the info for an item in one of the player's bags. |
||
| − | : [[API GetContainerItemLink|GetContainerItemLink]]([[bagId|bagID]], slot) - Returns the [[itemLink]] of the item located in bag#, slot#. |
||
| − | : [[API GetContainerNumSlots|GetContainerNumSlots]]([[bagId|bagID]]) - Returns the total number of slots in the bag specified by the index. |
||
| − | : [[API GetContainerItemQuestInfo|GetContainerItemQuestInfo]](bag, slot) - Returns information about quest and quest-starting items in your bags. (New: 3.3.3) |
||
| − | : [[API GetContainerNumFreeSlots|GetContainerNumFreeSlots]]([[bagId|bagID]]) - Returns the number of free slots and type of slots in the bag specified by the index. (New in [[Patch 2.4]]) |
||
| − | : [[API HasKey|HasKey]]() - Returns 1 if the player has a keyring, nil otherwise. |
||
| − | : UI [[API OpenAllBags|OpenAllBags]]() - Open all bags |
||
| − | : UI [[API CloseAllBags|CloseAllBags]]() - Close all bags |
||
| − | : [[API PickupBagFromSlot|PickupBagFromSlot]](slot) - Picks up the bag from the specified slot, placing it in the cursor. |
||
| − | : [[API PickupContainerItem|PickupContainerItem]]([[bagId|bagID]],slot) |
||
| − | : [[API PutItemInBackpack|PutItemInBackpack]]() - attempts to place item in backpack (bag slot 0). |
||
| − | : [[API PutItemInBag|PutItemInBag]](inventoryId) - attempts to place item in a specific bag. |
||
| − | : UI [[API PutKeyInKeyRing|PutKeyInKeyRing]]() - attempts to place item in your keyring. |
||
| − | : [[API SplitContainerItem|SplitContainerItem]]([[bagId|bagID]],slot,amount) |
||
| − | : UI [[API ToggleBackpack|ToggleBackpack]]() - Toggles your backpack open/closed. |
||
| − | : UI [[API ToggleBag|ToggleBag]]([[bagId|bagID]]) - Opens or closes the specified bag. |
||
| − | : PROTECTED (Situational) [[API UseContainerItem|UseContainerItem]]([[bagId|bagID]], slot[, onSelf]) - Uses an item located in bag# and slot#. (Warning: If a vendor window is open, using items in your pack may sell them!) - 'onSelf' added in 1.12 |
||
| − | |||
| − | === Currency Functions === |
||
| − | Most of these functions were added in 3.0.2 |
||
| − | : [[API GetCoinText|GetCoinText]](amount, "separator") - Breaks down money and inserts separator strings. Added in 2.4.2. |
||
| − | : [[API GetCoinTextureString|GetCoinTextureString]](amount[, fontHeight]) - Breaks down money and inserts texture strings. |
||
| − | : [[API GetCurrencyInfo|GetCurrencyInfo]](index) - returns localized_label, amount, icon_file_name of the currency at the index. (added 4.0.1) |
||
| − | : [[API GetCurrencyListSize|GetCurrencyListSize]]() - returns the number of elements (both headers and currencies) in the currency list. |
||
| − | : [[API GetCurrencyListInfo|GetCurrencyListInfo]](index) - return information about an element in the currency list. |
||
| − | : [[API ExpandCurrencyList|ExpandCurrencyList]](index, state) - sets the expanded/collapsed state of a currency list header. |
||
| − | : [[API SetCurrencyUnused|SetCurrencyUnused]](id, state) - alters whether a currency is marked as unused. |
||
| − | : [[API GetNumWatchedTokens|GetNumWatchedTokens]]() - returns the number of currently watched. |
||
| − | : [[API GetBackpackCurrencyInfo|GetBackpackCurrencyInfo]](id) - returns information about a watched currency. |
||
| − | : [[API SetCurrencyBackpack|SetCurrencyBackpack]](id, state) - alters whether a currency is tracked. |
||
| − | |||
| − | === Cursor Functions === |
||
| − | : [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Causes the equipment on the cursor to be equipped. |
||
| − | : [[API ClearCursor|ClearCursor]]() - Clears whatever item the cursor is dragging from the cursor. - Added in 1.12 |
||
| − | : [[API CursorCanGoInSlot|CursorCanGoInSlot]]([[inventorySlotId|invSlot]]) - Return true if the item currently held by the cursor can go into the given inventory (equipment) slot. |
||
| − | : [[API CursorHasItem|CursorHasItem]]() - Returns true if the cursor currently holds an item. |
||
| − | : [[API CursorHasMoney|CursorHasMoney]]() - true/false |
||
| − | : [[API CursorHasSpell|CursorHasSpell]]() - true/false |
||
| − | : [[API DeleteCursorItem|DeleteCursorItem]]() - Destroys the item on the cursor. |
||
| − | : [[API DropCursorMoney|DropCursorMoney]]() - Drops the amount of money held by the cursor. |
||
| − | : [[API DropItemOnUnit|DropItemOnUnit]]("[[unitId|unit]]") - Drops an item from the cursor onto a unit. |
||
| − | : [[API EquipCursorItem|EquipCursorItem]]([[inventorySlotId|invSlot]]) |
||
| − | : [[API GetCursorInfo|GetCursorInfo]]() - Returns information about what the cursor is holding. |
||
| − | : [[API GetCursorMoney|GetCursorMoney]] - Returns the amount of money held by the cursor. |
||
| − | : [[API GetCursorPosition|GetCursorPosition]]() - Returns the cursor's position on the screen. |
||
| − | : [[API HideRepairCursor|HideRepairCursor]]() |
||
| − | : [[API InRepairMode|InRepairMode]]() - Returns true if your cursor is in repair mode |
||
| − | : NOCOMBAT [[API PickupAction|PickupAction]](slot) - Drags an action out of the specified quickbar slot and holds it on the cursor. |
||
| − | : [[API PickupBagFromSlot|PickupBagFromSlot]](slot) - Picks up the bag from the specified slot, placing it in the cursor. If an item is already picked up, this places the item into the specified slot, swapping the items if needed. |
||
| − | : [[API PickupContainerItem|PickupContainerItem]]([[bagId|bagID]],slot) |
||
| − | : [[API PickupInventoryItem|PickupInventoryItem]]([[inventorySlotId|invSlot]]) - "Picks up" an item from the player's worn inventory. |
||
| − | : NOCOMBAT [[API PickupItem|PickupItem]](itemId or "[[itemString]]" or "itemName" or "[[itemLink]]") |
||
| − | : [[API PickupMacro|PickupMacro]]("macroName" or index) - Adds the specified macro to the Cursor. |
||
| − | : [[API PickupMerchantItem|PickupMerchantItem]](index) - Places the item on the cursor. If the cursor already has an item, the item in the cursor will be sold. |
||
| − | : NOCOMBAT [[API PickupPetAction|PickupPetAction]](slot) - Drags an action from the specified pet action bar slot into the cursor. |
||
| − | : [[API PickupPlayerMoney|PickupPlayerMoney]] - Picks up an amount of money from the player. |
||
| − | : NOCOMBAT [[API PickupSpell|PickupSpell]]("spellName" | spellID, "bookType") - Adds the specified spell to the Cursor. |
||
| − | : [[API PickupStablePet|PickupStablePet]](index) - ?. |
||
| − | : [[API PickupTradeMoney|PickupTradeMoney]](amount) |
||
| − | : [[API PlaceAction|PlaceAction]](slot) - Drops an action from the cursor into the specified quickbar slot. |
||
| − | : [[API PutItemInBackpack|PutItemInBackpack]]() - attempts to place item in backpack (bag slot 0). |
||
| − | : [[API PutItemInBag|PutItemInBag]](inventoryId) - attempts to place item in a specific bag. |
||
| − | : [[API ResetCursor|ResetCursor]]() |
||
| − | : [[API SetCursor|SetCursor]]("cursor" or nil) |
||
| − | : [[API ShowContainerSellCursor|ShowContainerSellCursor]](index,slot) |
||
| − | : [[API ShowInspectCursor|ShowInspectCursor]]() - Change the cursor to the magnifying glass inventory inspection cursor |
||
| − | : [[API ShowInventorySellCursor|ShowInventorySellCursor]]() - ?. |
||
| − | : [[API ShowMerchantSellCursor|ShowMerchantSellCursor]](index) - Changes the cursor to the merchant sell cursor. |
||
| − | : [[API ShowRepairCursor|ShowRepairCursor]]() |
||
| − | : [[API SplitContainerItem|SplitContainerItem]](bagID,slot,amount) - Picks up part of a stack. |
||
| − | |||
| − | === Debugging Functions === |
||
| − | : [[API ConsoleAddMessage|ConsoleAddMessage]](message) - New in 3.0.8 |
||
| − | : [[API debugprofilestart|debugprofilestart]]() - starts a timer for profiling during debugging. |
||
| − | : [[API debugprofilestop|debugprofilestop]]() - return the time in milliseconds since the last call to debugprofilestart() |
||
| − | : [[API debugstack|debugstack]](start, count1, count2) - Returns a string representation of the current calling stack (as of 1.9) |
||
| − | : [[API FrameXML_Debug|FrameXML_Debug]](flag) - Sets FrameXML logging state which is output to /WoW Folder/Logs/FrameXML.log |
||
| − | : [[API GetDebugStats|GetDebugStats]]() |
||
| − | : UI [[API getprinthandler|getprinthandler]]() - Returns the function currently handling print() output. |
||
| − | : UI [[API print|print]](...) - Calls the current print output handler with the provided values; by default printing the values to the default chat frame. |
||
| − | : UI [[API setprinthandler|setprinthandler]](func) - Changes the function handling print() output. |
||
| − | : UI [[API tostringall|tostringall]](...) - Converts and returns the passed arguments to string. |
||
| − | : [[API wipe|wipe]](table) - removes all key/value pairs from a table; also available as table.wipe(). |
||
| − | |||
| − | === Dressing Room Functions === |
||
| − | Functions Controlling the Dressing Room interface. NEW in 1700. |
||
| − | : UI [[API DressUpItemLink|DressUpItemLink]]("[[itemString]]" or "[[itemLink]]") - Will show the DressingRoom UI with the given item equipped. |
||
| − | : UI [[API SetDressUpBackground|SetDressUpBackground]](isAuctionFrame) - Given an Item shown in the Auction House will show the DressingRoom UI with the item equipped. |
||
| − | |||
| − | === Dungeon Finder Functions === |
||
| − | Functions hidden behind and supporting the Dungeon Finder UI introduced in 3.3. See also: [[#Raid Browser Functions|Raid Browser Functions]] and [[#Looking For Group Functions|Looking For Group Functions]] |
||
| − | |||
| − | : HW [[API AcceptProposal|AcceptProposal]]() - Accept an LFD group invite and enter the dungeon. |
||
| − | : [[API CanPartyLFGBackfill|CanPartyLFGBackfill]]() - Returns whether the party is eligible to recruit additional members from the LFG pool. |
||
| − | : [[API GetLFDChoiceCollapseState|GetLFDChoiceCollapseState]](nil or table) - returns LFGCollapseList |
||
| − | : [[API GetLFDChoiceEnabledState|GetLFDChoiceEnabledState]](nil or table) - returns LFGEnabledList |
||
| − | : [[API GetLFDChoiceInfo|GetLFDChoiceInfo]](nil or table) - Returns a table of all dungeon info keyed by dungeonID |
||
| − | : [[API GetLFDChoiceLockedState|GetLFDChoiceLockedState]](nil or table) - Returns a table mapping dungeonID to isLocked (in LFD UI) |
||
| − | : [[API GetLFDChoiceOrder|GetLFDChoiceOrder]](nil or table) - returns LFDDungeonList |
||
| − | : [[API GetLFDLockPlayerCount|GetLFDLockPlayerCount]]() - returns the number of locks in a dungeon group |
||
| − | : [[API GetLFDLockInfo|GetLFDLockInfo]](dungeonID, lockedPlayerNumber) - returns playerName, lockedReason; lockedPlayerNumber is from 1 to [[API GetLFDLockPlayerCount|GetLFDLockPlayerCount]](); lockedReason is found in LFG_INSTANCE_INVALID_CODES |
||
| − | : [[API GetLFGDungeonInfo|GetLFGDungeonInfo]](dungeonId) - Returns information about a particular dungeon in the list: dungeonName, typeID, minLevel, maxLevel, recLevel, minRecLevel, maxRecLevel, expansionLevel, groupID, textureFilename, difficulty, maxPlayers, dungeonDescription, isHoliday |
||
| − | : [[API GetLFGDungeonRewards|GetLFGDungeonRewards]](dungeontype) - dungeontype = 261 (normal) or 262 (heroic), returns doneToday, moneyBase, moneyVar, experienceBase, experienceVar, numRewards |
||
| − | : [[API GetLFGDungeonRewardInfo|GetLFGDungeonRewardInfo]](dungeonID, rewardIndex) - returns name, texturePath, quantity. rewardIndex matches 1 through numRewards from [[API GetLFGDungeonRewards|GetLFGDungeonRewards]] |
||
| − | : [[API GetLFGInfoServer|GetLFGInfoServer]] - returns inParty, joined, queued, noPartialClear, achievements, lfgComment, slotCount |
||
| − | : [[API GetLFGProposal|GetLFGProposal]]() - Returns information about a LFD group invite. |
||
| − | : [[API GetLFGProposalEncounter|GetLFGProposalEncounter]](encounterNumber) - returns bossName, texture, isKilled. encounterNumber is from 1 to totalEncounters from [[API GetLFGProposal|GetLFGProposal]]() |
||
| − | : [[API GetLFGProposalMember|GetLFGProposalMember]](playerNumber) - returns info about players (numbers 1-5) in the LFG proposal: isLeader, role, level, responded, accepted, name, class |
||
| − | : [[API GetLFGRandomDungeonInfo|GetLFGRandomDungeonInfo]](index) - Returns information about a random dungeon queue: id, name |
||
| − | : [[API GetNumRandomDungeons|GetNumRandomDungeons]]() - returns the number of specific dungeons that can be queued for |
||
| − | : [[API GetPartyLFGBackfillInfo|GetPartyLFGBackfillInfo]]() - Returns information about the dungeon for which you may currently recruit additional members from the LFG pool. |
||
| − | : [[API GetRandomDungeonBestChoice|GetRandomDungeonBestChoice]]() - Returns suggested random dungeon ID. |
||
| − | : [[API HasLFGRestrictions|HasLFGRestrictions]]() - Returns whether the player is in a random party formed by the dungeon finder system. |
||
| − | : [[API IsLFGDungeonJoinable|IsLFGDungeonJoinable]](dungeonId) - Returns whether you can queue for a particular dungeon; dungeonId is from [[API GetLFGRandomDungeonInfo|GetLFGRandomDungeonInfo]] |
||
| − | : [[API LFGTeleport|LFGTeleport]]([toSafety]) - Teleports the player to (toSafety = nil) or from (toSafety = true) a dungeon |
||
| − | : [[API RejectProposal|RejectProposal]]() - Reject an LFD group invite and exit the queue. |
||
| − | : [[API SetLFGHeaderCollapsed|SetLFGHeaderCollapsed]](headerID, isCollapsed) |
||
| − | : [[API UnitGroupRolesAssigned|UnitGroupRolesAssigned]](UnitID) - Return's the targeted unit's assigned role. |
||
| − | |||
| − | === Enchanting Functions === |
||
| − | : [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Return information about main and offhand weapon enchantments. |
||
| − | : [[API ReplaceEnchant|ReplaceEnchant]]() |
||
| − | : [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirm the replacement of an enchantment via trade. |
||
| − | : [[API BindEnchant|BindEnchant]]() - Confirm the binding of the item when enchanting. |
||
| − | |||
| − | === Equipment Manager Functions === |
||
| − | Equipment management was added to the UI in [[Patch 3.1.2]]. |
||
| − | : [[API GetNumEquipmentSets|GetNumEquipmentSets]]() - Returns the number of saved equipment sets. |
||
| − | : [[API GetEquipmentSetInfo|GetEquipmentSetInfo]](index) - Returns information about an equipment set. |
||
| − | : [[API GetEquipmentSetInfoByName|GetEquipmentSetInfoByName]]("name") - Returns information about an equipment set. |
||
| − | : [[API GetEquipmentSetItemIDs|GetEquipmentSetItemIDs]]("name"[, returnTable]) - Populates and returns a table with the item IDs. |
||
| − | : [[API GetEquipmentSetLocations|GetEquipmentSetLocations]]("name"[, returnTable]) - Populates and returns a table with the item locations. |
||
| − | : [[API EquipmentManager UnpackLocation|EquipmentManager_UnpackLocation]](location) - Unpacks a location integer to determine the actual inventory location. |
||
| − | : [[API PickupEquipmentSet|PickupEquipmentSet]](index) - Places an equipment set on the cursor. |
||
| − | : [[API PickupEquipmentSetByName|PickupEquipmentSetByName]]("name") - Places an equipment set on the cursor. |
||
| − | : [[API EquipmentSetContainsLockedItems|EquipmentSetContainsLockedItems]]("name") - Checks if some of the items in the set are currently locked (pending client/server interaction). |
||
| − | : [[API UseEquipmentSet|UseEquipmentSet]]("name") - Equips an equipment set. |
||
| − | : [[API EquipmentManagerIgnoreSlotForSave|EquipmentManagerIgnoreSlotForSave]](slot) - flags the slot to be ignored when saving an equipment set. |
||
| − | : [[API EquipmentManagerUnignoreSlotForSave|EquipmentManagerUnignoreSlotForSave]](slot) - removes the ignore flag from a slot when saving an equipment set. |
||
| − | : [[API EquipmentManagerClearIgnoredSlotsForSave|EquipmentManagerClearIgnoredSlotsForSave]]() - removes the ignore flag from all slots when saving an equipment set. |
||
| − | : [[API SaveEquipmentSet|SaveEquipmentSet]]("name", iconIndex) - Saves the currently equipped items in a set. |
||
| − | : [[API RenameEquipmentSet|RenameEquipmentSet]]("oldName", "newName") - Renames an equipment set. |
||
| − | : [[API DeleteEquipmentSet|DeleteEquipmentSet]]("name") - Forgets an equipment set. |
||
| − | : UI [[API GetEquipmentSetIconInfo|GetEquipmentSetIconInfo]](index) - Returns information about available icons. |
||
| − | |||
| − | === Faction Functions === |
||
| − | : [[API CollapseFactionHeader|CollapseFactionHeader]](index) - Collapse a faction header row. |
||
| − | : [[API CollapseAllFactionHeaders|CollapseAllFactionHeaders]]() - Collapse all faction header rows. |
||
| − | : [[API ExpandFactionHeader|ExpandFactionHeader]](index) - Expand a faction header row. |
||
| − | : [[API ExpandAllFactionHeaders|ExpandAllFactionHeaders]]() - Expand all faction header rows. |
||
| − | : [[API FactionToggleAtWar|FactionToggleAtWar]](index) - Toggle the At War flag for a faction. |
||
| − | : [[API GetFactionInfo|GetFactionInfo]](index) - Gets details for a specific faction/faction header. |
||
| − | : [[API GetNumFactions|GetNumFactions]]() - Returns the number of lines in the faction display. |
||
| − | : [[API GetSelectedFaction|GetSelectedFaction]]() - Returns the row index of the currently selected faction in reputation window. (New in 1.10) |
||
| − | : [[API GetWatchedFactionInfo|GetWatchedFactionInfo]]() - Returns information about the currently watched faction. (New in 1.10) |
||
| − | : [[API IsFactionInactive|IsFactionInactive]](index) - Returns true if the faction is marked inactive. (New in 1.10) |
||
| − | : [[API SetFactionActive|SetFactionActive]](index) - Remove a faction from inactive group. (New in 1.10) |
||
| − | : [[API SetFactionInactive|SetFactionInactive]](index) - Move a faction to inactive group. (New in 1.10) |
||
| − | : [[API SetSelectedFaction|SetSelectedFaction]](index) - Sets the currently selected faction in reputation window. (New in 1.10) |
||
| − | : [[API SetWatchedFactionIndex|SetWatchedFactionIndex]](index) - Sets which faction should be watched in Blizzard reputation bar. (New in 1.10) |
||
| − | : [[API UnitFactionGroup|UnitFactionGroup]]("[[unitId|unit]]") - Returns the faction group id and name of the specified unit. (eg. "Alliance") - string returned is localization-independent (used in filepath) |
||
| − | |||
| − | === Frame Management === |
||
| − | : [[API CreateFrame|CreateFrame]]("frameType"[ ,"name"][, parent][, "inheritFrame"]) - Create a new frame of the specified type |
||
| − | : [[API CreateFont|CreateFont]]("name") - Dynamically create a font object |
||
| − | : [[API GetFramesRegisteredForEvent|GetFramesRegisteredForEvent]](event) - Returns a list of frames that are registered for the given event. - Added in 2.3 |
||
| − | : [[API GetNumFrames|GetNumFrames]]() - Get the current number of Frame (and derivative) objects |
||
| − | : [[API EnumerateFrames|EnumerateFrames]](currentFrame) - Get the Frame which follows currentFrame |
||
| − | : [[API GetMouseFocus|GetMouseFocus]]() - Returns the frame that currently has the mouse focus. |
||
| − | : UI [[API MouseIsOver|MouseIsOver]] - Determines whether or not the mouse is over the specified frame. |
||
| − | : UI [[API ToggleDropDownMenu|ToggleDropDownMenu]](level, value, dropDownFrame, anchorName, xOffset, yOffset) |
||
| − | : UI [[API UIFrameFadeIn|UIFrameFadeIn]](frame, fadeTime, startAlpha, endAlpha) |
||
| − | : UI [[API UIFrameFlash|UIFrameFlash]](...) |
||
| − | |||
| − | === FrameXML API === |
||
| − | This is a very limited selection of utility functions provided by Blizzard's FrameXML implementation. |
||
| − | : UI [[API EasyMenu|EasyMenu]](menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay) |
||
| − | |||
| − | === Friend Functions === |
||
| − | : [[API AddFriend|AddFriend]]("playerName") - Add a friend to your friend list. |
||
| − | : [[API AddOrRemoveFriend|AddOrRemoveFriend]]("playerName"[, "note"]) - Toggles a player's presence on your friends list. |
||
| − | : [[API GetFriendInfo|GetFriendInfo]](index) - Returns name, level, class, location, connected, status, and friend note of a friend. |
||
| − | : [[API SetFriendNotes|SetFriendNotes]](index, "note") - Sets the note text for a friend. |
||
| − | : [[API GetNumFriends|GetNumFriends]]() - Returns how many friends are on your friend list. |
||
| − | : [[API GetSelectedFriend|GetSelectedFriend]]() - Returns the index of the current selected friend. |
||
| − | : [[API RemoveFriend|RemoveFriend]]("name" or index) - Removes a friend from your friend list |
||
| − | : [[API SetSelectedFriend|SetSelectedFriend]](index) - Update the current selected friend. |
||
| − | : [[API ShowFriends|ShowFriends]]() - Request updated friends information from server. |
||
| − | : UI [[API ToggleFriendsFrame|ToggleFriendsFrame]]([tabNumber]) - Opens/closes the friends pane (possibly on a specific tab). |
||
| − | |||
| − | === Glyph Functions === |
||
| − | : PROTECTED [[API CastGlyphByID|CastGlyphByID]] (glyphID, slot) |
||
| − | : PROTECTED [[API CastGlyphByName|CastGlyphByName]] (glyphName, slot) |
||
| − | : [[API GetNumGlyphSockets|GetNumGlyphSockets]]() - Returns the number of Glyph Sockets available at max level. (Same result as NUM_GLYPH_SLOTS) |
||
| − | : [[API GetGlyphSocketInfo|GetGlyphSocketInfo]]([[Glyph SocketID|socketID]][, talentGroup]) - Returns info on a specific Glyph Socket. |
||
| − | : [[API GetGlyphLink|GetGlyphLink]]([[Glyph SocketID|socketID]][, talentGroup]) - Returns link text for a Glyph in the desired Socket. |
||
| − | : [[API GlyphMatchesSocket|GlyphMatchesSocket]]([[Glyph SocketID|socketID]]) - See if the Glyph held by the cursor matches the desired Socket. |
||
| − | : [[API PlaceGlyphInSocket|PlaceGlyphInSocket]]([[Glyph SocketID|socketID]]) - Places the Glyph held by the cursor into the desired Socket. |
||
| − | : [[API RemoveGlyphFromSocket|RemoveGlyphFromSocket]]([[Glyph SocketID|socketID]]) - Removes the Glyph from the desired Socket. |
||
| − | : [[API SpellCanTargetGlyph|SpellCanTargetGlyph]]() |
||
| − | |||
| − | === GM Functions === |
||
| − | : [[API CanComplainChat|CanComplainChat]](lineID) - determines if we should show the menu for reporting a line of chat spam (lineID comes from the player link in the chat line) |
||
| − | : [[API CanComplainInboxItem|CanComplainInboxItem]](index) - determines if we should show the “report spam” button on a mail item |
||
| − | : [[API ComplainChat|ComplainChat]](lineID) - complains about a particular line of chat spam |
||
| − | : [[API ComplainInboxItem|ComplainInboxItem]](index) - complains about a particular mail item |
||
| − | : PROTECTED [[API DeleteGMTicket|DeleteGMTicket]]() |
||
| − | : [[API GMRequestPlayerInfo|GMRequestPlayerInfo]]() - access denied (darn) |
||
| − | : [[API GetGMStatus|GetGMStatus]]() |
||
| − | : [[API GetGMTicket|GetGMTicket]]() |
||
| − | : [[API GetGMTicketCategories|GetGMTicketCategories]]() - Return all available ticket categories (not as a table) |
||
| − | : [[API GMSurveyAnswerSubmit|GMSurveyAnswerSubmit]](question, rank, comment) - ? |
||
| − | : [[API GMSurveyCommentSubmit|GMSurveyCommentSubmit]](comment) - ? |
||
| − | : [[API GMSurveyQuestion|GMSurveyQuestion]] ? |
||
| − | : [[API GMSurveySubmit|GMSurveySubmit]] ? |
||
| − | : [[API HelpReportLag|HelpReportLag]](type) - Uses the Report Lag function on the help screen to report the specified type of lag |
||
| − | : PROTECTED [[API NewGMTicket|NewGMTicket]](type,"text") |
||
| − | : PROTECTED UI [[API Stuck|Stuck]]() - Informs the game engine that the player is Stuck. |
||
| − | : PROTECTED [[API UpdateGMTicket|UpdateGMTicket]](type,"text") |
||
| − | |||
| − | === Gossip Functions === |
||
| − | : [[API CloseGossip|CloseGossip]]() - Dismiss the gossip window. |
||
| − | : [[API ForceGossip|ForceGossip]]() - Returns whether the gossip text ''must'' be displayed. (New: 3.3.3) |
||
| − | : [[API GetGossipActiveQuests|GetGossipActiveQuests]]() - Retrieves a list of the active (?) quests on the NPC you are talking to. |
||
| − | : [[API GetGossipAvailableQuests|GetGossipAvailableQuests]]() - Retrieves a list of the available (!) quests on the NPC you are talking to. |
||
| − | : [[API GetGossipOptions|GetGossipOptions]]() - Retrieves a list of the available gossip items on the NPC you are talking to. |
||
| − | : [[API GetGossipText|GetGossipText]]() - Retrieves the gossip text. |
||
| − | : [[API GetNumGossipActiveQuests|GetNumGossipActiveQuests]]() - Returns the number of active quests that you should eventually turn in to this NPC. |
||
| − | : [[API GetNumGossipAvailableQuests|GetNumGossipAvailableQuests]]() - Returns the number of quests (that you are not already on) offered by this NPC. |
||
| − | : [[API GetNumGossipOptions|GetNumGossipOptions]]() - Returns the number of conversation options available with this NPC. |
||
| − | : [[API SelectGossipActiveQuest|SelectGossipActiveQuest]](index) - Selects an active quest. |
||
| − | : [[API SelectGossipAvailableQuest|SelectGossipAvailableQuest]](index) - Selects an available quest. |
||
| − | : [[API SelectGossipOption|SelectGossipOption]](index) - Selects on a gossip item. |
||
| − | |||
| − | === Group Functions === |
||
| − | See also: [[#Raid Functions|Raid Functions]] |
||
| − | |||
| − | : [[API AcceptGroup|AcceptGroup]]() - Accept the invitation to party. |
||
| − | : [[API ConfirmReadyCheck|ConfirmReadyCheck]](isReady) - Indicate if you are ready or not. |
||
| − | : [[API ConvertToParty|ConvertToParty]]() - Converts a raid group with 5 or less members to a party. (4.0.1) |
||
| − | : [[API ConvertToRaid|ConvertToRaid]]() - Converts party to raid. |
||
| − | : [[API DeclineGroup|DeclineGroup]]() - Decline the invitation to a party. |
||
| − | : [[API DoReadyCheck|DoReadyCheck]]() - Initiate a ready check. |
||
| − | : [[API GetLootMethod|GetLootMethod]]() - Return the currently active [[lootMethod]] |
||
| − | : [[API GetLootThreshold|GetLootThreshold]]() - Return the current loot threshold (for group/master loot) |
||
| − | : [[API GetMasterLootCandidate|GetMasterLootCandidate]](index) - Return the name of a player who is eligible to receive loot in master mode |
||
| − | : [[API GetNumPartyMembers|GetNumPartyMembers]]() - Returns the number of other players in your party (0-4). |
||
| − | : [[API GetRealNumPartyMembers|GetRealNumPartyMembers]]() - Returns the number of other players in your non-battleground party. |
||
| − | : [[API GetPartyLeaderIndex|GetPartyLeaderIndex]]() - Returns the index of the party leader (1-4) if not yourself. |
||
| − | : [[API GetPartyMember|GetPartyMember]](index) - Returns 1 if the party member at the given index exists, nil otherwise.. |
||
| − | : [[API InviteUnit|InviteUnit]]("name" or "[[unitId|unit]]") - Invites the specified player to the group you are currently in ''(new for WoW 2.0)'' |
||
| − | : [[API IsPartyLeader|IsPartyLeader]]() - Returns true if the player is the party leader. |
||
| − | : [[API LeaveParty|LeaveParty]]() - Quit the party, often useful to troubleshoot "phantom party" bugs which may list you in a party when you are in fact not. |
||
| − | : [[API PromoteToLeader|PromoteToLeader]]("[[unitId|unit]]") - Promote a unit to party leader. |
||
| − | : [[API SetLootMethod|SetLootMethod]]("[[lootMethod]]"[, "masterPlayer" or threshold]) - Set the current loot method |
||
| − | : [[API SetLootThreshold|SetLootThreshold]](itemQuality) - Set the threshold for group/master loot |
||
| − | : HW [[API UninviteUnit|UninviteUnit]]("name" [, "reason"]) - Kick a unit from the party if player is group leader; or initiate a kick vote in an LFD group. |
||
| − | : [[API UnitInParty|UnitInParty]]("[[unitId|unit]]") - Returns true if the unit is a member of your party. |
||
| − | : [[API UnitIsPartyLeader|UnitIsPartyLeader]]("[[unitId|unit]]") - Returns true if the unit is the leader of its party. |
||
| − | |||
| − | === Guild Functions === |
||
| − | : [[API AcceptGuild|AcceptGuild]]() - The player accepts the invitation to join a guild. |
||
| − | : [[API BuyGuildCharter|BuyGuildCharter]]("guildName") - Purchases a guild charter for ''guildName''. |
||
| − | : [[API CanEditGuildEvent|CanEditGuildEvent]]() - Returns true if you are allowed to edit guild events (in the calendar), |
||
| − | : [[API CanEditGuildInfo|CanEditGuildInfo]]() - Returns true if you are allowed to edit the guild info |
||
| − | : [[API CanEditMOTD|CanEditMOTD]]() - Returns true if you are allowed to edit the guild motd. |
||
| − | : [[API CanEditOfficerNote|CanEditOfficerNote]]() - Returns true if you are allowed to edit a guild member's officer note. |
||
| − | : [[API CanEditPublicNote|CanEditPublicNote]]() - Returns true if you are allowed to edit a guild member's public note. |
||
| − | : [[API CanGuildDemote|CanGuildDemote]]() - Returns true if you are allowed to demote a guild member. |
||
| − | : [[API CanGuildInvite|CanGuildInvite]]() - Returns true if you are allowed to invite a new member to the guild. |
||
| − | : [[API CanGuildPromote|CanGuildPromote]]() - Returns true if you are allowed to demote a guild member. |
||
| − | : [[API CanGuildRemove|CanGuildRemove]]() - Returns true if you are allowed to remove a guild member. |
||
| − | : [[API CanViewOfficerNote|CanViewOfficerNote]]() - Returns true if you are allowed to view a Officer Note. |
||
| − | : [[API CloseGuildRegistrar|CloseGuildRegistrar]]() - ?. |
||
| − | : [[API CloseGuildRoster|CloseGuildRoster]]() - ?. |
||
| − | : [[API CloseTabardCreation|CloseTabardCreation]]() - ?. |
||
| − | : [[API DeclineGuild|DeclineGuild]]() - The player declines the invitation to join a guild. |
||
| − | : [[API GetGuildCharterCost|GetGuildCharterCost]]() - Returns the cost of purchasing a guild charter. |
||
| − | : [[API GetGuildEventInfo|GetGuildEventInfo]](index) - Returns the event information. (Added in 2.3) |
||
| − | : [[API GetGuildInfo|GetGuildInfo]]("[[unitId|unit]]") - This function returns the name of the guild ''unit'' belongs to. |
||
| − | : [[API GetGuildInfoText|GetGuildInfoText]]() - Returns the persistant Guild Information data. (new in 1.9) |
||
| − | : [[API GetGuildRosterInfo|GetGuildRosterInfo]](index) - This function is used to get info on members in the guild. |
||
| − | : [[API GetGuildRosterLastOnline|GetGuildRosterLastOnline]](index) - Returns time since last online for indexth member in current sort order. |
||
| − | : [[API GetGuildRosterMOTD|GetGuildRosterMOTD]]() - Returns guild's MOTD. |
||
| − | : [[API GetGuildRosterSelection|GetGuildRosterSelection]]() - Returns the index of the current selected guild member. |
||
| − | : [[API GetGuildRosterShowOffline|GetGuildRosterShowOffline]]() - Returns true if showing offline members of the guild. |
||
| − | : [[API GetNumGuildEvents|GetNumGuildEvents]]() - Returns the number of guild events. (Added in 2.3) |
||
| − | : [[API GetNumGuildMembers|GetNumGuildMembers]](offline) - Returns the number of guild members total. |
||
| − | : [[API GetTabardCreationCost|GetTabardCreationCost]]() - Returns cost in coppers. |
||
| − | : [[API GetTabardInfo|GetTabardInfo]]() -?. |
||
| − | : [[API GuildControlAddRank|GuildControlAddRank]]("name") - Add another rank called "name". Only Guildmaster. |
||
| − | : [[API GuildControlDelRank|GuildControlDelRank]]("name") - Delete rank "name". Only Guildmaster. |
||
| − | : [[API GuildControlGetNumRanks|GuildControlGetNumRanks]]() - Returns number of ranks after guild frame open. Any guild member can use this. |
||
| − | : [[API GuildControlGetRankFlags|GuildControlGetRankFlags]]() - Returns list of values for each permission for a select rank (default rank 1). |
||
| − | : [[API GuildControlGetRankName|GuildControlGetRankName]](index) - Returns name of the rank at index. Any guild member can use this. |
||
| − | : [[API GuildControlSaveRank|GuildControlSaveRank]]("name") - Saves the permissions for rank "name". Only Guildmaster. |
||
| − | : [[API GuildControlSetRank|GuildControlSetRank]](rank) - Sets the currently selected rank to view. |
||
| − | : [[API GuildControlSetRankFlag|GuildControlSetRankFlag]](index, enabled) - Enable/disable permission for an action at index. Only Guildmaster. |
||
| − | : [[API GuildDemote|GuildDemote]]("name") - Demotes a player "name". |
||
| − | : [[API GuildDisband|GuildDisband]]() - Disbands at once your guild. You must be the guild's leader to do so. Be careful, no warning is given prior disbanding. |
||
| − | : [[API GuildInfo|GuildInfo]]() - Displays information about the guild you are a member of. |
||
| − | : [[API GuildInvite|GuildInvite]]("name") - Invites a player to your guild. |
||
| − | : [[API GuildLeave|GuildLeave]]() - Removes you from your current guild. |
||
| − | : [[API GuildPromote|GuildPromote]]("name") - Promotes a player "name". |
||
| − | : [[API GuildRoster|GuildRoster]]() - Fetches the guild list and fires a GUILD_ROSTER_UPDATE event. |
||
| − | : [[API GuildRosterSetOfficerNote|GuildRosterSetOfficerNote]](index, "note") - Sets the officer note at index to "note". |
||
| − | : [[API GuildRosterSetPublicNote|GuildRosterSetPublicNote]](index, "note") - Sets the public note at index to "note". |
||
| − | : [[API GuildSetMOTD|GuildSetMOTD]]("note") - Set Guild Message of the Day to "note". |
||
| − | : [[API GuildSetLeader|GuildSetLeader]]("name") - Transfers guild leadership to another character. |
||
| − | : [[API GuildUninvite|GuildUninvite]]("name") - Removes the member "name". |
||
| − | : [[API IsGuildLeader|IsGuildLeader]]("name") - Determine if player "name" is a guild master. |
||
| − | : [[API IsInGuild|IsInGuild]]() - Lets you know whether you are in a guild. |
||
| − | : [[API QueryGuildEventLog|QueryGuildEventLog]]() - Fetches the guild event list and fires a GUILD_EVENT_LOG_UPDATE event. (Added in 2.3) |
||
| − | : [[API SetGuildInfoText|SetGuildInfoText]]() - Sets the persistant Guild Information data. Limit is 500 letters (GuildInfoEditBox is limited to this number). Longer texts are possible, but will be reseted during the day. (new in 1.9) |
||
| − | : [[API SetGuildRosterSelection|SetGuildRosterSelection]](index) - Selects/deselects a guild member according current sorting order. |
||
| − | : [[API SetGuildRosterShowOffline|SetGuildRosterShowOffline]](enabled) - Sets/Resets the show offline members flag. |
||
| − | : [[API SortGuildRoster|SortGuildRoster]]("sort") - Sorts guildroster according "sort". Any unknown values sort on "name". |
||
| − | |||
| − | === Guild Bank Functions === |
||
| − | All functions were added in [[Patch 2.3]] |
||
| − | : [[API AutoStoreGuildBankItem|AutoStoreGuildBankItem]](tab, slot) - Withdraws an item from the bank, and automatically stores it in the player's inventory. |
||
| − | : [[API BuyGuildBankTab|BuyGuildBankTab]]() - Buys a guild bank tab, without confirmation. |
||
| − | : [[API CanWithdrawGuildBankMoney|CanWithdrawGuildBankMoney]]() - Boolean, true if player is permitted to withdraw funds. No bank proximity required. |
||
| − | : [[API CloseGuildBankFrame|CloseGuildBankFrame]]() - Closes the guild bank frame |
||
| − | : [[API DepositGuildBankMoney|DepositGuildBankMoney]](money) - Deposits "money" amount in copper. |
||
| − | : [[API GetCurrentGuildBankTab|GetCurrentGuildBankTab]]() - Integer of selected tab, >= 1 |
||
| − | : [[API GetGuildBankItemInfo|GetGuildBankItemInfo]](tab, slot) - Returns texture, amount and integer 1 or nil depending on locked state |
||
| − | : [[API GetGuildBankItemLink|GetGuildBankItemLink]](tab, slot) - Returns itemLink |
||
| − | : [[API GetGuildBankMoney|GetGuildBankMoney]]() - Integer, funds available in copper. |
||
| − | : [[API GetGuildBankMoneyTransaction|GetGuildBankMoneyTransaction]](index) - No bank proximity required, however QueryGuildBankLog function requires proximity. |
||
| − | : [[API GetGuildBankTabCost|GetGuildBankTabCost]]() - Integer OR nil - cost in copper OR no tabs available to buy |
||
| − | : [[API GetGuildBankTabInfo|GetGuildBankTabInfo]](tab) - Returns the name and icon of the guild bank tab queried. |
||
| − | : [[API GetGuildBankTabPermissions|GetGuildBankTabPermissions]](tab) - Gets display / player's access info. Limited data available without bank proximity. |
||
| − | : [[API GetGuildBankTransaction|GetGuildBankTransaction]](tab, index) - Requires Guild Bank Proximity |
||
| − | : [[API GetGuildBankWithdrawGoldLimit|GetGuildBankWithdrawGoldLimit]]() - Returns withdraw limit for currently selected rank in guild control |
||
| − | : [[API GetGuildTabardFileNames|GetGuildTabardFileNames]]() |
||
| − | : [[API GetNumGuildBankMoneyTransactions|GetNumGuildBankMoneyTransactions]]() - Returns number of money log entries |
||
| − | : [[API GetNumGuildBankTabs|GetNumGuildBankTabs]]() - Integer count of bought tabs, >= 0. No bank proximity required. |
||
| − | : [[API GetNumGuildBankTransactions|GetNumGuildBankTransactions]](tab) - Returns number of log transactions for tab "tab" |
||
| − | : [[API PickupGuildBankItem|PickupGuildBankItem]](tab, slot) - Picks up an item from the guild bank |
||
| − | : [[API PickupGuildBankMoney|PickupGuildBankMoney]](money) - Picks up "money" copper from the guild bank |
||
| − | : [[API QueryGuildBankLog|QueryGuildBankLog]](tab) - Updates bank log data from the server, called before all transaction functions. "Money tab" is MAX_GUILDBANK_TABS+1 |
||
| − | : [[API QueryGuildBankTab|QueryGuildBankTab]](tab) - Updates bank tab data from the server, called before all item functions. |
||
| − | : [[API SetCurrentGuildBankTab|SetCurrentGuildBankTab]](tab) - Select different bank tab in the UI |
||
| − | : [[API SetGuildBankTabInfo|SetGuildBankTabInfo]](tab, name, iconIndex) - Modifies name and icon for tab |
||
| − | : [[API SetGuildBankTabPermissions|SetGuildBankTabPermissions]](tab, index, enabled) - Modifies the permissions for the GuildBankTab. Guild Leader Only. |
||
| − | : [[API SetGuildBankWithdrawGoldLimit|SetGuildBankWithdrawGoldLimit]](amount) - Sets the gold withdraw limit from the guild bank. Guild Leader Only. |
||
| − | : [[API SplitGuildBankItem|SplitGuildBankItem]](tab, slot, amount) - Picks up part of a stack |
||
| − | : [[API WithdrawGuildBankMoney|WithdrawGuildBankMoney]](money) - Withdraws "money" copper from the guild bank |
||
| − | |||
| − | === PVP Functions === |
||
| − | Functions related to PvP and Honor |
||
| − | |||
| − | : [[API GetHolidayBGHonorCurrencyBonuses|GetHolidayBGHonorCurrencyBonuses]]() - Return rewards for participating in a Call to Arms (holiday) battleground. (New: 3.3.3) |
||
| − | : [[API GetInspectHonorData|GetInspectHonorData]]() - Return honor info for the inspected unit (if available). |
||
| − | : [[API GetPVPLifetimeStats|GetPVPLifetimeStats]]() - Get your PvP/Honor statistics for your lifetime. |
||
| − | : [[API GetPVPRankInfo|GetPVPRankInfo]](rank[, [[unitId|unit]]]) - Get information about a specific PvP rank. |
||
| − | : [[API GetPVPRankProgress|GetPVPRankProgress]]() - Get information about the PvP rank progress. |
||
| − | : [[API GetPVPSessionStats|GetPVPSessionStats]]() - Get your PvP/Honor statistics for this session. |
||
| − | : [[API GetPVPYesterdayStats|GetPVPYesterdayStats]]() - Get your PvP/Honor statistics for yesterday. |
||
| − | : [[API GetRandomBGHonorCurrencyBonuses|GetRandomBGHonorCurrencyBonuses]]() - Returns rewards for participating in a random battleground. (New: 3.3.3) |
||
| − | : [[API HasInspectHonorData|HasInspectHonorData]]() - Determine if the inspected unit's honor data is available. |
||
| − | : [[API RequestInspectHonorData|RequestInspectHonorData]]() - Request honor data for inspected unit. |
||
| − | : [[API StartWarGame|StartWarGame]](target,area) - Starts a [[WarGame]]. |
||
| − | : [[API UnitPVPName|UnitPVPName]]("[[unitId|unit]]") - Returns unit's name with PvP rank prefix (e.g., "Corporal Allianceguy"). |
||
| − | : [[API UnitPVPRank|UnitPVPRank]]("[[unitId|unit]]") - Get PvP rank information for requested unit. |
||
| − | |||
| − | === Ignore Functions === |
||
| − | : [[API AddIgnore|AddIgnore]]("name") - Add a player to your ignore list. |
||
| − | : [[API AddOrDelIgnore|AddOrDelIgnore]]("name") - Toggles the ignore state of the specified name. |
||
| − | : [[API DelIgnore|DelIgnore]]("name") - Delete a player from your ignore list. |
||
| − | : [[API GetIgnoreName|GetIgnoreName]](index) - Get the name of the player on your ignore list at index. |
||
| − | : [[API GetNumIgnores|GetNumIgnores]]() - Get the number of players on your ignore list. |
||
| − | : [[API GetSelectedIgnore|GetSelectedIgnore]]() - Returns the currently selected index in the ignore listing |
||
| − | : [[API SetSelectedIgnore|SetSelectedIgnore]](index) - Sets the currently selected ignore entry |
||
| − | |||
| − | === Inspection Functions === |
||
| − | : [[API CanInspect|CanInspect]]("unit"[, showError]) - Returns whether you can inspect the specified unit. |
||
| − | : [[API CheckInteractDistance|CheckInteractDistance]]("unit", interaction) - Returns whether you're in range to preform various interactions with the specified unit. |
||
| − | : [[API ClearInspectPlayer|ClearInspectPlayer]]() - Reset inspect data once finished with it. |
||
| − | : [[API GetInspectArenaTeamData|GetInspectArenaTeamData]](index) - Returns information about one of the inspected player's arena teams. |
||
| − | : [[API HasInspectHonorData|HasInspectHonorData]]() - Determine if the inspected unit's honor statistics are available. |
||
| − | : [[API RequestInspectHonorData|RequestInspectHonorData]]() - Request honor information for inspected unit. |
||
| − | : [[API GetInspectHonorData|GetInspectHonorData]]() - Return honor information about the inspected player. |
||
| − | : [[API NotifyInspect|NotifyInspect]]("unit") - Requests information about a unit's inventory and talents from the server. |
||
| − | : UI [[API InspectUnit|InspectUnit]]("unit") - Instructs FrameXML to inspect a particular unit (query server; show UI). |
||
| − | |||
| − | === Instance Functions === |
||
| − | : [[API CanShowResetInstances|CanShowResetInstances]]() - Determine if player can reset instances at the moment. |
||
| − | : [[API GetBattlefieldInstanceExpiration|GetBattlefieldInstanceExpiration]]() - Get shutdown timer for the battlefield instance. |
||
| − | : [[API GetBattlefieldInstanceInfo|GetBattlefieldInstanceInfo]](index) - Get the instance ID for a battlefield. |
||
| − | : [[API GetBattlefieldInstanceRunTime|GetBattlefieldInstanceRunTime]]() - In milliseconds, the time since battleground started (seems to be queried from server because it is not in sync with time()). |
||
| − | : [[API GetInstanceBootTimeRemaining|GetInstanceBootTimeRemaining]]() - Gets the time in seconds after which the player will be ejected from an instance. |
||
| − | : [[API GetInstanceInfo|GetInstanceInfo]]() - Gets informations about the current Instance |
||
| − | : [[API GetNumSavedInstances|GetNumSavedInstances]]() - Gets the number of instances that the player is saved to. |
||
| − | : [[API GetSavedInstanceInfo|GetSavedInstanceInfo]](index) - Gets information about an instance that the player is saved to. |
||
| − | : [[API IsInInstance|IsInInstance]]() - Returns 1 if the player is in an instance, as well as the type of instance (pvp, raid, etc.). |
||
| − | : [[API ResetInstances|ResetInstances]]() - Reset instances. |
||
| − | : [[API GetDungeonDifficulty|GetDungeonDifficulty]]() - Returns the player's current Dungeon Difficulty setting (1-3). |
||
| − | : [[API SetDungeonDifficulty|SetDungeonDifficulty]](difficulty) - Sets the player's Dungeon Difficulty setting (for the 5-man instances). |
||
| − | : [[API GetInstanceDifficulty|GetInstanceDifficulty]]() - Returns the current instance's Dungeon Difficulty (1-4, or 1 if player is not in an instance). |
||
| − | : [[API GetInstanceLockTimeRemaining|GetInstanceLockTimeRemaining]]() - Returns information about the instance lock timer for the instance the player is currently entering. |
||
| − | : [[API GetInstanceLockTimeRemainingEncounter|GetInstanceLockTimeRemainingEncounter]](id) - Returns information about bosses in the instance the player is about to be saved to. |
||
| − | |||
| − | === Inventory Functions === |
||
| − | These functions manage your "inventory", that is, '''equipped items'''. See also [[#Container/Bag Functions|Container/Bag Functions]] and [[#Bank Functions|Bank Functions]]. |
||
| − | |||
| − | : [[API AutoEquipCursorItem|AutoEquipCursorItem]]() - Causes the equipment on the cursor to be equipped. |
||
| − | : [[API BankButtonIDToInvSlotID|BankButtonIDToInvSlotID]](buttonID, isBag) - Returns the ID number of a bank button or bag in terms of inventory slot ID. |
||
| − | : [[API CancelPendingEquip|CancelPendingEquip]](index) - This function is used to cancel a pending equip. |
||
| − | : [[API ConfirmBindOnUse|ConfirmBindOnUse]]() |
||
| − | : [[API ContainerIDToInventoryID|ContainerIDToInventoryID]]([[bagId|bagID]]) |
||
| − | : [[API CursorCanGoInSlot|CursorCanGoInSlot]]([[inventorySlotId|invSlot]]) - Return true if the item currently held by the cursor can go into the given inventory (equipment) slot |
||
| − | : [[API EquipCursorItem|EquipCursorItem]]([[inventorySlotId|invSlot]]) |
||
| − | : [[API EquipPendingItem|EquipPendingItem]]([[inventorySlotId|invSlot]]) - Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot. (Internal — do not use.) |
||
| − | : [[API GetInventoryAlertStatus|GetInventoryAlertStatus]](index) - Returns one of several codes describing the "status" of an equipped item. |
||
| − | : [[API GetInventoryItemBroken|GetInventoryItemBroken]]("[[unitId|unit]]",[[inventorySlotId|invSlot]]) - Determine if an inventory item is broken (no durability). |
||
| − | : [[API GetInventoryItemCooldown|GetInventoryItemCooldown]]("[[unitId|unit]]",[[inventorySlotId|invSlot]]) - Get cooldown information for an inventory item. |
||
| − | : [[API GetInventoryItemCount|GetInventoryItemCount]]("[[unitId|unit]]",[[inventorySlotId|invSlot]]) - Determine the quantity of an item in an inventory slot. |
||
| − | : [[API GetInventoryItemDurability|GetInventoryItemDurability]]([[inventorySlotId|invSlot]]) - Returns the maximum and remaining durability points for an inventory item. |
||
| − | : [[API GetInventoryItemGems|GetInventoryItemGems]](invSlot) - Returns item ids of the gems socketed in the item in the specified inventory slot. |
||
| − | : [[API GetInventoryItemID|GetInventoryItemID]]("unit", invSlot) - Returns the item id of the item in the specified inventory slot. |
||
| − | : [[API GetInventoryItemLink|GetInventoryItemLink]]("[[unitId|unit]]",[[inventorySlotId|slotId]]) - Returns an [[itemLink]] for an inventory (equipped) item. |
||
| − | : [[API GetInventoryItemQuality|GetInventoryItemQuality]]("[[unitId|unit]]",[[inventorySlotId|invSlot]]) - Return the quality of an inventory item. |
||
| − | : [[API GetInventoryItemTexture|GetInventoryItemTexture]]("[[unitId|unit]]",[[inventorySlotId|invSlot]]) - Return the texture for an inventory item. |
||
| − | : [[API GetInventorySlotInfo|GetInventorySlotInfo]]([[inventorySlotName|invSlotName]]) - Get the info for a named inventory slot (slot ID and texture) |
||
| − | : [[API GetWeaponEnchantInfo|GetWeaponEnchantInfo]]() - Return information about main and offhand weapon enchantments. |
||
| − | : [[API HasWandEquipped|HasWandEquipped]]() - Returns 1 if a wand is equipped, false otherwise. |
||
| − | : [[API IsInventoryItemLocked|IsInventoryItemLocked]](id) - Returns whether an inventory item is locked, usually as it awaits pending action. |
||
| − | : [[API KeyRingButtonIDToInvSlotID|KeyRingButtonIDToInvSlotID]](buttonID) - Map a keyring button to an inventory slot button for use in inventory functions. |
||
| − | : [[API PickupBagFromSlot|PickupBagFromSlot]](slot) - Picks up the bag from the specified slot, placing it in the cursor. If an item is already picked up, this places the item into the specified slot, swapping the items if needed. |
||
| − | : [[API PickupInventoryItem|PickupInventoryItem]]([[inventorySlotId|invSlot]]) - "Picks up" an item from the player's worn inventory. |
||
| − | : [[API UpdateInventoryAlertStatus|UpdateInventoryAlertStatus]]() |
||
| − | : PROTECTED [[API UseInventoryItem|UseInventoryItem]]([[inventorySlotId|invSlot]]) - Use an item in a specific inventory slot. |
||
| − | |||
| − | === Item Functions === |
||
| − | These functions are those which operate on item links or item information directly. See also [[#Container/Bag Functions|Container/Bag Functions]] and [[#Inventory Functions|Inventory Functions]]. |
||
| − | |||
| − | : [[API EquipItemByName|EquipItemByName]](itemId or "itemName" or "[[itemLink]]"[, [[inventorySlotId|slot]]]) - Equips an item, optionally into a specified slot. |
||
| − | : [[API GetAuctionItemLink|GetAuctionItemLink]]("type", index) - Returns an [[itemLink]] for the specified auction item. |
||
| − | : [[API GetContainerItemLink|GetContainerItemLink]]([[bagId|bagID]], slot) - Returns the [[itemLink]] of the item located in bag#, slot#. |
||
| − | : [[API GetItemCooldown|GetItemCooldown]](itemId) - Returns startTime, duration, enable. |
||
| − | : [[API GetItemCount|GetItemCount]](itemId or "itemName" or "[[itemLink]]"[, includeBank][, includeCharges]) - Returns number of such items in inventory[, or charges instead if it has charges] |
||
| − | : [[API GetItemFamily|GetItemFamily]](itemId or "itemName" or "[[itemLink]]") - Returns the bag type that an item can go into, or for bags the type of items that it can contain. (New in [[Patch 2.4]]) |
||
| − | : [[API GetItemIcon|GetItemIcon]](itemId) - Returns the icon for the item. Works for any valid item even if it's not in the cache. (New in [[Patch 2.4]]) |
||
| − | : [[API GetItemInfo|GetItemInfo]](itemId or "[[itemString]]" or "itemName" or "[[itemLink]]") - Returns information about an item. |
||
| − | : [[API GetItemQualityColor|GetItemQualityColor]](quality) - Returns the RGB color codes for a quality. |
||
| − | : [[API GetItemSpell|GetItemSpell]](item) - Returns name, rank. |
||
| − | : [[API GetItemStats|GetItemStats]](itemLink, statTable) - Returns a table of stats for an item. |
||
| − | : [[API GetMerchantItemLink|GetMerchantItemLink]](index) - Returns an [[itemLink]] for the given purchasable item |
||
| − | : [[API GetQuestItemLink|GetQuestItemLink]]("type", index) - Returns an [[itemLink]] for a quest reward item. |
||
| − | : [[API GetQuestLogItemLink|GetQuestLogItemLink]]("type", index) - Returns an [[itemLink]] for a quest reward item. |
||
| − | : [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](id) - Returns an [[itemLink]] for the given item in your side of the trade window (if open) |
||
| − | : [[API GetTradeSkillItemLink|GetTradeSkillItemLink]](index) - Returns the [[itemLink]] for a trade skill item. |
||
| − | : [[API GetTradeSkillReagentItemLink|GetTradeSkillReagentItemLink]](index, reagentId) - Returns the [[itemLink]] for one of the reagents needed to craft the given item |
||
| − | : [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](id) - Returns an [[itemLink]] for the given item in the other player's side of the trade window (if open) |
||
| − | : [[API IsUsableItem|IsUsableItem]](item) - Returns usable, noMana. |
||
| − | : [[API IsConsumableItem|IsConsumableItem]](item) - |
||
| − | : [[API IsCurrentItem|IsCurrentItem]](item) - |
||
| − | : [[API IsEquippedItem|IsEquippedItem]](item) - |
||
| − | : [[API IsEquippableItem|IsEquippableItem]](itemId or "itemName" or "[[itemLink]]") - Returns 1 or nil. |
||
| − | : [[API IsEquippedItemType|IsEquippedItemType]]("type") - Where "type" is any valid inventory type, item class, or item subclass. |
||
| − | : [[API IsItemInRange|IsItemInRange]]("itemName" or "[[itemLink]]", "[[unitId|unit]]") - Nil for invalid target, 0 for out of range, 1 for in range. |
||
| − | : [[API ItemHasRange|ItemHasRange]](item) - |
||
| − | : [[API OffhandHasWeapon|OffhandHasWeapon]]() - Determine if your offhand carries a weapon. |
||
| − | : [[API SplitContainerItem|SplitContainerItem]](bagID,slot,amount) - Picks up part of a stack. |
||
| − | : UI [[API SetItemRef|SetItemRef]](link, text, button) - Handles item link tooltips in chat. |
||
| − | |||
| − | === Item Socketing Functions === |
||
| − | The following were introduced along with socketed items and gems in [[Patch 2.0]]. id refers to a 1-based index of the sockets in the item being considered for socketing. |
||
| − | : [[API AcceptSockets|AcceptSockets]]() - Sockets tentative gems into the sockets, replacing existing gems if necessary. |
||
| − | : [[API ClickSocketButton|ClickSocketButton]](id) - If the cursor is currently holding a gem, tentatively insert it into the socket. |
||
| − | : [[API CloseSocketInfo|CloseSocketInfo]]() - Stops considering the item for socketing, without applying changes. |
||
| − | : [[API GetSocketItemInfo|GetSocketItemInfo]]() - Returns information about the item currently being socketed. |
||
| − | : [[API GetSocketItemRefundable|GetSocketItemRefundable]]() - Returns whether the item currently being socketed is refundable. |
||
| − | : [[API GetSocketItemBoundTradeable|GetSocketItemBoundTradeable]]() - Returns whether the item currently being socketed is temporarily tradable (BoP boss loot). |
||
| − | : [[API GetNumSockets|GetNumSockets]]() - Returns the number of sockets in the item currently being socketed. |
||
| − | : [[API GetSocketTypes|GetSocketTypes]](id) - Returns the type (color) of a socket in the item. |
||
| − | : [[API GetExistingSocketInfo|GetExistingSocketInfo]](id) - Returns information about the existing gem in the socket. |
||
| − | : [[API GetExistingSocketLink|GetExistingSocketLink]](id) - Returns an item link for the existing gem in the socket. |
||
| − | : [[API GetNewSocketInfo|GetNewSocketInfo]](id) - Returns information about the new (tentative) gem in the socket. |
||
| − | : [[API GetNewSocketLink|GetNewSocketLink]](id) - Returns an item link for the new (tentative) gem in the socket. |
||
| − | : [[API SocketInventoryItem|SocketInventoryItem]](slot) - Considers the item in the inventory slot for socketing. |
||
| − | : [[API SocketContainerItem|SocketContainerItem]](bag, slot) - Consider an item in a container slot for socketing. |
||
| − | |||
| − | === Item Text Functions === |
||
| − | These functions relate to item text (books, etc) |
||
| − | |||
| − | : [[API CloseItemText|CloseItemText]]() - Close an open item text (book, plaque, etc). |
||
| − | : [[API ItemTextGetCreator|ItemTextGetCreator]]() - Get the creator of the current text (if player-created). |
||
| − | : [[API ItemTextGetItem|ItemTextGetItem]]() - Get the name of the text. |
||
| − | : [[API ItemTextGetMaterial|ItemTextGetMaterial]]() - Get the material on which the text is printed. |
||
| − | : [[API ItemTextGetPage|ItemTextGetPage]]() - Get the page number of the currently viewed page. |
||
| − | : [[API ItemTextGetText|ItemTextGetText]]() - Get the page contents of the currently viewed page. |
||
| − | : [[API ItemTextHasNextPage|ItemTextHasNextPage]]() - Determine if there is another page after the current one. |
||
| − | : [[API ItemTextNextPage|ItemTextNextPage]]() - Request the next page of the text. |
||
| − | : [[API ItemTextPrevPage|ItemTextPrevPage]]() - Request the previous page of the text. |
||
| − | |||
| − | === Knowledge Base Functions === |
||
| − | :[[API KBArticle_BeginLoading|KBArticle_BeginLoading]](articleId, searchType) - Starts the article loading process. |
||
| − | :[[API KBArticle_GetData|KBArticle_GetData]]() - Returns information about the current article. |
||
| − | :[[API KBArticle_IsLoaded|KBArticle_IsLoaded]]() - Returns true if an article is loaded. |
||
| − | :[[API KBQuery_BeginLoading|KBQuery_BeginLoading]](searchText, categoryIndex, subcategoryIndex, articlesPerPage, curPage) - Starts a query for articles. |
||
| − | :[[API KBQuery_GetArticleHeaderCount|KBQuery_GetArticleHeaderCount]]() - Returns the number of article headers in the current query. |
||
| − | :[[API KBQuery_GetArticleHeaderData|KBQuery_GetArticleHeaderData]](index) - Returns information about an article header of the current query. |
||
| − | :[[API KBQuery_GetTotalArticleCount|KBQuery_GetTotalArticleCount]]() - Returns the total number of articles that matches the current query. |
||
| − | :[[API KBQuery_IsLoaded|KBQuery_IsLoaded]]() - Returns true if a query loaded successfuly. |
||
| − | :[[API KBSetup_BeginLoading|KBSetup_BeginLoading]](articlesPerPage, curPage) - Starts the loading process for the KB start page. |
||
| − | :[[API KBSetup_GetArticleHeaderCount|KBSetup_GetArticleHeaderCount]]() - Returns the number of articles for the current page. |
||
| − | :[[API KBSetup_GetArticleHeaderData|KBSetup_GetArticleHeaderData]](index) - Returns information for an article header. |
||
| − | :[[API KBSetup_GetCategoryCount|KBSetup_GetCategoryCount]]() - Returns the number of categories in the knowledge base. |
||
| − | :[[API KBSetup_GetCategoryData|KBSetup_GetCategoryData]](index) - Returns information about a category. |
||
| − | :[[API KBSetup_GetLanguageCount|KBSetup_GetLanguageCount]]() - Returns the number of languages in the knowledge base. |
||
| − | :[[API KBSetup_GetLanguageData|KBSetup_GetLanguageData]](index) - Returns information about a language. |
||
| − | :[[API KBSetup_GetSubCategoryCount|KBSetup_GetSubCategoryCount]](category) - Returns the number of subcategories for a category. |
||
| − | :[[API KBSetup_GetSubCategoryData|KBSetup_GetSubCategoryData]](category, index) - Returns information about a subcategory. |
||
| − | :[[API KBSetup_GetTotalArticleCount|KBSetup_GetTotalArticleCount]]() - Returns the total number of articles in the knowlege base. |
||
| − | :[[API KBSetup_IsLoaded|KBSetup_IsLoaded]]() - Returns true if the knowledge base is loaded successfuly. |
||
| − | :[[API KBSystem_GetMOTD|KBSystem_GetMOTD]]() - Returns the server message of the day. |
||
| − | :[[API KBSystem_GetServerNotice|KBSystem_GetServerNotice]]() - Returns the server notice. |
||
| − | :[[API KBSystem_GetServerStatus|KBSystem_GetServerStatus]]() - Returns the server status text. |
||
| − | |||
| − | === Location Functions === |
||
| − | These functions are related to the current location of the player and how it is displayed. |
||
| − | |||
| − | : [[API GetMinimapZoneText|GetMinimapZoneText]]() - Returns the zone text, that is displayed over the minimap. |
||
| − | : [[API GetRealZoneText|GetRealZoneText]]() - Returns either instance name or zone name |
||
| − | : [[API GetSubZoneText|GetSubZoneText]]() - Returns the subzone text (e.g. "The Canals"). |
||
| − | : [[API GetZonePVPInfo|GetZonePVPInfo]]() - Returns PVP info for the current zone. |
||
| − | : [[API GetZoneText|GetZoneText]]() - Returns the zone text (e.g. "Stormwind City"). |
||
| − | |||
| − | === Looking For Group Functions=== |
||
| − | Functions for use in the Looking For Group tool. See also: [[#Dungeon Finder Functions|Dungeon Finder Functions]] and [[#Raid Browser Functions|Raid Browser Functions]] |
||
| − | : [[API CompleteLFGRoleCheck|CompleteLFGRoleCheck]](boolean) - boolean = false means declining the roleCheck. The returned boolean seems to indicate that the roleCheck was successful? |
||
| − | : [[API GetLFGDeserterExpiration|GetLFGDeserterExpiration]]() - Returns the time at which you may once again use the dungeon finder after prematurely leaving a group. (3.3.3) |
||
| − | : [[API GetLFGRandomCooldownExpiration|GetLFGRandomCooldownExpiration]]() - Returns the time at which you may once again queue for a random dungeon. (3.3.3) |
||
| − | : [[API GetLFGBootProposal|GetLFGBootProposal]]() - Returns information about an LFG Kick vote in progress. |
||
| − | : UI [[API GetLFGMode|GetLFGMode]]() - returns mode, subMode (sometimes empty result) |
||
| − | : [[API GetLFGQueueStats|GetLFGQueueStats]]() - returns current state and wait times for being in queue |
||
| − | : [[API GetLFGRoles|GetLFGRoles]]() - returns isLeader, isTank, isHealer, isDPS - Returns the roles you signed up as, not the role you were assigned. |
||
| − | : [[API GetLFGRoleUpdate|GetLFGRoleUpdate]]() - returns roleCheckInProgress, slots, members |
||
| − | : [[API GetLFGRoleUpdateSlot|GetLFGRoleUpdateSlot]](slot) - returns dungeonType, dungeonID for a particular role slot (integer) |
||
| − | : [[API SetLFGBootVote|SetLFGBootVote]](boolean) - responds to a vote-kick |
||
| − | : [[API SetLFGComment|SetLFGComment]]("comment") |
||
| − | : [[API SetLFGRoles|SetLFGRoles]](isLeader, isTank, isHealer, isDPS) - changes the selected roles |
||
| − | : [[API UninviteUnit|UninviteUnit]]("name" [, "reason"]) - initiate a kick vote in a LFD group. |
||
| − | : [[API UnitGroupRolesAssigned|UnitGroupRolesAssigned]](UnitID) - Return's the targeted unit's assigned role. |
||
| − | : [[API UnitHasLFGDeserter|UnitHasLFGDeserter]]("unit") - returns whether the specified unit has recently deserted |
||
| − | : [[API UnitHasLFGRandomCooldown|UnitHasLFGRandomCooldown]]("unit") - returns whether the specified unit has recently queued for a random |
||
| − | |||
| − | === Loot Functions === |
||
| − | Automatic looting behavior is controlled by [[CVar autoLootDefault|autoLootDefalt]] [[CVar]]. |
||
| − | : [[API CloseLoot|CloseLoot]]([uiFailedFlag]) |
||
| − | : PROTECTED [[API ConfirmBindOnUse|ConfirmBindOnUse]]() |
||
| − | : [[API ConfirmLootRoll|ConfirmLootRoll]](rollId[, roll]) - Confirm a loot roll (NEW IN 1300) |
||
| − | : [[API ConfirmLootSlot|ConfirmLootSlot]](slot) - Confirm looting of a BoP item. |
||
| − | : [[API GetLootMethod|GetLootMethod]]() - Return the currently active [[lootMethod]] |
||
| − | : [[API GetLootRollItemInfo|GetLootRollItemInfo]](rollId) |
||
| − | : [[API GetLootRollItemLink|GetLootRollItemLink]](rollId) |
||
| − | : [[API GetLootRollTimeLeft|GetLootRollTimeLeft]](rollid) |
||
| − | : [[API GetLootSlotInfo|GetLootSlotInfo]](slot) - Returns icon path, item name, and item quantity for the item in the given loot window slot |
||
| − | : [[API GetLootSlotLink|GetLootSlotLink]](slot) - Returns an [[itemLink]] for the item in the given loot window slot |
||
| − | : [[API GetLootThreshold|GetLootThreshold]]() - Return the current loot threshold (for group/master loot) |
||
| − | : [[API GetMasterLootCandidate|GetMasterLootCandidate]](index) - Return the name of a player who is eligible to receive loot in master mode |
||
| − | : [[API GetNumLootItems|GetNumLootItems]]() - Returns amount of objects to loot (number) |
||
| − | : [[API GetOptOutOfLoot|GetOptOutOfLoot]]() - Return whether the character is currently automatically passing on all loot. |
||
| − | : [[API GiveMasterLoot|GiveMasterLoot]](slot,index) |
||
| − | : [[API IsFishingLoot|IsFishingLoot]]() |
||
| − | : [[API LootSlot|LootSlot]](slot) - Used to loot the specified slot. |
||
| − | : [[API LootSlotIsCoin|LootSlotIsCoin]](slot) |
||
| − | : [[API LootSlotIsItem|LootSlotIsItem]](slot) |
||
| − | : [[API RollOnLoot|RollOnLoot]](rollId[, roll]) - Roll or pass on a loot event started by the game engine. |
||
| − | : [[API SetLootMethod|SetLootMethod]]("[[lootMethod]]"[, "masterPlayer" or threshold]) - Set the current loot method. |
||
| − | : [[API SetLootPortrait|SetLootPortrait]]() |
||
| − | : [[API SetLootThreshold|SetLootThreshold]]([[itemQuality]]) - Set the threshold for group/master loot. |
||
| − | : [[API SetOptOutOfLoot|SetOptOutOfLoot]](optOut) - Enables or disables automatic passing on all loot. |
||
| − | |||
| − | === Macro Functions === |
||
| − | : NOCOMBAT (2.0) [[API CreateMacro|CreateMacro]]("name", icon, "body", perCharacter, isLocal) - Create a new macro. |
||
| − | : [[API CursorHasMacro|CursorHasMacro]]() - Returns 1 if the cursor is currently dragging a macro. (New: 2.0.3) |
||
| − | : [[API DeleteMacro|DeleteMacro]](id or "name") - Deletes a macro. |
||
| − | : NOCOMBAT (2.0) [[API EditMacro|EditMacro]](index, "name", iconIndex, "body", isLocal, perCharacter) - Saves a macro. |
||
| − | : [[API GetMacroBody|GetMacroBody]](id or "name") - Returns the body (macro text) of a macro. |
||
| − | : [[API GetMacroIconInfo|GetMacroIconInfo]](index) - Returns texture of the icons provided by Blizzard. |
||
| − | : [[API GetMacroItemIconInfo|GetMacroItemIconInfo]](index) - Returns texture of the item icons provided by Blizzard |
||
| − | : [[API GetMacroIndexByName|GetMacroIndexByName]]("name") - Returns macro index. |
||
| − | : [[API GetMacroInfo|GetMacroInfo]](id or "name") - Returns "name", "iconTexture", "body", isLocal. |
||
| − | : [[API GetNumMacroIcons|GetNumMacroIcons]]() - Returns the number of usable icons provided by Blizzard. |
||
| − | : [[API GetNumMacroItemIcons|GetNumMacroItemIcons]]() - Returns the number of usable item icons provided by Blizzard. |
||
| − | : [[API GetNumMacros|GetNumMacros]]() - Returns the number of macros the user has. |
||
| − | : [[API PickupMacro|PickupMacro]](id or "name") - Pickup a macro button icon. |
||
| − | : PROTECTED [[API RunMacro|RunMacro]](id or "name") - Runs a macro. |
||
| − | : PROTECTED [[API RunMacroText|RunMacroText]]("macro") - Interpret the given string as a macro and run it. |
||
| − | : [[API SecureCmdOptionParse|SecureCmdOptionParse]]("command") - Used for evaluating conditionals in macros, returning the appropriate choice. |
||
| − | : PROTECTED [[API StopMacro|StopMacro]]() - Stops the currently executing macro. |
||
| − | |||
| − | === Mail Functions === |
||
| − | [[Events/Mail|Events associated with Mail.]] |
||
| − | |||
| − | : [[API AutoLootMailItem|AutoLootMailItem]](index) - Loot all items from mail message. |
||
| − | : [[API CheckInbox|CheckInbox]]() - Populate client's inbox with mail from server. |
||
| − | : [[API ClearSendMail|ClearSendMail]]() - This clears the text in the send mail tab and places the COD item in the inventory. |
||
| − | : [[API ClickSendMailItemButton|ClickSendMailItemButton]]([itemIndex, [clearItem]]) - Places or picks up an item from the send mail frame. |
||
| − | : [[API CloseMail|CloseMail]]() - Closes the mail window. |
||
| − | : [[API DeleteInboxItem|DeleteInboxItem]](index) - Deletes the inbox item at index. It returns immediately, it does not seem to wait for the deletion to go through, giving the normal problems with rapid mail removal attempts. |
||
| − | : [[API DropCursorMoney|DropCursorMoney]] - Drops the amount of money held by the cursor. |
||
| − | : [[API GetCoinIcon|GetCoinIcon]](amount) |
||
| − | : [[API GetInboxHeaderInfo|GetInboxHeaderInfo]](index) - Returns information about a message in the inbox. |
||
| − | : [[API GetInboxItem|GetInboxItem]](index, itemIndex) - Returns description of the attachment attached to message at (index). |
||
| − | : [[API GetInboxItemLink|GetInboxItemLink]](index, itemIndex) - Returns link of the attachment attached to message at (index). |
||
| − | : [[API GetInboxNumItems|GetInboxNumItems]]() - Returns the number of messages in your inbox. |
||
| − | : [[API GetInboxText|GetInboxText]](index) - Returns the message text of message at (index). |
||
| − | : [[API GetInboxInvoiceInfo|GetInboxInvoiceInfo]](index) - Returns informations about an auction house invoice. |
||
| − | : [[API GetLatestThreeSenders|GetLatestThreeSenders]] - Returns the senders of the most recent unread mail. |
||
| − | : [[API GetNumPackages|GetNumPackages]]() - Not yet fully implemented. Currently it always returns 1. |
||
| − | : [[API GetNumStationeries|GetNumStationeries]]() - Not yet fully implemented. Currently it always returns 1. |
||
| − | : [[API GetPackageInfo|GetPackageInfo]](index) - Not yet fully implemented. Currently an index of 1 returns "Test Package". |
||
| − | : [[API GetSelectedStationeryTexture|GetSelectedStationeryTexture]]() - Not yet fully implemented. Currently it returns "STATIONERYTEST" when the mailbox is open. |
||
| − | : [[API GetSendMailCOD|GetSendMailCOD]]() - determine amount of gold entered in COD box in mail frame when mail is sent |
||
| − | : [[API GetSendMailItem|GetSendMailItem]](index) - Get information about an item attached on the send mail frame. |
||
| − | : [[API GetSendMailItemLink|GetSendMailItemLink]](index) - Get link for an item attached on the send mail frame. |
||
| − | : [[API GetSendMailMoney|GetSendMailMoney]]() - ?. |
||
| − | : [[API GetSendMailPrice|GetSendMailPrice]]() - Gets the cost for sending mail. |
||
| − | : [[API GetStationeryInfo|GetStationeryInfo]](index) - Not yet fully implemented. Currently an index of 1 returns "Default Stationery". |
||
| − | : [[API HasNewMail|HasNewMail]]() - Returns nil if there is no new mail. |
||
| − | : [[API InboxItemCanDelete|InboxItemCanDelete]](index) - Boolean check for whether a message is returnable to the sender. |
||
| − | : [[API ReturnInboxItem|ReturnInboxItem]](index) - Returns to the sender the attached item in the mail message at the specified index. |
||
| − | : [[API SelectPackage|SelectPackage]](index) - Not yet fully implemented. It does nothing visible. |
||
| − | : [[API SelectStationery|SelectStationery]](index) - Not yet fully implemented. It does nothing visible. |
||
| − | : [[API SendMail|SendMail]]("target", "subject", "body") - If the mailbox is open, this sends mail. |
||
| − | : PROTECTED [[API SetSendMailCOD|SetSendMailCOD]](amount) - Make next mail sent using SendMail() COD target for amount. -- Protected as of 2.0 |
||
| − | : PROTECTED [[API SetSendMailMoney|SetSendMailMoney]](amount) - Add money to next mail sent using SendMail(). -- Protected as of 2.0 |
||
| − | : [[API TakeInboxItem|TakeInboxItem]](index, itemIndex) - Take the attached item from the mailbox message at index. |
||
| − | : [[API TakeInboxMoney|TakeInboxMoney]](index) - Take the attached money from the mailbox message at index. |
||
| − | : [[API TakeInboxTextItem|TakeInboxTextItem]](index) - Creates a permanent copy of letter (readable "Plain Letter"). |
||
| − | |||
| − | === Mapping Functions === |
||
| − | These functions are related to display of the world map. |
||
| − | |||
| − | : [[API ClickLandmark|ClickLandmark]](id) - ? |
||
| − | : [[API GetCorpseMapPosition|GetCorpseMapPosition]]() - Returns the position of the corpse on the current world map. |
||
| − | : [[API GetCurrentMapContinent|GetCurrentMapContinent]]() - Returns the number of the continent the world map is currently shown. |
||
| − | : [[API GetCurrentMapDungeonLevel|GetCurrentMapDungeonLevel]]() - Returns which level of a multi-level map is currently shown. |
||
| − | : [[API GetNumDungeonMapLevels|GetNumDungeonMapLevels]]() - Returns the number of levels in the currently shown zone map (0 for none). |
||
| − | : [[API GetCurrentMapAreaID|GetCurrentMapAreaID]] () - Returns the area id of the current map. |
||
| − | : [[API GetCurrentMapZone|GetCurrentMapZone]]() - Returns the number of the zone the world map is currently showing. |
||
| − | : [[API GetMapContinents|GetMapContinents]]() - Returns the continent names. |
||
| − | : [[API GetMapDebugObjectInfo|GetMapDebugObjectInfo]](id) - ? |
||
| − | : [[API GetMapInfo|GetMapInfo]]() - Returns the name and size of the current world map. |
||
| − | : [[API GetMapLandmarkInfo|GetMapLandmarkInfo]](landmarkIndex) - Returns information about a landmark on the current world map. |
||
| − | : [[API GetMapOverlayInfo|GetMapOverlayInfo]](overlayIndex) - Returns information about an overlay on the current world map. |
||
| − | : [[API GetMapZones|GetMapZones]](continentIndex) - Returns the zone names of a continent. |
||
| − | : [[API GetNumMapDebugObjects|GetNumMapDebugObjects]]() - ? |
||
| − | : [[API GetNumMapLandmarks|GetNumMapLandmarks]]() - Returns the number of landmarks on the current world map. |
||
| − | : [[API GetNumMapOverlays|GetNumMapOverlays]]() - Returns the number of overlays on the current world map. |
||
| − | : [[API GetPlayerMapPosition|GetPlayerMapPosition]]("[[unitId|unit]]") - Returns the position of a unit on the current world map. |
||
| − | : [[API ProcessMapClick|ProcessMapClick]](x,y) - Passes a click to the client, which then calculates if the zone has to be changed. |
||
| − | : [[API RequestBattlefieldPositions|RequestBattlefieldPositions]]() - Request new data for GetBattlefieldPosition(). |
||
| − | : [[API SetDungeonMapLevel|SetDungeonMapLevel]](level) - Sets which level of a multi-level map (Dalaran, dungeons, etc) is currently shown. |
||
| − | : [[API SetMapByID|SetMapByID]](id) - Set map by area id. |
||
| − | : [[API SetMapToCurrentZone|SetMapToCurrentZone]]() - Sets the current world map to the zone the player is presently in. |
||
| − | : [[API SetMapZoom|SetMapZoom]](continentIndex[, zoneIndex]) - Sets the current world map to a specific continent and optionally zone. |
||
| − | : [[API SetupFullscreenScale|SetupFullscreenScale]]() - Configures scale of full-screen views, such as the world map, to best fill screen. |
||
| − | : [[API UpdateMapHighlight|UpdateMapHighlight]](x,y) - Provides map rollover information for highlighting. |
||
| − | : [[API CreateWorldMapArrowFrame|CreateWorldMapArrowFrame]]("frame") - create a arrow cursor for the player position and orientation. |
||
| − | : [[API UpdateWorldMapArrowFrames|UpdateWorldMapArrowFrames]]() - update the orientation of the arrow cursor based on the current player orientation. |
||
| − | : [[API ShowWorldMapArrowFrame|ShowWorldMapArrowFrame]](bool) - show or hide the arrow representing the player. |
||
| − | : [[API PositionWorldMapArrowFrame|PositionWorldMapArrowFrame]](x,y) - set the position of the arrow representing the player |
||
| − | : [[API ZoomOut|ZoomOut]]() - "Zooms out" of the current map: going from zone to continent to world view. |
||
| − | |||
| − | === Merchant Functions === |
||
| − | : [[API BuyMerchantItem|BuyMerchantItem]](index[, qty]) - Buys an item from a merchant. |
||
| − | : [[API BuybackItem|BuybackItem]](index) - Buys back a sold item. |
||
| − | : [[API CanMerchantRepair|CanMerchantRepair]]() - Returns true if the merchant can repair items. |
||
| − | : [[API CloseMerchant|CloseMerchant]]() - Closes the merchant window. |
||
| − | : [[API GetBuybackItemInfo|GetBuybackItemInfo]](index) - Returns information about the buyback item. |
||
| − | : [[API GetBuybackItemLink|GetBuybackItemLink]](index) - Returns an [[itemLink]] for the buyback item. |
||
| − | : [[API GetMerchantItemCostInfo|GetMerchantItemCostInfo]] (index) - Returns "alternative currency" information about an item. |
||
| − | : [[API GetMerchantItemCostItem|GetMerchantItemCostItem]] (index, itemIndex) - Returns information about an "alternative currency" component of the price for a purchasable item. |
||
| − | : [[API GetMerchantItemInfo|GetMerchantItemInfo]](index) - Returns information about the given purchasable item |
||
| − | : [[API GetMerchantItemLink|GetMerchantItemLink]](index) - Returns an [[itemLink]] for the given purchasable item |
||
| − | : [[API GetMerchantItemMaxStack|GetMerchantItemMaxStack]](index) - Returns the maximum number of items in a stack. |
||
| − | : [[API GetMerchantNumItems|GetMerchantNumItems]]() - Returns the number of items the merchant sells. |
||
| − | : [[API GetRepairAllCost|GetRepairAllCost]]() |
||
| − | : [[API HideRepairCursor|HideRepairCursor]]() |
||
| − | : [[API InRepairMode|InRepairMode]]() - Returns true if your cursor is in repair mode |
||
| − | : [[API PickupMerchantItem|PickupMerchantItem]](index) - Places the item on the cursor. |
||
| − | : [[API RepairAllItems|RepairAllItems]]([guildBankRepair]) - Repairs all equipped and inventory items. |
||
| − | : [[API ShowMerchantSellCursor|ShowMerchantSellCursor]](index) - Changes the cursor to the merchant sell cursor. |
||
| − | : [[API ShowRepairCursor|ShowRepairCursor]]() |
||
| − | : [[API GetNumBuybackItems|GetNumBuybackItems]]() - Returns number of items available for buyback |
||
| − | |||
| − | === Movement Functions === |
||
| − | Most of these functions may only called on a hardware event from '''secure''' code. |
||
| − | |||
| − | : [[API FollowUnit|FollowUnit]]("[[unitId|unit]]") - Follow an ally with the specified UnitID |
||
| − | : PROTECTED [[API CameraOrSelectOrMoveStart|CameraOrSelectOrMoveStart]]() - Begin "Left click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API CameraOrSelectOrMoveStop|CameraOrSelectOrMoveStop]]([stickyFlag]) - End "Left click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API JumpOrAscendStart|JumpOrAscendStart]]() - Makes the player jump. |
||
| − | : PROTECTED [[API AscendStop|AscendStop]]() - Called when you release the jump key. |
||
| − | : PROTECTED [[API MoveBackwardStart|MoveBackwardStart]] - The player begins moving backward at the specified time. |
||
| − | : PROTECTED [[API MoveBackwardStop|MoveBackwardStop]] - The player stops moving backward at the specified time. |
||
| − | : PROTECTED [[API MoveForwardStart|MoveForwardStart]] - The player begins moving forward at the specified time. |
||
| − | : PROTECTED [[API MoveForwardStop|MoveForwardStop]] - The player stops moving forward at the specified time. |
||
| − | : PROTECTED [[API StrafeLeftStart|StrafeLeftStart]] - The player begins strafing left at the specified time. |
||
| − | : PROTECTED [[API StrafeLeftStop|StrafeLeftStop]] - The player stops strafing left at the specified time. |
||
| − | : PROTECTED [[API StrafeRightStart|StrafeRightStart]] - The player begins strafing right at the specified time. |
||
| − | : PROTECTED [[API StrafeRightStop|StrafeRightStop]] - The player stops strafing right at the specified time. |
||
| − | : PROTECTED [[API ToggleAutoRun|ToggleAutoRun]] - Turns auto-run on or off |
||
| − | : PROTECTED [[API ToggleRun|ToggleRun]] - Toggle between running and walking. |
||
| − | : PROTECTED [[API TurnLeftStart|TurnLeftStart]] - The player starts turning left at the specified time. |
||
| − | : PROTECTED [[API TurnLeftStop|TurnLeftStop]] - The player stops turning left at the specified time. |
||
| − | : PROTECTED [[API TurnOrActionStart|TurnOrActionStart]]() - Begin "Right Click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API TurnOrActionStop|TurnOrActionStop]]() - End "Right Click" in the 3D world. (1.10 - Protected) |
||
| − | : PROTECTED [[API TurnRightStart|TurnRightStart]] - The player starts turning right at the specified time. |
||
| − | : PROTECTED [[API TurnRightStop|TurnRightStop]] - The player stops turning right at the specified time. |
||
| − | |||
| − | === Music Player Functions === |
||
| − | These functions were added exclusively to the Mac client in [[Patch 1.12]]. The functions are protected and are only called through key bindings; thus they only serve to enable you to bind specific keys to control iTunes while using the WoW client. |
||
| − | : PROTECTED [[API MusicPlayer_BackTrack|MusicPlayer_BackTrack]]() - Go back a track. |
||
| − | : PROTECTED [[API MusicPlayer_NextTrack|MusicPlayer_NextTrack]]() - Go forward a track. |
||
| − | : PROTECTED [[API MusicPlayer_PlayPause|MusicPlayer_PlayPause]]() - Toggle play/pause. |
||
| − | : PROTECTED [[API MusicPlayer_VolumeDown|MusicPlayer_VolumeDown]]() - Reduce music volume. |
||
| − | : PROTECTED [[API MusicPlayer_VolumeUp|MusicPlayer_VolumeUp]]() - Increase music volume. |
||
| − | |||
| − | === Pet Functions === |
||
| − | : PROTECTED [[API CastPetAction|CastPetAction]](index) - Cast the corresponding pet skill. |
||
| − | : [[API ClosePetStables|ClosePetStables]]() - Close the pet stables user interface. |
||
| − | : [[API DropItemOnUnit|DropItemOnUnit]]("[[unitId|unit]]") - Drops an item from the cursor onto a unit. |
||
| − | : [[API GetPetActionCooldown|GetPetActionCooldown]](index) - Returns cooldown information for the pet action at the specificed pet action bar slot. |
||
| − | : [[API GetPetActionInfo|GetPetActionInfo]](index) - Returns information on the pet action at the specified pet action bar slot. |
||
| − | : [[API GetPetActionSlotUsable|GetPetActionSlotUsable]](slot) |
||
| − | : [[API GetPetActionsUsable|GetPetActionsUsable]]() - Returns a value indicating if the player's pet's actions can be used at this time. |
||
| − | : [[API GetPetExperience|GetPetExperience]]() - Returns the pet's current xp, and total xp required for next level. |
||
| − | : [[API GetPetFoodTypes|GetPetFoodTypes]]() - Returns a list of the food types the player's pet can eat. |
||
| − | : [[API GetPetHappiness|GetPetHappiness]]() - Returns the pet's happiness, damage percentage, and loyalty gain rate. |
||
| − | : [[API GetPetIcon|GetPetIcon]]() - Returns the path to the texture to use as the icon for the player's pet. |
||
| − | : [[API GetPetTimeRemaining|GetPetTimeRemaining]]() - Returns in milliseconds about some timeout for the player's pet. |
||
| − | : [[API GetStablePetFoodTypes|GetStablePetFoodTypes]](index) - Returns a list of the food types a specific stabled pet can eat. |
||
| − | : [[API GetStablePetInfo|GetStablePetInfo]](index) - Returns information about a specific stabled pet. |
||
| − | : [[API HasPetSpells|HasPetSpells]]() - Returns true if the player has pet spells. |
||
| − | : [[API HasPetUI|HasPetUI]]() - Returns 1 if the player has a pet User Interface. |
||
| − | : [[API PetAbandon|PetAbandon]]() - Permanently abandons your pet. |
||
| − | : PROTECTED [[API PetAggressiveMode|PetAggressiveMode]]() - Set your pet in aggressive mode. Protected function as of patch 2.0. |
||
| − | : PROTECTED [[API PetAttack|PetAttack]]() - Instruct your pet to attack your target. Protected as of patch 2.0. |
||
| − | : [[API IsPetAttackActive|IsPetAttackActive]]() - Returns true if the pet is currently attacking. |
||
| − | : [[API PetStopAttack|PetStopAttack]]() - Stop the attack of the pet. |
||
| − | : [[API PetCanBeAbandoned|PetCanBeAbandoned]]() - Returns true if the pet is abandonable. |
||
| − | : [[API PetCanBeDismissed|PetCanBeDismissed]]() |
||
| − | : [[API PetCanBeRenamed|PetCanBeRenamed]]() - Returns true if the pet can be renamed. |
||
| − | : PROTECTED [[API PetDefensiveMode|PetDefensiveMode]]() - Set your pet in defensive mode. Protected as of patch 2.0. |
||
| − | : [[API PetDismiss|PetDismiss]]() - Dismiss your pet. |
||
| − | : PROTECTED [[API PetFollow|PetFollow]]() - Instruct your pet to follow you. Protected as of patch 2.0. |
||
| − | : [[API PetHasActionBar|PetHasActionBar]]() - Determine if player has a pet with an action bar. |
||
| − | : PROTECTED [[API PetPassiveMode|PetPassiveMode]]() - Set your pet into passive mode. Protected as of patch 2.0. |
||
| − | : [[API PetRename|PetRename]]("name") - Renames the pet. |
||
| − | : PROTECTED [[API PetWait|PetWait]]() - Instruct your pet to remain still. Protected as of patch 2.0. |
||
| − | : [[API PickupPetAction|PickupPetAction]](slot) - Drags an action from the specified pet action bar slot into the cursor. |
||
| − | : [[API PickupStablePet|PickupStablePet]](index) - ?. |
||
| − | : [[API SetPetStablePaperdoll|SetPetStablePaperdoll]](modelObject) - ?. |
||
| − | : PROTECTED [[API TogglePetAutocast|TogglePetAutocast]](index) - Toggles whether the specified pet ability should autocast or not. |
||
| − | : PROTECTED [[API ToggleSpellAutocast|ToggleSpellAutocast]]("spellName" | spellId, bookType) - Toggles whether the specified spell should autocast or not. |
||
| − | : [[API GetSpellAutocast|GetSpellAutocast]]("spellName" | spellId, bookType) - Check whether the specified spell autocasts or not. |
||
| − | |||
| − | === Petition Functions === |
||
| − | Petitions are signup documents for guilds and arena teams. Some functions below only apply to a particular petition type |
||
| − | : [[API CanSignPetition|CanSignPetition]]() - Returns nil if the player cannot sign the current petition. |
||
| − | : [[API ClosePetition|ClosePetition]]() - Closes the current petition. |
||
| − | : [[API GetNumPetitionNames|GetNumPetitionNames]]() - Gets the number of signatures on the current petition. |
||
| − | : [[API GetPetitionInfo|GetPetitionInfo]]() - Retrieves information about the current petition. |
||
| − | : [[API GetPetitionNameInfo|GetPetitionNameInfo]](index) - Retrieves information about a signature on the petition. |
||
| − | : [[API OfferPetition|OfferPetition]]() - Offers a petition to your target, inviting them to join your would-be guild/arena team. |
||
| − | : [[API RenamePetition|RenamePetition]]("name") - Renames the current petition. |
||
| − | : [[API SignPetition|SignPetition]]() - Signs the current petition. |
||
| − | : [[API TurnInGuildCharter|TurnInGuildCharter]]() - Founds a guild. |
||
| − | |||
| − | === Quest Functions === |
||
| − | See also [[#Gossip Functions|Gossip Functions]] |
||
| − | |||
| − | : [[API AbandonQuest|AbandonQuest]] - Abandon the specified quest. |
||
| − | : [[API AcceptQuest|AcceptQuest]] - Accept the specified quest. |
||
| − | : [[API AddQuestWatch|AddQuestWatch]](questIndex[, watchTime]) - Add a quest to the watch list. |
||
| − | : [[API CloseQuest|CloseQuest]] - ?. |
||
| − | : [[API CollapseQuestHeader|CollapseQuestHeader]] - Collapses a quest header. |
||
| − | : [[API CompleteQuest|CompleteQuest]] - Complete the specified quest. |
||
| − | : [[API ConfirmAcceptQuest|ConfirmAcceptQuest]] - Accept the quest. Yes. Really accept it. |
||
| − | : [[API DeclineQuest|DeclineQuest]] - Declines the currently offered quest. |
||
| − | : [[API ExpandQuestHeader|ExpandQuestHeader]] - Expands a quest header. |
||
| − | : [[API GetAbandonQuestName|GetAbandonQuestName]] - Gets the name of a quest while it is being abandoned. |
||
| − | : [[API GetActiveLevel|GetActiveLevel]](index) - Gets the level of an active quest (only available after QUEST_GREETING event). |
||
| − | : [[API GetActiveTitle|GetActiveTitle]](index) - Gets the title of an active quest (only available after QUEST_GREETING event). |
||
| − | : [[API GetAvailableLevel|GetAvailableLevel]](index) - Gets the level of an available quest (only available after QUEST_GREETING event). |
||
| − | : [[API GetAvailableTitle|GetAvailableTitle]](index) - Gets the title of an available quest (only available after QUEST_GREETING event). |
||
| − | : [[API GetAvailableQuestInfo|GetAvailableQuestInfo]](index) - Returns metadata (quest type) about an available quest. (New: 3.3.3) |
||
| − | : [[API GetGreetingText|GetGreetingText]]() |
||
| − | : [[API GetNumActiveQuests|GetNumActiveQuests]] - Gets the number of currently active quests from this NPC (only available after QUEST_GREETING event). |
||
| − | : [[API GetNumAvailableQuests|GetNumAvailableQuests]] - Gets the number of currently available quests from this NPC (only available after QUEST_GREETING event). |
||
| − | : [[API GetNumQuestChoices|GetNumQuestChoices]] - Returns the number of rewards available for choice for quest currently in gossip window. |
||
| − | : [[API GetNumQuestItems|GetNumQuestItems]] - Returns the number of items necessary to complete a particular quest. |
||
| − | : [[API GetNumQuestLeaderBoards|GetNumQuestLeaderBoards]]([questIndex]) - Returns the number of available quest objectives. |
||
| − | : [[API GetNumQuestLogChoices|GetNumQuestLogChoices]] - Returns the number of options someone has when getting a quest item. |
||
| − | : [[API GetNumQuestLogEntries|GetNumQuestLogEntries]] - Returns the number of entries in the quest log. |
||
| − | : [[API GetNumQuestLogRewards|GetNumQuestLogRewards]] - Returns the count of the rewards for a particular quest. |
||
| − | : [[API GetNumQuestRewards|GetNumQuestRewards]] - Returns number of reward items (those that you always get) for quest currently in gossip window. |
||
| − | : [[API GetNumQuestWatches|GetNumQuestWatches]]() - Returns the number of quest watches active. |
||
| − | : [[API GetObjectiveText|GetObjectiveText]]() - Gets the objective of the current quest. |
||
| − | : [[API GetProgressText|GetProgressText]]() - Returns quest progress text, displayed by the NPC before the player pressed "Continue". |
||
| − | : [[API GetQuestBackgroundMaterial|GetQuestBackgroundMaterial]] - Returns the material string associated with the particular quest. |
||
| − | : [[API GetQuestGreenRange|GetQuestGreenRange]]() - Return for how many levels below you quests and mobs remain "green" (i.e. yield xp) |
||
| − | : [[API GetQuestIndexForTimer|GetQuestIndexForTimer]] - ?. |
||
| − | : [[API GetQuestIndexForWatch|GetQuestIndexForWatch]](watchIndx) - Return the quest index for the specified watch |
||
| − | : [[API GetQuestItemInfo|GetQuestItemInfo]] - Returns basic information about the reward/choice/required item for quest currently in gossip window. |
||
| − | : [[API GetQuestItemLink|GetQuestItemLink]] - Returns an [[itemLink]] for a selected quest reward/choice/required item for quest currently in gossip window. |
||
| − | : [[API GetQuestLink|GetQuestLink]](index) - Returns a [[QuestLink]] for a quest |
||
| − | : [[API GetQuestLogChoiceInfo|GetQuestLogChoiceInfo]] - Returns a bunch of data about a quest reward choice from the quest log. |
||
| − | : [[API GetQuestLogGroupNum|GetQuestLogGroupNum]]() - Returns suggested number of players for quest selected currently in log or 0 if there's no suggestion. |
||
| − | : [[API GetQuestLogItemLink|GetQuestLogItemLink]] - Returns item link for selected quest reward/choice/required item from quest log. |
||
| − | : [[API GetQuestLogLeaderBoard|GetQuestLogLeaderBoard]](ldrIndex[, questIndex]) - Gets information about the objectives for a quest. |
||
| − | : [[API GetQuestLogPushable|GetQuestLogPushable]] - Returns true if the currently loaded quest in the quest window can be shared. |
||
| − | : [[API GetQuestLogQuestText|GetQuestLogQuestText]] - Returns the description and objectives required for the specified quest. |
||
| − | : [[API GetQuestLogRequiredMoney|GetQuestLogRequiredMoney]] - Returns amount of money required for quest completion from quest log. |
||
| − | : [[API GetQuestLogRewardInfo|GetQuestLogRewardInfo]] - Returns a pile of reward item info from the quest log. |
||
| − | : [[API GetQuestLogRewardMoney|GetQuestLogRewardMoney]] - Returns a number representing the amount of copper returned by a particular quest. |
||
| − | : [[API GetQuestLogRewardSpell|GetQuestLogRewardSpell]] - Returns name and texture of spell awarded for quest completion from quest log. |
||
| − | : [[API GetQuestLogRewardTalents|GetQuestLogRewardTalents]] - Returns number of talents awarded for quest completion from quest log. |
||
| − | : [[API GetQuestLogSelection|GetQuestLogSelection]] - Returns a number associated with the QuestLogSelection index. |
||
| − | : [[API GetQuestLogTimeLeft|GetQuestLogTimeLeft]] - Returns the seconds remaining on the current quest timer. |
||
| − | : [[API GetQuestLogTitle|GetQuestLogTitle]](index) - Returns verbose data about a particular quest log entry: level requirement, tag, suggested group, completed status, etc. |
||
| − | : [[API GetQuestMoneyToGet|GetQuestMoneyToGet]] - Returns amount of money required for quest currently displayed in gossip. |
||
| − | : [[API GetQuestReward|GetQuestReward]](rewardIndex) - Completes the quest with the specified quest reward. |
||
| − | : [[API GetQuestText|GetQuestText]] - Gets the description of the current quest. |
||
| − | : [[API GetQuestTimers|GetQuestTimers]] - Returns all of the quest timers currently in progress. |
||
| − | : [[API GetRewardArenaPoints|GetRewardArenaPoints]]() - Returns the amount of arena points awarded by the currently displayed quest. |
||
| − | : [[API GetRewardHonor|GetRewardHonor]]() - Returns the amount of honor points awarded by the currently displayed quest. |
||
| − | : [[API GetRewardMoney|GetRewardMoney]]() - Returns a amount of copper rewarded for completion of quest displayed in gossip. |
||
| − | : [[API GetRewardSpell|GetRewardSpell]]() - Returns name and texture of spell awarded for quest completion for quest currently in gossip window. |
||
| − | : [[API GetRewardTalents|GetRewardTalents]]() - Returns number of talents awarded for quest completion for quest currently in gossip window. |
||
| − | : [[API GetRewardText|GetRewardText]]() - Returns quest reward text, displayed by the NPC before the player hits "Complete Quest". |
||
| − | : [[API GetRewardTitle|GetRewardTitle]]() - Returns the title awarded by the currently displayed quest. |
||
| − | : [[API GetRewardXP|GetRewardXP]]() - Returns the amount of experience awarded by the currently displayed text. |
||
| − | : [[API GetTitleText|GetTitleText]] - Retrieves the title of the quest while talking to the NPC about it. |
||
| − | : [[API IsCurrentQuestFailed|IsCurrentQuestFailed]] - ?. |
||
| − | : [[API IsQuestCompletable|IsQuestCompletable]] - Returns true if a quest is possible to complete. |
||
| − | : [[API IsQuestWatched|IsQuestWatched]](questIndex) - Determine if the specified quest is watched. |
||
| − | : [[API IsUnitOnQuest|IsUnitOnQuest]](questIndex, "[[unitId|unit]]") - Determine if the specified unit is on the given quest. |
||
| − | : [[API QuestChooseRewardError|QuestChooseRewardError]] - Throws an error when the quest choose reward method doesn't work. |
||
| − | : [[API QuestFlagsPVP|QuestFlagsPVP]]() - Determine if the quest will flag you you for PvP when accepted. |
||
| − | : [[API QuestGetAutoAccept|QuestGetAutoAccept]]() - Returns whether the last-offered quest was automatically accepted. (3.3.0) |
||
| − | : [[API QuestLogPushQuest|QuestLogPushQuest]] - Initiates the sharing of the currently viewed quest in the quest log. |
||
| − | : [[API RemoveQuestWatch|RemoveQuestWatch]](questIndex) - Removes a quest watch by questIndex. |
||
| − | : [[API SelectActiveQuest|SelectActiveQuest]] - Selects an active quest from the NPC (only available after QUEST_GREETING event). |
||
| − | : [[API SelectAvailableQuest|SelectAvailableQuest]] - Selects an available quest from the NPC (only available after QUEST_GREETING event). |
||
| − | : [[API SelectQuestLogEntry|SelectQuestLogEntry]] - Sets the selected quest, required for most GetQuest functions. |
||
| − | : [[API SetAbandonQuest|SetAbandonQuest]] - Called before [[API AbandonQuest|AbandonQuest]]. |
||
| − | : [[API ShiftQuestWatches|ShiftQuestWatches]](id1, id2) - Exchanges the order of two watched quests. (3.3.3) |
||
| − | : [[API SortQuestWatches|SortQuestWatches]]() - Sorts the watched quests according to proximity and returns whether the order changed since last sorting. (3.3.3) |
||
| − | : [[API GetDailyQuestsCompleted|GetDailyQuestsCompleted]] - Return the current number of daily quests completed today. |
||
| − | : [[API GetMaxDailyQuests|GetMaxDailyQuests]] - Returns the maximum number of daily quests completable in one day. |
||
| − | : [[API GetQuestResetTime|GetQuestResetTime]] - Returns number of seconds until quest reset. |
||
| − | : [[API WatchFrame_Update|WatchFrame_Update]] - Updates the watch frame display. |
||
| − | : [[API QueryQuestsCompleted|QueryQuestsCompleted]]() - Query list of completed quests. (3.3.0) |
||
| − | : [[API GetQuestsCompleted|GetQuestsCompleted]]([table]) - Returns list of completed quests (only available after QUEST_QUERY_COMPLETE event). (3.3.0) |
||
| − | : [[API QuestIsDaily|QuestIsDaily]]() - Returns whether the offered quest is a daily quest. (3.3.3) |
||
| − | : [[API QuestIsWeekly|QuestIsWeekly]]() - Returns whether the offered quest is a weekly quest. (3.3.3) |
||
| − | : [[API AddAutoQuestPopUp|AddAutoQuestPopUp]]() - Adds quest to an internal list of quests for offer/completion popup notification. (4.0.1) |
||
| − | : [[API GetAutoQuestPopUp|GetAutoQuestPopUp]]() - Retrieves quest info by index that added using [[API AddAutoQuestPopUp|AddAutoQuestPopUp]]. (4.0.1) |
||
| − | : [[API GetNumAutoQuestPopUps|GetNumAutoQuestPopUps]]() - Retrieves number of quests added via [[API AddAutoQuestPopUp|AddAutoQuestPopUp]]. (4.0.1) |
||
| − | |||
| − | === Raid Functions === |
||
| − | See also: [[#Group Functions|Group Functions]] |
||
| − | |||
| − | : [[API ClearRaidMarker|ClearRaidMarker]](index) - Removes a raid marker from the world. (4.0.1) |
||
| − | : [[API ConvertToParty|ConvertToParty]]() - Converts a raid group with 5 or less members to a party. (4.0.1) |
||
| − | : [[API ConvertToRaid|ConvertToRaid]]() - Converts a party to a raid. |
||
| − | : [[API DemoteAssistant|DemoteAssistant]]("[[unitId|unit]]") - Demotes player from assistant status. Requires raid leadership. |
||
| − | : [[API GetAllowLowLevelRaid|GetAllowLowLevelRaid]]() - Returns whether joining low-level raids is enabled for the current character. |
||
| − | : [[API GetNumRaidMembers|GetNumRaidMembers]]() - Returns the number of players in your raid group. |
||
| − | : [[API GetRealNumRaidMembers|GetRealNumRaidMembers]]() - Returns the number of players in your non-battleground raid group. |
||
| − | : [[API GetPartyAssignment|GetPartyAssignment]]("assignment") - Returns unitID of unit assigned to given role. |
||
| − | : [[API GetPartyAssignment|GetPartyAssignment]]("assignment", "[[unitId|unit]]") - Returns a value based on whether the unit is assigned to given role. |
||
| − | : [[API GetRaidRosterInfo|GetRaidRosterInfo]](index) - Returns information about the members of your raid . |
||
| − | : [[API GetRaidRosterSelection|GetRaidRosterSelection]] - ?. |
||
| − | : [[API GetRaidTargetIndex|GetRaidTargetIndex]]("[[unitId|unit]]") - Get the raid target index assigned to a unit. |
||
| − | : [[API GetReadyCheckStatus|GetReadyCheckStatus]]("unit") - Returns a raid member's response to the current LFG check. |
||
| − | : [[API IsRaidLeader|IsRaidLeader]]() - Returns a value based on whether the player is a raid leader. |
||
| − | : [[API IsRaidOfficer|IsRaidOfficer]]() - Returns a value based on whether the player is a raid officer (assistant). |
||
| − | : PROTECTED [[API PlaceRaidMarker|PlaceRaidMarker]](index) - Brings up a targeting circle to place a raid marker in the world.(4.0.1) |
||
| − | : [[API PromoteToAssistant|PromoteToAssistant]]("[[unitId|unit]]") - Promotes player to assistant status. Requires raid leadership. |
||
| − | : [[API RequestRaidInfo|RequestRaidInfo]]() - Returns information about which instances you are saved to. |
||
| − | : PROTECTED [[API SetPartyAssignment|SetPartyAssignment]]("assignment", player) (2.3.3) |
||
| − | : [[API SetAllowLowLevelRaid|SetAllowLowLevelRaid]](allowed) - Controls whether the current character can join low-level raids. |
||
| − | : [[API SetRaidRosterSelection|SetRaidRosterSelection]](index) - ?. |
||
| − | : [[API SetRaidSubgroup|SetRaidSubgroup]](index, subgroup) - Move a raid member from his current subgroup into a different (non-full) subgroup. |
||
| − | : PROTECTED [[API SwapRaidSubgroup|SwapRaidSubgroup]](index1, index2) - Swaps raid members into different groups. |
||
| − | : [[API SetRaidTarget|SetRaidTarget]]("[[unitId|unit]]", index) - Sets a raid icon on a unit. |
||
| − | : [[API SetRaidTargetIcon|SetRaidTargetIcon]]("[[unitId|unit]]", index) - Sets or resets a raid icon a unit. |
||
| − | : [[API UnitInRaid|UnitInRaid]]("[[unitId|unit]]") - Returns 1 if unit is in your raid, nil if not. |
||
| − | |||
| − | === Raid Browser Functions === |
||
| − | Functions hidden behind and supporting the Raid Browser UI introduced in 3.3 See also: [[#Dungeon Finder Functions|Dungeon Finder Functions]] and [[#Looking For Group Functions|Looking For Group Functions]] |
||
| − | |||
| − | '''This is a very preliminary list of functions by perusing [[FrameXML]]\LFRFrame.lua|xml. Please edit and contribute if you know more about these =)''' |
||
| − | |||
| − | : UI [[API LFGGetDungeonInfoByID|LFGGetDungeonInfoByID]](id) - returns data for the specified dungeon/raid/category ID, from the table returned by [[API GetLFDChoiceInfo|GetLFDChoiceInfo]](). Raid category IDs and raid IDs may be obtained from the UI function LFR_FULL_RAID_LIST_HEADER_ORDER, LFR_FULL_RAID_LIST = [[API GetFullRaidList|GetFullRaidList]](). |
||
| − | : [[API GetInstanceLockTimeRemainingEncounter|GetInstanceLockTimeRemainingEncounter]](index) - returns bossName, texture, isKilled |
||
| − | : [[API RefreshLFGList|RefreshLFGList]]() |
||
| − | : [[API SearchLFGGetEncounterResults|SearchLFGGetEncounterResults]](index, bossIndex) - returns bossName, texture, isKilled |
||
| − | : [[API SearchLFGGetJoinedID|SearchLFGGetJoinedID]]() - returns the currently selected raid ID or nil |
||
| − | : [[API SearchLFGGetNumResults|SearchLFGGetNumResults]]() - returns numResults, totalResults |
||
| − | : [[API SearchLFGGetPartyResults|SearchLFGGetPartyResults]](index, partyMemberIndex) - returns name, level, relationship, className, areaName, comment |
||
| − | : [[API SearchLFGGetResults|SearchLFGGetResults]](index) - returns name, level, areaName, className, comment, partyMembers, status, class, encountersTotal, encountersComplete, isLeader, isTank, isHealer, isDamage |
||
| − | : HW [[API SearchLFGJoin|SearchLFGJoin]](typeID, raidID) - enters a search into the Raid Browser |
||
| − | : [[API SearchLFGLeave|SearchLFGLeave]]() - removes yourself from looking through the Raid Browser. Equivalent to selecting "none" in the Raid Browser |
||
| − | : [[API SearchLFGSort|SearchLFGSort]](sortType) |
||
| − | : [[API SetLFGComment|SetLFGComment]](comment) - sets the comment in the raid browser |
||
| − | |||
| − | |||
| − | These also ''appear'' to be used by the Raid Browser, as well as the Dungeon Finder: |
||
| − | : [[API ClearAllLFGDungeons|ClearAllLFGDungeons]]() |
||
| − | : [[API JoinLFG|JoinLFG]]() |
||
| − | : [[API LeaveLFG|LeaveLFG]]() |
||
| − | : [[API RequestLFDPartyLockInfo|RequestLFDPartyLockInfo]]() |
||
| − | : [[API RequestLFDPlayerLockInfo|RequestLFDPlayerLockInfo]]() |
||
| − | : [[API SetLFGDungeon|SetLFGDungeon]](id) |
||
| − | : [[API SetLFGDungeonEnabled|SetLFGDungeonEnabled]](dungeonID, isEnabled) |
||
| − | : [[API SetLFGHeaderCollapsed|SetLFGHeaderCollapsed]](headerID, isCollapsed) |
||
| − | |||
| − | === RealID (BNet) Functions === |
||
| − | These functions are only available in [[Patch 3.3.5]]. |
||
| − | : [[API BNAcceptFriendInvite|BNAcceptFriendInvite]](ID) |
||
| − | : [[API BNConnected|BNConnected]]() - Returns your battle.net connected state (True|False) |
||
| − | : [[API BNCreateConversation|BNCreateConversation]](id,id) |
||
| − | : [[API BNDeclineFriendInvite|BNDeclineFriendInvite]](ID) |
||
| − | : [[API BNFeaturesEnabled|BNFeaturesEnabled]]() |
||
| − | : [[API BNFeaturesEnabledAndConnected|BNFeaturesEnabledAndConnected]]() |
||
| − | : [[API BNGetBlockedInfo|BNGetBlockedInfo]](index) |
||
| − | : [[API BNGetBlockedToonInfo|BNGetBlockedToonInfo]](index) |
||
| − | : [[API BNGetConversationInfo|BNGetConversationInfo]](chatTarget) - returns unknown |
||
| − | : [[API BNGetConversationMemberInfo|BNGetConversationMemberInfo]](conversationID, memberID) - returns accountID, toonID, name |
||
| − | : [[API BNGetCustomMessageTable|BNGetCustomMessageTable]](table) |
||
| − | : [[API BNGetFOFInfo|BNGetFOFInfo]](presenceID, mutual, non-mutual, index) - returns presenceID, givenName, surname, isFriend |
||
| − | : [[API BNGetFriendInfo|BNGetFriendInfo]](friendIndex) - Returns BNet ID, real name, character name, character ID, game client, connected, status, broadcast and note of the friend |
||
| − | : [[API BNGetFriendInfoByID|BNGetFriendInfoByID]](presenceID) - returns presenceID, givenName, surname, toonName |
||
| − | : [[API BNGetFriendInviteInfo|BNGetFriendInviteInfo]](menuValue) - returns presenceID, givenName, surname |
||
| − | : [[API BNGetFriendToonInfo|BNGetFriendToonInfo]](friendIndex, toonIndex) |
||
| − | : [[API BNGetInfo|BNGetInfo]]() - returns presenceID, toonID, currentBroadcast, bnetAFK, bnetDND |
||
| − | : [[API BNGetMatureLanguageFilter|BNGetMatureLanguageFilter]]() |
||
| − | : [[API BNGetMaxPlayersInConversation|BNGetMaxPlayersInConversation]]() |
||
| − | : [[API BNGetNumBlocked|BNGetNumBlocked]]() |
||
| − | : [[API BNGetNumBlockedToons|BNGetNumBlockedToons]]() |
||
| − | : [[API BNGetNumConversationMembers|BNGetNumConversationMembers]](conversationID) |
||
| − | : [[API BNGetNumFOF|BNGetNumFOF]](ID,mutual,non) |
||
| − | : [[API BNGetFOFInfo|BNGetFOFInfo]](ID, mutual, non, index) |
||
| − | : [[API BNGetNumFriendInvites|BNGetNumFriendInvites]]() |
||
| − | : [[API BNGetNumFriends|BNGetNumFriends]]() - returns numBNetTotal, numBNetOnline |
||
| − | : [[API BNGetNumFriendToons|BNGetNumFriendToons]](index) |
||
| − | : [[API BNGetSelectedBlock|BNGetSelectedBlock]]() |
||
| − | : [[API BNGetSelectedFriend|BNGetSelectedFriend]]() |
||
| − | : [[API BNGetSelectedToonBlock|BNGetSelectedToonBlock]]() |
||
| − | : [[API BNGetToonInfo|BNGetToonInfo]](toonID) - returns hasFocus, toonName, client, realmName, faction, race, class, guild, zoneName, level, gameText |
||
| − | : [[API BNInviteToConversation|BNInviteToConversation]](target, player) |
||
| − | : [[API BNIsBlocked|BNIsBlocked]](ID) |
||
| − | : [[API BNIsFriend|BNIsFriend]](presenceID) |
||
| − | : [[API BNIsSelf|BNIsSelf]](presenceID) - Returns true if the specified presenceID is your own, false otherwise. |
||
| − | : [[API BNIsToonBlocked|BNIsToonBlocked]](ID) |
||
| − | : [[API BNLeaveConversation|BNLeaveConversation]](channel) |
||
| − | : [[API BNListConversation|BNListConversation]](channel) |
||
| − | : [[API BNRemoveFriend|BNRemoveFriend]](ID) |
||
| − | : [[API BNReportFriendInvite|BNReportFriendInvite]](ID) |
||
| − | : [[API BNReportPlayer|BNReportPlayer]](presenceID, type, comments) |
||
| − | : [[API BNSendConversationMessage|BNSendConversationMessage]](channel,text) |
||
| − | : [[API BNSendFriendInvite|BNSendFriendInvite]](text, noteText) |
||
| − | : [[API BNSendFriendInviteByID|BNSendFriendInviteByID]](ID, noteText) |
||
| − | : [[API BNSendWhisper|BNSendWhisper]](id,text) |
||
| − | : [[API BNSetAFK|BNSetAFK]]() |
||
| − | : [[API BNSetBlocked|BNSetBlocked]](ID, bool) |
||
| − | : [[API BNSetCustomMessage|BNSetCustomMessage]](text) |
||
| − | : [[API BNSetDND|BNSetDND]]() |
||
| − | : [[API BNSetFocus|BNSetFocus]]() |
||
| − | : [[API BNSetFriendNote|BNSetFriendNote]](ID, noteText) |
||
| − | : [[API BNSetMatureLanguageFilter|BNSetMatureLanguageFilter]](bool) |
||
| − | : [[API BNSetSelectedBlock|BNSetSelectedBlock]](index) |
||
| − | : [[API BNSetSelectedFriend|BNSetSelectedFriend]](index) |
||
| − | : [[API BNSetSelectedToonBlock|BNSetSelectedToonBlock]](index) |
||
| − | : [[API BNSetToonBlocked|BNSetToonBlocked]](ID, bool) |
||
| − | : [[API IsBNLogin|IsBNLogin]]() |
||
| − | : [[API CanCooperateWithToon|CanCooperateWithToon]](toonID) |
||
| − | |||
| − | === Recruit-a-Friend Functions === |
||
| − | Note: Only usable by people that have been referred or have referred someone. |
||
| − | |||
| − | : [[API AcceptLevelGrant|AcceptLevelGrant]]() - Accepts a level grant proposal. |
||
| − | : [[API DeclineLevelGrant|DeclineLevelGrant]]() - Declines a level grant proposal. |
||
| − | : [[API IsReferAFriendLinked|IsReferAFriendLinked]]("unit") - Returns whether the unit is linked to the player via RaF. |
||
| − | : [[API CanGrantLevel|CanGrantLevel]]("unit") - Returns whether you can grant levels to a particular player. |
||
| − | : [[API GrantLevel|GrantLevel]]("unit", level) - Grant a custom amount of levels to a RaF-linked player. |
||
| − | : [[API CanSummonFriend|CanSummonFriend]]("unit") - Returns whether you can RaF summon a particular unit. |
||
| − | : [[API SummonFriend|SummonFriend]]("unit") - Summons a player using the RaF system. |
||
| − | : [[API GetSummonFriendCooldown|GetSummonFriendCooldown]]() - Returns the cooldown (start, duration) of the RaF Summon Friend ability. |
||
| − | |||
| − | === Script Profiling Functions === |
||
| − | Note: CPU profiling is disabled by default since it has some overhead. CPU profiling is controlled by the scriptProfile cvar, which persists across sessions, and takes effect after a UI reload. Memory profiling is always available. These functions have been added in Patch 2.1. |
||
| − | |||
| − | : [[API GetAddOnCPUUsage|GetAddOnCPUUsage]](index or "name") - Returns the total time used by the specified AddOn. This returns a cached value calculated by UpdateAddOnCPUUsage(). |
||
| − | : [[API GetAddOnMemoryUsage|GetAddOnMemoryUsage]](index or "name") - query an addon's memory use (in K, precision to 1 byte) - This returns a cached value calculated by UpdateAddOnMemoryUsage(). |
||
| − | : [[API GetEventCPUUsage|GetEventCPUUsage]](["event"]) - Returns the time used and number of times the specified event has been triggered. If 'event' is omitted, the time and count will be totals across all events. |
||
| − | : [[API GetFrameCPUUsage|GetFrameCPUUsage]](frame[, includeChildren]) - Returns the time used and number of function calls of any of the frame's script handlers. If 'includeChildren' is true or omitted, the time and call count will include the handlers for all of the frame's children as well. |
||
| − | : [[API GetFunctionCPUUsage|GetFunctionCPUUsage]](function[, includeSubroutines]) - Returns the time used and number of times the specified function was called. If 'includeSubroutines' is true or omitted, the time includes both the time spent in the function and subroutines called by the function. If it is false, then time is only the time actually spent by the code in the function itself. |
||
| − | : [[API GetScriptCPUUsage|GetScriptCPUUsage]]() - Returns the total time used by the scripting system |
||
| − | : [[API ResetCPUUsage|ResetCPUUsage]]() - Reset all CPU profiling statistics to zero. |
||
| − | : [[API UpdateAddOnCPUUsage|UpdateAddOnCPUUsage]]() - Scan through the profiling data and update the per-addon statistics |
||
| − | : [[API UpdateAddOnMemoryUsage|UpdateAddOnMemoryUsage]]() - Scan through memory profiling data and update the per-addon statistics |
||
| − | |||
| − | === Security and Protection Functions === |
||
| − | : [[API issecure|issecure]]() - Determine if the current environment is secure. |
||
| − | : [[API forceinsecure|forceinsecure]]() - Taint the current execution path. |
||
| − | : [[API issecurevariable|issecurevariable]]([table,] "name") - Determine if the specified variable is secure. |
||
| − | : [[API securecall|securecall]](function or "functionName", ...) - Call a function from a secure environment without risking secure status. |
||
| − | : [[API hooksecurefunc|hooksecurefunc]]([table,] "functionName", hookfunc) - Creates a secure 'post hook' for the named function. The hookfunc is invoked after the original function, and receives the same parameters. Return values from hookfunc are discarded. This is the only safe way to hook functions that execute protected functionality. |
||
| − | : [[API InCombatLockdown|InCombatLockdown]]() - Returns true if the in-combat AddOn restrictions are active. |
||
| − | : [[API scrub|scrub]](...) - returns the argument list with non-number/boolean/string values changed to nil. |
||
| − | |||
| − | === Settings Functions === |
||
| − | : [[API CombatTextSetActiveUnit|CombatTextSetActiveUnit]](unit) - changes the entity for which COMBAT_TEXT_UPDATE events fire. |
||
| − | : [[API DownloadSettings|DownloadSettings]]() - Download a backup of your settings from the server. |
||
| − | : [[API GetCVar|GetCVar]]("cVar") - Returns the current value of a console variable. |
||
| − | : [[API GetCVarDefault|GetCVarDefault]]("cVar") - Returns the default value of a console variable. |
||
| − | : [[API GetCVarBool|GetCVarBool]]("cVar") - Returns the value of the cvar as 1 or nil instead of requiring you to compare the cvar value with "0" or "1" |
||
| − | : [[API GetCVarInfo|GetCVarInfo]]("cVar") - returns name, defaultValue, serverStoredAccountWide, serverStoredPerCharacter |
||
| − | : [[API GetCurrentMultisampleFormat|GetCurrentMultisampleFormat]]() - Get the current in-use multi-sample (antialias) format. |
||
| − | : [[API GetCurrentResolution|GetCurrentResolution]]() - Get the index of the current screen resolution. |
||
| − | : [[API GetGamma|GetGamma]]() |
||
| − | : [[API GetMultisampleFormats|GetMultisampleFormats]]() - Get the available multi-sample (antialias) formats.. |
||
| − | : [[API GetRefreshRates|GetRefreshRates]](x) |
||
| − | : [[API GetScreenResolutions|GetScreenResolutions]]() |
||
| − | : [[API GetVideoCaps|GetVideoCaps]]() |
||
| − | : [[API IsThreatWarningEnabled|IsThreatWarningEnabled]]() - returns whether threat warnings should currently be displayed. |
||
| − | : [[API RegisterCVar|RegisterCVar]]("cVar"[, value]) - Registers a variable for use with the [[API GetCVar|GetCVar]] and [[API SetCVar|SetCVar]] functions. |
||
| − | : [[API ResetPerformanceValues|ResetPerformanceValues]]() |
||
| − | : [[API ResetTutorials|ResetTutorials]]() |
||
| − | : [[API SetCVar|SetCVar]]("cVar", value[, "scriptCVar"]) - Set the value of a variable in config.wtf |
||
| − | : [[API SetEuropeanNumbers|SetEuropeanNumbers]](flag) - Sets the decimal separator to a comma instead of a dot |
||
| − | : [[API SetGamma|SetGamma]](value) |
||
| − | : [[API SetLayoutMode|SetLayoutMode]]() |
||
| − | : [[API SetMultisampleFormat|SetMultisampleFormat]](index) - Set the multi-sample (antialias) format to use. |
||
| − | : [[API SetScreenResolution|SetScreenResolution]](x) |
||
| − | : [[API ShowCloak|ShowCloak]](flag) - Set whether player's cloak is displayed. |
||
| − | : [[API ShowHelm|ShowHelm]](flag) - Set whether player's helm is displayed. |
||
| − | : [[API ShowNumericThreat|ShowNumericThreat]]() - Returns 1 if detailed threat information should be shown on unit frames. |
||
| − | : [[API ShowingCloak|ShowingCloak]]() - Return 1 if player's cloak is displayed, nil otherwise. |
||
| − | : [[API ShowingHelm|ShowingHelm]]() - Return 1 if player's helm is displayed, nil otherwise. |
||
| − | : [[API UploadSettings|UploadSettings]]() - Uploads a backup of your settings to the server. |
||
| − | |||
| − | === Skill Functions === |
||
| − | : [[API AbandonSkill|AbandonSkill]](index) - The player abandons a skill. |
||
| − | |||
| − | === Spell Functions === |
||
| − | spellID is the index of a spell in a spellbook. The indices increase from top to bottom, then left to right, then between categories (e.g.: General -> Discipline). spellIDs will change as players learn new spells and ''professions''. |
||
| − | |||
| − | : PROTECTED [[API CastShapeshiftForm|CastShapeshiftForm]](index) |
||
| − | : PROTECTED [[API CastSpell|CastSpell]](spellID, "bookType") - Cast the specified spell by ID. spellbookTab is "spell" or "pet". As of patch 2.0, this function has been restricted to Blizzard signed UI mods. Note: You can still use this function to open Craft windows and activate Lock Picking. |
||
| − | : PROTECTED [[API CastSpellByName|CastSpellByName]]("name"[, onSelf]) - Cast the specified spell by display name. As of patch 2.0, this function has been restricted to Blizzard signed UI mods. Note: You can still use this function to open Craft windows and activate Lock Picking. |
||
| − | : [[API GetMultiCastTotemSpells|GetMultiCastTotemSpells]](totemslot) - Returns a list of spellIDs that are applicable for the specified totem slot (1-4) (NEW in 3.2) |
||
| − | : [[API GetNumShapeshiftForms|GetNumShapeshiftForms]]() |
||
| − | : [[API GetNumSpellTabs|GetNumSpellTabs]]() - Returns the total number of tabs in the user's spellbook. |
||
| − | : [[API GetQuestLogRewardSpell|GetQuestLogRewardSpell]] - ?. |
||
| − | : [[API GetRewardSpell|GetRewardSpell]] - ?. |
||
| − | : [[API GetShapeshiftForm|GetShapeshiftForm]](unknown) - returns zero-based index of current form/stance |
||
| − | : [[API GetShapeshiftFormCooldown|GetShapeshiftFormCooldown]](index) |
||
| − | : [[API GetShapeshiftFormInfo|GetShapeshiftFormInfo]](index) - Retrieves information about an available ShapeshiftForm or Stance. |
||
| − | : [[API GetSpellAutocast|GetSpellAutocast]]("spellName" | spellId, bookType) - Check whether the specified spell autocasts or not. |
||
| − | : [[API GetSpellBookItemInfo|GetSpellBookItemInfo]](spellID, "bookType") - Returns the spell's type and spellID for a spell in the player's spellbook. |
||
| − | : [[API GetSpellBookItemName|GetSpellBookItemName]](spellID, "bookType") - Returns the spell name and spell rank for a spell in the player's spellbook. |
||
| − | : [[API GetSpellCooldown|GetSpellCooldown]](spellName | spellID, "bookType") - Retrieves data on the cooldown of a specific spell. |
||
| − | : [[API GetSpellInfo|GetSpellInfo]] (spellId | spellName | spellLink) - Returns the spell's info, including name, cost, icon, cast time, and range. |
||
| − | : [[API GetSpellLink|GetSpellLink]] (spellName, spellRank) - Returns the spell's link. (2.4) |
||
| − | : [[API GetSpellTabInfo|GetSpellTabInfo]](spellbookTabNum) - Returns information about the specified spellbook tab. |
||
| − | : [[API GetSpellTexture|GetSpellTexture]](spellName | spellID, "bookType") - Returns the texture used for the spell's icon. |
||
| − | : [[API GetTotemInfo|GetTotemInfo]](slot) - Returns information about a totem. |
||
| − | : [[API IsAttackSpell|IsAttackSpell]](spell) - Returns 1 if the spell is the "Attack" spell. |
||
| − | : [[API IsAutoRepeatSpell|IsAutoRepeatSpell]](spell) - |
||
| − | : [[API IsPassiveSpell|IsPassiveSpell]](spellID, "bookType") - Returns whether the icon in your spellbook is a Passive ability. Formerly IsSpellPassive(spell). |
||
| − | : [[API IsSpellInRange|IsSpellInRange]]("spellName", [unit]) - Is nil for no valid target, 0 for out of range, 1 for in range. |
||
| − | : [[API IsUsableSpell|IsUsableSpell]](spell) - |
||
| − | : [[API PickupSpell|PickupSpell]]("spellName" | spellID, "bookType") - Loads an action button onto the cursor to be dropped into a quickbar slot. |
||
| − | : UI [[API QueryCastSequence|QueryCastSequence]]("sequence") - Returns index, item, spell for the spell/item that will be used next if the cast sequence is executed. |
||
| − | : PROTECTED [[API SetMultiCastSpell|SetMultiCastSpell]](actionID,spellID) - Assigns a spellID to a multicast (totem bar) actionID (NEW in 3.2) |
||
| − | : [[API SpellCanTargetUnit|SpellCanTargetUnit]]("[[unitId|unit]]") - Returns true if the spell awaiting target selection can be cast on the specified unit. |
||
| − | : [[API SpellHasRange|SpellHasRange]](spell) - Returns true if the specified spell has a ranged effect (i.e. requires a target). |
||
| − | : [[API SpellIsTargeting|SpellIsTargeting]]() - Returns true if a spell has been cast and is awaiting target selection. |
||
| − | : PROTECTED [[API SpellStopCasting|SpellStopCasting]]() - Stops the current spellcast. |
||
| − | : PROTECTED [[API SpellStopTargeting|SpellStopTargeting]]() - Cancels the spell awaiting target selection. |
||
| − | : PROTECTED [[API SpellTargetUnit|SpellTargetUnit]]("[[unitId|unit]]") - Casts the spell awaiting target selection on the specified unit. |
||
| − | : PROTECTED [[API ToggleSpellAutocast|ToggleSpellAutocast]]("spellName" | spellId, bookType) - Toggles whether the specified spell should autocast or not. |
||
| − | : [[API UnitCastingInfo|UnitCastingInfo]]("unit") - Returns spellName, nameSubtext, text, texture, startTime, endTime, isTradeSkill, castID, interrupt . |
||
| − | : [[API UnitChannelInfo|UnitChannelInfo]]("unit") - Returns spellName, nameSubtext, text, texture, startTime, endTime, isTradeSkill, interrupt . |
||
| − | |||
| − | === System Functions === |
||
| − | : [[API ConsoleExec|ConsoleExec]]("command") - Execute a console command. |
||
| − | : [[API DetectWowMouse|DetectWowMouse]]() - Attempts to detect the world of warcraft MMO mouse. |
||
| − | : [[API GetBuildInfo|GetBuildInfo]]() - Returns information about current client build. |
||
| − | : [[API geterrorhandler|geterrorhandler]]() - Returns the currently set error handler. |
||
| − | : [[API GetCurrentKeyBoardFocus|GetCurrentKeyBoardFocus]]() - Returns the [editbox] widget currently handling keyboard events. |
||
| − | : [[API GetExistingLocales|GetExistingLocales]]() - Returns a list of installed language packs. |
||
| − | : [[API GetFramerate|GetFramerate]]() - Returns the current framerate (full precision) |
||
| − | : [[API GetGameTime|GetGameTime]]() - Returns the time in-game. |
||
| − | : [[API GetLocale|GetLocale]]() - Returns client locale, example 'enUS'. |
||
| − | : [[API GetCursorPosition|GetCursorPosition]]() - Returns the cursor's position on the screen. |
||
| − | : [[API GetNetStats|GetNetStats]]() - Get bandwidth and latency network information. |
||
| − | : [[API GetRealmName|GetRealmName]]() - returns the name of the server a user is logged in to |
||
| − | : [[API GetScreenHeight|GetScreenHeight]]() - Returns the height of the window in pixels. |
||
| − | : [[API GetScreenWidth|GetScreenWidth]]() - Returns the width of the window in pixels. |
||
| − | : UI [[API GetText|GetText]]() - Used to localize some client text. |
||
| − | : [[API GetTime|GetTime]]() - Returns the system uptime in seconds (millisecond precision). |
||
| − | : [[API IsAltKeyDown|IsAltKeyDown]]() - Returns true if the alt key is currently depressed. |
||
| − | : [[API InCinematic|InCinematic]]() |
||
| − | : [[API IsControlKeyDown|IsControlKeyDown]]() - Returns true if the control key is currently depressed. |
||
| − | : [[API IsDebugBuild|IsDebugBuild]]() - ? |
||
| − | : [[API IsDesaturateSupported|IsDesaturateSupported]]() - ? |
||
| − | : [[API IsLeftAltKeyDown|IsLeftAltKeyDown]]() - Returns true if the left alt key is currently depressed. |
||
| − | : [[API IsLeftControlKeyDown|IsLeftControlKeyDown]]() - Returns true if the left control key is currently depressed. |
||
| − | : [[API IsLeftShiftKeyDown|IsLeftShiftKeyDown]]() - Returns true if the left shift key is currently depressed. |
||
| − | : [[API IsLinuxClient|IsLinuxClient]]() - Boolean - Returns true if WoW is being run on Linux. |
||
| − | : [[API IsLoggedIn|IsLoggedIn]]() - Returns nil before the PLAYER_LOGIN event has fired, 1 afterwards. |
||
| − | : [[API IsMacClient|IsMacClient]]() - Returns true if WoW is being run on Mac. |
||
| − | : [[API IsRightAltKeyDown|IsRightAltKeyDown]]() - Returns true if the right alt key is currently depressed. |
||
| − | : [[API IsRightControlKeyDown|IsRightControlKeyDown]]() - Returns true if the right control key is currently depressed. |
||
| − | : [[API IsRightShiftKeyDown|IsRightShiftKeyDown]]() - Returns true if the right shift key is currently depressed. |
||
| − | : [[API IsShiftKeyDown|IsShiftKeyDown]]() - Returns true if the shift key is currently depressed. |
||
| − | : [[API IsStereoVideoAvailable|IsStereoVideoAvailable]]() - New in 3.0.8 |
||
| − | : [[API IsWindowsClient|IsWindowsClient]]() - Returns true if WoW is being run on Windows. |
||
| − | : [[API OpeningCinematic|OpeningCinematic]]() - Shows the opening movie for a player's race |
||
| − | : [[API PlayMusic|PlayMusic]]() - Plays the specified mp3. |
||
| − | : [[API PlaySound|PlaySound]]() - Plays the specified built-in sound effect. |
||
| − | : [[API PlaySoundFile|PlaySoundFile]]() - Plays the specified sound file. |
||
| − | : HW [[API ReloadUI|ReloadUI]]() - Reloads the UI from source files |
||
| − | : [[API RepopMe|RepopMe]]() - The "Release Spirit" button. Sends you to the graveyard when dead. |
||
| − | : [[API RequestTimePlayed|RequestTimePlayed]]() - Request a summary of time played from the server. |
||
| − | : [[API RestartGx|RestartGx]]() - Restarts the graphical engine. Needed for things such as resolution changes to take effect. |
||
| − | : [[API RunScript|RunScript]]("script") - Execute "script" as a block of Lua code. |
||
| − | : [[API Screenshot|Screenshot]]() - Takes a screenshot. |
||
| − | : UI [[API SecondsToTime|SecondsToTime]] - Converts a number of seconds into a readable days / hours / etc. formatted string. |
||
| − | : [[API seterrorhandler|seterrorhandler]](function) - Set the error handler to the given parameter. |
||
| − | : [[API StopCinematic|StopCinematic]]() |
||
| − | : [[API StopMusic|StopMusic]]() - Stops the currently playing mp3. |
||
| − | : UI [[API UIParentLoadAddOn|UIParentLoadAddOn]]("AddOnName") - Loads or Reloads the specified AddOn, and pops up an error message if it fails to load for any reason. |
||
| − | : UI [[API TakeScreenshot|TakeScreenshot]]() - Takes a screenshot. |
||
| − | : UI [[API ERRORMESSAGE|_ERRORMESSAGE]](value) - Displays the script error dialog with optional text |
||
| − | : [[API debuginfo|debuginfo]]() - Output win32 debug text. Freeware debug message viewer: [http://www.sysinternals.com/Utilities/DebugView.html DebugView] (Has no effect on live server.) |
||
| − | : UI [[API message|message]]("text") - Displays a message box with your text message and an "Okay" button. |
||
| − | |||
| − | === Talent Functions === |
||
| − | : [[API BuyTrainerService|BuyTrainerService]](index) - Used for buying new/upgrading professions, profession items and class skills. |
||
| − | : [[API CheckTalentMasterDist|CheckTalentMasterDist]]() - Returns nil if the player is too far away from the talent master to use the talent methods. |
||
| − | : [[API ConfirmTalentWipe|ConfirmTalentWipe]]() - Confirms freeing all talent points. |
||
| − | : [[API GetActiveTalentGroup|GetActiveTalentGroup]](isInspect,isPet) - Returns the index of the current talent group |
||
| − | : [[API GetNumTalentTabs|GetNumTalentTabs]]([inspect[,pet]]) - return number of talent trees (usually 3). The inspect argument is new with 2.3. |
||
| − | : [[API GetNumTalents|GetNumTalents]](tabIndex[,inspect[,pet]]) - return number of talents in tree. The inspect argument is new with 2.3. |
||
| − | : [[API GetTalentInfo|GetTalentInfo]](tabIndex,talentIndex[,inspect][,isPet][,groupIndex]) - return name, iconTexture, tier, column, rank, maxRank, isExceptional, meetsPrereq. [,inspect][,isPet] added in 2.3. [,groupIndex] added in 3.1.0. |
||
| − | : [[API GetTalentLink|GetTalentLink]](tabIndex,talentIndex[,isInspect][,isPet][,groupIndex][, isPreview]) - Returns the talent link. (2.4) [,isInspect][,isPet] added in 3.0.1. groupIndex and isPreview added in 3.1.0. |
||
| − | : [[API GetTalentPrereqs|GetTalentPrereqs]](tabIndex,talentIndex[,inspect] [, groupIndex]) - return tier, column, isLearnable. The inspect argument is new with 2.3, groupIndex in 3.1. |
||
| − | : [[API GetTalentTabInfo|GetTalentTabInfo]](tabIndex[,inspect][,isPet][, groupIndex]) - return name, iconTexture, pointsSpent, background, and previewPointsSpent. The inspect argument is new with 2.3, the isPet argument with 3.0.2; groupIndex in 3.1. |
||
| − | : [[API LearnTalent|LearnTalent]](tabIndex,talentIndex) - Learns a talent from the talent tree. |
||
| − | : [[API SetActiveTalentGroup|SetActiveTalentGroup]](talentGroupIndex) - switch the character's talents to the specified talent group |
||
| − | : [[API GetNumTalentGroups|GetNumTalentGroups]](isInspect, isPet) - returns the number of available specialization groups for the specified character/pet. (New in 3.1) |
||
| − | : [[API GetActiveTalentGroup|GetActiveTalentGroup]](isInspect, isPet) - returns the active specialization for the specified character/pet. (New in 3.1) |
||
| − | : [[API GetPrimaryTalentTree|GetPrimaryTalentTree]](isInspect, isPet, TalentGroup) - returns an integer indicating the primary talent tree in the active talent group. (New in 4.0) |
||
| − | |||
| − | Talent points preview (assignment before spending) was introduced in 3.1.0: |
||
| − | : [[API AddPreviewTalentPoints|AddPreviewTalentPoints]](tabIndex, talentIndex, points[, isPet[, groupIndex]]) - Add talent points to the previewed talent build. |
||
| − | : [[API GetGroupPreviewTalentPointsSpent|GetGroupPreviewTalentPointsSpent]](isPet[, groupIndex]) - Returns the total number of points spent in a spec. |
||
| − | : [[API GetPreviewTalentPointsSpent|GetPreviewTalentPointsSpent]](tabIndex, isPet [,groupIndex]) - Returns the number of points spent. |
||
| − | : [[API GetUnspentTalentPoints|GetUnspentTalentPoints]]([isInspect [,isPet)]] - Returns the number of unspent talent points. |
||
| − | : [[API LearnPreviewTalents|LearnPreviewTalents]](isPet) - Learns currently previewed talents. |
||
| − | : [[API ResetGroupPreviewTalentPoints|ResetGroupPreviewTalentPoints]](isPet[,groupIndex]) - Unassigns all preview talent points. |
||
| − | : [[API ResetPreviewTalentPoints|ResetPreviewTalentPoints]](tabIndex, isPet [,groupIndex]) - Unassigns preview talent points in a specific tab. |
||
| − | |||
| − | === Targeting Functions === |
||
| − | : PROTECTED [[API AssistUnit|AssistUnit]]("[[unitId|unit]]") - Instructs your character to assist the specified unit. |
||
| − | : PROTECTED [[API AttackTarget|AttackTarget]]() - Attacks the targetted unit. |
||
| − | : PROTECTED [[API ClearTarget|ClearTarget]]() - Clears the selected target. |
||
| − | : [[API ClickTargetTradeButton|ClickTargetTradeButton]](index) |
||
| − | : PROTECTED [[API TargetLastEnemy|TargetLastEnemy]]() - Selects the last targetted enemy as the current target. |
||
| − | : PROTECTED [[API TargetLastTarget|TargetLastTarget]]() - Selects the last target as the current target. |
||
| − | : PROTECTED [[API TargetNearestEnemy|TargetNearestEnemy]]([reverseFlag]) - Selects the nearest enemy as the current target. |
||
| − | : PROTECTED [[API TargetNearestEnemyPlayer|TargetNearestEnemyPlayer]]([reverseFlag]) - Selects the nearest enemy player as the current target. |
||
| − | : PROTECTED [[API TargetNearestFriend|TargetNearestFriend]]([reverseFlag]) - Selects the nearest friendly unit as the current target. |
||
| − | : PROTECTED [[API TargetNearestFriendPlayer|TargetNearestFriendPlayer]]([reverseFlag]) - Selects the nearest friendly player as the current target. |
||
| − | : PROTECTED [[API TargetNearestPartyMember|TargetNearestPartyMember]]() - Selects the nearest Party member as the current target. |
||
| − | : PROTECTED [[API TargetNearestRaidMember|TargetNearestRaidMember]]() - Selects the nearest Raid member as the current target. |
||
| − | : PROTECTED [[API TargetUnit|TargetUnit]]("[[unitId|unit]]") - Selects the specified unit as the current target. |
||
| − | |||
| − | === Taxi Functions === |
||
| − | : [[API CloseTaxiMap|CloseTaxiMap]]() - Closes the Flightpath Map. |
||
| − | : [[API DrawRouteLine|DrawRouteLine]](texture, canvas, startx, starty, endx, endy, width, relPoint) - Draws a line. |
||
| − | : [[API GetNumRoutes|GetNumRoutes]](slot) - Gets the number of hops between current-slot and slot. |
||
| − | : [[API NumTaxiNodes|NumTaxiNodes]]() - Returns the number of nodes (flight paths) on an open taxi map. |
||
| − | : [[API SetTaxiMap|SetTaxiMap]](frame) - ?. |
||
| − | : [[API TakeTaxiNode|TakeTaxiNode]](slot) - Takes the named taxi node. |
||
| − | : [[API TaxiNodeCost|TaxiNodeCost]](slot) - Returns the cost in copper of a node. |
||
| − | : [[API TaxiNodeGetType|TaxiNodeGetType]](slot) - Returns the status of a node. |
||
| − | : [[API TaxiGetSrcX|TaxiGetSrcX]](slot, hop) - ?. |
||
| − | : [[API TaxiGetSrcY|TaxiGetSrcY]](slot, hop) - ?. |
||
| − | : [[API TaxiGetDestX|TaxiGetDestX]](slot, hop) - ?. |
||
| − | : [[API TaxiGetDestY|TaxiGetDestY]](slot, hop) - ?. |
||
| − | : [[API TaxiNodeSetCurrent|TaxiNodeSetCurrent]](slot) - Renumbers slots based on new current slot. |
||
| − | : [[API TaxiNodeName|TaxiNodeName]](slot) - Returns the name of a node. |
||
| − | : [[API TaxiNodePosition|TaxiNodePosition]](slot) - Returns position (x,y) of node on the map. |
||
| − | : [[API UnitOnTaxi|UnitOnTaxi]]("[[unitId|unit]]") - Returns 1 if unit is on a taxi. |
||
| − | |||
| − | === Toggle Functions === |
||
| − | : UI [[API ToggleBackpack|ToggleBackpack]]() - Toggles your backpack open/closed. |
||
| − | : UI [[API ToggleBag|ToggleBag]]([[bagId|bagID]]) - Opens or closes the specified bag. |
||
| − | : UI [[API ToggleCharacter|ToggleCharacter]](index) - Toggles the character pane to the specified frame. |
||
| − | : UI [[API ToggleFramerate|ToggleFramerate]] - Show/Hide the FPS. |
||
| − | : UI [[API ToggleFriendsFrame|ToggleFriendsFrame]]([tabNumber]) - Opens/closes the friends pane (possibly on a specific tab). |
||
| − | : PROTECTED UI [[API ToggleGameMenu|ToggleGameMenu]] - Opens/closes the game menu. Triggers protected functions. |
||
| − | : UI [[API ToggleHelpFrame|ToggleHelpFrame]] - Opens the Help Request frame. |
||
| − | : UI [[API ToggleKeyRing|ToggleKeyRing]] - Opens/closes the key ring. |
||
| − | : UI [[API ToggleMinimap|ToggleMinimap]] - Turns the minimap display on/off. |
||
| − | : UI [[API TogglePVPFrame|TogglePVPFrame]] - Opens/closes the PvP frame. |
||
| − | : UI [[API ToggleSpellBook|ToggleSpellBook]]("bookType") - Shows the spellbook. Can show your spells or your pet's. |
||
| − | : UI [[API ToggleTalentFrame|ToggleTalentFrame]] - Opens the Talent frame. |
||
| − | : UI [[API ToggleAchievementFrame|ToggleAchievementFrame]] - Shows the achievements frame. |
||
| − | |||
| − | === TradeSkill Functions === |
||
| − | : [[API CloseTradeSkill|CloseTradeSkill]]() - Closes an open trade skill window. |
||
| − | : [[API CollapseTradeSkillSubClass|CollapseTradeSkillSubClass]](index) - Collapses the specified subclass header row. |
||
| − | : [[API DoTradeSkill|DoTradeSkill]](index[, repeatTimes]) - Performs the tradeskill a specified # of times. |
||
| − | : [[API ExpandTradeSkillSubClass|ExpandTradeSkillSubClass]](index) - Expands the specified subclass header row. |
||
| − | : [[API GetFirstTradeSkill|GetFirstTradeSkill]]() - Returns the index of the first non-header trade skill entry. |
||
| − | : [[API GetNumTradeSkills|GetNumTradeSkills]]() - Get the number of trade skill entries (including headers). |
||
| − | : [[API GetTradeSkillCooldown|GetTradeSkillCooldown]](index) - Returns the number of seconds left for a skill to cooldown. |
||
| − | : [[API GetTradeSkillDescription|GetTradeSkillDescription]](index) - Returns the description text of the indicated trade skill. |
||
| − | : [[API GetTradeSkillIcon|GetTradeSkillIcon]](index) - Returns the texture name of a tradeskill's icon. |
||
| − | : [[API GetTradeSkillInfo|GetTradeSkillInfo]](index) - Retrieves information about a specific trade skill. |
||
| − | : [[API GetTradeSkillInvSlotFilter|GetTradeSkillInvSlotFilter]](slotIndex) - Returns 1 if items corresponding to slotIndex are currently visible, otherwise nil. |
||
| − | : [[API GetTradeSkillInvSlots|GetTradeSkillInvSlots]]() - Returns a list of the available inventory slot types. |
||
| − | : [[API GetTradeSkillItemLink|GetTradeSkillItemLink]](index) - Returns the [[itemLink]] for a trade skill item. |
||
| − | : [[API GetTradeSkillLine|GetTradeSkillLine]]() - Returns information about the selected skill line. |
||
| − | : [[API GetTradeSkillListLink|GetTradeSkillListLink]]() - Returns the [[TradeSkillLink]] for a trade skill. |
||
| − | : [[API GetTradeSkillNumMade|GetTradeSkillNumMade]](index) - Gets the number of items made in a single use of a skill. |
||
| − | : [[API GetTradeSkillNumReagents|GetTradeSkillNumReagents]](tradeSkillRecipeId) - Returns the number of different reagents required. |
||
| − | : [[API GetTradeSkillReagentInfo|GetTradeSkillReagentInfo]](tradeSkillRecipeId, reagentId) - Returns data on the reagent, including a count of the player's inventory. |
||
| − | : [[API GetTradeSkillReagentItemLink|GetTradeSkillReagentItemLink]](index, reagentId) - Returns the [[itemLink]] for one of the reagents needed to craft the given item |
||
| − | : [[API GetTradeSkillRecipeLink|GetTradeSkillRecipeLink]](index) - Returns the [[EnchantLink]] for a trade skill. |
||
| − | : [[API GetTradeSkillSelectionIndex|GetTradeSkillSelectionIndex]]() - Returns the Id of the currently selected trade skill, 0 if none selected. |
||
| − | : [[API GetTradeSkillSubClassFilter|GetTradeSkillSubClassFilter]](filterIndex) - Returns 1 if items corresponding to filterIndex are currently visible, otherwise nil. |
||
| − | : [[API GetTradeSkillSubClasses|GetTradeSkillSubClasses]]() - Returns a list of the valid subclasses. |
||
| − | : [[API GetTradeSkillTools|GetTradeSkillTools]](index) - Returns information about the tools needed for a tradeskill. |
||
| − | : [[API GetTradeskillRepeatCount|GetTradeskillRepeatCount]]() - Returns the number of times the current item is being crafted. |
||
| − | : [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns 1 if trainer is for a tradeskill. |
||
| − | : [[API IsTradeSkillLinked|IsTradeSkillLinked]]() - Returns true if you're inspecting a tradeskill link rather then looking at your own tradeskills |
||
| − | : [[API SelectTradeSkill|SelectTradeSkill]](index) - Select a specific trade skill in the list. |
||
| − | : [[API SetTradeSkillInvSlotFilter|SetTradeSkillInvSlotFilter]](slotIndex, onOff[, exclusive] ) - Set the inventory slot type filter. |
||
| − | : [[API SetTradeSkillSubClassFilter|SetTradeSkillSubClassFilter]](slotIndex, onOff[,exclusive] ) - Set the subclass filter. |
||
| − | : [[API StopTradeSkillRepeat|StopTradeSkillRepeat]]() - Stops creating additional queued items. |
||
| − | : [[API TradeSkillOnlyShowMakeable|TradeSkillOnlyShowMakeable]](onlyMakable) - Controls whether only recipes you have the reagents to craft are shown. |
||
| − | |||
| − | === Tracking Functions === |
||
| − | : [[API GetNumTrackingTypes|GetNumTrackingTypes]]() - Returns number of available tracking methods. |
||
| − | : [[API GetTrackingInfo|GetTrackingInfo]](id) - Retrieves tracking information from specified id. |
||
| − | : [[API SetTracking|SetTracking]](id) - Selects a tracking method. |
||
| − | |||
| − | === Trading Functions === |
||
| − | : HW [[API AcceptTrade|AcceptTrade]]() - A pending trade will be accepted. |
||
| − | : [[API AddTradeMoney|AddTradeMoney]]() - Adds the money dropped into the player's trade frame. |
||
| − | : [[API CancelTrade|CancelTrade]]() - Declines the offer to trade with the other player. |
||
| − | : [[API CancelTradeAccept|CancelTradeAccept]]() - Cancels the trade attempt which required an accept. |
||
| − | : [[API ClickTargetTradeButton|ClickTargetTradeButton]](index) |
||
| − | : [[API ClickTradeButton|ClickTradeButton]](index) - Equivalent of a mouseclick on the trade window buttons [1-7] |
||
| − | : [[API CloseTrade|CloseTrade]]() - Closes the trade. |
||
| − | : [[API GetPlayerTradeMoney|GetPlayerTradeMoney]] - Returns the amount of money the player has in the trade window. |
||
| − | : [[API GetTargetTradeMoney|GetTargetTradeMoney]] - Returns the amount of money in the trade frame of the target player. |
||
| − | : [[API GetTradePlayerItemInfo|GetTradePlayerItemInfo]](id) - Returns information about a trade item. |
||
| − | : [[API GetTradePlayerItemLink|GetTradePlayerItemLink]](id) - Returns an [[itemLink]] for the given item in your side of the trade window (if open) |
||
| − | : [[API GetTradeTargetItemInfo|GetTradeTargetItemInfo]](id) - Returns information about a trade item. |
||
| − | : [[API GetTradeTargetItemLink|GetTradeTargetItemLink]](id) - Returns an [[itemLink]] for the given item in the other player's side of the trade window (if open) |
||
| − | : [[API InitiateTrade|InitiateTrade]](UnitId) - Asks the specified unit to trade. |
||
| − | : [[API PickupPlayerMoney|PickupPlayerMoney]](copper) - Picks up an amount of money from the player. |
||
| − | : [[API PickupTradeMoney|PickupTradeMoney]](copper) - Picks up an amount of money from the player's trade offer. |
||
| − | : [[API SetTradeMoney|SetTradeMoney]](copper) - Sets the amount of money offered as part of the player's trade offer. |
||
| − | : [[API ReplaceTradeEnchant|ReplaceTradeEnchant]]() - Confirm the replacement of an enchantment via trade. |
||
| − | |||
| − | === Training Functions === |
||
| − | : [[API BuyTrainerService|BuyTrainerService]](index) - Used for buying new/upgrading professions, profession items and class skills. |
||
| − | : [[API CloseTrainer|CloseTrainer]]() - Closes the trainer window. |
||
| − | : [[API GetNumTrainerServices|GetNumTrainerServices]]() - Get the number of the trainer services. |
||
| − | : [[API GetTrainerGreetingText|GetTrainerGreetingText]]() - Get the trainer's greeting text. |
||
| − | : [[API GetTrainerSelectionIndex|GetTrainerSelectionIndex]]() - Get the index of the selected trainer service. |
||
| − | : [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]](trainerIndex,reqIndex) - Used for displaying the requirements to learn a new profession, profession skill or class skill. |
||
| − | : [[API GetTrainerServiceCost|GetTrainerServiceCost]](index) - Returns the cost of a specific trainer service. |
||
| − | : [[API GetTrainerServiceDescription|GetTrainerServiceDescription]](index) - Returns the description of a specific trainer service. |
||
| − | : [[API GetTrainerServiceIcon|GetTrainerServiceIcon]](index) - Returns icon texture for a trainer service. |
||
| − | : [[API GetTrainerServiceInfo|GetTrainerServiceInfo]](index) - Returns information about a trainer service. |
||
| − | : [[API GetTrainerServiceItemLink|GetTrainerServiceItemLink]](index) - Returns an item link for a trainer service. |
||
| − | : [[API GetTrainerServiceLevelReq|GetTrainerServiceLevelReq]](index) - Get the required level to learn the skill. |
||
| − | : [[API GetTrainerServiceNumAbilityReq|GetTrainerServiceNumAbilityReq]] - Get the maximum number of requirements that [[API GetTrainerServiceAbilityReq|GetTrainerServiceAbilityReq]]() has. |
||
| − | : [[API GetTrainerServiceSkillLine|GetTrainerServiceSkillLine]](index) - ?. |
||
| − | : [[API GetTrainerServiceSkillReq|GetTrainerServiceSkillReq]](index) - Returns a String and Variable for the requirements of a specific trainer service. |
||
| − | : [[API GetTrainerServiceTypeFilter|GetTrainerServiceTypeFilter]]("filter") - Returns the status of a skill filter in the trainer window. |
||
| − | : [[API IsTradeskillTrainer|IsTradeskillTrainer]]() - Returns 1 if trainer is for a tradeskill. |
||
| − | : [[API OpenTrainer|OpenTrainer]]() - ?. |
||
| − | : [[API SelectTrainerService|SelectTrainerService]] - ?. |
||
| − | : [[API SetTrainerServiceTypeFilter|SetTrainerServiceTypeFilter]]("filter",state) - Sets the status of a skill filter in the trainer window. |
||
| − | |||
| − | === Unit Functions === |
||
| − | These are functions which act on one or more units. Units are identified by [[UnitId]]s. |
||
| − | |||
| − | : PROTECTED [[API AssistUnit|AssistUnit]]("unit") - Instructs your character to assist the specified unit. |
||
| − | : [[API CheckInteractDistance|CheckInteractDistance]]("unit",distIndex) |
||
| − | : [[API DropItemOnUnit|DropItemOnUnit]]("unit") - Drops an item from the cursor onto a unit. |
||
| − | : [[API FollowUnit|FollowUnit]]("unit") - Follow an ally with the specified UnitID |
||
| − | : PROTECTED [[API FocusUnit|FocusUnit]]("unit") - Sets your unit for focus. -- Protected with Patch 2.0! |
||
| − | : PROTECTED [[API ClearFocus|ClearFocus]]() - Removes any focus you may have set. |
||
| − | : UI [[API GetUnitName|GetUnitName]]("unit", showServerName) - Returns a string with the unit's name and realm name if applicable. |
||
| − | : [[API GetUnitPitch|GetUnitPitch]]("unit") - Returns the moving pitch of the unit. -- New for WoW 3.0.2 |
||
| − | : [[API GetUnitSpeed|GetUnitSpeed]]("unit") - Returns the moving speed of the unit. -- New for WoW 3.0.2 |
||
| − | : [[API InviteUnit|InviteUnit]]("name" or "unit") - Invites the specified player to the group you are currently in ''(new for WoW 2.0)'' |
||
| − | : [[API IsUnitOnQuest|IsUnitOnQuest]](questIndex, "unit") - Determine if the specified unit is on the given quest. |
||
| − | : [[API SpellCanTargetUnit|SpellCanTargetUnit]]("unit") - Returns true if the spell awaiting target selection can be cast on the specified unit. |
||
| − | : PROTECTED [[API SpellTargetUnit|SpellTargetUnit]]("unit") - Casts the spell awaiting target selection on the specified unit. |
||
| − | : PROTECTED [[API TargetUnit|TargetUnit]]("unit") - Selects the specified unit as the current target. -- Protected with Patch 2.0! |
||
| − | : [[API UnitAffectingCombat|UnitAffectingCombat]]("unit") - Determine if the unit is in combat or has aggro. (returns nil if "false" and 1 if "true") |
||
| − | : [[API UnitArmor|UnitArmor]]("unit") - Returns the armor statistics relevant to the specified unit. |
||
| − | : [[API UnitAttackBothHands|UnitAttackBothHands]]("unit") - Returns information about the unit's melee attacks. |
||
| − | : [[API UnitAttackPower|UnitAttackPower]]("unit") - Returns the unit's melee attack power and modifiers. |
||
| − | : [[API UnitAttackSpeed|UnitAttackSpeed]]("unit") - Returns the unit's melee attack speed for each hand. |
||
| − | : [[API UnitAura|UnitAura]]("unit", index [, filter]) - Returns info about buffs and debuffs of a unit. |
||
| − | : [[API UnitBuff|UnitBuff]]("unit", index [,raidFilter]) - Retrieves info about a buff of a certain unit. (Updated in 2.0) |
||
| − | : [[API UnitCanAssist|UnitCanAssist]]("unit", "otherUnit") - Indicates whether the first unit can assist the second unit. |
||
| − | : [[API UnitCanAttack|UnitCanAttack]]("unit", "otherUnit") - Returns true if the first unit can attack the second, false otherwise. |
||
| − | : [[API UnitCanCooperate|UnitCanCooperate]]("unit", "otherUnit") - Returns true if the first unit can cooperate with the second, false otherwise. |
||
| − | : [[API UnitClass|UnitClass]]("unit") - Returns the class name of the specified unit (e.g., "Warrior" or "Shaman"). |
||
| − | : [[API UnitClassification|UnitClassification]]("unit") - Returns the classification of the specified unit (e.g., "elite" or "worldboss"). |
||
| − | : [[API UnitCreatureFamily|UnitCreatureFamily]]("unit") - Returns the type of creature of the specified unit (e.g., "Crab"). |
||
| − | : [[API UnitCreatureType|UnitCreatureType]]("unit") - Returns the classification type of creature of the specified unit (e.g., "Beast"). |
||
| − | : [[API UnitDamage|UnitDamage]]("unit") - Returns the damage statistics relevant to the specified unit. |
||
| − | : [[API UnitDebuff|UnitDebuff]]("unit", index [,raidFilter]) - Retrieves info about a debuff of a certain unit. (Updated in 2.0) |
||
| − | : [[API UnitDefense|UnitDefense]]("unit") - Returns the base defense skill of the specified unit. |
||
| − | : [[API UnitDetailedThreatSituation|UnitDetailedThreatSituation]]("unit", "[[unitId|mob]]") - Returns detailed information about the specified unit's threat on a mob. New in [[Patch 3.0]]. |
||
| − | : [[API UnitExists|UnitExists]]("unit") - Returns 1 if the specified unit exists, nil otherwise. |
||
| − | : [[API UnitFactionGroup|UnitFactionGroup]]("unit") - Returns the faction group id and name of the specified unit. (eg. "Alliance") - string returned is localization-independent (used in filepath) |
||
| − | : [[API UnitGroupRolesAssigned|UnitGroupRolesAssigned]]("unit") - Returns the assigned role in a group formed via the Dungeon Finder Tool. (New in [[Patch 3.3]]) |
||
| − | : [[API UnitGUID|UnitGUID]]("unit") - Returns the GUID as a string for the specified unit matching the GUIDs used by the new combat logs. (New in [[Patch 2.4]]) |
||
| − | : [[API GetPlayerInfoByGUID|GetPlayerInfoByGUID]]("guid") - Added in 3.2, returns race, class, sex about the guid (client must have seen the guid) |
||
| − | : [[API UnitHasLFGDeserter|UnitHasLFGDeserter]]("unit") - Returns whether the unit is currently unable to use the dungeon finder due to leaving a group prematurely. (3.3.3) |
||
| − | : [[API UnitHasLFGRandomCooldown|UnitHasLFGRandomCooldown]]("unit") - Returns whether the unit is currently under the effects of the random dungeon cooldown. (3.3.3) |
||
| − | : [[API UnitHasRelicSlot|UnitHasRelicSlot]]("unit") |
||
| − | : [[API UnitHealth|UnitHealth]]("unit") - Returns the current health, in points, of the specified unit. |
||
| − | : [[API UnitHealthMax|UnitHealthMax]]("unit") - Returns the maximum health, in points, of the specified unit. |
||
| − | : [[API UnitInParty|UnitInParty]]("unit") - Returns true if the unit is a member of your party. |
||
| − | : [[API UnitInRaid|UnitInRaid]]("unit") - Returns the unit index if the unit is in your raid/battlegroud, nil otherwise. |
||
| − | : [[API UnitInBattleground|UnitInBattleground]]("unit") - Returns the unit index if the unit is in your battleground, nil otherwise. |
||
| − | : [[API UnitIsInMyGuild|UnitIsInMyGuild]]("unit") - Returns whether the specified unit is in the same guild as the player's character. |
||
| − | : [[API UnitInRange|UnitInRange]]("unit") - Returns true if the unit (party or raid only) is in range of a typical spell such as flash heal. (New in [[Patch 2.4]])) |
||
| − | : [[API UnitIsAFK|UnitIsAFK]]("unit") - Only works for friendly units. |
||
| − | : [[API UnitIsCharmed|UnitIsCharmed]]("unit") - Returns true if the specified unit is charmed, false otherwise. |
||
| − | : [[API UnitIsConnected|UnitIsConnected]]("unit") - Returns 1 if the specified unit is connected or npc, nil if offline or not a valid unit. |
||
| − | : [[API UnitIsCorpse|UnitIsCorpse]]("unit") - Returns true if the specified unit is a corpse, false otherwise. |
||
| − | : [[API UnitIsDead|UnitIsDead]]("unit") - Returns true if the specified unit is dead, nil otherwise. |
||
| − | : [[API UnitIsDeadOrGhost|UnitIsDeadOrGhost]]("unit") - Returns true if the specified unit is dead or a ghost, nil otherwise. |
||
| − | : [[API UnitIsDND|UnitIsDND]]("unit") - Only works for friendly units. |
||
| − | : [[API UnitIsEnemy|UnitIsEnemy]]("unit", "otherUnit") - Returns true if the specified units are enemies, false otherwise. |
||
| − | : [[API UnitIsFeignDeath|UnitIsFeignDeath]]("unit") - Returns true if the specified unit (must be a member of your group) is feigning death.''-- Added in 2.1'' |
||
| − | : [[API UnitIsFriend|UnitIsFriend]]("unit", "otherUnit") - Returns true if the specified units are friends (PC of same faction or friendly NPC), false otherwise. |
||
| − | : [[API UnitIsGhost|UnitIsGhost]]("unit") - Returns true if the specified unit is a ghost, false otherwise. |
||
| − | : [[API UnitIsPVP|UnitIsPVP]]("unit") - Returns true if the specified unit is flagged for PVP, false otherwise. |
||
| − | : [[API UnitIsPVPFreeForAll|UnitIsPVPFreeForAll]]("unit") - Returns true if the specified unit is flagged for free-for-all PVP, false otherwise. |
||
| − | : [[API UnitIsPVPSanctuary|UnitIsPVPSanctuary]]("unit") - Returns whether the unit is in a PvP sanctuary, and therefore cannot be attacked by other players. |
||
| − | : [[API UnitIsPartyLeader|UnitIsPartyLeader]]("unit") - Returns true if the unit is the leader of its party. |
||
| − | : [[API UnitIsPlayer|UnitIsPlayer]]("unit") - Returns true if the specified unit is a player character, false otherwise. |
||
| − | : [[API UnitIsPossessed|UnitIsPossessed]]("unit") - Returns whether the specified unit is currently under control of another (i.e. "pet" when casting Mind Control). |
||
| − | : [[API UnitIsRaidOfficer|UnitIsRaidOfficer]]("unit") - Returns whether the specified unit is an officer in your raid. |
||
| − | : [[API UnitIsSameServer|UnitIsSameServer]]("unit") - Returns whether the specified unit is from the same server as the player's character. |
||
| − | : [[API UnitIsTapped|UnitIsTapped]]("unit") - Returns true if the specified unit is tapped, false otherwise. |
||
| − | : [[API UnitIsTappedByPlayer|UnitIsTappedByPlayer]]("unit") - Returns true if the specified unit is tapped by the player himself, otherwise false. |
||
| − | : [[API UnitIsTappedByAllThreatList|UnitIsTappedByAllThreatList]]("unit") - Returns whether the specified unit is a community monster, i.e. whether all players engaged in combat with it will receive kill (quest) credit. |
||
| − | : [[API UnitIsTrivial|UnitIsTrivial]]("unit") - Returns true if the specified unit is trivial (Trivial means the unit is "grey" to the player. false otherwise. |
||
| − | : [[API UnitIsUnit|UnitIsUnit]]("unit", "otherUnit") - Determine if two units are the same unit. |
||
| − | : [[API UnitIsVisible|UnitIsVisible]]("unit") - 1 if visible, nil if not |
||
| − | : [[API UnitLevel|UnitLevel]]("unit") - Returns the level of a unit. |
||
| − | : [[API UnitName|UnitName]]("unit") - Returns the name (and realm name) of a unit. |
||
| − | : [[API UnitOnTaxi|UnitOnTaxi]]("unit") - Returns 1 if unit is on a taxi. |
||
| − | : [[API UnitPlayerControlled|UnitPlayerControlled]]("unit") - Returns true if the specified unit is controlled by a player, false otherwise. |
||
| − | : [[API UnitPlayerOrPetInParty|UnitPlayerOrPetInParty]]("unit") - Returns 1 if the specified unit/pet is a member of the player's party, nil otherwise (returns nil for "player" and "pet") - Added in 1.12 |
||
| − | : [[API UnitPlayerOrPetInRaid|UnitPlayerOrPetInRaid]]("unit") - Returns 1 if the specified unit/pet is a member of the player's raid, nil otherwise (returns nil for "player" and "pet") - Added in 1.12 |
||
| − | : [[API UnitPVPName|UnitPVPName]]("unit") - Returns unit's name with PvP rank prefix (e.g., "Corporal Allianceguy"). |
||
| − | : [[API UnitPVPRank|UnitPVPRank]]("unit") - Get PvP rank information for requested unit. |
||
| − | : [[API UnitPower|UnitPower]]("unit"[,type]) - Returns current power of the specified unit (Replaces [[API UnitMana|UnitMana]]() as of WoW 3.0.2) |
||
| − | : [[API UnitPowerMax|UnitPowerMax]]("unit"[,type]) - Returns max power of the specified unit (Replaces [[API UnitManaMax|UnitManaMax]]() as of WoW 3.0.2) |
||
| − | : [[API UnitPowerType|UnitPowerType]]("unit") - Returns a number corresponding to the power type (e.g., mana, rage or energy) of the specified unit. |
||
| − | : [[API UnitRace|UnitRace]]("unit") - Returns the race name of the specified unit (e.g., "Human" or "Troll"). |
||
| − | : [[API UnitRangedAttack|UnitRangedAttack]]("unit") - Returns the ranged attack number of the unit. |
||
| − | : [[API UnitRangedAttackPower|UnitRangedAttackPower]]("unit") - Returns the ranged attack power of the unit. |
||
| − | : [[API UnitRangedDamage|UnitRangedDamage]]("unit") - Returns the ranged attack speed and damage of the unit. |
||
| − | : [[API UnitReaction|UnitReaction]]("unit", "otherUnit") - Returns a number corresponding to the reaction (aggressive, neutral or friendly) of the first unit towards the second unit. |
||
| − | : [[API UnitResistance|UnitResistance]]("unit", "resistanceIndex") - Returns the resistance statistics relevant to the specified unit and resistance type. |
||
| − | : [[API UnitSelectionColor|UnitSelectionColor]]([[UnitId]]) - Returns RGBA values for the color of a unit's name. |
||
| − | : [[API UnitSex|UnitSex]]("unit") - Returns a code indicating the gender of the specified unit, if known. (1=unknown, 2=male, 3=female) <small>← changed in 1.11!</small> |
||
| − | : [[API UnitStat|UnitStat]]("unit", statIndex) - Returns the statistics relevant to the specified unit and basic attribute (e.g., strength or intellect). |
||
| − | : [[API UnitThreatSituation|UnitThreatSituation]]("unit", "[[unitId|mob]]") - Returns the specified unit's threat status on a mob. New in [[Patch 3.0]]. |
||
| − | : [[API UnitUsingVehicle|UnitUsingVehicle]]("unit") - Returns whether the specified unit is currently using a vehicle (including transitioning between seats). |
||
| − | : [[API GetThreatStatusColor|GetThreatStatusColor]](status) - Returns RGB values for a given UnitThreatSituation return value. |
||
| − | : [[API UnitXP|UnitXP]]("unit") - Returns the number of experience points the specified unit has in their current level. (only works on your player) |
||
| − | : [[API UnitXPMax|UnitXPMax]]("unit") - Returns the number of experience points the specified unit needs to reach their next level. (only works on your player) |
||
| − | : [[API SetPortraitTexture|SetPortraitTexture]](texture,"unit") - Paint a Texture object with the specified unit's portrait. |
||
| − | : [[API SetPortraitToTexture|SetPortraitToTexture]](texture or "texture", "texturePath") - Sets the texture to be displayed from a file applying a circular opacity mask making it look round like portraits. |
||
| − | |||
| − | === Vehicle Functions === |
||
| − | These functions were introduced in [[Patch 3.0.2]]. |
||
| − | : [[API CanExitVehicle|CanExitVehicle]]() - Returns 1 if the player can be exit the Vehicle. |
||
| − | : [[API CanSwitchVehicleSeats|CanSwitchVehicleSeats]]() - Returns 1 if the player can Switch Seats in the Vehicle |
||
| − | : [[API CanEjectPassengerFromSeat|CanEjectPassengerFromSeat]](seat) - Returns 1 if the player can eject a passenger from a seat. |
||
| − | : [[API GetBattlefieldVehicleInfo|GetBattlefieldVehicleInfo]](index) |
||
| − | : [[API GetNumBattlefieldVehicles|GetNumBattlefieldVehicles]](index) |
||
| − | : [[API EjectPassengerFromSeat|EjectPassengerFromSeat]](seat) - Ejects a passenger from a seat. |
||
| − | : [[API IsUsingVehicleControls|IsUsingVehicleControls]]() |
||
| − | : [[API IsUsingVehicleControls|IsUsingVehicleControls]]() |
||
| − | : [[API IsVehicleAimAngleAdjustable|IsVehicleAimAngleAdjustable]]() - Returns 1 if the player can adjust the Aim Angle of the Vehicle. |
||
| − | : [[API IsVehicleAimPowerAdjustable|IsVehicleAimPowerAdjustable]]() - Returns 1 if the player can adjust the Aim Power of the Vehicle. |
||
| − | : [[API UnitControllingVehicle|UnitControllingVehicle]](unit) |
||
| − | : [[API UnitHasVehicleUI|UnitHasVehicleUI]](unit) |
||
| − | : [[API UnitInVehicle|UnitInVehicle]](unit) |
||
| − | : [[API UnitInVehicleControlSeat|UnitInVehicleControlSeat]](unit) |
||
| − | : [[API UnitSwitchToVehicleSeat|UnitSwitchToVehicleSeat]](unit, seatId) |
||
| − | : [[API UnitTargetsVehicleInRaidUI|UnitTargetsVehicleInRaidUI]](unit) |
||
| − | : [[API UnitVehicleSeatCount|UnitVehicleSeatCount]](unit) |
||
| − | : [[API UnitVehicleSeatInfo|UnitVehicleSeatInfo]](unit, seatId) |
||
| − | : [[API UnitVehicleSkin|UnitVehicleSkin]](unit) |
||
| − | : [[API VehicleAimDecrement|VehicleAimDecrement]]() |
||
| − | : [[API VehicleAimDownStart|VehicleAimDownStart]]() |
||
| − | : [[API VehicleAimDownStop|VehicleAimDownStop]]() |
||
| − | : [[API VehicleAimGetAngle|VehicleAimGetAngle]]() |
||
| − | : [[API VehicleAimGetNormAngle|VehicleAimGetNormAngle]]() |
||
| − | : [[API VehicleAimGetNormPower|VehicleAimGetNormPower]]() |
||
| − | : [[API VehicleAimIncrement|VehicleAimIncrement]]() |
||
| − | : [[API VehicleAimRequestAngle|VehicleAimRequestAngle]]() |
||
| − | : [[API VehicleAimRequestNormAngle|VehicleAimRequestNormAngle]]() |
||
| − | : [[API VehicleAimSetNormPower|VehicleAimSetNormPower]]() |
||
| − | : [[API VehicleAimUpStart|VehicleAimUpStart]]() |
||
| − | : [[API VehicleAimUpStop|VehicleAimUpStop]]() |
||
| − | : [[API VehicleCameraZoomIn|VehicleCameraZoomIn]](amount) |
||
| − | : [[API VehicleCameraZoomOut|VehicleCameraZoomOut]](amount) |
||
| − | : [[API VehicleExit|VehicleExit]]() - Exit the current Vehicle |
||
| − | : [[API VehicleNextSeat|VehicleNextSeat]]() |
||
| − | : [[API VehiclePrevSeat|VehiclePrevSeat]]() |
||
| − | |||
| − | === Voice Chat Functions === |
||
| − | These functions were introduced in [[Patch 2.2]]. |
||
| − | |||
| − | : [[API AddMute|AddMute]]("name") |
||
| − | : [[API AddOrDelMute|AddOrDelMute]]("unit") |
||
| − | : [[API ChannelSilenceAll|ChannelSilenceAll]]() |
||
| − | : [[API ChannelSilenceVoice|ChannelSilenceVoice]]() |
||
| − | : [[API ChannelUnSilenceAll|ChannelUnSilenceAll]]() |
||
| − | : [[API ChannelUnSilenceVoice|ChannelUnSilenceVoice]]() |
||
| − | : [[API ChannelVoiceOff|ChannelVoiceOff]]() |
||
| − | : [[API ChannelVoiceOn|ChannelVoiceOn]]() |
||
| − | : [[API DelMute|DelMute]]("name") |
||
| − | : [[API DisplayChannelVoiceOff|DisplayChannelVoiceOff]]() |
||
| − | : [[API DisplayChannelVoiceOn|DisplayChannelVoiceOn]]() |
||
| − | : [[API GetActiveVoiceChannel|GetActiveVoiceChannel]]() |
||
| − | : [[API GetChannelDisplayInfo|GetChannelDisplayInfo]](id) - Returns the name of the channel according to the given id. |
||
| − | : [[API GetNumVoiceSessions|GetNumVoiceSessions()]] - Returns the number of voice sessions the client is currently in. Ignores those under the 'World' category. |
||
| − | : [[API GetSelectedDisplayChannel|GetSelectedDisplayChannel]]() |
||
| − | : [[API GetSelectedMute|GetSelectedMute]]() |
||
| − | : [[API GetMuteName|GetMuteName]](id) - Returns the name of a muted player. |
||
| − | : [[API GetMuteStatus|GetMuteStatus]]("unit", "channel") - Returns whether a particular unit is currently muted in a particular channel. |
||
| − | : [[API GetNumMutes|GetNumMutes]]() - Returns the number of people you currently have muted. |
||
| − | : [[API GetVoiceCurrentSessionID|GetVoiceCurrentSessionID]]() |
||
| − | : [[API GetVoiceSessionInfo|GetVoiceSessionInfo]](id) - Returns the name of the voice session according to the given id. Does not apply for channels under the 'World' category. |
||
| − | : [[API GetVoiceStatus|GetVoiceStatus]]("[[unitId|unit]]") |
||
| − | : [[API IsMuted|IsMuted]]("name") |
||
| − | : [[API IsSilenced|IsSilenced]]() |
||
| − | : [[API IsVoiceChatAllowed|IsVoiceChatAllowed()]] - Returns 1 if Voice Chat is enabled on the server, ''nil'' otherwise |
||
| − | : [[API IsVoiceChatEnabled|IsVoiceChatEnabled()]] - Returns 1 if Voice Chat is enabled for your client, ''nil'' otherwise |
||
| − | : [[API SetActiveVoiceChannelBySessionID|SetActiveVoiceChannelBySessionID(id)]] - Set the active voice session to the session of the given id. |
||
| − | : [[API SetActiveVoiceChannel|SetActiveVoiceChannel]]() |
||
| − | : [[API SetSelectedDisplayChannel|SetSelectedDisplayChannel]]() |
||
| − | : [[API SetSelectedMute|SetSelectedMute]]() |
||
| − | : [[API UnitIsSilenced|UnitIsSilenced]]() |
||
| − | : [[API UnitIsTalking|UnitIsTalking]]() - |
||
| − | : [[API UnSilenceMember|UnSilenceMember]]() |
||
| − | : [[API VoiceChat_ActivatePrimaryCaptureCallback|VoiceChat_ActivatePrimaryCaptureCallback]]() |
||
| − | : [[API VoiceChat_GetCurrentMicrophoneSignalLevel|VoiceChat_GetCurrentMicrophoneSignalLevel]]() |
||
| − | : [[API VoiceChat_IsPlayingLoopbackSound|VoiceChat_IsPlayingLoopbackSound]]() |
||
| − | : [[API VoiceChat_IsRecordingLoopbackSound|VoiceChat_IsRecordingLoopbackSound]]() |
||
| − | : [[API VoiceChat_PlayLoopbackSound|VoiceChat_PlayLoopbackSound]]() |
||
| − | : [[API VoiceChat_RecordLoopbackSound|VoiceChat_RecordLoopbackSound]]() |
||
| − | : [[API VoiceChat_StartCapture|VoiceChat_StartCapture]]() |
||
| − | : [[API VoiceChat_StopCapture|VoiceChat_StopCapture]]() |
||
| − | : [[API VoiceChat_StopPlayingLoopbackSound|VoiceChat_StopPlayingLoopbackSound]]() |
||
| − | : [[API VoiceChat_StopRecordingLoopbackSound|VoiceChat_StopRecordingLoopbackSound]]() |
||
| − | : [[API VoiceEnumerateCaptureDevices|VoiceEnumerateCaptureDevices]]() |
||
| − | : [[API VoiceEnumerateOutputDevices|VoiceEnumerateOutputDevices]]() |
||
| − | : [[API VoiceGetCurrentCaptureDevice|VoiceGetCurrentCaptureDevice]]() |
||
| − | : [[API VoiceGetCurrentOutputDevice|VoiceGetCurrentOutputDevice]]() |
||
| − | : [[API VoiceIsDisabledByClient|VoiceIsDisabledByClient]]() |
||
| − | : [[API VoicePushToTalkStart|VoicePushToTalkStart]]() |
||
| − | : [[API VoicePushToTalkStop|VoicePushToTalkStop]]() |
||
| − | : [[API VoiceSelectCaptureDevice|VoiceSelectCaptureDevice]]() |
||
| − | : [[API VoiceSelectOutputDevice|VoiceSelectOutputDevice]]() |
||
| − | |||
| − | === World Battlefield Functions === |
||
| − | The following functions are used for population-limited world PvP zones, primarily [[Lake Wintergrasp]]. |
||
| − | : [[API BattlefieldMgrEntryInviteResponse|BattlefieldMgrEntryInviteResponse]](queueId, accept) |
||
| − | : [[API BattlefieldMgrExitRequest|BattlefieldMgrExitRequest]](queueId) |
||
| − | : [[API BattlefieldMgrQueueInviteResponse|BattlefieldMgrQueueInviteResponse]](queueId, accept) |
||
| − | : [[API BattlefieldMgrQueueRequest|BattlefieldMgrQueueRequest]] - ? |
||
| − | : [[API CanHearthAndResurrectFromArea|CanHearthAndResurrectFromArea]]() - Returns whether you can currently be resurrected and teleported out of the world PvP zone. |
||
| − | : [[API HearthAndResurrectFromArea|HearthAndResurrectFromArea]]() - Resurrects the player, and ports them out of the world PvP zone. |
||
| − | : [[API CanQueueForWintergrasp|CanQueueForWintergrasp]]() - Returns whether you can queue for Lake Wintergrasp at the moment. |
||
| − | : [[API GetWintergraspWaitTime|GetWintergraspWaitTime]]() - Returns number of seconds before the next Lake Wintergrasp battle, nil if a battle is currently in progress. |
||
| − | : [[API GetWorldPVPQueueStatus|GetWorldPVPQueueStatus]](queueId) |
||
| − | |||
| − | === Who Functions === |
||
| − | : [[API GetNumWhoResults|GetNumWhoResults]]() - Return the number of entries resulting from your most recent /who query. |
||
| − | : [[API GetWhoInfo|GetWhoInfo]](index) |
||
| − | : [[API SendWho|SendWho]]("filter") - Send a who request to the server. |
||
| − | : [[API SetWhoToUI|SetWhoToUI]](toUIFlag) - Indicate that who request results should be delivered as WHO_LIST_UPDATE instead of to chat. |
||
| − | : [[API SortWho|SortWho]](sortType) - Sorts an existing /who list; displays the Who List frame if not visible. |
||
| − | |||
| − | == See also == |
||
| − | * [[Widget API]] documents methods that can be called on widgets objects |
||
| − | * [[Lua functions]] describe the language and library functions available in the WoW client. |
||
| − | * [[API change summaries]] document changes made in WoW patches, as summarized on the US official UI forum. |
||
| − | * [[User Defined Functions]] lists various useful user-contributed functions. |
||
| − | ** [[:Category:Function Libraries]] contains some AddOns that do nothing but provide you with utility functions. |
||
| − | |||
| − | == External links == |
||
| − | {{elink|type=wowus|site=US official UI & Macros forum|link=http://forums.worldofwarcraft.com/board.html?forumId=11114&sid=1}} |
||
| − | {{elink|type=woweu|site=EU official Interface Customisation forum|link=http://forums.wow-europe.com/board.html?forumId=11098&sid=1}} |
||
| − | [[Category:Macros]] |
||
| − | [[Category:Interface customization]] |
||
| − | [[Category:World of Warcraft API| World of Warcraft API]] |
||
| − | [[Category:UI]] |
||
Revision as of 13:10, 14 November 2010
 To Legion Hold | |
|---|---|
| Start | Wing Commander Nuainn |
| End | Wing Commander Nuainn |
| Level | 69 (Requires 67) |
| Category | Shadowmoon Valley |
| Experience |
12300 (7 38 at level 70) |
| Previous |
 [69] Besieged! |
| Next |
[69] Setting Up the Bomb |
Objectives
Make your way to Legion Hold and locate the Legion Communication Device. While standing near the communication device, use your disguise and learn about the Legion's plans. Return to Wing Commander Nuainn at Wildhammer Stronghold when you've completed your mission.
- Discover Legion's Plans
[Box o' Tricks] (Provided)
Description
The fortress of Legion Hold is nigh impregnable, and to be completely honest, I can't spare the forces for an assault. Our hopes are riding on you, <name>.
What little information we've been able to gather indicates that the Legion stocks and prepares its infernals at the hold. With the help of a disguise I'll give you, you must sneak into Legion Hold and learn about the their plans. Your best hope is to intercept or overhear communication between their commanders. Good luck, <name>.
Rewards
You will receive: 4 10
Progress
What did you discover?
Completion
<Wing Commander Nuainn listens to your report, growing more alarmed with each sentence.>
So you're saying they have more than enough infernals to intensify the bombardment? If we don't stop them before they can put the next phase of their plan into motion, Wildhammer Stronghold is finished.
Gains
Upon completion of this quest you will gain:
- 12300 experience (or 7
38 at level 70)
Quest progression
- [25-30] Visions of Destruction or
[25-30] Kroghan's Report 
[25-30] Besieged!- [25-30] To Legion Hold
- [25-30] Setting Up the Bomb
- [25-30] Blast the Infernals!
- [25-30] The Deathforge
- [25-30] Minions of the Shadow Council
- Complete both:
- [25-30] The Summoning Chamber
- [25-30] The Fate of Flanis / [25-30] The Fate of Kagrosh
- [25-30] Bring Down the Warbringer!
- [25-30] Gaining Access
- [25-30] Invasion Point: Cataclysm
- [25-30] The Art of Fel Reaver Maintenance
- [25-30] The Fel and the Furious
- [25-30] News of Victory