First commit, step 4 completed

2026-10-15 14:27:00 +11:00
commit 9a30efa170
5378 changed files with 1136719 additions and 0 deletions
@@ -0,0 +1,61 @@
+local EncounterEventsShared =
+{
+	Tables =
+	{
+		{
+			Name = "EncounterEventColorTrigger",
+			Type = "Enumeration",
+			NumValues = 3,
+			MinValue = 0,
+			MaxValue = 2,
+			Fields =
+			{
+				{ Name = "TextWarning", Type = "EncounterEventColorTrigger", EnumValue = 0, Documentation = { "Color to be used when an encounter event shown as a text warning alert." } },
+				{ Name = "TimelineEvent", Type = "EncounterEventColorTrigger", EnumValue = 1, Documentation = { "Color to be used when an encounter event is placed on the timeline." } },
+				{ Name = "TimelineEventHighlight", Type = "EncounterEventColorTrigger", EnumValue = 2, Documentation = { "Color to be used when an encounter event reaches its 'highlight' duration on the timeline (typically, ~5s before the cast is due)." } },
+			},
+		},
+		{
+			Name = "EncounterEventSoundTrigger",
+			Type = "Enumeration",
+			NumValues = 3,
+			MinValue = 0,
+			MaxValue = 2,
+			Fields =
+			{
+				{ Name = "OnTextWarningShown", Type = "EncounterEventSoundTrigger", EnumValue = 0, Documentation = { "Trigger to be activated when an text warning is initially shown for an encounter event." } },
+				{ Name = "OnTimelineEventFinished", Type = "EncounterEventSoundTrigger", EnumValue = 1, Documentation = { "Trigger to be activated when an encounter event on the timeline transitions to a finished (ie. casted, or resolved) state." } },
+				{ Name = "OnTimelineEventHighlight", Type = "EncounterEventSoundTrigger", EnumValue = 2, Documentation = { "Trigger to be activated when an encounter event reaches its 'highlight' duration on the timeline (typically, ~5s before the cast is due)." } },
+			},
+		},
+		{
+			Name = "EncounterEventInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "encounterEventID", Type = "number", Nilable = false, Documentation = { "ID of the encounter event record." } },
+				{ Name = "enabled", Type = "bool", Nilable = false, Documentation = { "If true, this event should be displayed on boss ability HUD elements." } },
+				{ Name = "spellID", Type = "number", Nilable = false, Documentation = { "Spell ID that triggers this event. A single spell may be used by multiple encounter events." } },
+				{ Name = "iconFileID", Type = "number", Nilable = false, Documentation = { "Icon file ID for the event. Typically the same as the spell icon, but may be overridden." } },
+				{ Name = "severity", Type = "EncounterEventSeverity", Nilable = false, Documentation = { "Severity level of this event." } },
+				{ Name = "icons", Type = "EncounterEventIconmask", Nilable = false, Documentation = { "Bitmask of spell support icons to show for this event." } },
+			},
+		},
+		{
+			Name = "EncounterEventSoundInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "file", Type = "FileAsset", Nilable = false, Documentation = { "Sound file to be played when triggered." } },
+				{ Name = "channel", Type = "UISoundSubType", Nilable = false, Default = "g_defaultSI3UISoundSubTypeForLua", Documentation = { "Sound channel to play this file on." } },
+				{ Name = "volume", Type = "number", Nilable = false, Default = 1, Documentation = { "Volume scalar for the sound file." } },
+			},
+		},
+	},
+
+	Predicates =
+	{
+	},
+};
+
+APIDocumentation:AddDocumentationTable(EncounterEventsShared);