CovenantsDocumentation.lua 1.31 KB
Newer Older
TOM_RUS's avatar
TOM_RUS committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
local Covenants =
{
	Name = "Covenant",
	Type = "System",
	Namespace = "C_Covenants",

	Functions =
	{
		{
			Name = "GetActiveCovenantID",
			Type = "Function",

			Returns =
			{
				{ Name = "covenantID", Type = "number", Nilable = false },
			},
		},
		{
			Name = "GetCovenantData",
			Type = "Function",

			Arguments =
			{
				{ Name = "covenantID", Type = "number", Nilable = false },
			},

			Returns =
			{
TOM_RUS's avatar
TOM_RUS committed
29
				{ Name = "data", Type = "CovenantData", Nilable = true },
TOM_RUS's avatar
TOM_RUS committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
			},
		},
		{
			Name = "GetCovenantIDs",
			Type = "Function",

			Returns =
			{
				{ Name = "covenantID", Type = "table", InnerType = "number", Nilable = false },
			},
		},
	},

	Events =
	{
TOM_RUS's avatar
TOM_RUS committed
45 46 47 48 49 50 51 52 53
		{
			Name = "CovenantChosen",
			Type = "Event",
			LiteralName = "COVENANT_CHOSEN",
			Payload =
			{
				{ Name = "covenantID", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
54 55 56 57 58 59 60 61 62 63 64
	},

	Tables =
	{
		{
			Name = "CovenantData",
			Type = "Structure",
			Fields =
			{
				{ Name = "ID", Type = "number", Nilable = false },
				{ Name = "textureKit", Type = "string", Nilable = false },
TOM_RUS's avatar
TOM_RUS committed
65
				{ Name = "celebrationSoundKit", Type = "number", Nilable = false },
TOM_RUS's avatar
TOM_RUS committed
66 67 68 69 70 71 72 73
				{ Name = "name", Type = "string", Nilable = false },
				{ Name = "soulbindIDs", Type = "table", InnerType = "number", Nilable = false },
			},
		},
	},
};

APIDocumentation:AddDocumentationTable(Covenants);