Files
SessionGoldTracker/docs/blizzard-api/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua
T
2026-10-15 14:27:00 +11:00

155 lines
6.1 KiB
Lua

local Tutorial =
{
Name = "Tutorial",
Type = "System",
Namespace = "C_Tutorial",
Environment = "All",
Functions =
{
{
Name = "AbandonTutorialArea",
Type = "Function",
},
{
Name = "GetCombatEventInfo",
Type = "Function",
RequireNPERestricted = true,
Returns =
{
},
},
{
Name = "ReturnToTutorialArea",
Type = "Function",
},
},
Events =
{
{
Name = "LeavingTutorialArea",
Type = "Event",
LiteralName = "LEAVING_TUTORIAL_AREA",
SynchronousEvent = true,
},
{
Name = "NpeTutorialUpdate",
Type = "Event",
LiteralName = "NPE_TUTORIAL_UPDATE",
SynchronousEvent = true,
},
{
Name = "TutorialCombatEvent",
Type = "Event",
LiteralName = "TUTORIAL_COMBAT_EVENT",
RequireNPERestricted = true,
SynchronousEvent = true,
},
{
Name = "TutorialHighlightSpell",
Type = "Event",
LiteralName = "TUTORIAL_HIGHLIGHT_SPELL",
SynchronousEvent = true,
Payload =
{
{ Name = "spellID", Type = "number", Nilable = false },
{ Name = "tutorialGlobalStringTag", Type = "cstring", Nilable = false },
},
},
{
Name = "TutorialTrigger",
Type = "Event",
LiteralName = "TUTORIAL_TRIGGER",
SynchronousEvent = true,
Payload =
{
{ Name = "tutorialIndex", Type = "number", Nilable = false },
{ Name = "forceShow", Type = "bool", Nilable = false },
},
},
{
Name = "TutorialUnhighlightSpell",
Type = "Event",
LiteralName = "TUTORIAL_UNHIGHLIGHT_SPELL",
SynchronousEvent = true,
},
},
Tables =
{
{
Name = "FrameTutorialAccount",
Type = "Enumeration",
NumValues = 51,
MinValue = 1,
MaxValue = 51,
Fields =
{
{ Name = "HudRevampBagChanges", Type = "FrameTutorialAccount", EnumValue = 1 },
{ Name = "PerksProgramActivitiesIntro", Type = "FrameTutorialAccount", EnumValue = 2 },
{ Name = "EditModeManager", Type = "FrameTutorialAccount", EnumValue = 3 },
{ Name = "TransmogSetsTab", Type = "FrameTutorialAccount", EnumValue = 4 },
{ Name = "MountCollectionDragonriding", Type = "FrameTutorialAccount", EnumValue = 5 },
{ Name = "LFGList", Type = "FrameTutorialAccount", EnumValue = 6 },
{ Name = "HeirloomJournalLevel", Type = "FrameTutorialAccount", EnumValue = 7 },
{ Name = "TimerunnersAdvantage", Type = "FrameTutorialAccount", EnumValue = 8 },
{ Name = "AccountWideReputation", Type = "FrameTutorialAccount", EnumValue = 9 },
{ Name = "TransferableCurrencies", Type = "FrameTutorialAccount", EnumValue = 10 },
{ Name = "BindToAccountUntilEquip", Type = "FrameTutorialAccount", EnumValue = 11 },
{ Name = "CompletedQuestsFilter", Type = "FrameTutorialAccount", EnumValue = 12 },
{ Name = "CompletedQuestsFilterSeen", Type = "FrameTutorialAccount", EnumValue = 13 },
{ Name = "ConcentrationCurrency", Type = "FrameTutorialAccount", EnumValue = 14 },
{ Name = "MapLegendOpened", Type = "FrameTutorialAccount", EnumValue = 15 },
{ Name = "NpcCraftingOrders", Type = "FrameTutorialAccount", EnumValue = 16 },
{ Name = "NpcCraftingOrderCreateButton", Type = "FrameTutorialAccount", EnumValue = 17 },
{ Name = "NpcCraftingOrderTabNew", Type = "FrameTutorialAccount", EnumValue = 18 },
{ Name = "LocalStoriesFilterSeen", Type = "FrameTutorialAccount", EnumValue = 19 },
{ Name = "EventSchedulerTabSeen", Type = "FrameTutorialAccount", EnumValue = 20 },
{ Name = "AssistedCombatRotationDragSpell", Type = "FrameTutorialAccount", EnumValue = 21 },
{ Name = "AssistedCombatRotationActionButton", Type = "FrameTutorialAccount", EnumValue = 22 },
{ Name = "HousingDecorCleanup", Type = "FrameTutorialAccount", EnumValue = 23 },
{ Name = "HousingDecorPlace", Type = "FrameTutorialAccount", EnumValue = 24 },
{ Name = "HousingDecorClippingGrid", Type = "FrameTutorialAccount", EnumValue = 25 },
{ Name = "HousingDecorCustomization", Type = "FrameTutorialAccount", EnumValue = 26 },
{ Name = "HousingDecorLayout", Type = "FrameTutorialAccount", EnumValue = 27 },
{ Name = "HousingHouseFinderMap", Type = "FrameTutorialAccount", EnumValue = 28 },
{ Name = "HousingHouseFinderVisitHouse", Type = "FrameTutorialAccount", EnumValue = 29 },
{ Name = "HousingItemAcquisition", Type = "FrameTutorialAccount", EnumValue = 30 },
{ Name = "HousingNewPip", Type = "FrameTutorialAccount", EnumValue = 31 },
{ Name = "PerksProgramActivitiesOpen", Type = "FrameTutorialAccount", EnumValue = 32 },
{ Name = "EnconterJournalTutorialsTabSeen", Type = "FrameTutorialAccount", EnumValue = 33 },
{ Name = "HousingMarketTab", Type = "FrameTutorialAccount", EnumValue = 34 },
{ Name = "HousingTeleportButton", Type = "FrameTutorialAccount", EnumValue = 35 },
{ Name = "RPETalentStarterBuild", Type = "FrameTutorialAccount", EnumValue = 36 },
{ Name = "HousingInvalidCollision", Type = "FrameTutorialAccount", EnumValue = 37 },
{ Name = "HousingModesUnlocked", Type = "FrameTutorialAccount", EnumValue = 38 },
{ Name = "HousingExpertMode", Type = "FrameTutorialAccount", EnumValue = 39 },
{ Name = "HousingCleanupMode", Type = "FrameTutorialAccount", EnumValue = 40 },
{ Name = "TransmogOutfits", Type = "FrameTutorialAccount", EnumValue = 41 },
{ Name = "TransmogSets", Type = "FrameTutorialAccount", EnumValue = 42 },
{ Name = "TransmogCustomSets", Type = "FrameTutorialAccount", EnumValue = 43 },
{ Name = "TransmogSituations", Type = "FrameTutorialAccount", EnumValue = 44 },
{ Name = "TransmogWeaponOptions", Type = "FrameTutorialAccount", EnumValue = 45 },
{ Name = "TransmogTrialOfStyle", Type = "FrameTutorialAccount", EnumValue = 46 },
{ Name = "TransmogCustomSetsMigration", Type = "FrameTutorialAccount", EnumValue = 47 },
{ Name = "HousingEndeavorsTabSeen", Type = "FrameTutorialAccount", EnumValue = 48 },
{ Name = "RunesOfPower", Type = "FrameTutorialAccount", EnumValue = 49 },
{ Name = "HousingPetBeds", Type = "FrameTutorialAccount", EnumValue = 50 },
{ Name = "Reserved1", Type = "FrameTutorialAccount", EnumValue = 51 },
},
},
},
Predicates =
{
{
Name = "RequireNPERestricted",
Type = "Precondition",
FailureMode = "ReturnNothing",
},
},
};
APIDocumentation:AddDocumentationTable(Tutorial);