C_Commentator
namespaceavailable in: camelotStatus in wowlua
144 functions: 63 implemented, 1 recorded, 80 guessed. 10 events, 1 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
AddPlayerOverrideName | Sets a name the commentator UI shows in place of a player's name. · by wowlua(playerName: string, overrideName: string) | guessed |
AddTrackedDefensiveAuras | Adds spells to the defensive auras the commentator UI tracks. · by wowlua(spellIDs: number[]) | implemented |
AddTrackedOffensiveAuras | Adds spells to the offensive auras the commentator UI tracks. · by wowlua(spellIDs: number[]) | implemented |
AreTeamsSwapped | Whether the commentator view shows the two teams on swapped sides. · by wowlua(): boolean | guessed |
AssignPlayerToTeam | Assigns a player to a named team in the commentator's team directory. · by wowlua(playerName: string, teamName: string) | guessed |
AssignPlayersToTeam | Assigns several players to a named team in the commentator's team directory. · by wowlua(playerName: string[], teamName: string) | guessed |
AssignPlayersToTeamInCurrentInstance | Assigns the players of a team in the current match to a named team. · by wowlua(teamIndex: number, teamName: string) | guessed |
CanUseCommentatorCheats | Whether commentator cheats are available. · by wowlua(): boolean | guessed |
ClearCameraTarget | Clears the commentator camera's target. · by wowlua() | implemented |
ClearFollowTarget | Stops the commentator camera from following a player. · by wowlua() | implemented |
ClearLookAtTarget | Clears a target the commentator camera looks at. · by wowlua(lookAtIndex: number?) | implemented |
EnterInstance | Enters the match selected with SetMapAndInstanceIndex as a commentator. · by wowlua() | implemented |
ExitInstance | Leaves the match the commentator is spectating. · by wowlua() | implemented |
FindSpectatedUnit | Looks up a unit among the spectated players and returns its indices. · by wowlua(unitToken: string): (number?, number?, boolean?) | implemented |
FindTeamNameInCurrentInstance | Returns the team name assigned to a team of the current match. · by wowlua(teamIndex: number): string? | guessed |
FindTeamNameInDirectory | Returns the name of the team the given players are assigned to. · by wowlua(playerNames: string[]): string? | guessed |
FlushCommentatorHistory | Clears the saved commentator history. · by wowlua() | guessed |
FollowPlayer | Makes the commentator camera follow a player. · by wowlua(factionIndex: number, playerIndex: number, forceInstantTransition: boolean?) | implemented |
FollowUnit | Makes the commentator camera follow a unit. · by wowlua(token: string) | implemented |
ForceFollowTransition | Forces the commentator camera's transition to its follow target. · by wowlua() | implemented |
GetAdditionalCameraWeight | Returns the additional camera weight set with SetAdditionalCameraWeight. · by wowlua(): (number, number) | implemented |
GetAdditionalCameraWeightByToken | Returns the additional weight the smart camera gives a unit. · by wowlua(unitToken: string): number? | implemented |
GetAllPlayerOverrideNames | Returns every player name override of the commentator UI. · by wowlua(): NameOverrideEntry[] | implemented |
GetCamera | Returns the commentator camera's position, yaw, pitch, roll and field of view. · by wowlua(): (number?, number?, number?, number?, number?, number?, number?) | implemented |
GetCameraCollision | Whether the commentator camera collides with the world. · by wowlua(): boolean | guessed |
GetCameraPosition | Returns the commentator camera's position. · by wowlua(): (number?, number?, number?) | implemented |
GetCombatEventInfo | Returns information about the combat event being handled in commentator mode. · by wowlua() | implemented |
GetCommentatorHistory | Returns the commentator history, to restore later with SetCommentatorHistory. · by wowlua(): CommentatorHistory | guessed |
GetCommentatorMatchDataState | Returns the state of the commentator's match data. · by wowlua(): CommentatorMatchDataState | implemented |
GetCurrentMapID | Returns the map ID of the match being spectated. · by wowlua(): number? | implemented |
GetDampeningPercent | Returns the current dampening percentage of the spectated arena match. · by wowlua(): number | guessed |
GetDistanceBeforeForcedHorizontalConvergence | Returns the distance at which the smart camera is forced to converge horizontally on its target. · by wowlua(): number | guessed |
GetDurationToForceHorizontalConvergence | Returns how long, in milliseconds, before the smart camera is forced to converge horizontally on its target. · by wowlua(): number | guessed |
GetExcludeDistance | Returns the smart camera's exclude distance. · by wowlua(): number | guessed |
GetHardlockWeight | Returns the smart camera's hard-lock weight. · by wowlua(): number | guessed |
GetHorizontalAngleThresholdToSmooth | Returns the horizontal angle above which the smart camera smooths its turns. · by wowlua(): number | guessed |
GetIndirectSpellID | Returns the indirect spell that counts as the given tracked spell. · by wowlua(trackedSpellID: number): number | implemented |
GetInstanceInfo | Returns information about an instance of a map in the commentator's match list. · by wowlua(mapIndex: number, instanceIndex: number): (number?, string?, number?, number?, number?) | implemented |
GetLookAtLerpAmount | Returns how quickly the commentator camera turns toward its look-at target. · by wowlua(): number | guessed |
GetMapInfo | Returns information about a map in the commentator's match list. · by wowlua(mapIndex: number): (number?, number?, number?, number?) | implemented |
GetMatchDuration | Returns how long the spectated match has been running. · by wowlua(): number | guessed |
GetMaxNumPlayersPerTeam | Returns the maximum number of players on a team. · by wowlua(): number | guessed |
GetMaxNumTeams | Returns the maximum number of teams in a match. · by wowlua(): number | guessed |
GetMode | Returns the commentator's current mode. · by wowlua(): number | guessed |
GetMsToHoldForHorizontalMovement | Returns how long, in milliseconds, the smart camera waits before moving horizontally. · by wowlua(): number | guessed |
GetMsToHoldForVerticalMovement | Returns how long, in milliseconds, the smart camera waits before moving vertically. · by wowlua(): number | guessed |
GetMsToSmoothHorizontalChange | Returns how long, in milliseconds, the smart camera takes to smooth a horizontal change. · by wowlua(): number | guessed |
GetMsToSmoothVerticalChange | Returns how long, in milliseconds, the smart camera takes to smooth a vertical change. · by wowlua(): number | guessed |
GetNumMaps | Returns the number of maps in the commentator's match list. · by wowlua(): number | guessed |
GetNumPlayers | Returns the number of players on a team. · by wowlua(factionIndex: number): number? | implemented |
GetOrCreateSeries | Returns the series between two teams, creating it without a score if there is none. · by wowlua(teamName1: string, teamName2: string): CommentatorSeries | guessed |
GetPlayerAuraInfo | Returns timing information for an aura on a spectated player. · by wowlua(teamIndex: number, playerIndex: number, spellID: number): (number?, number?, boolean?) | implemented |
GetPlayerAuraInfoByUnit | Returns timing information for an aura on a spectated unit. · by wowlua(token: string, spellID: number): (number?, number?, boolean?) | implemented |
GetPlayerCooldownInfo | Returns the cooldown of a spell for a spectated player. · by wowlua(teamIndex: number, playerIndex: number, spellID: number): (number?, number?, boolean?) | implemented |
GetPlayerCooldownInfoByUnit | Returns the cooldown of a spell for a spectated unit. · by wowlua(unitToken: string, spellID: number): (number?, number?, boolean?) | implemented |
GetPlayerCrowdControlInfo | Returns the crowd control currently on a spectated player. · by wowlua(teamIndex: number, playerIndex: number): (number?, number?, number?) | implemented |
GetPlayerCrowdControlInfoByUnit | Returns the crowd control currently on a spectated unit. · by wowlua(token: string): (number?, number?, number?) | implemented |
GetPlayerData | Returns information about a spectated player. · by wowlua(teamIndex: number, playerIndex: number): CommentatorPlayerData? | implemented |
GetPlayerFlagInfo | Whether a spectated player carries a flag. · by wowlua(teamIndex: number, playerIndex: number): boolean | implemented |
GetPlayerFlagInfoByUnit | Whether a spectated unit carries a flag. · by wowlua(unitToken: string): boolean | implemented |
GetPlayerItemCooldownInfo | Returns the cooldown of an item for a spectated player. · by wowlua(teamIndex: number, playerIndex: number, itemID: number): (number?, number?, boolean?) | implemented |
GetPlayerItemCooldownInfoByUnit | Returns the cooldown of an item for a spectated unit. · by wowlua(unitToken: string, itemID: number): (number?, number?, boolean?) | implemented |
GetPlayerOverrideName | Returns the name set for a player with AddPlayerOverrideName. · by wowlua(originalName: string): string? | guessed |
GetPlayerSpellCharges | Returns the charges of a spell for a spectated player. · by wowlua(teamIndex: number, playerIndex: number, spellID: number): (number?, number?, number?, number?) | implemented |
GetPlayerSpellChargesByUnit | Returns the charges of a spell for a spectated unit. · by wowlua(unitToken: string, spellID: number): (number?, number?, number?, number?) | implemented |
GetPositionLerpAmount | Returns how quickly the commentator camera moves toward its target position. · by wowlua(): number | guessed |
GetSmoothFollowTransitioning | Whether the commentator camera moves smoothly when it switches to a new follow target. · by wowlua(): boolean | implemented |
GetSoftlockWeight | Returns the smart camera's soft-lock weight. · by wowlua(): number | guessed |
GetSpeedFactor | Returns the commentator camera's speed factor. · by wowlua(): number | guessed |
GetStartLocation | Returns the start location on a map. · by wowlua(mapID: number): Vector3DMixin? | guessed |
GetTeamColor | Returns the color of a team in the commentator UI. · by wowlua(teamIndex: number): ColorMixin | guessed |
GetTeamColorByUnit | Returns the color of a unit's team in the commentator UI. · by wowlua(unitToken: string): ColorMixin | guessed |
GetTimeLeftInMatch | Returns the time left in the spectated match. · by wowlua(): number? | guessed |
GetTrackedSpellID | Returns the tracked spell that an indirect spell counts as. · by wowlua(indirectSpellID: number): number | implemented |
GetTrackedSpells | Returns a spectated player's tracked spells in a category, and the lookup's result. · by wowlua(teamIndex: number, playerIndex: number, category: TrackedSpellCategory): (number[]?, TrackedSpellsResult) | implemented |
GetTrackedSpellsByUnit | Returns a spectated unit's tracked spells in a category, and the lookup's result. · by wowlua(unitToken: string, category: TrackedSpellCategory): (number[]?, TrackedSpellsResult) | implemented |
GetUnitData | Returns information about a spectated unit. · by wowlua(unitToken: string): CommentatorUnitData | implemented |
GetWargameInfo | Returns information about an entry of the wargame list. · by wowlua(listID: number): (string?, number?, number?, boolean?) | implemented |
HasTrackedAuras | Whether a unit has tracked offensive or defensive auras on it, one boolean for each kind. · by wowlua(token: string): (boolean, boolean) | implemented |
IsSmartCameraLocked | Whether the smart camera is locked. · by wowlua(): boolean | guessed |
IsSpectating | Whether the player is spectating a match as a commentator. · by wowlua(): boolean | recorded |
IsTrackedDefensiveAura | Whether the spell is a tracked defensive aura. · by wowlua(spellID: number): boolean | implemented |
IsTrackedOffensiveAura | Whether the spell is a tracked offensive aura. · by wowlua(spellID: number): boolean | implemented |
IsTrackedSpell | Whether the spell is tracked for a spectated player in the given category. · by wowlua(teamIndex: number, playerIndex: number, spellID: number, category: TrackedSpellCategory): boolean | implemented |
IsTrackedSpellByUnit | Whether the spell is tracked for a spectated unit in the given category. · by wowlua(unitToken: string, spellID: number, category: TrackedSpellCategory): boolean | implemented |
IsUsingSmartCamera | Whether the commentator uses the smart camera. · by wowlua(): boolean | guessed |
LookAtPlayer | Points the commentator camera at a player. · by wowlua(factionIndex: number, playerIndex: number, lookAtIndex: number?) | implemented |
RemoveAllOverrideNames | Removes every player name override. · by wowlua() | guessed |
RemovePlayerOverrideName | Removes a player's name override. · by wowlua(originalPlayerName: string) | guessed |
RequestPlayerCooldownInfo | Requests the cooldown information of a spectated player. · by wowlua(teamIndex: number, playerIndex: number) | implemented |
ResetFoVTarget | Resets the commentator camera's target field of view. · by wowlua() | guessed |
ResetSeriesScores | Resets the scores of the series between two teams. · by wowlua(teamName1: string, teamName2: string) | guessed |
ResetSettings | Resets the commentator settings to their defaults. · by wowlua() | guessed |
ResetTrackedAuras | Clears the auras the commentator UI tracks. · by wowlua() | implemented |
SendAddonMessage | Works the same as C_ChatInfo.SendAddonMessage but accepts secrets and is only allowed when outgoing addon comms are allowed (i.e. on tournament realms)(prefix: string, message: string, chatType: string?, target: string?): SendAddonMessageResult | guessed |
SendAddonMessageLogged | Works the same as C_ChatInfo.SendAddonMessageLogged but accepts secrets and is only allowed when outgoing addon comms are allowed (i.e. on tournament realms)(prefix: string, message: string, chatType: string?, target: string?): SendAddonMessageResult? | guessed |
SetAdditionalCameraWeight | Sets an additional weight the smart camera gives a spectated player. · by wowlua(teamIndex: number, playerIndex: number, weight: number) | implemented |
SetAdditionalCameraWeightByToken | Sets an additional weight the smart camera gives a unit. · by wowlua(unitToken: string, weight: number) | implemented |
SetBlocklistedAuras | Sets the auras the commentator UI leaves out. · by wowlua(spellIDs: number[]) | guessed |
SetBlocklistedCooldowns | Sets the spell cooldowns the commentator UI leaves out for a specialization. · by wowlua(specID: number, spellIDs: number[]) | guessed |
SetBlocklistedItemCooldowns | Sets the item cooldowns the commentator UI leaves out. · by wowlua(itemIDs: number[]) | guessed |
SetCamera | Sets the commentator camera's position, orientation and field of view. · by wowlua(xPos: number, yPos: number, zPos: number, yaw: number, pitch: number, roll: number, fov: number) | implemented |
SetCameraCollision | Sets whether the commentator camera collides with the world. · by wowlua(collide: boolean) | implemented |
SetCameraPosition | Moves the commentator camera to a position. · by wowlua(xPos: number, yPos: number, zPos: number, snapToLocation: boolean) | implemented |
SetCheatsEnabled | Enables or disables commentator cheats. · by wowlua(enableCheats: boolean) | guessed |
SetCommentatorHistory | Restores commentator history saved with GetCommentatorHistory. · by wowlua(history: CommentatorHistory) | guessed |
SetDistanceBeforeForcedHorizontalConvergence | Sets the distance at which the smart camera is forced to converge horizontally on its target. · by wowlua(distance: number) | guessed |
SetDurationToForceHorizontalConvergence | Sets how long, in milliseconds, before the smart camera is forced to converge horizontally on its target. · by wowlua(ms: number) | guessed |
SetExcludeDistance | Sets the smart camera's exclude distance. · by wowlua(excludeDistance: number) | guessed |
SetFollowCameraSpeeds | Sets the follow camera's elastic speed and minimum speed. · by wowlua(elasticSpeed: number, minSpeed: number) | implemented |
SetHardlockWeight | Sets the smart camera's hard-lock weight. · by wowlua(weight: number) | guessed |
SetHorizontalAngleThresholdToSmooth | Sets the horizontal angle above which the smart camera smooths its turns. · by wowlua(angle: number) | guessed |
SetLookAtLerpAmount | Sets how quickly the commentator camera turns toward its look-at target. · by wowlua(amount: number) | guessed |
SetMapAndInstanceIndex | Selects the map and instance that EnterInstance enters. · by wowlua(mapIndex: number, instanceIndex: number) | implemented |
SetMouseDisabled | Disables or enables mouse control of the commentator camera. · by wowlua(disabled: boolean) | guessed |
SetMoveSpeed | Sets the commentator camera's movement speed. · by wowlua(newSpeed: number) | guessed |
SetMsToHoldForHorizontalMovement | Sets how long, in milliseconds, the smart camera waits before moving horizontally. · by wowlua(ms: number) | guessed |
SetMsToHoldForVerticalMovement | Sets how long, in milliseconds, the smart camera waits before moving vertically. · by wowlua(ms: number) | guessed |
SetMsToSmoothHorizontalChange | Sets how long, in milliseconds, the smart camera takes to smooth a horizontal change. · by wowlua(ms: number) | guessed |
SetMsToSmoothVerticalChange | Sets how long, in milliseconds, the smart camera takes to smooth a vertical change. · by wowlua(ms: number) | guessed |
SetPositionLerpAmount | Sets how quickly the commentator camera moves toward its target position. · by wowlua(amount: number) | guessed |
SetRequestedDebuffCooldowns | Sets the debuff spells whose cooldowns the commentator UI requests for a specialization. · by wowlua(specID: number, spellIDs: number[]) | guessed |
SetRequestedDefensiveCooldowns | Sets the defensive spells whose cooldowns the commentator UI requests for a specialization. · by wowlua(specID: number, spellIDs: number[]) | guessed |
SetRequestedItemCooldowns | Sets the items whose cooldowns the commentator UI requests. · by wowlua(itemIDs: number[]) | guessed |
SetRequestedOffensiveCooldowns | Sets the offensive spells whose cooldowns the commentator UI requests for a specialization. · by wowlua(specID: number, spellIDs: number[]) | guessed |
SetSeriesScore | Sets one team's score in the series between two teams. · by wowlua(teamName1: string, teamName2: string, scoringTeamName: string, score: number) | guessed |
SetSeriesScores | Sets both teams' scores in the series between them. · by wowlua(teamName1: string, teamName2: string, score1: number, score2: number) | guessed |
SetSmartCameraLocked | Locks or unlocks the smart camera. · by wowlua(locked: boolean) | guessed |
SetSmoothFollowTransitioning | Sets whether the commentator camera moves smoothly when it switches to a new follow target. · by wowlua(enabled: boolean) | implemented |
SetSoftlockWeight | Sets the smart camera's soft-lock weight. · by wowlua(weight: number) | guessed |
SetSpeedFactor | Sets the commentator camera's speed factor. · by wowlua(factor: number) | guessed |
SetTargetHeightOffset | Sets the height offset of the point the commentator camera aims at. · by wowlua(offset: number) | implemented |
SetUseSmartCamera | Turns the commentator's smart camera on or off. · by wowlua(useSmartCamera: boolean) | guessed |
SnapCameraLookAtPoint | Turns the commentator camera to its look-at point at once. · by wowlua() | implemented |
SpellUsesItemCharges | Whether the spell uses an item's charges. · by wowlua(spellID: number): boolean | guessed |
StartWargame | Starts a wargame between two teams led by the given captains. · by wowlua(listID: number, teamSize: number, tournamentRules: boolean, teamOneCaptain: string, teamTwoCaptain: string) | implemented |
SwapTeamSides | Swaps the sides the two teams are shown on. · by wowlua() | guessed |
ToggleCheats | Turns commentator cheats on or off. · by wowlua() | guessed |
UpdateMapInfo | Requests updated information about the commentator's maps. · by wowlua(targetPlayer: string?) | implemented |
UpdatePlayerInfo | Requests updated information about the spectated players. · by wowlua() | implemented |
ZoomIn | Zooms the commentator camera in. · by wowlua() | guessed |
ZoomIn_Position | Zooms the commentator camera in. · by wowlua(zoomAmount: number?) | guessed |
ZoomOut | Zooms the commentator camera out. · by wowlua() | guessed |
ZoomOut_Position | Zooms the commentator camera out. · by wowlua(zoomAmount: number?) | 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 |
|---|---|---|
COMMENTATOR_COMBAT_EVENT | no payload | not implemented |
COMMENTATOR_ENTER_WORLD | no payload | implemented |
COMMENTATOR_HISTORY_FLUSHED | no payload | not implemented |
COMMENTATOR_IMMEDIATE_FOV_UPDATE | fov: number | not implemented |
COMMENTATOR_MAP_UPDATE | no payload | not implemented |
COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE | nameToOverride: string, overrideName: string? | not implemented |
COMMENTATOR_PLAYER_UPDATE | no payload | not implemented |
COMMENTATOR_RESET_SETTINGS | no payload | not implemented |
COMMENTATOR_TEAMS_SWAPPED | swapped: boolean | not implemented |
COMMENTATOR_TEAM_NAME_UPDATE | teamName: string | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("COMMENTATOR_COMBAT_EVENT").
Structures
CommentatorHistory· series, teamDirectory, overrideNameDirectoryCommentatorMatchDataState· receivedPlayerInfo, setInstancePlayers, requestedCooldownInfo, requestedPlayerCooldownsCommentatorOverrideNameEntry· originalName, newNameCommentatorPlayerData· unitToken, name, faction, specialization, damageDone, damageTaken, healingDone, healingTaken, kills, deaths, soloShuffleRoundWins, soloShuffleRoundLossesCommentatorSeries· teamsCommentatorSeriesTeam· name, scoreCommentatorTeamDirectoryEntry· playerName, teamNameCommentatorTrackedItemCooldown· spellID, categoryCommentatorUnitData· healthMax, health, absorbTotal, isDeadOrGhost, isFeignDeath, powerTypeToken, power, powerMaxNameOverrideEntry· originalName, overrideNameTeamPlayerRequestedCooldownInfo· teamIndex, playerIndex, cooldownsRequested
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (CommentatorFrame 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.