C_PvP
namespaceavailable in: camelotStatus in wowlua
113 functions: 3 implemented, 8 recorded, 102 guessed. 43 events, 8 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
ArePvpTalentsUnlocked | Whether the player has unlocked PvP talents. · by wowlua(): boolean | guessed |
AreTrainingGroundsEnabled | Whether Training Grounds are enabled. · by wowlua(): boolean | guessed |
CanDisplayDeaths | Whether the scoreboard of the current match can show deaths. · by wowlua(): boolean | guessed |
CanDisplayHonorableKills | Whether the scoreboard of the current match can show honorable kills. · by wowlua(): boolean | guessed |
CanPlayerUseRatedPVPUI | Returns true if the player is allowed to use the Rated PvP UI, or false and a reason string if not.(): (boolean, string) | guessed |
CanPlayerUseTrainingGroundsUI | Returns whether the player can use the Training Grounds window and, if not, the reason. · by wowlua(): (boolean, string) | guessed |
CanSurrenderArena | Whether the player can surrender the current arena match. · by wowlua(): boolean | guessed |
CanToggleWarMode | Whether the player can turn War Mode on or off. · by wowlua(toggle: boolean): boolean | guessed |
CanToggleWarModeInArea | Whether War Mode can be changed in the player's current area. · by wowlua(): boolean | guessed |
DoesMatchOutcomeAffectRating | Whether the current match's outcome changes the player's rating. · by wowlua(): boolean | guessed |
GetActiveBrawlInfo | Returns active brawl information.(): PvpBrawlInfo? | guessed |
GetActiveMatchBracket | Returns the bracket of the current PvP match. · by wowlua(): number | guessed |
GetActiveMatchDuration | Returns how long the current PvP match has lasted. · by wowlua(): number | guessed |
GetActiveMatchState | Returns the state of the current PvP match, such as waiting, engaged or complete. · by wowlua(): PvPMatchState | recorded |
GetActiveMatchWinner | Returns the winning team of the current PvP match. · by wowlua(): number | guessed |
GetArenaCrowdControlDuration | Returns a duration object for an arena opponent's crowd control trinket cooldown. · by wowlua(playerToken: string): LuaDurationObject | guessed |
GetArenaCrowdControlInfo | Returns the spell ID, start time and duration of an arena opponent's crowd control trinket cooldown. · by wowlua(playerToken: string): (number?, number?, number?) | recorded |
GetArenaRewards | Returns 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 |
GetArenaSkirmishRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning an arena skirmish. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetAssignedSpecForBattlefieldQueue | Returns the specialization the player is queued as in a battlefield queue, or nil when none is assigned. · by wowlua(queueID: number): number? | guessed |
GetAvailableBrawlInfo | If nil is returned, PVP_BRAWL_INFO_UPDATED event will be sent when the data is ready.(): PvpBrawlInfo? | guessed |
GetBattlefieldFlagPosition | Returns a battleground flag's map position and its texture. · by wowlua(flagIndex: number, uiMapId: number): (number?, number?, number) | guessed |
GetBattlefieldVehicleInfo | Returns battleground vehicle info.(vehicleIndex: number, uiMapID: number): BattlefieldVehicleInfo? | guessed |
GetBattlefieldVehicles | Returns the vehicles to show on the battleground's map. · by wowlua(uiMapID: number): BattlefieldVehicleInfo[]? | implemented |
GetBattlegroundInfo | Returns information about a battleground in the battleground list, or nil when there is none at that index. · by wowlua(battlegroundIndex: number): BattlegroundInfo? | guessed |
GetBrawlRewards | Returns 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 |
GetBrawlSoloRBGMinItemLevel | Returns the minimum item level to queue for the solo rated battleground brawl. · by wowlua(): number | guessed |
GetCustomVictoryStatID | Returns the ID of the score column that decides victory in the current match. · by wowlua(): number | guessed |
GetGlobalPvpScalingInfoForSpecID | Returns the PvP stat scaling of a specialization, or nil when there is none. · by wowlua(specializationID: number): PvpScalingData[]? | guessed |
GetHonorRewardInfo | Returns the reward for reaching an honor level, or nil when there is none. · by wowlua(honorLevel: number): HonorRewardInfo? | guessed |
GetLevelUpBattlegrounds | Returns info indicating the backgrounds available for leveling.(level: number): LevelUpBattlegroundInfo[] | guessed |
GetMatchPVPStatColumn | Returns a score column of the current match, or nil when there is none. · by wowlua(pvpStatID: number): MatchPVPStatColumn? | guessed |
GetMatchPVPStatColumns | Returns the score columns of the current match. · by wowlua(): MatchPVPStatColumn[] | guessed |
GetNextHonorLevelForReward | Returns the next honor level after the given one that grants a reward, or nil when there is none. · by wowlua(honorLevel: number): number? | guessed |
GetOutdoorPvPWaitTime | Returns the time until the next battle in a PvP zone like Wintergrasp and Tol Barad.(uiMapID: number): number | implemented |
GetPVPActiveMatchPersonalRatedInfo | Returns the player's personal rating information for the current rated match, or nil outside one. · by wowlua(): PVPPersonalRatedInfo? | guessed |
GetPVPActiveRatedMatchDeserterPenalty | Returns the penalty for leaving the current rated match, or nil when there is none. · by wowlua(): RatedMatchDeserterPenalty? | guessed |
GetPVPSeasonRewardAchievementID | Returns the achievement ID of the current PvP season's reward, or nil when there is none. · by wowlua(): number? | guessed |
GetPersonalRatedBGBlitzSpecStats | Returns the player's rated Battleground Blitz statistics per specialization, or nil when there are none. · by wowlua(): RatedBGBlitzSpecStats? | guessed |
GetPersonalRatedSoloShuffleSpecStats | Returns the player's rated Solo Shuffle statistics per specialization, or nil when there are none. · by wowlua(): RatedSoloShuffleSpecStats? | guessed |
GetPostMatchCurrencyRewards | Returns the currencies the player earned in the match that just ended. · by wowlua(): PVPPostMatchCurrencyReward[] | guessed |
GetPostMatchItemRewards | Returns the items the player earned in the match that just ended. · by wowlua(): PVPPostMatchItemReward[] | guessed |
GetPvpTalentsUnlockedLevel | Returns the level at which PvP talents unlock. · by wowlua(): number | guessed |
GetPvpTierID | Returns the ID of a PvP rating tier, or nil when there is none. · by wowlua(tierEnum: number, bracketEnum: number): number? | guessed |
GetPvpTierInfo | Returns information about a PvP rating tier, or nil for an unknown tier. · by wowlua(tierID: number): PvpTierInfo? | guessed |
GetRandomBGInfo | Returns information about the random battleground queue. · by wowlua(): RandomBGInfo | guessed |
GetRandomBGRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning a random battleground. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetRandomEpicBGInfo | Returns information about the random epic battleground queue. · by wowlua(): RandomBGInfo | guessed |
GetRandomEpicBGRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning a random epic battleground. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetRandomTrainingGroundArenaRewards | Returns 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 |
GetRandomTrainingGroundBGRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning a random Training Grounds battleground. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetRatedBGRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning a rated battleground. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetRatedSoloRBGMinItemLevel | Returns the minimum item level to queue for rated Battleground Blitz. · by wowlua(): number | guessed |
GetRatedSoloRBGRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning a rated Battleground Blitz match. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetRatedSoloShuffleMinItemLevel | Returns the minimum item level to queue for rated Solo Shuffle. · by wowlua(): number | guessed |
GetRatedSoloShuffleRewards | Returns the honor, experience, items, currencies and role shortage bonus for winning a rated Solo Shuffle match. · by wowlua(): (number, number, BattlefieldItemReward[]?, BattlefieldCurrencyReward[]?, RoleShortageReward?) | guessed |
GetRewardItemLevelsByTierEnum | Returns the item levels of the match rewards and of the weekly reward for a PvP rating tier. · by wowlua(pvpTierEnum: number): (number, number) | guessed |
GetScoreInfo | Returns PvP score info.(offsetIndex: number): PVPScoreInfo? | guessed |
GetScoreInfoByPlayerGuid | Returns PvP score info.(guid: string): PVPScoreInfo? | guessed |
GetSeasonBestInfo | Returns 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 |
GetSkirmishInfo | Returns information about the arena skirmish of the given bracket, or nil when there is none. · by wowlua(pvpBracket: number): BattlemasterListInfo? | guessed |
GetSpecialEventBrawlInfo | Returns information about the current special event brawl, or nil when there is none. · by wowlua(): PvpBrawlInfo? | guessed |
GetTeamInfo | Returns information about a team in the current match, or nil when there is none. · by wowlua(factionIndex: number): PVPTeamInfo? | guessed |
GetTrainingGrounds | Returns the battlegrounds available as Training Grounds. · by wowlua(): BattlegroundInfo[] | guessed |
GetUIDisplaySeason | Returns the PvP season number the interface shows. · by wowlua(): number | guessed |
GetWarModeRewardBonus | Returns the bonus to rewards that War Mode currently grants, in percent. · by wowlua(): number | guessed |
GetWarModeRewardBonusDefault | Returns the default bonus to rewards that War Mode grants, in percent. · by wowlua(): number | guessed |
GetWeeklyChestInfo | Returns 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 |
GetZonePVPInfo | Returns PVP info for the current zone.(): (string?, boolean?, string?) | implemented |
HasArenaSkirmishWinToday | Whether the player has won an arena skirmish today. · by wowlua(): boolean | guessed |
HasMatchStarted | Returns true if a match is either active or complete.(): boolean | guessed |
HasRandomTrainingGroundArenaWinToday | Whether the player has won a random Training Grounds arena match today. · by wowlua(): boolean | guessed |
HasRandomTrainingGroundBGWinToday | Whether the player has won a random Training Grounds battleground today. · by wowlua(): boolean | guessed |
IsActiveBattlefield | Returns whether you are currently in a battleground/battlefield.(): boolean | recorded |
IsActiveMatchRegistered | Whether the current match is a registered (rated) one. · by wowlua(): boolean | guessed |
IsArena | Whether the player is in an arena. · by wowlua(): boolean | guessed |
IsBattleground | Whether the player is in a battleground. · by wowlua(): boolean | guessed |
IsBattlegroundEnlistmentBonusActive | Returns whether the enlistment bonus is active for battlegrounds and for brawls. · by wowlua(): (boolean, boolean) | guessed |
IsBrawlSoloRBG | Whether the current brawl is the solo rated battleground brawl. · by wowlua(): boolean | guessed |
IsBrawlSoloShuffle | Whether the current brawl is the Solo Shuffle brawl. · by wowlua(): boolean | guessed |
IsInBrawl | Whether the player is in a PvP brawl. · by wowlua(): boolean | recorded |
IsInRatedMatchWithDeserterPenalty | Whether the player is in a rated match that gives a penalty for leaving. · by wowlua(): boolean | guessed |
IsMatchActive | Whether a PvP match is in progress. · by wowlua(): boolean | recorded |
IsMatchComplete | Whether the current PvP match has ended. · by wowlua(): boolean | recorded |
IsMatchConsideredArena | Whether the current match counts as an arena match. · by wowlua(): boolean | guessed |
IsMatchFactional | Whether the teams of the current match are split by faction. · by wowlua(): boolean | guessed |
IsPVPMap | Whether the player is on a PvP map, such as a battleground or arena. · by wowlua(): boolean | recorded |
IsRatedArena | Whether the player is in a rated arena match. · by wowlua(): boolean | guessed |
IsRatedBattleground | Whether the player is in a rated battleground. · by wowlua(): boolean | guessed |
IsRatedMap | Returns if the map is a rated battleground or arena.(): boolean | guessed |
IsRatedSoloRBG | Whether the player is in a rated Battleground Blitz match. · by wowlua(): boolean | guessed |
IsRatedSoloShuffle | Whether the player is in a rated Solo Shuffle match. · by wowlua(): boolean | guessed |
IsSoloRBG | Whether the player is in a Battleground Blitz match. · by wowlua(): boolean | guessed |
IsSoloShuffle | Whether the player is in a Solo Shuffle match. · by wowlua(): boolean | guessed |
IsSubZonePVPPOI | Whether the player's subzone is a PvP point of interest. · by wowlua(): boolean | guessed |
IsTrainingGroundsArena | Whether the given LFG dungeon is a Training Grounds arena. · by wowlua(lfgDungeonsID: number): boolean | guessed |
IsTrainingGroundsBG | Whether the given LFG dungeon is a Training Grounds battleground. · by wowlua(lfgDungeonsID: number): boolean | guessed |
IsWarModeActive | Whether War Mode is active for the player. · by wowlua(): boolean | guessed |
IsWarModeDesired | Indicates 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 |
IsWarModeFeatureEnabled | Whether the War Mode feature is enabled. · by wowlua(): boolean | guessed |
JoinBattlefield | Queues for a battleground or arena from the battlemaster list. · by wowlua(battlemasterListId: number) | guessed |
JoinBrawl | Queues for the current PvP brawl. · by wowlua(isSpecialBrawl: boolean) | guessed |
JoinRandomTrainingGroundArena | Queues for a random Training Grounds arena match. · by wowlua() | guessed |
JoinRandomTrainingGroundBG | Queues for a random Training Grounds battleground. · by wowlua() | guessed |
JoinRatedBGBlitz | Queues for rated Battleground Blitz. · by wowlua() | guessed |
JoinTrainingGround | Queues for a specific Training Grounds match. · by wowlua(trainingGroundID: number) | guessed |
RequestCrowdControlSpell | Requests the crowd control trinket spell of an arena opponent. · by wowlua(playerToken: string) | guessed |
SetPVP | Sets the player's PvP flag.(enablePVP: boolean) | guessed |
SetWarModeDesired | Sets whether the player wants War Mode on. · by wowlua(warModeDesired: boolean) | guessed |
StartSoloRBGWarGameByName | Starts a Battleground Blitz war game described by the given arguments. · by wowlua(args: string): number | guessed |
StartSpectatorSoloRBGWarGame | Starts a Battleground Blitz war game watched by spectators. · by wowlua(opaqueID1: number, opaqueID2: number, specifiedMap: string, tournamentRules: boolean): number | guessed |
TogglePVP | Toggles the player's PvP flag on or off.() | guessed |
ToggleWarMode | Turns 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
| event | payload | fired by the emulator |
|---|---|---|
ARENA_OPPONENT_UPDATE | unitToken: string, updateReason: string | implemented |
ARENA_PREP_OPPONENT_SPECIALIZATIONS | no payload | not implemented |
ARENA_SEASON_WORLD_STATE | no payload | implemented |
BATTLEFIELDS_CLOSED | no payload | not implemented |
BATTLEFIELDS_SHOW | isArena: boolean?, battleMasterListID: number? | not implemented |
BATTLEFIELD_AUTO_QUEUE | no payload | not implemented |
BATTLEFIELD_AUTO_QUEUE_EJECT | no payload | not implemented |
BATTLEFIELD_QUEUE_TIMEOUT | no payload | not implemented |
BATTLEGROUND_OBJECTIVES_UPDATE | no payload | not implemented |
BATTLEGROUND_POINTS_UPDATE | no payload | not implemented |
GDF_SIM_COMPLETE | no payload | not implemented |
HONOR_LEVEL_UPDATE | isHigherLevel: boolean | implemented |
NOTIFY_PVP_AFK_RESULT | offender: string, numBlackMarksOnOffender: number, numPlayersIHaveReported: number | not implemented |
PLAYER_ENTERING_BATTLEGROUND | no payload | not implemented |
PLAYER_JOINED_PVP_MATCH | no payload | not implemented |
PLAYER_PVP_FLAG_CHANGED | isPvpFlagged: boolean | not implemented |
POST_MATCH_CURRENCY_REWARD_UPDATE | reward: PVPPostMatchCurrencyReward | not implemented |
POST_MATCH_ITEM_REWARD_UPDATE | no payload | not implemented |
PVPQUEUE_ANYWHERE_SHOW | no payload | not implemented |
PVPQUEUE_ANYWHERE_UPDATE_AVAILABLE | no payload | implemented |
PVP_BRAWL_INFO_UPDATED | no payload | implemented |
PVP_MATCH_ACTIVE | no payload | not implemented |
PVP_MATCH_COMPLETE | winner: number, duration: number | not implemented |
PVP_MATCH_INACTIVE | no payload | not implemented |
PVP_MATCH_STATE_CHANGED | no payload | not implemented |
PVP_RATED_STATS_UPDATE | no payload | implemented |
PVP_REWARDS_UPDATE | no payload | not implemented |
PVP_ROLE_POPUP_HIDE | readyCheckInfo: PvpReadyCheckInfo? | not implemented |
PVP_ROLE_POPUP_SHOW | readyCheckInfo: PvpReadyCheckInfo | not implemented |
PVP_ROLE_UPDATE | no payload | not implemented |
PVP_SPECIAL_EVENT_INFO_UPDATED | no payload | implemented |
PVP_TYPES_ENABLED | wargameBattlegrounds: boolean, ratedBattlegrounds: boolean, ratedArenas: boolean, ratedSoloShuffle: boolean, ratedBGBlitz: boolean | not implemented |
PVP_VEHICLE_INFO_UPDATED | no payload | not implemented |
PVP_WORLDSTATE_UPDATE | no payload | not implemented |
TRAINING_GROUNDS_ENABLED_STATUS_UPDATED | no payload | not implemented |
UPDATE_ACTIVE_BATTLEFIELD | no payload | not implemented |
UPDATE_BATTLEFIELD_SCORE | no payload | not implemented |
UPDATE_BATTLEFIELD_STATUS | battleFieldIndex: number | not implemented |
WARGAME_INVITE_SENT | no payload | not implemented |
WARGAME_REQUESTED | opposingPartyMemberName: string, battlegroundName: string, timeoutSeconds: number, tournamentRules: boolean | not implemented |
WARGAME_REQUEST_RESPONSE | responderGUID: string, responderName: string?, accepted: boolean | not implemented |
WAR_MODE_STATUS_UPDATE | warModeEnabled: boolean | implemented |
WORLD_PVP_QUEUE | no payload | not 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, quantityBattlefieldItemReward· id, name, texture, quantityBattlefieldRewards· honor, experience, itemRewards?, currencyRewards?, roleShortageBonus?BattlefieldVehicleInfo· x, y, name, isOccupied, atlas, textureWidth, textureHeight, facing, isPlayer, isAlive, shouldDrawBelowPlayerBlipsBattlegroundInfo· name, icon?, gameType, shortDescription, longDescription, mapDescription, maxPlayers, battlegroundID?, lfgDungeonID?, mapID?, isHoliday, isRandom, canEnter, isTrainingGroundBattlemasterListInfo· name, matchmakingType, minPlayers, maxPlayers, icon, longDescription, shortDescriptionHonorRewardInfo· honorLevelName, badgeFileDataID, achievementRewardedIDLevelUpBattlegroundInfo· id, icon, name, isEpicMatchPVPStatColumn· pvpStatID, columnHeaderID, orderIndex, name, tooltipTitle, tooltipPvpBrawlInfo· brawlID, name, shortDescription, longDescription, canQueue, minLevel, maxLevel, groupsAllowed, crossFactionAllowed, timeLeftUntilNextChange?, brawlType, mapNames, includesAllArenas, minItemLevel, shouldHideRewardIconPVPPersonalRatedInfo· personalRating, bestSeasonRating, bestWeeklyRating, seasonPlayed, seasonWon, weeklyPlayed, weeklyWon, lastWeeksBestRating, hasWonBracketToday, tier, ranking?, roundsSeasonPlayed, roundsSeasonWon, roundsWeeklyPlayed, roundsWeeklyWonPVPPostMatchCurrencyReward· currencyType, quantityChangedPVPPostMatchItemReward· type, link, quantity, specID, sex, isUpgradedPvpReadyCheckInfo· roles, numPlayersAccepted, numPlayersDeclined, totalNumPlayersPvpRoleQueueInfo· role, totalRole, totalAccepted, totalDeclinedPvpScalingData· scalingDataID, specializationID, name, valuePVPScoreInfo· name, guid, killingBlows, honorableKills, deaths, honorGained, faction, raceName, gender, className, classToken, damageDone, healingDone, rating, ratingChange, prematchMMR, mmrChange, postmatchMMR, talentSpec, honorLevel, roleAssigned, statsPVPStatInfo· pvpStatID, pvpStatValue, orderIndex, name, tooltip, iconNamePVPTeamInfo· name, size, rating, ratingNew, ratingMMRPvpTierInfo· name, descendRating, ascendRating, descendTier, ascendTier, pvpTierEnum, tierIconIDRandomBGInfo· canQueue, bgID, bgIndex, hasRandomWinToday, minLevel, maxLevel, nameRatedBGBlitzSpecStats· weeklyMostPlayedSpecID, weeklyMostPlayedSpecGames, seasonMostPlayedSpecID, seasonMostPlayedSpecGamesRatedMatchDeserterPenalty· personalRatingChange, queuePenaltySpellID, queuePenaltyDurationRatedSoloShuffleSpecStats· weeklyMostPlayedSpecID, weeklyMostPlayedSpecRounds, seasonMostPlayedSpecID, seasonMostPlayedSpecRoundsRoleShortageReward· validRoles, rewardSpellID, rewardItemIDWorldPVPBattlegroundInfo· 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.