First commit, step 4 completed

docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua

@@ -0,0 +1,558 @@
+local TransmogSets =
+{
+	Name = "TransmogrifySets",
+	Type = "System",
+	Namespace = "C_TransmogSets",
+	Environment = "All",
+
+	Functions =
+	{
+		{
+			Name = "ClearLatestSource",
+			Type = "Function",
+		},
+		{
+			Name = "ClearNewSource",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "sourceID", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "ClearSetNewSourcesForSlot",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+				{ Name = "slot", Type = "luaIndex", Nilable = false },
+			},
+		},
+		{
+			Name = "GetAllSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "sets", Type = "table", InnerType = "TransmogSetInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetAllSourceIDs",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "sources", Type = "table", InnerType = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetAvailableSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "sets", Type = "table", InnerType = "TransmogSetInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetBaseSetID",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "baseTransmogSetID", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetBaseSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "sets", Type = "table", InnerType = "TransmogSetInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetBaseSetsFilter",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "index", Type = "luaIndex", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isChecked", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "GetCameraIDs",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "detailsCameraID", Type = "number", Nilable = true },
+				{ Name = "vendorCameraID", Type = "number", Nilable = true },
+			},
+		},
+		{
+			Name = "GetFilteredBaseSetsCounts",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "numCollected", Type = "number", Nilable = false },
+				{ Name = "numTotal", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetFullBaseSetsCounts",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "numCollected", Type = "number", Nilable = false },
+				{ Name = "numTotal", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetIsFavorite",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isFavorite", Type = "bool", Nilable = false },
+				{ Name = "isGroupFavorite", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "GetLatestSource",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "sourceID", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSetInfo",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "set", Type = "TransmogSetInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSetNewSources",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "sourceIDs", Type = "table", InnerType = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSetPrimaryAppearances",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "apppearances", Type = "table", InnerType = "TransmogSetPrimaryAppearanceInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSetsContainingSourceID",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "sourceID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "setIDs", Type = "table", InnerType = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSetsFilter",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "index", Type = "luaIndex", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isChecked", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSourceIDsForSlot",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+				{ Name = "slot", Type = "luaIndex", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "sources", Type = "table", InnerType = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetSourcesForSlot",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+				{ Name = "slot", Type = "luaIndex", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "sources", Type = "table", InnerType = "AppearanceSourceInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetTransmogSetsClassFilter",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "classID", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetUsableSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "sets", Type = "table", InnerType = "TransmogSetInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "GetValidBaseSetsCountsForCharacter",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "numCollected", Type = "number", Nilable = false },
+				{ Name = "numTotal", Type = "number", Nilable = false },
+			},
+		},
+		{
+			Name = "GetValidClassForSet",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "classID", Type = "number", Nilable = true },
+			},
+		},
+		{
+			Name = "GetVariantSets",
+			Type = "Function",
+			MayReturnNothing = true,
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "sets", Type = "table", InnerType = "TransmogSetInfo", Nilable = false },
+			},
+		},
+		{
+			Name = "HasAnyValidSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "hasAnyValidSets", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "HasAvailableSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "hasAvailableSets", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "HasUsableSets",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "hasUsableSets", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsBaseSetCollected",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isCollected", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsNewSource",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "sourceID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isNew", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsSetVisible",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "isVisible", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsUsingDefaultBaseSetsFilters",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "isUsingDefaultBaseSetsFilters", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "IsUsingDefaultSetsFilters",
+			Type = "Function",
+
+			Returns =
+			{
+				{ Name = "isUsingDefaultSetsFilters", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "SetBaseSetsFilter",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "index", Type = "luaIndex", Nilable = false },
+				{ Name = "isChecked", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "SetDefaultBaseSetsFilters",
+			Type = "Function",
+		},
+		{
+			Name = "SetDefaultSetsFilters",
+			Type = "Function",
+		},
+		{
+			Name = "SetHasNewSources",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "hasNewSources", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "SetHasNewSourcesForSlot",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+				{ Name = "slot", Type = "luaIndex", Nilable = false },
+			},
+
+			Returns =
+			{
+				{ Name = "hasNewSources", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "SetIsFavorite",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "transmogSetID", Type = "number", Nilable = false },
+				{ Name = "isFavorite", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "SetSetsFilter",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "index", Type = "luaIndex", Nilable = false },
+				{ Name = "isChecked", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "SetTransmogSetsClassFilter",
+			Type = "Function",
+			SecretArguments = "AllowedWhenUntainted",
+
+			Arguments =
+			{
+				{ Name = "classID", Type = "number", Nilable = false },
+			},
+		},
+	},
+
+	Events =
+	{
+	},
+
+	Tables =
+	{
+		{
+			Name = "TransmogSetInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "setID", Type = "number", Nilable = false },
+				{ Name = "name", Type = "string", Nilable = false },
+				{ Name = "baseSetID", Type = "number", Nilable = true },
+				{ Name = "description", Type = "cstring", Nilable = true },
+				{ Name = "label", Type = "cstring", Nilable = true },
+				{ Name = "expansionID", Type = "number", Nilable = false },
+				{ Name = "patchID", Type = "number", Nilable = false },
+				{ Name = "uiOrder", Type = "number", Nilable = false },
+				{ Name = "classMask", Type = "number", Nilable = false },
+				{ Name = "hiddenUntilCollected", Type = "bool", Nilable = false },
+				{ Name = "requiredFaction", Type = "cstring", Nilable = true },
+				{ Name = "collected", Type = "bool", Nilable = false },
+				{ Name = "favorite", Type = "bool", Nilable = false },
+				{ Name = "limitedTimeSet", Type = "bool", Nilable = false },
+				{ Name = "validForCharacter", Type = "bool", Nilable = false },
+				{ Name = "grantAsPrecedingVariant", Type = "bool", Nilable = false },
+			},
+		},
+		{
+			Name = "TransmogSetPrimaryAppearanceInfo",
+			Type = "Structure",
+			Fields =
+			{
+				{ Name = "appearanceID", Type = "number", Nilable = false },
+				{ Name = "collected", Type = "bool", Nilable = false },
+			},
+		},
+	},
+
+	Predicates =
+	{
+	},
+};
+
+APIDocumentation:AddDocumentationTable(TransmogSets);