C_EncounterWarnings
namespaceavailable in: camelotStatus in wowlua
10 functions: 0 implemented, 0 recorded, 10 guessed. 1 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
GetColorForSeverity | Returns the color that encounter warnings of the given severity are shown in. · by wowlua(severity: EncounterEventSeverity): ColorMixin | guessed |
GetEditModeWarningInfo | Returns the sample encounter warning that Edit Mode shows for the given severity. · by wowlua(severity: EncounterEventSeverity): EncounterWarningInfo | guessed |
GetPlayCustomSoundsWhenHidden | Returns true if custom sound alerts are allowed to play for hidden warning messages.(): boolean | guessed |
GetSoundKitForSeverity | Returns the sound kit ID played for encounter warnings of the given severity. · by wowlua(severity: EncounterEventSeverity): number | guessed |
GetWarningsShown | Returns true if text messages for encounter events are allowed to be shown.(): boolean | guessed |
IsFeatureAvailable | Whether encounter warnings are available. · by wowlua(): boolean | guessed |
IsFeatureEnabled | Whether encounter warnings are turned on. · by wowlua(): boolean | guessed |
PlaySound | Plays the encounter warning sound for the given severity and returns its sound handle. · by wowlua(severity: EncounterEventSeverity): number? | guessed |
SetPlayCustomSoundsWhenHidden | Controls whether custom sound alerts for encounter events are allowed to play for warning messages that are hidden.(play: boolean) | guessed |
SetWarningsShown | Controls whether text messages for encounter events are allowed to be shown.(shown: boolean) | 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 |
|---|---|---|
ENCOUNTER_WARNING | encounterWarningInfo: EncounterWarningInfo | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ENCOUNTER_WARNING").
Structures
EncounterWarningInfo· text, casterGUID, casterName, targetGUID, targetName, iconFileID, tooltipSpellID, isDeadly, color, duration, severity, shouldPlaySound, shouldShowChatMessage, shouldShowWarning
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (EncounterWarnings 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.