部分API
魔兽世界全局函数
魔兽世界 API 列表,随着游戏版本的变化而随时更新.不会100%完整,我们会第一时间补充新的API.
这是一张完整的全局函数列表.假如有任何的遗漏,是因为仍没有人添加这个条目,欢迎您参与添加或修改其中的条目。在您添加函数以前,请先阅读如何编辑 API 页面。
帐号游戏时间范围函数 (Account PlayTime Limit Functions)
此类API函数是专门为防沉迷系统而设计的,能计算出当前玩家游戏时间等内容,当前只在亚洲地区有效。
-
GetBillingTimeRested() - 返回当前帐户已登陆时间。
PartialPlayTime() - 如果用户状态为“疲劳(tired)”则返回1:降低经验及掉落。
NoPlayTime() - 如果用户状态为“不健康的(unhealthy)”则返回1:无经验及掉落。
动作函数 (Action Functions)
这些函数对动作按钮进行操作(通常玩家的动作有可能通过下面列表中的函数执行)。
-
保护 界面 ActionButtonDown(id) - 按下指定动作按钮。
保护 界面 ActionButtonUp(id) - 释放指定动作按钮。
ActionHasRange(slot) - 检测指定动作按钮是否受距离限制 (是则返回 1,否则返回 nil) 。
界面 BonusActionButtonDown - 触发指定额外动作按钮 (宠物或仆从)。
界面 BonusActionButtonUp - 释放指定额外动作按钮 (宠物或仆从)。
保护 CameraOrSelectOrMoveStart() - 在 3D 界面开始 "左键单击" 动作。 (1.10 - 保护)
保护 CameraOrSelectOrMoveStop([stickyFlag]) - 在 3D 界面结束 "左键单击" 动作。 (1.10 - 保护)
ChangeActionBarPage() - 更改系统动作按钮页面为系统变量 CURRENT_ACTIONBAR_PAGE 指定页。
GetActionBarToggles() - 获取系统动作条显示状况。
GetActionCooldown(slot) - 获取指定动作按钮冷却状况。
GetActionCount(slot) - 获取动作按钮所需物品剩余量 (绷带/毒药/等),无物品或不可用时返回 0。
GetActionText(slot) - 获取动作按钮文本标签 (宏, 等),不存在则返回 nil。
GetActionTexture(slot) - 获取指定动作按钮材质路径。
GetBonusBarOffset() - 检测何种额外动作条已显示。
HasAction(slot) - 假如指定动作条按钮有技能执行,则返回 1,其他情况返回 nil。
IsActionInRange(slot) - 测试技能是否在施展距离内 (1=是, 0=否, nil=不可用)。
IsAttackAction(slot) - 技能为“攻击”动作则返回 1 (战斗中闪光), 其他情况返回 nil。
IsAutoRepeatAction(slot) - 技能可自动重复时返回 1,其他情况返回 nil。
IsCurrentAction(slot) - 技能动作正在执行时返回 1,其他情况返回 nil。
IsUsableAction(slot) - 技能可立即执行时返回 1,其他情况返回 nil。
IsConsumableAction(slot) - 技能有施展次数时返回 1 (例如:施法物品),其他情况返回 nil。
IsEquippedAction(slot) - 必须装备才能施展的技能返回 1 (例如:链接到必须装备的物品),其他情况返回 nil。
PetHasActionBar() - 检测玩家宠物是否有动作条。
PickupAction(slot) - 将指定动作按钮的技能提取并放置于光标上。
PickupPetAction(slot) - 将指定的宠物动作按钮的技能提取并放置于光标上。
PlaceAction(slot) - 将鼠标上的技能放置于指定动作按钮。
SetActionBarToggles(show1,show2,show3,show4[, alwaysShow]) - 设置指定系统动作条显示。 - 1.12 版本添加 'alwaysShow'。
保护 TurnOrActionStart() - 在 3D 界面开始 "右键单击" 动作。(1.10 - 保护)
保护 TurnOrActionStop() - 在 3D 界面结束 "右键单击" 动作。 (1.10 - 保护)
保护 UseAction(slot[, checkCursor[, onSelf]]) - 执行绑定到指定 ID 的动作按钮技能,可定向玩家 (与目标无关)。
行为函数 (Activity Functions)
这个部分的函数会引发玩家角色的动作(未在别处加以保护, 非简单确认步骤)
-
AcceptDuel() - 玩家同意接受决斗挑战.
保护 AttackTarget() - 攻击选定目标.
CancelDuel() - 拒绝决斗挑战.
CancelLogout()
CancelMeetingStoneRequest() - 将角色从集合石队列中移除
ClearTutorials()
ConfirmSummon()
保护 DescendStop() --增加于2.1
Dismount() --增加于2.0.3
FlagTutorial("tutotial")
保护 ForceLogout()
ForceQuit()
GetSummonConfirmAreaName()
GetSummonConfirmSummoner()
GetSummonConfirmTimeLeft()
Logout - 注销当前玩家角色.
Quit - 退出应用程序(游戏), 而非 LUA 脚本.
RandomRoll(low, high) - 随机产生在两个(正整数)数值闭区间的整数.
保护 SitStandOrDescendStart() - 切换玩家坐下/站立姿势.
保护 StartDuel("name") - 向玩家发出决斗邀请(根据名字)
TogglePVP() - 切换 PVP 状态
ToggleSheath() - 拔出/收起武器.
UseSoulstone() - 使用激活的灵魂石复活自己.
插件函数 (AddOn Functions)
-
DisableAddOn(index or "AddOnName") - 禁止某插件下次载入.
DisableAllAddOns() - 禁止所有插件下次被载入..
EnableAddOn(index or "AddOnName") - 在下次进程开启指定插件.
EnableAllAddOns() - 在下次进程开启全部插件.
GetAddOnDependencies(index or "AddOnName") - 取得插件依赖列表.
GetAddOnInfo(index or "AddOnName") - 取得插件相关信息.
GetAddOnMetadata(index or "name", "variable") - 从插件的TOC文件中获取标签内容(值)。
GetNumAddOns() - 取得用户插件数量.
IsAddOnLoaded(index or "AddOnName") - 指定插件已读取则返回 true.
IsAddOnLoadOnDemand(index or "AddOnName") - 测试插件是否可动态载入.
LoadAddOn(index or "AddOnName") - 发出动态载入插件读取请求.
ResetDisabledAddOns() -
竞技场函数(Arena Functions)
-
ArenaTeamInviteByName(teamIndex, playerName) - Invites the specified player to the specified arena team.
ArenaTeamLeave(teamIndex) - Leaves the specified arena team.
ArenaTeamRoster(teamIndex) - Sends a request to the server to request the most recent information on a specific Arena Team that you are in.
ArenaTeamUninviteByName(teamIndex, playerName) - Removes the specified played from the specified arena team.
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).
GetArenaCurrency() - Gets the amount of arena points a player currently has to spend.
GetArenaTeam(teamIndex) - Returns information regarding the players arena team, nil if the player is not in the passed team
GetArenaTeamRosterInfo(teamIndex, playerIndex) - Returns information regarding a player from the specified team, this requires a call to ArenaTeamRoster you only need to do this when the player logins in, UI reloads will not effect the return.
GetNumArenaTeamMembers(teamIndex[, showOffline]) - Gets the number of arena team members, this requires a call to ArenaTeamRoster you only need to do this when the player logins in, UI reloads will not effect the return.
GetBattlefieldTeamInfo(index) - Gets info about a registered Arena Team at the end of an arena match.
GetCurrentArenaSeason() - Gets the current Arena season.
IsActiveBattlefieldArena() - Returns true if in an Arena Match, also Returns true for the second argument if it's a registered match.
IsArenaTeamCaptain(teamIndex) - Returns a value based on whether the player is the arena team captain.
IsBattlefieldArena() - Returns true if the battlemaster you're talking to can queue you for arenas
拍卖函数 (Auction Functions)
-
CalculateAuctionDeposit(runTime) - 返回当前指定持续时间拍卖物品的堆放信息 (单位:分钟).
CanSendAuctionQuery() - 拍卖行搜索按钮可用时返回 1, 否则为 nil.
CancelAuction(index) - 取消指定拍卖 (在物主列表).
ClickAuctionSellItemButton() - 将当前 '拣起' 的物品放到 '拍卖' 栏.
CloseAuctionHouse() - 关闭 (打开的) 拍卖窗口.
GetAuctionHouseDepositRate() - 返回当前开启的拍卖窗口内物品 [含未显示] 存放比例 (百分率) (可能根据 CalculateAuctionDeposit).
GetAuctionInvTypes(classIndex, subclassIndex) - 返回物品的子类.
GetAuctionItemClasses() - 返回拍卖物品的主分类.
GetAuctionItemInfo("type", index) - 返回指定拍卖物品细节.
GetAuctionItemLink("type", index) - 返回指定拍卖物品的 itemLink.
GetAuctionItemSubClasses(classIndex) - 返回拍卖物品种类次序的子类.
GetAuctionItemTimeLeft("type", index) - 返回指定拍卖物品剩余时间状态.
GetAuctionSellItemInfo() - 返回当前拍卖物品相关信息 (未选择为 nil).
GetBidderAuctionItems([page]) - (取得竞标人信息).
GetNumAuctionItems("type") - 返回指定拍卖物品列表大小.
GetOwnerAuctionItems([page]) - (取得拍卖人信息).
GetSelectedAuctionItem("type") - 返回选择的拍卖物品索引 (1-50), 未选择返回 0.
IsAuctionSortReversed("type", "sort") - 指定拍卖物品的排列类型逆序排列时返回 1, 否则为 nil.
PlaceAuctionBid("type", index, bid) - 对选择拍卖物品投标.
QueryAuctionItems("name", minLevel, maxLevel, invTypeIndex, classIndex, subclassIndex, page, isUsable, qualityIndex) - (请求检索符合条件的物品).
SetSelectedAuctionItem("type", index) - ?.
SortAuctionItems("type", "sort") - 根据指定分栏对指定拍卖列表进行排序.
StartAuction(minBid, buyoutPrice, runTime) - 开始拍卖 '创建拍卖' 面板内物品.
界面 AuctionFrameAuctions.duration - 设置拍卖持续总计时间.