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,109 @@
+local TooltipComparison =
+{
+	Name = "TooltipComparison",
+	Type = "System",
+	Namespace = "C_TooltipComparison",
+	Environment = "All",
+
+	Functions =
+	{
+		{
+			Name = "CompareItem",
+			Type = "Function",
+			IsProtectedFunction = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false },
+				{ Name = "tooltip", Type = "Tooltip", Nilable = false },
+				{ Name = "anchorFrame", Type = "SimpleFrame", Nilable = true },
+			},
+		},
+		{
+			Name = "GetItemComparisonDelta",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false },
+				{ Name = "equippedItem", Type = "TooltipComparisonItem", Nilable = false },
+				{ Name = "pairedItem", Type = "TooltipComparisonItem", Nilable = true },
+				{ Name = "addPairedStats", Type = "bool", Nilable = true, Documentation = { "Whether the paired item's stats are added or subtracted" } },
+			},
+
+			Returns =
+			{
+				{ Name = "lines", Type = "table", InnerType = "string", Nilable = false },
+			},
+		},
+		{
+			Name = "GetItemComparisonInfo",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "info", Type = "TooltipItemComparisonInfo", Nilable = false },
+			},
+		},
+	},
+
+	Events =
+	{
+		{
+			Name = "TooltipShowItemComparison",
+			Type = "Event",
+			LiteralName = "TOOLTIP_SHOW_ITEM_COMPARISON",
+			CallbackEvent = true,
+			Payload =
+			{
+				{ Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false },
+				{ Name = "tooltip", Type = "Tooltip", Nilable = false },
+				{ Name = "anchorFrame", Type = "SimpleFrame", Nilable = true },
+			},
+		},
+	},
+
+	Tables =
+	{
+		{
+			Name = "TooltipComparisonMethod",
+			Type = "Enumeration",
+			NumValues = 4,
+			MinValue = 0,
+			MaxValue = 3,
+			Fields =
+			{
+				{ Name = "Single", Type = "TooltipComparisonMethod", EnumValue = 0 },
+				{ Name = "WithBothHands", Type = "TooltipComparisonMethod", EnumValue = 1 },
+				{ Name = "WithBagMainHandItem", Type = "TooltipComparisonMethod", EnumValue = 2 },
+				{ Name = "WithBagOffHandItem", Type = "TooltipComparisonMethod", EnumValue = 3 },
+			},
+		},
+		{
+			Name = "TooltipItemComparisonInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "method", Type = "TooltipComparisonMethod", Nilable = false, Default = "Single" },
+				{ Name = "item", Type = "TooltipComparisonItem", Nilable = false },
+				{ Name = "additionalItems", Type = "table", InnerType = "TooltipComparisonItem", Nilable = false },
+			},
+		},
+	},
+
+	Predicates =
+	{
+	},
+};
+
+APIDocumentation:AddDocumentationTable(TooltipComparison);