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,226 @@
+local CovenantSanctum =
+{
+	Name = "CovenantSanctumUI",
+	Type = "System",
+	Namespace = "C_CovenantSanctumUI",
+	Environment = "All",
+
+	Functions =
+	{
+		{
+			Name = "CanAccessReservoir",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "canAccess", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "CanDepositAnima",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "canDeposit", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "DepositAnima",
+			Type = "Function",
+		},
+		{
+			Name = "EndInteraction",
+			Type = "Function",
+		},
+		{
+			Name = "GetAnimaInfo",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "currencyID", Type = "number", Nilable = false },
+				{ Name = "maxDisplayableValue", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetCurrentTalentTreeID",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "currentTalentTreeID", Type = "number", Nilable = true },
+			},
+		},
+		{
+			Name = "GetFeatures",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "features", Type = "table", InnerType = "CovenantSanctumFeatureInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetRenownLevel",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "level", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetRenownLevels",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "covenantID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "levels", Type = "table", InnerType = "CovenantSanctumRenownLevelInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetRenownRewardsForLevel",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "covenantID", Type = "number", Nilable = false },
+				{ Name = "renownLevel", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "rewards", Type = "table", InnerType = "CovenantSanctumRenownRewardInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSanctumType",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "sanctumType", Type = "GarrTalentFeatureSubtype", Nilable = true },
+			},
+		},
+		{
+			Name = "GetSoulCurrencies",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "currencyIDs", Type = "table", InnerType = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "HasMaximumRenown",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "hasMaxRenown", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsPlayerInRenownCatchUpMode",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "isInCatchUpMode", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsWeeklyRenownCapped",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "isWeeklyCapped", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "RequestCatchUpState",
+			Type = "Function",
+		},
+	},
+
+	Events =
+	{
+		{
+			Name = "CovenantRenownCatchUpStateUpdate",
+			Type = "Event",
+			LiteralName = "COVENANT_RENOWN_CATCH_UP_STATE_UPDATE",
+			SynchronousEvent = true,
+		},
+		{
+			Name = "CovenantSanctumRenownLevelChanged",
+			Type = "Event",
+			LiteralName = "COVENANT_SANCTUM_RENOWN_LEVEL_CHANGED",
+			SynchronousEvent = true,
+			Payload =
+			{
+				{ Name = "newRenownLevel", Type = "number", Nilable = false },
+				{ Name = "oldRenownLevel", Type = "number", Nilable = false },
+			},
+		},
+	},
+
+	Tables =
+	{
+		{
+			Name = "CovenantSanctumFeatureInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "garrTalentTreeID", Type = "number", Nilable = false },
+				{ Name = "featureType", Type = "number", Nilable = false },
+				{ Name = "uiOrder", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "CovenantSanctumRenownLevelInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "level", Type = "number", Nilable = false },
+				{ Name = "locked", Type = "bool", Nilable = false },
+				{ Name = "isMilestone", Type = "bool", Nilable = false },
+				{ Name = "isCapstone", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "CovenantSanctumRenownRewardInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "uiOrder", Type = "number", Nilable = false },
+				{ Name = "itemID", Type = "number", Nilable = true },
+				{ Name = "spellID", Type = "number", Nilable = true },
+				{ Name = "mountID", Type = "number", Nilable = true },
+				{ Name = "transmogID", Type = "number", Nilable = true },
+				{ Name = "transmogSetID", Type = "number", Nilable = true },
+				{ Name = "titleMaskID", Type = "number", Nilable = true },
+				{ Name = "garrFollowerID", Type = "number", Nilable = true },
+				{ Name = "transmogIllusionSourceID", Type = "number", Nilable = true },
+				{ Name = "icon", Type = "fileID", Nilable = true },
+				{ Name = "name", Type = "cstring", Nilable = true },
+				{ Name = "description", Type = "cstring", Nilable = true },
+				{ Name = "toastDescription", Type = "cstring", Nilable = true },
+			},
+		},
+	},
+
+	Predicates =
+	{
+	},
+};
+
+APIDocumentation:AddDocumentationTable(CovenantSanctum);