177 lines
4.5 KiB
Lua
177 lines
4.5 KiB
Lua
local EncounterWarnings =
|
|
{
|
|
Name = "EncounterWarnings",
|
|
Type = "System",
|
|
Namespace = "C_EncounterWarnings",
|
|
Environment = "All",
|
|
|
|
Functions =
|
|
{
|
|
{
|
|
Name = "GetColorForSeverity",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "severity", Type = "EncounterEventSeverity", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetEditModeWarningInfo",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "severity", Type = "EncounterEventSeverity", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "warningInfo", Type = "EncounterWarningInfo", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetPlayCustomSoundsWhenHidden",
|
|
Type = "Function",
|
|
Documentation = { "Returns true if custom sound alerts are allowed to play for hidden warning messages." },
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "play", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetSoundKitForSeverity",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "severity", Type = "EncounterEventSeverity", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "soundKitID", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetWarningsShown",
|
|
Type = "Function",
|
|
Documentation = { "Returns true if text messages for encounter events are allowed to be shown." },
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "shown", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsFeatureAvailable",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isAvailable", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsFeatureEnabled",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isAvailableAndEnabled", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "PlaySound",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "severity", Type = "EncounterEventSeverity", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "soundHandle", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetPlayCustomSoundsWhenHidden",
|
|
Type = "Function",
|
|
SecretArguments = "NotAllowed",
|
|
Documentation = { "Controls whether custom sound alerts for encounter events are allowed to play for warning messages that are hidden." },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "play", Type = "bool", Nilable = false, Documentation = { "If true, allow playing custom sound alerts. Note that sound alerts will not be played if the encounter warnings feature has been disabled." } },
|
|
},
|
|
},
|
|
{
|
|
Name = "SetWarningsShown",
|
|
Type = "Function",
|
|
SecretArguments = "NotAllowed",
|
|
Documentation = { "Controls whether text messages for encounter events are allowed to be shown." },
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "shown", Type = "bool", Nilable = false, Documentation = { "If false, hides all warning messages in the default UI." } },
|
|
},
|
|
},
|
|
},
|
|
|
|
Events =
|
|
{
|
|
{
|
|
Name = "EncounterWarning",
|
|
Type = "Event",
|
|
LiteralName = "ENCOUNTER_WARNING",
|
|
SynchronousEvent = true,
|
|
Payload =
|
|
{
|
|
{ Name = "encounterWarningInfo", Type = "EncounterWarningInfo", Nilable = false },
|
|
},
|
|
},
|
|
},
|
|
|
|
Tables =
|
|
{
|
|
{
|
|
Name = "EncounterWarningInfo",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "text", Type = "cstring", Nilable = false, SecretValue = true },
|
|
{ Name = "casterGUID", Type = "WOWGUID", Nilable = false, SecretValue = true },
|
|
{ Name = "casterName", Type = "cstring", Nilable = false, SecretValue = true },
|
|
{ Name = "targetGUID", Type = "WOWGUID", Nilable = false, SecretValue = true },
|
|
{ Name = "targetName", Type = "cstring", Nilable = false, SecretValue = true },
|
|
{ Name = "iconFileID", Type = "number", Nilable = false, SecretValue = true },
|
|
{ Name = "tooltipSpellID", Type = "number", Nilable = false, SecretValue = true },
|
|
{ Name = "isDeadly", Type = "bool", Nilable = false, SecretValue = true },
|
|
{ Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false, SecretValue = true },
|
|
{ Name = "duration", Type = "Seconds", Nilable = false },
|
|
{ Name = "severity", Type = "EncounterEventSeverity", Nilable = false },
|
|
{ Name = "shouldPlaySound", Type = "bool", Nilable = false },
|
|
{ Name = "shouldShowChatMessage", Type = "bool", Nilable = false },
|
|
{ Name = "shouldShowWarning", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
},
|
|
|
|
Predicates =
|
|
{
|
|
},
|
|
};
|
|
|
|
APIDocumentation:AddDocumentationTable(EncounterWarnings); |