Include Blizzard_APIDocumentation and Search API Button to Code Editor with Wrath Classic Data (#57)

2025-07-05 19:08:53 +02:00
parent ad68aa2f97
commit 0971189346
319 changed files with 47180 additions and 18 deletions
@@ -0,0 +1,103 @@
+local AreaPoiInfo =
+{
+	Name = "AreaPoiInfo",
+	Type = "System",
+	Namespace = "C_AreaPoiInfo",
+
+	Functions =
+	{
+		{
+			Name = "GetAreaPOIForMap",
+			Type = "Function",
+
+			Arguments =
+			{
+				{ Name = "uiMapID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetAreaPOIInfo",
+			Type = "Function",
+
+			Arguments =
+			{
+				{ Name = "uiMapID", Type = "number", Nilable = false },
+				{ Name = "areaPoiID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "poiInfo", Type = "AreaPOIInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetAreaPOITimeLeft",
+			Type = "Function",
+			Documentation = { "Returns the number of minutes until the POI expires." },
+
+			Arguments =
+			{
+				{ Name = "areaPoiID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "minutesLeft", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "IsAreaPOITimed",
+			Type = "Function",
+			Documentation = { "This statically determines if the POI is timed, GetAreaPOITimeLeft retrieves the value from the server and may return nothing for long intervals" },
+
+			Arguments =
+			{
+				{ Name = "areaPoiID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isTimed", Type = "bool", Nilable = false },
+			},
+		},
+	},
+
+	Events =
+	{
+		{
+			Name = "AreaPoisUpdated",
+			Type = "Event",
+			LiteralName = "AREA_POIS_UPDATED",
+		},
+	},
+
+	Tables =
+	{
+		{
+			Name = "AreaPOIInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "areaPoiID", Type = "number", Nilable = false },
+				{ Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false },
+				{ Name = "name", Type = "cstring", Nilable = false },
+				{ Name = "description", Type = "cstring", Nilable = true },
+				{ Name = "textureIndex", Type = "number", Nilable = true },
+				{ Name = "widgetSetID", Type = "number", Nilable = true },
+				{ Name = "atlasName", Type = "string", Nilable = true },
+				{ Name = "shouldGlow", Type = "bool", Nilable = false },
+				{ Name = "factionID", Type = "number", Nilable = true },
+				{ Name = "isPrimaryMapForPOI", Type = "bool", Nilable = false },
+				{ Name = "isAlwaysOnFlightmap", Type = "bool", Nilable = false },
+				{ Name = "addPaddingAboveWidgets", Type = "bool", Nilable = true },
+			},
+		},
+	},
+};
+
+APIDocumentation:AddDocumentationTable(AreaPoiInfo);