FrontPage

World of Warcraft API Reference

http://www.wowwiki.com/World_of_Warcraft_API
上記サイトで解説されているAPI Referenceの翻訳を主に行います。

目次

• World of Warcraft API Reference
• 目次
• Global Function Groups
  • Action Functions
  • Activity Functions
  • AddOn Functions
  • Auction Functions
  • Bank Functions
  • Battlefield Functions
  • Buff/Debuff Functions
  • Camera Functions
  • Channel Functions
  • Character Functions
  • Chat Functions
  • Communication Functions
  • Container/Bag Functions
  • Crafting Functions
  • Cursor Functions
  • Debugging Functions
  • Disabled Functions
  • Dressing Room Functions

Global Function Groups

Action Functions

• UI ActionButtonDown(id)?
• UI ActionButtonUp(id)?
• UI BonusActionButtonDown?
• UI BonusActionButtonUp?
• PROTECTED CameraOrSelectOrMoveStart()?
• PROTECTED CameraOrSelectOrMoveStop([stickyFlag])?
• ChangeActionBarPage()?
• GetActionBarToggles()?
• GetActionCooldown(slot)?
• GetActionCount(slot)?
• GetActionText(slot)?
• GetActionTexture(slot)?
• GetBonusBarOffset()?
• HasAction(slot)?
• IsActionInRange(slot)?
• IsAttackAction(slot)?
• IsAutoRepeatAction(slot)?
• IsCurrentAction(slot)?
• IsUsableAction(slot)?
• IsConsumableAction(slot)?
• IsEquippedAction(slot)?
• PetHasActionBar()?
• PickupAction(slot)?
• PickupPetAction(slot)?
• PlaceAction(slot)?
• SetActionBarToggles(show1,show2,show3,show4)?
• PROTECTED TurnOrActionStart()?
• PROTECTED TurnOrActionStop()?
• UseAction(slot, {checkCursor {,onSelf} })?

Activity Functions

• AcceptDuel()?
• AttackTarget()?
• CancelDuel()?
• CancelLogout()?
• CancelMeetingStoneRequest()?
• ClearTutorials()?
• ConfirmSummon()?
• FlagTutorial("tutotial")?
• ForceLogout()?
• ForceQuit()?
• GetSummonConfirmAreaName()?
• GetSummonConfirmSummoner()?
• GetSummonConfirmTimeLeft()?
• Logout?
• Quit?
• RandomRoll(low, high)?
• SitOrStand()?
• StartDuel("name")?
• StartDuelUnit("unit")?
• TogglePVP()?
• ToggleSheath()?
• UseSoulstone()?

AddOn Functions

• DisableAddOn(index or "AddonName")?
• DisableAllAddOns()?
• EnableAddOn(index or "AddonName")?
• EnableAllAddOns()?
• GetAddOnDependencies(index or "AddonName")?
• GetAddOnInfo(index or "AddonName")?
• GetNumAddOns()?
• IsAddOnLoaded(index or "AddonName")?
• IsAddOnLoadOnDemand(index or "AddonName")?
• LoadAddOn(index or "AddonName")?
• ResetDisabledAddOns()?

Auction Functions

• CalculateAuctionDeposit(runTime)?
• CanSendAuctionQuery()?
• CancelAuction(index)?
• ClickAuctionSellItemButton()?
• CloseAuctionHouse()?
• GetAuctionHouseDepositRate()?
• GetAuctionInvTypes(classIndex, subclassIndex)?
• GetAuctionItemClasses()?
• GetAuctionItemInfo("type", index)?
• GetAuctionItemLink("type", index)?
• GetAuctionItemSubClasses(classIndex)?
• GetAuctionItemTimeLeft("type", index)?
• GetAuctionSellItemInfo()?
• GetBidderAuctionItems({page})?
• GetNumAuctionItems("type")?
• GetOwnerAuctionItems({page})?
• GetSelectedAuctionItem("type")?
• IsAuctionSortReversed("type", "sort")?
• PlaceAuctionBid("type", index, bid)?
• QueryAuctionItems("name", minLevel, maxLevel, invTypeIndex, classIndex, subclassIndex, page, isUsable, qualityIndex)?
• SetSelectedAuctionItem("type", index)?
• SortAuctionItems("type", "sort")?
• StartAuction(minBid, buyoutPrice, runTime)?
• UI AuctionFrameAuctions.duration?

Bank Functions

• BankButtonIDToInvSlotID?
• CloseBankFrame()?
• GetBankSlotCost(numSlots)?
• GetNumBankSlots()?

Battlefield Functions

• AcceptAreaSpiritHeal()?
• CancelAreaSpiritHeal()?
• CanJoinBattlefieldAsGroup()?
• AcceptBattlefieldPort({acceptFlag})?
• CheckSpiritHealerDist()?
• CloseBattlefield()?
• GetAreaSpiritHealerTime()?
• GetBattlefieldEstimatedWaitTime()?
• GetBattlefieldFlagPosition(index)?
• GetBattlefieldInfo(index)?
• GetBattlefieldInstanceExpiration()?
• GetBattlefieldInstanceInfo(index)?
• GetBattlefieldInstanceRunTime?
• GetBattlefieldPortExpiration()?
• GetBattlefieldPosition(index)?
• GetBattlefieldScore(index)?
• GetBattlefieldStatData()?
• GetBattlefieldStatInfo()?
• GetBattlefieldStatus()?
• GetBattlefieldTimeWaited()?
• GetBattlefieldWinner()?
• GetBattlefieldWorldStateUIInfo(i)?
• GetNumBattlefieldFlagPositions?
• GetNumBattlefieldPositions()?
• GetNumBattlefieldScores()?
• GetNumBattlefieldStats()?
• GetNumBattlefieldStateUI()?
• GetNumBattlefields()?
• GetNumWorldStateUI()?
• GetSelectedBattlefield()?
• GetWorldStateUIInfo(i)?
• JoinBattlefield(index)?
• LeaveBattlefield()?
• RequestBattlefieldPositions()?
• RequestBattlefieldScoreData()?
• SetBattlefieldScoreFaction()?
• SetSelectedBattlefield(index)?
• ShowBattlefieldList()?
• ToggleBattlefieldMinimap()?

Buff/Debuff Functions

Don't get buffId and buffIndex confused, they aren't the same thing!

• CancelPlayerBuff(buffIndex)?
• CancelTrackingBuff()?
• GetPlayerBuff(buffId, buffFilter)?
• GetPlayerBuffApplications(buffIndex)?
• GetPlayerBuffTexture(buffIndex)?
• GetPlayerBuffTimeLeft(buffIndex)?
• GetWeaponEnchantInfo()?
• UnitBuff("unit", index [, showCastable])?
• UnitDebuff("unit", index [, showDispellable])?

Camera Functions

• PROTECTED CameraOrSelectOrMoveStart()?
• PROTECTED CameraOrSelectOrMoveStop([stickyFlag])?
• CameraZoomIn(increment)?
• CameraZoomOut(increment)?
• FlipCameraYaw(degrees)?
• IsMouselooking()?
• MouselookStart()?
• MouselookStop()?
• MoveViewDownStart()?
• MoveViewDownStop()?
• MoveViewInStart()?
• MoveViewInStop()?
• MoveViewLeftStart()?
• MoveViewLeftStop()?
• MoveViewOutStart()?
• MoveViewOutStop()?
• MoveViewRightStart()?
• MoveViewRightStop()?
• MoveViewUpStart()?
• MoveViewUpStop()?
• PROTECTED PitchDownStart()?
• PROTECTED PitchDownStop()?
• PROTECTED PitchUpStart()?
• PROTECTED PitchUpStop()?
• NextView()?
• PrevView()?
• ResetView(index)?
• SaveView(index)?
• SetView(index)?

Channel Functions

These are chat functions which are specific to channels. Also see the Chat Functions and Communication Functions sections.

• AddChatWindowChannel(chatFrameIndex, "channel")?
• ChannelBan("channel", "name")?
• ChannelInvite("channel", "name")?
• ChannelKick("channel", "name")?
• ChannelModerate("channel")?
• ChannelModerator("channel", "name")?
• ChannelMute("channel", "name")?
• ChannelToggleAnnouncements("channel")?
• ChannelUnban("channel", "name")?
• ChannelUnmoderator("channel", "name")?
• ChannelUnmute("channel", "name")?
• DisplayChannelOwner("channel")?
• EnumerateServerChannels()?
• GetChannelList()?
• GetChannelName("channel" or index)?
• GetChatWindowChannels(index)?
• JoinChannelByName("channel"{,"password"{,frameId}})?
• LeaveChannelByName("channel")?
• ListChannelByName(channelMatch)?
• ListChannels()?
• RemoveChatWindowChannel(chatFrameIndex, "channel")?
• SendChatMessage(text,{,type} {,language} {,targetPlayer})?
• SetChannelOwner("channel", "name")?
• SetChannelPassword("channel", "password")?

Character Functions

• AbandonSkill?
• AcceptResurrect?
• AcceptSkillUps()?
• AcceptXPLoss?
• AddSkillUp(index)?
• BuySkillTier(index)?
• CancelSkillUps()?
• CheckBinderDist()?
• ConfirmBinder()?
• DeclineResurrect()?
• GetBindLocation()?
• GetBlockChance()?
• GetComboPoints()?
• GetCorpseRecoveryDelay()?
• GetDamageBonusStat()?
• GetDodgeChance()?
• GetMoney()?
• GetParryChance()?
• GetReleaseTimeRemaining()?
• GetResSicknessDuration()?
• GetRestState()?
• GetTimeToWellRested()?
• GetXPExhaustion()?
• HasFullControl()?
• HasSoulstone()?
• IsResting()?
• NotWhileDeadError?
• RemoveSkillUp(index)?
• ResurrectHasSickness()?
• RessurectHasTimes()?
• RetrieveCorpse()?
• SetSelectedSkill(index)?

Chat Functions

These are functions which are specific to chat window management. Also see the Channel Functions and Communication Functions sections.

• AddChatWindowChannel(chatFrameIndex, "channel")?
• AddChatWindowMessages?
• ChangeChatColor(chatType,r,g,b)?
• UI API ChatFrame AddChannel(chatFrame, "channelName")?
• ChatFrameLog()?
• UI ChatFrame_OnHyperlinkShow(reference, link, button)?
• GetChatTypeIndex(type)?
• GetChatWindowChannels(index)?
• GetChatWindowInfo(index)?
• GetChatWindowMessages(index)?
• JoinChannelByName("channel"{,"password"{,frameId}})?
• LoggingChat(newState)?
• LoggingCombat(newState)?
• RemoveChatWindowChannel(chatFrameIndex, "channel")?
• RemoveChatWindowMessages(chatFrameIndex,"messageGroup")?
• SetChatWindowAlpha(index,alpha)?
• SetChatWindowColor(index,r,g,b)?
• SetChatWindowDocked(index,docked)?
• SetChatWindowLocked(index,locked)?
• SetChatWindowName(index,"name")?
• SetChatWindowShown(index,shown)?
• SetChatWindowSize(index,size)?

Communication Functions

These are the functions which communicate with other players. Also see the Channel Functions and Chat Functions sections.

• DoEmote("emote"{,"target"})?
• GetDefaultLanguage("unit")?
• GetLanguageByIndex(index)?
• GetNumLaguages()?
• RandomRoll(low, high)?
• SendChatMessage(text,{,type} {,language} {,targetPlayer})?

Container/Bag Functions

These functions manage containers (bags, backpack). See also Inventory Functions and Bank Functions.

• ContainerIDToInventoryID(bagID)?
• GetBagName(bagID)?
• GetContainerItemCooldown(bagID,slot)?
• GetContainerItemInfo(bagID,slot)?
• GetContainerItemLink(bagID,slot)?
• GetContainerNumSlots(bagID)?
• PickupBagFromSlot(slot)?
• PickupContainerItem(bagID,slot)?
• PutItemInBackpack()?
• PutItemInBag(inventoryId)?
• SetBagPortaitTexture(texture,slot)?
• SplitContainerItem(bagID,slot,amount)?
• UI ToggleBackpack()?
• UI ToggleBag(bagID)?
• UseContainerItem(bagID,slot)?

Crafting Functions

These superseded the older crafting functions for all skills, except for enchanting and the hunters train-pet-window (for the other skills see TradeSkill Functions). Most functions only work if the window for enchants is opened in the GUI. You can check whether the window is opened by using GetCraftSkillLine().

• CloseCraft()?
• CollapseCraftSkillLine(index)?
• DoCraft(index)?
• ExpandCraftSkillLine(index)?
• GetCraftButtonToken()?
• GetCraftDescription(index)?
• GetCraftDisplaySkillLine()?
• GetCraftIcon(index)?
• GetCraftInfo(index)?
• GetCraftItemLink(index)?
• GetCraftName()?
• GetCraftNumReagents(index)?
• GetCraftReagentInfo(index,reagentIndex)?
• GetCraftReagentItemLink(index,reagentIndex)?
• GetCraftSelectionIndex()?
• GetCraftSkillLine()?
• GetCraftSpellFocus?
• GetNumCrafts()?
• SelectCraft(index)?

Cursor Functions

• AutoEquipCursorItem()?
• CursorCanGoInSlot(slot)?
• CursorHasItem()?
• CursorHasMoney()?
• CursorHasSpell()?
• DeleteCursorItem()?
• DropCursorMoney?
• DropItemOnUnit("unit")?
• EquipCursorItem(x)?
• GetCursorMoney?
• GetCursorPosition()?
• HideRepairCursor()?
• InRepairMode()?
• PickupAction(slot)?
• PickupBagFromSlot(slot)?
• PickupContainerItem(bagID,slot)?
• PickupInventoryItem(slot)?
• PickupMacro(index)?
• PickupMerchantItem(index)?
• PickupPetAction(index)?
• PickupPlayerMoney?
• PickupSpell(spellID, spellbookTabNum)?
• PickupStablePet(index)?
• PickupTradeMoney(amount)?
• PlaceAction(slot)?
• PutItemInBackpack()?
• PutItemInBag(inventoryId)?
• ResetCursor()?
• SetCursor("cursor")?
• ShowContainerSellCursor(index,slot)?
• ShowInspectCursor()?
• ShowInventorySellCursor()?
• ShowMerchantSellCursor(index)?
• ShowRepairCursor()?

Debugging Functions

• debugprofilestart()?
• debugprofilestop()?
• FrameXML_Debug(flag)?
• GetDebugStats()?
• debugstack(start, count1, count2)?

Disabled Functions

These functions are present but have been disabled entirely.

• AppendToFile?
• DeleteFile()?
• ReadFile()?

Dressing Room Functions

Functions Controling the Dressing Room interface. NEW in 1700.

• UI DressUpItem("item")?
• UI DressUpItemLink("itemlink")?
• UI SetDressUpBackground(isAuctionFrame)?