v0.13.8

C_PvP

namespaceavailable in: camelot

Status in wowlua

113 functions: 3 implemented, 8 recorded, 102 guessed. 43 events, 8 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
ArePvpTalentsUnlockedWhether the player has unlocked PvP talents. · by wowlua
(): boolean
guessed
AreTrainingGroundsEnabledWhether Training Grounds are enabled. · by wowlua
(): boolean
guessed
CanDisplayDeathsWhether the scoreboard of the current match can show deaths. · by wowlua
(): boolean
guessed
CanDisplayHonorableKillsWhether the scoreboard of the current match can show honorable kills. · by wowlua
(): boolean
guessed
CanPlayerUseRatedPVPUIReturns true if the player is allowed to use the Rated PvP UI, or false and a reason string if not.
(): (boolean, string)
guessed
CanPlayerUseTrainingGroundsUIReturns whether the player can use the Training Grounds window and, if not, the reason. · by wowlua
(): (boolean, string)
guessed
CanSurrenderArenaWhether the player can surrender the current arena match. · by wowlua
(): boolean
guessed
CanToggleWarModeWhether the player can turn War Mode on or off. · by wowlua
(toggle: boolean): boolean
guessed
CanToggleWarModeInAreaWhether War Mode can be changed in the player's current area. · by wowlua
(): boolean
guessed
DoesMatchOutcomeAffectRatingWhether the current match's outcome changes the player's rating. · by wowlua
(): boolean
guessed
GetActiveBrawlInfoReturns active brawl information.
(): PvpBrawlInfo?
guessed
GetActiveMatchBracketReturns the bracket of the current PvP match. · by wowlua
(): number
guessed
GetActiveMatchDurationReturns how long the current PvP match has lasted. · by wowlua
(): number
guessed
GetActiveMatchStateReturns the state of the current PvP match, such as waiting, engaged or complete. · by wowlua
(): PvPMatchState
recorded
GetActiveMatchWinnerReturns the winning team of the current PvP match. · by wowlua
(): number
guessed
GetArenaCrowdControlDurationReturns a duration object for an arena opponent's crowd control trinket cooldown. · by wowlua
(playerToken: string): LuaDurationObject
guessed
GetArenaCrowdControlInfoReturns the spell ID, start time and duration of an arena opponent's crowd control trinket cooldown. · by wowlua
(playerToken: string): (number?, number?, number?)
recorded
GetArenaRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning an arena match of the given size. · by wowlua
(teamSize: number): (number?, number?, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetArenaSkirmishRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning an arena skirmish. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetAssignedSpecForBattlefieldQueueReturns the specialization the player is queued as in a battlefield queue, or nil when none is assigned. · by wowlua
(queueID: number): number?
guessed
GetAvailableBrawlInfoIf nil is returned, PVP_BRAWL_INFO_UPDATED event will be sent when the data is ready.
(): PvpBrawlInfo?
guessed
GetBattlefieldFlagPositionReturns a battleground flag's map position and its texture. · by wowlua
(flagIndex: number, uiMapId: number): (number?, number?, number)
guessed
GetBattlefieldVehicleInfoReturns battleground vehicle info.
(vehicleIndex: number, uiMapID: number): BattlefieldVehicleInfo?
guessed
GetBattlefieldVehiclesReturns the vehicles to show on the battleground's map. · by wowlua
(uiMapID: number): BattlefieldVehicleInfo[]?
implemented
GetBattlegroundInfoReturns information about a battleground in the battleground list, or nil when there is none at that index. · by wowlua
(battlegroundIndex: number): BattlegroundInfo?
guessed
GetBrawlRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning the given kind of brawl. · by wowlua
(brawlType: BrawlType): (number?, number?, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?, boolean?)
guessed
GetBrawlSoloRBGMinItemLevelReturns the minimum item level to queue for the solo rated battleground brawl. · by wowlua
(): number
guessed
GetCustomVictoryStatIDReturns the ID of the score column that decides victory in the current match. · by wowlua
(): number
guessed
GetGlobalPvpScalingInfoForSpecIDReturns the PvP stat scaling of a specialization, or nil when there is none. · by wowlua
(specializationID: number): PvpScalingData[]?
guessed
GetHonorRewardInfoReturns the reward for reaching an honor level, or nil when there is none. · by wowlua
(honorLevel: number): HonorRewardInfo?
guessed
GetLevelUpBattlegroundsReturns info indicating the backgrounds available for leveling.
(level: number): LevelUpBattlegroundInfo[]
guessed
GetMatchPVPStatColumnReturns a score column of the current match, or nil when there is none. · by wowlua
(pvpStatID: number): MatchPVPStatColumn?
guessed
GetMatchPVPStatColumnsReturns the score columns of the current match. · by wowlua
(): MatchPVPStatColumn[]
guessed
GetNextHonorLevelForRewardReturns the next honor level after the given one that grants a reward, or nil when there is none. · by wowlua
(honorLevel: number): number?
guessed
GetOutdoorPvPWaitTimeReturns the time until the next battle in a PvP zone like Wintergrasp and Tol Barad.
(uiMapID: number): number
implemented
GetPVPActiveMatchPersonalRatedInfoReturns the player's personal rating information for the current rated match, or nil outside one. · by wowlua
(): PVPPersonalRatedInfo?
guessed
GetPVPActiveRatedMatchDeserterPenaltyReturns the penalty for leaving the current rated match, or nil when there is none. · by wowlua
(): RatedMatchDeserterPenalty?
guessed
GetPVPSeasonRewardAchievementIDReturns the achievement ID of the current PvP season's reward, or nil when there is none. · by wowlua
(): number?
guessed
GetPersonalRatedBGBlitzSpecStatsReturns the player's rated Battleground Blitz statistics per specialization, or nil when there are none. · by wowlua
(): RatedBGBlitzSpecStats?
guessed
GetPersonalRatedSoloShuffleSpecStatsReturns the player's rated Solo Shuffle statistics per specialization, or nil when there are none. · by wowlua
(): RatedSoloShuffleSpecStats?
guessed
GetPostMatchCurrencyRewardsReturns the currencies the player earned in the match that just ended. · by wowlua
(): PVPPostMatchCurrencyReward[]
guessed
GetPostMatchItemRewardsReturns the items the player earned in the match that just ended. · by wowlua
(): PVPPostMatchItemReward[]
guessed
GetPvpTalentsUnlockedLevelReturns the level at which PvP talents unlock. · by wowlua
(): number
guessed
GetPvpTierIDReturns the ID of a PvP rating tier, or nil when there is none. · by wowlua
(tierEnum: number, bracketEnum: number): number?
guessed
GetPvpTierInfoReturns information about a PvP rating tier, or nil for an unknown tier. · by wowlua
(tierID: number): PvpTierInfo?
guessed
GetRandomBGInfoReturns information about the random battleground queue. · by wowlua
(): RandomBGInfo
guessed
GetRandomBGRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a random battleground. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRandomEpicBGInfoReturns information about the random epic battleground queue. · by wowlua
(): RandomBGInfo
guessed
GetRandomEpicBGRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a random epic battleground. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRandomTrainingGroundArenaRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a random Training Grounds arena match. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRandomTrainingGroundBGRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a random Training Grounds battleground. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRatedBGRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a rated battleground. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRatedSoloRBGMinItemLevelReturns the minimum item level to queue for rated Battleground Blitz. · by wowlua
(): number
guessed
GetRatedSoloRBGRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a rated Battleground Blitz match. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRatedSoloShuffleMinItemLevelReturns the minimum item level to queue for rated Solo Shuffle. · by wowlua
(): number
guessed
GetRatedSoloShuffleRewardsReturns the honor, experience, items, currencies and role shortage bonus for winning a rated Solo Shuffle match. · by wowlua
(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?)
guessed
GetRewardItemLevelsByTierEnumReturns the item levels of the match rewards and of the weekly reward for a PvP rating tier. · by wowlua
(pvpTierEnum: number): (number, number)
guessed
GetScoreInfoReturns PvP score info.
(offsetIndex: number): PVPScoreInfo?
guessed
GetScoreInfoByPlayerGuidReturns PvP score info.
(guid: string): PVPScoreInfo?
guessed
GetSeasonBestInfoReturns the tier ID of the player's best rating this PvP season and of the next tier, or nil when there is no next tier. · by wowlua
(): (number, number?)
guessed
GetSkirmishInfoReturns information about the arena skirmish of the given bracket, or nil when there is none. · by wowlua
(pvpBracket: number): BattlemasterListInfo?
guessed
GetSpecialEventBrawlInfoReturns information about the current special event brawl, or nil when there is none. · by wowlua
(): PvpBrawlInfo?
guessed
GetTeamInfoReturns information about a team in the current match, or nil when there is none. · by wowlua
(factionIndex: number): PVPTeamInfo?
guessed
GetTrainingGroundsReturns the battlegrounds available as Training Grounds. · by wowlua
(): BattlegroundInfo[]
guessed
GetUIDisplaySeasonReturns the PvP season number the interface shows. · by wowlua
(): number
guessed
GetWarModeRewardBonusReturns the bonus to rewards that War Mode currently grants, in percent. · by wowlua
(): number
guessed
GetWarModeRewardBonusDefaultReturns the default bonus to rewards that War Mode grants, in percent. · by wowlua
(): number
guessed
GetWeeklyChestInfoReturns the state of the weekly PvP reward: whether this week's and last week's rewards were earned, whether last week's was claimed, and the highest tier reached through wins. · by wowlua
(): (boolean, boolean, boolean, number)
guessed
GetZonePVPInfoReturns PVP info for the current zone.
(): (string?, boolean?, string?)
implemented
HasArenaSkirmishWinTodayWhether the player has won an arena skirmish today. · by wowlua
(): boolean
guessed
HasMatchStartedReturns true if a match is either active or complete.
(): boolean
guessed
HasRandomTrainingGroundArenaWinTodayWhether the player has won a random Training Grounds arena match today. · by wowlua
(): boolean
guessed
HasRandomTrainingGroundBGWinTodayWhether the player has won a random Training Grounds battleground today. · by wowlua
(): boolean
guessed
IsActiveBattlefieldReturns whether you are currently in a battleground/battlefield.
(): boolean
recorded
IsActiveMatchRegisteredWhether the current match is a registered (rated) one. · by wowlua
(): boolean
guessed
IsArenaWhether the player is in an arena. · by wowlua
(): boolean
guessed
IsBattlegroundWhether the player is in a battleground. · by wowlua
(): boolean
guessed
IsBattlegroundEnlistmentBonusActiveReturns whether the enlistment bonus is active for battlegrounds and for brawls. · by wowlua
(): (boolean, boolean)
guessed
IsBrawlSoloRBGWhether the current brawl is the solo rated battleground brawl. · by wowlua
(): boolean
guessed
IsBrawlSoloShuffleWhether the current brawl is the Solo Shuffle brawl. · by wowlua
(): boolean
guessed
IsInBrawlWhether the player is in a PvP brawl. · by wowlua
(): boolean
recorded
IsInRatedMatchWithDeserterPenaltyWhether the player is in a rated match that gives a penalty for leaving. · by wowlua
(): boolean
guessed
IsMatchActiveWhether a PvP match is in progress. · by wowlua
(): boolean
recorded
IsMatchCompleteWhether the current PvP match has ended. · by wowlua
(): boolean
recorded
IsMatchConsideredArenaWhether the current match counts as an arena match. · by wowlua
(): boolean
guessed
IsMatchFactionalWhether the teams of the current match are split by faction. · by wowlua
(): boolean
guessed
IsPVPMapWhether the player is on a PvP map, such as a battleground or arena. · by wowlua
(): boolean
recorded
IsRatedArenaWhether the player is in a rated arena match. · by wowlua
(): boolean
guessed
IsRatedBattlegroundWhether the player is in a rated battleground. · by wowlua
(): boolean
guessed
IsRatedMapReturns if the map is a rated battleground or arena.
(): boolean
guessed
IsRatedSoloRBGWhether the player is in a rated Battleground Blitz match. · by wowlua
(): boolean
guessed
IsRatedSoloShuffleWhether the player is in a rated Solo Shuffle match. · by wowlua
(): boolean
guessed
IsSoloRBGWhether the player is in a Battleground Blitz match. · by wowlua
(): boolean
guessed
IsSoloShuffleWhether the player is in a Solo Shuffle match. · by wowlua
(): boolean
guessed
IsSubZonePVPPOIWhether the player's subzone is a PvP point of interest. · by wowlua
(): boolean
guessed
IsTrainingGroundsArenaWhether the given LFG dungeon is a Training Grounds arena. · by wowlua
(lfgDungeonsID: number): boolean
guessed
IsTrainingGroundsBGWhether the given LFG dungeon is a Training Grounds battleground. · by wowlua
(lfgDungeonsID: number): boolean
guessed
IsWarModeActiveWhether War Mode is active for the player. · by wowlua
(): boolean
guessed
IsWarModeDesiredIndicates whether the player has opted into War Mode beginning with *Battle for Azeroth*, regardless if the player is in an outdoor zone where such PvP is actually possible.
(): boolean
recorded
IsWarModeFeatureEnabledWhether the War Mode feature is enabled. · by wowlua
(): boolean
guessed
JoinBattlefieldQueues for a battleground or arena from the battlemaster list. · by wowlua
(battlemasterListId: number)
guessed
JoinBrawlQueues for the current PvP brawl. · by wowlua
(isSpecialBrawl: boolean)
guessed
JoinRandomTrainingGroundArenaQueues for a random Training Grounds arena match. · by wowlua
()
guessed
JoinRandomTrainingGroundBGQueues for a random Training Grounds battleground. · by wowlua
()
guessed
JoinRatedBGBlitzQueues for rated Battleground Blitz. · by wowlua
()
guessed
JoinTrainingGroundQueues for a specific Training Grounds match. · by wowlua
(trainingGroundID: number)
guessed
RequestCrowdControlSpellRequests the crowd control trinket spell of an arena opponent. · by wowlua
(playerToken: string)
guessed
SetPVPSets the player's PvP flag.
(enablePVP: boolean)
guessed
SetWarModeDesiredSets whether the player wants War Mode on. · by wowlua
(warModeDesired: boolean)
guessed
StartSoloRBGWarGameByNameStarts a Battleground Blitz war game described by the given arguments. · by wowlua
(args: string): number
guessed
StartSpectatorSoloRBGWarGameStarts a Battleground Blitz war game watched by spectators. · by wowlua
(opaqueID1: number, opaqueID2: number, specifiedMap: string, tournamentRules: boolean): number
guessed
TogglePVPToggles the player's PvP flag on or off.
()
guessed
ToggleWarModeTurns War Mode on or off. · by wowlua
()
guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

eventpayloadfired by the emulator
ARENA_OPPONENT_UPDATEunitToken: string, updateReason: stringimplemented
ARENA_PREP_OPPONENT_SPECIALIZATIONSno payloadnot implemented
ARENA_SEASON_WORLD_STATEno payloadimplemented
BATTLEFIELDS_CLOSEDno payloadnot implemented
BATTLEFIELDS_SHOWisArena: boolean?, battleMasterListID: number?not implemented
BATTLEFIELD_AUTO_QUEUEno payloadnot implemented
BATTLEFIELD_AUTO_QUEUE_EJECTno payloadnot implemented
BATTLEFIELD_QUEUE_TIMEOUTno payloadnot implemented
BATTLEGROUND_OBJECTIVES_UPDATEno payloadnot implemented
BATTLEGROUND_POINTS_UPDATEno payloadnot implemented
GDF_SIM_COMPLETEno payloadnot implemented
HONOR_LEVEL_UPDATEisHigherLevel: booleanimplemented
NOTIFY_PVP_AFK_RESULToffender: string, numBlackMarksOnOffender: number, numPlayersIHaveReported: numbernot implemented
PLAYER_ENTERING_BATTLEGROUNDno payloadnot implemented
PLAYER_JOINED_PVP_MATCHno payloadnot implemented
PLAYER_PVP_FLAG_CHANGEDisPvpFlagged: booleannot implemented
POST_MATCH_CURRENCY_REWARD_UPDATEreward: PVPPostMatchCurrencyRewardnot implemented
POST_MATCH_ITEM_REWARD_UPDATEno payloadnot implemented
PVPQUEUE_ANYWHERE_SHOWno payloadnot implemented
PVPQUEUE_ANYWHERE_UPDATE_AVAILABLEno payloadimplemented
PVP_BRAWL_INFO_UPDATEDno payloadimplemented
PVP_MATCH_ACTIVEno payloadnot implemented
PVP_MATCH_COMPLETEwinner: number, duration: numbernot implemented
PVP_MATCH_INACTIVEno payloadnot implemented
PVP_MATCH_STATE_CHANGEDno payloadnot implemented
PVP_RATED_STATS_UPDATEno payloadimplemented
PVP_REWARDS_UPDATEno payloadnot implemented
PVP_ROLE_POPUP_HIDEreadyCheckInfo: PvpReadyCheckInfo?not implemented
PVP_ROLE_POPUP_SHOWreadyCheckInfo: PvpReadyCheckInfonot implemented
PVP_ROLE_UPDATEno payloadnot implemented
PVP_SPECIAL_EVENT_INFO_UPDATEDno payloadimplemented
PVP_TYPES_ENABLEDwargameBattlegrounds: boolean, ratedBattlegrounds: boolean, ratedArenas: boolean, ratedSoloShuffle: boolean, ratedBGBlitz: booleannot implemented
PVP_VEHICLE_INFO_UPDATEDno payloadnot implemented
PVP_WORLDSTATE_UPDATEno payloadnot implemented
TRAINING_GROUNDS_ENABLED_STATUS_UPDATEDno payloadnot implemented
UPDATE_ACTIVE_BATTLEFIELDno payloadnot implemented
UPDATE_BATTLEFIELD_SCOREno payloadnot implemented
UPDATE_BATTLEFIELD_STATUSbattleFieldIndex: numbernot implemented
WARGAME_INVITE_SENTno payloadnot implemented
WARGAME_REQUESTEDopposingPartyMemberName: string, battlegroundName: string, timeoutSeconds: number, tournamentRules: booleannot implemented
WARGAME_REQUEST_RESPONSEresponderGUID: string, responderName: string?, accepted: booleannot implemented
WAR_MODE_STATUS_UPDATEwarModeEnabled: booleanimplemented
WORLD_PVP_QUEUEno payloadnot implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ARENA_PREP_OPPONENT_SPECIALIZATIONS").

Structures

  • BattlefieldCurrencyReward · id, quantity
  • BattlefieldItemReward · id, name, texture, quantity
  • BattlefieldRewards · honor, experience, itemRewards?, currencyRewards?, roleShortageBonus?
  • BattlefieldVehicleInfo · x, y, name, isOccupied, atlas, textureWidth, textureHeight, facing, isPlayer, isAlive, shouldDrawBelowPlayerBlips
  • BattlegroundInfo · name, icon?, gameType, shortDescription, longDescription, mapDescription, maxPlayers, battlegroundID?, lfgDungeonID?, mapID?, isHoliday, isRandom, canEnter, isTrainingGround
  • BattlemasterListInfo · name, matchmakingType, minPlayers, maxPlayers, icon, longDescription, shortDescription
  • HonorRewardInfo · honorLevelName, badgeFileDataID, achievementRewardedID
  • LevelUpBattlegroundInfo · id, icon, name, isEpic
  • MatchPVPStatColumn · pvpStatID, columnHeaderID, orderIndex, name, tooltipTitle, tooltip
  • PvpBrawlInfo · brawlID, name, shortDescription, longDescription, canQueue, minLevel, maxLevel, groupsAllowed, crossFactionAllowed, timeLeftUntilNextChange?, brawlType, mapNames, includesAllArenas, minItemLevel, shouldHideRewardIcon
  • PVPPersonalRatedInfo · personalRating, bestSeasonRating, bestWeeklyRating, seasonPlayed, seasonWon, weeklyPlayed, weeklyWon, lastWeeksBestRating, hasWonBracketToday, tier, ranking?, roundsSeasonPlayed, roundsSeasonWon, roundsWeeklyPlayed, roundsWeeklyWon
  • PVPPostMatchCurrencyReward · currencyType, quantityChanged
  • PVPPostMatchItemReward · type, link, quantity, specID, sex, isUpgraded
  • PvpReadyCheckInfo · roles, numPlayersAccepted, numPlayersDeclined, totalNumPlayers
  • PvpRoleQueueInfo · role, totalRole, totalAccepted, totalDeclined
  • PvpScalingData · scalingDataID, specializationID, name, value
  • PVPScoreInfo · name, guid, killingBlows, honorableKills, deaths, honorGained, faction, raceName, gender, className, classToken, damageDone, healingDone, rating, ratingChange, prematchMMR, mmrChange, postmatchMMR, talentSpec, honorLevel, roleAssigned, stats
  • PVPStatInfo · pvpStatID, pvpStatValue, orderIndex, name, tooltip, iconName
  • PVPTeamInfo · name, size, rating, ratingNew, ratingMMR
  • PvpTierInfo · name, descendRating, ascendRating, descendTier, ascendTier, pvpTierEnum, tierIconID
  • RandomBGInfo · canQueue, bgID, bgIndex, hasRandomWinToday, minLevel, maxLevel, name
  • RatedBGBlitzSpecStats · weeklyMostPlayedSpecID, weeklyMostPlayedSpecGames, seasonMostPlayedSpecID, seasonMostPlayedSpecGames
  • RatedMatchDeserterPenalty · personalRatingChange, queuePenaltySpellID, queuePenaltyDuration
  • RatedSoloShuffleSpecStats · weeklyMostPlayedSpecID, weeklyMostPlayedSpecRounds, seasonMostPlayedSpecID, seasonMostPlayedSpecRounds
  • RoleShortageReward · validRoles, rewardSpellID, rewardItemID
  • WorldPVPBattlegroundInfo · bgID, name, isActive, canQueue, canEnter, startTime, minLevel, maxLevel

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (PvpInfo system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.