BarberShopDocumentation.lua 4.5 KB
Newer Older
TOM_RUS's avatar
TOM_RUS committed
1 2 3 4 5 6 7 8
local BarberShop =
{
	Name = "BarberShop",
	Type = "System",
	Namespace = "C_BarberShop",

	Functions =
	{
TOM_RUS's avatar
TOM_RUS committed
9 10 11 12 13 14 15 16 17 18 19 20 21
		{
			Name = "ApplyCustomizationChoices",
			Type = "Function",

			Returns =
			{
				{ Name = "success", Type = "bool", Nilable = false },
			},
		},
		{
			Name = "Cancel",
			Type = "Function",
		},
TOM_RUS's avatar
TOM_RUS committed
22 23 24 25
		{
			Name = "ClearPreviewChoices",
			Type = "Function",
		},
TOM_RUS's avatar
TOM_RUS committed
26 27 28 29 30 31 32 33 34
		{
			Name = "GetAvailableCustomizations",
			Type = "Function",

			Returns =
			{
				{ Name = "categories", Type = "table", InnerType = "CharCustomizationCategory", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
35 36 37 38 39 40 41 42 43
		{
			Name = "GetCurrentCameraZoom",
			Type = "Function",

			Returns =
			{
				{ Name = "zoomLevel", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
44 45 46 47 48 49 50 51 52
		{
			Name = "GetCurrentCharacterData",
			Type = "Function",

			Returns =
			{
				{ Name = "characterData", Type = "BarberShopCharacterData", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
53 54 55 56 57 58 59 60 61
		{
			Name = "GetCurrentCost",
			Type = "Function",

			Returns =
			{
				{ Name = "cost", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
62 63 64 65 66 67 68 69 70
		{
			Name = "HasAnyChanges",
			Type = "Function",

			Returns =
			{
				{ Name = "hasChanges", Type = "bool", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
71 72 73 74 75 76 77 78 79
		{
			Name = "IsViewingAlteredForm",
			Type = "Function",

			Returns =
			{
				{ Name = "isViewingAlteredForm", Type = "bool", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
80 81 82 83
		{
			Name = "OldBarberShopLoaded",
			Type = "Function",
		},
TOM_RUS's avatar
TOM_RUS committed
84 85 86 87 88 89 90 91 92 93
		{
			Name = "PreviewCustomizationChoice",
			Type = "Function",

			Arguments =
			{
				{ Name = "optionID", Type = "number", Nilable = false },
				{ Name = "choiceID", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
94 95 96 97
		{
			Name = "ResetCameraRotation",
			Type = "Function",
		},
TOM_RUS's avatar
TOM_RUS committed
98 99 100 101
		{
			Name = "ResetCustomizationChoices",
			Type = "Function",
		},
TOM_RUS's avatar
TOM_RUS committed
102 103 104 105 106 107 108 109 110
		{
			Name = "RotateCamera",
			Type = "Function",

			Arguments =
			{
				{ Name = "diffDegrees", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
111 112 113 114 115 116 117 118 119
		{
			Name = "SetCameraDistanceOffset",
			Type = "Function",

			Arguments =
			{
				{ Name = "offset", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
120 121 122 123 124 125 126 127 128 129
		{
			Name = "SetCameraZoomLevel",
			Type = "Function",

			Arguments =
			{
				{ Name = "zoomLevel", Type = "number", Nilable = false },
				{ Name = "keepCustomZoom", Type = "bool", Nilable = true },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
130 131 132 133 134 135 136 137 138 139
		{
			Name = "SetCustomizationChoice",
			Type = "Function",

			Arguments =
			{
				{ Name = "optionID", Type = "number", Nilable = false },
				{ Name = "choiceID", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
140 141 142 143 144 145 146 147 148
		{
			Name = "SetModelDressState",
			Type = "Function",

			Arguments =
			{
				{ Name = "dressedState", Type = "bool", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
149 150 151 152 153 154 155 156 157
		{
			Name = "SetSelectedSex",
			Type = "Function",

			Arguments =
			{
				{ Name = "sex", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
158 159 160 161 162 163 164 165 166
		{
			Name = "SetViewingAlteredForm",
			Type = "Function",

			Arguments =
			{
				{ Name = "isViewingAlteredForm", Type = "bool", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
167 168 169 170 171 172 173 174 175
		{
			Name = "SetViewingShapeshiftForm",
			Type = "Function",

			Arguments =
			{
				{ Name = "shapeshiftFormID", Type = "number", Nilable = true },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
176 177 178 179 180 181 182 183 184
		{
			Name = "ZoomCamera",
			Type = "Function",

			Arguments =
			{
				{ Name = "zoomAmount", Type = "number", Nilable = false },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
	},

	Events =
	{
		{
			Name = "BarberShopAppearanceApplied",
			Type = "Event",
			LiteralName = "BARBER_SHOP_APPEARANCE_APPLIED",
		},
		{
			Name = "BarberShopClose",
			Type = "Event",
			LiteralName = "BARBER_SHOP_CLOSE",
		},
		{
			Name = "BarberShopCostUpdate",
			Type = "Event",
			LiteralName = "BARBER_SHOP_COST_UPDATE",
		},
TOM_RUS's avatar
TOM_RUS committed
204 205 206 207 208
		{
			Name = "BarberShopForceCustomizationsUpdate",
			Type = "Event",
			LiteralName = "BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE",
		},
TOM_RUS's avatar
TOM_RUS committed
209 210 211 212 213 214
		{
			Name = "BarberShopOpen",
			Type = "Event",
			LiteralName = "BARBER_SHOP_OPEN",
		},
		{
TOM_RUS's avatar
TOM_RUS committed
215
			Name = "BarberShopResult",
TOM_RUS's avatar
TOM_RUS committed
216
			Type = "Event",
TOM_RUS's avatar
TOM_RUS committed
217 218 219 220 221
			LiteralName = "BARBER_SHOP_RESULT",
			Payload =
			{
				{ Name = "success", Type = "bool", Nilable = false },
			},
TOM_RUS's avatar
TOM_RUS committed
222 223 224 225 226
		},
	},

	Tables =
	{
TOM_RUS's avatar
TOM_RUS committed
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
		{
			Name = "BarberShopCharacterData",
			Type = "Structure",
			Fields =
			{
				{ Name = "raceData", Type = "BarberShopRaceData", Nilable = false },
				{ Name = "sex", Type = "number", Nilable = false },
			},
		},
		{
			Name = "BarberShopRaceData",
			Type = "Structure",
			Fields =
			{
				{ Name = "name", Type = "string", Nilable = false },
				{ Name = "fileName", Type = "string", Nilable = false },
				{ Name = "alternateFormRaceData", Type = "CharacterAlternateFormData", Nilable = true },
			},
		},
TOM_RUS's avatar
TOM_RUS committed
246 247 248 249
	},
};

APIDocumentation:AddDocumentationTable(BarberShop);