From 9a30efa170e4a62dcbf18e88151582ea6e00c304 Mon Sep 17 00:00:00 2001 From: bepis Date: Thu, 15 Oct 2026 14:27:00 +1100 Subject: [PATCH] First commit, step 4 completed --- .continue/rules/wow.md | 13 + .continueignore | 8 + .wowluarc.json | 11 + NOTES.md | 48 + STATUS.md | 54 + SessionGoldTracker.lua | 197 + SessionGoldTracker.toc | 8 + SessionGoldTracker_Camelot.toc | 8 + .../AccountInfoDocumentation.lua | 17 + .../AccountStoreDocumentation.lua | 85 + .../AchievementInfoDocumentation.lua | 30 + .../AchievementTelemetryDocumentation.lua | 13 + .../ActionBarFrameDocumentation.lua | 359 + .../ActionBarSharedDocumentation.lua | 5 + .../AddOnProfilerDocumentation.lua | 96 + .../AddOnsDocumentation.lua | 161 + .../AdventureMapDocumentation.lua | 18 + .../AlliedRacesFrameDocumentation.lua | 30 + .../AnimaDiversionUIDocumentation.lua | 48 + .../AppearanceSourceDocumentation.lua | 20 + .../ArdenwealdGardeningDocumentation.lua | 15 + .../AreaPoiInfoDocumentation.lua | 78 + .../ArenaTeamDocumentation.lua | 29 + .../ArtifactUIDocumentation.lua | 432 + .../AssistedCombatDocumentation.lua | 20 + .../AuctionHouseDocumentation.lua | 567 + .../AutoCompleteDocumentation.lua | 33 + .../AzeriteEmpoweredItemDocumentation.lua | 112 + .../AzeriteEssenceDocumentation.lua | 110 + .../AzeriteItemDocumentation.lua | 53 + .../BNetOutageDocumentation.lua | 6 + .../BankDocumentation.lua | 131 + .../BarberShopDocumentation.lua | 118 + .../BarberShopInternalDocumentation.lua | 6 + .../BaseDocumentation.lua | 2 + .../BattleNetDocumentation.lua | 115 + .../BehavioralMessagingDocumentation.lua | 8 + .../BountySharedDocumentation.lua | 7 + .../BuildDocumentation.lua | 51 + .../CVarDocumentation.lua | 64 + .../CalendarDocumentation.lua | 507 + .../CameraDocumentation.lua | 20 + .../CatalogShopDocumentation.lua | 322 + .../ChallengeModeInfoDocumentation.lua | 194 + ...racterCustomizationSharedDocumentation.lua | 37 + .../ChatBubblesDocumentation.lua | 7 + .../ChatConstantsDocumentation.lua | 8 + .../ChatInfoDocumentation.lua | 260 + .../ChatSharedDocumentation.lua | 6 + .../ChromieTimeUIDocumentation.lua | 29 + .../CinematicDocumentation.lua | 30 + .../CinematicListDocumentation.lua | 15 + .../ClassColorDocumentation.lua | 7 + .../ClassTalentsDocumentation.lua | 189 + .../ClickBindingsConstantsDocumentation.lua | 6 + .../ClickBindingsDocumentation.lua | 52 + .../ClientDocumentation.lua | 38 + .../ClubDocumentation.lua | 661 + .../ClubFinderDocumentation.lua | 315 + .../ColorOverridesDocumentation.lua | 34 + .../ColorUtilDocumentation.lua | 69 + .../CombatAudioAlertDocumentation.lua | 88 + .../CombatLogDocumentation.lua | 46 + .../CombatLogInternalDocumentation.lua | 5 + .../CombatLogSecureDocumentation.lua | 41 + .../CombatLogSharedDocumentation.lua | 2 + .../CombatTextDocumentation.lua | 13 + .../CombatTextSharedDocumentation.lua | 2 + .../CommentatorFrameDocumentation.lua | 782 ++ .../ConnectionDocumentation.lua | 45 + .../ConsoleDocumentation.lua | 56 + .../ConsoleScriptCollectionDocumentation.lua | 42 + .../ContainerDocumentation.lua | 279 + .../ContentTrackingDocumentation.lua | 114 + .../ContentTrackingTypesDocumentation.lua | 25 + .../ContributionCollectorDocumentation.lua | 110 + .../CooldownViewerDocumentation.lua | 44 + .../CovenantCallingsDocumentation.lua | 9 + .../CovenantPreviewDocumentation.lua | 39 + .../CovenantSanctumDocumentation.lua | 93 + .../CovenantsDocumentation.lua | 32 + .../CraftingOrderUIDocumentation.lua | 174 + .../CraftingOrderUISharedDocumentation.lua | 144 + .../CreatureInfoDocumentation.lua | 63 + .../CurrencyInfoDocumentation.lua | 282 + .../CursorDocumentation.lua | 6 + .../CurveUtilDocumentation.lua | 38 + .../DamageMeterDocumentation.lua | 112 + .../DateAndTimeDocumentation.lua | 51 + .../DeathInfoDocumentation.lua | 42 + .../DeathRecapDocumentation.lua | 26 + .../DebugToggleDocumentation.lua | 28 + .../DelvesConstantsDocumentation.lua | 7 + .../DelvesUIDocumentation.lua | 178 + .../DurationUtilDocumentation.lua | 14 + .../DyeColorInfoDocumentation.lua | 44 + .../DyeColorInfoSharedDocumentation.lua | 14 + .../EditModeManagerDocumentation.lua | 79 + .../EncodingUtilDocumentation.lua | 65 + .../EncounterEventsDocumentation.lua | 60 + .../EncounterEventsSharedDocumentation.lua | 14 + .../EncounterJournalDocumentation.lua | 139 + .../EncounterTimelineDocumentation.lua | 256 + .../EncounterWarningsDocumentation.lua | 70 + .../EndOfMatchUIDocumentation.lua | 15 + .../EquipmentManagerDocumentation.lua | 116 + .../EventSchedulerUIDocumentation.lua | 91 + .../EventUtilsDocumentation.lua | 12 + .../ExpansionDocumentation.lua | 114 + .../ExpansionInfoDocumentation.lua | 14 + .../ExpansionTrialDocumentation.lua | 8 + .../ExternalEventURLDocumentation.lua | 13 + .../FogOfWarDocumentation.lua | 18 + .../FontDocumentation.lua | 34 + .../FrameScriptDocumentation.lua | 203 + .../FriendListDocumentation.lua | 162 + .../GameCursorDocumentation.lua | 72 + .../GameErrorDocumentation.lua | 10 + .../GamePadDocumentation.lua | 172 + .../GameRulesDocumentation.lua | 115 + .../GameUIDocumentation.lua | 8 + .../GarrisonInfoDocumentation.lua | 398 + .../GarrisonSharedDocumentation.lua | 66 + .../GlueDocumentation.lua | 10 + .../GossipInfoDocumentation.lua | 150 + .../GuildBankDocumentation.lua | 6 + .../GuildInfoDocumentation.lua | 175 + .../GuildInfoSharedDocumentation.lua | 7 + .../HeirloomInfoDocumentation.lua | 30 + .../HouseEditorUIDocumentation.lua | 54 + .../HouseExteriorConstantsDocumentation.lua | 40 + .../HouseExteriorUIDocumentation.lua | 98 + .../HousingBasicModeUIDocumentation.lua | 114 + .../HousingCatalogConstantsDocumentation.lua | 20 + .../HousingCatalogUIDocumentation.lua | 255 + .../HousingCleanupModeUIDocumentation.lua | 13 + .../HousingCustomizeModeUIDocumentation.lua | 202 + .../HousingDecorSharedDocumentation.lua | 22 + .../HousingDecorUIDocumentation.lua | 156 + .../HousingExpertModeUIDocumentation.lua | 103 + .../HousingInspectModeUIDocumentation.lua | 30 + .../HousingLayoutUIDocumentation.lua | 173 + .../HousingLayoutUITypesDocumentation.lua | 13 + .../HousingNeighborhoodUIDocumentation.lua | 156 + .../HousingPhotoSharingUIDocumentation.lua | 40 + .../HousingUIDocumentation.lua | 234 + .../HousingUISharedDocumentation.lua | 75 + ...mersiveInteractionManagerDocumentation.lua | 6 + .../InGameNavigationDocumentation.lua | 26 + .../IncomingSummonDocumentation.lua | 12 + .../InputDocumentation.lua | 125 + .../InstanceDocumentation.lua | 131 + .../InstanceEncounterDocumentation.lua | 18 + .../InstanceLeaverInfoDocumentation.lua | 8 + .../InterfaceFileManifestDocumentation.lua | 6 + .../InvasionInfoDocumentation.lua | 30 + .../IslandsQueueUIDocumentation.lua | 29 + .../ItemConstants_SharedDocumentation.lua | 2 + .../ItemDocumentation.lua | 658 + .../ItemInteractionUIDocumentation.lua | 65 + .../ItemSocketInfoDocumentation.lua | 85 + .../ItemUpgradeDocumentation.lua | 127 + .../KeyBindingsDocumentation.lua | 56 + .../LFGConstantsDocumentation.lua | 5 + .../LFGInfoDocumentation.lua | 111 + .../LFGListInfoDocumentation.lua | 415 + .../LegendaryCraftingDocumentation.lua | 111 + .../LegendaryCraftingTypesDocumentation.lua | 32 + .../LevelLinkDocumentation.lua | 12 + .../LevelSquishDocumentation.lua | 13 + .../LimitedInputDocumentation.lua | 7 + .../LiveEventDocumentation.lua | 10 + .../LobbyMatchmakerInfoDocumentation.lua | 39 + .../LocaleDocumentation.lua | 26 + .../LocalizationDocumentation.lua | 64 + .../LocalizationSharedDocumentation.lua | 7 + .../LogDocumentation.lua | 19 + .../LootDocumentation.lua | 11 + .../LootHistoryDocumentation.lua | 57 + .../LootJournalDocumentation.lua | 23 + .../LoreTextDocumentation.lua | 10 + .../LossOfControlDocumentation.lua | 41 + .../LuaTableUtilDocumentation.lua | 36 + .../MacOptionsDocumentation.lua | 40 + .../MailInfoDocumentation.lua | 25 + .../MajorFactionsDocumentation.lua | 119 + .../MapDocumentation.lua | 277 + .../MapExplorationDocumentation.lua | 29 + .../MerchantFrameDocumentation.lua | 41 + .../MinimapDocumentation.lua | 124 + .../MirrorTimerDocumentation.lua | 25 + .../MountJournalDocumentation.lua | 291 + .../MovieDocumentation.lua | 30 + .../MythicPlusInfoDocumentation.lua | 149 + .../MythicPlusInfoSharedDocumentation.lua | 22 + .../NamePlateDocumentation.lua | 22 + .../NamePlateManagerDocumentation.lua | 36 + .../NeighborhoodInitiativeDocumentation.lua | 138 + .../NewItemsDocumentation.lua | 16 + ...umericRuleFormatterSharedDocumentation.lua | 15 + .../OsDocumentation.lua | 10 + .../PaperDollInfoDocumentation.lua | 98 + .../ParentalControlsDocumentation.lua | 4 + .../PartyInfoDocumentation.lua | 240 + .../PartyPoseUIDocumentation.lua | 34 + .../PerformanceDocumentation.lua | 26 + .../PerksActivitiesDocumentation.lua | 90 + .../PerksProgramDocumentation.lua | 156 + .../PerksVendorConstantsDocumentation.lua | 8 + .../PetBattlesDocumentation.lua | 29 + .../PetInfoDocumentation.lua | 41 + .../PetJournalInfoDocumentation.lua | 143 + .../PhotoSharingUIDocumentation.lua | 44 + .../PingConstantsDocumentation.lua | 13 + .../PingManagerDocumentation.lua | 33 + .../PingManagerSecureDocumentation.lua | 82 + .../PlayerChoiceDocumentation.lua | 96 + .../PlayerInfoDocumentation.lua | 153 + .../PlayerInfoSharedDocumentation.lua | 13 + .../PlayerInteractionManagerDocumentation.lua | 34 + .../PlayerLocationDocumentation.lua | 39 + .../PlayerMentorshipDocumentation.lua | 25 + .../PlayerScriptDocumentation.lua | 714 + .../PortraitDocumentation.lua | 5 + .../ProfessionSpecConstantsDocumentation.lua | 22 + .../ProfessionSpecUIDocumentation.lua | 138 + .../PvpInfoDocumentation.lua | 738 ++ .../QuestHubInfoDocumentation.lua | 8 + .../QuestInfoSharedDocumentation.lua | 15 + .../QuestInfoSystemDocumentation.lua | 45 + .../QuestItemUseDocumentation.lua | 9 + .../QuestLineInfoDocumentation.lua | 60 + .../QuestLogDocumentation.lua | 525 + .../QuestOfferDocumentation.lua | 28 + .../QuestRewardsDocumentation.lua | 25 + .../QuestSessionDocumentation.lua | 61 + .../QuestTaskInfoDocumentation.lua | 66 + .../QueueSpecificDocumentation.lua | 12 + .../RaidLocksDocumentation.lua | 19 + .../RaidMarkersDocumentation.lua | 38 + .../RecentAlliesDocumentation.lua | 100 + .../RecruitAFriendDocumentation.lua | 170 + .../RemixArtifactUIDocumentation.lua | 61 + .../ReportSystemDocumentation.lua | 59 + .../ReputationInfoDocumentation.lua | 141 + .../ResearchInfoDocumentation.lua | 14 + .../RestrictedActionsDocumentation.lua | 28 + .../ReturningPlayerUIDocumentation.lua | 8 + .../ScenarioInfoDocumentation.lua | 99 + .../ScrappingMachineUIDocumentation.lua | 42 + .../ScreenDocumentation.lua | 21 + .../ScriptedAnimationsDocumentation.lua | 35 + .../SeasonInfoDocumentation.lua | 10 + .../SecretPredicateAPIDocumentation.lua | 199 + .../SecureTransferDocumentation.lua | 45 + .../SettingsUtilDocumentation.lua | 10 + ...redScriptObjectModelLightDocumentation.lua | 8 + .../SharedTraitsDocumentation.lua | 416 + .../SimpleHTMLSharedDocumentation.lua | 5 + .../SlashCommandDocumentation.lua | 8 + .../SocialQueueDocumentation.lua | 101 + .../SocialRestrictionsDocumentation.lua | 37 + .../SoulbindsDocumentation.lua | 247 + .../SoundDocumentation.lua | 42 + .../SpecializationInfoDocumentation.lua | 216 + .../SpecializationSharedDocumentation.lua | 50 + .../SpellActivationOverlayDocumentation.lua | 7 + .../SpellBookDocumentation.lua | 360 + .../SpellDiminishUIDocumentation.lua | 34 + .../SpellDocumentation.lua | 424 + .../SpellSharedDocumentation.lua | 35 + .../SplashScreenDocumentation.lua | 37 + .../StableInfoDocumentation.lua | 85 + .../StorePublicUIDocumentation.lua | 16 + .../StreamingDocumentation.lua | 16 + .../StringUtilDocumentation.lua | 105 + .../SummonInfoDocumentation.lua | 28 + .../SuperTrackManagerDocumentation.lua | 91 + .../SystemDocumentation.lua | 6 + .../SystemTimeDocumentation.lua | 30 + .../TTSSettingsDocumentation.lua | 89 + .../TargetScriptDocumentation.lua | 88 + .../TaxiMapDocumentation.lua | 41 + .../TextureUtilsDocumentation.lua | 75 + .../ThreatDocumentation.lua | 11 + .../TimeDocumentation.lua | 8 + .../TimerunningUIDocumentation.lua | 6 + .../TitleDocumentation.lua | 23 + .../TooltipComparisonDocumentation.lua | 26 + .../TooltipInfoDocumentation.lua | 484 + .../TooltipInfoSharedDocumentation.lua | 13 + .../TotemDocumentation.lua | 47 + .../ToyBoxInfoDocumentation.lua | 23 + .../TradeInfoDocumentation.lua | 21 + .../TradeSkillUIDocumentation.lua | 470 + .../TradeSkillUITypesDocumentation.lua | 214 + .../TransmogDocumentation.lua | 67 + .../TransmogItemsDocumentation.lua | 478 + .../TransmogOutfitInfoDocumentation.lua | 386 + .../TransmogSetsDocumentation.lua | 215 + .../TutorialDocumentation.lua | 11 + .../UIButtonSharedDocumentation.lua | 7 + .../UIColorDocumentation.lua | 6 + .../UIColorSharedDocumentation.lua | 4 + .../UIEventToastManagerDocumentation.lua | 41 + .../UIFrameManagerDocumentation.lua | 7 + .../UIGenericWidgetDisplayDocumentation.lua | 17 + .../UIMacrosDocumentation.lua | 23 + .../UIManagerDocumentation.lua | 43 + .../UIMapPinSharedDocumentation.lua | 6 + .../UIModelInfoDocumentation.lua | 90 + .../UIModifiedInstanceDocumentation.lua | 15 + .../UISharedDocumentation.lua | 13 + ...UISystemVisibilityManagerDocumentation.lua | 7 + .../UITextureConstantsDocumentation.lua | 7 + .../UITimerDocumentation.lua | 25 + .../UIWidgetManagerDocumentation.lua | 981 ++ .../URLDocumentation.lua | 9 + .../UnitAuraDocumentation.lua | 202 + .../UnitConstantsDocumentation.lua | 41 + .../UnitDocumentation.lua | 1292 ++ ...redictionCalculatorSharedDocumentation.lua | 22 + .../UnitRoleDocumentation.lua | 33 + .../UserFeedbackDocumentation.lua | 13 + .../VideoDocumentation.lua | 35 + .../VignetteInfoDocumentation.lua | 55 + .../VoiceChatDocumentation.lua | 394 + .../WarCampaignDocumentation.lua | 71 + .../WarbandSceneInfoDocumentation.lua | 46 + .../WeeklyRewardsDocumentation.lua | 140 + .../WorldLootObjectDocumentation.lua | 48 + .../WorldSafeLocsUIInternalDocumentation.lua | 12 + .../WowSurveyDocumentation.lua | 9 + .../WowTokenUIDocumentation.lua | 6 + .../XMLUtilDocumentation.lua | 29 + .../ZoneAbilityDocumentation.lua | 18 + .../ZoneScriptDocumentation.lua | 21 + .../Annotations/Core/Data/CVar.lua | 1626 +++ .../Annotations/Core/Data/Classic.lua | 9 + .../Annotations/Core/Data/Enum.lua | 10962 ++++++++++++++++ .../Annotations/Core/Data/Event.lua | 1741 +++ .../Annotations/Core/Data/Wiki.lua | 9095 +++++++++++++ .../Blizzard_Deprecated/Deprecated_11_0_5.lua | 42 + .../Blizzard_Deprecated/Deprecated_11_0_7.lua | 18 + .../Blizzard_Deprecated/Deprecated_11_1_5.lua | 12 + .../Blizzard_Deprecated/Deprecated_11_1_7.lua | 11 + .../Blizzard_Deprecated/Deprecated_11_2_0.lua | 12 + .../Deprecated_ChatInfo.lua | 9 + .../Deprecated_CurrencyScript.lua | 21 + .../Deprecated_GuildScript.lua | 39 + .../Deprecated_ItemScript.lua | 307 + .../Deprecated_PvpScript.lua | 22 + .../Deprecated_SoundScript.lua | 6 + .../Deprecated_Specialization_Standard.lua | 66 + .../Deprecated_SpellBook.lua.lua | 21 + .../Deprecated_SpellScript.lua | 22 + .../Deprecated_UnitScript.lua | 7 + .../FrameXML/Blizzard_FrameXML/AuraUtil.lua | 50 + .../Core/FrameXML/Blizzard_FrameXML/BNet.lua | 8 + .../FrameXML/Blizzard_FrameXML/ItemUtil.lua | 25 + .../Blizzard_FrameXML/ReportFrame.lua | 41 + .../Blizzard_FrameXML/TransmogUtil.lua | 58 + .../FrameXML/Blizzard_FrameXML/UIParent.lua | 52 + .../Core/FrameXML/Blizzard_Menu/Menu.lua | 37 + .../Core/FrameXML/Blizzard_Menu/MenuTypes.lua | 24 + .../Core/FrameXML/Blizzard_Menu/MenuUtil.lua | 172 + .../Proxies/ElementMenuDescriptionProxy.lua | 118 + .../Proxies/MenuManagerProxy.lua | 41 + .../Blizzard_Menu/Proxies/MenuProxy.lua | 38 + .../Proxies/RootMenuDescriptionProxy.lua | 21 + .../Proxies/SharedMenuDescriptionProxy.lua | 139 + .../Blizzard_NamePlates.lua | 38 + .../ContinuableContainer.lua | 28 + .../Core/FrameXML/Blizzard_ObjectAPI/Item.lua | 109 + .../Blizzard_ObjectAPI/ItemLocation.lua | 66 + .../Blizzard_ObjectAPI/PlayerLocation.lua | 158 + .../FrameXML/Blizzard_ObjectAPI/Spell.lua | 42 + .../FrameXML/Blizzard_SharedXML/Backdrop.lua | 85 + .../Blizzard_SharedXML/CallbackRegistry.lua | 38 + .../FrameXML/Blizzard_SharedXML/Color.lua | 88 + .../FrameXML/Blizzard_SharedXML/ColorUtil.lua | 44 + .../FrameXML/Blizzard_SharedXML/CvarUtil.lua | 62 + .../Core/FrameXML/Blizzard_SharedXML/Dump.lua | 5 + .../Blizzard_SharedXML/FormattingUtil.lua | 72 + .../GlobalCallbackRegistry.lua | 29 + .../FrameXML/Blizzard_SharedXML/Mixin.lua | 38 + .../FrameXML/Blizzard_SharedXML/TableUtil.lua | 233 + .../Blizzard_SharedXML/TextureUtil.lua | 148 + .../FrameXML/Blizzard_SharedXML/TimeUtil.lua | 50 + .../FrameXML/Blizzard_SharedXML/Vector2D.lua | 84 + .../FrameXML/Blizzard_SharedXML/Vector3D.lua | 80 + .../Core/Libraries/Ace3/AceAddon-3.0.lua | 192 + .../Core/Libraries/Ace3/AceBucket-3.0.lua | 31 + .../Core/Libraries/Ace3/AceComm-3.0.lua | 54 + .../Ace3/AceConfig-3.0/AceConfig-3.0.lua | 75 + .../Ace3/AceConfig-3.0/AceConfigCmd-3.0.lua | 31 + .../AceConfig-3.0/AceConfigDialog-3.0.lua | 57 + .../AceConfig-3.0/AceConfigRegistry-3.0.lua | 57 + .../Core/Libraries/Ace3/AceConsole-3.0.lua | 58 + .../Core/Libraries/Ace3/AceDB-3.0.lua | 148 + .../Core/Libraries/Ace3/AceDBOptions-3.0.lua | 23 + .../Core/Libraries/Ace3/AceEvent-3.0.lua | 55 + .../Libraries/Ace3/AceGUI-3.0/AceGUI-3.0.lua | 229 + .../AceGUIContainer-BlizOptionsGroup.lua | 31 + .../widgets/AceGUIContainer-DropDownGroup.lua | 48 + .../widgets/AceGUIContainer-Frame.lua | 48 + .../widgets/AceGUIContainer-InlineGroup.lua | 21 + .../widgets/AceGUIContainer-ScrollFrame.lua | 38 + .../widgets/AceGUIContainer-SimpleGroup.lua | 16 + .../widgets/AceGUIContainer-TabGroup.lua | 57 + .../widgets/AceGUIContainer-TreeGroup.lua | 101 + .../widgets/AceGUIContainer-Window.lua | 31 + .../widgets/AceGUIWidget-Button.lua | 16 + .../widgets/AceGUIWidget-CheckBox.lua | 44 + .../widgets/AceGUIWidget-ColorPicker.lua | 24 + .../widgets/AceGUIWidget-DropDown.lua | 61 + .../widgets/AceGUIWidget-EditBox.lua | 40 + .../widgets/AceGUIWidget-Heading.lua | 10 + .../AceGUI-3.0/widgets/AceGUIWidget-Icon.lua | 22 + .../widgets/AceGUIWidget-InteractiveLabel.lua | 51 + .../widgets/AceGUIWidget-Keybinding.lua | 23 + .../AceGUI-3.0/widgets/AceGUIWidget-Label.lua | 41 + .../widgets/AceGUIWidget-MultiLineEditBox.lua | 55 + .../widgets/AceGUIWidget-Slider.lua | 35 + .../Core/Libraries/Ace3/AceHook-3.0.lua | 152 + .../Core/Libraries/Ace3/AceLocale-3.0.lua | 32 + .../Core/Libraries/Ace3/AceSerializer-3.0.lua | 16 + .../Core/Libraries/Ace3/AceTab-3.0.lua | 35 + .../Core/Libraries/Ace3/AceTimer-3.0.lua | 37 + .../CallbackHandler-1.0.lua | 27 + .../ChatThrottleLib/ChatThrottleLib.lua | 50 + .../HereBeDragons-2.0/HereBeDragons-2.0.lua | 164 + .../HereBeDragons-Pins-2.0.lua | 99 + .../Libraries/LibDBIcon-1.0/LibDBIcon-1.0.lua | 111 + .../LibDataBroker-1.1/LibDataBroker-1.1.lua | 91 + .../Core/Libraries/LibDeflate/LibDeflate.lua | 192 + .../Libraries/LibDialog-1.0/LibDialog-1.0.lua | 154 + .../LibDualSpec-1.0/LibDualSpec-1.0.lua | 11 + .../Libraries/LibQTip-1.0/LibQTip-1.0.lua | 307 + .../LibSharedMedia-3.0/LibSharedMedia-3.0.lua | 74 + .../Libraries/LibSink-2.0/LibSink-2.0.lua | 45 + .../Core/Libraries/LibStub/LibStub.lua | 29 + .../LibTextDump-1.0/LibTextDump-1.0.lua | 54 + .../Annotations/Core/Lua/basic.lua | 371 + docs/annotations/Annotations/Core/Lua/bit.lua | 57 + .../Annotations/Core/Lua/compat.lua | 64 + .../annotations/Annotations/Core/Lua/math.lua | 312 + docs/annotations/Annotations/Core/Lua/os.lua | 148 + .../Annotations/Core/Lua/string.lua | 242 + .../Annotations/Core/Lua/table.lua | 131 + .../Core/ScriptObject/AbbreviateConfig.lua | 12 + .../Core/ScriptObject/ColorCurveObject.lua | 79 + .../Core/ScriptObject/CurveObject.lua | 65 + .../Core/ScriptObject/CurveObjectBase.lua | 22 + .../Core/ScriptObject/DurationObject.lua | 154 + .../ScriptObject/HousingCatalogSearcher.lua | 227 + .../ScriptObject/HousingFixturePointFrame.lua | 25 + .../ScriptObject/HousingLayoutPinFrame.lua | 69 + .../UnitHealPredictionCalculator.lua | 218 + .../Annotations/Core/Type/BlizzardType.lua | 63 + .../Annotations/Core/Type/EmoteToken.lua | 265 + .../Core/Type/FunctionContainer.lua | 11 + .../Annotations/Core/Type/GlobalColors.lua | 282 + .../Annotations/Core/Type/Mixin.lua | 12 + .../Annotations/Core/Type/Namespace.lua | 25 + .../Annotations/Core/Type/StringEnum.lua | 113 + .../Annotations/Core/Type/Structure.lua | 64 + .../Annotations/Core/Type/UnitToken.lua | 29 + .../Core/Widget/Animation/Alpha.lua | 23 + .../Core/Widget/Animation/Animation.lua | 165 + .../Core/Widget/Animation/AnimationGroup.lua | 131 + .../Core/Widget/Animation/ControlPoint.lua | 33 + .../Core/Widget/Animation/FlipBook.lua | 46 + .../Core/Widget/Animation/Path.lua | 29 + .../Core/Widget/Animation/Rotation.lua | 34 + .../Core/Widget/Animation/Scale.lua | 49 + .../Animation/TextureCoordTranslation.lua | 16 + .../Core/Widget/Animation/Translation.lua | 20 + .../Core/Widget/Animation/VertexColor.lua | 23 + .../Core/Widget/Base/AnimatableObject.lua | 17 + .../Annotations/Core/Widget/Base/Blob.lua | 59 + .../Core/Widget/Base/CharacterModelBase.lua | 111 + .../Core/Widget/Base/FrameScriptObject.lua | 50 + .../Core/Widget/Base/ModelSceneActorBase.lua | 227 + .../Annotations/Core/Widget/Base/Object.lua | 24 + .../Annotations/Core/Widget/Base/Region.lua | 81 + .../Core/Widget/Base/ScriptRegion.lua | 228 + .../Core/Widget/Base/ScriptRegionResizing.lua | 77 + .../Core/Widget/Base/TabardModelBase.lua | 30 + .../Core/Widget/Base/TextureBase.lua | 204 + .../Annotations/Core/Widget/Font/Font.lua | 123 + .../Core/Widget/Font/FontString.lua | 245 + .../Core/Widget/Frame/Button/Button.lua | 199 + .../Core/Widget/Frame/Button/CheckButton.lua | 30 + .../Core/Widget/Frame/ColorSelect.lua | 113 + .../Core/Widget/Frame/Cooldown.lua | 227 + .../Annotations/Core/Widget/Frame/EditBox.lua | 368 + .../Core/Widget/Frame/FogOfWarFrame.lua | 79 + .../Annotations/Core/Widget/Frame/Frame.lua | 555 + .../Core/Widget/Frame/GameTooltip.lua | 458 + .../Core/Widget/Frame/MessageFrame.lua | 162 + .../Annotations/Core/Widget/Frame/Minimap.lua | 112 + .../Widget/Frame/Model/CinematicModel.lua | 110 + .../Core/Widget/Frame/Model/DressUpModel.lua | 118 + .../Core/Widget/Frame/Model/Model.lua | 322 + .../Core/Widget/Frame/Model/PlayerModel.lua | 4 + .../Core/Widget/Frame/Model/TabardModel.lua | 30 + .../Core/Widget/Frame/ModelScene.lua | 252 + .../Core/Widget/Frame/ModelSceneActor.lua | 149 + .../Core/Widget/Frame/MovieFrame.lua | 52 + .../POIFrame/ArchaeologyDigSiteFrame.lua | 4 + .../Widget/Frame/POIFrame/QuestPOIFrame.lua | 22 + .../Frame/POIFrame/ScenarioPOIFrame.lua | 16 + .../Core/Widget/Frame/ScrollFrame.lua | 65 + .../Core/Widget/Frame/SimpleHTML.lua | 135 + .../Annotations/Core/Widget/Frame/Slider.lua | 107 + .../Core/Widget/Frame/StatusBar.lua | 155 + .../Core/Widget/Frame/UnitPositionFrame.lua | 68 + .../Core/Widget/Intrinsic/DropdownButton.lua | 9 + .../Core/Widget/Intrinsic/EventFrame.lua | 13 + .../Annotations/Core/Widget/Texture/Line.lua | 54 + .../Core/Widget/Texture/Texture.lua | 28 + .../Annotations/Core/Widget/UIType/Font.lua | 733 ++ .../Core/Widget/UIType/FrameType.lua | 74 + .../Core/Widget/UIType/ScriptType.lua | 101 + .../Core/Widget/UIType/Template.lua | 41 + .../Annotations/Core/Widget/UIType/UIType.lua | 153 + .../BaseAPIMixin.lua.annotated.lua | 108 + ...lizzard_APIDocumentation.lua.annotated.lua | 399 + .../Blizzard_APIDocumentation.toc | 12 + .../EventsAPIMixin.lua.annotated.lua | 90 + .../FieldsAPIMixin.lua.annotated.lua | 85 + .../FunctionsAPIMixin.lua.annotated.lua | 112 + .../SystemsAPIMixin.lua.annotated.lua | 142 + .../TablesAPIMixin.lua.annotated.lua | 69 + ...teConfigAPIDocumentation.lua.annotated.lua | 43 + ...lityOptionsDocumentation.lua.annotated.lua | 21 + ...ntConstantsDocumentation.lua.annotated.lua | 274 + ...AccountInfoDocumentation.lua.annotated.lua | 66 + ...ccountStoreDocumentation.lua.annotated.lua | 275 + ...evementInfoDocumentation.lua.annotated.lua | 205 + ...ntTelemetryDocumentation.lua.annotated.lua | 47 + ...ionBarFrameDocumentation.lua.annotated.lua | 1069 ++ ...onBarSharedDocumentation.lua.annotated.lua | 44 + .../ActionDocumentation.lua.annotated.lua | 8 + ...erConstantsDocumentation.lua.annotated.lua | 43 + ...dOnProfilerDocumentation.lua.annotated.lua | 204 + .../AddOnsDocumentation.lua.annotated.lua | 475 + ...tureJournalDocumentation.lua.annotated.lua | 120 + ...dventureMapDocumentation.lua.annotated.lua | 96 + ...dRacesFrameDocumentation.lua.annotated.lua | 97 + ...DiversionUIDocumentation.lua.annotated.lua | 149 + ...ranceSourceDocumentation.lua.annotated.lua | 33 + ...ldGardeningDocumentation.lua.annotated.lua | 49 + ...AreaPoiInfoDocumentation.lua.annotated.lua | 182 + ...utConstantsDocumentation.lua.annotated.lua | 37 + .../ArtifactUIDocumentation.lua.annotated.lua | 1015 ++ ...istedCombatDocumentation.lua.annotated.lua | 70 + ...nsConstantsDocumentation.lua.annotated.lua | 25 + ...seConstantsDocumentation.lua.annotated.lua | 16 + ...uctionHouseDocumentation.lua.annotated.lua | 1715 +++ ...nHouseEnumsDocumentation.lua.annotated.lua | 154 + ...teConstantsDocumentation.lua.annotated.lua | 22 + ...poweredItemDocumentation.lua.annotated.lua | 349 + ...riteEssenceDocumentation.lua.annotated.lua | 353 + ...AzeriteItemDocumentation.lua.annotated.lua | 195 + .../BNetOutageDocumentation.lua.annotated.lua | 30 + ...agConstantsDocumentation.lua.annotated.lua | 66 + ...exConstantsDocumentation.lua.annotated.lua | 50 + .../BankDocumentation.lua.annotated.lua | 428 + .../BarberShopDocumentation.lua.annotated.lua | 329 + ...hopInternalDocumentation.lua.annotated.lua | 31 + .../BaseDocumentation.lua.annotated.lua | 15 + .../BattleNetDocumentation.lua.annotated.lua | 268 + ...etConstantsDocumentation.lua.annotated.lua | 398 + .../BattlePetDocumentation.lua.annotated.lua | 260 + ...ayConstantsDocumentation.lua.annotated.lua | 239 + ...alMessagingDocumentation.lua.annotated.lua | 44 + ...kMarketInfoDocumentation.lua.annotated.lua | 78 + .../Blizzard_APIDocumentationGenerated.toc | 583 + ...ountySharedDocumentation.lua.annotated.lua | 20 + .../BrowserDocumentation.lua.annotated.lua | 63 + .../BuildDocumentation.lua.annotated.lua | 125 + ...ButtonStateDocumentation.lua.annotated.lua | 8 + .../CVarDocumentation.lua.annotated.lua | 173 + ...arConstantsDocumentation.lua.annotated.lua | 346 + .../CalendarDocumentation.lua.annotated.lua | 1183 ++ ...raConstantsDocumentation.lua.annotated.lua | 22 + .../CameraDocumentation.lua.annotated.lua | 55 + ...opConstantsDocumentation.lua.annotated.lua | 17 + ...CatalogShopDocumentation.lua.annotated.lua | 830 ++ ...ngeModeInfoDocumentation.lua.annotated.lua | 536 + ...onConstantsDocumentation.lua.annotated.lua | 34 + ...ationSharedDocumentation.lua.annotated.lua | 145 + ...onConstantsDocumentation.lua.annotated.lua | 135 + ...esConstantsDocumentation.lua.annotated.lua | 20 + ...ChatBubblesDocumentation.lua.annotated.lua | 36 + ...atConstantsDocumentation.lua.annotated.lua | 245 + .../ChatInfoDocumentation.lua.annotated.lua | 2767 ++++ ...romieTimeUIDocumentation.lua.annotated.lua | 75 + ...icConstantsDocumentation.lua.annotated.lua | 22 + .../CinematicDocumentation.lua.annotated.lua | 121 + ...nematicListDocumentation.lua.annotated.lua | 44 + .../ClassColorDocumentation.lua.annotated.lua | 37 + ...lassTalentsDocumentation.lua.annotated.lua | 433 + .../ClassTrialDocumentation.lua.annotated.lua | 33 + ...gsConstantsDocumentation.lua.annotated.lua | 46 + ...ickBindingsDocumentation.lua.annotated.lua | 153 + .../ClientDocumentation.lua.annotated.lua | 104 + ...ClientSceneDocumentation.lua.annotated.lua | 49 + ...entSettingsDocumentation.lua.annotated.lua | 27 + .../ClubDocumentation.lua.annotated.lua | 1972 +++ .../ClubFinderDocumentation.lua.annotated.lua | 989 ++ .../ClubSharedDocumentation.lua.annotated.lua | 22 + .../ColorDocumentation.lua.annotated.lua | 8 + ...deConstantsDocumentation.lua.annotated.lua | 26 + ...orOverridesDocumentation.lua.annotated.lua | 117 + .../ColorUtilDocumentation.lua.annotated.lua | 151 + ...rtConstantsDocumentation.lua.annotated.lua | 54 + ...tAudioAlertDocumentation.lua.annotated.lua | 223 + ...AlertSharedDocumentation.lua.annotated.lua | 270 + ...ogConstantsDocumentation.lua.annotated.lua | 87 + .../CombatLogDocumentation.lua.annotated.lua | 154 + ...LogInternalDocumentation.lua.annotated.lua | 36 + ...atLogSecureDocumentation.lua.annotated.lua | 154 + ...atLogSharedDocumentation.lua.annotated.lua | 27 + .../CombatTextDocumentation.lua.annotated.lua | 59 + ...tTextSharedDocumentation.lua.annotated.lua | 15 + ...ntatorFrameDocumentation.lua.annotated.lua | 1849 +++ ...tatorSharedDocumentation.lua.annotated.lua | 23 + ...tUnitFramesDocumentation.lua.annotated.lua | 27 + ...ngConstantsDocumentation.lua.annotated.lua | 26 + ...ionWarningsDocumentation.lua.annotated.lua | 77 + .../ConnectionDocumentation.lua.annotated.lua | 105 + .../ConsoleDocumentation.lua.annotated.lua | 271 + ...tCollectionDocumentation.lua.annotated.lua | 121 + .../ContainerDocumentation.lua.annotated.lua | 820 ++ ...entTrackingDocumentation.lua.annotated.lua | 354 + ...ackingTypesDocumentation.lua.annotated.lua | 125 + ...onCollectorDocumentation.lua.annotated.lua | 362 + ...erConstantsDocumentation.lua.annotated.lua | 96 + ...ldownViewerDocumentation.lua.annotated.lua | 138 + ...gsConstantsDocumentation.lua.annotated.lua | 29 + ...antCallingsDocumentation.lua.annotated.lua | 44 + ...nantPreviewDocumentation.lua.annotated.lua | 106 + ...umConstantsDocumentation.lua.annotated.lua | 8 + ...nantSanctumDocumentation.lua.annotated.lua | 222 + ...tsConstantsDocumentation.lua.annotated.lua | 21 + .../CovenantsDocumentation.lua.annotated.lua | 86 + ...UIConstantsDocumentation.lua.annotated.lua | 43 + ...tingOrderUIDocumentation.lua.annotated.lua | 610 + ...derUISharedDocumentation.lua.annotated.lua | 244 + ...reatureInfoDocumentation.lua.annotated.lua | 177 + ...cyConstantsDocumentation.lua.annotated.lua | 213 + ...ts_MainlineDocumentation.lua.annotated.lua | 113 + ...urrencyInfoDocumentation.lua.annotated.lua | 742 ++ ...CursorConstDocumentation.lua.annotated.lua | 168 + .../CursorDocumentation.lua.annotated.lua | 67 + .../CursorUtilDocumentation.lua.annotated.lua | 21 + .../CurveUtilDocumentation.lua.annotated.lua | 93 + ...geConstantsDocumentation.lua.annotated.lua | 138 + ...erConstantsDocumentation.lua.annotated.lua | 104 + ...DamageMeterDocumentation.lua.annotated.lua | 246 + ...DateAndTimeDocumentation.lua.annotated.lua | 158 + .../DeathAlertDocumentation.lua.annotated.lua | 31 + .../DeathInfoDocumentation.lua.annotated.lua | 221 + .../DeathRecapDocumentation.lua.annotated.lua | 89 + ...DebugToggleDocumentation.lua.annotated.lua | 52 + ...esConstantsDocumentation.lua.annotated.lua | 69 + .../DelvesUIDocumentation.lua.annotated.lua | 406 + .../DuelInfoDocumentation.lua.annotated.lua | 59 + ...erConstantsDocumentation.lua.annotated.lua | 114 + ...urationUtilDocumentation.lua.annotated.lua | 41 + ...yeColorInfoDocumentation.lua.annotated.lua | 157 + ...rInfoSharedDocumentation.lua.annotated.lua | 32 + ...erConstantsDocumentation.lua.annotated.lua | 879 ++ ...ts_MainlineDocumentation.lua.annotated.lua | 16 + ...ModeManagerDocumentation.lua.annotated.lua | 206 + ...ilConstantsDocumentation.lua.annotated.lua | 17 + ...ncodingUtilDocumentation.lua.annotated.lua | 238 + ...unterEventsDocumentation.lua.annotated.lua | 140 + ...ventsSharedDocumentation.lua.annotated.lua | 45 + ...counterInfoDocumentation.lua.annotated.lua | 101 + ...alConstantsDocumentation.lua.annotated.lua | 128 + ...nterJournalDocumentation.lua.annotated.lua | 373 + ...neConstantsDocumentation.lua.annotated.lua | 135 + ...terTimelineDocumentation.lua.annotated.lua | 605 + ...terWarningsDocumentation.lua.annotated.lua | 173 + ...ndOfMatchUIDocumentation.lua.annotated.lua | 80 + ...mentManagerDocumentation.lua.annotated.lua | 341 + ...erConstantsDocumentation.lua.annotated.lua | 19 + ...SchedulerUIDocumentation.lua.annotated.lua | 186 + .../EventUtilsDocumentation.lua.annotated.lua | 51 + ...onConstantsDocumentation.lua.annotated.lua | 20 + .../ExpansionDocumentation.lua.annotated.lua | 324 + ...pansionInfoDocumentation.lua.annotated.lua | 59 + ...elConstantsDocumentation.lua.annotated.lua | 31 + ...ansionTrialDocumentation.lua.annotated.lua | 31 + ...nalEventURLDocumentation.lua.annotated.lua | 44 + .../FogOfWarDocumentation.lua.annotated.lua | 68 + .../FontDocumentation.lua.annotated.lua | 94 + ...logyDigsiteDocumentation.lua.annotated.lua | 20 + ...rameAPIBlobDocumentation.lua.annotated.lua | 160 + ...erModelBaseDocumentation.lua.annotated.lua | 283 + ...ematicModelDocumentation.lua.annotated.lua | 205 + ...APICooldownDocumentation.lua.annotated.lua | 513 + ...ressUpModelDocumentation.lua.annotated.lua | 268 + ...gOfWarFrameDocumentation.lua.annotated.lua | 160 + ...meActorBaseDocumentation.lua.annotated.lua | 623 + ...eFrameActorDocumentation.lua.annotated.lua | 386 + ...lSceneFrameDocumentation.lua.annotated.lua | 606 + ...FrameSharedDocumentation.lua.annotated.lua | 20 + ...PINamePlateDocumentation.lua.annotated.lua | 30 + ...APIQuestPOIDocumentation.lua.annotated.lua | 65 + ...ScenarioPOIDocumentation.lua.annotated.lua | 49 + ...pleCheckoutDocumentation.lua.annotated.lua | 97 + ...rdModelBaseDocumentation.lua.annotated.lua | 93 + ...TabardModelDocumentation.lua.annotated.lua | 98 + ...eAPITooltipDocumentation.lua.annotated.lua | 133 + ...sitionFrameDocumentation.lua.annotated.lua | 160 + ...FrameScriptDocumentation.lua.annotated.lua | 509 + .../FriendListDocumentation.lua.annotated.lua | 637 + ...PEConstantsDocumentation.lua.annotated.lua | 23 + ...PEConstantsDocumentation.lua.annotated.lua | 22 + ...MTicketInfoDocumentation.lua.annotated.lua | 89 + .../GameCursorDocumentation.lua.annotated.lua | 177 + .../GameErrorDocumentation.lua.annotated.lua | 42 + ...amePadConstDocumentation.lua.annotated.lua | 24 + .../GamePadDocumentation.lua.annotated.lua | 435 + ...esConstantsDocumentation.lua.annotated.lua | 49 + .../GameRulesDocumentation.lua.annotated.lua | 335 + .../GameUIDocumentation.lua.annotated.lua | 40 + ...onConstantsDocumentation.lua.annotated.lua | 376 + ...arrisonInfoDocumentation.lua.annotated.lua | 1460 ++ ...risonSharedDocumentation.lua.annotated.lua | 104 + .../GlueDocumentation.lua.annotated.lua | 45 + ...phConstantsDocumentation.lua.annotated.lua | 8 + .../GlyphInfoDocumentation.lua.annotated.lua | 47 + ...ipConstantsDocumentation.lua.annotated.lua | 109 + .../GossipInfoDocumentation.lua.annotated.lua | 442 + ...erConstantsDocumentation.lua.annotated.lua | 8 + .../GuildBankDocumentation.lua.annotated.lua | 98 + ...ldConstantsDocumentation.lua.annotated.lua | 71 + .../GuildInfoDocumentation.lua.annotated.lua | 636 + ...dInfoSharedDocumentation.lua.annotated.lua | 20 + ...eirloomInfoDocumentation.lua.annotated.lua | 110 + ...useEditorUIDocumentation.lua.annotated.lua | 148 + ...orConstantsDocumentation.lua.annotated.lua | 83 + ...eExteriorUIDocumentation.lua.annotated.lua | 255 + ...BasicModeUIDocumentation.lua.annotated.lua | 289 + ...ogConstantsDocumentation.lua.annotated.lua | 126 + ...SearcherAPIDocumentation.lua.annotated.lua | 550 + ...ngCatalogUIDocumentation.lua.annotated.lua | 535 + ...eanupModeUIDocumentation.lua.annotated.lua | 73 + ...omizeModeUIDocumentation.lua.annotated.lua | 442 + ...DecorSharedDocumentation.lua.annotated.lua | 56 + ...singDecorUIDocumentation.lua.annotated.lua | 399 + ...xpertModeUIDocumentation.lua.annotated.lua | 308 + ...intFrameAPIDocumentation.lua.annotated.lua | 81 + ...PinFrameAPIDocumentation.lua.annotated.lua | 207 + ...ingLayoutUIDocumentation.lua.annotated.lua | 527 + ...youtUITypesDocumentation.lua.annotated.lua | 72 + ...ghborhoodUIDocumentation.lua.annotated.lua | 416 + ...toSharingUIDocumentation.lua.annotated.lua | 142 + .../HousingUIDocumentation.lua.annotated.lua | 895 ++ ...ingUISharedDocumentation.lua.annotated.lua | 173 + ...ngConstantsDocumentation.lua.annotated.lua | 91 + ...tionManagerDocumentation.lua.annotated.lua | 42 + ...eNavigationDocumentation.lua.annotated.lua | 115 + ...omingSummonDocumentation.lua.annotated.lua | 65 + ...utConstantsDocumentation.lua.annotated.lua | 22 + .../InputDocumentation.lua.annotated.lua | 300 + .../InstanceDocumentation.lua.annotated.lua | 271 + ...ceEncounterDocumentation.lua.annotated.lua | 117 + ...eLeaverInfoDocumentation.lua.annotated.lua | 41 + ...ileManifestDocumentation.lua.annotated.lua | 31 + ...nvasionInfoDocumentation.lua.annotated.lua | 89 + ...IslandsInfoDocumentation.lua.annotated.lua | 35 + ...andsQueueUIDocumentation.lua.annotated.lua | 93 + ...emConstantsDocumentation.lua.annotated.lua | 698 + ...ts_MainlineDocumentation.lua.annotated.lua | 77 + ...ants_SharedDocumentation.lua.annotated.lua | 8 + .../ItemDocumentation.lua.annotated.lua | 1917 +++ ...teractionUIDocumentation.lua.annotated.lua | 156 + ...emQualitiesDocumentation.lua.annotated.lua | 27 + .../ItemSharedDocumentation.lua.annotated.lua | 8 + ...mSocketInfoDocumentation.lua.annotated.lua | 276 + .../ItemTextDocumentation.lua.annotated.lua | 49 + ...ItemUpgradeDocumentation.lua.annotated.lua | 308 + ...KeyBindingsDocumentation.lua.annotated.lua | 254 + ...FGConstantsDocumentation.lua.annotated.lua | 154 + .../LFGInfoDocumentation.lua.annotated.lua | 517 + ...LFGListInfoDocumentation.lua.annotated.lua | 990 ++ ...aryCraftingDocumentation.lua.annotated.lua | 334 + ...aftingTypesDocumentation.lua.annotated.lua | 92 + ...elConstantsDocumentation.lua.annotated.lua | 17 + .../LevelLinkDocumentation.lua.annotated.lua | 51 + ...LevelSquishDocumentation.lua.annotated.lua | 52 + ...imitedInputDocumentation.lua.annotated.lua | 50 + .../LiveEventDocumentation.lua.annotated.lua | 43 + ...adingScreenDocumentation.lua.annotated.lua | 33 + ...chmakerInfoDocumentation.lua.annotated.lua | 145 + .../LocaleDocumentation.lua.annotated.lua | 86 + ...ocalizationDocumentation.lua.annotated.lua | 175 + ...ationSharedDocumentation.lua.annotated.lua | 35 + ...ogConstantsDocumentation.lua.annotated.lua | 24 + .../LogDocumentation.lua.annotated.lua | 62 + ...icConstantsDocumentation.lua.annotated.lua | 55 + ...otConstantsDocumentation.lua.annotated.lua | 58 + .../LootDocumentation.lua.annotated.lua | 436 + ...LootHistoryDocumentation.lua.annotated.lua | 200 + ...LootJournalDocumentation.lua.annotated.lua | 80 + .../LoreTextDocumentation.lua.annotated.lua | 51 + ...ssOfControlDocumentation.lua.annotated.lua | 151 + ...veObjectAPIDocumentation.lua.annotated.lua | 178 + ...veObjectAPIDocumentation.lua.annotated.lua | 149 + ...jectBaseAPIDocumentation.lua.annotated.lua | 60 + ...ctConstantsDocumentation.lua.annotated.lua | 22 + ...onObjectAPIDocumentation.lua.annotated.lua | 343 + ...bjectSharedDocumentation.lua.annotated.lua | 20 + ...uaTableUtilDocumentation.lua.annotated.lua | 74 + .../MacOptionsDocumentation.lua.annotated.lua | 98 + .../MailInfoDocumentation.lua.annotated.lua | 177 + ...nsConstantsDocumentation.lua.annotated.lua | 46 + ...jorFactionsDocumentation.lua.annotated.lua | 311 + ...apConstantsDocumentation.lua.annotated.lua | 109 + .../MapDocumentation.lua.annotated.lua | 744 ++ ...ExplorationDocumentation.lua.annotated.lua | 85 + ...atrixSharedDocumentation.lua.annotated.lua | 8 + ...rchantFrameDocumentation.lua.annotated.lua | 136 + ...apConstantsDocumentation.lua.annotated.lua | 42 + .../MinimapDocumentation.lua.annotated.lua | 341 + ...mapFrameAPIDocumentation.lua.annotated.lua | 369 + ...MirrorTimerDocumentation.lua.annotated.lua | 71 + ...ationSharedDocumentation.lua.annotated.lua | 20 + ...eyConstantsDocumentation.lua.annotated.lua | 16 + ...ntConstantsDocumentation.lua.annotated.lua | 46 + ...ountJournalDocumentation.lua.annotated.lua | 697 + .../MovieDocumentation.lua.annotated.lua | 102 + ...hicPlusInfoDocumentation.lua.annotated.lua | 351 + ...sInfoSharedDocumentation.lua.annotated.lua | 51 + ...teConstantsDocumentation.lua.annotated.lua | 165 + .../NamePlateDocumentation.lua.annotated.lua | 68 + ...lateManagerDocumentation.lua.annotated.lua | 168 + ...dInitiativeDocumentation.lua.annotated.lua | 333 + ...esConstantsDocumentation.lua.annotated.lua | 111 + .../NewItemsDocumentation.lua.annotated.lua | 52 + .../OsDocumentation.lua.annotated.lua | 46 + ...grConstantsDocumentation.lua.annotated.lua | 20 + ...perDollInfoDocumentation.lua.annotated.lua | 418 + ...talControlsDocumentation.lua.annotated.lua | 29 + ...tyConstantsDocumentation.lua.annotated.lua | 61 + .../PartyInfoDocumentation.lua.annotated.lua | 788 ++ ...UIConstantsDocumentation.lua.annotated.lua | 19 + ...PartyPoseUIDocumentation.lua.annotated.lua | 107 + ...PerformanceDocumentation.lua.annotated.lua | 79 + ...sActivitiesDocumentation.lua.annotated.lua | 235 + ...erksProgramDocumentation.lua.annotated.lua | 468 + ...orConstantsDocumentation.lua.annotated.lua | 48 + ...leConstantsDocumentation.lua.annotated.lua | 354 + .../PetBattlesDocumentation.lua.annotated.lua | 90 + ...etConstantsDocumentation.lua.annotated.lua | 193 + .../PetInfoDocumentation.lua.annotated.lua | 194 + ...JournalInfoDocumentation.lua.annotated.lua | 494 + ...ngConstantsDocumentation.lua.annotated.lua | 8 + ...ngConstantsDocumentation.lua.annotated.lua | 93 + ...PingManagerDocumentation.lua.annotated.lua | 111 + ...nagerSecureDocumentation.lua.annotated.lua | 262 + ...PinFrameAPIDocumentation.lua.annotated.lua | 20 + .../PlatformDocumentation.lua.annotated.lua | 33 + ...layerChoiceDocumentation.lua.annotated.lua | 205 + ...taConstantsDocumentation.lua.annotated.lua | 20 + .../PlayerDocumentation.lua.annotated.lua | 8 + ...ngConstantsDocumentation.lua.annotated.lua | 512 + .../PlayerInfoDocumentation.lua.annotated.lua | 376 + ...rInfoSharedDocumentation.lua.annotated.lua | 31 + ...erConstantsDocumentation.lua.annotated.lua | 98 + ...tionManagerDocumentation.lua.annotated.lua | 123 + ...yerLocationDocumentation.lua.annotated.lua | 128 + ...ipConstantsDocumentation.lua.annotated.lua | 34 + ...rMentorshipDocumentation.lua.annotated.lua | 86 + ...layerScriptDocumentation.lua.annotated.lua | 1631 +++ .../PonyDocumentation.lua.annotated.lua | 22 + ...peConstantsDocumentation.lua.annotated.lua | 93 + ...wnConstantsDocumentation.lua.annotated.lua | 33 + ...onConstantsDocumentation.lua.annotated.lua | 391 + ...ecConstantsDocumentation.lua.annotated.lua | 106 + ...ssionSpecUIDocumentation.lua.annotated.lua | 419 + ...onConstantsDocumentation.lua.annotated.lua | 20 + ...foConstantsDocumentation.lua.annotated.lua | 46 + .../PvpInfoDocumentation.lua.annotated.lua | 1886 +++ ...stConstantsDocumentation.lua.annotated.lua | 157 + ...ts_MainlineDocumentation.lua.annotated.lua | 8 + ...uestHubInfoDocumentation.lua.annotated.lua | 37 + ...tInfoSharedDocumentation.lua.annotated.lua | 49 + ...tInfoSystemDocumentation.lua.annotated.lua | 146 + ...uestItemUseDocumentation.lua.annotated.lua | 38 + ...estLineInfoDocumentation.lua.annotated.lua | 163 + .../QuestLogDocumentation.lua.annotated.lua | 1589 +++ .../QuestOfferDocumentation.lua.annotated.lua | 118 + ...uestRewardsDocumentation.lua.annotated.lua | 48 + ...onConstantsDocumentation.lua.annotated.lua | 67 + ...uestSessionDocumentation.lua.annotated.lua | 211 + ...estTaskInfoDocumentation.lua.annotated.lua | 204 + ...eueSpecificDocumentation.lua.annotated.lua | 25 + .../RaidLocksDocumentation.lua.annotated.lua | 63 + ...RaidMarkersDocumentation.lua.annotated.lua | 116 + ...esConstantsDocumentation.lua.annotated.lua | 28 + ...ecentAlliesDocumentation.lua.annotated.lua | 288 + ...ruitAFriendDocumentation.lua.annotated.lua | 460 + ...riendSharedDocumentation.lua.annotated.lua | 36 + ...xArtifactUIDocumentation.lua.annotated.lua | 160 + ...wnConstantsDocumentation.lua.annotated.lua | 42 + ...emConstantsDocumentation.lua.annotated.lua | 151 + ...eportSystemDocumentation.lua.annotated.lua | 180 + ...utationInfoDocumentation.lua.annotated.lua | 367 + ...esearchInfoDocumentation.lua.annotated.lua | 117 + ...nsConstantsDocumentation.lua.annotated.lua | 36 + ...ctedActionsDocumentation.lua.annotated.lua | 135 + ...exConstantsDocumentation.lua.annotated.lua | 79 + ...cenarioInfoDocumentation.lua.annotated.lua | 269 + ...ngMachineUIDocumentation.lua.annotated.lua | 137 + .../ScreenDocumentation.lua.annotated.lua | 66 + ...onConstantsDocumentation.lua.annotated.lua | 30 + ...egionSharedDocumentation.lua.annotated.lua | 8 + ...iptWarningsDocumentation.lua.annotated.lua | 31 + ...dAnimationsDocumentation.lua.annotated.lua | 114 + .../SeasonInfoDocumentation.lua.annotated.lua | 39 + ...nsConstantsDocumentation.lua.annotated.lua | 24 + ...ctConstantsDocumentation.lua.annotated.lua | 44 + ...redicateAPIDocumentation.lua.annotated.lua | 415 + ...tPredicatesDocumentation.lua.annotated.lua | 8 + ...erConstantsDocumentation.lua.annotated.lua | 21 + ...ureTransferDocumentation.lua.annotated.lua | 115 + ...ettingsUtilDocumentation.lua.annotated.lua | 54 + ...tModelLightDocumentation.lua.annotated.lua | 21 + ...ePlateFrameDocumentation.lua.annotated.lua | 8 + ...sitionFrameDocumentation.lua.annotated.lua | 21 + ...haredTraitsDocumentation.lua.annotated.lua | 1115 ++ ...TraitsEnumsDocumentation.lua.annotated.lua | 8 + ...mpleAnimAPIDocumentation.lua.annotated.lua | 461 + ...nimAlphaAPIDocumentation.lua.annotated.lua | 66 + ...FlipBookAPIDocumentation.lua.annotated.lua | 135 + ...nimGroupAPIDocumentation.lua.annotated.lua | 357 + ...AnimPathAPIDocumentation.lua.annotated.lua | 86 + ...RotationAPIDocumentation.lua.annotated.lua | 93 + ...nimScaleAPIDocumentation.lua.annotated.lua | 122 + ...caleLineAPIDocumentation.lua.annotated.lua | 20 + ...nslationAPIDocumentation.lua.annotated.lua | 45 + ...nslationAPIDocumentation.lua.annotated.lua | 45 + ...tionLineAPIDocumentation.lua.annotated.lua | 20 + ...texColorAPIDocumentation.lua.annotated.lua | 66 + ...leObjectAPIDocumentation.lua.annotated.lua | 57 + ...eBrowserAPIDocumentation.lua.annotated.lua | 122 + ...leButtonAPIDocumentation.lua.annotated.lua | 487 + ...CheckboxAPIDocumentation.lua.annotated.lua | 89 + ...orSelectAPIDocumentation.lua.annotated.lua | 243 + ...rolPointAPIDocumentation.lua.annotated.lua | 79 + ...eEditBoxAPIDocumentation.lua.annotated.lua | 952 ++ ...mpleFontAPIDocumentation.lua.annotated.lua | 319 + ...ntStringAPIDocumentation.lua.annotated.lua | 683 + ...pleFrameAPIDocumentation.lua.annotated.lua | 1494 +++ ...ptObjectAPIDocumentation.lua.annotated.lua | 167 + ...mpleHTMLAPIDocumentation.lua.annotated.lua | 343 + ...eHTMLSharedDocumentation.lua.annotated.lua | 18 + ...mpleLineAPIDocumentation.lua.annotated.lua | 133 + ...MapSceneAPIDocumentation.lua.annotated.lua | 86 + ...kTextureAPIDocumentation.lua.annotated.lua | 20 + ...ageFrameAPIDocumentation.lua.annotated.lua | 424 + ...pleModelAPIDocumentation.lua.annotated.lua | 780 ++ ...ModelFFXAPIDocumentation.lua.annotated.lua | 61 + ...pleMovieAPIDocumentation.lua.annotated.lua | 73 + ...leObjectAPIDocumentation.lua.annotated.lua | 82 + ...eenFrameAPIDocumentation.lua.annotated.lua | 125 + ...leRegionAPIDocumentation.lua.annotated.lua | 228 + ...ptRegionAPIDocumentation.lua.annotated.lua | 683 + ...ResizingAPIDocumentation.lua.annotated.lua | 194 + ...ollFrameAPIDocumentation.lua.annotated.lua | 128 + ...leSliderAPIDocumentation.lua.annotated.lua | 236 + ...tatusBarAPIDocumentation.lua.annotated.lua | 351 + ...arConstantsDocumentation.lua.annotated.lua | 46 + ...eTextureAPIDocumentation.lua.annotated.lua | 71 + ...tureBaseAPIDocumentation.lua.annotated.lua | 515 + .../SkillInfoDocumentation.lua.annotated.lua | 27 + ...lashCommandDocumentation.lua.annotated.lua | 39 + ...alConstantsDocumentation.lua.annotated.lua | 22 + ...SocialQueueDocumentation.lua.annotated.lua | 233 + ...estrictionsDocumentation.lua.annotated.lua | 117 + ...etConstantsDocumentation.lua.annotated.lua | 22 + ...dsConstantsDocumentation.lua.annotated.lua | 90 + .../SoulbindsDocumentation.lua.annotated.lua | 744 ++ .../SoundDocumentation.lua.annotated.lua | 130 + ...izationInfoDocumentation.lua.annotated.lua | 559 + ...ationSharedDocumentation.lua.annotated.lua | 122 + ...tionOverlayDocumentation.lua.annotated.lua | 82 + ...okConstantsDocumentation.lua.annotated.lua | 49 + .../SpellBookDocumentation.lua.annotated.lua | 979 ++ ...llConstantsDocumentation.lua.annotated.lua | 44 + ...shConstantsDocumentation.lua.annotated.lua | 39 + ...lDiminishUIDocumentation.lua.annotated.lua | 114 + .../SpellDocumentation.lua.annotated.lua | 1077 ++ .../SpellIDDocumentation.lua.annotated.lua | 28 + ...SpellSharedDocumentation.lua.annotated.lua | 49 + ...enConstantsDocumentation.lua.annotated.lua | 20 + ...plashScreenDocumentation.lua.annotated.lua | 87 + .../StableInfoDocumentation.lua.annotated.lua | 228 + ...orePublicUIDocumentation.lua.annotated.lua | 56 + .../StreamingDocumentation.lua.annotated.lua | 56 + .../StringUtilDocumentation.lua.annotated.lua | 215 + ...onConstantsDocumentation.lua.annotated.lua | 20 + .../SummonInfoDocumentation.lua.annotated.lua | 74 + ...rackManagerDocumentation.lua.annotated.lua | 229 + ...nagerSharedDocumentation.lua.annotated.lua | 41 + .../SystemDocumentation.lua.annotated.lua | 238 + .../SystemTimeDocumentation.lua.annotated.lua | 85 + ...TTSSettingsDocumentation.lua.annotated.lua | 233 + ...phConstantsDocumentation.lua.annotated.lua | 8 + ...TalkingHeadDocumentation.lua.annotated.lua | 33 + ...argetScriptDocumentation.lua.annotated.lua | 208 + .../TaxiMapDocumentation.lua.annotated.lua | 146 + ...xtureSharedDocumentation.lua.annotated.lua | 8 + ...extureUtilsDocumentation.lua.annotated.lua | 211 + .../ThreatDocumentation.lua.annotated.lua | 46 + .../TimeDocumentation.lua.annotated.lua | 21 + ...erConstantsDocumentation.lua.annotated.lua | 22 + ...ngConstantsDocumentation.lua.annotated.lua | 20 + ...merunningUIDocumentation.lua.annotated.lua | 36 + .../TitleDocumentation.lua.annotated.lua | 79 + ...pComparisonDocumentation.lua.annotated.lua | 105 + ...ipConstantsDocumentation.lua.annotated.lua | 51 + ...TooltipInfoDocumentation.lua.annotated.lua | 1400 ++ ...pInfoSharedDocumentation.lua.annotated.lua | 171 + .../TotemDocumentation.lua.annotated.lua | 117 + .../ToyBoxInfoDocumentation.lua.annotated.lua | 97 + .../TradeInfoDocumentation.lua.annotated.lua | 160 + ...radeSkillUIDocumentation.lua.annotated.lua | 1392 ++ ...killUITypesDocumentation.lua.annotated.lua | 437 + .../TrainerDocumentation.lua.annotated.lua | 51 + ...TraitConfigDocumentation.lua.annotated.lua | 21 + ...itConstantsDocumentation.lua.annotated.lua | 329 + ...orConstantsDocumentation.lua.annotated.lua | 80 + ...ogConstantsDocumentation.lua.annotated.lua | 41 + .../TransmogDocumentation.lua.annotated.lua | 321 + ...ansmogItemsDocumentation.lua.annotated.lua | 1228 ++ ...itConstantsDocumentation.lua.annotated.lua | 396 + ...gOutfitInfoDocumentation.lua.annotated.lua | 913 ++ ...ransmogSetsDocumentation.lua.annotated.lua | 536 + ...nsmogSharedDocumentation.lua.annotated.lua | 139 + .../TutorialDocumentation.lua.annotated.lua | 142 + ...onConstantsDocumentation.lua.annotated.lua | 20 + .../UIActionDocumentation.lua.annotated.lua | 31 + ...uttonSharedDocumentation.lua.annotated.lua | 20 + ...ssConstantsDocumentation.lua.annotated.lua | 28 + .../UIColorDocumentation.lua.annotated.lua | 30 + ...ColorSharedDocumentation.lua.annotated.lua | 17 + ...foConstantsDocumentation.lua.annotated.lua | 21 + ...stConstantsDocumentation.lua.annotated.lua | 82 + ...oastManagerDocumentation.lua.annotated.lua | 99 + ...AssetSharedDocumentation.lua.annotated.lua | 8 + ...rameManagerDocumentation.lua.annotated.lua | 65 + ...dgetDisplayDocumentation.lua.annotated.lua | 53 + .../UIMacrosDocumentation.lua.annotated.lua | 89 + .../UIManagerDocumentation.lua.annotated.lua | 101 + ...apPinSharedDocumentation.lua.annotated.lua | 19 + ...UIModelInfoDocumentation.lua.annotated.lua | 194 + ...lInfoSharedDocumentation.lua.annotated.lua | 77 + ...iedInstanceDocumentation.lua.annotated.lua | 50 + .../UISharedDocumentation.lua.annotated.lua | 43 + ...lityManagerDocumentation.lua.annotated.lua | 53 + ...AssetSharedDocumentation.lua.annotated.lua | 8 + ...reConstantsDocumentation.lua.annotated.lua | 32 + .../UITimerDocumentation.lua.annotated.lua | 78 + ...dgetManagerDocumentation.lua.annotated.lua | 2254 ++++ ...nagerSharedDocumentation.lua.annotated.lua | 172 + .../URLDocumentation.lua.annotated.lua | 42 + ...neConstantsDocumentation.lua.annotated.lua | 34 + ...erConstantsDocumentation.lua.annotated.lua | 8 + .../UnitAuraDocumentation.lua.annotated.lua | 498 + ...tAuraSharedDocumentation.lua.annotated.lua | 37 + ...itConstantsDocumentation.lua.annotated.lua | 71 + .../UnitDocumentation.lua.annotated.lua | 4848 +++++++ ...lculatorAPIDocumentation.lua.annotated.lua | 490 + ...latorSharedDocumentation.lua.annotated.lua | 111 + .../UnitRoleDocumentation.lua.annotated.lua | 123 + ...exConstantsDocumentation.lua.annotated.lua | 23 + .../UnitSharedDocumentation.lua.annotated.lua | 16 + ...serFeedbackDocumentation.lua.annotated.lua | 52 + ...meConstantsDocumentation.lua.annotated.lua | 50 + ...ectorSharedDocumentation.lua.annotated.lua | 8 + .../VehicleDocumentation.lua.annotated.lua | 126 + .../VideoDocumentation.lua.annotated.lua | 207 + ...teConstantsDocumentation.lua.annotated.lua | 36 + ...ignetteInfoDocumentation.lua.annotated.lua | 153 + .../VoiceChatDocumentation.lua.annotated.lua | 1472 +++ ...WarCampaignDocumentation.lua.annotated.lua | 214 + ...foConstantsDocumentation.lua.annotated.lua | 23 + ...ndSceneInfoDocumentation.lua.annotated.lua | 143 + ...eklyRewardsDocumentation.lua.annotated.lua | 351 + ...wardsSharedDocumentation.lua.annotated.lua | 8 + ...erConstantsDocumentation.lua.annotated.lua | 21 + ...dLootObjectDocumentation.lua.annotated.lua | 160 + ...sUIInternalDocumentation.lua.annotated.lua | 41 + ...ldStateInfoDocumentation.lua.annotated.lua | 91 + ...CSConstantsDocumentation.lua.annotated.lua | 90 + ...tlementInfoDocumentation.lua.annotated.lua | 70 + ...eyConstantsDocumentation.lua.annotated.lua | 23 + .../WowSurveyDocumentation.lua.annotated.lua | 42 + .../WowTokenUIDocumentation.lua.annotated.lua | 150 + .../XMLUtilDocumentation.lua.annotated.lua | 79 + ...ZoneAbilityDocumentation.lua.annotated.lua | 57 + .../ZoneScriptDocumentation.lua.annotated.lua | 71 + .../AccessibilityIntrinsics.xml | 11 + .../AccessibilityIntrinsics.xml.annotated.lua | 6 + .../Blizzard_AccessibilityTemplates.toc | 12 + .../AccessibilityTemplates.lua.annotated.lua | 113 + .../QuestTextContrast.lua.annotated.lua | 63 + .../TextSizeManager.lua.annotated.lua | 139 + .../TextSizeManagerGame.lua.annotated.lua | 7 + ...erScaledElementTemplates.lua.annotated.lua | 62 + .../UserScaledElementTemplates.xml | 27 + ...erScaledElementTemplates.xml.annotated.lua | 10 + .../UserScaledSliderTemplates.xml | 35 + ...serScaledSliderTemplates.xml.annotated.lua | 26 + .../Blizzard_AccountSaveUI.toc | 7 + .../Blizzard_AccountStore.lua.annotated.lua | 112 + .../Blizzard_AccountStore.toc | 18 + .../Blizzard_AccountStore.xml | 187 + .../Blizzard_AccountStore.xml.annotated.lua | 154 + ...ccountStoreCardTemplates.lua.annotated.lua | 367 + .../Blizzard_AccountStoreCardTemplates.xml | 129 + ...ccountStoreCardTemplates.xml.annotated.lua | 55 + ...AccountStoreCategoryList.lua.annotated.lua | 78 + .../Blizzard_AccountStoreCategoryList.xml | 89 + ...AccountStoreCategoryList.xml.annotated.lua | 35 + ..._AccountStoreItemDisplay.lua.annotated.lua | 184 + .../Blizzard_AccountStoreItemDisplay.xml | 56 + ..._AccountStoreItemDisplay.xml.annotated.lua | 31 + ...ard_AccountStoreItemRack.lua.annotated.lua | 56 + .../Blizzard_AccountStoreItemRack.xml | 6 + ...ard_AccountStoreItemRack.xml.annotated.lua | 6 + ...lizzard_AccountStoreUtil.lua.annotated.lua | 144 + .../Blizzard_AchievementUI_Mainline.toc | 9 + .../Blizzard_AchievementUI.lua.annotated.lua | 3631 +++++ .../Mainline/Blizzard_AchievementUI.xml | 2706 ++++ .../Blizzard_AchievementUI.xml.annotated.lua | 1506 +++ .../Mainline/Localization.lua.annotated.lua | 105 + .../Blizzard_ActionBar_Mainline.toc | 60 + .../ActionButtonOverrides.lua.annotated.lua | 30 + .../Mainline/ActionButtonTemplate.xml | 209 + .../ActionButtonTemplate.xml.annotated.lua | 92 + ...ctionButtonUtilOverrides.lua.annotated.lua | 41 + .../Mainline/ArtifactBar.lua.annotated.lua | 131 + .../Mainline/ArtifactBar.xml | 27 + .../Mainline/ArtifactBar.xml.annotated.lua | 14 + .../AssistedCombatManager.lua.annotated.lua | 364 + .../Mainline/AzeriteBar.lua.annotated.lua | 137 + .../Mainline/AzeriteBar.xml | 17 + .../Mainline/AzeriteBar.xml.annotated.lua | 7 + .../Blizzard_ActionBar/Mainline/ExpBar.xml | 47 + .../Mainline/ExpBar.xml.annotated.lua | 18 + .../ExpBarOverrides.lua.annotated.lua | 55 + .../Mainline/HonorBar.lua.annotated.lua | 68 + .../Blizzard_ActionBar/Mainline/HonorBar.xml | 13 + .../Mainline/HonorBar.xml.annotated.lua | 6 + .../Mainline/HouseFavorBar.lua.annotated.lua | 86 + .../Mainline/HouseFavorBar.xml | 14 + .../Mainline/HouseFavorBar.xml.annotated.lua | 6 + .../Mainline/MainActionBar.xml | 176 + .../Mainline/MainActionBar.xml.annotated.lua | 96 + .../MainActionBarOverrides.lua.annotated.lua | 20 + .../Mainline/PetActionBar.xml | 62 + .../Mainline/PetActionBar.xml.annotated.lua | 45 + .../Mainline/PossessActionBar.xml | 34 + .../PossessActionBar.xml.annotated.lua | 33 + .../ReputationBarOverrides.lua.annotated.lua | 47 + .../Blizzard_ActionBar/Mainline/StanceBar.xml | 37 + .../Mainline/StanceBar.xml.annotated.lua | 35 + .../Mainline/StatusTrackingBar.xml | 63 + .../StatusTrackingBar.xml.annotated.lua | 51 + .../Mainline/StatusTrackingBarTemplate.xml | 47 + ...tatusTrackingBarTemplate.xml.annotated.lua | 25 + ...TrackingManagerOverrides.lua.annotated.lua | 66 + .../Shared/ActionBar.lua.annotated.lua | 365 + .../Shared/ActionBarTemplate.xml | 63 + .../ActionBarTemplate.xml.annotated.lua | 14 + .../Shared/ActionButton.lua.annotated.lua | 1993 +++ .../Shared/ActionButtonComponentTemplate.xml | 337 + ...nButtonComponentTemplate.xml.annotated.lua | 166 + .../ActionButtonSpellAlerts.lua.annotated.lua | 145 + .../Shared/ActionButtonSpellAlerts.xml | 38 + .../ActionButtonSpellAlerts.xml.annotated.lua | 20 + .../Shared/ActionButtonUtil.lua.annotated.lua | 368 + .../Shared/ExpBar.lua.annotated.lua | 197 + .../Shared/ExtraActionBar.lua.annotated.lua | 88 + .../Shared/ExtraActionBar.xml | 129 + .../Shared/ExtraActionBar.xml.annotated.lua | 97 + .../Shared/Localization.lua.annotated.lua | 21 + .../Shared/MainActionBar.lua.annotated.lua | 168 + .../Shared/MultiActionBars.lua.annotated.lua | 166 + .../Shared/MultiActionBars.xml | 248 + .../Shared/MultiActionBars.xml.annotated.lua | 256 + .../MultiCastActionBarFrame.lua.annotated.lua | 1080 ++ .../Shared/MultiCastActionBarFrame.xml | 382 + .../MultiCastActionBarFrame.xml.annotated.lua | 952 ++ .../Shared/PetActionBar.lua.annotated.lua | 387 + .../Shared/PossessActionBar.lua.annotated.lua | 115 + .../Shared/ReputationBar.lua.annotated.lua | 197 + .../Shared/ReputationBar.xml | 12 + .../Shared/ReputationBar.xml.annotated.lua | 6 + .../Shared/SpellFlyout.lua.annotated.lua | 385 + .../Blizzard_ActionBar/Shared/SpellFlyout.xml | 70 + .../Shared/SpellFlyout.xml.annotated.lua | 26 + .../Shared/StanceBar.lua.annotated.lua | 148 + .../StatusTrackingBar.lua.annotated.lua | 54 + .../StatusTrackingManager.lua.annotated.lua | 412 + .../VehicleLeaveButton.lua.annotated.lua | 65 + .../Shared/VehicleLeaveButton.xml | 29 + .../VehicleLeaveButton.xml.annotated.lua | 14 + .../ActionBarController.lua.annotated.lua | 232 + .../ActionBarController.xml | 9 + .../ActionBarController.xml.annotated.lua | 6 + .../Blizzard_ActionBarController.toc | 7 + .../ActionStatus.lua.annotated.lua | 96 + .../Blizzard_ActionStatus/ActionStatus.xml | 19 + .../ActionStatus.xml.annotated.lua | 11 + .../Blizzard_ActionStatus.toc | 7 + .../AddonList.lua.annotated.lua | 1031 ++ .../AddOns/Blizzard_AddOnList/AddonList.xml | 236 + .../AddonList.xml.annotated.lua | 186 + .../Blizzard_AddOnList/Blizzard_AddOnList.toc | 9 + .../Localization.lua.annotated.lua | 17 + .../AddOnPerformance.lua.annotated.lua | 85 + .../Blizzard_AddOnPerformance.toc | 5 + ..._QuestChoiceDataProvider.lua.annotated.lua | 249 + .../AM_QuestChoiceDataProvider.xml | 70 + ..._QuestChoiceDataProvider.xml.annotated.lua | 34 + .../AM_QuestDialog.lua.annotated.lua | 292 + .../Blizzard_AdventureMap/AM_QuestDialog.xml | 186 + .../AM_QuestDialog.xml.annotated.lua | 86 + ...M_QuestOfferDataProvider.lua.annotated.lua | 175 + .../AM_QuestOfferDataProvider.xml | 30 + ...M_QuestOfferDataProvider.xml.annotated.lua | 13 + ..._ZoneSummaryDataProvider.lua.annotated.lua | 198 + .../AM_ZoneSummaryDataProvider.xml | 73 + ..._ZoneSummaryDataProvider.xml.annotated.lua | 30 + .../Blizzard_AdventureMap.lua.annotated.lua | 87 + .../Blizzard_AdventureMap.toc | 14 + .../Blizzard_AdventureMap.xml | 8 + .../Blizzard_AdventureMap.xml.annotated.lua | 6 + ...izzard_AdventureMapInset.lua.annotated.lua | 198 + .../Blizzard_AdventureMapInset.xml | 75 + ...izzard_AdventureMapInset.xml.annotated.lua | 36 + ...izzard_AdventureMapUtils.lua.annotated.lua | 26 + ...sModelControlButtonMixin.lua.annotated.lua | 50 + ...zzard_AlliedRacesFrameUI.lua.annotated.lua | 201 + .../Blizzard_AlliedRacesFrameUI.xml | 213 + ...zzard_AlliedRacesFrameUI.xml.annotated.lua | 105 + .../Blizzard_AlliedRacesUI.toc | 7 + ...D_WorldQuestDataProvider.lua.annotated.lua | 18 + .../AD_WorldQuestDataProvider.xml | 6 + ...D_WorldQuestDataProvider.xml.annotated.lua | 6 + ...imaDiversionDataProvider.lua.annotated.lua | 412 + .../AnimaDiversionDataProvider.xml | 96 + ...imaDiversionDataProvider.xml.annotated.lua | 64 + ...lizzard_AnimaDiversionUI.lua.annotated.lua | 443 + .../Blizzard_AnimaDiversionUI.toc | 8 + .../Blizzard_AnimaDiversionUI.xml | 159 + ...lizzard_AnimaDiversionUI.xml.annotated.lua | 83 + ...zzard_AnimaDiversionUtil.lua.annotated.lua | 21 + .../Blizzard_ArchaeologyUI.lua.annotated.lua | 741 ++ .../Blizzard_ArchaeologyUI.xml | 1000 ++ .../Blizzard_ArchaeologyUI.xml.annotated.lua | 1074 ++ .../Blizzard_ArchaeologyUI_Mainline.toc | 6 + .../Localization.lua.annotated.lua | 1 + ...zard_ArdenwealdGardening.lua.annotated.lua | 51 + .../Blizzard_ArdenwealdGardening.toc | 5 + .../Blizzard_ArdenwealdGardening.xml | 84 + ...zard_ArdenwealdGardening.xml.annotated.lua | 25 + .../Blizzard_ArrowCalloutFrame.toc | 8 + ...zard_ArtifactAppearances.lua.annotated.lua | 193 + .../Blizzard_ArtifactAppearances.xml | 132 + ...zard_ArtifactAppearances.xml.annotated.lua | 34 + .../Blizzard_ArtifactPerks.lua.annotated.lua | 1409 ++ .../Blizzard_ArtifactPerks.xml | 710 + .../Blizzard_ArtifactPerks.xml.annotated.lua | 247 + ...zard_ArtifactPowerButton.lua.annotated.lua | 655 + .../Blizzard_ArtifactPowerButton.xml | 543 + ...zard_ArtifactPowerButton.xml.annotated.lua | 110 + .../Blizzard_ArtifactUI.lua.annotated.lua | 325 + .../Blizzard_ArtifactUI.toc | 7 + .../Blizzard_ArtifactUI.xml | 202 + .../Blizzard_ArtifactUI.xml.annotated.lua | 80 + .../Blizzard_AsyncRequest.lua.annotated.lua | 101 + .../Blizzard_AsyncRequest.toc | 4 + .../Blizzard_AuctionHouseUI_Mainline.toc | 53 + .../Localization.lua.annotated.lua | 43 + .../Blizzard_AuctionData.lua.annotated.lua | 214 + .../Blizzard_AuctionHouseAuctionsFrame.xml | 189 + ...uctionHouseAuctionsFrame.xml.annotated.lua | 106 + ...ctionHouseCategoriesList.lua.annotated.lua | 80 + .../Blizzard_AuctionHouseCategoriesList.xml | 95 + ...ctionHouseCategoriesList.xml.annotated.lua | 32 + .../Blizzard_AuctionHouseItemList.xml | 114 + ...ard_AuctionHouseItemList.xml.annotated.lua | 58 + .../Blizzard_AuctionHouseMultisell.xml | 86 + ...rd_AuctionHouseMultisell.xml.annotated.lua | 28 + ...tionHouseSharedTemplates.lua.annotated.lua | 68 + .../Blizzard_AuctionHouseSharedTemplates.xml | 41 + ...tionHouseSharedTemplates.xml.annotated.lua | 25 + .../Mainline/Blizzard_AuctionHouseTab.xml | 28 + ...Blizzard_AuctionHouseTab.xml.annotated.lua | 14 + ...lizzard_AuctionHouseUtil.lua.annotated.lua | 111 + .../Blizzard_AuctionData.lua.annotated.lua | 215 + ...uctionHouseAuctionsFrame.lua.annotated.lua | 539 + ...nHouseBrowseResultsFrame.lua.annotated.lua | 168 + ...lizzard_AuctionHouseBrowseResultsFrame.xml | 27 + ...nHouseBrowseResultsFrame.xml.annotated.lua | 16 + ...rd_AuctionHouseBuyDialog.lua.annotated.lua | 274 + .../Shared/Blizzard_AuctionHouseBuyDialog.xml | 133 + ...rd_AuctionHouseBuyDialog.xml.annotated.lua | 83 + ...ctionHouseCategoriesList.lua.annotated.lua | 183 + ...HouseCommoditiesBuyFrame.lua.annotated.lua | 171 + ...izzard_AuctionHouseCommoditiesBuyFrame.xml | 113 + ...HouseCommoditiesBuyFrame.xml.annotated.lua | 74 + ...tionHouseCommoditiesList.lua.annotated.lua | 260 + .../Blizzard_AuctionHouseCommoditiesList.xml | 43 + ...tionHouseCommoditiesList.xml.annotated.lua | 27 + ...ouseCommoditiesSellFrame.lua.annotated.lua | 192 + ...zzard_AuctionHouseCommoditiesSellFrame.xml | 9 + ...ouseCommoditiesSellFrame.xml.annotated.lua | 6 + ...izzard_AuctionHouseFrame.lua.annotated.lua | 917 ++ .../Shared/Blizzard_AuctionHouseFrame.xml | 208 + ...izzard_AuctionHouseFrame.xml.annotated.lua | 250 + ...AuctionHouseItemBuyFrame.lua.annotated.lua | 136 + .../Blizzard_AuctionHouseItemBuyFrame.xml | 67 + ...AuctionHouseItemBuyFrame.xml.annotated.lua | 44 + ...ard_AuctionHouseItemList.lua.annotated.lua | 374 + ...uctionHouseItemSellFrame.lua.annotated.lua | 529 + .../Blizzard_AuctionHouseItemSellFrame.xml | 44 + ...uctionHouseItemSellFrame.xml.annotated.lua | 24 + ...rd_AuctionHouseMultisell.lua.annotated.lua | 30 + ...rd_AuctionHouseSearchBar.lua.annotated.lua | 195 + .../Shared/Blizzard_AuctionHouseSearchBar.xml | 75 + ...rd_AuctionHouseSearchBar.xml.annotated.lua | 47 + ...rd_AuctionHouseSellFrame.lua.annotated.lua | 534 + .../Shared/Blizzard_AuctionHouseSellFrame.xml | 282 + ...rd_AuctionHouseSellFrame.xml.annotated.lua | 157 + ...tionHouseSharedTemplates.lua.annotated.lua | 790 ++ .../Blizzard_AuctionHouseSharedTemplates.xml | 175 + ...tionHouseSharedTemplates.xml.annotated.lua | 82 + ...Blizzard_AuctionHouseTab.lua.annotated.lua | 26 + ...AuctionHouseTableBuilder.lua.annotated.lua | 1143 ++ .../Blizzard_AuctionHouseTableBuilder.xml | 218 + ...AuctionHouseTableBuilder.xml.annotated.lua | 181 + ...lizzard_AuctionHouseUtil.lua.annotated.lua | 663 + ...uctionHouseWoWTokenFrame.lua.annotated.lua | 453 + .../Blizzard_AuctionHouseWoWTokenFrame.xml | 386 + ...uctionHouseWoWTokenFrame.xml.annotated.lua | 178 + ...Blizzard_AuthChallengeUI.lua.annotated.lua | 20 + .../Blizzard_AuthChallengeUI.toc | 5 + .../Blizzard_AuthChallengeUI.xml | 277 + ...Blizzard_AuthChallengeUI.xml.annotated.lua | 2 + .../AutoComplete.lua.annotated.lua | 465 + .../Blizzard_AutoComplete/AutoComplete.xml | 82 + .../AutoComplete.xml.annotated.lua | 45 + .../Blizzard_AutoComplete.toc | 7 + ...rd_AutoCompletePopupList.lua.annotated.lua | 234 + .../Blizzard_AutoCompletePopupList.toc | 6 + .../Blizzard_AutoCompletePopupList.xml | 136 + ...rd_AutoCompletePopupList.xml.annotated.lua | 65 + ...lizzard_AzeriteEssenceUI.lua.annotated.lua | 1435 ++ .../Blizzard_AzeriteEssenceUI.toc | 4 + .../Blizzard_AzeriteEssenceUI.xml | 1023 ++ ...lizzard_AzeriteEssenceUI.xml.annotated.lua | 467 + ...Blizzard_AzeriteRespecUI.lua.annotated.lua | 198 + .../Blizzard_AzeriteRespecUI.toc | 4 + .../Blizzard_AzeriteRespecUI.xml | 129 + ...Blizzard_AzeriteRespecUI.xml.annotated.lua | 142 + ...mpoweredItemChannelMixin.lua.annotated.lua | 102 + .../AzeriteEmpoweredItemChannelMixin.xml | 108 + ...mpoweredItemChannelMixin.xml.annotated.lua | 37 + ...eEmpoweredItemPowerMixin.lua.annotated.lua | 708 + .../AzeriteEmpoweredItemPowerMixin.xml | 185 + ...eEmpoweredItemPowerMixin.xml.annotated.lua | 76 + ...teEmpoweredItemSlotMixin.lua.annotated.lua | 101 + .../AzeriteEmpoweredItemSlotMixin.xml | 21 + ...teEmpoweredItemSlotMixin.xml.annotated.lua | 12 + ...teEmpoweredItemTierMixin.lua.annotated.lua | 403 + .../AzeriteEmpoweredItemTierMixin.xml | 13 + ...teEmpoweredItemTierMixin.xml.annotated.lua | 7 + .../AzeritePowerLayoutInfo.lua.annotated.lua | 149 + ...zeriteTierAnimationMixin.lua.annotated.lua | 399 + ...d_AzeriteEmpoweredItemUI.lua.annotated.lua | 394 + .../Blizzard_AzeriteEmpoweredItemUI.xml | 4 + ...d_AzeriteEmpoweredItemUI.xml.annotated.lua | 6 + ...izzard_AzeriteEmpoweredItemUITemplates.xml | 269 + ...EmpoweredItemUITemplates.xml.annotated.lua | 155 + .../Blizzard_AzeriteUI/Blizzard_AzeriteUI.toc | 23 + .../Annotations/AddOns/Blizzard_BNet/BNet.xml | 103 + .../Blizzard_BNet/BNet.xml.annotated.lua | 86 + .../Blizzard_BNet/Blizzard_BNet_Mainline.toc | 10 + .../BnetShared.lua.annotated.lua | 35 + .../Mainline/BNet.lua.annotated.lua | 360 + .../Blizzard_BarberShopUI.toc | 5 + .../Blizzard_BarberShopUI.lua.annotated.lua | 249 + .../Mainline/Blizzard_BarberShopUI.xml | 81 + .../Blizzard_BarberShopUI.xml.annotated.lua | 37 + .../Blizzard_BattlefieldMap.lua.annotated.lua | 327 + .../Blizzard_BattlefieldMap.toc | 6 + .../Blizzard_BattlefieldMap.xml | 140 + .../Blizzard_BattlefieldMap.xml.annotated.lua | 37 + ...zard_BehavioralMessaging.lua.annotated.lua | 211 + .../Blizzard_BehavioralMessaging.toc | 6 + .../Blizzard_BehavioralMessaging.xml | 136 + ...zard_BehavioralMessaging.xml.annotated.lua | 59 + .../Blizzard_Register.lua.annotated.lua | 10 + .../Blizzard_BlackMarketUI.lua.annotated.lua | 259 + .../Blizzard_BlackMarketUI.toc | 5 + .../Blizzard_BlackMarketUI.xml | 685 + .../Blizzard_BlackMarketUI.xml.annotated.lua | 442 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_BoostTutorial.lua.annotated.lua | 229 + .../Blizzard_BoostTutorial.toc | 19 + .../Blizzard_Tutorial.lua.annotated.lua | 60 + ...ard_TutorialCalloutFrame.lua.annotated.lua | 58 + .../Blizzard_TutorialCalloutFrame.xml | 19 + ...ard_TutorialCalloutFrame.xml.annotated.lua | 18 + ...torialKeyboardMouseFrame.lua.annotated.lua | 158 + .../Blizzard_TutorialKeyboardMouseFrame.xml | 201 + ...torialKeyboardMouseFrame.xml.annotated.lua | 78 + .../Blizzard_TutorialLogic.lua.annotated.lua | 3139 +++++ ...izzard_TutorialMainFrame.lua.annotated.lua | 199 + .../Blizzard_TutorialMainFrame.xml | 106 + ...izzard_TutorialMainFrame.xml.annotated.lua | 26 + ...ard_TutorialPointerFrame.lua.annotated.lua | 237 + .../Blizzard_TutorialPointerFrame.xml | 166 + ...ard_TutorialPointerFrame.xml.annotated.lua | 99 + ...ard_TutorialQuestManager.lua.annotated.lua | 183 + ...zzard_TutorialRacialData.lua.annotated.lua | 1096 ++ ...ard_TutorialRangeManager.lua.annotated.lua | 142 + .../Blizzard_BuffFrame/Blizzard_BuffFrame.toc | 8 + .../BuffFrame.lua.annotated.lua | 1386 ++ .../AddOns/Blizzard_BuffFrame/BuffFrame.xml | 169 + .../BuffFrame.xml.annotated.lua | 116 + .../Blizzard_BuffFrame/BuffFrameTemplates.xml | 145 + .../BuffFrameTemplates.xml.annotated.lua | 80 + .../ExternalDefensivesFrame.lua.annotated.lua | 46 + .../ExternalDefensivesFrame.xml | 17 + .../ExternalDefensivesFrame.xml.annotated.lua | 16 + .../Blizzard_CUFProfiles.toc | 3 + ...CompactUnitFrameProfiles.lua.annotated.lua | 137 + .../Blizzard_Calendar_Mainline.toc | 9 + .../Localization.lua.annotated.lua | 59 + .../Blizzard_Calendar.lua.annotated.lua | 4698 +++++++ .../Mainline/Blizzard_Calendar.xml | 1302 ++ .../Blizzard_Calendar.xml.annotated.lua | 927 ++ .../Mainline/Blizzard_CalendarTemplates.xml | 576 + ...izzard_CalendarTemplates.xml.annotated.lua | 161 + .../Blizzard_CatalogShop.lua.annotated.lua | 1057 ++ .../Blizzard_CatalogShop.toc | 27 + .../Blizzard_CatalogShop.xml | 635 + .../Blizzard_CatalogShop.xml.annotated.lua | 580 + ...zard_CatalogShop_Details.lua.annotated.lua | 175 + ...ard_CatalogShop_Elements.lua.annotated.lua | 842 ++ .../Blizzard_CatalogShop_Elements.xml | 776 ++ ...ard_CatalogShop_Elements.xml.annotated.lua | 362 + ..._CatalogShop_ErrorLookup.lua.annotated.lua | 341 + ...zzard_CatalogShop_Header.lua.annotated.lua | 30 + .../Blizzard_CatalogShop_Header.xml | 45 + ...zzard_CatalogShop_Header.xml.annotated.lua | 19 + ...zard_CatalogShop_Inbound.lua.annotated.lua | 67 + ...izzard_CatalogShop_Model.lua.annotated.lua | 474 + ...ard_CatalogShop_Outbound.lua.annotated.lua | 50 + ...CatalogShop_ProductCards.lua.annotated.lua | 489 + .../Blizzard_CatalogShop_ProductCards.xml | 161 + ...CatalogShop_ProductCards.xml.annotated.lua | 118 + ...ard_CatalogShop_Products.lua.annotated.lua | 578 + ...ard_CatalogShop_Unsecure.lua.annotated.lua | 10 + .../DialogPopup.lua.annotated.lua | 247 + .../Blizzard_CatalogShop/DialogPopup.xml | 52 + .../DialogPopup.xml.annotated.lua | 24 + ...rd_CatalogShopRefundFlow.lua.annotated.lua | 409 + .../Blizzard_CatalogShopRefundFlow.toc | 14 + .../Blizzard_CatalogShopRefundFlow.xml | 202 + ...rd_CatalogShopRefundFlow.xml.annotated.lua | 115 + ...gShopRefundFlow_Elements.lua.annotated.lua | 190 + ...lizzard_CatalogShopRefundFlow_Elements.xml | 159 + ...gShopRefundFlow_Elements.xml.annotated.lua | 64 + ...ogShopRefundFlow_Inbound.lua.annotated.lua | 29 + ...gShopRefundFlow_Outbound.lua.annotated.lua | 14 + .../Blizzard_CatalogShopSharedTemplates.toc | 7 + ...gShop_SharedProductCards.lua.annotated.lua | 578 + ...lizzard_CatalogShop_SharedProductCards.xml | 241 + ...gShop_SharedProductCards.xml.annotated.lua | 134 + .../Blizzard_CatalogShopSharedUtil.toc | 6 + ...rd_CatalogShop_Constants.lua.annotated.lua | 154 + ...d_CatalogShop_SharedUtil.lua.annotated.lua | 1346 ++ ...ard_CatalogShopTopUpFlow.lua.annotated.lua | 176 + .../Blizzard_CatalogShopTopUpFlow.toc | 13 + .../Blizzard_CatalogShopTopUpFlow.xml | 105 + ...ard_CatalogShopTopUpFlow.xml.annotated.lua | 51 + ...ogShopTopUpFlow_Elements.lua.annotated.lua | 116 + ...Blizzard_CatalogShopTopUpFlow_Elements.xml | 5 + ...ogShopTopUpFlow_Elements.xml.annotated.lua | 2 + ...logShopTopUpFlow_Inbound.lua.annotated.lua | 40 + .../Blizzard_ChallengesUI_Mainline.toc | 4 + .../Blizzard_ChallengesUI.lua.annotated.lua | 1099 ++ .../Mainline/Blizzard_ChallengesUI.xml | 1010 ++ .../Blizzard_ChallengesUI.xml.annotated.lua | 351 + .../Mainline/Localization.lua.annotated.lua | 1 + .../Blizzard_Channels/Blizzard_Channels.toc | 15 + .../ChannelButton.lua.annotated.lua | 431 + .../Blizzard_Channels/ChannelButton.xml | 65 + .../ChannelButton.xml.annotated.lua | 43 + .../ChannelFrame.lua.annotated.lua | 710 + .../AddOns/Blizzard_Channels/ChannelFrame.xml | 79 + .../ChannelFrame.xml.annotated.lua | 57 + .../ChannelList.lua.annotated.lua | 411 + .../AddOns/Blizzard_Channels/ChannelList.xml | 23 + .../ChannelList.xml.annotated.lua | 10 + .../ChannelRoster.lua.annotated.lua | 258 + .../Blizzard_Channels/ChannelRoster.xml | 50 + .../ChannelRoster.xml.annotated.lua | 31 + .../CreateChannelPopup.lua.annotated.lua | 37 + .../Blizzard_Channels/CreateChannelPopup.xml | 106 + .../CreateChannelPopup.xml.annotated.lua | 70 + .../RosterButton.lua.annotated.lua | 348 + .../AddOns/Blizzard_Channels/RosterButton.xml | 49 + .../RosterButton.xml.annotated.lua | 29 + .../VoiceActivityManager.lua.annotated.lua | 400 + .../VoiceActivityManager.xml | 11 + .../VoiceActivityManager.xml.annotated.lua | 6 + ...oiceActivityNotification.lua.annotated.lua | 123 + .../VoiceActivityNotification.xml | 89 + ...oiceActivityNotification.xml.annotated.lua | 31 + .../VoiceActivityNotificationParty.xml | 23 + ...ctivityNotificationParty.xml.annotated.lua | 12 + .../VoiceActivityNotificationRoster.xml | 13 + ...tivityNotificationRoster.xml.annotated.lua | 11 + .../VoiceChatPrompt.lua.annotated.lua | 176 + .../Blizzard_Channels/VoiceChatPrompt.xml | 64 + .../VoiceChatPrompt.xml.annotated.lua | 56 + .../VoiceUtils.lua.annotated.lua | 131 + .../Blizzard_CharacterCreate.toc | 6 + ...zzard_CharacterCustomize.lua.annotated.lua | 430 + .../Blizzard_CharacterCustomize.toc | 7 + .../Blizzard_CharacterCustomize.xml | 164 + ...zzard_CharacterCustomize.xml.annotated.lua | 127 + .../Blizzard_CharacterSelectNavBar.toc | 6 + .../Blizzard_ChatFrame_Mainline.toc | 27 + .../BattlegroundChatFilters.lua.annotated.lua | 203 + .../Mainline/BattlegroundChatFilters.xml | 9 + .../BattlegroundChatFilters.xml.annotated.lua | 6 + .../ChatConfigFrame.lua.annotated.lua | 2603 ++++ .../Mainline/ChatConfigFrame.xml | 1555 +++ .../ChatConfigFrame.xml.annotated.lua | 1053 ++ .../Mainline/FloatingChatFrameAlertFrame.xml | 13 + ...atingChatFrameAlertFrame.xml.annotated.lua | 6 + .../Mainline/FloatingChatFrameVoiceChat.xml | 28 + ...oatingChatFrameVoiceChat.xml.annotated.lua | 57 + .../Mainline/Localization.lua.annotated.lua | 38 + ...xtToSpeechFrameConstants.lua.annotated.lua | 30 + .../VoiceChatHeadsetButton.lua.annotated.lua | 326 + .../Mainline/VoiceChatHeadsetButton.xml | 39 + .../VoiceChatHeadsetButton.xml.annotated.lua | 27 + .../ClassTalentHelper.lua.annotated.lua | 75 + .../Shared/TextToSpeech.lua.annotated.lua | 90 + .../Shared/TextToSpeech.xml | 40 + .../Shared/TextToSpeech.xml.annotated.lua | 32 + .../TextToSpeechCommands.lua.annotated.lua | 1222 ++ .../TextToSpeechFrame.lua.annotated.lua | 1089 ++ .../Shared/TextToSpeechFrame.xml | 167 + .../TextToSpeechFrame.xml.annotated.lua | 107 + .../Shared/VoiceChatDots.lua.annotated.lua | 19 + .../Shared/VoiceChatDots.xml | 25 + .../Shared/VoiceChatDots.xml.annotated.lua | 14 + ...eChatTranscriptionButton.lua.annotated.lua | 252 + .../Shared/VoiceChatTranscriptionButton.xml | 24 + ...eChatTranscriptionButton.xml.annotated.lua | 22 + ...ceChatTranscriptionFrame.lua.annotated.lua | 204 + .../Blizzard_ChatFrameBase_Mainline.toc | 37 + .../ChannelFrameButtonMixin.lua.annotated.lua | 87 + .../ChatEmoteConstants.lua.annotated.lua | 350 + .../Mainline/ChatFrame.xml | 21 + .../Mainline/ChatFrame.xml.annotated.lua | 11 + .../Mainline/ChatFrameEditBox.xml | 113 + .../ChatFrameEditBox.xml.annotated.lua | 38 + ...hatFrameEditBoxOverrides.lua.annotated.lua | 51 + .../ChatFrameMenuButton.lua.annotated.lua | 181 + .../ChatFrameOverrides.lua.annotated.lua | 690 + .../ChatFrameUtilOverrides.lua.annotated.lua | 182 + ...ypeInfoConstantsOverride.lua.annotated.lua | 20 + .../FloatingChatFrame.lua.annotated.lua | 2519 ++++ .../Mainline/FloatingChatFrame.xml | 707 + .../FloatingChatFrame.xml.annotated.lua | 2179 +++ .../SlashCommandsOverrides.lua.annotated.lua | 303 + .../CastRandomManager.lua.annotated.lua | 95 + .../CastSequenceManager.lua.annotated.lua | 258 + .../ChatAlertFrameMixin.lua.annotated.lua | 16 + .../Shared/ChatFrame.lua.annotated.lua | 276 + .../ChatFrameConstants.lua.annotated.lua | 135 + .../Shared/ChatFrameEditBox.lua.annotated.lua | 807 ++ .../Shared/ChatFrameFilters.lua.annotated.lua | 208 + .../ChatFrameFiltersSecure.lua.annotated.lua | 9 + .../Shared/ChatFrameSetup.lua.annotated.lua | 34 + .../Shared/ChatFrameUtil.lua.annotated.lua | 1058 ++ .../ChatTypeInfoColors.lua.annotated.lua | 13 + .../ChatTypeInfoConstants.lua.annotated.lua | 291 + .../FloatingChatFrame.lua.annotated.lua | 38 + .../Shared/HistoryKeeper.lua.annotated.lua | 36 + .../MacroExecutionManager.lua.annotated.lua | 29 + ...MessageFrameScrollButton.lua.annotated.lua | 39 + .../Shared/SlashCommands.lua.annotated.lua | 1633 +++ .../SlashCommandsRegistry.lua.annotated.lua | 66 + .../Blizzard_ChatFrameUtil.lua.annotated.lua | 20 + .../Blizzard_ChatFrameUtil.toc | 3 + .../Blizzard_ChromieTimeUI.lua.annotated.lua | 171 + .../Blizzard_ChromieTimeUI.toc | 5 + .../Blizzard_ChromieTimeUI.xml | 191 + .../Blizzard_ChromieTimeUI.xml.annotated.lua | 81 + .../Blizzard_ClassMenu.lua.annotated.lua | 125 + .../Blizzard_ClassMenu/Blizzard_ClassMenu.toc | 6 + .../Blizzard_ClassTrial.lua.annotated.lua | 354 + .../Blizzard_ClassTrial.toc | 7 + .../Blizzard_ClassTrial.xml | 181 + .../Blizzard_ClassTrial.xml.annotated.lua | 65 + ...zzard_ClassTrialOutbound.lua.annotated.lua | 23 + ...lizzard_ClassTrialSecure.lua.annotated.lua | 49 + .../Blizzard_ClassTrialSecure.toc | 6 + .../Blizzard_ClassTrialSecure.xml | 16 + ...lizzard_ClassTrialSecure.xml.annotated.lua | 2 + .../Blizzard_ClickBindingUI.lua.annotated.lua | 851 ++ .../Blizzard_ClickBindingUI.toc | 4 + .../Blizzard_ClickBindingUI.xml | 326 + .../Blizzard_ClickBindingUI.xml.annotated.lua | 178 + .../Blizzard_ClientSavedVariables.toc | 3 + .../Blizzard_CodeOfConduct.lua.annotated.lua | 5 + .../Blizzard_CodeOfConduct.toc | 6 + .../Blizzard_Collections_Mainline.toc | 21 + .../Localization.lua.annotated.lua | 21 + ...zard_CollectionTemplates.lua.annotated.lua | 140 + .../Mainline/Blizzard_CollectionTemplates.xml | 224 + ...zard_CollectionTemplates.xml.annotated.lua | 81 + .../Blizzard_Collections.lua.annotated.lua | 91 + .../Mainline/Blizzard_Collections.xml | 64 + .../Blizzard_Collections.xml.annotated.lua | 66 + ...zzard_HeirloomCollection.lua.annotated.lua | 720 + .../Mainline/Blizzard_HeirloomCollection.xml | 144 + ...zzard_HeirloomCollection.xml.annotated.lua | 82 + ...Blizzard_MountCollection.lua.annotated.lua | 1162 ++ .../Mainline/Blizzard_MountCollection.xml | 601 + ...Blizzard_MountCollection.xml.annotated.lua | 335 + .../Blizzard_ToyBox.lua.annotated.lua | 462 + .../Mainline/Blizzard_ToyBox.xml | 157 + .../Blizzard_ToyBox.xml.annotated.lua | 157 + ...d_WarbandSceneCollection.lua.annotated.lua | 65 + .../Blizzard_WarbandSceneCollection.xml | 78 + ...d_WarbandSceneCollection.xml.annotated.lua | 52 + .../Blizzard_Wardrobe.lua.annotated.lua | 1752 +++ .../Mainline/Blizzard_Wardrobe.xml | 723 + .../Blizzard_Wardrobe.xml.annotated.lua | 377 + .../Blizzard_PetCollection.lua.annotated.lua | 1769 +++ .../Shared/Blizzard_PetCollection.xml | 1714 +++ .../Blizzard_PetCollection.xml.annotated.lua | 1600 +++ .../Blizzard_Wardrobe_Sets.lua.annotated.lua | 949 ++ .../Shared/Blizzard_Wardrobe_Sets.xml | 134 + .../Blizzard_Wardrobe_Sets.xml.annotated.lua | 51 + .../Blizzard_Colors_Mainline.toc | 8 + .../Mainline/ColorConstants.lua.annotated.lua | 167 + .../Mainline/ColorManager.lua.annotated.lua | 278 + .../Shared/ColorConstants.lua.annotated.lua | 21 + .../Shared/MaterialColors.lua.annotated.lua | 9 + ..._CombatAudioAlertManager.lua.annotated.lua | 1078 ++ .../Blizzard_CombatAudioAlertManager.xml | 9 + ..._CombatAudioAlertManager.xml.annotated.lua | 6 + .../Blizzard_CombatAudioAlerts.toc | 9 + .../Blizzard_CombatLog_Mainline.toc | 8 + .../Blizzard_CombatLog.lua.annotated.lua | 1726 +++ .../Mainline/Blizzard_CombatLog.xml | 67 + .../Blizzard_CombatLog.xml.annotated.lua | 25 + .../Blizzard_CombatLogBase.toc | 10 + .../CombatLogUtil.lua.annotated.lua | 227 + .../CombatLogColors.lua.annotated.lua | 36 + .../CombatLogConstants.lua.annotated.lua | 21 + .../Shared/CombatLogFilters.lua.annotated.lua | 79 + ...zzard_CombatLogProcessor.lua.annotated.lua | 1419 ++ .../Blizzard_CombatLogProcessor.toc | 8 + ...ombatLogProcessorInbound.lua.annotated.lua | 10 + ...mbatLogProcessorOutbound.lua.annotated.lua | 30 + .../Blizzard_CombatText.toc | 9 + ...atTextConstantsOverrides.lua.annotated.lua | 10 + .../CombatTextUtilOverrides.lua.annotated.lua | 4 + .../Shared/CombatText.lua.annotated.lua | 523 + .../Blizzard_CombatText/Shared/CombatText.xml | 14 + .../Shared/CombatText.xml.annotated.lua | 6 + .../CombatTextConstants.lua.annotated.lua | 124 + .../Shared/CombatTextUtil.lua.annotated.lua | 73 + ...Blizzard_CommandLineUtil.lua.annotated.lua | 39 + .../Blizzard_CommandLineUtil.toc | 4 + .../Blizzard_Commentator.lua.annotated.lua | 512 + .../Blizzard_Commentator.toc | 23 + .../Blizzard_Commentator.xml | 16 + .../Blizzard_Commentator.xml.annotated.lua | 11 + ...ard_CommentatorConstants.lua.annotated.lua | 6 + ...rd_CommentatorModelScene.lua.annotated.lua | 99 + .../Blizzard_CommentatorModelScene.xml | 11 + ...rd_CommentatorModelScene.xml.annotated.lua | 6 + ...ard_CommentatorNamePlate.lua.annotated.lua | 170 + .../Blizzard_CommentatorNamePlate.xml | 52 + ...ard_CommentatorNamePlate.xml.annotated.lua | 25 + ...rd_CommentatorScoreboard.lua.annotated.lua | 143 + .../Blizzard_CommentatorScoreboard.xml | 129 + ...rd_CommentatorScoreboard.xml.annotated.lua | 64 + ...lizzard_CommentatorSpell.lua.annotated.lua | 124 + .../Blizzard_CommentatorSpell.xml | 62 + ...lizzard_CommentatorSpell.xml.annotated.lua | 33 + ...ard_CommentatorSpellTray.lua.annotated.lua | 133 + .../Blizzard_CommentatorSpellTray.xml | 30 + ...ard_CommentatorSpellTray.xml.annotated.lua | 24 + ...ard_CommentatorUnitFrame.lua.annotated.lua | 510 + .../Blizzard_CommentatorUnitFrame.xml | 299 + ...ard_CommentatorUnitFrame.xml.annotated.lua | 121 + ...Blizzard_CommentatorUtil.lua.annotated.lua | 23 + ...ommentatorVictoryFanfare.lua.annotated.lua | 66 + .../CommentatorVictoryFanfare.xml | 174 + ...ommentatorVictoryFanfare.xml.annotated.lua | 56 + .../FadeToBlack.lua.annotated.lua | 53 + .../Blizzard_Commentator/FadeToBlack.xml | 19 + .../FadeToBlack.xml.annotated.lua | 6 + .../Blizzard_Communities_Mainline.toc | 33 + .../ClubFinder.lua.annotated.lua | 2270 ++++ .../Blizzard_Communities/ClubFinder.xml | 1316 ++ .../ClubFinder.xml.annotated.lua | 652 + .../ClubFinderApplicantList.lua.annotated.lua | 583 + .../ClubFinderApplicantList.xml | 169 + .../ClubFinderApplicantList.xml.annotated.lua | 82 + ...unitiesAddDialogInsecure.lua.annotated.lua | 46 + .../CommunitiesAddDialogInsecure.xml | 4 + ...unitiesAddDialogInsecure.xml.annotated.lua | 2 + ...nitiesAvatarPickerDialog.lua.annotated.lua | 103 + .../CommunitiesAvatarPickerDialog.xml | 66 + ...nitiesAvatarPickerDialog.xml.annotated.lua | 27 + .../CommunitiesCalendar.lua.annotated.lua | 67 + .../CommunitiesCalendar.xml | 21 + .../CommunitiesCalendar.xml.annotated.lua | 6 + .../CommunitiesChatFrame.lua.annotated.lua | 491 + .../CommunitiesChatFrame.xml | 95 + .../CommunitiesChatFrame.xml.annotated.lua | 29 + .../CommunitiesErrors.lua.annotated.lua | 135 + .../CommunitiesFrame.lua.annotated.lua | 1740 +++ .../Blizzard_Communities/CommunitiesFrame.xml | 611 + .../CommunitiesFrame.xml.annotated.lua | 524 + ...munitiesGuildFinderFrame.lua.annotated.lua | 4 + .../CommunitiesGuildFinderFrame.xml | 52 + ...munitiesGuildFinderFrame.xml.annotated.lua | 26 + .../CommunitiesHyperlink.lua.annotated.lua | 48 + ...mmunitiesInvitationFrame.lua.annotated.lua | 180 + .../CommunitiesInvitationFrame.xml | 137 + ...mmunitiesInvitationFrame.xml.annotated.lua | 62 + .../CommunitiesLanguage.lua.annotated.lua | 89 + .../CommunitiesLanguage.xml | 26 + .../CommunitiesLanguage.xml.annotated.lua | 12 + .../CommunitiesList.lua.annotated.lua | 886 ++ .../Blizzard_Communities/CommunitiesList.xml | 285 + .../CommunitiesList.xml.annotated.lua | 68 + .../CommunitiesMemberList.lua.annotated.lua | 1778 +++ .../CommunitiesMemberList.xml | 410 + .../CommunitiesMemberList.xml.annotated.lua | 188 + .../CommunitiesSettings.lua.annotated.lua | 425 + .../CommunitiesSettings.xml | 375 + .../CommunitiesSettings.xml.annotated.lua | 195 + .../CommunitiesStreams.lua.annotated.lua | 476 + .../CommunitiesStreams.xml | 323 + .../CommunitiesStreams.xml.annotated.lua | 171 + .../CommunitiesTabs.lua.annotated.lua | 40 + .../Blizzard_Communities/CommunitiesTabs.xml | 45 + .../CommunitiesTabs.xml.annotated.lua | 8 + ...itiesTicketManagerDialog.lua.annotated.lua | 505 + .../CommunitiesTicketManagerDialog.xml | 443 + ...itiesTicketManagerDialog.xml.annotated.lua | 210 + .../GuildInfo.lua.annotated.lua | 195 + .../AddOns/Blizzard_Communities/GuildInfo.xml | 460 + .../GuildInfo.xml.annotated.lua | 281 + .../Blizzard_Communities/GuildNameChange.xml | 224 + .../GuildNameChange.xml.annotated.lua | 85 + .../GuildNews.lua.annotated.lua | 331 + .../AddOns/Blizzard_Communities/GuildNews.xml | 446 + .../GuildNews.xml.annotated.lua | 290 + .../GuildPerks.lua.annotated.lua | 66 + .../Blizzard_Communities/GuildPerks.xml | 152 + .../GuildPerks.xml.annotated.lua | 48 + .../GuildRewards.lua.annotated.lua | 281 + .../Blizzard_Communities/GuildRewards.xml | 253 + .../GuildRewards.xml.annotated.lua | 75 + .../GuildRoster.lua.annotated.lua | 190 + .../Blizzard_Communities/GuildRoster.xml | 186 + .../GuildRoster.xml.annotated.lua | 105 + .../Localization.lua.annotated.lua | 36 + .../Mainline/GuildInfo.lua.annotated.lua | 1 + .../Blizzard_CommunitiesSecure.toc | 6 + .../CommunitiesAddDialog.lua.annotated.lua | 211 + .../CommunitiesAddDialog.xml | 369 + .../CommunitiesAddDialog.xml.annotated.lua | 2 + ...unitiesAddDialogOutbound.lua.annotated.lua | 35 + ...ompactRaidFrameContainer.lua.annotated.lua | 485 + .../Blizzard_CompactRaidFrameContainer.xml | 86 + ...ompactRaidFrameContainer.xml.annotated.lua | 64 + ...dFrameReservationManager.lua.annotated.lua | 38 + .../Blizzard_CompactRaidFrames.toc | 8 + .../Localization.lua.annotated.lua | 1 + ..._CompactRaidFrameManager.lua.annotated.lua | 1338 ++ .../Blizzard_CompactRaidFrameManager.xml | 405 + ..._CompactRaidFrameManager.xml.annotated.lua | 306 + .../Blizzard_Console.lua.annotated.lua | 578 + .../Blizzard_Console/Blizzard_Console.toc | 10 + .../Blizzard_Console/Blizzard_Console.xml | 357 + .../Blizzard_Console.xml.annotated.lua | 113 + ...ard_Console_AutoComplete.lua.annotated.lua | 387 + .../Blizzard_Console_AutoComplete.xml | 184 + ...ard_Console_AutoComplete.xml.annotated.lua | 57 + .../Blizzard_ContentTracking.toc | 8 + .../ContentTrackingElement.lua.annotated.lua | 114 + .../ContentTrackingElement.xml | 28 + .../ContentTrackingElement.xml.annotated.lua | 13 + .../ContentTrackingManager.lua.annotated.lua | 168 + .../Blizzard_Contribution.lua.annotated.lua | 509 + .../Blizzard_Contribution.toc | 3 + .../Blizzard_Contribution.xml | 319 + .../Blizzard_Contribution.xml.annotated.lua | 124 + .../Blizzard_CooldownViewer.toc | 27 + .../CooldownViewer.lua.annotated.lua | 2110 +++ .../CooldownViewer.xml | 334 + .../CooldownViewer.xml.annotated.lua | 238 + .../CooldownViewerAlert.lua.annotated.lua | 262 + .../CooldownViewerItemData.lua.annotated.lua | 527 + .../CooldownViewerSettings.lua.annotated.lua | 1717 +++ .../CooldownViewerSettings.xml | 261 + .../CooldownViewerSettings.xml.annotated.lua | 162 + ...downViewerSettingsAlerts.lua.annotated.lua | 212 + .../CooldownViewerSettingsAlerts.xml | 88 + ...downViewerSettingsAlerts.xml.annotated.lua | 62 + ...nViewerSettingsConstants.lua.annotated.lua | 137 + ...ewerSettingsDataProvider.lua.annotated.lua | 342 + ...gsDataStoreSerialization.lua.annotated.lua | 440 + ...ownViewerSettingsDialogs.lua.annotated.lua | 58 + .../CooldownViewerSettingsDialogs.xml | 14 + ...ownViewerSettingsDialogs.xml.annotated.lua | 10 + ...werSettingsLayoutManager.lua.annotated.lua | 978 ++ ...downViewerSoundAlertData.lua.annotated.lua | 87 + .../CooldownViewerUtil.lua.annotated.lua | 53 + ...ooldownViewerVisualAlert.lua.annotated.lua | 84 + ...ownViewerVisualAlertData.lua.annotated.lua | 14 + ...nViewerVisualAlertTarget.lua.annotated.lua | 58 + ...ewerVisualAlertTemplates.lua.annotated.lua | 65 + .../CooldownViewerVisualAlertTemplates.xml | 88 + ...ewerVisualAlertTemplates.xml.annotated.lua | 58 + ...iewerVisualAlertsManager.lua.annotated.lua | 32 + .../CooldownViewerVisualAlertsManager.xml | 8 + ...iewerVisualAlertsManager.xml.annotated.lua | 6 + .../PandemicAlertAnimation.xml | 82 + .../PandemicAlertAnimation.xml.annotated.lua | 38 + .../Blizzard_CovenantCallings.toc | 5 + .../CovenantCallings.lua.annotated.lua | 335 + .../CovenantCallings.xml | 82 + .../CovenantCallings.xml.annotated.lua | 22 + ...izzard_CovenantPreviewUI.lua.annotated.lua | 337 + .../Blizzard_CovenantPreviewUI.toc | 5 + .../Blizzard_CovenantPreviewUI.xml | 313 + ...izzard_CovenantPreviewUI.xml.annotated.lua | 117 + .../Blizzard_CovenantRenown.lua.annotated.lua | 375 + .../Blizzard_CovenantRenown.toc | 4 + .../Blizzard_CovenantRenown.xml | 217 + .../Blizzard_CovenantRenown.xml.annotated.lua | 90 + ...Blizzard_CovenantSanctum.lua.annotated.lua | 50 + .../Blizzard_CovenantSanctum.toc | 5 + .../Blizzard_CovenantSanctum.xml | 53 + ...Blizzard_CovenantSanctum.xml.annotated.lua | 27 + ..._CovenantSanctumUpgrades.lua.annotated.lua | 1105 ++ .../Blizzard_CovenantSanctumUpgrades.xml | 618 + ..._CovenantSanctumUpgrades.xml.annotated.lua | 201 + ...zard_CovenantChoiceToast.lua.annotated.lua | 65 + .../Blizzard_CovenantChoiceToast.xml | 76 + ...zard_CovenantChoiceToast.xml.annotated.lua | 24 + ...zard_CovenantRenownToast.lua.annotated.lua | 212 + .../Blizzard_CovenantRenownToast.xml | 136 + ...zard_CovenantRenownToast.xml.annotated.lua | 31 + .../Blizzard_CovenantToasts.lua.annotated.lua | 44 + .../Blizzard_CovenantToasts.toc | 13 + .../Blizzard_CovenantToasts.xml | 46 + .../Blizzard_CovenantToasts.xml.annotated.lua | 19 + ...tomizationAudioInterface.lua.annotated.lua | 199 + .../Blizzard_CustomizationAudioInterface.xml | 82 + ...tomizationAudioInterface.xml.annotated.lua | 42 + ...omizationOptionTemplates.lua.annotated.lua | 819 ++ .../Blizzard_CustomizationOptionTemplates.xml | 204 + ...omizationOptionTemplates.xml.annotated.lua | 104 + ...d_CustomizationTemplates.lua.annotated.lua | 177 + .../Blizzard_CustomizationTemplates.xml | 72 + ...d_CustomizationTemplates.xml.annotated.lua | 218 + ...Blizzard_CustomizationUI.lua.annotated.lua | 733 ++ .../Blizzard_CustomizationUI.toc | 13 + .../Blizzard_CustomizationUI.xml | 98 + ...Blizzard_CustomizationUI.xml.annotated.lua | 68 + ...izzard_CustomizationUtil.lua.annotated.lua | 14 + .../Blizzard_DamageMeter.toc | 16 + .../DamageMeter.lua.annotated.lua | 616 + .../Blizzard_DamageMeter/DamageMeter.xml | 16 + .../DamageMeter.xml.annotated.lua | 13 + .../DamageMeterConstants.lua.annotated.lua | 19 + .../DamageMeterEntry.lua.annotated.lua | 682 + .../Blizzard_DamageMeter/DamageMeterEntry.xml | 51 + .../DamageMeterEntry.xml.annotated.lua | 38 + ...DamageMeterSessionWindow.lua.annotated.lua | 1078 ++ .../DamageMeterSessionWindow.xml | 137 + ...DamageMeterSessionWindow.xml.annotated.lua | 86 + ...erSettingsDropdownButton.lua.annotated.lua | 38 + .../DamageMeterSettingsDropdownButton.xml | 28 + ...erSettingsDropdownButton.xml.annotated.lua | 13 + .../DamageMeterSourceWindow.lua.annotated.lua | 406 + .../DamageMeterSourceWindow.xml | 61 + .../DamageMeterSourceWindow.xml.annotated.lua | 32 + .../Blizzard_DeathRecap.lua.annotated.lua | 362 + .../Blizzard_DeathRecap.toc | 5 + .../Blizzard_DeathRecap.xml | 229 + .../Blizzard_DeathRecap.xml.annotated.lua | 122 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_DebugTools.lua.annotated.lua | 337 + .../Blizzard_DebugTools.toc | 16 + .../Blizzard_DebugTools.xml | 68 + .../Blizzard_DebugTools.xml.annotated.lua | 213 + .../Blizzard_TableInspector.lua.annotated.lua | 291 + .../Blizzard_TableInspector.xml | 289 + .../Blizzard_TableInspector.xml.annotated.lua | 115 + ...pectorAnchorDataProvider.lua.annotated.lua | 62 + ...zzard_TableInspectorAnchorDataProvider.xml | 50 + ...pectorAnchorDataProvider.xml.annotated.lua | 40 + ...torAttributeDataProvider.lua.annotated.lua | 235 + ...rd_TableInspectorAttributeDataProvider.xml | 118 + ...torAttributeDataProvider.xml.annotated.lua | 59 + ...bleInspectorDataProvider.lua.annotated.lua | 28 + ..._TexelSnappingVisualizer.lua.annotated.lua | 114 + ...ard_TextureInfoGenerator.lua.annotated.lua | 123 + .../DebugObjectUtil.lua.annotated.lua | 4 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_DeclensionFrame_Mainline.toc | 8 + .../DeclensionFrame.lua.annotated.lua | 1 + .../Mainline/DeclensionFrame.xml | 4 + .../DeclensionFrame.xml.annotated.lua | 2 + .../Blizzard_DeclensionFrameGlue_Mainline.toc | 8 + ...lvesCompanionAbilityList.lua.annotated.lua | 454 + .../Blizzard_DelvesCompanionAbilityList.xml | 86 + ...lvesCompanionAbilityList.xml.annotated.lua | 71 + ...esCompanionConfiguration.lua.annotated.lua | 743 ++ .../Blizzard_DelvesCompanionConfiguration.toc | 10 + .../Blizzard_DelvesCompanionConfiguration.xml | 378 + ...esCompanionConfiguration.xml.annotated.lua | 147 + ...d_DelvesDifficultyPicker.lua.annotated.lua | 661 + .../Blizzard_DelvesDifficultyPicker.toc | 7 + .../Blizzard_DelvesDifficultyPicker.xml | 204 + ...d_DelvesDifficultyPicker.xml.annotated.lua | 102 + .../Blizzard_DelvesToast.lua.annotated.lua | 92 + .../Blizzard_DelvesToast.toc | 6 + .../Blizzard_DelvesToast.xml | 55 + .../Blizzard_DelvesToast.xml.annotated.lua | 29 + ...llBookAPITransitionGuide.lua.annotated.lua | 154 + .../Blizzard_Deprecated.toc | 4 + .../Blizzard_DeprecatedActionBar.toc | 7 + .../Deprecated_ActionBar.lua.annotated.lua | 148 + .../Blizzard_DeprecatedBattleNet.toc | 7 + .../Deprecated_BattleNet.lua.annotated.lua | 19 + .../Blizzard_DeprecatedChatInfo.toc | 8 + .../Deprecated_ChatFrame.lua.annotated.lua | 126 + .../Deprecated_ChatInfo.lua.annotated.lua | 23 + .../Blizzard_DeprecatedCombatLog.toc | 7 + .../Deprecated_CombatLog.lua.annotated.lua | 146 + .../Blizzard_DeprecatedCurrencyScript.toc | 7 + ...eprecated_CurrencyScript.lua.annotated.lua | 12 + .../Blizzard_DeprecatedGlue.toc | 7 + .../Deprecated_Glue.lua.annotated.lua | 10 + .../Blizzard_DeprecatedGuildScript.toc | 7 + .../Deprecated_GuildScript.lua.annotated.lua | 17 + .../Blizzard_DeprecatedInstanceEncounter.toc | 7 + ...ecated_InstanceEncounter.lua.annotated.lua | 18 + .../Blizzard_DeprecatedItemScript.toc | 7 + .../Deprecated_ItemScript.lua.annotated.lua | 56 + .../Blizzard_DeprecatedItemSocketInfo.toc | 7 + ...eprecated_ItemSocketInfo.lua.annotated.lua | 34 + .../Blizzard_DeprecatedLFG.toc | 7 + .../Deprecated_LFG.lua.annotated.lua | 16 + .../Blizzard_DeprecatedPetInfo.toc | 7 + .../Deprecated_PetInfo.lua.annotated.lua | 11 + .../Blizzard_DeprecatedPvpScript.toc | 7 + .../Deprecated_PvpScript.lua.annotated.lua | 13 + .../Blizzard_DeprecatedSoundScript.toc | 7 + .../Deprecated_SoundScript.lua.annotated.lua | 10 + .../Blizzard_DeprecatedSpecialization.toc | 8 + .../Blizzard_DeprecatedSpellBook.toc | 7 + .../Deprecated_SpellBook.lua.annotated.lua | 39 + .../Blizzard_DeprecatedSpellScript.toc | 7 + .../Deprecated_SpellScript.lua.annotated.lua | 34 + .../Blizzard_DeprecatedTradeInfo.toc | 7 + .../Deprecated_TradeInfo.lua.annotated.lua | 10 + .../Blizzard_DeprecatedUnitScript.toc | 8 + .../Deprecated_UnitScript.lua.annotated.lua | 12 + ...zzard_DeprecatedWorldElapsedTimerTypes.toc | 7 + ...d_WorldElapsedTimerTypes.lua.annotated.lua | 12 + .../Blizzard_Deprecated_ArenaUI.toc | 6 + .../Deprecated_ArenaUI.lua.annotated.lua | 497 + .../Deprecated_ArenaUI.xml | 451 + .../Deprecated_ArenaUI.xml.annotated.lua | 603 + .../Blizzard_Dispatcher.lua.annotated.lua | 548 + .../Blizzard_Dispatcher.toc | 6 + .../Blizzard_DurabilityFrame.toc | 6 + .../DurabilityFrame.lua.annotated.lua | 138 + .../DurabilityFrame.xml | 103 + .../DurabilityFrame.xml.annotated.lua | 76 + .../Blizzard_EditMode/Blizzard_EditMode.toc | 22 + ...EditModeManagerOverrides.lua.annotated.lua | 68 + .../EditModePresetLayouts.lua.annotated.lua | 1511 +++ ...EditModeAuraDataProvider.lua.annotated.lua | 105 + .../Shared/EditModeDialogs.lua.annotated.lua | 686 + .../Shared/EditModeDialogs.xml | 327 + .../Shared/EditModeDialogs.xml.annotated.lua | 202 + ...ditModeLayoutManagerUtil.lua.annotated.lua | 33 + .../Shared/EditModeManager.lua.annotated.lua | 2780 ++++ .../Shared/EditModeManager.xml | 518 + .../Shared/EditModeManager.xml.annotated.lua | 446 + ...EditModeManagerOverrides.lua.annotated.lua | 33 + ...ePresetLayoutSystemUtils.lua.annotated.lua | 32 + ...ModePresetLayoutsManager.lua.annotated.lua | 95 + ...itModeSettingDisplayInfo.lua.annotated.lua | 1317 ++ .../EditModeSystemTemplates.lua.annotated.lua | 3418 +++++ .../Shared/EditModeSystemTemplates.xml | 392 + .../EditModeSystemTemplates.xml.annotated.lua | 279 + .../EditModeTemplates.lua.annotated.lua | 323 + .../Shared/EditModeTemplates.xml | 178 + .../EditModeTemplates.xml.annotated.lua | 99 + .../Shared/EditModeUtil.lua.annotated.lua | 476 + .../Blizzard_EncounterJournal_Mainline.toc | 18 + .../Localization.lua.annotated.lua | 23 + ...lizzard_EncounterJournal.lua.annotated.lua | 3671 ++++++ .../Mainline/Blizzard_EncounterJournal.xml | 2508 ++++ ...lizzard_EncounterJournal.xml.annotated.lua | 1797 +++ .../Blizzard_Journeys.lua.annotated.lua | 974 ++ .../Mainline/Blizzard_Journeys.xml | 642 + .../Blizzard_Journeys.xml.annotated.lua | 303 + .../Blizzard_LootJournal.lua.annotated.lua | 219 + .../Mainline/Blizzard_LootJournal.xml | 136 + .../Blizzard_LootJournal.xml.annotated.lua | 27 + ...lizzard_LootJournalItems.lua.annotated.lua | 299 + .../Mainline/Blizzard_LootJournalItems.xml | 122 + ...lizzard_LootJournalItems.xml.annotated.lua | 29 + ...izzard_MonthlyActivities.lua.annotated.lua | 1686 +++ .../Mainline/Blizzard_MonthlyActivities.xml | 599 + ...izzard_MonthlyActivities.xml.annotated.lua | 271 + .../Blizzard_EncounterTimeline.toc | 26 + .../EncounterTimeline.lua.annotated.lua | 437 + .../EncounterTimeline.xml | 35 + .../EncounterTimeline.xml.annotated.lua | 35 + ...counterTimelineConstants.lua.annotated.lua | 220 + ...nterTimelineDataProvider.lua.annotated.lua | 149 + ...ounterTimelineEventFrame.lua.annotated.lua | 205 + .../EncounterTimelineEventFrame.xml | 13 + ...ounterTimelineEventFrame.xml.annotated.lua | 6 + ...nterTimelineFrameManager.lua.annotated.lua | 152 + ...ineScriptedAnimationUtil.lua.annotated.lua | 58 + ...ncounterTimelineSettings.lua.annotated.lua | 365 + ...counterTimelineTemplates.lua.annotated.lua | 259 + .../EncounterTimelineTemplates.xml | 188 + ...counterTimelineTemplates.xml.annotated.lua | 129 + ...ounterTimelineTimerEvent.lua.annotated.lua | 759 ++ .../EncounterTimelineTimerEvent.xml | 75 + ...ounterTimelineTimerEvent.xml.annotated.lua | 41 + ...counterTimelineTimerView.lua.annotated.lua | 594 + .../EncounterTimelineTimerView.xml | 47 + ...counterTimelineTimerView.xml.annotated.lua | 29 + ...ounterTimelineTrackEvent.lua.annotated.lua | 824 ++ .../EncounterTimelineTrackEvent.xml | 59 + ...ounterTimelineTrackEvent.xml.annotated.lua | 52 + ...unterTimelineTrackLayout.lua.annotated.lua | 317 + ...counterTimelineTrackView.lua.annotated.lua | 340 + .../EncounterTimelineTrackView.xml | 36 + ...counterTimelineTrackView.xml.annotated.lua | 38 + .../EncounterTimelineUtil.lua.annotated.lua | 213 + .../EncounterTimelineView.lua.annotated.lua | 351 + .../Blizzard_EncounterWarnings.toc | 13 + .../EncounterWarnings.lua.annotated.lua | 177 + .../EncounterWarnings.xml | 47 + .../EncounterWarnings.xml.annotated.lua | 41 + ...counterWarningsConstants.lua.annotated.lua | 43 + ...ncounterWarningsSettings.lua.annotated.lua | 36 + .../EncounterWarningsUtil.lua.annotated.lua | 53 + .../EncounterWarningsView.lua.annotated.lua | 254 + .../EncounterWarningsView.xml | 40 + .../EncounterWarningsView.xml.annotated.lua | 27 + ...nterWarningsViewElements.lua.annotated.lua | 84 + .../EncounterWarningsViewElements.xml | 63 + ...nterWarningsViewElements.xml.annotated.lua | 42 + .../Blizzard_EndOfMatchUI.toc | 8 + .../Blizzard_EnvironmentCleanup_Mainline.toc | 9 + .../EnvironmentCleanup.lua.annotated.lua | 292 + .../Blizzard_EventTrace.lua.annotated.lua | 994 ++ .../Blizzard_EventTrace.toc | 8 + .../Blizzard_EventTrace.xml | 386 + .../Blizzard_EventTrace.xml.annotated.lua | 444 + .../Blizzard_ExpansionTrial.lua.annotated.lua | 191 + .../Blizzard_ExpansionTrial.toc | 4 + .../Blizzard_ExpansionTrial.xml | 134 + .../Blizzard_ExpansionTrial.xml.annotated.lua | 71 + .../Blizzard_FlightMap.lua.annotated.lua | 119 + .../Blizzard_FlightMap/Blizzard_FlightMap.toc | 12 + .../Blizzard_FlightMap/Blizzard_FlightMap.xml | 45 + .../Blizzard_FlightMap.xml.annotated.lua | 29 + .../FM_AreaPOIDataProvider.lua.annotated.lua | 19 + .../FM_AreaPOIDataProvider.xml | 6 + .../FM_AreaPOIDataProvider.xml.annotated.lua | 6 + ...M_FlightPathDataProvider.lua.annotated.lua | 354 + .../FM_FlightPathDataProvider.xml | 60 + ...M_FlightPathDataProvider.xml.annotated.lua | 44 + .../FM_QuestDataProvider.lua.annotated.lua | 33 + .../FM_QuestDataProvider.xml | 6 + .../FM_QuestDataProvider.xml.annotated.lua | 6 + .../FM_VignetteDataProvider.lua.annotated.lua | 24 + .../FM_VignetteDataProvider.xml | 6 + .../FM_VignetteDataProvider.xml.annotated.lua | 6 + ...M_WorldQuestDataProvider.lua.annotated.lua | 26 + .../FM_WorldQuestDataProvider.xml | 6 + ...M_WorldQuestDataProvider.xml.annotated.lua | 6 + ..._ZoneSummaryDataProvider.lua.annotated.lua | 76 + .../FM_ZoneSummaryDataProvider.xml | 4 + ..._ZoneSummaryDataProvider.xml.annotated.lua | 2 + .../Blizzard_Flyout/Blizzard_Flyout.toc | 8 + .../Blizzard_Flyout/Flyout.lua.annotated.lua | 371 + .../AddOns/Blizzard_Flyout/Flyout.xml | 67 + .../Blizzard_Flyout/Flyout.xml.annotated.lua | 36 + .../Blizzard_Fonts_Shared.toc | 15 + .../Mainline/FontStyles.xml | 92 + .../Mainline/FontStyles.xml.annotated.lua | 122 + .../Blizzard_Fonts_Shared/Mainline/Fonts.xml | 909 ++ .../Mainline/Fonts.xml.annotated.lua | 118 + .../Mainline/GameFontStyles.xml | 81 + .../Mainline/GameFontStyles.xml.annotated.lua | 50 + .../Mainline/GameFonts.xml | 488 + .../Mainline/GameFonts.xml.annotated.lua | 94 + .../Shared/FontStyles.xml | 442 + .../Shared/FontStyles.xml.annotated.lua | 554 + .../Blizzard_Fonts_Shared/Shared/Fonts.xml | 1913 +++ .../Shared/Fonts.xml.annotated.lua | 246 + .../Shared/GameFontStyles.xml | 237 + .../Shared/GameFontStyles.xml.annotated.lua | 247 + .../Shared/GameFonts.xml | 1637 +++ .../Shared/GameFonts.xml.annotated.lua | 286 + .../Blizzard_FrameEffects.toc | 7 + .../EffectFactory.lua.annotated.lua | 85 + .../GlowEmitter.lua.annotated.lua | 49 + .../Blizzard_FrameEffects/GlowEmitter.xml | 70 + .../GlowEmitter.xml.annotated.lua | 36 + .../Blizzard_FrameEffects/PowerSwirl.xml | 85 + .../PowerSwirl.xml.annotated.lua | 43 + .../Blizzard_FrameStack.toc | 3 + .../FrameStack.lua.annotated.lua | 23 + .../AchievementDisplayFrame.lua.annotated.lua | 140 + .../AchievementDisplayFrame.xml | 83 + .../AchievementDisplayFrame.xml.annotated.lua | 34 + .../ArchaeologyProgressBar.lua.annotated.lua | 142 + .../ArchaeologyProgressBar.xml | 98 + .../ArchaeologyProgressBar.xml.annotated.lua | 57 + .../ArtifactToasts.lua.annotated.lua | 76 + .../Blizzard_FrameXML/ArtifactToasts.xml | 265 + .../ArtifactToasts.xml.annotated.lua | 50 + .../AzeriteAnimationTemplates.xml | 129 + ...zeriteAnimationTemplates.xml.annotated.lua | 49 + ...eEmpoweredItemDataSource.lua.annotated.lua | 141 + .../AzeriteIslandsToast.lua.annotated.lua | 147 + .../Blizzard_FrameXML/AzeriteIslandsToast.xml | 76 + .../AzeriteIslandsToast.xml.annotated.lua | 45 + .../AzeriteItemToasts.lua.annotated.lua | 190 + .../Blizzard_FrameXML/AzeriteItemToasts.xml | 362 + .../AzeriteItemToasts.xml.annotated.lua | 98 + .../BattlePetTooltip.lua.annotated.lua | 55 + .../Blizzard_FrameXML/BattlePetTooltip.xml | 9 + .../BattlePetTooltip.xml.annotated.lua | 7 + .../Blizzard_FrameXML_Mainline.toc | 93 + .../BossBannerToast.lua.annotated.lua | 300 + .../Blizzard_FrameXML/BossBannerToast.xml | 357 + .../BossBannerToast.xml.annotated.lua | 90 + .../CustomBindingHandler.lua.annotated.lua | 36 + .../CustomBindingManager.lua.annotated.lua | 129 + .../CustomizationDebugFrame.lua.annotated.lua | 23 + .../CustomizationDebugFrame.xml | 19 + .../CustomizationDebugFrame.xml.annotated.lua | 11 + .../DeprecatedTemplates.lua.annotated.lua | 34 + .../Blizzard_FrameXML/DeprecatedTemplates.xml | 159 + .../DeprecatedTemplates.xml.annotated.lua | 42 + .../DestinyFrame.lua.annotated.lua | 38 + .../AddOns/Blizzard_FrameXML/DestinyFrame.xml | 158 + .../DestinyFrame.xml.annotated.lua | 82 + .../EquipmentFlyout.lua.annotated.lua | 669 + .../Blizzard_FrameXML/EquipmentFlyout.xml | 145 + .../EquipmentFlyout.xml.annotated.lua | 63 + .../EquipmentManager.lua.annotated.lua | 299 + .../EventToastManager.lua.annotated.lua | 1347 ++ .../Blizzard_FrameXML/EventToastManager.xml | 1489 +++ .../EventToastManager.xml.annotated.lua | 606 + ...FloatingPetBattleTooltip.lua.annotated.lua | 174 + .../FloatingPetBattleTooltip.xml | 151 + ...FloatingPetBattleTooltip.xml.annotated.lua | 72 + .../GhostFrame.lua.annotated.lua | 15 + .../AddOns/Blizzard_FrameXML/GhostFrame.xml | 45 + .../GhostFrame.xml.annotated.lua | 51 + .../GuildInviteFrame.lua.annotated.lua | 44 + .../Blizzard_FrameXML/GuildInviteFrame.xml | 166 + .../GuildInviteFrame.xml.annotated.lua | 135 + .../GuildUtil.lua.annotated.lua | 203 + .../IconIntroAnimation.lua.annotated.lua | 139 + .../Blizzard_FrameXML/IconIntroAnimation.xml | 111 + .../IconIntroAnimation.xml.annotated.lua | 47 + .../InstanceDifficulty.lua.annotated.lua | 229 + .../Blizzard_FrameXML/InstanceDifficulty.xml | 185 + .../InstanceDifficulty.xml.annotated.lua | 146 + .../ItemDisplay.lua.annotated.lua | 123 + .../AddOns/Blizzard_FrameXML/ItemDisplay.xml | 148 + .../ItemDisplay.xml.annotated.lua | 57 + .../LossOfControlFrame.lua.annotated.lua | 234 + .../Blizzard_FrameXML/LossOfControlFrame.xml | 115 + .../LossOfControlFrame.xml.annotated.lua | 40 + .../AlertFrameSystems.lua.annotated.lua | 1484 +++ .../Mainline/AlertFrameSystems.xml | 3198 +++++ .../AlertFrameSystems.xml.annotated.lua | 1463 +++ .../Mainline/AlertFrames.lua.annotated.lua | 908 ++ .../Mainline/AlertFrames.xml | 28 + .../Mainline/AlertFrames.xml.annotated.lua | 14 + .../CoinPickupFrame.lua.annotated.lua | 250 + .../Mainline/CoinPickupFrame.xml | 99 + .../CoinPickupFrame.xml.annotated.lua | 55 + .../ColorPickerFrame.lua.annotated.lua | 164 + .../Mainline/ColorPickerFrame.xml | 210 + .../ColorPickerFrame.xml.annotated.lua | 92 + .../Mainline/CombatFeedback.lua.annotated.lua | 120 + .../InstanceAbandon.lua.annotated.lua | 231 + .../Mainline/InstanceAbandon.xml | 66 + .../InstanceAbandon.xml.annotated.lua | 200 + .../Mainline/Localization.lua.annotated.lua | 48 + .../Mainline/LootHistory.lua.annotated.lua | 622 + .../Mainline/LootHistory.xml | 431 + .../Mainline/LootHistory.xml.annotated.lua | 184 + .../Mainline/LowHealthFrame.xml | 19 + .../Mainline/LowHealthFrame.xml.annotated.lua | 12 + .../Mainline/NavigationBar.lua.annotated.lua | 313 + .../Mainline/NavigationBar.xml | 347 + .../Mainline/NavigationBar.xml.annotated.lua | 42 + .../Mainline/RaidWarning.xml | 74 + .../Mainline/RaidWarning.xml.annotated.lua | 40 + .../Mainline/RatingMenuFrame.xml | 98 + .../RatingMenuFrame.xml.annotated.lua | 50 + .../Mainline/ReadyCheck.lua.annotated.lua | 170 + .../Blizzard_FrameXML/Mainline/ReadyCheck.xml | 120 + .../Mainline/ReadyCheck.xml.annotated.lua | 63 + .../StackSplitFrame.lua.annotated.lua | 244 + .../Mainline/StackSplitFrame.xml | 75 + .../StackSplitFrame.xml.annotated.lua | 38 + .../Mainline/StreamingFrame.lua.annotated.lua | 64 + .../Mainline/StreamingFrame.xml | 61 + .../Mainline/StreamingFrame.xml.annotated.lua | 46 + .../Mainline/TutorialFrame.lua.annotated.lua | 740 ++ .../Mainline/TutorialFrame.xml | 314 + .../Mainline/TutorialFrame.xml.annotated.lua | 210 + .../Mainline/ZoneText.lua.annotated.lua | 177 + .../Blizzard_FrameXML/Mainline/ZoneText.xml | 76 + .../Mainline/ZoneText.xml.annotated.lua | 39 + .../MotionSickness.lua.annotated.lua | 157 + .../Blizzard_FrameXML/MotionSickness.xml | 59 + .../MotionSickness.xml.annotated.lua | 13 + .../MovieFrame.lua.annotated.lua | 94 + .../AddOns/Blizzard_FrameXML/MovieFrame.xml | 70 + .../MovieFrame.xml.annotated.lua | 27 + .../PVPHonorSystem.lua.annotated.lua | 350 + .../Blizzard_FrameXML/PVPHonorSystem.xml | 991 ++ .../PVPHonorSystem.xml.annotated.lua | 231 + .../PVPUITemplates.lua.annotated.lua | 186 + .../Blizzard_FrameXML/PVPUITemplates.xml | 140 + .../PVPUITemplates.xml.annotated.lua | 38 + .../QuestNPCModelFrameMixin.lua.annotated.lua | 11 + .../QuestSession.lua.annotated.lua | 1093 ++ .../AddOns/Blizzard_FrameXML/QuestSession.xml | 310 + .../QuestSession.xml.annotated.lua | 208 + .../RewardTrackTemplates.lua.annotated.lua | 486 + .../RewardTrackTemplates.xml | 421 + .../RewardTrackTemplates.xml.annotated.lua | 164 + .../RolePoll.lua.annotated.lua | 114 + .../AddOns/Blizzard_FrameXML/RolePoll.xml | 132 + .../RolePoll.xml.annotated.lua | 55 + .../SecureTemplates.lua.annotated.lua | 849 ++ .../Blizzard_FrameXML/SecureTemplates.xml | 26 + .../SecureTemplates.xml.annotated.lua | 16 + .../Blizzard_FrameXML/SecureTemplatesBase.xml | 12 + .../SecureTemplatesBase.xml.annotated.lua | 12 + .../Shared/CinematicFrame.lua.annotated.lua | 141 + .../Shared/CinematicFrame.xml | 104 + .../Shared/CinematicFrame.xml.annotated.lua | 58 + .../Shared/EquipmentManager.lua.annotated.lua | 29 + .../Shared/Localization.lua.annotated.lua | 55 + .../Shared/LowHealthFrame.lua.annotated.lua | 178 + ...SharedPetBattleTemplates.lua.annotated.lua | 575 + .../SharedPetBattleTemplates.xml | 115 + ...SharedPetBattleTemplates.xml.annotated.lua | 75 + .../SpellActivationOverlay.lua.annotated.lua | 200 + .../SpellActivationOverlay.xml | 43 + .../SpellActivationOverlay.xml.annotated.lua | 26 + .../SplashFrame.lua.annotated.lua | 206 + .../AddOns/Blizzard_FrameXML/SplashFrame.xml | 186 + .../SplashFrame.xml.annotated.lua | 81 + .../TabardModelFrameMixin.lua.annotated.lua | 14 + .../TalentFrameBase.lua.annotated.lua | 350 + .../TalentFrameTemplates.xml | 71 + .../TalentFrameTemplates.xml.annotated.lua | 28 + .../TalkingHeadUI.lua.annotated.lua | 339 + .../Blizzard_FrameXML/TalkingHeadUI.xml | 221 + .../TalkingHeadUI.xml.annotated.lua | 137 + .../Blizzard_FrameXML/Timer.lua.annotated.lua | 405 + .../AddOns/Blizzard_FrameXML/Timer.xml | 162 + .../Blizzard_FrameXML/Timer.xml.annotated.lua | 46 + .../TopBannerManager.lua.annotated.lua | 63 + .../UIErrorsFrame.lua.annotated.lua | 195 + .../Blizzard_FrameXML/UIErrorsFrame.xml | 16 + .../UIErrorsFrame.xml.annotated.lua | 6 + .../WardrobeCustomSets.lua.annotated.lua | 512 + .../Blizzard_FrameXML/WardrobeCustomSets.xml | 180 + .../WardrobeCustomSets.xml.annotated.lua | 62 + .../AnimatedStatusBar.lua.annotated.lua | 372 + .../AnimatedStatusBar.xml | 142 + .../AnimatedStatusBar.xml.annotated.lua | 31 + .../Blizzard_FrameXMLBase_Mainline.toc | 17 + .../Constants.lua.annotated.lua | 632 + .../FlowContainer.lua.annotated.lua | 240 + ...GradualAnimatedStatusBar.lua.annotated.lua | 446 + .../GradualAnimatedStatusBar.xml | 70 + ...GradualAnimatedStatusBar.xml.annotated.lua | 31 + .../Mainline/FrameLocks.lua.annotated.lua | 230 + .../IconDataProvider.lua.annotated.lua | 264 + .../Mainline/Localization.lua.annotated.lua | 33 + ...PlayerMovementFrameFader.lua.annotated.lua | 85 + .../PowerDependencyLine.lua.annotated.lua | 229 + .../PowerDependencyLine.xml | 70 + .../PowerDependencyLine.xml.annotated.lua | 55 + .../Shared/Constants.lua.annotated.lua | 46 + .../AchievementUtil.lua.annotated.lua | 44 + .../AdventureGuideUtil.lua.annotated.lua | 40 + .../AnimationSystem.lua.annotated.lua | 74 + .../AreaPoiUtil.lua.annotated.lua | 72 + .../ArenaUtil.lua.annotated.lua | 31 + .../AuraUtil.lua.annotated.lua | 501 + .../AzeriteEssenceUtil.lua.annotated.lua | 44 + .../AzeriteUtil.lua.annotated.lua | 137 + .../Blizzard_FrameXMLUtil_Mainline.toc | 44 + .../CalendarUtil.lua.annotated.lua | 44 + .../CampaignUtil.lua.annotated.lua | 47 + .../CollectionsUtil.lua.annotated.lua | 509 + .../CommunitiesUtil.lua.annotated.lua | 356 + .../Cooldown.lua.annotated.lua | 19 + .../CurrencyContainer.lua.annotated.lua | 18 + .../CurrencyUtil.lua.annotated.lua | 36 + .../DifficultyUtil.lua.annotated.lua | 141 + .../DragonridingUtil.lua.annotated.lua | 55 + .../FadingFrame.lua.annotated.lua | 56 + .../ItemUtil.lua.annotated.lua | 389 + .../Localization.lua.annotated.lua | 26 + .../Mainline/AuraUtil.lua.annotated.lua | 24 + ...zzard_QuestSuperTracking.lua.annotated.lua | 141 + .../Mainline/Cooldown.xml | 12 + .../Mainline/Cooldown.xml.annotated.lua | 6 + .../Mainline/ExpansionUtil.lua.annotated.lua | 4 + .../Mainline/MapUtil.lua.annotated.lua | 158 + .../Mainline/MinimapUtil.lua.annotated.lua | 51 + .../PlayerSpellsUtil.lua.annotated.lua | 168 + .../Mainline/QuestUtils.lua.annotated.lua | 1056 ++ .../Mainline/RAFUtil.lua.annotated.lua | 26 + .../Mainline/RaidWarning.lua.annotated.lua | 184 + .../Mainline/ReputationUtil.lua.annotated.lua | 57 + .../Mainline/TraitUtil.lua.annotated.lua | 46 + .../PVPUtil.lua.annotated.lua | 29 + .../PartyUtil.lua.annotated.lua | 113 + .../ProfessionsUtil.lua.annotated.lua | 164 + .../RenownRewardUtil.lua.annotated.lua | 135 + .../RuneforgeUtil.lua.annotated.lua | 345 + .../Blizzard_FrameXMLUtil/RuneforgeUtil.xml | 37 + .../RuneforgeUtil.xml.annotated.lua | 9 + .../TitleUtil.lua.annotated.lua | 8 + .../Blizzard_FramerateFrame.toc | 7 + .../FramerateFrame.lua.annotated.lua | 74 + .../FramerateFrame.xml | 26 + .../FramerateFrame.xml.annotated.lua | 16 + .../Blizzard_FriendsFrame.toc | 10 + .../Mainline/FriendsFrame.lua.annotated.lua | 3116 +++++ .../Mainline/FriendsFrame.xml | 1858 +++ .../Mainline/FriendsFrame.xml.annotated.lua | 1081 ++ .../Mainline/Localization.lua.annotated.lua | 65 + .../Blizzard_GMChatUI.lua.annotated.lua | 194 + .../Blizzard_GMChatUI/Blizzard_GMChatUI.toc | 6 + .../Blizzard_GMChatUI/Blizzard_GMChatUI.xml | 136 + .../Blizzard_GMChatUI.xml.annotated.lua | 259 + .../Localization.lua.annotated.lua | 19 + .../Blizzard_GameMenu_Mainline.toc | 9 + .../Shared/GameMenuFrame.lua.annotated.lua | 179 + .../Shared/GameMenuFrame.xml | 41 + .../Shared/GameMenuFrame.xml.annotated.lua | 29 + .../Shared/Localization.lua.annotated.lua | 27 + .../Blizzard_GameModeSelect_Mainline.toc | 8 + .../Blizzard_GameTooltip_Mainline.toc | 8 + .../HealthBar.lua.annotated.lua | 32 + .../Mainline/GameTooltip.lua.annotated.lua | 1087 ++ .../Mainline/GameTooltip.xml | 330 + .../Mainline/GameTooltip.xml.annotated.lua | 1631 +++ ...dventuresFollowerTooltip.lua.annotated.lua | 14 + .../AdventuresFollowerTooltip.xml | 49 + ...dventuresFollowerTooltip.xml.annotated.lua | 20 + .../Blizzard_GarrisonBase.toc | 9 + ...gGarrisonFollowerTooltip.lua.annotated.lua | 711 + .../FloatingGarrisonFollowerTooltip.xml | 488 + ...gGarrisonFollowerTooltip.xml.annotated.lua | 271 + .../GarrisonBaseUtils.lua.annotated.lua | 624 + .../GarrisonBaseUtils.xml | 54 + .../GarrisonBaseUtils.xml.annotated.lua | 16 + .../GarrisonFollowerTooltip.lua.annotated.lua | 132 + .../GarrisonFollowerTooltip.xml | 34 + .../GarrisonFollowerTooltip.xml.annotated.lua | 36 + ...CovenantMissionTemplates.lua.annotated.lua | 849 ++ .../Blizzard_CovenantMissionTemplates.xml | 1115 ++ ...CovenantMissionTemplates.xml.annotated.lua | 457 + ...GarrisonMissionTemplates.lua.annotated.lua | 2975 +++++ .../Blizzard_GarrisonMissionTemplates.xml | 1626 +++ ...GarrisonMissionTemplates.xml.annotated.lua | 1048 ++ ..._GarrisonSharedTemplates.lua.annotated.lua | 2842 ++++ .../Blizzard_GarrisonSharedTemplates.xml | 780 ++ ..._GarrisonSharedTemplates.xml.annotated.lua | 257 + .../Blizzard_GarrisonTemplates.toc | 9 + .../Localization.lua.annotated.lua | 30 + .../Blizzard_GarrisonUI_Mainline.toc | 38 + ...Blizzard_AdventuresBoard.lua.annotated.lua | 730 + .../Mainline/Blizzard_AdventuresBoard.xml | 155 + ...Blizzard_AdventuresBoard.xml.annotated.lua | 107 + ...zard_AdventuresCombatLog.lua.annotated.lua | 149 + .../Mainline/Blizzard_AdventuresCombatLog.xml | 59 + ...zard_AdventuresCombatLog.xml.annotated.lua | 22 + ...AdventuresCompleteScreen.lua.annotated.lua | 574 + .../Blizzard_AdventuresCompleteScreen.xml | 180 + ...AdventuresCompleteScreen.xml.annotated.lua | 89 + .../Blizzard_AdventuresPuck.lua.annotated.lua | 526 + .../Mainline/Blizzard_AdventuresPuck.xml | 220 + .../Blizzard_AdventuresPuck.xml.annotated.lua | 98 + ..._AdventuresRewardsScreen.lua.annotated.lua | 220 + .../Blizzard_AdventuresRewardsScreen.xml | 264 + ..._AdventuresRewardsScreen.xml.annotated.lua | 133 + .../Blizzard_BFAMissionUI.lua.annotated.lua | 383 + .../Mainline/Blizzard_BFAMissionUI.xml | 327 + .../Blizzard_BFAMissionUI.xml.annotated.lua | 219 + ...izzard_CovenantMissionUI.lua.annotated.lua | 1377 ++ .../Mainline/Blizzard_CovenantMissionUI.xml | 592 + ...izzard_CovenantMissionUI.xml.annotated.lua | 327 + ...zzard_GarrisonBuildingUI.lua.annotated.lua | 1884 +++ .../Mainline/Blizzard_GarrisonBuildingUI.xml | 1502 +++ ...zzard_GarrisonBuildingUI.xml.annotated.lua | 508 + ...arrisonCapacitiveDisplay.lua.annotated.lua | 352 + .../Blizzard_GarrisonCapacitiveDisplay.xml | 349 + ...arrisonCapacitiveDisplay.xml.annotated.lua | 155 + ...zard_GarrisonLandingPage.lua.annotated.lua | 966 ++ .../Mainline/Blizzard_GarrisonLandingPage.xml | 1129 ++ ...zard_GarrisonLandingPage.xml.annotated.lua | 577 + ...izzard_GarrisonMissionUI.lua.annotated.lua | 1632 +++ .../Mainline/Blizzard_GarrisonMissionUI.xml | 2044 +++ ...izzard_GarrisonMissionUI.xml.annotated.lua | 888 ++ ...zzard_GarrisonMonumentUI.lua.annotated.lua | 118 + .../Mainline/Blizzard_GarrisonMonumentUI.xml | 109 + ...zzard_GarrisonMonumentUI.xml.annotated.lua | 41 + ...zard_GarrisonRecruiterUI.lua.annotated.lua | 402 + .../Mainline/Blizzard_GarrisonRecruiterUI.xml | 462 + ...zard_GarrisonRecruiterUI.xml.annotated.lua | 254 + ...zzard_GarrisonShipyardUI.lua.annotated.lua | 2258 ++++ .../Mainline/Blizzard_GarrisonShipyardUI.xml | 1897 +++ ...zzard_GarrisonShipyardUI.xml.annotated.lua | 1024 ++ ...zzard_OrderHallMissionUI.lua.annotated.lua | 1113 ++ .../Mainline/Blizzard_OrderHallMissionUI.xml | 755 ++ ...zzard_OrderHallMissionUI.xml.annotated.lua | 425 + .../Mainline/Localization.lua.annotated.lua | 57 + .../Blizzard_GenericShoppingCart.toc | 11 + ...cShoppingCartDataManager.lua.annotated.lua | 133 + ...ShoppingCartServicesBase.lua.annotated.lua | 28 + ...ricShoppingCartTemplates.lua.annotated.lua | 441 + .../Blizzard_GenericShoppingCartTemplates.xml | 311 + ...ricShoppingCartTemplates.xml.annotated.lua | 143 + ...izzard_GenericTraitFrame.lua.annotated.lua | 370 + .../Blizzard_GenericTraitFrame.xml | 134 + ...izzard_GenericTraitFrame.xml.annotated.lua | 83 + .../Blizzard_GenericTraitUI.toc | 7 + ...lizzard_GenericTraitUtil.lua.annotated.lua | 146 + .../Blizzard_GlobalFXModelScenes.toc | 5 + .../GlobalFXModelScenes.xml | 6 + .../GlobalFXModelScenes.xml.annotated.lua | 17 + .../Blizzard_GlueCollections.toc | 9 + .../Blizzard_GlueMenuFrame_Mainline.toc | 10 + .../Blizzard_GlueParent_Mainline.toc | 11 + .../Blizzard_GlueSavedVariables.toc | 4 + .../Blizzard_GlueStubs/Blizzard_GlueStubs.toc | 7 + .../Blizzard_GlueXML_Mainline.toc | 75 + .../Blizzard_GlueXMLBase_Mainline.toc | 14 + .../Blizzard_GroupFinder_Mainline.toc | 27 + .../Mainline/LFDFrame.lua.annotated.lua | 939 ++ .../Mainline/LFDFrame.xml | 424 + .../Mainline/LFDFrame.xml.annotated.lua | 581 + .../Mainline/LFGFrame.xml | 1146 ++ .../Mainline/LFGFrame.xml.annotated.lua | 722 + .../Mainline/LFGList.lua.annotated.lua | 4667 +++++++ .../Blizzard_GroupFinder/Mainline/LFGList.xml | 2119 +++ .../Mainline/LFGList.xml.annotated.lua | 948 ++ .../Mainline/PVEFrame.lua.annotated.lua | 551 + .../Mainline/PVEFrame.xml | 297 + .../Mainline/PVEFrame.xml.annotated.lua | 242 + .../Mainline/PVPHelper.lua.annotated.lua | 475 + .../Mainline/PVPHelper.xml | 372 + .../Mainline/PVPHelper.xml.annotated.lua | 273 + .../Mainline/PvpPopup.lua.annotated.lua | 145 + .../Mainline/PvpPopup.xml | 80 + .../Mainline/PvpPopup.xml.annotated.lua | 46 + .../Mainline/QueueUpdater.lua.annotated.lua | 43 + .../Mainline/ScenarioFinder.lua.annotated.lua | 19 + .../Shared/LFGFrame.lua.annotated.lua | 2366 ++++ .../Shared/LFGReadyCheck.lua.annotated.lua | 28 + .../Shared/LFGReadyCheck.xml | 52 + .../Shared/LFGReadyCheck.xml.annotated.lua | 26 + .../Shared/RaidFinder.lua.annotated.lua | 604 + .../Shared/RaidFinder.xml | 270 + .../Shared/RaidFinder.xml.annotated.lua | 472 + .../Shared/ScenarioFinder.xml | 241 + .../Shared/ScenarioFinder.xml.annotated.lua | 399 + .../ScenarioFinder_Shared.lua.annotated.lua | 340 + .../Blizzard_GuildBankUI.lua.annotated.lua | 902 ++ .../Blizzard_GuildBankUI.toc | 4 + .../Blizzard_GuildBankUI.xml | 816 ++ .../Blizzard_GuildBankUI.xml.annotated.lua | 634 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_GuildControlUI.lua.annotated.lua | 488 + .../Blizzard_GuildControlUI.toc | 8 + .../Blizzard_GuildControlUI.xml | 665 + .../Blizzard_GuildControlUI.xml.annotated.lua | 508 + .../Localization.lua.annotated.lua | 31 + .../Blizzard_GuildRename.lua.annotated.lua | 615 + .../Blizzard_GuildRename.toc | 7 + .../Blizzard_GuildRename.xml | 192 + .../Blizzard_GuildRename.xml.annotated.lua | 150 + .../Blizzard_HUDInventoryTemplates.toc | 11 + .../Blizzard_HelpFrame/Blizzard_HelpFrame.toc | 7 + .../HelpFrame.lua.annotated.lua | 273 + .../AddOns/Blizzard_HelpFrame/HelpFrame.xml | 408 + .../HelpFrame.xml.annotated.lua | 195 + .../Blizzard_HelpPlate.lua.annotated.lua | 346 + .../Blizzard_HelpPlate/Blizzard_HelpPlate.toc | 5 + .../Blizzard_HelpPlate/Blizzard_HelpPlate.xml | 567 + .../Blizzard_HelpPlate.xml.annotated.lua | 329 + .../Blizzard_HouseEditor.lua.annotated.lua | 164 + .../Blizzard_HouseEditor.toc | 47 + .../Blizzard_HouseEditor.xml | 75 + .../Blizzard_HouseEditor.xml.annotated.lua | 69 + ...ouseEditorBasicDecorMode.lua.annotated.lua | 296 + .../Blizzard_HouseEditorBasicDecorMode.xml | 112 + ...ouseEditorBasicDecorMode.xml.annotated.lua | 113 + ...d_HouseEditorCleanupMode.lua.annotated.lua | 65 + .../Blizzard_HouseEditorCleanupMode.xml | 25 + ...d_HouseEditorCleanupMode.xml.annotated.lua | 24 + ...ustomizationDyeTemplates.lua.annotated.lua | 409 + ...d_HouseEditorCustomizationDyeTemplates.xml | 318 + ...ustomizationDyeTemplates.xml.annotated.lua | 162 + ...stomizationRoomTemplates.lua.annotated.lua | 376 + ..._HouseEditorCustomizationRoomTemplates.xml | 184 + ...stomizationRoomTemplates.xml.annotated.lua | 112 + ...HouseEditorCustomizeMode.lua.annotated.lua | 219 + .../Blizzard_HouseEditorCustomizeMode.xml | 44 + ...HouseEditorCustomizeMode.xml.annotated.lua | 39 + ...useEditorExpertDecorMode.lua.annotated.lua | 278 + .../Blizzard_HouseEditorExpertDecorMode.xml | 243 + ...useEditorExpertDecorMode.xml.annotated.lua | 235 + ...xteriorCustomizationMode.lua.annotated.lua | 246 + ...d_HouseEditorExteriorCustomizationMode.xml | 99 + ...xteriorCustomizationMode.xml.annotated.lua | 63 + ...itorExteriorFixturePoint.lua.annotated.lua | 90 + ...izzard_HouseEditorExteriorFixturePoint.xml | 118 + ...itorExteriorFixturePoint.xml.annotated.lua | 2 + ...rExteriorOptionTemplates.lua.annotated.lua | 448 + ...ard_HouseEditorExteriorOptionTemplates.xml | 144 + ...rExteriorOptionTemplates.xml.annotated.lua | 77 + ...rd_HouseEditorLayoutMode.lua.annotated.lua | 306 + .../Blizzard_HouseEditorLayoutMode.xml | 143 + ...rd_HouseEditorLayoutMode.xml.annotated.lua | 2 + ...HouseEditorLayoutModePin.lua.annotated.lua | 490 + .../Blizzard_HouseEditorLayoutModePin.xml | 315 + ...HouseEditorLayoutModePin.xml.annotated.lua | 2 + ...d_HouseEditorModeButtons.lua.annotated.lua | 220 + .../Blizzard_HouseEditorModeButtons.xml | 316 + ...d_HouseEditorModeButtons.xml.annotated.lua | 197 + ...useEditorPlacedDecorList.lua.annotated.lua | 299 + .../Blizzard_HouseEditorPlacedDecorList.xml | 146 + ...useEditorPlacedDecorList.xml.annotated.lua | 72 + ..._HouseEditorRegistration.lua.annotated.lua | 8 + ..._HouseEditorStorageFrame.lua.annotated.lua | 810 ++ .../Blizzard_HouseEditorStorageFrame.xml | 187 + ..._HouseEditorStorageFrame.xml.annotated.lua | 87 + ...ard_HouseEditorTemplates.lua.annotated.lua | 332 + .../Blizzard_HouseEditorTemplates.xml | 141 + ...ard_HouseEditorTemplates.xml.annotated.lua | 53 + .../Blizzard_HouseList.lua.annotated.lua | 183 + .../Blizzard_HouseList/Blizzard_HouseList.toc | 9 + .../Blizzard_HouseList/Blizzard_HouseList.xml | 150 + .../Blizzard_HouseList.xml.annotated.lua | 89 + ...rd_HouseListRegistration.lua.annotated.lua | 9 + ...ard_HousingBulletinBoard.lua.annotated.lua | 776 ++ .../Blizzard_HousingBulletinBoard.toc | 9 + .../Blizzard_HousingBulletinBoard.xml | 561 + ...ard_HousingBulletinBoard.xml.annotated.lua | 330 + ...ulletinBoardRegistration.lua.annotated.lua | 11 + .../Blizzard_HousingCharter.lua.annotated.lua | 165 + .../Blizzard_HousingCharter.toc | 9 + .../Blizzard_HousingCharter.xml | 185 + .../Blizzard_HousingCharter.xml.annotated.lua | 161 + ...usingCharterRegistration.lua.annotated.lua | 8 + ...ard_HousingControlButton.lua.annotated.lua | 179 + .../Blizzard_HousingControlButton.xml | 93 + ...ard_HousingControlButton.xml.annotated.lua | 68 + ...Blizzard_HousingControls.lua.annotated.lua | 86 + .../Blizzard_HousingControls.toc | 11 + .../Blizzard_HousingControls.xml | 103 + ...Blizzard_HousingControls.xml.annotated.lua | 69 + ...zard_HousingControlsUtil.lua.annotated.lua | 11 + ...zzard_HousingCornerstone.lua.annotated.lua | 474 + .../Blizzard_HousingCornerstone.toc | 9 + .../Blizzard_HousingCornerstone.xml | 438 + ...zzard_HousingCornerstone.xml.annotated.lua | 506 + ...gCornerstoneRegistration.lua.annotated.lua | 13 + ...ousingCreateNeighborhood.lua.annotated.lua | 255 + .../Blizzard_HousingCreateNeighborhood.toc | 9 + .../Blizzard_HousingCreateNeighborhood.xml | 305 + ...ousingCreateNeighborhood.xml.annotated.lua | 159 + ...NeighborhoodRegistration.lua.annotated.lua | 10 + ...lizzard_HousingDashboard.lua.annotated.lua | 93 + .../Blizzard_HousingDashboard.toc | 15 + .../Blizzard_HousingDashboard.xml | 56 + ...lizzard_HousingDashboard.xml.annotated.lua | 53 + ..._HousingDashboardCatalog.lua.annotated.lua | 197 + .../Blizzard_HousingDashboardCatalog.xml | 87 + ..._HousingDashboardCatalog.xml.annotated.lua | 43 + ...ashboardHouseInfoContent.lua.annotated.lua | 974 ++ ...zzard_HousingDashboardHouseInfoContent.xml | 940 ++ ...ashboardHouseInfoContent.xml.annotated.lua | 362 + ...ingDashboardHouseUpgrade.lua.annotated.lua | 602 + .../Blizzard_HousingDashboardHouseUpgrade.xml | 504 + ...ingDashboardHouseUpgrade.xml.annotated.lua | 189 + ...ingDashboardRegistration.lua.annotated.lua | 9 + ...zard_HousingEventHandler.lua.annotated.lua | 413 + .../Blizzard_HousingEventHandler.toc | 5 + ...zzard_HousingHouseFinder.lua.annotated.lua | 693 + .../Blizzard_HousingHouseFinder.toc | 11 + .../Blizzard_HousingHouseFinder.xml | 646 + ...zzard_HousingHouseFinder.xml.annotated.lua | 363 + ...gHouseFinderRegistration.lua.annotated.lua | 8 + ...useFinderMapDataProvider.lua.annotated.lua | 183 + .../HouseFinderMapDataProvider.xml | 88 + ...useFinderMapDataProvider.xml.annotated.lua | 49 + ...ard_HousingHouseSettings.lua.annotated.lua | 329 + .../Blizzard_HousingHouseSettings.toc | 9 + .../Blizzard_HousingHouseSettings.xml | 229 + ...ard_HousingHouseSettings.xml.annotated.lua | 221 + ...ouseSettingsRegistration.lua.annotated.lua | 8 + .../Blizzard_HousingMarketCart.toc | 13 + ...gMarketCartItemTemplates.lua.annotated.lua | 316 + ...lizzard_HousingMarketCartItemTemplates.xml | 321 + ...gMarketCartItemTemplates.xml.annotated.lua | 117 + ...ousingMarketCartServices.lua.annotated.lua | 20 + ...usingMarketCartTemplates.lua.annotated.lua | 741 ++ .../Blizzard_HousingMarketCartTemplates.xml | 106 + ...usingMarketCartTemplates.xml.annotated.lua | 48 + ...zard_HousingModelPreview.lua.annotated.lua | 137 + .../Blizzard_HousingModelPreview.toc | 9 + .../Blizzard_HousingModelPreview.xml | 125 + ...zard_HousingModelPreview.xml.annotated.lua | 95 + ...PreviewFrameRegistration.lua.annotated.lua | 8 + ...zard_HousingPhotoSharing.lua.annotated.lua | 108 + .../Blizzard_HousingPhotoSharing.toc | 8 + .../Blizzard_HousingPhotoSharing.xml | 322 + ...zard_HousingPhotoSharing.xml.annotated.lua | 179 + ...usingPhotoSharingBrowser.lua.annotated.lua | 80 + .../Blizzard_HousingPhotoSharingBrowser.xml | 126 + ...usingPhotoSharingBrowser.xml.annotated.lua | 94 + ...zard_HousingActionButton.lua.annotated.lua | 339 + .../Blizzard_HousingActionButton.xml | 79 + ...zard_HousingActionButton.xml.annotated.lua | 15 + ...singCatalogBundleDisplay.lua.annotated.lua | 114 + .../Blizzard_HousingCatalogBundleDisplay.xml | 22 + ...singCatalogBundleDisplay.xml.annotated.lua | 12 + ...HousingCatalogCategories.lua.annotated.lua | 649 + .../Blizzard_HousingCatalogCategories.xml | 183 + ...HousingCatalogCategories.xml.annotated.lua | 120 + ...zard_HousingCatalogEntry.lua.annotated.lua | 868 ++ .../Blizzard_HousingCatalogEntry.xml | 95 + ...zard_HousingCatalogEntry.xml.annotated.lua | 36 + ...rd_HousingCatalogFilters.lua.annotated.lua | 224 + .../Blizzard_HousingCatalogFilters.xml | 19 + ...rd_HousingCatalogFilters.xml.annotated.lua | 16 + ..._HousingCatalogTemplates.lua.annotated.lua | 218 + .../Blizzard_HousingCatalogTemplates.xml | 58 + ..._HousingCatalogTemplates.xml.annotated.lua | 32 + ...zzard_HousingCatalogUtil.lua.annotated.lua | 47 + .../Blizzard_HousingData.lua.annotated.lua | 157 + .../Blizzard_HousingTemplates.toc | 22 + ...lizzard_HousingTopBanner.lua.annotated.lua | 60 + .../Blizzard_HousingTopBanner.xml | 211 + ...lizzard_HousingTopBanner.xml.annotated.lua | 59 + .../Blizzard_HousingTutorials.toc | 12 + ...ard_HousingTutorialsData.lua.annotated.lua | 280 + ...rd_HousingTutorialsDecor.lua.annotated.lua | 540 + ...singTutorialsHouseFinder.lua.annotated.lua | 133 + ...ard_HousingTutorialsInit.lua.annotated.lua | 74 + ...ard_HousingTutorialsMisc.lua.annotated.lua | 172 + ...ard_HousingTutorialsUtil.lua.annotated.lua | 58 + .../Blizzard_HybridMinimap.lua.annotated.lua | 124 + .../Blizzard_HybridMinimap.toc | 5 + .../Blizzard_HybridMinimap.xml | 43 + .../Blizzard_HybridMinimap.xml.annotated.lua | 19 + .../AddOns/Blizzard_IME/Blizzard_IME.toc | 6 + .../Annotations/AddOns/Blizzard_IME/IME.xml | 107 + .../AddOns/Blizzard_IME/IME.xml.annotated.lua | 67 + .../Blizzard_InspectUI.lua.annotated.lua | 143 + .../Blizzard_InspectUI/Blizzard_InspectUI.toc | 8 + .../Blizzard_InspectUI/Blizzard_InspectUI.xml | 51 + .../Blizzard_InspectUI.xml.annotated.lua | 42 + .../InspectGuildFrame.lua.annotated.lua | 35 + .../Blizzard_InspectUI/InspectGuildFrame.xml | 147 + .../InspectGuildFrame.xml.annotated.lua | 74 + .../InspectPVPFrame.lua.annotated.lua | 129 + .../Blizzard_InspectUI/InspectPVPFrame.xml | 151 + .../InspectPVPFrame.xml.annotated.lua | 118 + .../InspectPaperDollFrame.lua.annotated.lua | 237 + .../InspectPaperDollFrame.xml | 358 + .../InspectPaperDollFrame.xml.annotated.lua | 391 + .../Localization.lua.annotated.lua | 17 + ...zzard_IslandsPartyPoseUI.lua.annotated.lua | 121 + .../Blizzard_IslandsPartyPoseUI.toc | 10 + .../Blizzard_IslandsPartyPoseUI.xml | 51 + ...zzard_IslandsPartyPoseUI.xml.annotated.lua | 29 + .../Blizzard_IslandsQueueUI.lua.annotated.lua | 335 + .../Blizzard_IslandsQueueUI.toc | 10 + .../Blizzard_IslandsQueueUI.xml | 499 + .../Blizzard_IslandsQueueUI.xml.annotated.lua | 181 + .../Blizzard_ItemBeltFrame.toc | 9 + .../Blizzard_ItemButton_Mainline.toc | 9 + .../Mainline/ItemButtonTemplate.xml | 282 + .../ItemButtonTemplate.xml.annotated.lua | 93 + .../ItemButtonTemplate.lua.annotated.lua | 270 + .../Shared/ItemButtonTemplate.xml | 79 + .../ItemButtonTemplate.xml.annotated.lua | 26 + ...izzard_ItemInteractionUI.lua.annotated.lua | 1036 ++ .../Blizzard_ItemInteractionUI.toc | 4 + .../Blizzard_ItemInteractionUI.xml | 356 + ...izzard_ItemInteractionUI.xml.annotated.lua | 202 + ...Blizzard_ItemSocketingUI.lua.annotated.lua | 352 + .../Blizzard_ItemSocketingUI.toc | 4 + .../Blizzard_ItemSocketingUI.xml | 433 + ...Blizzard_ItemSocketingUI.xml.annotated.lua | 158 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_ItemUpgradeUI_Mainline.toc | 6 + .../Blizzard_ItemUpgradeUI.lua.annotated.lua | 1113 ++ .../Mainline/Blizzard_ItemUpgradeUI.xml | 483 + .../Blizzard_ItemUpgradeUI.xml.annotated.lua | 852 ++ .../AddOns/Blizzard_Kiosk/Blizzard_Kiosk.toc | 16 + .../Housing/Config.lua.annotated.lua | 1 + .../Housing/Game.lua.annotated.lua | 187 + .../AddOns/Blizzard_Kiosk/Housing/Game.xml | 141 + .../Housing/Game.xml.annotated.lua | 80 + .../Blizzard_Kiosk/Kiosk.lua.annotated.lua | 194 + .../AddOns/Blizzard_Kiosk/Kiosk.xml | 11 + .../Blizzard_Kiosk/Kiosk.xml.annotated.lua | 10 + ...zard_LandingRenownButton.lua.annotated.lua | 47 + .../Blizzard_LandingRenownButton.xml | 35 + ...zard_LandingRenownButton.xml.annotated.lua | 17 + ...rd_LandingSoulbindButton.lua.annotated.lua | 74 + .../Blizzard_LandingSoulbindButton.xml | 33 + ...rd_LandingSoulbindButton.xml.annotated.lua | 14 + ...ard_LandingSoulbindPanel.lua.annotated.lua | 34 + .../Blizzard_LandingSoulbindPanel.xml | 34 + ...ard_LandingSoulbindPanel.xml.annotated.lua | 20 + .../Blizzard_LandingSoulbinds.toc | 7 + .../Blizzard_LoadLocale.toc | 5 + .../LoadLocale.lua.annotated.lua | 3 + .../Blizzard_LoginWarningDialogs.toc | 8 + .../Blizzard_MacroDefine.lua.annotated.lua | 4 + ...izzard_MacroIconSelector.lua.annotated.lua | 135 + .../Blizzard_MacroIconSelector.xml | 13 + ...izzard_MacroIconSelector.xml.annotated.lua | 8 + .../Blizzard_MacroScrollFrame.xml | 10 + ...lizzard_MacroScrollFrame.xml.annotated.lua | 9 + .../Blizzard_MacroUI.lua.annotated.lua | 348 + .../Blizzard_MacroUI/Blizzard_MacroUI.toc | 8 + .../Blizzard_MacroUI/Blizzard_MacroUI.xml | 249 + .../Blizzard_MacroUI.xml.annotated.lua | 158 + .../Localization.lua.annotated.lua | 46 + .../Blizzard_MailFrame/Blizzard_MailFrame.toc | 9 + .../Localization.lua.annotated.lua | 48 + .../MailFrame.lua.annotated.lua | 1335 ++ .../AddOns/Blizzard_MailFrame/MailFrame.xml | 1334 ++ .../MailFrame.xml.annotated.lua | 1331 ++ ...lizzard_MainMenuBarBagButtons_Mainline.toc | 10 + .../MainMenuBarBagButtons.lua.annotated.lua | 424 + .../Mainline/MainMenuBarBagButtons.xml | 140 + .../MainMenuBarBagButtons.xml.annotated.lua | 90 + .../Shared/BagsBar.lua.annotated.lua | 130 + .../MainMenuBarBagManager.lua.annotated.lua | 79 + ..._MajorFactionRenownToast.lua.annotated.lua | 172 + .../Blizzard_MajorFactionRenownToast.xml | 110 + ..._MajorFactionRenownToast.xml.annotated.lua | 31 + ...zzard_MajorFactionToasts.lua.annotated.lua | 10 + .../Blizzard_MajorFactionToasts.xml | 91 + ...zzard_MajorFactionToasts.xml.annotated.lua | 21 + ..._MajorFactionUnlockToast.lua.annotated.lua | 70 + .../Blizzard_MajorFactionUnlockToast.xml | 61 + ..._MajorFactionUnlockToast.xml.annotated.lua | 21 + .../Blizzard_MajorFactions.toc | 14 + ...FactionsLandingTemplates.lua.annotated.lua | 447 + ...Blizzard_MajorFactionsLandingTemplates.xml | 185 + ...FactionsLandingTemplates.xml.annotated.lua | 82 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_MapCanvas.lua.annotated.lua | 1183 ++ .../Blizzard_MapCanvas/Blizzard_MapCanvas.toc | 7 + .../Blizzard_MapCanvas/Blizzard_MapCanvas.xml | 65 + .../Blizzard_MapCanvas.xml.annotated.lua | 30 + ...ard_MapCanvasDetailLayer.lua.annotated.lua | 105 + ...pCanvas_DataProviderBase.lua.annotated.lua | 642 + ...as_PinFrameLevelsManager.lua.annotated.lua | 158 + ...vas_ScrollContainerMixin.lua.annotated.lua | 796 ++ ...zard_MapCanvasSecureUtil.lua.annotated.lua | 79 + .../Blizzard_MapCanvasSecureUtil.toc | 4 + ...chCelebrationPartyPoseUI.lua.annotated.lua | 72 + .../Blizzard_MatchCelebrationPartyPoseUI.toc | 9 + .../Blizzard_MatchCelebrationPartyPoseUI.xml | 64 + ...chCelebrationPartyPoseUI.xml.annotated.lua | 43 + ..._MatchmakingQueueDisplay.lua.annotated.lua | 428 + .../Blizzard_MatchmakingQueueDisplay.toc | 9 + .../Blizzard_MatchmakingQueueDisplay.xml | 196 + ..._MatchmakingQueueDisplay.xml.annotated.lua | 105 + .../Blizzard_MawBuffs.lua.annotated.lua | 280 + .../Blizzard_MawBuffs/Blizzard_MawBuffs.toc | 5 + .../Blizzard_MawBuffs/Blizzard_MawBuffs.xml | 109 + .../Blizzard_MawBuffs.xml.annotated.lua | 35 + .../AddOns/Blizzard_Menu/Blizzard_Menu.toc | 21 + .../Compositor.lua.annotated.lua | 455 + .../DropdownButton.lua.annotated.lua | 423 + .../AddOns/Blizzard_Menu/DropdownButton.xml | 18 + .../DropdownButton.xml.annotated.lua | 11 + .../Mainline/MenuConstants.lua.annotated.lua | 6 + .../Mainline/MenuTemplates.lua.annotated.lua | 87 + .../Blizzard_Menu/Mainline/MenuTemplates.xml | 118 + .../Mainline/MenuTemplates.xml.annotated.lua | 41 + .../Mainline/MenuVariants.lua.annotated.lua | 41 + .../Blizzard_Menu/Menu.lua.annotated.lua | 2613 ++++ .../Annotations/AddOns/Blizzard_Menu/Menu.xml | 19 + .../Blizzard_Menu/Menu.xml.annotated.lua | 9 + .../MenuConstants.lua.annotated.lua | 36 + .../MenuTemplates.lua.annotated.lua | 1011 ++ .../AddOns/Blizzard_Menu/MenuTemplates.xml | 105 + .../MenuTemplates.xml.annotated.lua | 35 + .../Blizzard_Menu/MenuUtil.lua.annotated.lua | 416 + .../MenuVariants.lua.annotated.lua | 82 + .../Blizzard_MicroMenu_Mainline.toc | 14 + .../MainMenuBarMicroButtons.lua.annotated.lua | 1901 +++ .../Mainline/MainMenuBarMicroButtons.xml | 335 + .../MainMenuBarMicroButtons.xml.annotated.lua | 147 + .../Mainline/MicroMenuContainer.xml | 38 + .../MicroMenuContainer.xml.annotated.lua | 26 + ...roMenuContainerOverrides.lua.annotated.lua | 20 + .../MicroMenuContainer.lua.annotated.lua | 303 + .../Shared/MicroMenuUtil.lua.annotated.lua | 16 + .../Blizzard_Minimap_Mainline.toc | 12 + .../AddonCompartment.lua.annotated.lua | 148 + .../Mainline/AddonCompartment.xml | 25 + .../AddonCompartment.xml.annotated.lua | 8 + .../Mainline/GameTime.lua.annotated.lua | 254 + .../Blizzard_Minimap/Mainline/GameTime.xml | 59 + .../Mainline/GameTime.xml.annotated.lua | 26 + .../Mainline/Minimap.lua.annotated.lua | 1205 ++ .../Blizzard_Minimap/Mainline/Minimap.xml | 408 + .../Mainline/Minimap.xml.annotated.lua | 164 + .../Blizzard_MirrorTimer.toc | 8 + .../MirrorTimer.lua.annotated.lua | 191 + .../Blizzard_MirrorTimer/MirrorTimer.xml | 85 + .../MirrorTimer.xml.annotated.lua | 23 + .../Blizzard_MoneyFrame_Mainline.toc | 14 + .../Mainline/Localization.lua.annotated.lua | 25 + .../Mainline/MoneyFrame.lua.annotated.lua | 493 + .../Mainline/MoneyFrame.xml | 231 + .../Mainline/MoneyFrame.xml.annotated.lua | 81 + .../MoneyInputFrame.lua.annotated.lua | 379 + .../Mainline/MoneyInputFrame.xml | 156 + .../MoneyInputFrame.xml.annotated.lua | 64 + .../Shared/MoneyFrame.lua.annotated.lua | 670 + .../Blizzard_MoneyFrame/Shared/MoneyFrame.xml | 72 + .../Shared/MoneyFrame.xml.annotated.lua | 34 + .../Shared/MoneyInputFrame.lua.annotated.lua | 119 + .../Shared/MoneyInputFrame.xml | 77 + .../Shared/MoneyInputFrame.xml.annotated.lua | 37 + .../Blizzard_MoneyReceipt.lua.annotated.lua | 77 + .../Blizzard_MoneyReceipt.toc | 3 + .../Blizzard_MovePad.lua.annotated.lua | 209 + .../Blizzard_MovePad/Blizzard_MovePad.toc | 5 + .../Blizzard_MovePad/Blizzard_MovePad.xml | 123 + .../Blizzard_MovePad.xml.annotated.lua | 125 + ...ateAlternatePowerBarBase.lua.annotated.lua | 44 + ...rd_ClassNameplateAlternatePowerBarBase.xml | 26 + ...ateAlternatePowerBarBase.xml.annotated.lua | 13 + ...izzard_ClassNameplateBar.lua.annotated.lua | 302 + .../Blizzard_ClassNameplateBar.xml | 52 + ...izzard_ClassNameplateBar.xml.annotated.lua | 33 + ...NameplateBar_DeathKnight.lua.annotated.lua | 12 + ...Blizzard_ClassNameplateBar_DeathKnight.xml | 14 + ...NameplateBar_DeathKnight.xml.annotated.lua | 22 + ...assNameplateBar_Dracthyr.lua.annotated.lua | 45 + .../Blizzard_ClassNameplateBar_Dracthyr.xml | 21 + ...assNameplateBar_Dracthyr.xml.annotated.lua | 42 + ..._ClassNameplateBar_Druid.lua.annotated.lua | 31 + .../Blizzard_ClassNameplateBar_Druid.xml | 15 + ..._ClassNameplateBar_Druid.xml.annotated.lua | 35 + ...d_ClassNameplateBar_Mage.lua.annotated.lua | 21 + .../Blizzard_ClassNameplateBar_Mage.xml | 14 + ...d_ClassNameplateBar_Mage.xml.annotated.lua | 32 + ...d_ClassNameplateBar_Monk.lua.annotated.lua | 44 + .../Blizzard_ClassNameplateBar_Monk.xml | 19 + ...d_ClassNameplateBar_Monk.xml.annotated.lua | 40 + ...lassNameplateBar_Paladin.lua.annotated.lua | 21 + .../Blizzard_ClassNameplateBar_Paladin.xml | 13 + ...lassNameplateBar_Paladin.xml.annotated.lua | 86 + ..._ClassNameplateBar_Rogue.lua.annotated.lua | 21 + .../Blizzard_ClassNameplateBar_Rogue.xml | 13 + ..._ClassNameplateBar_Rogue.xml.annotated.lua | 32 + ...lassNameplateBar_Warlock.lua.annotated.lua | 21 + .../Blizzard_ClassNameplateBar_Warlock.xml | 15 + ...lassNameplateBar_Warlock.xml.annotated.lua | 34 + .../Blizzard_NamePlateAuras.lua.annotated.lua | 562 + .../Blizzard_NamePlateAuras.xml | 64 + .../Blizzard_NamePlateAuras.xml.annotated.lua | 33 + .../Blizzard_NamePlateBase.lua.annotated.lua | 72 + ...zard_NamePlateCastingBar.lua.annotated.lua | 22 + ...PlateClassificationFrame.lua.annotated.lua | 176 + ...zzard_NamePlateComponent.lua.annotated.lua | 33 + ...zzard_NamePlateConstants.lua.annotated.lua | 42 + ...rd_NamePlateFrameOptions.lua.annotated.lua | 63 + ...zzard_NamePlateHealthBar.lua.annotated.lua | 187 + ...zard_NamePlateRaidTarget.lua.annotated.lua | 42 + ...zzard_NamePlateUnitFrame.lua.annotated.lua | 805 ++ .../Blizzard_NamePlates.lua.annotated.lua | 554 + .../Blizzard_NamePlates.toc | 39 + .../Blizzard_NamePlates.xml | 447 + .../Blizzard_NamePlates.xml.annotated.lua | 210 + .../Blizzard_NewPlayerExperience.toc | 14 + .../Blizzard_Tutorial.lua.annotated.lua | 66 + .../Blizzard_TutorialData.lua.annotated.lua | 501 + ...torialKeyboardMouseFrame.lua.annotated.lua | 138 + .../Blizzard_TutorialKeyboardMouseFrame.xml | 98 + ...torialKeyboardMouseFrame.xml.annotated.lua | 62 + .../Blizzard_TutorialLogic.lua.annotated.lua | 307 + ...lizzard_TutorialServices.lua.annotated.lua | 386 + ...izzard_TutorialTutorials.lua.annotated.lua | 3256 +++++ ...lizzard_TutorialWatchers.lua.annotated.lua | 965 ++ .../Blizzard_NewPlayerExperienceGuide.toc | 4 + .../GuideCriteriaFrame.lua.annotated.lua | 113 + .../GuideCriteriaFrame.xml | 81 + .../GuideCriteriaFrame.xml.annotated.lua | 34 + .../GuideFrame.lua.annotated.lua | 268 + .../GuideFrame.xml | 82 + .../GuideFrame.xml.annotated.lua | 54 + .../Blizzard_Notification.toc | 7 + .../Blizzard_Notification.xml | 30 + .../Blizzard_Notification.xml.annotated.lua | 12 + ...lizzard_NotificationUtil.lua.annotated.lua | 35 + .../Blizzard_ObjectAPI_Mainline.toc | 18 + .../AsyncCallbackSystem.lua.annotated.lua | 112 + .../Mainline/Campaign.lua.annotated.lua | 61 + .../CampaignChapter.lua.annotated.lua | 32 + .../ContinuableContainer.lua.annotated.lua | 104 + .../CovenantCalling.lua.annotated.lua | 121 + .../Mainline/Item.lua.annotated.lua | 348 + .../Mainline/ItemLocation.lua.annotated.lua | 106 + .../Mainline/ObjectCache.lua.annotated.lua | 20 + .../Mainline/PlayerLocation.lua.annotated.lua | 185 + .../Mainline/Quest.lua.annotated.lua | 111 + .../Mainline/Spell.lua.annotated.lua | 82 + .../Mainline/UiMapPoint.lua.annotated.lua | 16 + ...ievementObjectiveTracker.lua.annotated.lua | 190 + .../Blizzard_AchievementObjectiveTracker.xml | 4 + ...ievementObjectiveTracker.xml.annotated.lua | 6 + ...dventureObjectiveTracker.lua.annotated.lua | 294 + .../Blizzard_AdventureObjectiveTracker.xml | 4 + ...dventureObjectiveTracker.xml.annotated.lua | 6 + ...rd_AutoQuestPopUpTracker.lua.annotated.lua | 186 + .../Blizzard_AutoQuestPopUpTracker.xml | 235 + ...rd_AutoQuestPopUpTracker.xml.annotated.lua | 138 + ...rd_BonusObjectiveTracker.lua.annotated.lua | 779 ++ .../Blizzard_BonusObjectiveTracker.xml | 328 + ...rd_BonusObjectiveTracker.xml.annotated.lua | 142 + ...ignQuestObjectiveTracker.lua.annotated.lua | 11 + ...Blizzard_CampaignQuestObjectiveTracker.xml | 4 + ...ignQuestObjectiveTracker.xml.annotated.lua | 6 + ...iveTasksObjectiveTracker.lua.annotated.lua | 81 + ...izzard_InitiativeTasksObjectiveTracker.xml | 4 + ...iveTasksObjectiveTracker.xml.annotated.lua | 6 + ...tivitiesObjectiveTracker.lua.annotated.lua | 106 + ...zard_MonthlyActivitiesObjectiveTracker.xml | 4 + ...tivitiesObjectiveTracker.xml.annotated.lua | 6 + ...lizzard_ObjectiveTracker.lua.annotated.lua | 51 + .../Blizzard_ObjectiveTracker.toc | 48 + .../Blizzard_ObjectiveTracker.xml | 22 + ...lizzard_ObjectiveTracker.xml.annotated.lua | 29 + ...tiveTrackerAnimTemplates.lua.annotated.lua | 221 + ...Blizzard_ObjectiveTrackerAnimTemplates.xml | 89 + ...tiveTrackerAnimTemplates.xml.annotated.lua | 51 + ...rd_ObjectiveTrackerBlock.lua.annotated.lua | 393 + .../Blizzard_ObjectiveTrackerBlock.xml | 31 + ...rd_ObjectiveTrackerBlock.xml.annotated.lua | 16 + ...bjectiveTrackerContainer.lua.annotated.lua | 259 + .../Blizzard_ObjectiveTrackerContainer.xml | 87 + ...bjectiveTrackerContainer.xml.annotated.lua | 47 + .../Blizzard_ObjectiveTrackerFonts.xml | 219 + ...rd_ObjectiveTrackerFonts.xml.annotated.lua | 54 + ..._ObjectiveTrackerManager.lua.annotated.lua | 230 + ...d_ObjectiveTrackerModule.lua.annotated.lua | 801 ++ .../Blizzard_ObjectiveTrackerModule.xml | 98 + ...d_ObjectiveTrackerModule.xml.annotated.lua | 40 + ...tiveTrackerQuestPOIBlock.lua.annotated.lua | 71 + ...Blizzard_ObjectiveTrackerQuestPOIBlock.xml | 14 + ...tiveTrackerQuestPOIBlock.xml.annotated.lua | 15 + ...d_ObjectiveTrackerShared.lua.annotated.lua | 478 + .../Blizzard_ObjectiveTrackerShared.xml | 347 + ...d_ObjectiveTrackerShared.xml.annotated.lua | 125 + ...TrackerUIWidgetContainer.lua.annotated.lua | 64 + ...zard_ObjectiveTrackerUIWidgetContainer.xml | 15 + ...TrackerUIWidgetContainer.xml.annotated.lua | 22 + ...ProfessionsRecipeTracker.lua.annotated.lua | 201 + .../Blizzard_ProfessionsRecipeTracker.xml | 4 + ...ProfessionsRecipeTracker.xml.annotated.lua | 6 + ...rd_QuestObjectiveTracker.lua.annotated.lua | 399 + .../Blizzard_QuestObjectiveTracker.xml | 27 + ...rd_QuestObjectiveTracker.xml.annotated.lua | 15 + ...ScenarioObjectiveTracker.lua.annotated.lua | 1167 ++ .../Blizzard_ScenarioObjectiveTracker.xml | 678 + ...ScenarioObjectiveTracker.xml.annotated.lua | 303 + ...rldQuestObjectiveTracker.lua.annotated.lua | 123 + .../Blizzard_WorldQuestObjectiveTracker.xml | 5 + ...rldQuestObjectiveTracker.xml.annotated.lua | 6 + .../Blizzard_ObliterumUI.lua.annotated.lua | 131 + .../Blizzard_ObliterumUI.toc | 4 + .../Blizzard_ObliterumUI.xml | 80 + .../Blizzard_ObliterumUI.xml.annotated.lua | 40 + ...lizzard_OrderHallTalents.lua.annotated.lua | 1447 ++ .../Blizzard_OrderHallTalents.xml | 347 + ...lizzard_OrderHallTalents.xml.annotated.lua | 188 + .../Blizzard_OrderHallUI.toc | 7 + .../Localization.lua.annotated.lua | 1 + .../Blizzard_OverrideActionBar.toc | 7 + .../OverrideActionBar.lua.annotated.lua | 335 + .../OverrideActionBar.xml | 560 + .../OverrideActionBar.xml.annotated.lua | 634 + .../Blizzard_POIButton/Blizzard_POIButton.toc | 12 + .../POIButton.lua.annotated.lua | 972 ++ .../AddOns/Blizzard_POIButton/POIButton.xml | 73 + .../POIButton.xml.annotated.lua | 21 + ...OIButtonHighlightManager.lua.annotated.lua | 30 + .../POIButtonOwner.lua.annotated.lua | 147 + .../Blizzard_POIButton/POIButtonOwner.xml | 4 + .../POIButtonOwner.xml.annotated.lua | 6 + .../POIButtonUtil.lua.annotated.lua | 72 + .../Blizzard_PTRFeedback.lua.annotated.lua | 722 + .../Blizzard_PTRFeedback.toc | 12 + ...zzard_PTRFeedback_Events.lua.annotated.lua | 350 + .../Blizzard_PTRFeedback_FrameTemplates.xml | 66 + ...RFeedback_FrameTemplates.xml.annotated.lua | 15 + ...zzard_PTRFeedback_Frames.lua.annotated.lua | 1157 ++ ...ard_PTRFeedback_Tooltips.lua.annotated.lua | 355 + .../Blizzard_Reports.lua.annotated.lua | 903 ++ .../Blizzard_PTRFeedbackGlue.toc | 12 + .../Blizzard_PVPMatch/Blizzard_PVPMatch.toc | 8 + .../PVPMatchResults.lua.annotated.lua | 561 + .../Blizzard_PVPMatch/PVPMatchResults.xml | 461 + .../PVPMatchResults.xml.annotated.lua | 270 + .../PVPMatchScoreboard.lua.annotated.lua | 134 + .../Blizzard_PVPMatch/PVPMatchScoreboard.xml | 167 + .../PVPMatchScoreboard.xml.annotated.lua | 114 + .../PVPMatchTable.lua.annotated.lua | 480 + .../Blizzard_PVPMatch/PVPMatchTable.xml | 96 + .../PVPMatchTable.xml.annotated.lua | 72 + .../PVPMatchUtil.lua.annotated.lua | 198 + .../Blizzard_PVPUI_Mainline.toc | 10 + .../Localization.lua.annotated.lua | 25 + .../Mainline/Blizzard_PVPUI.lua.annotated.lua | 3138 +++++ .../Mainline/Blizzard_PVPUI.xml | 2137 +++ .../Mainline/Blizzard_PVPUI.xml.annotated.lua | 1117 ++ ...ondensedGridContentFrame.lua.annotated.lua | 306 + ...lizzard_PagedCondensedGridContentFrame.xml | 27 + ...ondensedGridContentFrame.xml.annotated.lua | 10 + .../Blizzard_PagedContent.toc | 14 + ...izzard_PagedContentFrame.lua.annotated.lua | 661 + .../Blizzard_PagedContentFrame.xml | 34 + ...izzard_PagedContentFrame.xml.annotated.lua | 14 + ...rd_PagedGridContentFrame.lua.annotated.lua | 166 + .../Blizzard_PagedGridContentFrame.xml | 37 + ...rd_PagedGridContentFrame.xml.annotated.lua | 16 + ...rd_PagedListContentFrame.lua.annotated.lua | 117 + .../Blizzard_PagedListContentFrame.xml | 19 + ...rd_PagedListContentFrame.xml.annotated.lua | 10 + .../Blizzard_PagingControls.lua.annotated.lua | 143 + .../Blizzard_PagingControls.xml | 109 + .../Blizzard_PagingControls.xml.annotated.lua | 69 + .../Blizzard_PartyPoseUI.lua.annotated.lua | 453 + .../Blizzard_PartyPoseUI.toc | 9 + .../Blizzard_PartyPoseUI.xml | 353 + .../Blizzard_PartyPoseUI.xml.annotated.lua | 140 + .../Blizzard_PerformanceBar.toc | 7 + .../PerformanceBar.lua.annotated.lua | 191 + .../Blizzard_PerksProgram.lua.annotated.lua | 621 + .../Blizzard_PerksProgram.toc | 13 + .../Blizzard_PerksProgram.xml | 953 ++ .../Blizzard_PerksProgram.xml.annotated.lua | 699 + ...ard_PerksProgramElements.lua.annotated.lua | 2283 ++++ .../Blizzard_PerksProgramElements.xml | 910 ++ ...ard_PerksProgramElements.xml.annotated.lua | 363 + ...zzard_PerksProgramFooter.lua.annotated.lua | 214 + ...izzard_PerksProgramModel.lua.annotated.lua | 860 ++ ...ard_PerksProgramProducts.lua.annotated.lua | 927 ++ .../Localization.lua.annotated.lua | 28 + ...emonHunterAlternatePower.lua.annotated.lua | 106 + .../EvokerAlternatePower.lua.annotated.lua | 90 + .../MonkAlternatePower.lua.annotated.lua | 98 + ..._PersonalResourceDisplay.lua.annotated.lua | 600 + .../Blizzard_PersonalResourceDisplay.toc | 13 + .../Blizzard_PersonalResourceDisplay.xml | 124 + ..._PersonalResourceDisplay.xml.annotated.lua | 73 + .../Blizzard_PetBattleUI.toc | 9 + .../Blizzard_PetBattleUI.lua.annotated.lua | 30 + .../Blizzard_PetBattleUI.lua.annotated.lua | 1959 +++ .../Shared/Blizzard_PetBattleUI.xml | 1668 +++ .../Blizzard_PetBattleUI.xml.annotated.lua | 767 ++ .../Shared/Blizzard_PetBattleUIPatchwerks.xml | 152 + ...rd_PetBattleUIPatchwerks.xml.annotated.lua | 134 + .../Shared/Localization.lua.annotated.lua | 1 + .../Blizzard_PingManager.lua.annotated.lua | 254 + .../Blizzard_PingUI.lua.annotated.lua | 384 + .../Blizzard_PingUI/Blizzard_PingUI.toc | 8 + .../Blizzard_PingUI/Blizzard_PingUI.xml | 212 + .../Blizzard_PingUI.xml.annotated.lua | 2 + .../Blizzard_PlayerChoice.lua.annotated.lua | 425 + .../Blizzard_PlayerChoice.toc | 25 + .../Blizzard_PlayerChoice.xml | 118 + .../Blizzard_PlayerChoice.xml.annotated.lua | 60 + ...nantChoiceOptionTemplate.lua.annotated.lua | 108 + ...ayerChoiceCovenantChoiceOptionTemplate.xml | 78 + ...nantChoiceOptionTemplate.xml.annotated.lua | 22 + ...oiceCypherOptionTemplate.lua.annotated.lua | 104 + ...zzard_PlayerChoiceCypherOptionTemplate.xml | 126 + ...oiceCypherOptionTemplate.xml.annotated.lua | 34 + ...owerChoiceOptionTemplate.lua.annotated.lua | 45 + ...ChoiceGenericPowerChoiceOptionTemplate.xml | 168 + ...owerChoiceOptionTemplate.xml.annotated.lua | 41 + ...oiceNormalOptionTemplate.lua.annotated.lua | 209 + ...zzard_PlayerChoiceNormalOptionTemplate.xml | 115 + ...oiceNormalOptionTemplate.xml.annotated.lua | 61 + ...d_PlayerChoiceOptionBase.lua.annotated.lua | 781 ++ .../Blizzard_PlayerChoiceOptionBase.xml | 241 + ...d_PlayerChoiceOptionBase.xml.annotated.lua | 141 + ...hoicePowerChoiceTemplate.lua.annotated.lua | 225 + ...izzard_PlayerChoicePowerChoiceTemplate.xml | 61 + ...hoicePowerChoiceTemplate.xml.annotated.lua | 27 + ...izzard_PlayerChoiceTimer.lua.annotated.lua | 43 + .../Blizzard_PlayerChoiceTimer.xml | 28 + ...izzard_PlayerChoiceTimer.xml.annotated.lua | 12 + ...PlayerChoiceToggleButton.lua.annotated.lua | 282 + .../Blizzard_PlayerChoiceToggleButton.xml | 130 + ...PlayerChoiceToggleButton.xml.annotated.lua | 64 + ...ceTorghastOptionTemplate.lua.annotated.lua | 52 + ...ard_PlayerChoiceTorghastOptionTemplate.xml | 128 + ...ceTorghastOptionTemplate.xml.annotated.lua | 50 + .../Blizzard_PlayerSpells.toc | 32 + ...izzard_PlayerSpellsFrame.lua.annotated.lua | 499 + .../Blizzard_PlayerSpellsFrame.xml | 67 + ...izzard_PlayerSpellsFrame.xml.annotated.lua | 58 + ...PlayerSpellsRegistration.lua.annotated.lua | 19 + ...lassSpecializationsFrame.lua.annotated.lua | 540 + .../Blizzard_ClassSpecializationsFrame.xml | 360 + ...lassSpecializationsFrame.xml.annotated.lua | 114 + ...assTalentButtonTemplates.lua.annotated.lua | 463 + .../Blizzard_ClassTalentButtonTemplates.xml | 160 + ...assTalentButtonTemplates.xml.annotated.lua | 94 + ...ClassTalentEdgeTemplates.lua.annotated.lua | 72 + .../Blizzard_ClassTalentEdgeTemplates.xml | 8 + ...ClassTalentEdgeTemplates.xml.annotated.lua | 7 + ..._ClassTalentImportExport.lua.annotated.lua | 411 + ...alentLoadoutCreateDialog.lua.annotated.lua | 56 + ...lizzard_ClassTalentLoadoutCreateDialog.xml | 37 + ...alentLoadoutCreateDialog.xml.annotated.lua | 24 + ...ntLoadoutDialogTemplates.lua.annotated.lua | 54 + ...zard_ClassTalentLoadoutDialogTemplates.xml | 72 + ...ntLoadoutDialogTemplates.xml.annotated.lua | 37 + ...sTalentLoadoutEditDialog.lua.annotated.lua | 136 + .../Blizzard_ClassTalentLoadoutEditDialog.xml | 76 + ...sTalentLoadoutEditDialog.xml.annotated.lua | 44 + ...alentLoadoutImportDialog.lua.annotated.lua | 84 + ...lizzard_ClassTalentLoadoutImportDialog.xml | 79 + ...alentLoadoutImportDialog.xml.annotated.lua | 44 + ...izzard_ClassTalentSearch.lua.annotated.lua | 196 + ...Blizzard_ClassTalentUtil.lua.annotated.lua | 218 + ...izzard_ClassTalentsFrame.lua.annotated.lua | 1773 +++ .../Blizzard_ClassTalentsFrame.xml | 418 + ...izzard_ClassTalentsFrame.xml.annotated.lua | 159 + ...ard_HeroTalentsContainer.lua.annotated.lua | 756 ++ .../Blizzard_HeroTalentsContainer.xml | 661 + ...ard_HeroTalentsContainer.xml.annotated.lua | 258 + ...roTalentsSelectionDialog.lua.annotated.lua | 592 + .../Blizzard_HeroTalentsSelectionDialog.xml | 275 + ...roTalentsSelectionDialog.xml.annotated.lua | 123 + .../Localization.lua.annotated.lua | 37 + ...d_PvPTalentListTemplates.lua.annotated.lua | 257 + .../Blizzard_PvPTalentListTemplates.xml | 109 + ...d_PvPTalentListTemplates.xml.annotated.lua | 33 + ...d_PvPTalentSlotTemplates.lua.annotated.lua | 415 + .../Blizzard_PvPTalentSlotTemplates.xml | 110 + ...d_PvPTalentSlotTemplates.xml.annotated.lua | 46 + ...rd_WarmodeButtonTemplate.lua.annotated.lua | 204 + .../Blizzard_WarmodeButtonTemplate.xml | 92 + ...rd_WarmodeButtonTemplate.xml.annotated.lua | 28 + ...izzard_SpellBookCategory.lua.annotated.lua | 345 + .../Blizzard_SpellBookFrame.lua.annotated.lua | 634 + .../SpellBook/Blizzard_SpellBookFrame.xml | 168 + .../Blizzard_SpellBookFrame.xml.annotated.lua | 101 + ..._SpellBookFrameTutorials.lua.annotated.lua | 153 + .../Blizzard_SpellBookItem.lua.annotated.lua | 765 ++ .../SpellBook/Blizzard_SpellBookItem.xml | 299 + .../Blizzard_SpellBookItem.xml.annotated.lua | 123 + ...Blizzard_SpellBookSearch.lua.annotated.lua | 325 + ...zzard_SpellBookTemplates.lua.annotated.lua | 37 + .../SpellBook/Blizzard_SpellBookTemplates.xml | 62 + ...zzard_SpellBookTemplates.xml.annotated.lua | 24 + ...zzard_PlunderstormBasics.lua.annotated.lua | 159 + .../Blizzard_PlunderstormBasics.toc | 7 + .../Blizzard_PlunderstormBasics.xml | 127 + ...zzard_PlunderstormBasics.xml.annotated.lua | 79 + .../Blizzard_PlunderstormPrematchUI.toc | 8 + .../Blizzard_PrintHandler.lua.annotated.lua | 95 + .../Blizzard_PrintHandler.toc | 4 + .../Blizzard_PrivateAurasUI.lua.annotated.lua | 355 + .../Blizzard_PrivateAurasUI.toc | 7 + .../Blizzard_PrivateAurasUI.xml | 39 + .../Blizzard_PrivateAurasUI.xml.annotated.lua | 2 + .../Blizzard_Professions.toc | 20 + ...fessionsCrafterOrderPage.lua.annotated.lua | 799 ++ .../Blizzard_ProfessionsCrafterOrderPage.xml | 229 + ...fessionsCrafterOrderPage.xml.annotated.lua | 130 + ...fessionsCrafterOrderView.lua.annotated.lua | 1103 ++ .../Blizzard_ProfessionsCrafterOrderView.xml | 554 + ...fessionsCrafterOrderView.xml.annotated.lua | 329 + ...zard_ProfessionsCrafting.lua.annotated.lua | 1471 +++ .../Blizzard_ProfessionsCrafting.xml | 392 + ...zard_ProfessionsCrafting.xml.annotated.lua | 208 + ...essionsCraftingOutputLog.lua.annotated.lua | 418 + .../Blizzard_ProfessionsCraftingOutputLog.xml | 147 + ...essionsCraftingOutputLog.xml.annotated.lua | 79 + ...lizzard_ProfessionsFrame.lua.annotated.lua | 515 + .../Blizzard_ProfessionsFrame.xml | 40 + ...lizzard_ProfessionsFrame.xml.annotated.lua | 52 + ...ofessionsGuildMemberList.lua.annotated.lua | 85 + .../Blizzard_ProfessionsGuildMemberList.xml | 69 + ...ofessionsGuildMemberList.xml.annotated.lua | 37 + ...ProfessionsInspectRecipe.lua.annotated.lua | 43 + .../Blizzard_ProfessionsInspectRecipe.xml | 40 + ...ProfessionsInspectRecipe.xml.annotated.lua | 32 + ...zzard_ProfessionsRankBar.lua.annotated.lua | 179 + .../Blizzard_ProfessionsRankBar.xml | 108 + ...zzard_ProfessionsRankBar.xml.annotated.lua | 40 + ...d_ProfessionsRecipeLevel.lua.annotated.lua | 101 + .../Blizzard_ProfessionsRecipeLevel.xml | 22 + ...d_ProfessionsRecipeLevel.xml.annotated.lua | 10 + ..._ProfessionsRegistration.lua.annotated.lua | 23 + ...ofessionsSpecializations.lua.annotated.lua | 1071 ++ .../Blizzard_ProfessionsSpecializations.xml | 478 + ...ofessionsSpecializations.xml.annotated.lua | 216 + ...SpecializationsTemplates.lua.annotated.lua | 808 ++ ...rd_ProfessionsSpecializationsTemplates.xml | 193 + ...SpecializationsTemplates.xml.annotated.lua | 73 + .../Localization.lua.annotated.lua | 35 + ...Blizzard_ProfessionsBook.lua.annotated.lua | 518 + .../Blizzard_ProfessionsBook.toc | 6 + .../Blizzard_ProfessionsBook.xml | 410 + ...Blizzard_ProfessionsBook.xml.annotated.lua | 1119 ++ ...rofessionsCustomerOrders.lua.annotated.lua | 149 + .../Blizzard_ProfessionsCustomerOrders.toc | 11 + .../Blizzard_ProfessionsCustomerOrders.xml | 91 + ...rofessionsCustomerOrders.xml.annotated.lua | 88 + ...stomerOrdersBrowseOrders.lua.annotated.lua | 346 + ..._ProfessionsCustomerOrdersBrowseOrders.xml | 66 + ...stomerOrdersBrowseOrders.xml.annotated.lua | 42 + ...ssionsCustomerOrdersForm.lua.annotated.lua | 1689 +++ ...Blizzard_ProfessionsCustomerOrdersForm.xml | 620 + ...ssionsCustomerOrdersForm.xml.annotated.lua | 347 + ...nsCustomerOrdersMyOrders.lua.annotated.lua | 303 + ...zard_ProfessionsCustomerOrdersMyOrders.xml | 114 + ...nsCustomerOrdersMyOrders.xml.annotated.lua | 50 + ...OrdersRecipeCategoryList.lua.annotated.lua | 243 + ...ssionsCustomerOrdersRecipeCategoryList.xml | 102 + ...OrdersRecipeCategoryList.xml.annotated.lua | 34 + ...CustomerOrdersRecipeList.lua.annotated.lua | 137 + ...rd_ProfessionsCustomerOrdersRecipeList.xml | 99 + ...CustomerOrdersRecipeList.xml.annotated.lua | 41 + .../Registration.lua.annotated.lua | 11 + .../Blizzard_Professions.lua.annotated.lua | 1637 +++ ...ProfessionsQualityDialog.lua.annotated.lua | 224 + .../Blizzard_ProfessionsQualityDialog.xml | 66 + ...ProfessionsQualityDialog.xml.annotated.lua | 51 + ...ionsRecipeCrafterDetails.lua.annotated.lua | 799 ++ ...izzard_ProfessionsRecipeCrafterDetails.xml | 435 + ...ionsRecipeCrafterDetails.xml.annotated.lua | 286 + ...essionsRecipeEnchantSlot.lua.annotated.lua | 77 + .../Blizzard_ProfessionsRecipeEnchantSlot.xml | 6 + ...essionsRecipeEnchantSlot.xml.annotated.lua | 6 + ..._ProfessionsRecipeFlyout.lua.annotated.lua | 814 ++ .../Blizzard_ProfessionsRecipeFlyout.xml | 85 + ..._ProfessionsRecipeFlyout.xml.annotated.lua | 54 + ...ionsRecipeFlyoutInstance.lua.annotated.lua | 25 + ...rd_ProfessionsRecipeList.lua.annotated.lua | 377 + .../Blizzard_ProfessionsRecipeList.xml | 226 + ...rd_ProfessionsRecipeList.xml.annotated.lua | 99 + ..._ProfessionsRecipeLoader.lua.annotated.lua | 87 + ...essionsRecipeReagentSlot.lua.annotated.lua | 446 + .../Blizzard_ProfessionsRecipeReagentSlot.xml | 6 + ...essionsRecipeReagentSlot.xml.annotated.lua | 6 + ...onsRecipeReagentSlotBase.lua.annotated.lua | 97 + ...zzard_ProfessionsRecipeReagentSlotBase.xml | 123 + ...onsRecipeReagentSlotBase.xml.annotated.lua | 41 + ...essionsRecipeRecraftSlot.lua.annotated.lua | 155 + .../Blizzard_ProfessionsRecipeRecraftSlot.xml | 114 + ...essionsRecipeRecraftSlot.xml.annotated.lua | 49 + ...essionsRecipeSalvageSlot.lua.annotated.lua | 77 + .../Blizzard_ProfessionsRecipeSalvageSlot.xml | 6 + ...essionsRecipeSalvageSlot.xml.annotated.lua | 6 + ...sionsRecipeSchematicForm.lua.annotated.lua | 1551 +++ ...lizzard_ProfessionsRecipeSchematicForm.xml | 256 + ...sionsRecipeSchematicForm.xml.annotated.lua | 192 + ...rofessionsRecipeSlotBase.lua.annotated.lua | 22 + ...ard_ProfessionsTemplates.lua.annotated.lua | 939 ++ .../Blizzard_ProfessionsTemplates.toc | 21 + .../Blizzard_ProfessionsTemplates.xml | 387 + ...ard_ProfessionsTemplates.xml.annotated.lua | 214 + ...d_ProfessionsTransaction.lua.annotated.lua | 870 ++ .../Blizzard_QuestNavigation.toc | 4 + .../SuperTrackedFrame.lua.annotated.lua | 318 + .../SuperTrackedFrame.xml | 41 + .../SuperTrackedFrame.xml.annotated.lua | 14 + .../Blizzard_QuestTimer.toc | 8 + .../Blizzard_QueueStatusFrame_Mainline.toc | 8 + .../QueueStatusFrame.lua.annotated.lua | 1593 +++ .../Mainline/QueueStatusFrame.xml | 411 + .../QueueStatusFrame.xml.annotated.lua | 204 + .../Blizzard_QuickJoin/Blizzard_QuickJoin.toc | 8 + .../QuickJoin.lua.annotated.lua | 620 + .../AddOns/Blizzard_QuickJoin/QuickJoin.xml | 108 + .../QuickJoin.xml.annotated.lua | 53 + .../QuickJoinToast.lua.annotated.lua | 710 + .../Blizzard_QuickJoin/QuickJoinToast.xml | 139 + .../QuickJoinToast.xml.annotated.lua | 62 + .../Blizzard_QuickKeybind.toc | 6 + .../QuickKeybind.lua.annotated.lua | 253 + .../Blizzard_QuickKeybind/QuickKeybind.xml | 90 + .../QuickKeybind.xml.annotated.lua | 246 + .../Blizzard_RPE_TurnStrafe.lua.annotated.lua | 107 + .../Blizzard_RPE_TurnStrafe.toc | 7 + .../Blizzard_RPE_TurnStrafe.xml | 87 + .../Blizzard_RPE_TurnStrafe.xml.annotated.lua | 51 + .../Blizzard_RaidFrame_Mainline.toc | 7 + .../Mainline/RaidFrame.lua.annotated.lua | 314 + .../Blizzard_RaidFrame/Mainline/RaidFrame.xml | 360 + .../Mainline/RaidFrame.xml.annotated.lua | 218 + .../Blizzard_RaidUI.lua.annotated.lua | 1203 ++ .../Blizzard_RaidUI/Blizzard_RaidUI.toc | 5 + .../Blizzard_RaidUI/Blizzard_RaidUI.xml | 814 ++ .../Blizzard_RaidUI.xml.annotated.lua | 2492 ++++ .../Localization.lua.annotated.lua | 1 + .../Blizzard_RecentAllies.toc | 7 + ...rd_RecentAlliesTemplates.lua.annotated.lua | 423 + .../Blizzard_RecentAlliesTemplates.xml | 206 + ...rd_RecentAlliesTemplates.xml.annotated.lua | 100 + ...lizzard_RecentAlliesUtil.lua.annotated.lua | 121 + .../Blizzard_RecruitAFriend.toc | 8 + .../RecruitAFriendFrame.lua.annotated.lua | 1530 +++ .../RecruitAFriendFrame.xml | 844 ++ .../RecruitAFriendFrame.xml.annotated.lua | 391 + ..._RemixArtifactTutorialUI.lua.annotated.lua | 180 + .../Blizzard_RemixArtifactTutorialUI.toc | 9 + .../Blizzard_RemixArtifactTutorialUI.xml | 10 + ..._RemixArtifactTutorialUI.xml.annotated.lua | 6 + ...Blizzard_RemixArtifactUI.lua.annotated.lua | 495 + .../Blizzard_RemixArtifactUI.toc | 10 + .../Blizzard_RemixArtifactUI.xml | 333 + ...Blizzard_RemixArtifactUI.xml.annotated.lua | 129 + .../Blizzard_ReportFrame.toc | 7 + .../ReportFrame.lua.annotated.lua | 35 + .../Blizzard_ReportFrame/ReportFrame.xml | 5 + .../ReportFrame.xml.annotated.lua | 9 + .../Blizzard_ReportFrameGlue.toc | 6 + .../Blizzard_ReportFrameShared.toc | 7 + .../ReportFrameShared.lua.annotated.lua | 573 + .../ReportFrameShared.xml | 228 + .../ReportFrameShared.xml.annotated.lua | 110 + .../Blizzard_RestrictedAddOnEnvironment.toc | 15 + .../RestrictedEnvironment.lua.annotated.lua | 287 + .../RestrictedExecution.lua.annotated.lua | 487 + .../RestrictedFrames.lua.annotated.lua | 847 ++ ...RestrictedInfrastructure.lua.annotated.lua | 638 + .../SecureGroupHeaders.lua.annotated.lua | 1092 ++ .../SecureGroupHeaders.xml | 69 + .../SecureGroupHeaders.xml.annotated.lua | 42 + .../SecureHandlerTemplates.xml | 119 + .../SecureHandlerTemplates.xml.annotated.lua | 52 + .../SecureHandlers.lua.annotated.lua | 803 ++ .../SecureHoverDriver.lua.annotated.lua | 303 + .../SecureStateDriver.lua.annotated.lua | 197 + ...d_RuneforgeCraftingFrame.lua.annotated.lua | 203 + .../Blizzard_RuneforgeCraftingFrame.xml | 90 + ...d_RuneforgeCraftingFrame.xml.annotated.lua | 54 + ...RuneforgeCraftingTooltip.lua.annotated.lua | 83 + .../Blizzard_RuneforgeCraftingTooltip.xml | 25 + ...RuneforgeCraftingTooltip.xml.annotated.lua | 12 + ...ard_RuneforgeCreateFrame.lua.annotated.lua | 172 + .../Blizzard_RuneforgeCreateFrame.xml | 51 + ...ard_RuneforgeCreateFrame.xml.annotated.lua | 26 + .../Blizzard_RuneforgeFrame.lua.annotated.lua | 656 + .../Blizzard_RuneforgeFrame.xml | 84 + .../Blizzard_RuneforgeFrame.xml.annotated.lua | 232 + ...izzard_RuneforgeItemSlot.lua.annotated.lua | 350 + .../Blizzard_RuneforgeItemSlot.xml | 50 + ...izzard_RuneforgeItemSlot.xml.annotated.lua | 14 + ...rd_RuneforgeModifierSlot.lua.annotated.lua | 431 + .../Blizzard_RuneforgeModifierSlot.xml | 112 + ...rd_RuneforgeModifierSlot.xml.annotated.lua | 40 + ...zzard_RuneforgePowerList.lua.annotated.lua | 356 + .../Blizzard_RuneforgePowerList.xml | 173 + ...zzard_RuneforgePowerList.xml.annotated.lua | 59 + .../Blizzard_RuneforgeUI.toc | 10 + .../Blizzard_SavedSets.lua.annotated.lua | 117 + .../Blizzard_SavedSets/Blizzard_SavedSets.toc | 8 + ...zzard_ScrappingMachineUI.lua.annotated.lua | 228 + .../Blizzard_ScrappingMachineUI.toc | 4 + .../Blizzard_ScrappingMachineUI.xml | 91 + ...zzard_ScrappingMachineUI.xml.annotated.lua | 44 + .../Blizzard_ScriptErrors.lua.annotated.lua | 73 + .../Blizzard_ScriptErrors.toc | 6 + ...izzard_ScriptErrorsFrame.lua.annotated.lua | 210 + .../Blizzard_ScriptErrorsFrame.toc | 8 + .../Blizzard_ScriptErrorsFrame.xml | 91 + ...izzard_ScriptErrorsFrame.xml.annotated.lua | 2 + ...lizzard_SecureTransferUI.lua.annotated.lua | 386 + .../Blizzard_SecureTransferUI.toc | 5 + .../Blizzard_SecureTransferUI.xml | 157 + ...lizzard_SecureTransferUI.xml.annotated.lua | 2 + ...SecureTransferUIOutbound.lua.annotated.lua | 32 + .../Blizzard_SelectorUI.toc | 2 + .../Blizzard_Settings.lua.annotated.lua | 2 + .../Blizzard_Settings/Blizzard_Settings.toc | 5 + .../Accessibility.lua.annotated.lua | 232 + .../Accessibility.xml | 19 + .../Accessibility.xml.annotated.lua | 16 + .../ActionBars.lua.annotated.lua | 119 + .../AdvancedOptions.lua.annotated.lua | 399 + .../AudioAssist.lua.annotated.lua | 1127 ++ .../AudioAssist.xml | 31 + .../AudioAssist.xml.annotated.lua | 25 + ...ard_SettingsDefinitions_Frame_Mainline.toc | 34 + .../Combat.lua.annotated.lua | 203 + .../CombatAudioAlertUtil.lua.annotated.lua | 328 + .../Controls.lua.annotated.lua | 223 + .../Controls.xml | 6 + .../Controls.xml.annotated.lua | 6 + .../Interface.lua.annotated.lua | 160 + .../Interface.xml | 28 + .../Interface.xml.annotated.lua | 14 + .../Keybindings.lua.annotated.lua | 330 + .../Keybindings.xml | 30 + .../Keybindings.xml.annotated.lua | 19 + .../AccessibilityOverrides.lua.annotated.lua | 16 + .../Mainline/Colorblind.xml | 57 + .../Mainline/Colorblind.xml.annotated.lua | 36 + .../ColorblindOverrides.lua.annotated.lua | 156 + .../CombatOverrides.lua.annotated.lua | 67 + .../ControlsOverrides.lua.annotated.lua | 19 + .../GameplaySettingsGroup.lua.annotated.lua | 12 + .../InterfaceOverrides.lua.annotated.lua | 241 + .../KeybindingsOverrides.lua.annotated.lua | 73 + .../SocialOverrides.lua.annotated.lua | 60 + .../Mounts.lua.annotated.lua | 125 + .../Nameplates.lua.annotated.lua | 816 ++ .../Nameplates.xml | 136 + .../Nameplates.xml.annotated.lua | 50 + .../PingSystem.lua.annotated.lua | 148 + .../PingSystem.xml | 153 + .../PingSystem.xml.annotated.lua | 95 + .../Social.lua.annotated.lua | 268 + .../Subtitles.lua.annotated.lua | 179 + .../Subtitles.xml | 42 + .../Subtitles.xml.annotated.lua | 2 + ...ssibilitySettingsPreview.lua.annotated.lua | 27 + .../Audio.lua.annotated.lua | 569 + .../Audio.xml | 90 + .../Audio.xml.annotated.lua | 45 + .../Blizzard_SettingsDefinitions_Shared.toc | 19 + .../Graphics.lua.annotated.lua | 1395 ++ .../Graphics.xml | 290 + .../Graphics.xml.annotated.lua | 200 + .../Groups.lua.annotated.lua | 13 + .../Languages.lua.annotated.lua | 163 + .../Languages.xml | 64 + .../Languages.xml.annotated.lua | 37 + .../Mac.lua.annotated.lua | 72 + .../QuestTextPreview.lua.annotated.lua | 12 + .../Mainline/QuestTextPreview.xml | 36 + .../QuestTextPreview.xml.annotated.lua | 2 + .../Mainline/Text.lua.annotated.lua | 111 + .../TextSizePreview.lua.annotated.lua | 8 + .../Mainline/TextSizePreview.xml | 40 + .../TextSizePreview.xml.annotated.lua | 2 + .../Network.lua.annotated.lua | 23 + .../Blizzard_Category.lua.annotated.lua | 136 + .../Blizzard_CategoryList.lua.annotated.lua | 426 + .../Blizzard_CategoryList.xml | 96 + .../Blizzard_CategoryList.xml.annotated.lua | 50 + .../Blizzard_Deprecated.lua.annotated.lua | 1 + .../Blizzard_Dialogs.lua.annotated.lua | 87 + .../Blizzard_Keybindings.lua.annotated.lua | 555 + .../Blizzard_Keybindings.xml | 87 + .../Blizzard_Keybindings.xml.annotated.lua | 39 + .../Blizzard_Registration.lua.annotated.lua | 12 + .../Blizzard_Setting.lua.annotated.lua | 445 + ...Blizzard_SettingControls.lua.annotated.lua | 1406 ++ .../Blizzard_SettingControls.xml | 234 + ...Blizzard_SettingControls.xml.annotated.lua | 128 + .../Blizzard_Settings.lua.annotated.lua | 681 + ...Blizzard_SettingsInbound.lua.annotated.lua | 280 + ...Blizzard_SettingsLayouts.lua.annotated.lua | 83 + .../Blizzard_SettingsList.lua.annotated.lua | 149 + .../Blizzard_SettingsList.xml | 87 + .../Blizzard_SettingsList.xml.annotated.lua | 47 + .../Blizzard_SettingsPanel.lua.annotated.lua | 980 ++ .../Blizzard_SettingsPanel.xml | 116 + .../Blizzard_SettingsPanel.xml.annotated.lua | 254 + ...izzard_SettingsRegistrar.lua.annotated.lua | 34 + .../Blizzard_Settings_Shared_Mainline.toc | 27 + .../Mainline/AudioOverrides.lua.annotated.lua | 78 + .../Blizzard_SettingsPanelTemplates.xml | 32 + ...d_SettingsPanelTemplates.xml.annotated.lua | 27 + .../GraphicsOverrides.lua.annotated.lua | 67 + .../Mainline/NewDefinitions.lua.annotated.lua | 94 + .../NewDefinitionsFramework.lua.annotated.lua | 63 + .../AreaLabelDataProvider.lua.annotated.lua | 232 + .../AreaLabelDataProvider.xml | 31 + .../AreaLabelDataProvider.xml.annotated.lua | 17 + .../AreaPOIDataProvider.lua.annotated.lua | 225 + .../AreaPOIDataProvider.xml | 6 + .../AreaPOIDataProvider.xml.annotated.lua | 6 + ...AreaPOIEventDataProvider.lua.annotated.lua | 94 + .../AreaPOIEventDataProvider.xml | 5 + ...AreaPOIEventDataProvider.xml.annotated.lua | 6 + .../BannerDataProvider.lua.annotated.lua | 38 + .../BannerDataProvider.xml | 4 + .../BannerDataProvider.xml.annotated.lua | 2 + ...tlefieldFlagDataProvider.lua.annotated.lua | 56 + .../BattlefieldFlagDataProvider.xml | 20 + ...tlefieldFlagDataProvider.xml.annotated.lua | 7 + ...izzard_SharedMapDataProviders_Mainline.toc | 54 + ...nusObjectiveDataProvider.lua.annotated.lua | 201 + .../BonusObjectiveDataProvider.xml | 7 + ...nusObjectiveDataProvider.xml.annotated.lua | 10 + .../ClickToZoomDataProvider.lua.annotated.lua | 167 + .../ClickToZoomDataProvider.xml | 30 + .../ClickToZoomDataProvider.xml.annotated.lua | 21 + ...tentTrackingDataProvider.lua.annotated.lua | 155 + .../ContentTrackingDataProvider.xml | 8 + ...tentTrackingDataProvider.xml.annotated.lua | 6 + ...ionCollectorDataProvider.lua.annotated.lua | 73 + .../ContributionCollectorDataProvider.xml | 6 + ...ionCollectorDataProvider.xml.annotated.lua | 6 + .../DeathMapDataProvider.lua.annotated.lua | 68 + .../DeathMapDataProvider.xml | 22 + .../DeathMapDataProvider.xml.annotated.lua | 10 + ...elveEntranceDataProvider.lua.annotated.lua | 46 + .../DelveEntranceDataProvider.xml | 6 + ...elveEntranceDataProvider.xml.annotated.lua | 6 + .../DigSiteDataProvider.lua.annotated.lua | 35 + .../DigSiteDataProvider.xml | 6 + .../DigSiteDataProvider.xml.annotated.lua | 6 + ...onridingRaceDataProvider.lua.annotated.lua | 30 + .../DragonridingRaceDataProvider.xml | 6 + ...onridingRaceDataProvider.xml.annotated.lua | 6 + ...geonEntranceDataProvider.lua.annotated.lua | 98 + .../DungeonEntranceDataProvider.xml | 10 + ...geonEntranceDataProvider.xml.annotated.lua | 6 + ...unterJournalDataProvider.lua.annotated.lua | 220 + .../EncounterJournalDataProvider.xml | 62 + ...unterJournalDataProvider.xml.annotated.lua | 19 + .../FlightPointDataProvider.lua.annotated.lua | 96 + .../FlightPointDataProvider.xml | 6 + .../FlightPointDataProvider.xml.annotated.lua | 6 + .../FogOfWarDataProvider.lua.annotated.lua | 38 + .../FogOfWarDataProvider.xml | 6 + .../FogOfWarDataProvider.xml.annotated.lua | 6 + .../FrameCloneManager.lua.annotated.lua | 127 + ...GarrisonPlotDataProvider.lua.annotated.lua | 18 + .../GarrisonPlotDataProvider.xml | 6 + ...GarrisonPlotDataProvider.xml.annotated.lua | 6 + .../GossipDataProvider.lua.annotated.lua | 36 + .../GossipDataProvider.xml | 6 + .../GossipDataProvider.xml.annotated.lua | 6 + ...GroupMembersDataProvider.lua.annotated.lua | 191 + .../GroupMembersDataProvider.xml | 10 + ...GroupMembersDataProvider.xml.annotated.lua | 6 + .../InvasionDataProvider.lua.annotated.lua | 71 + .../InvasionDataProvider.xml | 6 + .../InvasionDataProvider.xml.annotated.lua | 6 + ...pExplorationDataProvider.lua.annotated.lua | 209 + .../MapExplorationDataProvider.xml | 10 + ...pExplorationDataProvider.xml.annotated.lua | 6 + ...MapHighlightDataProvider.lua.annotated.lua | 142 + .../MapHighlightDataProvider.xml | 29 + ...MapHighlightDataProvider.xml.annotated.lua | 13 + .../MapLinkDataProvider.lua.annotated.lua | 52 + .../MapLinkDataProvider.xml | 6 + .../MapLinkDataProvider.xml.annotated.lua | 6 + .../MapPinTags.lua.annotated.lua | 1 + ...ghborhoodMapDataProvider.lua.annotated.lua | 118 + .../NeighborhoodMapDataProvider.xml | 27 + ...ghborhoodMapDataProvider.xml.annotated.lua | 18 + .../PetTamerDataProvider.lua.annotated.lua | 55 + .../PetTamerDataProvider.xml | 6 + .../PetTamerDataProvider.xml.annotated.lua | 6 + ...rstormCircleDataProvider.lua.annotated.lua | 258 + .../PlunderstormCircleDataProvider.xml | 77 + ...rstormCircleDataProvider.xml.annotated.lua | 96 + .../QuestBlobDataProvider.lua.annotated.lua | 239 + .../QuestBlobDataProvider.xml | 13 + .../QuestBlobDataProvider.xml.annotated.lua | 6 + .../QuestDataProvider.lua.annotated.lua | 308 + .../QuestDataProvider.xml | 20 + .../QuestDataProvider.xml.annotated.lua | 8 + .../QuestOfferDataProvider.lua.annotated.lua | 933 ++ .../QuestOfferDataProvider.xml | 53 + .../QuestOfferDataProvider.xml.annotated.lua | 35 + ...QuestSessionDataProvider.lua.annotated.lua | 16 + .../ScenarioDataProvider.lua.annotated.lua | 105 + .../ScenarioDataProvider.xml | 20 + .../ScenarioDataProvider.xml.annotated.lua | 11 + ...bleGraveyardDataProvider.lua.annotated.lua | 86 + .../SelectableGraveyardDataProvider.xml | 16 + ...bleGraveyardDataProvider.xml.annotated.lua | 7 + .../SharedMapPoiTemplates.lua.annotated.lua | 669 + .../SharedMapPoiTemplates.xml | 121 + .../SharedMapPoiTemplates.xml.annotated.lua | 58 + ...rackWaypointDataProvider.lua.annotated.lua | 89 + .../SuperTrackWaypointDataProvider.xml | 5 + ...rackWaypointDataProvider.xml.annotated.lua | 6 + .../VehicleDataProvider.lua.annotated.lua | 103 + .../VehicleDataProvider.xml | 19 + .../VehicleDataProvider.xml.annotated.lua | 7 + .../VignetteDataProvider.lua.annotated.lua | 640 + .../VignetteDataProvider.xml | 104 + .../VignetteDataProvider.xml.annotated.lua | 30 + ...ointLocationDataProvider.lua.annotated.lua | 159 + .../WaypointLocationDataProvider.xml | 26 + ...ointLocationDataProvider.xml.annotated.lua | 8 + .../WorldQuestDataProvider.lua.annotated.lua | 516 + .../WorldQuestDataProvider.xml | 36 + .../WorldQuestDataProvider.xml.annotated.lua | 18 + .../ZoneLabelDataProvider.lua.annotated.lua | 251 + .../ZoneLabelDataProvider.xml | 39 + .../ZoneLabelDataProvider.xml.annotated.lua | 22 + ...redTalentButtonTemplates.lua.annotated.lua | 41 + .../Blizzard_SharedTalentButtonTemplates.xml | 33 + ...redTalentButtonTemplates.xml.annotated.lua | 16 + ...haredTalentEdgeTemplates.lua.annotated.lua | 191 + .../Blizzard_SharedTalentEdgeTemplates.xml | 51 + ...haredTalentEdgeTemplates.xml.annotated.lua | 28 + ...izzard_SharedTalentFrame.lua.annotated.lua | 2105 +++ .../Blizzard_SharedTalentFrame.xml | 119 + ...izzard_SharedTalentFrame.xml.annotated.lua | 64 + ...aredTalentFrameTemplates.lua.annotated.lua | 283 + .../Blizzard_SharedTalentFrameTemplates.xml | 239 + ...aredTalentFrameTemplates.xml.annotated.lua | 135 + ...TalentSelectionTemplates.lua.annotated.lua | 602 + ...lizzard_SharedTalentSelectionTemplates.xml | 26 + ...TalentSelectionTemplates.xml.annotated.lua | 13 + .../Blizzard_SharedTalentUI.toc | 36 + ...lizzard_SharedTalentUtil.lua.annotated.lua | 717 + .../Blizzard_TalentArmorSet.lua.annotated.lua | 96 + .../Blizzard_TalentArmorSet.xml | 51 + .../Blizzard_TalentArmorSet.xml.annotated.lua | 20 + ...lizzard_TalentButtonAnim.lua.annotated.lua | 203 + .../Blizzard_TalentButtonAnim.xml | 12 + ...lizzard_TalentButtonAnim.xml.annotated.lua | 10 + ...ard_TalentButtonAnimUtil.lua.annotated.lua | 16 + ...Blizzard_TalentButtonArt.lua.annotated.lua | 455 + .../Blizzard_TalentButtonArt.xml | 264 + ...Blizzard_TalentButtonArt.xml.annotated.lua | 129 + ...lizzard_TalentButtonBase.lua.annotated.lua | 418 + ...zzard_TalentButtonSelect.lua.annotated.lua | 413 + .../Blizzard_TalentButtonSelect.xml | 42 + ...zzard_TalentButtonSelect.xml.annotated.lua | 11 + ...lentButtonSelectExpanded.lua.annotated.lua | 52 + .../Blizzard_TalentButtonSelectExpanded.xml | 17 + ...lentButtonSelectExpanded.xml.annotated.lua | 13 + ...izzard_TalentButtonSpend.lua.annotated.lua | 132 + ...ButtonTierTrackTemplates.lua.annotated.lua | 503 + ...lizzard_TalentButtonTierTrackTemplates.xml | 54 + ...ButtonTierTrackTemplates.xml.annotated.lua | 34 + .../Blizzard_TalentCard.lua.annotated.lua | 41 + .../Blizzard_TalentCard.xml | 42 + .../Blizzard_TalentCard.xml.annotated.lua | 26 + .../Blizzard_TalentDisplay.lua.annotated.lua | 479 + .../Blizzard_TalentDisplay.xml | 9 + .../Blizzard_TalentDisplay.xml.annotated.lua | 6 + ...Blizzard_TalentFrameGrid.lua.annotated.lua | 16 + .../Blizzard_TalentFrameGrid.xml | 18 + ...Blizzard_TalentFrameGrid.xml.annotated.lua | 7 + ...Blizzard_TalentFrameList.lua.annotated.lua | 46 + .../Blizzard_TalentFrameList.xml | 15 + ...Blizzard_TalentFrameList.xml.annotated.lua | 9 + ...Blizzard_TalentRedButton.lua.annotated.lua | 19 + .../Blizzard_TalentRedButton.xml | 9 + ...Blizzard_TalentRedButton.xml.annotated.lua | 6 + .../Blizzard_SharedWidgetFrames.toc | 6 + ...WidgetCenterDisplayFrame.lua.annotated.lua | 108 + .../Blizzard_UIWidgetCenterDisplayFrame.xml | 71 + ...WidgetCenterDisplayFrame.xml.annotated.lua | 47 + .../AccountUtil.lua.annotated.lua | 101 + .../AlertFrameIntrinsic.lua.annotated.lua | 33 + .../AlertFrameIntrinsic.xml | 10 + .../AlertFrameIntrinsic.xml.annotated.lua | 6 + .../AnimationTemplates.lua.annotated.lua | 143 + .../Blizzard_SharedXML/AnimationTemplates.xml | 69 + .../AnimationTemplates.xml.annotated.lua | 34 + .../Backdrop.lua.annotated.lua | 440 + .../AddOns/Blizzard_SharedXML/Backdrop.xml | 11 + .../Backdrop.xml.annotated.lua | 6 + .../BenchmarkUtil.lua.annotated.lua | 133 + .../BindingUtil.lua.annotated.lua | 236 + .../Blizzard_RadialWheel.lua.annotated.lua | 531 + .../Blizzard_RadialWheel.xml | 152 + .../Blizzard_RadialWheel.xml.annotated.lua | 75 + .../Blizzard_SharedXML_Mainline.toc | 242 + .../BulletPoint.lua.annotated.lua | 48 + .../AddOns/Blizzard_SharedXML/BulletPoint.xml | 47 + .../BulletPoint.xml.annotated.lua | 28 + .../ButtonGroup.lua.annotated.lua | 237 + ...CharacterModelFrameMixin.lua.annotated.lua | 46 + .../CircularBuffer.lua.annotated.lua | 187 + .../ColorUtil.lua.annotated.lua | 96 + .../CommonUIPanelTemplates.xml | 13 + .../CommonUIPanelTemplates.xml.annotated.lua | 6 + ...CustomBindingButtonMixin.lua.annotated.lua | 163 + .../CustomBindingButtonTemplate.xml | 38 + ...tomBindingButtonTemplate.xml.annotated.lua | 16 + .../DataProvider.lua.annotated.lua | 285 + .../DebugBarManager.lua.annotated.lua | 125 + .../DialogUtil.lua.annotated.lua | 1 + .../DropDownToggleButton.lua.annotated.lua | 9 + .../DropDownToggleButton.xml | 9 + .../DropDownToggleButton.xml.annotated.lua | 6 + .../Blizzard_SharedXML/Dump.lua.annotated.lua | 486 + .../EasingUtil.lua.annotated.lua | 107 + .../EventUtil.lua.annotated.lua | 138 + .../FontableFrameMixin.lua.annotated.lua | 137 + .../FormattingUtil.lua.annotated.lua | 275 + .../GameRulesUtil.lua.annotated.lua | 195 + .../GridLayoutUtil.lua.annotated.lua | 704 + .../HelpTip.lua.annotated.lua | 744 ++ .../AddOns/Blizzard_SharedXML/HelpTip.xml | 53 + .../HelpTip.xml.annotated.lua | 27 + .../HybridScrollFrame.lua.annotated.lua | 336 + .../Blizzard_SharedXML/HybridScrollFrame.xml | 218 + .../HybridScrollFrame.xml.annotated.lua | 97 + .../IndexRangeDataProvider.lua.annotated.lua | 77 + .../InputUtil.lua.annotated.lua | 23 + .../InterfaceUtil.lua.annotated.lua | 45 + .../Interpolator.lua.annotated.lua | 66 + .../KeyCommand.lua.annotated.lua | 211 + .../LayoutFrame.lua.annotated.lua | 767 ++ .../AddOns/Blizzard_SharedXML/LayoutFrame.xml | 195 + .../LayoutFrame.xml.annotated.lua | 26 + .../LinkUtil.lua.annotated.lua | 205 + .../LoopingSoundEffect.lua.annotated.lua | 61 + .../Mainline/ClassColors.lua.annotated.lua | 29 + .../Mainline/Frame/MainMenuFrameTemplates.xml | 55 + .../MainMenuFrameTemplates.xml.annotated.lua | 29 + .../Mainline/GameRulesUtil.lua.annotated.lua | 29 + ...ionRenownSharedTemplates.lua.annotated.lua | 52 + .../MajorFactionRenownSharedTemplates.xml | 57 + ...ionRenownSharedTemplates.xml.annotated.lua | 16 + .../ModelControlButtonMixin.lua.annotated.lua | 177 + .../ModelFrameMixin.lua.annotated.lua | 294 + .../Mainline/ModelFrames.lua.annotated.lua | 95 + .../Mainline/ModelFrames.xml | 15 + .../Mainline/ModelFrames.xml.annotated.lua | 6 + .../NineSliceLayouts.lua.annotated.lua | 465 + .../Scroll/OribosScrollBar.lua.annotated.lua | 12 + .../Mainline/Scroll/OribosScrollBar.xml | 136 + .../Scroll/OribosScrollBar.xml.annotated.lua | 42 + .../Mainline/ScrollDefine.lua.annotated.lua | 4 + .../Mainline/ScrollDefine.xml | 4 + .../Mainline/ScrollDefine.xml.annotated.lua | 6 + .../Selector/Blizzard_ScrollBoxSelector.xml | 27 + ...izzard_ScrollBoxSelector.xml.annotated.lua | 17 + ...haredCollectionTemplates.lua.annotated.lua | 75 + .../Mainline/SharedCollectionTemplates.xml | 203 + ...haredCollectionTemplates.xml.annotated.lua | 41 + .../SharedCollectionUtil.lua.annotated.lua | 30 + .../SharedUIPanelTemplates.lua.annotated.lua | 2367 ++++ .../Mainline/SharedUIPanelTemplates.xml | 2290 ++++ .../SharedUIPanelTemplates.xml.annotated.lua | 1014 ++ .../Mainline/Sound.lua.annotated.lua | 72 + .../SoundKitConstants.lua.annotated.lua | 960 ++ .../Mainline/UIDropDownMenu.lua.annotated.lua | 1589 +++ .../Mainline/UIDropDownMenu.xml | 18 + .../Mainline/UIDropDownMenu.xml.annotated.lua | 200 + .../UIDropDownMenuTemplates.lua.annotated.lua | 87 + .../Mainline/UIDropDownMenuTemplates.xml | 298 + .../UIDropDownMenuTemplates.xml.annotated.lua | 89 + .../ManagedLayoutFrame.lua.annotated.lua | 41 + .../Blizzard_SharedXML/ManagedLayoutFrame.xml | 14 + .../ManagedLayoutFrame.xml.annotated.lua | 10 + .../MixinUtil.lua.annotated.lua | 375 + .../ModelFrameTemplates.xml | 167 + .../ModelFrameTemplates.xml.annotated.lua | 60 + .../ModelPreviewFrame.lua.annotated.lua | 198 + .../Blizzard_SharedXML/ModelPreviewFrame.xml | 98 + .../ModelPreviewFrame.xml.annotated.lua | 116 + .../ModelSceneActorMixin.lua.annotated.lua | 142 + .../ModelSceneActorMixin.xml | 10 + .../ModelSceneActorMixin.xml.annotated.lua | 6 + .../ModelSceneControlFrame.lua.annotated.lua | 263 + .../ModelSceneControlFrame.xml | 62 + .../ModelSceneControlFrame.xml.annotated.lua | 45 + .../ModelSceneMixin.lua.annotated.lua | 564 + .../Blizzard_SharedXML/ModelSceneMixin.xml | 28 + .../ModelSceneMixin.xml.annotated.lua | 31 + .../ModelSceneTemplates.lua.annotated.lua | 166 + .../ModelSceneTemplates.xml | 104 + .../ModelSceneTemplates.xml.annotated.lua | 65 + .../NewFeatureLabel.lua.annotated.lua | 31 + .../Blizzard_SharedXML/NewFeatureLabel.xml | 59 + .../NewFeatureLabel.xml.annotated.lua | 31 + .../NineSlice.lua.annotated.lua | 313 + .../PagedList.lua.annotated.lua | 169 + .../AddOns/Blizzard_SharedXML/PagedList.xml | 68 + .../PagedList.xml.annotated.lua | 36 + .../Blizzard_SharedXML/PingAttributes.xml | 18 + .../PingAttributes.xml.annotated.lua | 14 + .../PingUtil.lua.annotated.lua | 6 + .../PingableType.lua.annotated.lua | 23 + .../PixelUtil.lua.annotated.lua | 56 + .../PixelUtilSecure.lua.annotated.lua | 5 + .../PortraitFrame.lua.annotated.lua | 135 + .../PredictedSetting.lua.annotated.lua | 58 + .../ProjectConstants.lua.annotated.lua | 2 + .../PropertyBindingMixin.lua.annotated.lua | 153 + .../PropertyButton.lua.annotated.lua | 149 + .../Blizzard_SharedXML/PropertyButton.xml | 42 + .../PropertyButton.xml.annotated.lua | 6 + .../PropertyFontString.lua.annotated.lua | 15 + .../Blizzard_SharedXML/PropertyFontString.xml | 13 + .../PropertyFontString.xml.annotated.lua | 11 + .../PropertySlider.lua.annotated.lua | 19 + .../Blizzard_SharedXML/PropertySlider.xml | 14 + .../PropertySlider.xml.annotated.lua | 6 + .../RegionUtil.lua.annotated.lua | 134 + .../ScaleToFitFrame.lua.annotated.lua | 58 + .../Blizzard_SharedXML/ScaleToFitFrame.xml | 15 + .../ScaleToFitFrame.xml.annotated.lua | 14 + .../ScriptAnimationUtil.lua.annotated.lua | 197 + ...AnimatedEffectController.lua.annotated.lua | 221 + ...ScriptAnimatedModelScene.lua.annotated.lua | 241 + .../ScriptAnimatedModelScene.xml | 15 + ...ScriptAnimatedModelScene.xml.annotated.lua | 7 + ...tAnimatedModelSceneActor.lua.annotated.lua | 135 + ...ScriptedAnimationEffects.lua.annotated.lua | 312 + .../ScrollableTabsContainer.lua.annotated.lua | 238 + .../ScrollableTabsContainer.xml | 17 + .../ScrollableTabsContainer.xml.annotated.lua | 7 + .../ScrollingMessageFrame.lua.annotated.lua | 959 ++ .../ScrollingMessageFrame.xml | 22 + .../ScrollingMessageFrame.xml.annotated.lua | 9 + .../SecureScrollTemplates.lua.annotated.lua | 265 + .../SecureScrollTemplates.xml | 535 + .../SecureScrollTemplates.xml.annotated.lua | 200 + .../SecureUIPanelTemplates.lua.annotated.lua | 260 + .../SecureUIPanelTemplates.xml | 456 + .../SecureUIPanelTemplates.xml.annotated.lua | 190 + .../SecureUtil.lua.annotated.lua | 139 + .../SelectableButton.lua.annotated.lua | 50 + .../Blizzard_SharedXML/SelectableButton.xml | 9 + .../SelectableButton.xml.annotated.lua | 6 + .../Sequencer.lua.annotated.lua | 48 + .../Shared/Button/CheckButtonTemplates.xml | 78 + .../CheckButtonTemplates.xml.annotated.lua | 46 + .../IconButtonTemplate.lua.annotated.lua | 68 + .../Shared/Button/IconButtonTemplate.xml | 81 + .../IconButtonTemplate.xml.annotated.lua | 20 + ...ThreeSliceButtonTemplate.lua.annotated.lua | 111 + .../Button/ThreeSliceButtonTemplate.xml | 133 + ...ThreeSliceButtonTemplate.xml.annotated.lua | 56 + .../Button/UIButtonTemplate.lua.annotated.lua | 164 + .../Shared/Button/UIButtonTemplate.xml | 68 + .../Button/UIButtonTemplate.xml.annotated.lua | 21 + .../UIPanelButtonTemplates.lua.annotated.lua | 7 + .../Shared/Button/UIPanelButtonTemplates.xml | 18 + .../UIPanelButtonTemplates.xml.annotated.lua | 10 + .../ButtonTray/ButtonTray.lua.annotated.lua | 112 + .../Shared/ButtonTray/ButtonTray.xml | 55 + .../ButtonTray/ButtonTray.xml.annotated.lua | 20 + .../ButtonTrayUtil.lua.annotated.lua | 42 + .../Dialog/DialogTemplates.lua.annotated.lua | 24 + .../Shared/Dialog/DialogTemplates.xml | 125 + .../Dialog/DialogTemplates.xml.annotated.lua | 40 + .../Frame/EventButton.lua.annotated.lua | 56 + .../Shared/Frame/EventButton.xml | 14 + .../Frame/EventButton.xml.annotated.lua | 6 + .../Frame/EventEditBox.lua.annotated.lua | 214 + .../Shared/Frame/EventEditBox.xml | 22 + .../Frame/EventEditBox.xml.annotated.lua | 8 + .../Shared/Frame/EventFrame.lua.annotated.lua | 26 + .../Shared/Frame/EventFrame.xml | 11 + .../Shared/Frame/EventFrame.xml.annotated.lua | 6 + .../Frame/EventScrollFrame.lua.annotated.lua | 36 + .../Shared/Frame/EventScrollFrame.xml | 13 + .../Frame/EventScrollFrame.xml.annotated.lua | 6 + .../MainMenuFrameTemplates.lua.annotated.lua | 75 + .../RingedFrameTemplate.lua.annotated.lua | 197 + .../FrameTemplate/RingedFrameTemplate.xml | 97 + .../RingedFrameTemplate.xml.annotated.lua | 42 + .../InputBoxTemplates.lua.annotated.lua | 267 + .../Shared/InputBox/InputBoxTemplates.xml | 308 + .../InputBoxTemplates.xml.annotated.lua | 92 + .../LoadSystemTemplates.lua.annotated.lua | 338 + .../Shared/LoadSystem/LoadSystemTemplates.xml | 20 + .../LoadSystemTemplates.xml.annotated.lua | 13 + .../Shared/Localization.lua.annotated.lua | 25 + .../LocalizationMachinery.lua.annotated.lua | 40 + .../CameraBaseMixin.lua.annotated.lua | 101 + .../CameraRegistry.lua.annotated.lua | 16 + .../OrbitCameraMixin.lua.annotated.lua | 638 + .../Scroll/MinimalScrollBar.lua.annotated.lua | 65 + .../Shared/Scroll/MinimalScrollBar.xml | 140 + .../Scroll/MinimalScrollBar.xml.annotated.lua | 62 + .../Shared/Scroll/ScrollBar.lua.annotated.lua | 413 + .../Shared/Scroll/ScrollBar.xml | 24 + .../Shared/Scroll/ScrollBar.xml.annotated.lua | 15 + .../Shared/Scroll/ScrollBox.lua.annotated.lua | 939 ++ .../Shared/Scroll/ScrollBox.xml | 52 + .../Shared/Scroll/ScrollBox.xml.annotated.lua | 30 + .../ScrollBoxBiaxalView.lua.annotated.lua | 179 + .../ScrollBoxGridView.lua.annotated.lua | 95 + .../ScrollBoxLinearView.lua.annotated.lua | 301 + .../ScrollBoxListView.lua.annotated.lua | 773 ++ .../Scroll/ScrollBoxPadding.lua.annotated.lua | 87 + .../ScrollBoxSequenceView.lua.annotated.lua | 262 + .../Scroll/ScrollBoxStride.lua.annotated.lua | 152 + .../ScrollBoxTreeView.lua.annotated.lua | 166 + .../Scroll/ScrollBoxView.lua.annotated.lua | 108 + .../ScrollBoxViewUtil.lua.annotated.lua | 57 + .../Scroll/ScrollController.lua.annotated.lua | 179 + .../Scroll/ScrollTemplates.lua.annotated.lua | 389 + .../Shared/Scroll/ScrollTemplates.xml | 69 + .../Scroll/ScrollTemplates.xml.annotated.lua | 54 + .../Scroll/ScrollUtil.lua.annotated.lua | 1689 +++ .../Scroll/TrimScrollBar.lua.annotated.lua | 76 + .../Shared/Scroll/TrimScrollBar.xml | 302 + .../Scroll/TrimScrollBar.xml.annotated.lua | 132 + .../Blizzard_GridSelectorUI.lua.annotated.lua | 53 + .../Selector/Blizzard_GridSelectorUI.xml | 15 + .../Blizzard_GridSelectorUI.xml.annotated.lua | 12 + ...izzard_ScrollBoxSelector.lua.annotated.lua | 90 + .../Blizzard_SelectorUI.lua.annotated.lua | 139 + .../Shared/Selector/Blizzard_SelectorUI.xml | 44 + .../Blizzard_SelectorUI.xml.annotated.lua | 15 + .../Slider/MinimalSlider.lua.annotated.lua | 179 + .../Shared/Slider/MinimalSlider.xml | 99 + .../Slider/MinimalSlider.xml.annotated.lua | 56 + .../TabSystemOwner.lua.annotated.lua | 117 + .../Shared/TabSystem/TabSystemOwner.xml | 8 + .../TabSystemOwner.xml.annotated.lua | 6 + .../TabSystemTemplates.lua.annotated.lua | 253 + .../Shared/TabSystem/TabSystemTemplates.xml | 132 + .../TabSystemTemplates.xml.annotated.lua | 36 + .../Shared/Tabs/MinimalTab.lua.annotated.lua | 56 + .../Shared/Tabs/MinimalTab.xml | 47 + .../Shared/Tabs/MinimalTab.xml.annotated.lua | 23 + .../Shared/VASErrorLookup.lua.annotated.lua | 383 + .../SharedBasicControls.lua.annotated.lua | 146 + .../SharedBasicControls.xml | 356 + .../SharedBasicControls.xml.annotated.lua | 140 + .../SharedColorConstants.lua.annotated.lua | 44 + .../SharedConstants.lua.annotated.lua | 147 + .../SharedTooltipTemplates.lua.annotated.lua | 291 + .../SharedTooltipTemplates.xml | 134 + .../SharedTooltipTemplates.xml.annotated.lua | 208 + .../SmoothStatusBar.lua.annotated.lua | 60 + .../SortUtil.lua.annotated.lua | 90 + .../SpaceToFitLayoutFrame.lua.annotated.lua | 120 + .../SpaceToFitLayoutFrame.xml | 20 + .../SpaceToFitLayoutFrame.xml.annotated.lua | 12 + .../Spinner.lua.annotated.lua | 78 + .../AddOns/Blizzard_SharedXML/Spinner.xml | 36 + .../Spinner.xml.annotated.lua | 18 + .../Spline.lua.annotated.lua | 132 + .../StringUtil.lua.annotated.lua | 31 + .../TabGroup.lua.annotated.lua | 78 + .../TableBuilder.lua.annotated.lua | 500 + .../TemplatedList.lua.annotated.lua | 263 + .../Blizzard_SharedXML/TemplatedList.xml | 31 + .../TemplatedList.xml.annotated.lua | 16 + .../TimeUtil.lua.annotated.lua | 443 + .../ToolWindowOwnerMixin.lua.annotated.lua | 81 + .../TreeListDataProvider.lua.annotated.lua | 470 + .../TypeUtil.lua.annotated.lua | 29 + .../UnitUtil.lua.annotated.lua | 116 + .../Vector2D.lua.annotated.lua | 139 + .../Vector3D.lua.annotated.lua | 170 + .../Vector4D.lua.annotated.lua | 140 + .../AddOns/Blizzard_SharedXML/VectorLib.xml | 6 + .../VectorLib.xml.annotated.lua | 2 + .../ProjectConstants.lua.annotated.lua | 1 + .../middleclass.lua.annotated.lua | 142 + .../AddOnUtil.lua.annotated.lua | 67 + .../AnchorUtil.lua.annotated.lua | 459 + .../Blizzard_SharedXMLBase.toc | 42 + .../ButtonStateBehavior.lua.annotated.lua | 113 + .../CallbackRegistrant.lua.annotated.lua | 86 + .../CallbackRegistrant.xml | 11 + .../CallbackRegistrant.xml.annotated.lua | 6 + .../CallbackRegistry.lua.annotated.lua | 288 + .../Color.lua.annotated.lua | 88 + .../ColorSwatch.lua.annotated.lua | 27 + .../Blizzard_SharedXMLBase/ColorSwatch.xml | 40 + .../ColorSwatch.xml.annotated.lua | 9 + ...ombatAudioAlertConstants.lua.annotated.lua | 75 + .../Compat.lua.annotated.lua | 61 + .../CurveConstants.lua.annotated.lua | 24 + .../CvarUtil.lua.annotated.lua | 292 + .../EnumUtil.lua.annotated.lua | 18 + .../EnvironmentUtil.lua.annotated.lua | 6 + .../ErrorUtil.lua.annotated.lua | 30 + .../Event.lua.annotated.lua | 31 + .../ExportUtil.lua.annotated.lua | 148 + .../Flags.lua.annotated.lua | 138 + .../FrameFactory.lua.annotated.lua | 64 + .../FrameUtil.lua.annotated.lua | 707 + .../FrameWatcher.lua.annotated.lua | 41 + .../FunctionUtil.lua.annotated.lua | 147 + .../GlobalCallbackRegistry.lua.annotated.lua | 77 + .../LocaleUtil.lua.annotated.lua | 9 + .../MathUtil.lua.annotated.lua | 158 + .../Mixin.lua.annotated.lua | 48 + .../ModelSceneUtil.lua.annotated.lua | 45 + .../ObjectUpdater.lua.annotated.lua | 58 + .../Pools.lua.annotated.lua | 866 ++ .../ProxyUtil.lua.annotated.lua | 252 + .../Rectangle.lua.annotated.lua | 133 + .../RegionLayoutManager.lua.annotated.lua | 47 + .../SecureTypes.lua.annotated.lua | 393 + .../TableUtil.lua.annotated.lua | 759 ++ .../TaggableObject.lua.annotated.lua | 81 + .../TemplateInfoCache.lua.annotated.lua | 52 + .../TextureUtil.lua.annotated.lua | 450 + .../TimedCallback.lua.annotated.lua | 22 + .../Blizzard_SharedXMLGame_Mainline.toc | 16 + .../DressUpModelFrameMixin.lua.annotated.lua | 761 ++ .../Mainline/ListTemplates.lua.annotated.lua | 163 + .../Mainline/ListTemplates.xml | 108 + .../Mainline/ListTemplates.xml.annotated.lua | 36 + .../Mainline/Localization.lua.annotated.lua | 44 + .../Shared/Localization.lua.annotated.lua | 56 + .../StaticModelInfo.lua.annotated.lua | 30 + ...TooltipComparisonManager.lua.annotated.lua | 387 + .../TooltipDataHandler.lua.annotated.lua | 610 + .../TooltipDataRules.lua.annotated.lua | 228 + .../Tooltip/TooltipUtil.lua.annotated.lua | 81 + .../Blizzard_SimpleCheckout.lua.annotated.lua | 182 + .../Blizzard_SimpleCheckout.toc | 11 + .../Blizzard_SimpleCheckout.xml | 85 + .../Blizzard_SimpleCheckout.xml.annotated.lua | 14 + ...d_SimpleCheckout_Inbound.lua.annotated.lua | 18 + ..._SimpleCheckout_Outbound.lua.annotated.lua | 18 + .../Blizzard_SocialToast.toc | 8 + .../SocialToast.lua.annotated.lua | 30 + .../Blizzard_SocialToast/SocialToast.xml | 71 + .../SocialToast.xml.annotated.lua | 41 + .../Blizzard_Soulbinds.lua.annotated.lua | 11 + .../Blizzard_Soulbinds/Blizzard_Soulbinds.toc | 15 + .../Blizzard_Soulbinds/Blizzard_Soulbinds.xml | 4 + .../Blizzard_Soulbinds.xml.annotated.lua | 2 + ...lizzard_SoulbindsConduit.lua.annotated.lua | 33 + ...ard_SoulbindsConduitList.lua.annotated.lua | 644 + .../Blizzard_SoulbindsConduitList.xml | 325 + ...ard_SoulbindsConduitList.xml.annotated.lua | 130 + .../Blizzard_SoulbindsNode.lua.annotated.lua | 613 + .../Blizzard_SoulbindsNode.xml | 375 + .../Blizzard_SoulbindsNode.xml.annotated.lua | 217 + ...izzard_SoulbindsNodeLink.lua.annotated.lua | 81 + .../Blizzard_SoulbindsNodeLink.xml | 100 + ...izzard_SoulbindsNodeLink.xml.annotated.lua | 45 + ...rd_SoulbindsSelectButton.lua.annotated.lua | 213 + .../Blizzard_SoulbindsSelectButton.xml | 133 + ...rd_SoulbindsSelectButton.xml.annotated.lua | 67 + ...ard_SoulbindsSelectGroup.lua.annotated.lua | 83 + .../Blizzard_SoulbindsSelectGroup.xml | 11 + ...ard_SoulbindsSelectGroup.xml.annotated.lua | 6 + ...zzard_SoulbindsTemplates.lua.annotated.lua | 1 + .../Blizzard_SoulbindsTemplates.xml | 4 + ...zzard_SoulbindsTemplates.xml.annotated.lua | 2 + .../Blizzard_SoulbindsTree.lua.annotated.lua | 600 + .../Blizzard_SoulbindsTree.xml | 19 + .../Blizzard_SoulbindsTree.xml.annotated.lua | 9 + .../Blizzard_SoulbindsUtil.lua.annotated.lua | 102 + ...Blizzard_SoulbindsViewer.lua.annotated.lua | 543 + .../Blizzard_SoulbindsViewer.xml | 386 + ...Blizzard_SoulbindsViewer.xml.annotated.lua | 238 + .../Blizzard_SpectateFrame.toc | 8 + .../Blizzard_SpellDiminishUI.toc | 7 + ...SpellDiminishUITemplates.lua.annotated.lua | 245 + .../Blizzard_SpellDiminishUITemplates.xml | 50 + ...SpellDiminishUITemplates.xml.annotated.lua | 27 + .../Blizzard_SpellPickUpIndicator.toc | 6 + .../Blizzard_SpellSearch.toc | 13 + ...ellSearchActionBarFilter.lua.annotated.lua | 93 + ...archAssistedCombatFilter.lua.annotated.lua | 29 + ...rd_SpellSearchController.lua.annotated.lua | 172 + ...izzard_SpellSearchFilter.lua.annotated.lua | 353 + ...rd_SpellSearchNameFilter.lua.annotated.lua | 165 + ...izzard_SpellSearchSource.lua.annotated.lua | 98 + ...ard_SpellSearchTemplates.lua.annotated.lua | 368 + .../Blizzard_SpellSearchTemplates.xml | 169 + ...ard_SpellSearchTemplates.xml.annotated.lua | 76 + ...rd_SpellSearchTextFilter.lua.annotated.lua | 252 + ...Blizzard_SpellSearchUtil.lua.annotated.lua | 127 + .../Blizzard_StableUI.lua.annotated.lua | 1284 ++ .../Blizzard_StableUI/Blizzard_StableUI.toc | 5 + .../Blizzard_StableUI/Blizzard_StableUI.xml | 644 + .../Blizzard_StableUI.xml.annotated.lua | 326 + .../Blizzard_StaticPopup.toc | 6 + .../SharedDialogDefs.lua.annotated.lua | 28 + .../SharedTemplates.lua.annotated.lua | 74 + .../StaticPopup.lua.annotated.lua | 1004 ++ .../Blizzard_StaticPopup_Game.toc | 18 + .../GameDialog.lua.annotated.lua | 847 ++ .../Blizzard_StaticPopup_Game/GameDialog.xml | 354 + .../GameDialog.xml.annotated.lua | 850 ++ .../GameDialogDefs.lua.annotated.lua | 3193 +++++ .../GameDialogDefsUtil.lua.annotated.lua | 50 + .../Mainline/GameDialog.lua.annotated.lua | 18 + .../Mainline/GameDialogDefs.lua.annotated.lua | 1406 ++ .../Mainline/StaticPopupSpecial.xml | 61 + .../StaticPopupSpecial.xml.annotated.lua | 27 + .../Blizzard_StaticPopup_Glue.toc | 14 + .../Blizzard_StatusUI.lua.annotated.lua | 24 + .../Blizzard_StatusUI/Blizzard_StatusUI.toc | 4 + .../Blizzard_StatusUI/Blizzard_StatusUI.xml | 50 + .../Blizzard_StatusUI.xml.annotated.lua | 33 + ...FullProductCardTemplates.lua.annotated.lua | 504 + ...argeProductCardTemplates.lua.annotated.lua | 499 + ...roductCardBuyButtonMixin.lua.annotated.lua | 121 + ...ctCardMagnifierTemplates.lua.annotated.lua | 24 + ...red_ProductCardTemplates.lua.annotated.lua | 674 + .../Blizzard_Shared_ProductCardTemplates.xml | 294 + ...red_ProductCardTemplates.xml.annotated.lua | 2 + ...mallProductCardTemplates.lua.annotated.lua | 291 + ..._Shared_StoreButtonMixin.lua.annotated.lua | 55 + .../Blizzard_Shared_StoreUI.xml | 1054 ++ .../Blizzard_Shared_StoreUI.xml.annotated.lua | 2 + ...rd_Shared_StoreUIInbound.lua.annotated.lua | 81 + ...d_Shared_StoreUIInsecure.lua.annotated.lua | 93 + ...d_Shared_StoreUIOutbound.lua.annotated.lua | 66 + .../Blizzard_Shared_StoreUIPatchwerk.xml | 260 + ..._Shared_StoreUIPatchwerk.xml.annotated.lua | 258 + ...ard_Shared_StoreUISecure.lua.annotated.lua | 4324 ++++++ ..._Shared_StoreUITemplates.lua.annotated.lua | 321 + .../Blizzard_Shared_StoreUITemplates.xml | 835 ++ ..._Shared_StoreUITemplates.xml.annotated.lua | 2 + .../Blizzard_StoreUI_Mainline.toc | 13 + .../Shared_Localization.lua.annotated.lua | 1 + ...bscriptionInterstitialUI.lua.annotated.lua | 155 + .../Blizzard_SubscriptionInterstitialUI.toc | 3 + .../Blizzard_SubscriptionInterstitialUI.xml | 183 + ...bscriptionInterstitialUI.xml.annotated.lua | 144 + .../Blizzard_Subtitles.lua.annotated.lua | 103 + .../Blizzard_Subtitles/Blizzard_Subtitles.toc | 6 + .../Blizzard_Subtitles/Blizzard_Subtitles.xml | 36 + .../Blizzard_Subtitles.xml.annotated.lua | 14 + .../Blizzard_TextStatusBar.toc | 7 + .../TextStatusBar.lua.annotated.lua | 354 + .../Blizzard_TextStatusBar/TextStatusBar.xml | 20 + .../TextStatusBar.xml.annotated.lua | 10 + .../Blizzard_TimeManager_Mainline.toc | 9 + .../Blizzard_TimeManager.lua.annotated.lua | 677 + .../Mainline/Blizzard_TimeManager.xml | 353 + .../Blizzard_TimeManager.xml.annotated.lua | 209 + .../Mainline/Localization.lua.annotated.lua | 34 + .../Blizzard_TimerunningCharacterCreate.toc | 8 + ...Blizzard_TimerunningUtil.lua.annotated.lua | 70 + .../Blizzard_TimerunningUtil.toc | 7 + ...lizzard_CurrencyTransfer.lua.annotated.lua | 795 ++ .../Blizzard_CurrencyTransfer.xml | 431 + ...lizzard_CurrencyTransfer.xml.annotated.lua | 236 + .../Blizzard_TokenUI.lua.annotated.lua | 735 ++ .../Blizzard_TokenUI/Blizzard_TokenUI.toc | 6 + .../Blizzard_TokenUI/Blizzard_TokenUI.xml | 291 + .../Blizzard_TokenUI.xml.annotated.lua | 177 + .../Localization.lua.annotated.lua | 1 + ...zard_TorghastLevelPicker.lua.annotated.lua | 550 + .../Blizzard_TorghastLevelPicker.toc | 6 + .../Blizzard_TorghastLevelPicker.xml | 262 + ...zard_TorghastLevelPicker.xml.annotated.lua | 104 + .../Blizzard_TrainerUI.lua.annotated.lua | 416 + .../Blizzard_TrainerUI/Blizzard_TrainerUI.toc | 4 + .../Blizzard_TrainerUI/Blizzard_TrainerUI.xml | 227 + .../Blizzard_TrainerUI.xml.annotated.lua | 214 + .../Localization.lua.annotated.lua | 1 + ...zzard_RotateControlFrame.lua.annotated.lua | 103 + .../Blizzard_RotateControlFrame.xml | 71 + ...zzard_RotateControlFrame.xml.annotated.lua | 32 + ...izzard_ScaleControlFrame.lua.annotated.lua | 190 + .../Blizzard_ScaleControlFrame.xml | 114 + ...izzard_ScaleControlFrame.xml.annotated.lua | 43 + .../Blizzard_TransformManipulator.toc | 11 + .../Blizzard_TransformTree.toc | 10 + ...ansformTreeBaseNodeMixin.lua.annotated.lua | 204 + ...nsformTreeFrameNodeMixin.lua.annotated.lua | 17 + .../TransformTreeMixin.lua.annotated.lua | 34 + .../TransformTreePools.lua.annotated.lua | 14 + ...formTreeTextureNodeMixin.lua.annotated.lua | 17 + .../Blizzard_Transmog.lua.annotated.lua | 2856 ++++ .../Blizzard_Transmog/Blizzard_Transmog.toc | 8 + .../Blizzard_Transmog/Blizzard_Transmog.xml | 766 ++ .../Blizzard_Transmog.xml.annotated.lua | 439 + ...ard_TransmogRegistration.lua.annotated.lua | 12 + ...izzard_TransmogTemplates.lua.annotated.lua | 1775 +++ .../Blizzard_TransmogTemplates.xml | 1314 ++ ...izzard_TransmogTemplates.xml.annotated.lua | 438 + ...izzard_TransmogOverrides.lua.annotated.lua | 11 + .../Blizzard_TransmogShared.lua.annotated.lua | 1235 ++ .../Blizzard_TransmogShared.toc | 5 + .../Blizzard_TutorialBase.lua.annotated.lua | 468 + ...Blizzard_TutorialEffects.lua.annotated.lua | 123 + .../Blizzard_TutorialEffects.xml | 74 + ...Blizzard_TutorialEffects.xml.annotated.lua | 33 + .../Blizzard_TutorialHelper.lua.annotated.lua | 303 + ...izzard_TutorialMainFrame.lua.annotated.lua | 315 + .../Blizzard_TutorialMainFrame.xml | 146 + ...izzard_TutorialMainFrame.xml.annotated.lua | 91 + ...Blizzard_TutorialManager.lua.annotated.lua | 244 + .../Blizzard_TutorialManager.toc | 15 + ...ard_TutorialPointerFrame.lua.annotated.lua | 253 + .../Blizzard_TutorialPointerFrame.xml | 166 + ...ard_TutorialPointerFrame.xml.annotated.lua | 99 + ...ard_TutorialQuestManager.lua.annotated.lua | 184 + .../Blizzard_TutorialQueue.lua.annotated.lua | 59 + ...ard_TutorialRangeManager.lua.annotated.lua | 143 + .../BagTutorialUtil.lua.annotated.lua | 176 + ...zzard_TutorialReagentBag.lua.annotated.lua | 56 + ...zzard_TutorialSupertrack.lua.annotated.lua | 124 + .../Blizzard_Tutorials.lua.annotated.lua | 49 + .../Blizzard_Tutorials/Blizzard_Tutorials.toc | 19 + ...izzard_Tutorials_Classes.lua.annotated.lua | 498 + ...zzard_Tutorials_Dracthyr.lua.annotated.lua | 354 + ...d_Tutorials_Dragonriding.lua.annotated.lua | 44 + ...utorials_Frame_Tutorials.lua.annotated.lua | 152 + ...izzard_Tutorials_Managed.lua.annotated.lua | 23 + .../Blizzard_Tutorials_Managed.xml | 10 + ...izzard_Tutorials_Managed.xml.annotated.lua | 10 + ...d_Tutorials_PerksProgram.lua.annotated.lua | 402 + ...rd_Tutorials_Professions.lua.annotated.lua | 706 + .../Blizzard_Tutorials_RPE.lua.annotated.lua | 495 + ...StateMachineTutorialUtil.lua.annotated.lua | 117 + .../StateMachineUtil.lua.annotated.lua | 55 + .../Blizzard_UIFrameManager.lua.annotated.lua | 54 + .../Blizzard_UIFrameManager.toc | 4 + .../Blizzard_UIFrameManager.xml | 22 + .../Blizzard_UIFrameManager.xml.annotated.lua | 10 + .../Blizzard_UIPanelTemplates_Mainline.toc | 12 + .../AutoCastTemplates.lua.annotated.lua | 26 + .../Mainline/AutoCastTemplates.xml | 42 + .../AutoCastTemplates.xml.annotated.lua | 18 + .../UIPanelTemplates.lua.annotated.lua | 712 + .../Mainline/UIPanelTemplates.xml | 1490 +++ .../UIPanelTemplates.xml.annotated.lua | 705 + .../UIPanelSpellButtonFrame.lua.annotated.lua | 181 + .../Shared/UIPanelSpellButtonFrame.xml | 63 + .../UIPanelSpellButtonFrame.xml.annotated.lua | 34 + .../Blizzard_UIPanels_Game_Mainline.toc | 91 + ...ritePaperDollItemOverlay.lua.annotated.lua | 79 + .../Mainline/AzeritePaperDollItemOverlay.xml | 193 + ...ritePaperDollItemOverlay.xml.annotated.lua | 53 + .../Mainline/BankFrame.lua.annotated.lua | 1685 +++ .../Mainline/BankFrame.xml | 786 ++ .../Mainline/BankFrame.xml.annotated.lua | 415 + .../CampaignOverview.lua.annotated.lua | 140 + .../Mainline/CampaignOverview.xml | 75 + .../CampaignOverview.xml.annotated.lua | 30 + .../CastingBarFrame.lua.annotated.lua | 1336 ++ .../Mainline/CastingBarFrame.xml | 512 + .../CastingBarFrame.xml.annotated.lua | 196 + .../Mainline/CharacterFrame.lua.annotated.lua | 453 + .../Mainline/CharacterFrame.xml | 308 + .../Mainline/CharacterFrame.xml.annotated.lua | 193 + .../Mainline/ContainerFrame.lua.annotated.lua | 2711 ++++ .../Mainline/ContainerFrame.xml | 336 + .../Mainline/ContainerFrame.xml.annotated.lua | 311 + .../CustomGossipFrameBase.lua.annotated.lua | 212 + .../Mainline/CustomGossipFrameBase.xml | 44 + .../CustomGossipFrameBase.xml.annotated.lua | 30 + .../Mainline/DressUpFrames.lua.annotated.lua | 954 ++ .../Mainline/DressUpFrames.xml | 446 + .../Mainline/DressUpFrames.xml.annotated.lua | 226 + .../Mainline/EventScheduler.lua.annotated.lua | 843 ++ .../Mainline/EventScheduler.xml | 311 + .../Mainline/EventScheduler.xml.annotated.lua | 142 + .../FogOfWarFrameTemplates.lua.annotated.lua | 46 + .../Mainline/FogOfWarFrameTemplates.xml | 11 + .../FogOfWarFrameTemplates.xml.annotated.lua | 6 + .../FriendshipStatusBar.lua.annotated.lua | 85 + .../Mainline/FriendshipStatusBar.xml | 84 + .../FriendshipStatusBar.xml.annotated.lua | 15 + .../Mainline/GossipFrame.lua.annotated.lua | 85 + .../Mainline/GossipFrame.xml | 117 + .../Mainline/GossipFrame.xml.annotated.lua | 81 + .../Mainline/GroupLootFrame.lua.annotated.lua | 755 ++ .../Mainline/GroupLootFrame.xml | 687 + .../Mainline/GroupLootFrame.xml.annotated.lua | 245 + .../GuildRegistrarFrame.lua.annotated.lua | 24 + .../Mainline/GuildRegistrarFrame.xml | 222 + .../GuildRegistrarFrame.xml.annotated.lua | 153 + .../Mainline/ItemRef.lua.annotated.lua | 404 + .../Mainline/ItemRef.xml | 31 + .../Mainline/ItemRef.xml.annotated.lua | 563 + .../ItemRefHandlers.lua.annotated.lua | 293 + .../Mainline/ItemTextFrame.lua.annotated.lua | 195 + .../Mainline/ItemTextFrame.xml | 168 + .../Mainline/ItemTextFrame.xml.annotated.lua | 92 + .../Mainline/Localization.lua.annotated.lua | 60 + .../Mainline/LootFrame.lua.annotated.lua | 344 + .../Mainline/LootFrame.xml | 127 + .../Mainline/LootFrame.xml.annotated.lua | 71 + .../Mainline/MapLegendFrame.lua.annotated.lua | 192 + .../Mainline/MapLegendFrame.xml | 100 + .../Mainline/MapLegendFrame.xml.annotated.lua | 48 + .../Mainline/MerchantFrame.lua.annotated.lua | 1088 ++ .../Mainline/MerchantFrame.xml | 635 + .../Mainline/MerchantFrame.xml.annotated.lua | 1385 ++ .../Mainline/PaperDollFrame.lua.annotated.lua | 2807 ++++ .../Mainline/PaperDollFrame.xml | 947 ++ .../Mainline/PaperDollFrame.xml.annotated.lua | 814 ++ .../Mainline/PetitionFrame.lua.annotated.lua | 76 + .../Mainline/PetitionFrame.xml | 209 + .../Mainline/PetitionFrame.xml.annotated.lua | 150 + .../Mainline/QuestFrame.lua.annotated.lua | 625 + .../Mainline/QuestFrame.xml | 421 + .../Mainline/QuestFrame.xml.annotated.lua | 604 + .../QuestFrameTemplates.lua.annotated.lua | 19 + .../Mainline/QuestFrameTemplates.xml | 188 + .../QuestFrameTemplates.xml.annotated.lua | 48 + .../Mainline/QuestInfo.lua.annotated.lua | 1371 ++ .../Mainline/QuestInfo.xml | 784 ++ .../Mainline/QuestInfo.xml.annotated.lua | 658 + .../Mainline/QuestMapFrame.lua.annotated.lua | 2506 ++++ .../Mainline/QuestMapFrame.xml | 948 ++ .../Mainline/QuestMapFrame.xml.annotated.lua | 463 + .../ReputationFrame.lua.annotated.lua | 850 ++ .../Mainline/ReputationFrame.xml | 432 + .../ReputationFrame.xml.annotated.lua | 186 + .../RoleSelectionTemplate.lua.annotated.lua | 88 + .../Mainline/RoleSelectionTemplate.xml | 154 + .../RoleSelectionTemplate.xml.annotated.lua | 56 + .../ScrollingFlatPanel.lua.annotated.lua | 91 + .../Mainline/ScrollingFlatPanel.xml | 46 + .../ScrollingFlatPanel.xml.annotated.lua | 34 + .../Mainline/TabardFrame.lua.annotated.lua | 101 + .../Mainline/TabardFrame.xml | 387 + .../Mainline/TabardFrame.xml.annotated.lua | 444 + ...dModelControlButtonMixin.lua.annotated.lua | 9 + .../Mainline/TradeFrame.lua.annotated.lua | 269 + .../Mainline/TradeFrame.xml | 456 + .../Mainline/TradeFrame.xml.annotated.lua | 727 + ...itPositionFrameTemplates.lua.annotated.lua | 341 + .../Mainline/UnitPositionFrameTemplates.xml | 11 + ...itPositionFrameTemplates.xml.annotated.lua | 6 + .../WarCampaignTemplates.lua.annotated.lua | 452 + .../Mainline/WarCampaignTemplates.xml | 282 + .../WarCampaignTemplates.xml.annotated.lua | 153 + .../WorldMapActionButton.lua.annotated.lua | 130 + .../WorldMapBountyBoard.lua.annotated.lua | 789 ++ .../Mainline/WorldMapFrame.lua.annotated.lua | 184 + .../Mainline/WorldMapFrameTemplates.xml | 258 + .../WorldMapFrameTemplates.xml.annotated.lua | 66 + .../Shared/CastingBarFrame.lua.annotated.lua | 18 + .../ExtraAbilityContainer.lua.annotated.lua | 80 + .../Shared/ExtraAbilityContainer.xml | 20 + .../ExtraAbilityContainer.xml.annotated.lua | 24 + .../GossipFrameShared.lua.annotated.lua | 305 + .../Shared/GossipFrameShared.xml | 34 + .../GossipFrameShared.xml.annotated.lua | 27 + .../ItemRefHandlersShared.lua.annotated.lua | 273 + ...rInteractionFrameManager.lua.annotated.lua | 284 + .../Shared/PlayerInteractionFrameManager.xml | 9 + ...rInteractionFrameManager.xml.annotated.lua | 6 + .../Shared/SocialQueue.lua.annotated.lua | 240 + .../Shared/TaxiFrame.lua.annotated.lua | 262 + .../Shared/TaxiFrame.xml | 49 + .../Shared/TaxiFrame.xml.annotated.lua | 15 + .../VehicleSeatIndicator.lua.annotated.lua | 238 + .../Shared/VehicleSeatIndicator.xml | 69 + .../VehicleSeatIndicator.xml.annotated.lua | 27 + .../WorldMapPOIQuantizer.lua.annotated.lua | 124 + .../Blizzard_UIParent_Mainline.toc | 13 + .../Blizzard_UIParent/ChatBubbleTemplates.xml | 26 + .../ChatBubbleTemplates.xml.annotated.lua | 14 + .../Mainline/UIParent.lua.annotated.lua | 2835 ++++ .../Blizzard_UIParent/Mainline/UIParent.xml | 84 + .../Mainline/UIParent.xml.annotated.lua | 49 + .../Mainline/WorldFrame.lua.annotated.lua | 53 + .../Blizzard_UIParent/Mainline/WorldFrame.xml | 27 + .../Mainline/WorldFrame.xml.annotated.lua | 6 + .../Shared/Localization.lua.annotated.lua | 39 + .../Shared/UIParent.lua.annotated.lua | 941 ++ ...Blizzard_UIParentPanelManager_Mainline.toc | 11 + .../Mainline/UIPanelWindows.lua.annotated.lua | 66 + ...entPanelManagerOverrides.lua.annotated.lua | 31 + .../UIParentPanelManager.lua.annotated.lua | 1205 ++ .../UpdateUIPanelPositions.lua.annotated.lua | 1 + .../Blizzard_UIWidgets_Mainline.toc | 85 + ...WidgetAnimationTemplates.lua.annotated.lua | 12 + .../Blizzard_UIWidgetAnimationTemplates.xml | 49 + ...WidgetAnimationTemplates.xml.annotated.lua | 16 + ...IWidgetBelowMinimapFrame.lua.annotated.lua | 12 + .../Blizzard_UIWidgetBelowMinimapFrame.xml | 13 + ...IWidgetBelowMinimapFrame.xml.annotated.lua | 21 + ...IWidgetCenterScreenFrame.lua.annotated.lua | 11 + .../Blizzard_UIWidgetCenterScreenFrame.xml | 9 + ...IWidgetCenterScreenFrame.xml.annotated.lua | 12 + ...Blizzard_UIWidgetManager.lua.annotated.lua | 692 + .../Mainline/Blizzard_UIWidgetManager.xml | 64 + ...Blizzard_UIWidgetManager.xml.annotated.lua | 36 + ...rd_UIWidgetPowerBarFrame.lua.annotated.lua | 16 + .../Blizzard_UIWidgetPowerBarFrame.xml | 10 + ...rd_UIWidgetPowerBarFrame.xml.annotated.lua | 16 + ...ard_UIWidgetTemplateBase.lua.annotated.lua | 1969 +++ .../Blizzard_UIWidgetTemplateBase.xml | 593 + ...ard_UIWidgetTemplateBase.xml.annotated.lua | 274 + ...etTemplateBulletTextList.lua.annotated.lua | 65 + ...lizzard_UIWidgetTemplateBulletTextList.xml | 25 + ...etTemplateBulletTextList.xml.annotated.lua | 20 + ...dgetTemplateButtonHeader.lua.annotated.lua | 56 + .../Blizzard_UIWidgetTemplateButtonHeader.xml | 38 + ...dgetTemplateButtonHeader.xml.annotated.lua | 21 + ...WidgetTemplateCaptureBar.lua.annotated.lua | 273 + .../Blizzard_UIWidgetTemplateCaptureBar.xml | 127 + ...WidgetTemplateCaptureBar.xml.annotated.lua | 38 + ...idgetTemplateCaptureZone.lua.annotated.lua | 31 + .../Blizzard_UIWidgetTemplateCaptureZone.xml | 12 + ...idgetTemplateCaptureZone.xml.annotated.lua | 11 + ...ateDiscreteProgressSteps.lua.annotated.lua | 207 + ..._UIWidgetTemplateDiscreteProgressSteps.xml | 257 + ...ateDiscreteProgressSteps.xml.annotated.lua | 95 + ...emplateDoubleIconAndText.lua.annotated.lua | 38 + ...zard_UIWidgetTemplateDoubleIconAndText.xml | 45 + ...emplateDoubleIconAndText.xml.annotated.lua | 31 + ...mplateDoubleStateIconRow.lua.annotated.lua | 81 + ...ard_UIWidgetTemplateDoubleStateIconRow.xml | 6 + ...mplateDoubleStateIconRow.xml.annotated.lua | 6 + ...tTemplateDoubleStatusBar.lua.annotated.lua | 110 + ...izzard_UIWidgetTemplateDoubleStatusBar.xml | 111 + ...tTemplateDoubleStatusBar.xml.annotated.lua | 45 + ...dgetTemplateFillUpFrames.lua.annotated.lua | 331 + .../Blizzard_UIWidgetTemplateFillUpFrames.xml | 139 + ...dgetTemplateFillUpFrames.xml.annotated.lua | 76 + ...lateHorizontalCurrencies.lua.annotated.lua | 68 + ...d_UIWidgetTemplateHorizontalCurrencies.xml | 6 + ...lateHorizontalCurrencies.xml.annotated.lua | 6 + ...idgetTemplateIconAndText.lua.annotated.lua | 64 + .../Blizzard_UIWidgetTemplateIconAndText.xml | 51 + ...idgetTemplateIconAndText.xml.annotated.lua | 24 + ...ateIconTextAndBackground.lua.annotated.lua | 26 + ..._UIWidgetTemplateIconTextAndBackground.xml | 36 + ...ateIconTextAndBackground.xml.annotated.lua | 19 + ...ateIconTextAndCurrencies.lua.annotated.lua | 84 + ..._UIWidgetTemplateIconTextAndCurrencies.xml | 28 + ...ateIconTextAndCurrencies.xml.annotated.lua | 17 + ...idgetTemplateItemDisplay.lua.annotated.lua | 41 + .../Blizzard_UIWidgetTemplateItemDisplay.xml | 12 + ...idgetTemplateItemDisplay.xml.annotated.lua | 11 + ...tTemplateMapPinAnimation.lua.annotated.lua | 57 + ...izzard_UIWidgetTemplateMapPinAnimation.xml | 37 + ...tTemplateMapPinAnimation.xml.annotated.lua | 19 + ...TemplatePreyHuntProgress.lua.annotated.lua | 114 + ...zzard_UIWidgetTemplatePreyHuntProgress.xml | 94 + ...TemplatePreyHuntProgress.xml.annotated.lua | 42 + ...rCurrenciesAndBackground.lua.annotated.lua | 93 + ...eScenarioHeaderCurrenciesAndBackground.xml | 13 + ...rCurrenciesAndBackground.xml.annotated.lua | 7 + ...lateScenarioHeaderDelves.lua.annotated.lua | 133 + ...d_UIWidgetTemplateScenarioHeaderDelves.xml | 67 + ...lateScenarioHeaderDelves.xml.annotated.lua | 35 + ...plateScenarioHeaderTimer.lua.annotated.lua | 52 + ...rd_UIWidgetTemplateScenarioHeaderTimer.xml | 28 + ...plateScenarioHeaderTimer.xml.annotated.lua | 21 + ...d_UIWidgetTemplateSpacer.lua.annotated.lua | 16 + .../Blizzard_UIWidgetTemplateSpacer.xml | 6 + ...d_UIWidgetTemplateSpacer.xml.annotated.lua | 6 + ...dgetTemplateSpellDisplay.lua.annotated.lua | 156 + .../Blizzard_UIWidgetTemplateSpellDisplay.xml | 28 + ...dgetTemplateSpellDisplay.xml.annotated.lua | 16 + ...teStackedResourceTracker.lua.annotated.lua | 57 + ...UIWidgetTemplateStackedResourceTracker.xml | 5 + ...teStackedResourceTracker.xml.annotated.lua | 6 + ...IWidgetTemplateStatusBar.lua.annotated.lua | 225 + .../Blizzard_UIWidgetTemplateStatusBar.xml | 123 + ...IWidgetTemplateStatusBar.xml.annotated.lua | 40 + ...getTemplateTextColumnRow.lua.annotated.lua | 74 + ...Blizzard_UIWidgetTemplateTextColumnRow.xml | 44 + ...getTemplateTextColumnRow.xml.annotated.lua | 21 + ...getTemplateTextWithState.lua.annotated.lua | 46 + ...Blizzard_UIWidgetTemplateTextWithState.xml | 15 + ...getTemplateTextWithState.xml.annotated.lua | 11 + ...tTemplateTextWithSubtext.lua.annotated.lua | 42 + ...izzard_UIWidgetTemplateTextWithSubtext.xml | 23 + ...tTemplateTextWithSubtext.xml.annotated.lua | 19 + ...etTemplateTextureAndText.lua.annotated.lua | 19 + ...lizzard_UIWidgetTemplateTextureAndText.xml | 5 + ...etTemplateTextureAndText.xml.annotated.lua | 6 + ...emplateTextureAndTextRow.lua.annotated.lua | 129 + ...zard_UIWidgetTemplateTextureAndTextRow.xml | 8 + ...emplateTextureAndTextRow.xml.annotated.lua | 7 + ...lateTextureWithAnimation.lua.annotated.lua | 83 + ...d_UIWidgetTemplateTextureWithAnimation.xml | 141 + ...lateTextureWithAnimation.xml.annotated.lua | 68 + ...UIWidgetTemplateTugOfWar.lua.annotated.lua | 200 + .../Blizzard_UIWidgetTemplateTugOfWar.xml | 89 + ...UIWidgetTemplateTugOfWar.xml.annotated.lua | 40 + ...dgetTemplateUnitPowerBar.lua.annotated.lua | 86 + .../Blizzard_UIWidgetTemplateUnitPowerBar.xml | 65 + ...dgetTemplateUnitPowerBar.xml.annotated.lua | 42 + ...idgetTemplateZoneControl.lua.annotated.lua | 58 + .../Blizzard_UIWidgetTemplateZoneControl.xml | 18 + ...idgetTemplateZoneControl.xml.annotated.lua | 12 + ...d_UIWidgetTopCenterFrame.lua.annotated.lua | 7 + .../Blizzard_UIWidgetTopCenterFrame.xml | 9 + ...d_UIWidgetTopCenterFrame.xml.annotated.lua | 12 + .../Blizzard_WidgetsUtil.lua.annotated.lua | 84 + .../Blizzard_UnitFrame_Mainline.toc | 58 + ...onHunterSoulFragmentsBar.lua.annotated.lua | 177 + .../DemonHunterSoulFragmentsBar.xml | 68 + ...onHunterSoulFragmentsBar.xml.annotated.lua | 48 + .../DevourerFuryBar.lua.annotated.lua | 79 + .../Blizzard_UnitFrame/DevourerFuryBar.xml | 31 + .../DevourerFuryBar.xml.annotated.lua | 17 + .../AlternatePowerBar.lua.annotated.lua | 106 + .../Mainline/AlternatePowerBar.xml | 14 + .../AlternatePowerBar.xml.annotated.lua | 21 + .../AlternatePowerBarBase.lua.annotated.lua | 248 + .../Mainline/AlternatePowerBarBase.xml | 65 + .../AlternatePowerBarBase.xml.annotated.lua | 33 + .../BuilderSpenderFrame.lua.annotated.lua | 234 + .../Mainline/BuilderSpenderFrame.xml | 102 + .../BuilderSpenderFrame.xml.annotated.lua | 42 + .../Mainline/ClassPowerBar.lua.annotated.lua | 132 + .../Mainline/ClassPowerBar.xml | 13 + .../Mainline/ClassPowerBar.xml.annotated.lua | 6 + ...ClassResourceBarTemplate.lua.annotated.lua | 155 + .../Mainline/ClassResourceBarTemplate.xml | 26 + ...ClassResourceBarTemplate.xml.annotated.lua | 20 + .../Mainline/ComboFrame.lua.annotated.lua | 125 + .../Mainline/ComboFrame.xml | 94 + .../Mainline/ComboFrame.xml.annotated.lua | 58 + .../CompactArenaFrame.lua.annotated.lua | 611 + .../Mainline/CompactArenaFrame.xml | 181 + .../CompactArenaFrame.xml.annotated.lua | 78 + .../CompactUnitFrameOptions.lua.annotated.lua | 154 + .../DruidComboPointBar.lua.annotated.lua | 61 + .../Mainline/DruidComboPointBar.xml | 114 + .../DruidComboPointBar.xml.annotated.lua | 67 + .../EssenceFramePlayer.lua.annotated.lua | 114 + .../Mainline/EssenceFramePlayer.xml | 305 + .../EssenceFramePlayer.xml.annotated.lua | 114 + .../EvokerEbonMightBar.lua.annotated.lua | 144 + .../Mainline/EvokerEbonMightBar.xml | 35 + .../EvokerEbonMightBar.xml.annotated.lua | 25 + .../Mainline/InsanityBar.lua.annotated.lua | 58 + .../Mainline/InsanityBar.xml | 45 + .../Mainline/InsanityBar.xml.annotated.lua | 24 + .../Mainline/Localization.lua.annotated.lua | 92 + .../MageArcaneChargesBar.lua.annotated.lua | 47 + .../Mainline/MageArcaneChargesBar.xml | 137 + .../MageArcaneChargesBar.xml.annotated.lua | 70 + .../Mainline/MonkHarmonyBar.lua.annotated.lua | 69 + .../Mainline/MonkHarmonyBar.xml | 130 + .../Mainline/MonkHarmonyBar.xml.annotated.lua | 70 + .../Mainline/MonkStaggerBar.lua.annotated.lua | 75 + .../Mainline/MonkStaggerBar.xml | 11 + .../Mainline/MonkStaggerBar.xml.annotated.lua | 18 + .../PaladinPowerBar.lua.annotated.lua | 214 + .../Mainline/PaladinPowerBar.xml | 242 + .../PaladinPowerBar.xml.annotated.lua | 206 + .../Mainline/PartyFrameTemplates.xml | 386 + .../PartyFrameTemplates.xml.annotated.lua | 179 + .../PartyMemberFrame.lua.annotated.lua | 653 + .../Mainline/PetFrame.lua.annotated.lua | 222 + .../Blizzard_UnitFrame/Mainline/PetFrame.xml | 200 + .../Mainline/PetFrame.xml.annotated.lua | 160 + .../Mainline/PlayerFrame.lua.annotated.lua | 789 ++ .../Mainline/PlayerFrame.xml | 475 + .../Mainline/PlayerFrame.xml.annotated.lua | 259 + .../PowerBarColorUtil.lua.annotated.lua | 69 + .../RogueComboPointBar.lua.annotated.lua | 120 + .../Mainline/RogueComboPointBar.xml | 250 + .../RogueComboPointBar.xml.annotated.lua | 128 + .../Mainline/RuneFrame.lua.annotated.lua | 366 + .../Blizzard_UnitFrame/Mainline/RuneFrame.xml | 244 + .../Mainline/RuneFrame.xml.annotated.lua | 123 + .../Mainline/ShardBar.lua.annotated.lua | 164 + .../Blizzard_UnitFrame/Mainline/ShardBar.xml | 174 + .../Mainline/ShardBar.xml.annotated.lua | 105 + .../Mainline/TargetFrame.lua.annotated.lua | 1469 +++ .../Mainline/TargetFrame.xml | 755 ++ .../Mainline/TargetFrame.xml.annotated.lua | 937 ++ .../Mainline/TotemFrame.lua.annotated.lua | 104 + .../Mainline/TotemFrame.xml | 73 + .../Mainline/TotemFrame.xml.annotated.lua | 42 + .../Mainline/UnitFrame.lua.annotated.lua | 1109 ++ .../UnitPowerBarAlt.lua.annotated.lua | 907 ++ .../Mainline/UnitPowerBarAlt.xml | 244 + .../UnitPowerBarAlt.xml.annotated.lua | 203 + .../CompactPartyFrame.lua.annotated.lua | 201 + .../Shared/CompactPartyFrame.xml | 46 + .../CompactPartyFrame.xml.annotated.lua | 42 + .../Shared/CompactRaidGroup.lua.annotated.lua | 172 + .../Shared/CompactRaidGroup.xml | 82 + .../Shared/CompactRaidGroup.xml.annotated.lua | 49 + .../Shared/CompactUnitFrame.lua.annotated.lua | 2858 ++++ .../Shared/CompactUnitFrame.xml | 237 + .../Shared/CompactUnitFrame.xml.annotated.lua | 199 + .../Shared/PartyFrame.lua.annotated.lua | 309 + .../Blizzard_UnitFrame/Shared/PartyFrame.xml | 62 + .../Shared/PartyFrame.xml.annotated.lua | 34 + .../Shared/PartyFrameTemplates.xml | 50 + .../PartyFrameTemplates.xml.annotated.lua | 22 + .../Shared/PartyMemberFrame.lua.annotated.lua | 219 + .../Shared/PlayerFrame.lua.annotated.lua | 63 + .../Shared/PlayerFrameTemplates.xml | 33 + .../PlayerFrameTemplates.xml.annotated.lua | 25 + .../StatusBarOverlaySegment.lua.annotated.lua | 91 + .../Shared/StatusBarOverlaySegment.xml | 75 + .../StatusBarOverlaySegment.xml.annotated.lua | 22 + .../Shared/TargetFrame.lua.annotated.lua | 15 + .../Shared/UnitFrame.lua.annotated.lua | 53 + .../Blizzard_UnitFrame/Shared/UnitFrame.xml | 42 + .../Shared/UnitFrame.xml.annotated.lua | 47 + .../Blizzard_UnitPopup_Mainline.toc | 13 + .../Mainline/UnitPopup.lua.annotated.lua | 76 + .../Mainline/UnitPopupUtils.lua.annotated.lua | 136 + .../UnitPopupCustomControls.lua.annotated.lua | 202 + .../UnitPopupCustomControls.xml | 82 + .../UnitPopupCustomControls.xml.annotated.lua | 87 + .../UnitPopupSlider.lua.annotated.lua | 11 + .../Blizzard_UnitPopup/UnitPopupSlider.xml | 6 + .../UnitPopupSlider.xml.annotated.lua | 6 + .../Blizzard_UnitPopupShared_Mainline.toc | 12 + ...tPopupSharedButtonMixins.lua.annotated.lua | 48 + .../UnitPopupShared.lua.annotated.lua | 133 + ...tPopupSharedButtonMixins.lua.annotated.lua | 3673 ++++++ .../UnitPopupSharedMenus.lua.annotated.lua | 507 + .../UnitPopupSharedUtils.lua.annotated.lua | 260 + .../Blizzard_VoiceToggleButton.toc | 7 + .../VoiceToggleButton.lua.annotated.lua | 270 + .../VoiceToggleButton.xml | 53 + .../VoiceToggleButton.xml.annotated.lua | 58 + ...ard_WarfrontsPartyPoseUI.lua.annotated.lua | 182 + .../Blizzard_WarfrontsPartyPoseUI.toc | 9 + .../Blizzard_WarfrontsPartyPoseUI.xml | 35 + ...ard_WarfrontsPartyPoseUI.xml.annotated.lua | 23 + .../Blizzard_WeeklyRewards.lua.annotated.lua | 1138 ++ .../Blizzard_WeeklyRewards.toc | 3 + .../Blizzard_WeeklyRewards.xml | 790 ++ .../Blizzard_WeeklyRewards.xml.annotated.lua | 319 + ...izzard_WeeklyRewardsUtil.lua.annotated.lua | 118 + .../Blizzard_WeeklyRewardsUtil.toc | 3 + .../Blizzard_WorldLootObjectList.toc | 8 + .../Blizzard_WorldMap.lua.annotated.lua | 596 + .../Blizzard_WorldMap/Blizzard_WorldMap.xml | 86 + .../Blizzard_WorldMap.xml.annotated.lua | 55 + ...izzard_WorldMapTemplates.lua.annotated.lua | 736 ++ .../Blizzard_WorldMapTemplates.xml | 339 + ...izzard_WorldMapTemplates.xml.annotated.lua | 112 + .../Blizzard_WorldMap_Mainline.toc | 13 + .../MapTexturePreloader.lua.annotated.lua | 26 + .../QuestLogOwnerMixin.lua.annotated.lua | 246 + .../WM_DebugDataProvider.lua.annotated.lua | 166 + .../WM_DebugDataProvider.xml | 14 + .../WM_DebugDataProvider.xml.annotated.lua | 11 + ...EventOverlayDataProvider.lua.annotated.lua | 59 + .../WM_EventOverlayDataProvider.xml | 22 + ...EventOverlayDataProvider.xml.annotated.lua | 10 + ...M_WorldQuestDataProvider.lua.annotated.lua | 45 + .../WM_WorldQuestDataProvider.xml | 6 + ...M_WorldQuestDataProvider.xml.annotated.lua | 6 + .../Blizzard_WowSurveyUI.lua.annotated.lua | 50 + .../Blizzard_WowSurveyUI.toc | 5 + .../Blizzard_WowSurveyUI.xml | 11 + .../Blizzard_WowSurveyUI.xml.annotated.lua | 7 + .../Blizzard_WowTokenUI.lua.annotated.lua | 958 ++ .../Blizzard_WowTokenUI.toc | 5 + .../Blizzard_WowTokenUI.xml | 325 + .../Blizzard_WowTokenUI.xml.annotated.lua | 2 + ...izzard_WowTokenUIInbound.lua.annotated.lua | 22 + ...zzard_WowTokenUIInsecure.lua.annotated.lua | 15 + .../Blizzard_WowTokenUIInsecure.xml | 4 + ...zzard_WowTokenUIInsecure.xml.annotated.lua | 2 + ...zzard_WowTokenUIOutbound.lua.annotated.lua | 22 + .../Blizzard_ZoneAbility_Mainline.toc | 8 + .../ZoneAbility.lua.annotated.lua | 321 + .../Blizzard_ZoneAbility/ZoneAbility.xml | 69 + .../ZoneAbility.xml.annotated.lua | 39 + .../Annotations/_enums.lua.annotated.lua | 237 + .../Annotations/_templates.lua.annotated.lua | 3385 +++++ .../Annotations/FrameXML/README.md | 32 + .../AbbreviateConfigAPIDocumentation.lua | 49 + ...eviatedNumberFormatterAPIDocumentation.lua | 96 + .../AccessibilityOptionsDocumentation.lua | 25 + .../AccountConstantsDocumentation.lua | 292 + .../AccountInfoDocumentation.lua | 70 + .../AccountStoreDocumentation.lua | 279 + .../AchievementInfoDocumentation.lua | 209 + .../AchievementTelemetryDocumentation.lua | 51 + .../ActionBarFrameDocumentation.lua | 1151 ++ .../ActionBarSharedDocumentation.lua | 27 + .../ActionDocumentation.lua | 17 + .../AddOnConstantsDocumentation.lua | 39 + .../AddOnProfilerConstantsDocumentation.lua | 47 + .../AddOnProfilerDocumentation.lua | 208 + .../AddOnsDocumentation.lua | 452 + .../AdventureJournalDocumentation.lua | 130 + .../AdventureMapDocumentation.lua | 127 + .../AlliedRacesFrameDocumentation.lua | 101 + .../AnimaDiversionUIDocumentation.lua | 153 + .../AppearanceSourceDocumentation.lua | 38 + .../ArdenwealdGardeningDocumentation.lua | 53 + .../AreaPoiInfoDocumentation.lua | 188 + .../ArrowCalloutConstantsDocumentation.lua | 41 + .../ArtifactUIDocumentation.lua | 1019 ++ .../AssistedCombatDocumentation.lua | 74 + ...yncAssistActionsConstantsDocumentation.lua | 29 + .../AuctionHouseConstantsDocumentation.lua | 20 + .../AuctionHouseDocumentation.lua | 1719 +++ .../AuctionHouseEnumsDocumentation.lua | 158 + .../AuraContainerSharedDocumentation.lua | 51 + .../AuraContainerUtilDocumentation.lua | 342 + .../AutoCompleteDocumentation.lua | 96 + .../AutoCompleteSharedDocumentation.lua | 48 + .../AutoLootDocumentation.lua | 35 + .../AzeriteConstantsDocumentation.lua | 26 + .../AzeriteEmpoweredItemDocumentation.lua | 353 + .../AzeriteEssenceDocumentation.lua | 357 + .../AzeriteItemDocumentation.lua | 199 + .../BNetOutageDocumentation.lua | 34 + .../BagConstantsDocumentation.lua | 69 + .../BagIndexConstantsDocumentation.lua | 61 + .../BankDocumentation.lua | 472 + .../BarberShopDocumentation.lua | 333 + .../BarberShopInternalDocumentation.lua | 35 + .../BaseDocumentation.lua | 19 + .../BattleNetDocumentation.lua | 508 + .../BattleNetSharedDocumentation.lua | 45 + .../BattlePetConstantsDocumentation.lua | 78 + .../BattlePetDocumentation.lua | 264 + .../BattlepayConstantsDocumentation.lua | 336 + .../BehavioralMessagingDocumentation.lua | 48 + .../BlackMarketInfoDocumentation.lua | 82 + .../BlizzCon2026Documentation.lua | 96 + .../Blizzard_APIDocumentationGenerated.toc | 647 + .../BountySharedDocumentation.lua | 24 + .../BrowserDocumentation.lua | 83 + .../BuildDocumentation.lua | 144 + .../ButtonStateDocumentation.lua | 12 + .../CVarDocumentation.lua | 233 + .../CalendarConstantsDocumentation.lua | 351 + .../CalendarDocumentation.lua | 1187 ++ .../CameraConstantsDocumentation.lua | 26 + .../CameraDocumentation.lua | 59 + .../CatalogShopConstantsDocumentation.lua | 21 + .../CatalogShopDocumentation.lua | 856 ++ .../ChallengeModeInfoDocumentation.lua | 540 + ...haracterCreationConstantsDocumentation.lua | 53 + ...racterCustomizationSharedDocumentation.lua | 149 + ...aracterSelectionConstantsDocumentation.lua | 139 + ...haracterServicesConstantsDocumentation.lua | 45 + .../ChatBubblesDocumentation.lua | 40 + .../ChatConstantsDocumentation.lua | 241 + .../ChatInfoDocumentation.lua | 2882 ++++ .../ChatSharedDocumentation.lua | 23 + .../ChromieTimeUIDocumentation.lua | 79 + .../CinematicConstantsDocumentation.lua | 26 + .../CinematicDocumentation.lua | 134 + .../CinematicListDocumentation.lua | 48 + .../ClassColorDocumentation.lua | 42 + .../ClassTalentsDocumentation.lua | 525 + .../ClassTrialDocumentation.lua | 37 + .../ClickBindingsConstantsDocumentation.lua | 50 + .../ClickBindingsDocumentation.lua | 133 + .../ClientDocumentation.lua | 121 + .../ClientSceneDocumentation.lua | 68 + .../ClientSettingsDocumentation.lua | 31 + .../ClubDocumentation.lua | 1996 +++ .../ClubFinderDocumentation.lua | 993 ++ .../ClubSharedDocumentation.lua | 26 + .../ColorDocumentation.lua | 12 + .../ColorOverrideConstantsDocumentation.lua | 30 + .../ColorOverridesDocumentation.lua | 121 + .../ColorUtilDocumentation.lua | 155 + ...CombatAudioAlertConstantsDocumentation.lua | 60 + .../CombatAudioAlertDocumentation.lua | 265 + .../CombatAudioAlertSharedDocumentation.lua | 299 + .../CombatLogConstantsDocumentation.lua | 91 + .../CombatLogDocumentation.lua | 158 + .../CombatLogInternalDocumentation.lua | 40 + .../CombatLogSecureDocumentation.lua | 158 + .../CombatLogSharedDocumentation.lua | 31 + .../CombatTextDocumentation.lua | 65 + .../CombatTextSharedDocumentation.lua | 19 + .../CommentatorFrameDocumentation.lua | 1938 +++ .../CommentatorSharedDocumentation.lua | 37 + .../CompactUnitFramesDocumentation.lua | 31 + ...igurationWarningConstantsDocumentation.lua | 30 + .../ConfigurationWarningsDocumentation.lua | 81 + .../ConnectionDocumentation.lua | 118 + .../ConsoleDocumentation.lua | 275 + .../ConsoleScriptCollectionDocumentation.lua | 125 + .../ContainerDocumentation.lua | 833 ++ .../ContentTrackingDocumentation.lua | 358 + .../ContentTrackingTypesDocumentation.lua | 129 + .../ContributionCollectorDocumentation.lua | 366 + .../CooldownFrameConstantsDocumentation.lua | 24 + .../CooldownViewerConstantsDocumentation.lua | 233 + .../CooldownViewerDocumentation.lua | 167 + ...CovenantCallingsConstantsDocumentation.lua | 33 + .../CovenantCallingsDocumentation.lua | 48 + .../CovenantPreviewDocumentation.lua | 110 + .../CovenantSanctumConstantsDocumentation.lua | 12 + .../CovenantSanctumDocumentation.lua | 226 + .../CovenantsConstantsDocumentation.lua | 25 + .../CovenantsDocumentation.lua | 90 + .../CraftingOrderUIConstantsDocumentation.lua | 47 + .../CraftingOrderUIDocumentation.lua | 614 + .../CraftingOrderUISharedDocumentation.lua | 248 + .../CreatureInfoDocumentation.lua | 181 + .../CurrencyConstantsDocumentation.lua | 247 + ...urrencyConstants_MainlineDocumentation.lua | 40 + .../CurrencyInfoDocumentation.lua | 746 ++ .../CursorConstDocumentation.lua | 188 + .../CursorDocumentation.lua | 71 + .../CursorUtilDocumentation.lua | 34 + .../CurveUtilDocumentation.lua | 97 + .../DamageConstantsDocumentation.lua | 142 + .../DamageMeterConstantsDocumentation.lua | 122 + .../DamageMeterDocumentation.lua | 252 + .../DateAndTimeDocumentation.lua | 182 + .../DeathAlertDocumentation.lua | 35 + .../DeathInfoDocumentation.lua | 225 + .../DeathRecapDocumentation.lua | 93 + .../DebugToggleDocumentation.lua | 65 + .../DelvesConstantsDocumentation.lua | 129 + .../DelvesUIDocumentation.lua | 617 + .../DiscordConstantsDocumentation.lua | 69 + .../DiscordDocumentation.lua | 278 + .../DuelInfoDocumentation.lua | 63 + ...DungeonEncounterConstantsDocumentation.lua | 58 + ...ationTextBindingObjectAPIDocumentation.lua | 394 + ...DurationTextBindingSharedDocumentation.lua | 56 + .../DurationUtilDocumentation.lua | 55 + .../DyeColorInfoDocumentation.lua | 161 + .../DyeColorInfoSharedDocumentation.lua | 36 + .../EditModeManagerConstantsDocumentation.lua | 1046 ++ .../EditModeManagerDocumentation.lua | 220 + .../EncodingUtilConstantsDocumentation.lua | 21 + .../EncodingUtilDocumentation.lua | 242 + .../EncounterEventsDocumentation.lua | 146 + .../EncounterEventsSharedDocumentation.lua | 61 + .../EncounterInfoDocumentation.lua | 116 + ...EncounterJournalConstantsDocumentation.lua | 132 + .../EncounterJournalDocumentation.lua | 407 + ...ncounterTimelineConstantsDocumentation.lua | 139 + .../EncounterTimelineDocumentation.lua | 647 + .../EncounterWarningsDocumentation.lua | 177 + .../EndOfMatchUIDocumentation.lua | 84 + .../EquipmentManagerDocumentation.lua | 345 + .../EventSchedulerConstantsDocumentation.lua | 23 + .../EventSchedulerUIDocumentation.lua | 190 + .../EventUtilsDocumentation.lua | 55 + .../ExpansionConstantsDocumentation.lua | 24 + .../ExpansionDocumentation.lua | 328 + .../ExpansionInfoDocumentation.lua | 63 + ...nsionLandingPageConstantsDocumentation.lua | 24 + .../ExpansionLevelConstantsDocumentation.lua | 35 + .../ExpansionTrialDocumentation.lua | 35 + .../ExternalEventURLDocumentation.lua | 54 + .../FlyoutDocumentation.lua | 139 + .../FogOfWarDocumentation.lua | 72 + .../FontDocumentation.lua | 98 + .../ForbiddenAspectConstantsDocumentation.lua | 37 + ...rameAPIArchaeologyDigsiteDocumentation.lua | 24 + .../FrameAPIBlobDocumentation.lua | 164 + ...rameAPICharacterModelBaseDocumentation.lua | 288 + .../FrameAPICinematicModelDocumentation.lua | 209 + .../FrameAPICooldownDocumentation.lua | 586 + .../FrameAPIDressUpModelDocumentation.lua | 272 + .../FrameAPIFogOfWarFrameDocumentation.lua | 164 + ...IModelSceneFrameActorBaseDocumentation.lua | 657 + ...meAPIModelSceneFrameActorDocumentation.lua | 411 + .../FrameAPIModelSceneFrameDocumentation.lua | 610 + ...eAPIModelSceneFrameSharedDocumentation.lua | 24 + .../FrameAPINamePlateDocumentation.lua | 102 + .../FrameAPIQuestPOIDocumentation.lua | 69 + .../FrameAPIScenarioPOIDocumentation.lua | 53 + .../FrameAPISimpleCheckoutDocumentation.lua | 101 + .../FrameAPITabardModelBaseDocumentation.lua | 97 + .../FrameAPITabardModelDocumentation.lua | 102 + .../FrameAPITooltipDocumentation.lua | 150 + ...FrameAPIUnitPositionFrameDocumentation.lua | 164 + .../FrameScriptDocumentation.lua | 617 + .../FriendListDocumentation.lua | 712 + ...ON_FOLLOWER_TYPEConstantsDocumentation.lua | 27 + .../GARRISON_TYPEConstantsDocumentation.lua | 26 + .../GMTicketInfoDocumentation.lua | 93 + .../GameCursorDocumentation.lua | 181 + .../GameErrorDocumentation.lua | 46 + .../GamePadConstDocumentation.lua | 28 + .../GamePadDocumentation.lua | 468 + .../GameRulesConstantsDocumentation.lua | 53 + .../GameRulesDocumentation.lua | 422 + .../GameUIDocumentation.lua | 44 + .../GamepadTargetingDocumentation.lua | 70 + .../GamepadUIDocumentation.lua | 166 + .../GarrisonConstantsDocumentation.lua | 380 + .../GarrisonInfoDocumentation.lua | 1464 +++ .../GarrisonSharedDocumentation.lua | 108 + .../GlueDocumentation.lua | 49 + .../GlyphConstantsDocumentation.lua | 12 + .../GlyphInfoDocumentation.lua | 51 + .../GossipConstantsDocumentation.lua | 117 + .../GossipInfoDocumentation.lua | 428 + .../GroupFinderConstantsDocumentation.lua | 12 + .../GuildBankDocumentation.lua | 102 + .../GuildConstantsDocumentation.lua | 77 + .../GuildInfoDocumentation.lua | 750 ++ .../GuildInfoSharedDocumentation.lua | 24 + .../HeirloomInfoDocumentation.lua | 123 + .../HouseEditorUIDocumentation.lua | 174 + .../HouseExteriorConstantsDocumentation.lua | 89 + .../HouseExteriorUIDocumentation.lua | 344 + .../HousingBasicModeUIDocumentation.lua | 293 + ...HousingBlueprintConstantsDocumentation.lua | 138 + .../HousingBlueprintUIDocumentation.lua | 396 + .../HousingCatalogConstantsDocumentation.lua | 125 + ...HousingCatalogSearcherAPIDocumentation.lua | 555 + .../HousingCatalogUIDocumentation.lua | 650 + .../HousingCleanupModeUIDocumentation.lua | 77 + .../HousingCustomizeModeUIDocumentation.lua | 487 + .../HousingDecorSharedDocumentation.lua | 63 + .../HousingDecorUIDocumentation.lua | 531 + .../HousingExpertModeUIDocumentation.lua | 312 + ...usingFixturePointFrameAPIDocumentation.lua | 85 + .../HousingInspectModeUIDocumentation.lua | 77 + .../HousingLayoutPinFrameAPIDocumentation.lua | 237 + .../HousingLayoutUIDocumentation.lua | 610 + .../HousingLayoutUITypesDocumentation.lua | 76 + .../HousingNeighborhoodUIDocumentation.lua | 424 + .../HousingUIDocumentation.lua | 966 ++ .../HousingUISharedDocumentation.lua | 177 + .../ImageSharingConstantsDocumentation.lua | 96 + ...mersiveInteractionManagerDocumentation.lua | 46 + .../InGameNavigationDocumentation.lua | 138 + .../IncomingSummonDocumentation.lua | 69 + .../InputConstantsDocumentation.lua | 38 + .../InputDocumentation.lua | 354 + .../InputInterfaceStyleDocumentation.lua | 34 + .../InstanceDocumentation.lua | 292 + .../InstanceEncounterDocumentation.lua | 121 + .../InstanceLeaverInfoDocumentation.lua | 45 + .../InterfaceFileManifestDocumentation.lua | 35 + .../IntlDocumentation.lua | 503 + .../IntlSharedTypesDocumentation.lua | 154 + .../InvasionInfoDocumentation.lua | 93 + .../IslandsInfoDocumentation.lua | 39 + .../IslandsQueueUIDocumentation.lua | 97 + .../ItemConstantsDocumentation.lua | 882 ++ .../ItemConstants_MainlineDocumentation.lua | 81 + .../ItemConstants_SharedDocumentation.lua | 12 + .../ItemDocumentation.lua | 1987 +++ .../ItemInteractionUIDocumentation.lua | 160 + .../ItemQualitiesDocumentation.lua | 31 + .../ItemSharedDocumentation.lua | 12 + .../ItemSocketInfoDocumentation.lua | 280 + .../ItemTextDocumentation.lua | 53 + .../ItemUpgradeDocumentation.lua | 312 + .../KeyBindingsDocumentation.lua | 258 + .../LFGConstantsDocumentation.lua | 158 + .../LFGInfoDocumentation.lua | 539 + .../LFGListInfoDocumentation.lua | 1066 ++ .../LFGListRolesDocumentation.lua | 67 + .../LegacyConstantsDocumentation.lua | 25 + .../LegendaryCraftingDocumentation.lua | 338 + .../LegendaryCraftingTypesDocumentation.lua | 96 + .../LevelConstantsDocumentation.lua | 22 + .../LevelLinkDocumentation.lua | 55 + .../LevelSquishDocumentation.lua | 56 + .../LimitedInputDocumentation.lua | 54 + .../LiveEventDocumentation.lua | 47 + .../LoadingScreenDocumentation.lua | 37 + .../LobbyMatchmakerInfoDocumentation.lua | 149 + .../LocaleDocumentation.lua | 90 + .../LocalizationDocumentation.lua | 198 + .../LocalizationSharedDocumentation.lua | 60 + .../LogConstantsDocumentation.lua | 28 + .../LogDocumentation.lua | 66 + .../LogicConstantsDocumentation.lua | 59 + .../LootConstantsDocumentation.lua | 54 + .../LootConstants_MainlineDocumentation.lua | 53 + .../LootDocumentation.lua | 440 + .../LootFrameDocumentation.lua | 29 + .../LootHistoryDocumentation.lua | 204 + .../LootJournalDocumentation.lua | 84 + .../LoreTextDocumentation.lua | 55 + .../LossOfControlConstantsDocumentation.lua | 20 + .../LossOfControlDocumentation.lua | 171 + .../LuaColorCurveObjectAPIDocumentation.lua | 183 + .../LuaCurveObjectAPIDocumentation.lua | 154 + .../LuaCurveObjectBaseAPIDocumentation.lua | 65 + .../LuaCurveObjectConstantsDocumentation.lua | 26 + .../LuaDurationClockAPIDocumentation.lua | 39 + ...LuaDurationManualClockAPIDocumentation.lua | 67 + .../LuaDurationObjectAPIDocumentation.lua | 493 + .../LuaDurationObjectSharedDocumentation.lua | 24 + .../LuaLocaleContextAPIDocumentation.lua | 413 + .../LuaMathExtensionsDocumentation.lua | 214 + .../LuaStringExtensionsDocumentation.lua | 127 + .../LuaTableExtensionsDocumentation.lua | 227 + .../LuaValuePredicatesDocumentation.lua | 17 + .../MacOptionsDocumentation.lua | 102 + .../MacroConstantsDocumentation.lua | 21 + .../MailInfoDocumentation.lua | 181 + .../MajorFactionsConstantsDocumentation.lua | 50 + .../MajorFactionsDocumentation.lua | 362 + .../MapConstantsDocumentation.lua | 113 + .../MapDocumentation.lua | 753 ++ .../MapExplorationDocumentation.lua | 89 + .../MatrixSharedDocumentation.lua | 12 + .../MerchantFrameDocumentation.lua | 150 + .../MinimapConstantsDocumentation.lua | 48 + .../MinimapDocumentation.lua | 327 + .../MinimapFrameAPIDocumentation.lua | 344 + .../MirrorTimerDocumentation.lua | 75 + .../ModelAnimationSharedDocumentation.lua | 24 + .../MoneyConstantsDocumentation.lua | 33 + .../MountConstantsDocumentation.lua | 50 + .../MountJournalDocumentation.lua | 719 + .../MovieDocumentation.lua | 106 + .../MythicPlusInfoDocumentation.lua | 355 + .../MythicPlusInfoSharedDocumentation.lua | 55 + .../NameGenConstantsDocumentation.lua | 24 + .../NamePlateConstantsDocumentation.lua | 170 + .../NamePlateDocumentation.lua | 72 + .../NamePlateManagerDocumentation.lua | 159 + .../NameUtilDocumentation.lua | 41 + .../NeighborhoodInitiativeDocumentation.lua | 362 + ...rhoodInitiativesConstantsDocumentation.lua | 115 + .../NewItemsDocumentation.lua | 56 + .../NumericFormatterAPIDocumentation.lua | 41 + .../NumericRuleFormatterAPIDocumentation.lua | 85 + ...umericRuleFormatterSharedDocumentation.lua | 50 + .../OsDocumentation.lua | 50 + .../PVPMgrConstantsDocumentation.lua | 24 + .../PaperDollInfoDocumentation.lua | 508 + .../ParentalControlsDocumentation.lua | 33 + .../PartyConstantsDocumentation.lua | 65 + .../PartyInfoDocumentation.lua | 924 ++ .../PartyInfoSystemStatusDocumentation.lua | 49 + .../PartyPoseUIConstantsDocumentation.lua | 23 + .../PartyPoseUIDocumentation.lua | 111 + .../PerformanceDocumentation.lua | 112 + .../PerksActivitiesDocumentation.lua | 239 + .../PerksProgramDocumentation.lua | 472 + .../PerksVendorConstantsDocumentation.lua | 52 + .../PetBattleConstantsDocumentation.lua | 82 + .../PetBattlesDocumentation.lua | 94 + .../PetConstantsDocumentation.lua | 66 + .../PetConstants_SharedDocumentation.lua | 138 + .../PetInfoDocumentation.lua | 263 + .../PetJournalInfoDocumentation.lua | 516 + .../PetScalingConstantsDocumentation.lua | 12 + .../PhotoSharingUIDocumentation.lua | 155 + .../PingConstantsDocumentation.lua | 113 + .../PingManagerDocumentation.lua | 109 + .../PingManagerSecureDocumentation.lua | 385 + .../PingManagerSharedDocumentation.lua | 32 + .../PingPinFrameAPIDocumentation.lua | 24 + .../PlatformDocumentation.lua | 37 + .../PlayerChoiceConstantsDocumentation.lua | 65 + .../PlayerChoiceDocumentation.lua | 210 + .../PlayerDataConstantsDocumentation.lua | 46 + .../PlayerDocumentation.lua | 12 + .../PlayerHousingConstantsDocumentation.lua | 633 + .../PlayerInfoDocumentation.lua | 404 + .../PlayerInfoSharedDocumentation.lua | 35 + ...teractionManagerConstantsDocumentation.lua | 104 + .../PlayerInteractionManagerDocumentation.lua | 131 + .../PlayerLocationDocumentation.lua | 133 + ...PlayerMentorshipConstantsDocumentation.lua | 38 + .../PlayerMentorshipDocumentation.lua | 90 + .../PlayerScriptDocumentation.lua | 1833 +++ .../PonyDocumentation.lua | 26 + .../PowerTypeConstantsDocumentation.lua | 97 + .../ProceduralSpawnConstantsDocumentation.lua | 37 + .../ProfessionConstantsDocumentation.lua | 395 + .../ProfessionSpecConstantsDocumentation.lua | 110 + .../ProfessionSpecUIDocumentation.lua | 423 + .../PvPFactionConstantsDocumentation.lua | 24 + .../PvpInfoConstantsDocumentation.lua | 50 + .../PvpInfoDocumentation.lua | 2000 +++ .../QuestConstantsDocumentation.lua | 169 + .../QuestConstants_MainlineDocumentation.lua | 12 + .../QuestHubInfoDocumentation.lua | 57 + .../QuestInfoSharedDocumentation.lua | 53 + .../QuestInfoSystemDocumentation.lua | 165 + .../QuestItemUseDocumentation.lua | 42 + .../QuestLineInfoDocumentation.lua | 167 + .../QuestLogDocumentation.lua | 1635 +++ .../QuestOfferDocumentation.lua | 123 + .../QuestRewardsDocumentation.lua | 52 + .../QuestSessionConstantsDocumentation.lua | 71 + .../QuestSessionDocumentation.lua | 215 + .../QuestTaskInfoDocumentation.lua | 208 + .../QueueSpecificDocumentation.lua | 29 + .../RaidLocksDocumentation.lua | 76 + .../RaidMarkerConstantsDocumentation.lua | 41 + .../RaidMarkersDocumentation.lua | 140 + .../RecentAlliesConstantsDocumentation.lua | 48 + .../RecentAlliesDocumentation.lua | 342 + .../RecruitAFriendDocumentation.lua | 475 + .../RecruitAFriendSharedDocumentation.lua | 61 + .../RemixArtifactUIDocumentation.lua | 164 + .../RenownConstantsDocumentation.lua | 46 + .../ReportSystemConstantsDocumentation.lua | 158 + .../ReportSystemDocumentation.lua | 184 + .../ReputationInfoDocumentation.lua | 371 + .../ResearchInfoDocumentation.lua | 121 + ...estrictedActionsConstantsDocumentation.lua | 41 + .../RestrictedActionsDocumentation.lua | 139 + .../RolesetSystemDocumentation.lua | 57 + .../RolodexConstantsDocumentation.lua | 94 + .../ScenarioInfoDocumentation.lua | 357 + .../ScrappingMachineUIDocumentation.lua | 141 + .../ScreenDocumentation.lua | 70 + .../ScreenLocationConstantsDocumentation.lua | 34 + .../ScriptWarningsDocumentation.lua | 35 + .../ScriptedAnimationsDocumentation.lua | 118 + .../SeasonInfoDocumentation.lua | 52 + .../SeasonsConstantsDocumentation.lua | 28 + .../SecondsFormatterAPIDocumentation.lua | 487 + .../SecondsFormatterSharedDocumentation.lua | 64 + .../SecretAspectConstantsDocumentation.lua | 52 + .../SecretPredicateAPIDocumentation.lua | 446 + .../SecretPredicatesDocumentation.lua | 167 + .../SecretWrapperConstantsDocumentation.lua | 25 + .../SecureTransferDocumentation.lua | 149 + .../SettingsUtilDocumentation.lua | 58 + ...redScriptObjectModelLightDocumentation.lua | 25 + ...criptObjectNamePlateFrameDocumentation.lua | 12 + ...ptObjectUnitPositionFrameDocumentation.lua | 25 + .../SharedTraitsDocumentation.lua | 1206 ++ .../SharedTraitsEnumsDocumentation.lua | 12 + .../SimpleAnimAPIDocumentation.lua | 491 + .../SimpleAnimAlphaAPIDocumentation.lua | 74 + .../SimpleAnimFlipBookAPIDocumentation.lua | 139 + .../SimpleAnimGroupAPIDocumentation.lua | 381 + .../SimpleAnimPathAPIDocumentation.lua | 90 + ...mpleAnimRadialProgressAPIDocumentation.lua | 70 + .../SimpleAnimRotationAPIDocumentation.lua | 97 + .../SimpleAnimScaleAPIDocumentation.lua | 126 + .../SimpleAnimScaleLineAPIDocumentation.lua | 24 + ...extureCoordTranslationAPIDocumentation.lua | 49 + .../SimpleAnimTranslationAPIDocumentation.lua | 49 + ...pleAnimTranslationLineAPIDocumentation.lua | 24 + .../SimpleAnimVertexColorAPIDocumentation.lua | 70 + ...SimpleAnimatableObjectAPIDocumentation.lua | 61 + .../SimpleBrowserAPIDocumentation.lua | 126 + .../SimpleButtonAPIDocumentation.lua | 501 + .../SimpleCheckboxAPIDocumentation.lua | 95 + .../SimpleColorSelectAPIDocumentation.lua | 253 + .../SimpleControlPointAPIDocumentation.lua | 84 + .../SimpleEditBoxAPIDocumentation.lua | 960 ++ .../SimpleFontAPIDocumentation.lua | 325 + .../SimpleFontStringAPIDocumentation.lua | 744 ++ .../SimpleFrameAPIDocumentation.lua | 1642 +++ ...impleFrameScriptObjectAPIDocumentation.lua | 322 + ...rameScriptObjectConstantsDocumentation.lua | 99 + .../SimpleHTMLAPIDocumentation.lua | 349 + .../SimpleHTMLSharedDocumentation.lua | 22 + .../SimpleLineAPIDocumentation.lua | 137 + .../SimpleMapSceneAPIDocumentation.lua | 90 + .../SimpleMaskTextureAPIDocumentation.lua | 24 + .../SimpleMessageFrameAPIDocumentation.lua | 430 + .../SimpleModelAPIDocumentation.lua | 784 ++ .../SimpleModelFFXAPIDocumentation.lua | 65 + .../SimpleMovieAPIDocumentation.lua | 77 + .../SimpleObjectAPIDocumentation.lua | 86 + .../SimpleOffScreenFrameAPIDocumentation.lua | 129 + .../SimpleRegionAPIDocumentation.lua | 232 + .../SimpleScriptRegionAPIDocumentation.lua | 773 ++ ...leScriptRegionResizingAPIDocumentation.lua | 200 + .../SimpleScrollFrameAPIDocumentation.lua | 137 + .../SimpleSliderAPIDocumentation.lua | 241 + .../SimpleStatusBarAPIDocumentation.lua | 381 + .../SimpleStatusBarConstantsDocumentation.lua | 62 + .../SimpleTextureAPIDocumentation.lua | 75 + .../SimpleTextureBaseAPIDocumentation.lua | 683 + .../SimpleVectorGraphicsAPIDocumentation.lua | 73 + .../SkillInfoDocumentation.lua | 142 + .../SlashCommandDocumentation.lua | 43 + .../SocialConstantsDocumentation.lua | 26 + .../SocialQueueDocumentation.lua | 237 + .../SocialQueueSystemStatusDocumentation.lua | 49 + .../SocialRestrictionsDocumentation.lua | 161 + .../SocialUIDocumentation.lua | 84 + .../SoftTargetConstantsDocumentation.lua | 26 + .../SoulbindsConstantsDocumentation.lua | 94 + .../SoulbindsDocumentation.lua | 748 ++ .../SoundDocumentation.lua | 153 + .../SpecializationConstantsDocumentation.lua | 54 + .../SpecializationInfoDocumentation.lua | 637 + .../SpecializationSharedDocumentation.lua | 135 + .../SpellActivationOverlayDocumentation.lua | 86 + .../SpellBookConstantsDocumentation.lua | 53 + .../SpellBookDocumentation.lua | 1049 ++ .../SpellConstantsDocumentation.lua | 51 + .../SpellDiminishConstantsDocumentation.lua | 43 + .../SpellDiminishUIDocumentation.lua | 123 + .../SpellDocumentation.lua | 1203 ++ .../SpellIDDocumentation.lua | 32 + .../SpellSharedDocumentation.lua | 72 + .../SplashScreenConstantsDocumentation.lua | 24 + .../SplashScreenDocumentation.lua | 91 + .../StableInfoDocumentation.lua | 259 + .../StorePublicUIDocumentation.lua | 60 + .../StreamingDocumentation.lua | 60 + .../StringUtilDocumentation.lua | 248 + .../SummonConstantsDocumentation.lua | 24 + .../SummonInfoDocumentation.lua | 78 + .../SuperTrackManagerDocumentation.lua | 215 + .../SuperTrackManagerSharedDocumentation.lua | 45 + .../SwingTimerDocumentation.lua | 90 + .../SystemDocumentation.lua | 276 + .../SystemTimeDocumentation.lua | 89 + .../TTSSettingsDocumentation.lua | 237 + .../TalentAndGlyphConstantsDocumentation.lua | 20 + .../TalentConstantsDocumentation.lua | 20 + .../TalkingHeadDocumentation.lua | 37 + .../TargetScriptDocumentation.lua | 223 + .../TaxiMapDocumentation.lua | 150 + .../TextureSharedDocumentation.lua | 12 + .../TextureUtilsDocumentation.lua | 240 + .../ThreatDocumentation.lua | 50 + .../TimeDocumentation.lua | 25 + .../TimedSignalMapAPIDocumentation.lua | 141 + .../TimedSignalMapSharedDocumentation.lua | 38 + .../TimerConstantsDocumentation.lua | 26 + .../TimerunningConstantsDocumentation.lua | 24 + .../TimerunningUIDocumentation.lua | 40 + .../TitleDocumentation.lua | 83 + .../TooltipComparisonDocumentation.lua | 109 + .../TooltipConstantsDocumentation.lua | 55 + .../TooltipInfoDocumentation.lua | 1412 ++ .../TooltipInfoSharedDocumentation.lua | 183 + .../TotemDocumentation.lua | 136 + .../ToyBoxInfoDocumentation.lua | 110 + .../TradeInfoDocumentation.lua | 179 + .../TradeSkillUIDocumentation.lua | 1411 ++ .../TradeSkillUITypesDocumentation.lua | 442 + .../TrainerConstantsDocumentation.lua | 26 + .../TrainerDocumentation.lua | 83 + .../TraitConfigDocumentation.lua | 25 + .../TraitConstantsDocumentation.lua | 364 + ...sformManipulatorConstantsDocumentation.lua | 84 + .../TransmogConstantsDocumentation.lua | 46 + .../TransmogDocumentation.lua | 325 + .../TransmogItemsDocumentation.lua | 1251 ++ .../TransmogOutfitConstantsDocumentation.lua | 460 + .../TransmogOutfitInfoDocumentation.lua | 1028 ++ .../TransmogSetsDocumentation.lua | 558 + .../TransmogSharedDocumentation.lua | 145 + .../TutorialDocumentation.lua | 155 + .../UIActionConstantsDocumentation.lua | 24 + .../UIActionDocumentation.lua | 35 + .../UIButtonSharedDocumentation.lua | 24 + ...UICharacterClassConstantsDocumentation.lua | 32 + .../UIColorDocumentation.lua | 34 + .../UIColorSharedDocumentation.lua | 21 + ...enantDisplayInfoConstantsDocumentation.lua | 26 + .../UIEventToastConstantsDocumentation.lua | 87 + .../UIEventToastManagerDocumentation.lua | 102 + .../UIFileAssetAPIDocumentation.lua | 73 + .../UIFileAssetSharedDocumentation.lua | 12 + .../UIFrameManagerDocumentation.lua | 69 + .../UIGenericWidgetDisplayDocumentation.lua | 57 + .../UIMacrosDocumentation.lua | 93 + .../UIManagerDocumentation.lua | 105 + .../UIMapPinSharedDocumentation.lua | 23 + .../UIModelInfoDocumentation.lua | 198 + .../UIModelInfoSharedDocumentation.lua | 81 + .../UIModifiedInstanceDocumentation.lua | 54 + .../UISharedDocumentation.lua | 52 + ...UISystemVisibilityManagerDocumentation.lua | 57 + .../UITextureAssetSharedDocumentation.lua | 12 + .../UITextureConstantsDocumentation.lua | 47 + .../UITimerDocumentation.lua | 98 + .../UIWidgetManagerDocumentation.lua | 2258 ++++ .../UIWidgetManagerSharedDocumentation.lua | 176 + .../URLDocumentation.lua | 46 + .../UiModelSceneConstantsDocumentation.lua | 38 + ...pcRequestManagerConstantsDocumentation.lua | 12 + .../UnitAuraConstantsDocumentation.lua | 34 + .../UnitAuraDocumentation.lua | 684 + .../UnitAuraSharedDocumentation.lua | 46 + .../UnitConstantsDocumentation.lua | 92 + .../UnitDocumentation.lua | 5074 +++++++ ...alPredictionCalculatorAPIDocumentation.lua | 495 + ...redictionCalculatorSharedDocumentation.lua | 115 + .../UnitRoleDocumentation.lua | 128 + .../UnitSexConstantsDocumentation.lua | 27 + .../UnitSharedDocumentation.lua | 392 + .../UserFeedbackDocumentation.lua | 56 + .../ValidateNameConstantsDocumentation.lua | 54 + .../VectorSharedDocumentation.lua | 12 + .../VehicleDocumentation.lua | 130 + .../VideoDocumentation.lua | 256 + .../VignetteConstantsDocumentation.lua | 40 + .../VignetteInfoDocumentation.lua | 157 + .../VisualAlertConstantsDocumentation.lua | 32 + .../VoiceChatDocumentation.lua | 1494 +++ .../WarCampaignDocumentation.lua | 218 + ...WarbandSceneInfoConstantsDocumentation.lua | 27 + .../WarbandSceneInfoDocumentation.lua | 156 + .../WeatherConstantsDocumentation.lua | 27 + .../WeatherScriptDocumentation.lua | 52 + .../WeeklyRewardsDocumentation.lua | 355 + .../WeeklyRewardsSharedDocumentation.lua | 12 + ...orldElapsedTimerConstantsDocumentation.lua | 25 + .../WorldLootObjectDocumentation.lua | 164 + .../WorldSafeLocsUIInternalDocumentation.lua | 45 + .../WorldStateInfoDocumentation.lua | 95 + .../WowCSConstantsDocumentation.lua | 100 + .../WowEntitlementInfoDocumentation.lua | 74 + .../WowSurveyConstantsDocumentation.lua | 46 + .../WowSurveyDocumentation.lua | 46 + .../WowTokenUIDocumentation.lua | 163 + .../XMLUtilDocumentation.lua | 83 + .../ZoneAbilityDocumentation.lua | 61 + .../ZoneScriptDocumentation.lua | 75 + docs/secrets.md | 202 + 5378 files changed, 1136719 insertions(+) create mode 100644 .continue/rules/wow.md create mode 100644 .continueignore create mode 100644 .wowluarc.json create mode 100644 NOTES.md create mode 100644 STATUS.md create mode 100644 SessionGoldTracker.lua create mode 100644 SessionGoldTracker.toc create mode 100644 SessionGoldTracker_Camelot.toc create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArenaTeamDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AutoCompleteDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BankDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FontDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingInspectModeUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InputDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LogDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NumericRuleFormatterSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/OsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PhotoSharingUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PortraitDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReturningPlayerUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/URLDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua create mode 100644 docs/annotations/Annotations/Core/Data/CVar.lua create mode 100644 docs/annotations/Annotations/Core/Data/Classic.lua create mode 100644 docs/annotations/Annotations/Core/Data/Enum.lua create mode 100644 docs/annotations/Annotations/Core/Data/Event.lua create mode 100644 docs/annotations/Annotations/Core/Data/Wiki.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_5.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_7.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_5.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_7.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_2_0.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ChatInfo.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_CurrencyScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_GuildScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ItemScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_PvpScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SoundScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_Specialization_Standard.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellBook.lua.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_UnitScript.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/AuraUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/BNet.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ItemUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ReportFrame.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/TransmogUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/UIParent.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Menu.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuTypes.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/ElementMenuDescriptionProxy.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuManagerProxy.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuProxy.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/RootMenuDescriptionProxy.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/SharedMenuDescriptionProxy.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_NamePlates/Blizzard_NamePlates.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ContinuableContainer.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Item.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ItemLocation.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/PlayerLocation.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Spell.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Backdrop.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CallbackRegistry.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Color.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/ColorUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CvarUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Dump.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/FormattingUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/GlobalCallbackRegistry.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Mixin.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TableUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TextureUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TimeUtil.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector2D.lua create mode 100644 docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector3D.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceAddon-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceBucket-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceComm-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfig-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigCmd-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigDialog-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigRegistry-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceConsole-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceDB-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceDBOptions-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceEvent-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/AceGUI-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-BlizOptionsGroup.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-DropDownGroup.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Frame.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-InlineGroup.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-ScrollFrame.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-SimpleGroup.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TabGroup.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TreeGroup.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Window.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Button.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-CheckBox.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-ColorPicker.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-DropDown.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-EditBox.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Heading.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Icon.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-InteractiveLabel.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Keybinding.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Label.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-MultiLineEditBox.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Slider.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceHook-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceLocale-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceSerializer-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceTab-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/Ace3/AceTimer-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/CallbackHandler-1.0/CallbackHandler-1.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/ChatThrottleLib/ChatThrottleLib.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-2.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-Pins-2.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibDBIcon-1.0/LibDBIcon-1.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibDataBroker-1.1/LibDataBroker-1.1.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibDeflate/LibDeflate.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibDialog-1.0/LibDialog-1.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibDualSpec-1.0/LibDualSpec-1.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibQTip-1.0/LibQTip-1.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibSharedMedia-3.0/LibSharedMedia-3.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibSink-2.0/LibSink-2.0.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibStub/LibStub.lua create mode 100644 docs/annotations/Annotations/Core/Libraries/LibTextDump-1.0/LibTextDump-1.0.lua create mode 100644 docs/annotations/Annotations/Core/Lua/basic.lua create mode 100644 docs/annotations/Annotations/Core/Lua/bit.lua create mode 100644 docs/annotations/Annotations/Core/Lua/compat.lua create mode 100644 docs/annotations/Annotations/Core/Lua/math.lua create mode 100644 docs/annotations/Annotations/Core/Lua/os.lua create mode 100644 docs/annotations/Annotations/Core/Lua/string.lua create mode 100644 docs/annotations/Annotations/Core/Lua/table.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/AbbreviateConfig.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/ColorCurveObject.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/CurveObject.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/CurveObjectBase.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/DurationObject.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/HousingCatalogSearcher.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/HousingFixturePointFrame.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/HousingLayoutPinFrame.lua create mode 100644 docs/annotations/Annotations/Core/ScriptObject/UnitHealPredictionCalculator.lua create mode 100644 docs/annotations/Annotations/Core/Type/BlizzardType.lua create mode 100644 docs/annotations/Annotations/Core/Type/EmoteToken.lua create mode 100644 docs/annotations/Annotations/Core/Type/FunctionContainer.lua create mode 100644 docs/annotations/Annotations/Core/Type/GlobalColors.lua create mode 100644 docs/annotations/Annotations/Core/Type/Mixin.lua create mode 100644 docs/annotations/Annotations/Core/Type/Namespace.lua create mode 100644 docs/annotations/Annotations/Core/Type/StringEnum.lua create mode 100644 docs/annotations/Annotations/Core/Type/Structure.lua create mode 100644 docs/annotations/Annotations/Core/Type/UnitToken.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/Alpha.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/Animation.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/AnimationGroup.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/ControlPoint.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/FlipBook.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/Path.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/Rotation.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/Scale.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/TextureCoordTranslation.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/Translation.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Animation/VertexColor.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/AnimatableObject.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/Blob.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/CharacterModelBase.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/FrameScriptObject.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/ModelSceneActorBase.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/Object.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/Region.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/ScriptRegion.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/ScriptRegionResizing.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/TabardModelBase.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Base/TextureBase.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Font/Font.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Font/FontString.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Button/Button.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Button/CheckButton.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/ColorSelect.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Cooldown.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/EditBox.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/FogOfWarFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Frame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/GameTooltip.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/MessageFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Minimap.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Model/CinematicModel.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Model/DressUpModel.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Model/Model.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Model/PlayerModel.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Model/TabardModel.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/ModelScene.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/ModelSceneActor.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/MovieFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ArchaeologyDigSiteFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/POIFrame/QuestPOIFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ScenarioPOIFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/ScrollFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/SimpleHTML.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/Slider.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/StatusBar.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Frame/UnitPositionFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Intrinsic/DropdownButton.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Intrinsic/EventFrame.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Texture/Line.lua create mode 100644 docs/annotations/Annotations/Core/Widget/Texture/Texture.lua create mode 100644 docs/annotations/Annotations/Core/Widget/UIType/Font.lua create mode 100644 docs/annotations/Annotations/Core/Widget/UIType/FrameType.lua create mode 100644 docs/annotations/Annotations/Core/Widget/UIType/ScriptType.lua create mode 100644 docs/annotations/Annotations/Core/Widget/UIType/Template.lua create mode 100644 docs/annotations/Annotations/Core/Widget/UIType/UIType.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/BaseAPIMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/EventsAPIMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FieldsAPIMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FunctionsAPIMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/SystemsAPIMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/TablesAPIMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AbbreviateConfigAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccessibilityOptionsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureJournalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArrowCalloutConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AsyncAssistActionsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseEnumsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagIndexConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BankDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlepayConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BlackMarketInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/Blizzard_APIDocumentationGenerated.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BrowserDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ButtonStateDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCreationConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterSelectionConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterServicesConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTrialDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSceneDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSettingsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverrideConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CompactUnitFramesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstants_MainlineDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorConstDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathAlertDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DuelInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DungeonEncounterConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstants_MainlineDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionLevelConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FontDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIArchaeologyDigsiteDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIBlobDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICharacterModelBaseDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICinematicModelDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICooldownDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIDressUpModelDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIFogOfWarFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorBaseDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPINamePlateDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIQuestPOIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIScenarioPOIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPISimpleCheckoutDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelBaseDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITooltipDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIUnitPositionFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_TYPEConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GMTicketInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadConstDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GroupFinderConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogSearcherAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingFixturePointFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutPinFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImageSharingConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_MainlineDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemQualitiesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemTextDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoadingScreenDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogicConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaColorCurveObjectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectBaseAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MatrixSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ModelAnimationSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MoneyConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativesConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/OsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PVPMgrConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattleConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetScalingConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingPinFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlatformDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDataConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerHousingConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PonyDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PowerTypeConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProceduralSpawnConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvPFactionConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstants_MainlineDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RenownConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RolodexConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenLocationConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptRegionSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptWarningsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretAspectConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicatesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretWrapperConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectNamePlateFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectUnitPositionFrameDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsEnumsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAlphaAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimFlipBookAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimGroupAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimPathAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimRotationAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleLineAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTextureCoordTranslationAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationLineAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimVertexColorAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimatableObjectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleBrowserAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleButtonAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleCheckboxAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleColorSelectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleControlPointAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleEditBoxAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontStringAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameScriptObjectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleLineAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMapSceneAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMaskTextureAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMessageFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelFFXAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMovieAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleObjectAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleOffScreenFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleRegionAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionResizingAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScrollFrameAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleSliderAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureBaseAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SkillInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoftTargetConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellIDDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalentAndGlyphConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalkingHeadDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TrainerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConfigDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransformManipulatorConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICharacterClassConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICovenantDisplayInfoConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFileAssetSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureAssetSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/URLDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiModelSceneConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiRpcRequestManagerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorAPIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSexConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ValidateNameConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VectorSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VehicleDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsSharedDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldElapsedTimerConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldStateInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowCSConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowEntitlementInfoDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyConstantsDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Blizzard_AccessibilityTemplates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Mainline/AccessibilityTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/QuestTextContrast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManagerGame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountSaveUI/Blizzard_AccountSaveUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Blizzard_AchievementUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Blizzard_ActionBar_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonUtilOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AssistedCombatManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBarOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBarOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ReputationBarOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingManagerOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExpBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MainActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PetActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PossessActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StanceBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/Blizzard_ActionBarController.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/Blizzard_ActionStatus.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Blizzard_AddOnList.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/AddOnPerformance.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/Blizzard_AddOnPerformance.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestOfferDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestOfferDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestOfferDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_ZoneSummaryDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_ZoneSummaryDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_ZoneSummaryDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMap.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMapInset.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMapInset.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMapInset.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/Blizzard_AdventureMapUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AlliedRacesUI/AlliedRacesModelControlButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AlliedRacesUI/Blizzard_AlliedRacesFrameUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AlliedRacesUI/Blizzard_AlliedRacesFrameUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AlliedRacesUI/Blizzard_AlliedRacesFrameUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AlliedRacesUI/Blizzard_AlliedRacesUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/AD_WorldQuestDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/AD_WorldQuestDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/AD_WorldQuestDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/AnimaDiversionDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/AnimaDiversionDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/AnimaDiversionDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/Blizzard_AnimaDiversionUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/Blizzard_AnimaDiversionUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/Blizzard_AnimaDiversionUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/Blizzard_AnimaDiversionUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AnimaDiversionUI/Blizzard_AnimaDiversionUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArchaeologyUI/Blizzard_ArchaeologyUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArchaeologyUI/Blizzard_ArchaeologyUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArchaeologyUI/Blizzard_ArchaeologyUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArchaeologyUI/Blizzard_ArchaeologyUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArchaeologyUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArdenwealdGardening/Blizzard_ArdenwealdGardening.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArdenwealdGardening/Blizzard_ArdenwealdGardening.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArdenwealdGardening/Blizzard_ArdenwealdGardening.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArdenwealdGardening/Blizzard_ArdenwealdGardening.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArrowCalloutFrame/Blizzard_ArrowCalloutFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactAppearances.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactAppearances.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactAppearances.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactPerks.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactPerks.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactPerks.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactPowerButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactPowerButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactPowerButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ArtifactUI/Blizzard_ArtifactUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AsyncRequest/Blizzard_AsyncRequest.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AsyncRequest/Blizzard_AsyncRequest.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Blizzard_AuctionHouseUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseAuctionsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseAuctionsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseCategoriesList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseCategoriesList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseCategoriesList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseItemList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseItemList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseMultisell.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseMultisell.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseSharedTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseSharedTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseSharedTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseTab.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseTab.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Mainline/Blizzard_AuctionHouseUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseAuctionsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseBrowseResultsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseBrowseResultsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseBrowseResultsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseBuyDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseBuyDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseBuyDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCategoriesList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesBuyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesBuyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesBuyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesSellFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesSellFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseCommoditiesSellFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemBuyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemBuyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemBuyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemSellFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemSellFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseItemSellFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseMultisell.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSearchBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSearchBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSearchBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSellFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSellFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSellFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSharedTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSharedTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseSharedTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseTab.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseTableBuilder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseTableBuilder.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseTableBuilder.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseWoWTokenFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseWoWTokenFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuctionHouseUI/Shared/Blizzard_AuctionHouseWoWTokenFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuthChallengeUI/Blizzard_AuthChallengeUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuthChallengeUI/Blizzard_AuthChallengeUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuthChallengeUI/Blizzard_AuthChallengeUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AuthChallengeUI/Blizzard_AuthChallengeUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoComplete/AutoComplete.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoComplete/AutoComplete.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoComplete/AutoComplete.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoComplete/Blizzard_AutoComplete.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoCompletePopupList/Blizzard_AutoCompletePopupList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoCompletePopupList/Blizzard_AutoCompletePopupList.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoCompletePopupList/Blizzard_AutoCompletePopupList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AutoCompletePopupList/Blizzard_AutoCompletePopupList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteEssenceUI/Blizzard_AzeriteEssenceUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteEssenceUI/Blizzard_AzeriteEssenceUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteEssenceUI/Blizzard_AzeriteEssenceUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteEssenceUI/Blizzard_AzeriteEssenceUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteRespecUI/Blizzard_AzeriteRespecUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteRespecUI/Blizzard_AzeriteRespecUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteRespecUI/Blizzard_AzeriteRespecUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteRespecUI/Blizzard_AzeriteRespecUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemChannelMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemChannelMixin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemChannelMixin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemPowerMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemPowerMixin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemPowerMixin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemSlotMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemSlotMixin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemSlotMixin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemTierMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemTierMixin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteEmpoweredItemTierMixin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeritePowerLayoutInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/AzeriteTierAnimationMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/Blizzard_AzeriteEmpoweredItemUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/Blizzard_AzeriteEmpoweredItemUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/Blizzard_AzeriteEmpoweredItemUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/Blizzard_AzeriteEmpoweredItemUITemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/Blizzard_AzeriteEmpoweredItemUITemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AzeriteUI/Blizzard_AzeriteUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BNet/BNet.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BNet/BNet.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BNet/Blizzard_BNet_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BNet/BnetShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BNet/Mainline/BNet.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BarbershopUI/Blizzard_BarberShopUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BarbershopUI/Mainline/Blizzard_BarberShopUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BarbershopUI/Mainline/Blizzard_BarberShopUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BarbershopUI/Mainline/Blizzard_BarberShopUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BattlefieldMap/Blizzard_BattlefieldMap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BattlefieldMap/Blizzard_BattlefieldMap.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BattlefieldMap/Blizzard_BattlefieldMap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BattlefieldMap/Blizzard_BattlefieldMap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BehavioralMessaging/Blizzard_BehavioralMessaging.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BehavioralMessaging/Blizzard_BehavioralMessaging.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BehavioralMessaging/Blizzard_BehavioralMessaging.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BehavioralMessaging/Blizzard_BehavioralMessaging.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BehavioralMessaging/Blizzard_Register.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BlackMarketUI/Blizzard_BlackMarketUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BlackMarketUI/Blizzard_BlackMarketUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BlackMarketUI/Blizzard_BlackMarketUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BlackMarketUI/Blizzard_BlackMarketUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BlackMarketUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_BoostTutorial.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_BoostTutorial.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_Tutorial.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialCalloutFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialCalloutFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialCalloutFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialKeyboardMouseFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialKeyboardMouseFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialKeyboardMouseFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialLogic.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialMainFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialMainFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialMainFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialPointerFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialPointerFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialPointerFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialQuestManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialRacialData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BoostTutorial/Blizzard_TutorialRangeManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/Blizzard_BuffFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/BuffFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/BuffFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/BuffFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/BuffFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/BuffFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/ExternalDefensivesFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/ExternalDefensivesFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_BuffFrame/ExternalDefensivesFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CUFProfiles/Blizzard_CUFProfiles.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CUFProfiles/Blizzard_CompactUnitFrameProfiles.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Blizzard_Calendar_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Mainline/Blizzard_Calendar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Mainline/Blizzard_Calendar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Mainline/Blizzard_Calendar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Mainline/Blizzard_CalendarTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Calendar/Mainline/Blizzard_CalendarTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Details.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Elements.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Elements.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Elements.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_ErrorLookup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Header.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Header.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Header.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Inbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Model.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Outbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_ProductCards.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_ProductCards.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_ProductCards.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Products.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/Blizzard_CatalogShop_Unsecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/DialogPopup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/DialogPopup.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShop/DialogPopup.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow_Elements.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow_Elements.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow_Elements.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow_Inbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopRefundFlow/Blizzard_CatalogShopRefundFlow_Outbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedTemplates/Blizzard_CatalogShopSharedTemplates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedTemplates/Blizzard_CatalogShop_SharedProductCards.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedTemplates/Blizzard_CatalogShop_SharedProductCards.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedTemplates/Blizzard_CatalogShop_SharedProductCards.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedUtil/Blizzard_CatalogShopSharedUtil.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedUtil/Blizzard_CatalogShop_Constants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopSharedUtil/Blizzard_CatalogShop_SharedUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow_Elements.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow_Elements.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow_Elements.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CatalogShopTopUpFlow/Blizzard_CatalogShopTopUpFlow_Inbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChallengesUI/Blizzard_ChallengesUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChallengesUI/Mainline/Blizzard_ChallengesUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChallengesUI/Mainline/Blizzard_ChallengesUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChallengesUI/Mainline/Blizzard_ChallengesUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChallengesUI/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/Blizzard_Channels.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelRoster.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelRoster.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/ChannelRoster.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/CreateChannelPopup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/CreateChannelPopup.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/CreateChannelPopup.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/RosterButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/RosterButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/RosterButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotification.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotification.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotification.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotificationParty.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotificationParty.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotificationRoster.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceActivityNotificationRoster.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceChatPrompt.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceChatPrompt.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceChatPrompt.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Channels/VoiceUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CharacterCreate/Blizzard_CharacterCreate.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CharacterCustomize/Blizzard_CharacterCustomize.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CharacterCustomize/Blizzard_CharacterCustomize.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CharacterCustomize/Blizzard_CharacterCustomize.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CharacterCustomize/Blizzard_CharacterCustomize.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CharacterSelectNavBar/Blizzard_CharacterSelectNavBar.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Blizzard_ChatFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/BattlegroundChatFilters.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/BattlegroundChatFilters.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/BattlegroundChatFilters.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/ChatConfigFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/ChatConfigFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/ChatConfigFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/FloatingChatFrameAlertFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/FloatingChatFrameAlertFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/FloatingChatFrameVoiceChat.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/FloatingChatFrameVoiceChat.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/TextToSpeechFrameConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/VoiceChatHeadsetButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/VoiceChatHeadsetButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Mainline/VoiceChatHeadsetButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/ClassTalentHelper.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeech.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeech.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeech.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeechCommands.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeechFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeechFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/TextToSpeechFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatDots.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatDots.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatDots.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatTranscriptionButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatTranscriptionButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatTranscriptionButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrame/Shared/VoiceChatTranscriptionFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Blizzard_ChatFrameBase_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChannelFrameButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatEmoteConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrameEditBox.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrameEditBox.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrameEditBoxOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrameMenuButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrameOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatFrameUtilOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/ChatTypeInfoConstantsOverride.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/FloatingChatFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/FloatingChatFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/FloatingChatFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Mainline/SlashCommandsOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/CastRandomManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/CastSequenceManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatAlertFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrameConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrameEditBox.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrameFilters.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrameFiltersSecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrameSetup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatFrameUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatTypeInfoColors.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/ChatTypeInfoConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/FloatingChatFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/HistoryKeeper.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/MacroExecutionManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/MessageFrameScrollButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/SlashCommands.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameBase/Shared/SlashCommandsRegistry.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameUtil/Blizzard_ChatFrameUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChatFrameUtil/Blizzard_ChatFrameUtil.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChromieTimeUI/Blizzard_ChromieTimeUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChromieTimeUI/Blizzard_ChromieTimeUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChromieTimeUI/Blizzard_ChromieTimeUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ChromieTimeUI/Blizzard_ChromieTimeUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassMenu/Blizzard_ClassMenu.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassMenu/Blizzard_ClassMenu.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrial/Blizzard_ClassTrial.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrial/Blizzard_ClassTrial.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrial/Blizzard_ClassTrial.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrial/Blizzard_ClassTrial.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrialSecure/Blizzard_ClassTrialOutbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrialSecure/Blizzard_ClassTrialSecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrialSecure/Blizzard_ClassTrialSecure.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrialSecure/Blizzard_ClassTrialSecure.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClassTrialSecure/Blizzard_ClassTrialSecure.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClickBindingUI/Blizzard_ClickBindingUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClickBindingUI/Blizzard_ClickBindingUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClickBindingUI/Blizzard_ClickBindingUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClickBindingUI/Blizzard_ClickBindingUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ClientSavedVariables/Blizzard_ClientSavedVariables.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CodeOfConduct/Blizzard_CodeOfConduct.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CodeOfConduct/Blizzard_CodeOfConduct.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Blizzard_Collections_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_CollectionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_CollectionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_CollectionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_Collections.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_Collections.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_Collections.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_HeirloomCollection.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_HeirloomCollection.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_HeirloomCollection.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_MountCollection.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_MountCollection.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_MountCollection.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_ToyBox.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_ToyBox.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_ToyBox.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_WarbandSceneCollection.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_WarbandSceneCollection.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_WarbandSceneCollection.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_Wardrobe.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_Wardrobe.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Mainline/Blizzard_Wardrobe.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Shared/Blizzard_PetCollection.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Shared/Blizzard_PetCollection.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Shared/Blizzard_PetCollection.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Shared/Blizzard_Wardrobe_Sets.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Shared/Blizzard_Wardrobe_Sets.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Collections/Shared/Blizzard_Wardrobe_Sets.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Colors/Blizzard_Colors_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Colors/Mainline/ColorConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Colors/Mainline/ColorManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Colors/Shared/ColorConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Colors/Shared/MaterialColors.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatAudioAlerts/Blizzard_CombatAudioAlertManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatAudioAlerts/Blizzard_CombatAudioAlertManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatAudioAlerts/Blizzard_CombatAudioAlertManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatAudioAlerts/Blizzard_CombatAudioAlerts.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLog/Blizzard_CombatLog_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLog/Mainline/Blizzard_CombatLog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLog/Mainline/Blizzard_CombatLog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLog/Mainline/Blizzard_CombatLog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogBase/Blizzard_CombatLogBase.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogBase/CombatLogUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogBase/Mainline/CombatLogColors.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogBase/Mainline/CombatLogConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogBase/Shared/CombatLogFilters.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogProcessor/Blizzard_CombatLogProcessor.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogProcessor/Blizzard_CombatLogProcessor.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogProcessor/Blizzard_CombatLogProcessorInbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatLogProcessor/Blizzard_CombatLogProcessorOutbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Blizzard_CombatText.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Mainline/CombatTextConstantsOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Mainline/CombatTextUtilOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Shared/CombatText.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Shared/CombatText.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Shared/CombatText.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Shared/CombatTextConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CombatText/Shared/CombatTextUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommandLineUtil/Blizzard_CommandLineUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommandLineUtil/Blizzard_CommandLineUtil.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_Commentator.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_Commentator.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_Commentator.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_Commentator.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorModelScene.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorModelScene.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorModelScene.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorNamePlate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorNamePlate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorNamePlate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorScoreboard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorScoreboard.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorScoreboard.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorSpell.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorSpell.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorSpell.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorSpellTray.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorSpellTray.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorSpellTray.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorUnitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorUnitFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorUnitFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/Blizzard_CommentatorUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/CommentatorVictoryFanfare.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/CommentatorVictoryFanfare.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/CommentatorVictoryFanfare.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/FadeToBlack.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/FadeToBlack.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Commentator/FadeToBlack.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/Blizzard_Communities_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/ClubFinder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/ClubFinder.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/ClubFinder.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/ClubFinderApplicantList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/ClubFinderApplicantList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/ClubFinderApplicantList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesAddDialogInsecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesAddDialogInsecure.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesAddDialogInsecure.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesAvatarPickerDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesAvatarPickerDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesAvatarPickerDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesCalendar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesCalendar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesCalendar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesChatFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesChatFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesChatFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesErrors.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesGuildFinderFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesGuildFinderFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesGuildFinderFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesHyperlink.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesInvitationFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesInvitationFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesInvitationFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesLanguage.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesLanguage.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesLanguage.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesMemberList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesMemberList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesMemberList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesSettings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesSettings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesSettings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesStreams.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesStreams.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesStreams.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesTabs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesTabs.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesTabs.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesTicketManagerDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesTicketManagerDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/CommunitiesTicketManagerDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildInfo.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildInfo.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildNameChange.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildNameChange.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildNews.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildNews.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildNews.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildPerks.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildPerks.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildPerks.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildRewards.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildRewards.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildRewards.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildRoster.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildRoster.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/GuildRoster.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Communities/Mainline/GuildInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommunitiesSecure/Blizzard_CommunitiesSecure.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommunitiesSecure/CommunitiesAddDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommunitiesSecure/CommunitiesAddDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommunitiesSecure/CommunitiesAddDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CommunitiesSecure/CommunitiesAddDialogOutbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Blizzard_CompactRaidFrameContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Blizzard_CompactRaidFrameContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Blizzard_CompactRaidFrameContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Blizzard_CompactRaidFrameReservationManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Blizzard_CompactRaidFrames.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Mainline/Blizzard_CompactRaidFrameManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Mainline/Blizzard_CompactRaidFrameManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CompactRaidFrames/Mainline/Blizzard_CompactRaidFrameManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console_AutoComplete.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console_AutoComplete.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Console/Blizzard_Console_AutoComplete.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ContentTracking/Blizzard_ContentTracking.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ContentTracking/ContentTrackingElement.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ContentTracking/ContentTrackingElement.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ContentTracking/ContentTrackingElement.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ContentTracking/ContentTrackingManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Contribution/Blizzard_Contribution.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Contribution/Blizzard_Contribution.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Contribution/Blizzard_Contribution.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Contribution/Blizzard_Contribution.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/Blizzard_CooldownViewer.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerAlert.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerItemData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsAlerts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsAlerts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsAlerts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsDataStoreSerialization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsDialogs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsDialogs.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsDialogs.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSettingsLayoutManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerSoundAlertData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlert.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertTarget.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertsManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertsManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/CooldownViewerVisualAlertsManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/PandemicAlertAnimation.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CooldownViewer/PandemicAlertAnimation.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantCallings/Blizzard_CovenantCallings.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantCallings/CovenantCallings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantCallings/CovenantCallings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantCallings/CovenantCallings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantPreviewUI/Blizzard_CovenantPreviewUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantPreviewUI/Blizzard_CovenantPreviewUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantPreviewUI/Blizzard_CovenantPreviewUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantPreviewUI/Blizzard_CovenantPreviewUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantRenown/Blizzard_CovenantRenown.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantRenown/Blizzard_CovenantRenown.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantRenown/Blizzard_CovenantRenown.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantRenown/Blizzard_CovenantRenown.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctum.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctum.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctum.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctum.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctumUpgrades.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctumUpgrades.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantSanctum/Blizzard_CovenantSanctumUpgrades.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantChoiceToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantChoiceToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantChoiceToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantRenownToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantRenownToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantRenownToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantToasts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantToasts.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantToasts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CovenantToasts/Blizzard_CovenantToasts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationAudioInterface.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationAudioInterface.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationAudioInterface.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationOptionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationOptionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationOptionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_CustomizationUI/Blizzard_CustomizationUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/Blizzard_DamageMeter.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeter.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeter.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterEntry.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterEntry.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterEntry.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSessionWindow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSessionWindow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSessionWindow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSettingsDropdownButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSettingsDropdownButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSettingsDropdownButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSourceWindow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSourceWindow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DamageMeter/DamageMeterSourceWindow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeathRecap/Blizzard_DeathRecap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeathRecap/Blizzard_DeathRecap.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeathRecap/Blizzard_DeathRecap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeathRecap/Blizzard_DeathRecap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeathRecap/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_DebugTools.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_DebugTools.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_DebugTools.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_DebugTools.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspector.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspector.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspector.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorAnchorDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorAnchorDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorAnchorDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorAttributeDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorAttributeDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorAttributeDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TableInspectorDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TexelSnappingVisualizer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Blizzard_TextureInfoGenerator.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/DebugObjectUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DebugTools/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeclensionFrame/Blizzard_DeclensionFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeclensionFrame/Mainline/DeclensionFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeclensionFrame/Mainline/DeclensionFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeclensionFrame/Mainline/DeclensionFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeclensionFrameGlue/Blizzard_DeclensionFrameGlue_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionAbilityList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionAbilityList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionAbilityList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionConfiguration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionConfiguration.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionConfiguration.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesCompanionConfiguration/Blizzard_DelvesCompanionConfiguration.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesDifficultyPicker/Blizzard_DelvesDifficultyPicker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesDifficultyPicker/Blizzard_DelvesDifficultyPicker.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesDifficultyPicker/Blizzard_DelvesDifficultyPicker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesDifficultyPicker/Blizzard_DelvesDifficultyPicker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesToast/Blizzard_DelvesToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesToast/Blizzard_DelvesToast.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesToast/Blizzard_DelvesToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DelvesToast/Blizzard_DelvesToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Deprecated/11_0_0_SpellBookAPITransitionGuide.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Deprecated/Blizzard_Deprecated.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedActionBar/Blizzard_DeprecatedActionBar.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedActionBar/Deprecated_ActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedBattleNet/Blizzard_DeprecatedBattleNet.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedBattleNet/Deprecated_BattleNet.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedChatInfo/Blizzard_DeprecatedChatInfo.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedChatInfo/Deprecated_ChatFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedChatInfo/Deprecated_ChatInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedCombatLog/Blizzard_DeprecatedCombatLog.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedCombatLog/Deprecated_CombatLog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedCurrencyScript/Blizzard_DeprecatedCurrencyScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedCurrencyScript/Deprecated_CurrencyScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedGlue/Blizzard_DeprecatedGlue.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedGlue/Deprecated_Glue.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedGuildScript/Blizzard_DeprecatedGuildScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedGuildScript/Deprecated_GuildScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedInstanceEncounter/Blizzard_DeprecatedInstanceEncounter.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedInstanceEncounter/Deprecated_InstanceEncounter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedItemScript/Blizzard_DeprecatedItemScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedItemScript/Deprecated_ItemScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedItemSocketInfo/Blizzard_DeprecatedItemSocketInfo.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedItemSocketInfo/Deprecated_ItemSocketInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedLFG/Blizzard_DeprecatedLFG.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedLFG/Deprecated_LFG.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedPetInfo/Blizzard_DeprecatedPetInfo.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedPetInfo/Deprecated_PetInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedPvpScript/Blizzard_DeprecatedPvpScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedPvpScript/Deprecated_PvpScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSoundScript/Blizzard_DeprecatedSoundScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSoundScript/Deprecated_SoundScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSpecialization/Blizzard_DeprecatedSpecialization.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSpellBook/Blizzard_DeprecatedSpellBook.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSpellBook/Deprecated_SpellBook.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSpellScript/Blizzard_DeprecatedSpellScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedSpellScript/Deprecated_SpellScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedTradeInfo/Blizzard_DeprecatedTradeInfo.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedTradeInfo/Deprecated_TradeInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedUnitScript/Blizzard_DeprecatedUnitScript.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedUnitScript/Deprecated_UnitScript.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedWorldElapsedTimerTypes/Blizzard_DeprecatedWorldElapsedTimerTypes.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DeprecatedWorldElapsedTimerTypes/Deprecated_WorldElapsedTimerTypes.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Deprecated_ArenaUI/Blizzard_Deprecated_ArenaUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Deprecated_ArenaUI/Deprecated_ArenaUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Deprecated_ArenaUI/Deprecated_ArenaUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Deprecated_ArenaUI/Deprecated_ArenaUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Dispatcher/Blizzard_Dispatcher.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Dispatcher/Blizzard_Dispatcher.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DurabilityFrame/Blizzard_DurabilityFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DurabilityFrame/DurabilityFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DurabilityFrame/DurabilityFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_DurabilityFrame/DurabilityFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Blizzard_EditMode.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Mainline/EditModeManagerOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Mainline/EditModePresetLayouts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeAuraDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeDialogs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeDialogs.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeDialogs.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeLayoutManagerUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeManagerOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModePresetLayoutSystemUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModePresetLayoutsManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeSettingDisplayInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeSystemTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeSystemTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeSystemTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EditMode/Shared/EditModeUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Blizzard_EncounterJournal_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_EncounterJournal.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_EncounterJournal.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_EncounterJournal.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_Journeys.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_Journeys.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_Journeys.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_LootJournal.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_LootJournal.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_LootJournal.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_LootJournalItems.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_LootJournalItems.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_LootJournalItems.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_MonthlyActivities.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_MonthlyActivities.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterJournal/Mainline/Blizzard_MonthlyActivities.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/Blizzard_EncounterTimeline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimeline.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimeline.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimeline.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineEventFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineEventFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineEventFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineFrameManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineScriptedAnimationUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineSettings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTimerEvent.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTimerEvent.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTimerEvent.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTimerView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTimerView.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTimerView.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackEvent.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackEvent.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackEvent.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackLayout.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackView.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineTrackView.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterTimeline/EncounterTimelineView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/Blizzard_EncounterWarnings.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarnings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarnings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarnings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsSettings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsView.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsView.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsViewElements.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsViewElements.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EncounterWarnings/EncounterWarningsViewElements.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EndOfMatchUI/Blizzard_EndOfMatchUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EnvironmentCleanup/Blizzard_EnvironmentCleanup_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EnvironmentCleanup/EnvironmentCleanup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EventTrace/Blizzard_EventTrace.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EventTrace/Blizzard_EventTrace.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EventTrace/Blizzard_EventTrace.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_EventTrace/Blizzard_EventTrace.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ExpansionTrial/Blizzard_ExpansionTrial.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ExpansionTrial/Blizzard_ExpansionTrial.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ExpansionTrial/Blizzard_ExpansionTrial.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ExpansionTrial/Blizzard_ExpansionTrial.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/Blizzard_FlightMap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/Blizzard_FlightMap.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/Blizzard_FlightMap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/Blizzard_FlightMap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_AreaPOIDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_AreaPOIDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_AreaPOIDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_FlightPathDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_FlightPathDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_FlightPathDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_QuestDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_QuestDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_QuestDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_VignetteDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_VignetteDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_VignetteDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_WorldQuestDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_WorldQuestDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_WorldQuestDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_ZoneSummaryDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_ZoneSummaryDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FlightMap/FM_ZoneSummaryDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Flyout/Blizzard_Flyout.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Flyout/Flyout.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Flyout/Flyout.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Flyout/Flyout.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Blizzard_Fonts_Shared.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/FontStyles.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/FontStyles.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/Fonts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/Fonts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/GameFontStyles.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/GameFontStyles.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/GameFonts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Mainline/GameFonts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/FontStyles.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/FontStyles.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/Fonts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/Fonts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/Blizzard_FrameEffects.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/EffectFactory.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/PowerSwirl.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/PowerSwirl.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameStack/Blizzard_FrameStack.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameStack/FrameStack.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AchievementDisplayFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AchievementDisplayFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AchievementDisplayFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ArchaeologyProgressBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ArchaeologyProgressBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ArchaeologyProgressBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ArtifactToasts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ArtifactToasts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ArtifactToasts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteAnimationTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteAnimationTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteEmpoweredItemDataSource.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteIslandsToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteIslandsToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteIslandsToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteItemToasts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteItemToasts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/AzeriteItemToasts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/BattlePetTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/BattlePetTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/BattlePetTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Blizzard_FrameXML_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/BossBannerToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/BossBannerToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/BossBannerToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/CustomBindingHandler.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/CustomBindingManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/CustomizationDebugFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/CustomizationDebugFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/CustomizationDebugFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/DeprecatedTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/DeprecatedTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/DeprecatedTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/DestinyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/DestinyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/DestinyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EquipmentFlyout.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EquipmentFlyout.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EquipmentFlyout.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EquipmentManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EventToastManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EventToastManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/EventToastManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/FloatingPetBattleTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/FloatingPetBattleTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/FloatingPetBattleTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GhostFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GhostFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GhostFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GuildInviteFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GuildInviteFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GuildInviteFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/GuildUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/IconIntroAnimation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/IconIntroAnimation.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/IconIntroAnimation.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/InstanceDifficulty.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/InstanceDifficulty.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/InstanceDifficulty.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ItemDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ItemDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/ItemDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/LossOfControlFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/LossOfControlFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/LossOfControlFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/AlertFrameSystems.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/AlertFrameSystems.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/AlertFrameSystems.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/AlertFrames.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/AlertFrames.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/AlertFrames.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/CoinPickupFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/CoinPickupFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/CoinPickupFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ColorPickerFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ColorPickerFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ColorPickerFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/CombatFeedback.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/InstanceAbandon.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/InstanceAbandon.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/InstanceAbandon.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/LootHistory.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/LootHistory.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/LootHistory.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/LowHealthFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/LowHealthFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/NavigationBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/NavigationBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/NavigationBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/RaidWarning.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/RaidWarning.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/RatingMenuFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/RatingMenuFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ReadyCheck.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ReadyCheck.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ReadyCheck.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/StackSplitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/StackSplitFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/StackSplitFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/StreamingFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/StreamingFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/StreamingFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/TutorialFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/TutorialFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/TutorialFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ZoneText.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ZoneText.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Mainline/ZoneText.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/MotionSickness.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/MotionSickness.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/MotionSickness.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/MovieFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/MovieFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/MovieFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/PVPHonorSystem.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/PVPHonorSystem.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/PVPHonorSystem.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/PVPUITemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/PVPUITemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/PVPUITemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/QuestNPCModelFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/QuestSession.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/QuestSession.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/QuestSession.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/RewardTrackTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/RewardTrackTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/RewardTrackTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/RolePoll.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/RolePoll.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/RolePoll.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SecureTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SecureTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SecureTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SecureTemplatesBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SecureTemplatesBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Shared/CinematicFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Shared/CinematicFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Shared/CinematicFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Shared/EquipmentManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Shared/LowHealthFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SharedPetBattleTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SharedPetBattleTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SharedPetBattleTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SpellActivationOverlay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SpellActivationOverlay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SpellActivationOverlay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SplashFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SplashFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/SplashFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TabardModelFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TalentFrameBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TalentFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TalentFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TalkingHeadUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TalkingHeadUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TalkingHeadUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Timer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Timer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/Timer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/TopBannerManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/UIErrorsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/UIErrorsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/UIErrorsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/WardrobeCustomSets.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/WardrobeCustomSets.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXML/WardrobeCustomSets.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/AnimatedStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/AnimatedStatusBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/AnimatedStatusBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/Blizzard_FrameXMLBase_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/Constants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/FlowContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/GradualAnimatedStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/GradualAnimatedStatusBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/GradualAnimatedStatusBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/Mainline/FrameLocks.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/Mainline/IconDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/PlayerMovementFrameFader.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/PowerDependencyLine.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/PowerDependencyLine.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/PowerDependencyLine.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLBase/Shared/Constants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AchievementUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AdventureGuideUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AnimationSystem.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AreaPoiUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/ArenaUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AuraUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AzeriteEssenceUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/AzeriteUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Blizzard_FrameXMLUtil_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/CalendarUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/CampaignUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/CollectionsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/CommunitiesUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Cooldown.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/CurrencyContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/CurrencyUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/DifficultyUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/DragonridingUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/FadingFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/ItemUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/AuraUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/Blizzard_QuestSuperTracking.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/Cooldown.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/Cooldown.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/ExpansionUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/MapUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/MinimapUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/PlayerSpellsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/QuestUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/RAFUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/RaidWarning.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/ReputationUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/Mainline/TraitUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/PVPUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/PartyUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/ProfessionsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/RenownRewardUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/RuneforgeUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/RuneforgeUtil.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/RuneforgeUtil.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameXMLUtil/TitleUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FramerateFrame/Blizzard_FramerateFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FramerateFrame/FramerateFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FramerateFrame/FramerateFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FramerateFrame/FramerateFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FriendsFrame/Blizzard_FriendsFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FriendsFrame/Mainline/FriendsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FriendsFrame/Mainline/FriendsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FriendsFrame/Mainline/FriendsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FriendsFrame/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GMChatUI/Blizzard_GMChatUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GMChatUI/Blizzard_GMChatUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GMChatUI/Blizzard_GMChatUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GMChatUI/Blizzard_GMChatUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GMChatUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameMenu/Blizzard_GameMenu_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameMenu/Shared/GameMenuFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameMenu/Shared/GameMenuFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameMenu/Shared/GameMenuFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameMenu/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameModeSelect/Blizzard_GameModeSelect_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameTooltip/Blizzard_GameTooltip_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameTooltip/HealthBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameTooltip/Mainline/GameTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameTooltip/Mainline/GameTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GameTooltip/Mainline/GameTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/AdventuresFollowerTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/AdventuresFollowerTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/AdventuresFollowerTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/Blizzard_GarrisonBase.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/FloatingGarrisonFollowerTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/FloatingGarrisonFollowerTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/FloatingGarrisonFollowerTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/GarrisonBaseUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/GarrisonBaseUtils.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/GarrisonBaseUtils.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/GarrisonFollowerTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/GarrisonFollowerTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonBase/GarrisonFollowerTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_CovenantMissionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_CovenantMissionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_CovenantMissionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonMissionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonMissionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonMissionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonSharedTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonSharedTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonSharedTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Blizzard_GarrisonTemplates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonTemplates/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Blizzard_GarrisonUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresBoard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresBoard.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresBoard.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresCombatLog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresCombatLog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresCombatLog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresCompleteScreen.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresCompleteScreen.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresCompleteScreen.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresPuck.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresPuck.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresPuck.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresRewardsScreen.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresRewardsScreen.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_AdventuresRewardsScreen.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_BFAMissionUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_BFAMissionUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_BFAMissionUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_CovenantMissionUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_CovenantMissionUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_CovenantMissionUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonBuildingUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonBuildingUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonBuildingUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonCapacitiveDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonCapacitiveDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonCapacitiveDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonLandingPage.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonLandingPage.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonLandingPage.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonMissionUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonMissionUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonMissionUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonMonumentUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonMonumentUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonMonumentUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonRecruiterUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonRecruiterUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonRecruiterUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonShipyardUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonShipyardUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_GarrisonShipyardUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_OrderHallMissionUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_OrderHallMissionUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Blizzard_OrderHallMissionUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GarrisonUI/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericShoppingCart/Blizzard_GenericShoppingCart.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericShoppingCart/Blizzard_GenericShoppingCartDataManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericShoppingCart/Blizzard_GenericShoppingCartServicesBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericShoppingCart/Blizzard_GenericShoppingCartTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericShoppingCart/Blizzard_GenericShoppingCartTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericShoppingCart/Blizzard_GenericShoppingCartTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericTraitUI/Blizzard_GenericTraitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericTraitUI/Blizzard_GenericTraitFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericTraitUI/Blizzard_GenericTraitFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericTraitUI/Blizzard_GenericTraitUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GenericTraitUI/Blizzard_GenericTraitUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlobalFXModelScenes/Blizzard_GlobalFXModelScenes.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlobalFXModelScenes/GlobalFXModelScenes.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlobalFXModelScenes/GlobalFXModelScenes.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueCollections/Blizzard_GlueCollections.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueMenuFrame/Blizzard_GlueMenuFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueParent/Blizzard_GlueParent_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueSavedVariables/Blizzard_GlueSavedVariables.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueStubs/Blizzard_GlueStubs.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueXML/Blizzard_GlueXML_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GlueXMLBase/Blizzard_GlueXMLBase_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Blizzard_GroupFinder_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFDFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFDFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFDFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFGFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFGFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFGList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFGList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/LFGList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PVEFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PVEFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PVEFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PVPHelper.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PVPHelper.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PVPHelper.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PvpPopup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PvpPopup.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/PvpPopup.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/QueueUpdater.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Mainline/ScenarioFinder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/LFGFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/LFGReadyCheck.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/LFGReadyCheck.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/LFGReadyCheck.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/RaidFinder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/RaidFinder.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/RaidFinder.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/ScenarioFinder.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/ScenarioFinder.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GroupFinder/Shared/ScenarioFinder_Shared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildBankUI/Blizzard_GuildBankUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildBankUI/Blizzard_GuildBankUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildBankUI/Blizzard_GuildBankUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildBankUI/Blizzard_GuildBankUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildBankUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildControlUI/Blizzard_GuildControlUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildControlUI/Blizzard_GuildControlUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildControlUI/Blizzard_GuildControlUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildControlUI/Blizzard_GuildControlUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildControlUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildRename/Blizzard_GuildRename.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildRename/Blizzard_GuildRename.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildRename/Blizzard_GuildRename.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_GuildRename/Blizzard_GuildRename.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HUDInventoryTemplates/Blizzard_HUDInventoryTemplates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpFrame/Blizzard_HelpFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpFrame/HelpFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpFrame/HelpFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpFrame/HelpFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpPlate/Blizzard_HelpPlate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpPlate/Blizzard_HelpPlate.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpPlate/Blizzard_HelpPlate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HelpPlate/Blizzard_HelpPlate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditor.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditor.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditor.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditor.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorBasicDecorMode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorBasicDecorMode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorBasicDecorMode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCleanupMode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCleanupMode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCleanupMode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizationDyeTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizationDyeTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizationDyeTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizationRoomTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizationRoomTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizationRoomTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizeMode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizeMode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorCustomizeMode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExpertDecorMode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExpertDecorMode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExpertDecorMode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorCustomizationMode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorCustomizationMode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorCustomizationMode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorFixturePoint.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorFixturePoint.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorFixturePoint.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorOptionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorOptionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorExteriorOptionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorLayoutMode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorLayoutMode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorLayoutMode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorLayoutModePin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorLayoutModePin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorLayoutModePin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorModeButtons.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorModeButtons.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorModeButtons.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorPlacedDecorList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorPlacedDecorList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorPlacedDecorList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorStorageFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorStorageFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorStorageFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseEditor/Blizzard_HouseEditorTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseList/Blizzard_HouseList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseList/Blizzard_HouseList.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseList/Blizzard_HouseList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseList/Blizzard_HouseList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HouseList/Blizzard_HouseListRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingBulletinBoard/Blizzard_HousingBulletinBoard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingBulletinBoard/Blizzard_HousingBulletinBoard.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingBulletinBoard/Blizzard_HousingBulletinBoard.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingBulletinBoard/Blizzard_HousingBulletinBoard.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingBulletinBoard/Blizzard_HousingBulletinBoardRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCharter/Blizzard_HousingCharter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCharter/Blizzard_HousingCharter.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCharter/Blizzard_HousingCharter.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCharter/Blizzard_HousingCharter.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCharter/Blizzard_HousingCharterRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControlButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControlButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControlButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControls.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControls.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControls.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControls.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingControls/Blizzard_HousingControlsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCornerstone/Blizzard_HousingCornerstone.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCornerstone/Blizzard_HousingCornerstone.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCornerstone/Blizzard_HousingCornerstone.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCornerstone/Blizzard_HousingCornerstone.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCornerstone/Blizzard_HousingCornerstoneRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCreateNeighborhood/Blizzard_HousingCreateNeighborhood.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCreateNeighborhood/Blizzard_HousingCreateNeighborhood.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCreateNeighborhood/Blizzard_HousingCreateNeighborhood.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCreateNeighborhood/Blizzard_HousingCreateNeighborhood.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingCreateNeighborhood/Blizzard_HousingCreateNeighborhoodRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboard.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboard.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboard.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardCatalog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardCatalog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardCatalog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardHouseInfoContent.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardHouseInfoContent.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardHouseInfoContent.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardHouseUpgrade.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardHouseUpgrade.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardHouseUpgrade.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingDashboard/Blizzard_HousingDashboardRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingEventHandler/Blizzard_HousingEventHandler.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingEventHandler/Blizzard_HousingEventHandler.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/Blizzard_HousingHouseFinder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/Blizzard_HousingHouseFinder.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/Blizzard_HousingHouseFinder.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/Blizzard_HousingHouseFinder.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/Blizzard_HousingHouseFinderRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/HouseFinderMapDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/HouseFinderMapDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseFinder/HouseFinderMapDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseSettings/Blizzard_HousingHouseSettings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseSettings/Blizzard_HousingHouseSettings.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseSettings/Blizzard_HousingHouseSettings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseSettings/Blizzard_HousingHouseSettings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingHouseSettings/Blizzard_HousingHouseSettingsRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCart.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartItemTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartItemTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartItemTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartServices.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingMarketCart/Blizzard_HousingMarketCartTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingModelPreview/Blizzard_HousingModelPreview.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingModelPreview/Blizzard_HousingModelPreview.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingModelPreview/Blizzard_HousingModelPreview.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingModelPreview/Blizzard_HousingModelPreview.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingModelPreview/Blizzard_HousingModelPreviewFrameRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharing.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharing.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharing.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharing.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharingBrowser.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharingBrowser.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingPhotoSharing/Blizzard_HousingPhotoSharingBrowser.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingActionButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingActionButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingActionButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogBundleDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogBundleDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogBundleDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogCategories.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogCategories.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogCategories.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogEntry.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogEntry.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogEntry.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogFilters.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogFilters.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogFilters.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingCatalogUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingTemplates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingTopBanner.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingTopBanner.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTemplates/Blizzard_HousingTopBanner.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorials.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorialsData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorialsDecor.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorialsHouseFinder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorialsInit.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorialsMisc.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HousingTutorials/Blizzard_HousingTutorialsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HybridMinimap/Blizzard_HybridMinimap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HybridMinimap/Blizzard_HybridMinimap.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HybridMinimap/Blizzard_HybridMinimap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_HybridMinimap/Blizzard_HybridMinimap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IME/Blizzard_IME.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IME/IME.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IME/IME.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/Blizzard_InspectUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/Blizzard_InspectUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/Blizzard_InspectUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/Blizzard_InspectUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectGuildFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectGuildFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectGuildFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectPVPFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectPVPFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectPVPFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectPaperDollFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectPaperDollFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/InspectPaperDollFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_InspectUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsPartyPoseUI/Blizzard_IslandsPartyPoseUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsPartyPoseUI/Blizzard_IslandsPartyPoseUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsPartyPoseUI/Blizzard_IslandsPartyPoseUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsPartyPoseUI/Blizzard_IslandsPartyPoseUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsQueueUI/Blizzard_IslandsQueueUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsQueueUI/Blizzard_IslandsQueueUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsQueueUI/Blizzard_IslandsQueueUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_IslandsQueueUI/Blizzard_IslandsQueueUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemBeltFrame/Blizzard_ItemBeltFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemButton/Blizzard_ItemButton_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemButton/Mainline/ItemButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemButton/Mainline/ItemButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemButton/Shared/ItemButtonTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemButton/Shared/ItemButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemButton/Shared/ItemButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemInteractionUI/Blizzard_ItemInteractionUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemInteractionUI/Blizzard_ItemInteractionUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemInteractionUI/Blizzard_ItemInteractionUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemInteractionUI/Blizzard_ItemInteractionUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemSocketingUI/Blizzard_ItemSocketingUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemSocketingUI/Blizzard_ItemSocketingUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemSocketingUI/Blizzard_ItemSocketingUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemSocketingUI/Blizzard_ItemSocketingUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemSocketingUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemUpgradeUI/Blizzard_ItemUpgradeUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemUpgradeUI/Mainline/Blizzard_ItemUpgradeUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemUpgradeUI/Mainline/Blizzard_ItemUpgradeUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ItemUpgradeUI/Mainline/Blizzard_ItemUpgradeUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Blizzard_Kiosk.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Housing/Config.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Housing/Game.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Housing/Game.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Housing/Game.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Kiosk.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Kiosk.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Kiosk/Kiosk.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingRenownButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingRenownButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingRenownButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbindButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbindButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbindButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbindPanel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbindPanel.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbindPanel.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LandingSoulbinds/Blizzard_LandingSoulbinds.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LoadLocale/Blizzard_LoadLocale.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LoadLocale/LoadLocale.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_LoginWarningDialogs/Blizzard_LoginWarningDialogs.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroDefine.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroIconSelector.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroIconSelector.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroIconSelector.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroScrollFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroScrollFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Blizzard_MacroUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MacroUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MailFrame/Blizzard_MailFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MailFrame/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MailFrame/MailFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MailFrame/MailFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MailFrame/MailFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MainMenuBarBagButtons/Blizzard_MainMenuBarBagButtons_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MainMenuBarBagButtons/Mainline/MainMenuBarBagButtons.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MainMenuBarBagButtons/Mainline/MainMenuBarBagButtons.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MainMenuBarBagButtons/Mainline/MainMenuBarBagButtons.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MainMenuBarBagButtons/Shared/BagsBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MainMenuBarBagButtons/Shared/MainMenuBarBagManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionRenownToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionRenownToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionRenownToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionToasts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionToasts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionToasts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionUnlockToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionUnlockToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionUnlockToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactions.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionsLandingTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionsLandingTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Blizzard_MajorFactionsLandingTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MajorFactions/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/Blizzard_MapCanvas.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/Blizzard_MapCanvas.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/Blizzard_MapCanvas.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/Blizzard_MapCanvas.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/Blizzard_MapCanvasDetailLayer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/MapCanvas_DataProviderBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/MapCanvas_PinFrameLevelsManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvas/MapCanvas_ScrollContainerMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvasSecureUtil/Blizzard_MapCanvasSecureUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MapCanvasSecureUtil/Blizzard_MapCanvasSecureUtil.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchCelebrationPartyPoseUI/Blizzard_MatchCelebrationPartyPoseUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchCelebrationPartyPoseUI/Blizzard_MatchCelebrationPartyPoseUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchCelebrationPartyPoseUI/Blizzard_MatchCelebrationPartyPoseUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchCelebrationPartyPoseUI/Blizzard_MatchCelebrationPartyPoseUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchmakingQueueDisplay/Blizzard_MatchmakingQueueDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchmakingQueueDisplay/Blizzard_MatchmakingQueueDisplay.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchmakingQueueDisplay/Blizzard_MatchmakingQueueDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MatchmakingQueueDisplay/Blizzard_MatchmakingQueueDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MawBuffs/Blizzard_MawBuffs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MawBuffs/Blizzard_MawBuffs.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MawBuffs/Blizzard_MawBuffs.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MawBuffs/Blizzard_MawBuffs.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Blizzard_Menu.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Compositor.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/DropdownButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/DropdownButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/DropdownButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Mainline/MenuConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Mainline/MenuTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Mainline/MenuTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Mainline/MenuTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Mainline/MenuVariants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Menu.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Menu.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/Menu.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/MenuConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/MenuTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/MenuTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/MenuTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/MenuUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Menu/MenuVariants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Blizzard_MicroMenu_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Mainline/MainMenuBarMicroButtons.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Mainline/MainMenuBarMicroButtons.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Mainline/MainMenuBarMicroButtons.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Mainline/MicroMenuContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Mainline/MicroMenuContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Mainline/MicroMenuContainerOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Shared/MicroMenuContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MicroMenu/Shared/MicroMenuUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Blizzard_Minimap_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/AddonCompartment.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/AddonCompartment.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/AddonCompartment.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/GameTime.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/GameTime.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/GameTime.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/Minimap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/Minimap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Minimap/Mainline/Minimap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MirrorTimer/Blizzard_MirrorTimer.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MirrorTimer/MirrorTimer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MirrorTimer/MirrorTimer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MirrorTimer/MirrorTimer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Blizzard_MoneyFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/MoneyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/MoneyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/MoneyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/MoneyInputFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/MoneyInputFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Mainline/MoneyInputFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Shared/MoneyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Shared/MoneyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Shared/MoneyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Shared/MoneyInputFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Shared/MoneyInputFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyFrame/Shared/MoneyInputFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyReceipt/Blizzard_MoneyReceipt.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MoneyReceipt/Blizzard_MoneyReceipt.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MovePad/Blizzard_MovePad.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MovePad/Blizzard_MovePad.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MovePad/Blizzard_MovePad.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_MovePad/Blizzard_MovePad.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateAlternatePowerBarBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateAlternatePowerBarBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateAlternatePowerBarBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_DeathKnight.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_DeathKnight.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_DeathKnight.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Dracthyr.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Dracthyr.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Dracthyr.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Druid.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Druid.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Druid.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Mage.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Mage.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Mage.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Monk.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Monk.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Monk.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Paladin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Paladin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Paladin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Rogue.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Rogue.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Rogue.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Warlock.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Warlock.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_ClassNameplateBar_Warlock.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateAuras.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateAuras.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateAuras.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateCastingBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateClassificationFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateComponent.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateFrameOptions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateHealthBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateRaidTarget.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlateUnitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NamePlates/Blizzard_NamePlates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_NewPlayerExperience.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_Tutorial.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialData.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialKeyboardMouseFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialKeyboardMouseFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialKeyboardMouseFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialLogic.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialServices.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialTutorials.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperience/Blizzard_TutorialWatchers.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/Blizzard_NewPlayerExperienceGuide.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/GuideCriteriaFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/GuideCriteriaFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/GuideCriteriaFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/GuideFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/GuideFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_NewPlayerExperienceGuide/GuideFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Notification/Blizzard_Notification.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Notification/Blizzard_Notification.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Notification/Blizzard_Notification.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Notification/Blizzard_NotificationUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Blizzard_ObjectAPI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/AsyncCallbackSystem.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/Campaign.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/CampaignChapter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/ContinuableContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/CovenantCalling.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/Item.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/ItemLocation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/ObjectCache.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/PlayerLocation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/Quest.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/Spell.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectAPI/Mainline/UiMapPoint.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AchievementObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AchievementObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AchievementObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AdventureObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AdventureObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AdventureObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AutoQuestPopUpTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AutoQuestPopUpTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_AutoQuestPopUpTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_BonusObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_BonusObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_BonusObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_CampaignQuestObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_CampaignQuestObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_CampaignQuestObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_InitiativeTasksObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_InitiativeTasksObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_InitiativeTasksObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_MonthlyActivitiesObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_MonthlyActivitiesObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_MonthlyActivitiesObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTracker.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerAnimTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerAnimTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerAnimTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerBlock.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerBlock.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerBlock.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerFonts.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerFonts.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerModule.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerModule.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerModule.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerQuestPOIBlock.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerQuestPOIBlock.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerQuestPOIBlock.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerShared.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerShared.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerUIWidgetContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerUIWidgetContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ObjectiveTrackerUIWidgetContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ProfessionsRecipeTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ProfessionsRecipeTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ProfessionsRecipeTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_QuestObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_QuestObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_QuestObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ScenarioObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ScenarioObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_ScenarioObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_WorldQuestObjectiveTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_WorldQuestObjectiveTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObjectiveTracker/Blizzard_WorldQuestObjectiveTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObliterumUI/Blizzard_ObliterumUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObliterumUI/Blizzard_ObliterumUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObliterumUI/Blizzard_ObliterumUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ObliterumUI/Blizzard_ObliterumUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OrderHallUI/Blizzard_OrderHallTalents.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OrderHallUI/Blizzard_OrderHallTalents.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OrderHallUI/Blizzard_OrderHallTalents.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OrderHallUI/Blizzard_OrderHallUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OrderHallUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OverrideActionBar/Blizzard_OverrideActionBar.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OverrideActionBar/OverrideActionBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OverrideActionBar/OverrideActionBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_OverrideActionBar/OverrideActionBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/Blizzard_POIButton.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButtonHighlightManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButtonOwner.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButtonOwner.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButtonOwner.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_POIButton/POIButtonUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback_Events.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback_FrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback_FrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback_Frames.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_PTRFeedback_Tooltips.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedback/Blizzard_Reports.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PTRFeedbackGlue/Blizzard_PTRFeedbackGlue.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/Blizzard_PVPMatch.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchResults.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchResults.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchResults.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchScoreboard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchScoreboard.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchScoreboard.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchTable.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchTable.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchTable.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPMatch/PVPMatchUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPUI/Blizzard_PVPUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPUI/Mainline/Blizzard_PVPUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPUI/Mainline/Blizzard_PVPUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PVPUI/Mainline/Blizzard_PVPUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedCondensedGridContentFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedCondensedGridContentFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedCondensedGridContentFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedContent.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedContentFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedContentFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedContentFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedGridContentFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedGridContentFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedGridContentFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedListContentFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedListContentFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagedListContentFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagingControls.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagingControls.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PagedContent/Blizzard_PagingControls.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PartyPoseUI/Blizzard_PartyPoseUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PartyPoseUI/Blizzard_PartyPoseUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PartyPoseUI/Blizzard_PartyPoseUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PartyPoseUI/Blizzard_PartyPoseUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerformanceBar/Blizzard_PerformanceBar.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerformanceBar/PerformanceBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgram.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgram.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgram.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgram.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgramElements.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgramElements.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgramElements.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgramFooter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgramModel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Blizzard_PerksProgramProducts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PerksProgram/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/AlternatePowerBars/DemonHunterAlternatePower.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/AlternatePowerBars/EvokerAlternatePower.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/AlternatePowerBars/MonkAlternatePower.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/Blizzard_PersonalResourceDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/Blizzard_PersonalResourceDisplay.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/Blizzard_PersonalResourceDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PersonalResourceDisplay/Blizzard_PersonalResourceDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Blizzard_PetBattleUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Mainline/Blizzard_PetBattleUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Shared/Blizzard_PetBattleUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Shared/Blizzard_PetBattleUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Shared/Blizzard_PetBattleUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Shared/Blizzard_PetBattleUIPatchwerks.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Shared/Blizzard_PetBattleUIPatchwerks.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PetBattleUI/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PingUI/Blizzard_PingManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PingUI/Blizzard_PingUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PingUI/Blizzard_PingUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PingUI/Blizzard_PingUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PingUI/Blizzard_PingUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoice.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoice.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoice.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoice.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceCovenantChoiceOptionTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceCovenantChoiceOptionTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceCovenantChoiceOptionTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceCypherOptionTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceCypherOptionTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceCypherOptionTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceGenericPowerChoiceOptionTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceGenericPowerChoiceOptionTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceGenericPowerChoiceOptionTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceNormalOptionTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceNormalOptionTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceNormalOptionTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceOptionBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceOptionBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceOptionBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoicePowerChoiceTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoicePowerChoiceTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoicePowerChoiceTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceTimer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceTimer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceTimer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceToggleButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceToggleButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceToggleButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceTorghastOptionTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceTorghastOptionTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerChoice/Blizzard_PlayerChoiceTorghastOptionTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/Blizzard_PlayerSpells.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/Blizzard_PlayerSpellsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/Blizzard_PlayerSpellsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/Blizzard_PlayerSpellsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/Blizzard_PlayerSpellsRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassSpecializations/Blizzard_ClassSpecializationsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassSpecializations/Blizzard_ClassSpecializationsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassSpecializations/Blizzard_ClassSpecializationsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentButtonTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentButtonTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentButtonTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentEdgeTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentEdgeTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentEdgeTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentImportExport.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutCreateDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutCreateDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutCreateDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutDialogTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutDialogTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutDialogTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutEditDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutEditDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutEditDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutImportDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutImportDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentLoadoutImportDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentSearch.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_ClassTalentsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_HeroTalentsContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_HeroTalentsContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_HeroTalentsContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_HeroTalentsSelectionDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_HeroTalentsSelectionDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/ClassTalents/Blizzard_HeroTalentsSelectionDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_PvPTalentListTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_PvPTalentListTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_PvPTalentListTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_PvPTalentSlotTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_PvPTalentSlotTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_PvPTalentSlotTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_WarmodeButtonTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_WarmodeButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/PvPTalents/Blizzard_WarmodeButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookCategory.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookFrameTutorials.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookItem.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookItem.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookItem.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookSearch.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlayerSpells/SpellBook/Blizzard_SpellBookTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlunderstormBasics/Blizzard_PlunderstormBasics.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlunderstormBasics/Blizzard_PlunderstormBasics.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlunderstormBasics/Blizzard_PlunderstormBasics.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlunderstormBasics/Blizzard_PlunderstormBasics.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PlunderstormPrematchUI/Blizzard_PlunderstormPrematchUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PrintHandler/Blizzard_PrintHandler.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PrintHandler/Blizzard_PrintHandler.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PrivateAurasUI/Blizzard_PrivateAurasUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PrivateAurasUI/Blizzard_PrivateAurasUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PrivateAurasUI/Blizzard_PrivateAurasUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_PrivateAurasUI/Blizzard_PrivateAurasUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_Professions.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafterOrderPage.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafterOrderPage.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafterOrderPage.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafterOrderView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafterOrderView.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafterOrderView.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafting.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafting.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCrafting.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCraftingOutputLog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCraftingOutputLog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsCraftingOutputLog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsGuildMemberList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsGuildMemberList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsGuildMemberList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsInspectRecipe.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsInspectRecipe.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsInspectRecipe.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRankBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRankBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRankBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRecipeLevel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRecipeLevel.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRecipeLevel.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsSpecializations.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsSpecializations.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsSpecializations.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsSpecializationsTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsSpecializationsTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Blizzard_ProfessionsSpecializationsTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Professions/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsBook/Blizzard_ProfessionsBook.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsBook/Blizzard_ProfessionsBook.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsBook/Blizzard_ProfessionsBook.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsBook/Blizzard_ProfessionsBook.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrders.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrders.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrders.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrders.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersBrowseOrders.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersBrowseOrders.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersBrowseOrders.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersForm.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersForm.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersForm.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersMyOrders.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersMyOrders.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersMyOrders.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersRecipeCategoryList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersRecipeCategoryList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersRecipeCategoryList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersRecipeList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersRecipeList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Blizzard_ProfessionsCustomerOrdersRecipeList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsCustomerOrders/Registration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_Professions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsQualityDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsQualityDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsQualityDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeCrafterDetails.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeCrafterDetails.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeCrafterDetails.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeEnchantSlot.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeEnchantSlot.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeEnchantSlot.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeFlyout.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeFlyout.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeFlyout.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeFlyoutInstance.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeLoader.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeReagentSlot.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeReagentSlot.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeReagentSlot.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeReagentSlotBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeReagentSlotBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeReagentSlotBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeRecraftSlot.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeRecraftSlot.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeRecraftSlot.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSalvageSlot.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSalvageSlot.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSalvageSlot.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSchematicForm.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSchematicForm.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSchematicForm.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsRecipeSlotBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsTemplates.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ProfessionsTemplates/Blizzard_ProfessionsTransaction.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuestNavigation/Blizzard_QuestNavigation.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuestNavigation/SuperTrackedFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuestNavigation/SuperTrackedFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuestNavigation/SuperTrackedFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuestTimer/Blizzard_QuestTimer.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QueueStatusFrame/Blizzard_QueueStatusFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QueueStatusFrame/Mainline/QueueStatusFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QueueStatusFrame/Mainline/QueueStatusFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QueueStatusFrame/Mainline/QueueStatusFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/Blizzard_QuickJoin.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/QuickJoin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/QuickJoin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/QuickJoin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/QuickJoinToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/QuickJoinToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickJoin/QuickJoinToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickKeybind/Blizzard_QuickKeybind.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickKeybind/QuickKeybind.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickKeybind/QuickKeybind.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_QuickKeybind/QuickKeybind.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RPE_TurnStrafe/Blizzard_RPE_TurnStrafe.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RPE_TurnStrafe/Blizzard_RPE_TurnStrafe.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RPE_TurnStrafe/Blizzard_RPE_TurnStrafe.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RPE_TurnStrafe/Blizzard_RPE_TurnStrafe.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidFrame/Blizzard_RaidFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidFrame/Mainline/RaidFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidFrame/Mainline/RaidFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidFrame/Mainline/RaidFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAllies.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/Blizzard_RecruitAFriend.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactTutorialUI/Blizzard_RemixArtifactTutorialUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactTutorialUI/Blizzard_RemixArtifactTutorialUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactTutorialUI/Blizzard_RemixArtifactTutorialUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactTutorialUI/Blizzard_RemixArtifactTutorialUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactUI/Blizzard_RemixArtifactUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactUI/Blizzard_RemixArtifactUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactUI/Blizzard_RemixArtifactUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RemixArtifactUI/Blizzard_RemixArtifactUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrame/Blizzard_ReportFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrame/ReportFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrame/ReportFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrame/ReportFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrameGlue/Blizzard_ReportFrameGlue.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrameShared/Blizzard_ReportFrameShared.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrameShared/ReportFrameShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrameShared/ReportFrameShared.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ReportFrameShared/ReportFrameShared.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/Blizzard_RestrictedAddOnEnvironment.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/RestrictedEnvironment.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/RestrictedExecution.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/RestrictedFrames.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/RestrictedInfrastructure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureGroupHeaders.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureGroupHeaders.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureGroupHeaders.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureHandlerTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureHandlerTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureHandlers.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureHoverDriver.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RestrictedAddOnEnvironment/SecureStateDriver.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCraftingFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCraftingFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCraftingFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCraftingTooltip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCraftingTooltip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCraftingTooltip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCreateFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCreateFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeCreateFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeItemSlot.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeItemSlot.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeItemSlot.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeModifierSlot.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeModifierSlot.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeModifierSlot.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgePowerList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgePowerList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgePowerList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RuneforgeUI/Blizzard_RuneforgeUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SavedSets/Blizzard_SavedSets.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SavedSets/Blizzard_SavedSets.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScrappingMachineUI/Blizzard_ScrappingMachineUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScrappingMachineUI/Blizzard_ScrappingMachineUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScrappingMachineUI/Blizzard_ScrappingMachineUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScrappingMachineUI/Blizzard_ScrappingMachineUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScriptErrors/Blizzard_ScriptErrors.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScriptErrors/Blizzard_ScriptErrors.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScriptErrorsFrame/Blizzard_ScriptErrorsFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScriptErrorsFrame/Blizzard_ScriptErrorsFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScriptErrorsFrame/Blizzard_ScriptErrorsFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ScriptErrorsFrame/Blizzard_ScriptErrorsFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SecureTransferUI/Blizzard_SecureTransferUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SecureTransferUI/Blizzard_SecureTransferUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SecureTransferUI/Blizzard_SecureTransferUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SecureTransferUI/Blizzard_SecureTransferUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SecureTransferUI/Blizzard_SecureTransferUIOutbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SelectorUI/Blizzard_SelectorUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings/Blizzard_Settings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings/Blizzard_Settings.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Accessibility.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Accessibility.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Accessibility.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/ActionBars.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/AdvancedOptions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/AudioAssist.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/AudioAssist.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/AudioAssist.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Blizzard_SettingsDefinitions_Frame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Combat.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/CombatAudioAlertUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Controls.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Controls.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Controls.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Interface.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Interface.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Interface.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Keybindings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Keybindings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Keybindings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/AccessibilityOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/Colorblind.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/Colorblind.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/ColorblindOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/CombatOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/ControlsOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/GameplaySettingsGroup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/InterfaceOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/KeybindingsOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mainline/SocialOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Mounts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Nameplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Nameplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Nameplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/PingSystem.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/PingSystem.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/PingSystem.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Social.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Subtitles.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Subtitles.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Frame/Subtitles.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/AccessibilitySettingsPreview.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Audio.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Audio.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Audio.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Blizzard_SettingsDefinitions_Shared.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Graphics.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Graphics.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Graphics.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Groups.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Languages.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Languages.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Languages.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mac.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/QuestTextPreview.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/QuestTextPreview.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/QuestTextPreview.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/Text.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/TextSizePreview.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/TextSizePreview.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Mainline/TextSizePreview.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SettingsDefinitions_Shared/Network.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Category.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_CategoryList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_CategoryList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_CategoryList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Deprecated.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Dialogs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Keybindings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Keybindings.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Keybindings.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Registration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Setting.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingControls.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingControls.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingControls.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Settings.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsInbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsLayouts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsPanel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsPanel.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsPanel.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_SettingsRegistrar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Blizzard_Settings_Shared_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Mainline/AudioOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Mainline/Blizzard_SettingsPanelTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Mainline/Blizzard_SettingsPanelTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Mainline/GraphicsOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/Mainline/NewDefinitions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Settings_Shared/NewDefinitionsFramework.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaLabelDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaLabelDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaLabelDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaPOIDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaPOIDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaPOIDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaPOIEventDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaPOIEventDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/AreaPOIEventDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BannerDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BannerDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BannerDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BattlefieldFlagDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BattlefieldFlagDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BattlefieldFlagDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/Blizzard_SharedMapDataProviders_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BonusObjectiveDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BonusObjectiveDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/BonusObjectiveDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ClickToZoomDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ClickToZoomDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ClickToZoomDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ContentTrackingDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ContentTrackingDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ContentTrackingDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ContributionCollectorDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ContributionCollectorDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ContributionCollectorDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DeathMapDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DeathMapDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DeathMapDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DelveEntranceDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DelveEntranceDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DelveEntranceDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DigSiteDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DigSiteDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DigSiteDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DragonridingRaceDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DragonridingRaceDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DragonridingRaceDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DungeonEntranceDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DungeonEntranceDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/DungeonEntranceDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/EncounterJournalDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/EncounterJournalDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/EncounterJournalDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FlightPointDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FlightPointDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FlightPointDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FogOfWarDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FogOfWarDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FogOfWarDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/FrameCloneManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GarrisonPlotDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GarrisonPlotDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GarrisonPlotDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GossipDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GossipDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GossipDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GroupMembersDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GroupMembersDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/GroupMembersDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/InvasionDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/InvasionDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/InvasionDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapExplorationDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapExplorationDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapExplorationDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapHighlightDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapHighlightDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapHighlightDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapLinkDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapLinkDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapLinkDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/MapPinTags.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/NeighborhoodMapDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/NeighborhoodMapDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/NeighborhoodMapDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/PetTamerDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/PetTamerDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/PetTamerDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/PlunderstormCircleDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/PlunderstormCircleDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/PlunderstormCircleDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestBlobDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestBlobDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestBlobDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestOfferDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestOfferDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestOfferDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/QuestSessionDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ScenarioDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ScenarioDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ScenarioDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SelectableGraveyardDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SelectableGraveyardDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SelectableGraveyardDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SharedMapPoiTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SharedMapPoiTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SharedMapPoiTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SuperTrackWaypointDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SuperTrackWaypointDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/SuperTrackWaypointDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/VehicleDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/VehicleDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/VehicleDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/VignetteDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/VignetteDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/VignetteDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/WaypointLocationDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/WaypointLocationDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/WaypointLocationDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/WorldQuestDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/WorldQuestDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/WorldQuestDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ZoneLabelDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ZoneLabelDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedMapDataProviders/ZoneLabelDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentButtonTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentButtonTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentButtonTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentEdgeTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentEdgeTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentEdgeTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentFrameTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentSelectionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentSelectionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentSelectionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_SharedTalentUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentArmorSet.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentArmorSet.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentArmorSet.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonAnim.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonAnim.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonAnim.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonAnimUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonArt.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonArt.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonArt.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSelect.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSelect.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSelect.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSelectExpanded.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSelectExpanded.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSelectExpanded.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonSpend.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonTierTrackTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonTierTrackTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentButtonTierTrackTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentCard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentCard.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentCard.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentFrameGrid.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentFrameGrid.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentFrameGrid.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentFrameList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentFrameList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentFrameList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentRedButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentRedButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedTalentUI/Blizzard_TalentRedButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedWidgetFrames/Blizzard_SharedWidgetFrames.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedWidgetFrames/Blizzard_UIWidgetCenterDisplayFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedWidgetFrames/Blizzard_UIWidgetCenterDisplayFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedWidgetFrames/Blizzard_UIWidgetCenterDisplayFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AccountUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AlertFrameIntrinsic.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AlertFrameIntrinsic.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AlertFrameIntrinsic.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AnimationTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AnimationTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/AnimationTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Backdrop.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Backdrop.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Backdrop.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/BenchmarkUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/BindingUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Blizzard_RadialWheel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Blizzard_RadialWheel.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Blizzard_RadialWheel.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Blizzard_SharedXML_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/BulletPoint.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/BulletPoint.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/BulletPoint.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ButtonGroup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CharacterModelFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CircularBuffer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ColorUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CommonUIPanelTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CommonUIPanelTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CustomBindingButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CustomBindingButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/CustomBindingButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/DataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/DebugBarManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/DialogUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/DropDownToggleButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/DropDownToggleButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/DropDownToggleButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Dump.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/EasingUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/EventUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/FontableFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/FormattingUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/GameRulesUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/GridLayoutUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/HelpTip.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/HelpTip.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/HelpTip.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/HybridScrollFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/HybridScrollFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/HybridScrollFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/IndexRangeDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/InputUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/InterfaceUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Interpolator.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/KeyCommand.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/LayoutFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/LayoutFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/LayoutFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/LinkUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/LoopingSoundEffect.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ClassColors.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Frame/MainMenuFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Frame/MainMenuFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/GameRulesUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/MajorFactionRenownSharedTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/MajorFactionRenownSharedTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/MajorFactionRenownSharedTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ModelControlButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ModelFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ModelFrames.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ModelFrames.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ModelFrames.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/NineSliceLayouts.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Scroll/OribosScrollBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Scroll/OribosScrollBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Scroll/OribosScrollBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ScrollDefine.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ScrollDefine.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/ScrollDefine.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Selector/Blizzard_ScrollBoxSelector.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Selector/Blizzard_ScrollBoxSelector.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedCollectionTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedCollectionTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedCollectionTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedCollectionUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedUIPanelTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedUIPanelTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SharedUIPanelTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/Sound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/SoundKitConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/UIDropDownMenu.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/UIDropDownMenu.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/UIDropDownMenu.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/UIDropDownMenuTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/UIDropDownMenuTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Mainline/UIDropDownMenuTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ManagedLayoutFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ManagedLayoutFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ManagedLayoutFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/MixinUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelPreviewFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelPreviewFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelPreviewFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneActorMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneActorMixin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneActorMixin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneControlFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneControlFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneControlFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneMixin.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneMixin.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ModelSceneTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/NewFeatureLabel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/NewFeatureLabel.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/NewFeatureLabel.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/NineSlice.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PagedList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PagedList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PagedList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PingAttributes.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PingAttributes.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PingUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PingableType.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PixelUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PixelUtilSecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PortraitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PredictedSetting.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ProjectConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyBindingMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyFontString.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyFontString.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertyFontString.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertySlider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertySlider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/PropertySlider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/RegionUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScaleToFitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScaleToFitFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScaleToFitFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptAnimationUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptedAnimations/ScriptAnimatedEffectController.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptedAnimations/ScriptAnimatedModelScene.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptedAnimations/ScriptAnimatedModelScene.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptedAnimations/ScriptAnimatedModelScene.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptedAnimations/ScriptAnimatedModelSceneActor.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScriptedAnimations/ScriptedAnimationEffects.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScrollableTabsContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScrollableTabsContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScrollableTabsContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScrollingMessageFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScrollingMessageFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ScrollingMessageFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureScrollTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureScrollTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureScrollTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureUIPanelTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureUIPanelTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureUIPanelTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SecureUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SelectableButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SelectableButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SelectableButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Sequencer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/CheckButtonTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/CheckButtonTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/IconButtonTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/IconButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/IconButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/ThreeSliceButtonTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/ThreeSliceButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/ThreeSliceButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/UIButtonTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/UIButtonTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/UIButtonTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/UIPanelButtonTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/UIPanelButtonTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Button/UIPanelButtonTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ButtonTray/ButtonTray.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ButtonTray/ButtonTray.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ButtonTray/ButtonTray.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ButtonTray/ButtonTrayUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Dialog/DialogTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Dialog/DialogTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Dialog/DialogTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventEditBox.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventEditBox.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventEditBox.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventScrollFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventScrollFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/EventScrollFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Frame/MainMenuFrameTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/FrameTemplate/RingedFrameTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/FrameTemplate/RingedFrameTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/FrameTemplate/RingedFrameTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/InputBox/InputBoxTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/InputBox/InputBoxTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/InputBox/InputBoxTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/LoadSystem/LoadSystemTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/LoadSystem/LoadSystemTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/LoadSystem/LoadSystemTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/LocalizationMachinery.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ModelSceneCameras/CameraBaseMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ModelSceneCameras/CameraRegistry.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/ModelSceneCameras/OrbitCameraMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/MinimalScrollBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/MinimalScrollBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/MinimalScrollBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBox.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBox.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBox.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxBiaxalView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxGridView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxLinearView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxListView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxPadding.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxSequenceView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxStride.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxTreeView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxView.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollBoxViewUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollController.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/ScrollUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/TrimScrollBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/TrimScrollBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Scroll/TrimScrollBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_GridSelectorUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_GridSelectorUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_GridSelectorUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_ScrollBoxSelector.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_SelectorUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_SelectorUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Selector/Blizzard_SelectorUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Slider/MinimalSlider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Slider/MinimalSlider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Slider/MinimalSlider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/TabSystem/TabSystemOwner.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/TabSystem/TabSystemOwner.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/TabSystem/TabSystemOwner.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/TabSystem/TabSystemTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/TabSystem/TabSystemTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/TabSystem/TabSystemTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Tabs/MinimalTab.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Tabs/MinimalTab.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/Tabs/MinimalTab.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Shared/VASErrorLookup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedBasicControls.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedBasicControls.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedBasicControls.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedColorConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SmoothStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SortUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spline.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/StringUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TabGroup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TableBuilder.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TimeUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/ToolWindowOwnerMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TreeListDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TypeUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/UnitUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Vector2D.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Vector3D.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Vector4D.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/VectorLib.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/VectorLib.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/WoWLabs/ProjectConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/middleclass.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/AddOnUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/AnchorUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Blizzard_SharedXMLBase.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ButtonStateBehavior.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CallbackRegistrant.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CallbackRegistrant.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CallbackRegistrant.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CallbackRegistry.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Color.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ColorSwatch.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ColorSwatch.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ColorSwatch.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CombatAudioAlertConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Compat.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CurveConstants.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/CvarUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/EnumUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/EnvironmentUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ErrorUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Event.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ExportUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Flags.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/FrameFactory.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/FrameUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/FrameWatcher.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/FunctionUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/GlobalCallbackRegistry.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/LocaleUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/MathUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Mixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ModelSceneUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ObjectUpdater.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Pools.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/ProxyUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/Rectangle.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/RegionLayoutManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/SecureTypes.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/TableUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/TaggableObject.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/TemplateInfoCache.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/TextureUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLBase/TimedCallback.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Blizzard_SharedXMLGame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/DressUpModelFrameMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Mainline/ListTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Mainline/ListTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Mainline/ListTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/StaticModelInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Tooltip/TooltipComparisonManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Tooltip/TooltipDataHandler.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Tooltip/TooltipDataRules.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXMLGame/Tooltip/TooltipUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SimpleCheckout/Blizzard_SimpleCheckout.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SimpleCheckout/Blizzard_SimpleCheckout.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SimpleCheckout/Blizzard_SimpleCheckout.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SimpleCheckout/Blizzard_SimpleCheckout.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SimpleCheckout/Blizzard_SimpleCheckout_Inbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SimpleCheckout/Blizzard_SimpleCheckout_Outbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SocialToast/Blizzard_SocialToast.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SocialToast/SocialToast.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SocialToast/SocialToast.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SocialToast/SocialToast.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_Soulbinds.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_Soulbinds.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_Soulbinds.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_Soulbinds.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsConduit.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsConduitList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsConduitList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsConduitList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsNode.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsNode.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsNode.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsNodeLink.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsNodeLink.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsNodeLink.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsSelectButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsSelectButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsSelectButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsSelectGroup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsSelectGroup.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsSelectGroup.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsTree.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsTree.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsTree.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsViewer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsViewer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Soulbinds/Blizzard_SoulbindsViewer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpectateFrame/Blizzard_SpectateFrame.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellDiminishUI/Blizzard_SpellDiminishUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellDiminishUI/Blizzard_SpellDiminishUITemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellDiminishUI/Blizzard_SpellDiminishUITemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellDiminishUI/Blizzard_SpellDiminishUITemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellPickUpIndicator/Blizzard_SpellPickUpIndicator.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearch.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchActionBarFilter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchAssistedCombatFilter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchController.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchFilter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchNameFilter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchSource.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchTextFilter.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SpellSearch/Blizzard_SpellSearchUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StableUI/Blizzard_StableUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StableUI/Blizzard_StableUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StableUI/Blizzard_StableUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StableUI/Blizzard_StableUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup/Blizzard_StaticPopup.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup/SharedDialogDefs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup/SharedTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup/StaticPopup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/Blizzard_StaticPopup_Game.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/GameDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/GameDialog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/GameDialog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/GameDialogDefs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/GameDialogDefsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/Mainline/GameDialog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/Mainline/GameDialogDefs.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/Mainline/StaticPopupSpecial.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Game/Mainline/StaticPopupSpecial.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StaticPopup_Glue/Blizzard_StaticPopup_Glue.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StatusUI/Blizzard_StatusUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StatusUI/Blizzard_StatusUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StatusUI/Blizzard_StatusUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StatusUI/Blizzard_StatusUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_FullProductCardTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_LargeProductCardTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_ProductCardBuyButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_ProductCardMagnifierTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_ProductCardTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_ProductCardTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_ProductCardTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_SmallProductCardTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUIInbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUIInsecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUIOutbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUIPatchwerk.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUIPatchwerk.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUISecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUITemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUITemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_Shared_StoreUITemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Blizzard_StoreUI_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_StoreUI/Shared_Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SubscriptionInterstitialUI/Blizzard_SubscriptionInterstitialUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SubscriptionInterstitialUI/Blizzard_SubscriptionInterstitialUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SubscriptionInterstitialUI/Blizzard_SubscriptionInterstitialUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SubscriptionInterstitialUI/Blizzard_SubscriptionInterstitialUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Subtitles/Blizzard_Subtitles.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Subtitles/Blizzard_Subtitles.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Subtitles/Blizzard_Subtitles.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Subtitles/Blizzard_Subtitles.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TextStatusBar/Blizzard_TextStatusBar.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TextStatusBar/TextStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TextStatusBar/TextStatusBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TextStatusBar/TextStatusBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimeManager/Blizzard_TimeManager_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimeManager/Mainline/Blizzard_TimeManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimeManager/Mainline/Blizzard_TimeManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimeManager/Mainline/Blizzard_TimeManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimeManager/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimerunningCharacterCreate/Blizzard_TimerunningCharacterCreate.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimerunningUtil/Blizzard_TimerunningUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TimerunningUtil/Blizzard_TimerunningUtil.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_CurrencyTransfer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_CurrencyTransfer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_CurrencyTransfer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_TokenUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_TokenUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_TokenUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Blizzard_TokenUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TokenUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TorghastLevelPicker/Blizzard_TorghastLevelPicker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TorghastLevelPicker/Blizzard_TorghastLevelPicker.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TorghastLevelPicker/Blizzard_TorghastLevelPicker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TorghastLevelPicker/Blizzard_TorghastLevelPicker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TrainerUI/Blizzard_TrainerUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TrainerUI/Blizzard_TrainerUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TrainerUI/Blizzard_TrainerUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TrainerUI/Blizzard_TrainerUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TrainerUI/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_RotateControlFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_RotateControlFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_RotateControlFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_ScaleControlFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_ScaleControlFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_ScaleControlFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformManipulator/Blizzard_TransformManipulator.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformTree/Blizzard_TransformTree.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformTree/TransformTreeBaseNodeMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformTree/TransformTreeFrameNodeMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformTree/TransformTreeMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformTree/TransformTreePools.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransformTree/TransformTreeTextureNodeMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_Transmog.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_Transmog.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_Transmog.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_Transmog.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_TransmogRegistration.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_TransmogTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_TransmogTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Blizzard_TransmogTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Transmog/Mainline/Blizzard_TransmogOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransmogShared/Blizzard_TransmogShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TransmogShared/Blizzard_TransmogShared.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialEffects.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialEffects.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialEffects.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialHelper.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialMainFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialMainFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialMainFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialManager.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialPointerFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialPointerFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialPointerFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialQuestManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialQueue.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_TutorialManager/Blizzard_TutorialRangeManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/BagTutorialUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_TutorialReagentBag.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_TutorialSupertrack.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Classes.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Dracthyr.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Dragonriding.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Frame_Tutorials.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Managed.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Managed.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Managed.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_PerksProgram.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_Professions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/Blizzard_Tutorials_RPE.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/StateMachineTutorialUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Tutorials/StateMachineUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIFrameManager/Blizzard_UIFrameManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIFrameManager/Blizzard_UIFrameManager.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIFrameManager/Blizzard_UIFrameManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIFrameManager/Blizzard_UIFrameManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Blizzard_UIPanelTemplates_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Mainline/AutoCastTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Mainline/AutoCastTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Mainline/AutoCastTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Mainline/UIPanelTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Mainline/UIPanelTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Mainline/UIPanelTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Shared/UIPanelSpellButtonFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Shared/UIPanelSpellButtonFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanelTemplates/Shared/UIPanelSpellButtonFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Blizzard_UIPanels_Game_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/AzeritePaperDollItemOverlay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/AzeritePaperDollItemOverlay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/AzeritePaperDollItemOverlay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/BankFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/BankFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/BankFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CampaignOverview.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CampaignOverview.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CampaignOverview.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CastingBarFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CastingBarFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CastingBarFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CharacterFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CharacterFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CharacterFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ContainerFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ContainerFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ContainerFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CustomGossipFrameBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CustomGossipFrameBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/CustomGossipFrameBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/DressUpFrames.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/DressUpFrames.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/DressUpFrames.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/EventScheduler.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/EventScheduler.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/EventScheduler.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/FogOfWarFrameTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/FogOfWarFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/FogOfWarFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/FriendshipStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/FriendshipStatusBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/FriendshipStatusBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GossipFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GossipFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GossipFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GroupLootFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GroupLootFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GroupLootFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GuildRegistrarFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GuildRegistrarFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/GuildRegistrarFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemRef.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemRef.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemRef.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemRefHandlers.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemTextFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemTextFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ItemTextFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/LootFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/LootFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/LootFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/MapLegendFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/MapLegendFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/MapLegendFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/MerchantFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/MerchantFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/MerchantFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/PaperDollFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/PaperDollFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/PaperDollFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/PetitionFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/PetitionFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/PetitionFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestFrameTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestInfo.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestInfo.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestInfo.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestMapFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestMapFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/QuestMapFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ReputationFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ReputationFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ReputationFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/RoleSelectionTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/RoleSelectionTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/RoleSelectionTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ScrollingFlatPanel.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ScrollingFlatPanel.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/ScrollingFlatPanel.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TabardFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TabardFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TabardFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TabardModelControlButtonMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TradeFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TradeFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/TradeFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/UnitPositionFrameTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/UnitPositionFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/UnitPositionFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WarCampaignTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WarCampaignTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WarCampaignTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WorldMapActionButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WorldMapBountyBoard.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WorldMapFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WorldMapFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Mainline/WorldMapFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/CastingBarFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/ExtraAbilityContainer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/ExtraAbilityContainer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/ExtraAbilityContainer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/GossipFrameShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/GossipFrameShared.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/GossipFrameShared.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/ItemRefHandlersShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/PlayerInteractionFrameManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/PlayerInteractionFrameManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/PlayerInteractionFrameManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/SocialQueue.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/TaxiFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/TaxiFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/TaxiFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/VehicleSeatIndicator.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/VehicleSeatIndicator.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/VehicleSeatIndicator.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIPanels_Game/Shared/WorldMapPOIQuantizer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Blizzard_UIParent_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/ChatBubbleTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/ChatBubbleTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Mainline/UIParent.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Mainline/UIParent.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Mainline/UIParent.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Mainline/WorldFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Mainline/WorldFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Mainline/WorldFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Shared/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParent/Shared/UIParent.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParentPanelManager/Blizzard_UIParentPanelManager_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParentPanelManager/Mainline/UIPanelWindows.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParentPanelManager/Mainline/UIParentPanelManagerOverrides.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParentPanelManager/Shared/UIParentPanelManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIParentPanelManager/Shared/UpdateUIPanelPositions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Blizzard_UIWidgets_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetAnimationTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetAnimationTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetAnimationTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetBelowMinimapFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetBelowMinimapFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetBelowMinimapFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetCenterScreenFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetCenterScreenFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetCenterScreenFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetManager.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetManager.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetManager.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetPowerBarFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetPowerBarFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetPowerBarFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateBulletTextList.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateBulletTextList.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateBulletTextList.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateButtonHeader.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateButtonHeader.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateButtonHeader.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateCaptureBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateCaptureBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateCaptureBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateCaptureZone.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateCaptureZone.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateCaptureZone.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDiscreteProgressSteps.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDiscreteProgressSteps.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDiscreteProgressSteps.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleIconAndText.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleIconAndText.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleIconAndText.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleStateIconRow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleStateIconRow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleStateIconRow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleStatusBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateDoubleStatusBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateFillUpFrames.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateFillUpFrames.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateFillUpFrames.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateHorizontalCurrencies.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateHorizontalCurrencies.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateHorizontalCurrencies.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconAndText.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconAndText.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconAndText.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconTextAndBackground.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconTextAndBackground.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconTextAndBackground.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconTextAndCurrencies.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconTextAndCurrencies.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateIconTextAndCurrencies.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateItemDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateItemDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateItemDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateMapPinAnimation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateMapPinAnimation.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateMapPinAnimation.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplatePreyHuntProgress.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplatePreyHuntProgress.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplatePreyHuntProgress.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderCurrenciesAndBackground.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderCurrenciesAndBackground.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderCurrenciesAndBackground.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderDelves.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderDelves.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderDelves.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderTimer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderTimer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateScenarioHeaderTimer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateSpacer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateSpacer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateSpacer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateSpellDisplay.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateSpellDisplay.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateSpellDisplay.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateStackedResourceTracker.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateStackedResourceTracker.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateStackedResourceTracker.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateStatusBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateStatusBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateStatusBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextColumnRow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextColumnRow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextColumnRow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextWithState.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextWithState.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextWithState.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextWithSubtext.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextWithSubtext.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextWithSubtext.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureAndText.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureAndText.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureAndText.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureAndTextRow.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureAndTextRow.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureAndTextRow.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureWithAnimation.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureWithAnimation.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTextureWithAnimation.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTugOfWar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTugOfWar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateTugOfWar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateUnitPowerBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateUnitPowerBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateUnitPowerBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateZoneControl.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateZoneControl.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTemplateZoneControl.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTopCenterFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTopCenterFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_UIWidgetTopCenterFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UIWidgets/Mainline/Blizzard_WidgetsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Blizzard_UnitFrame_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/DemonHunterSoulFragmentsBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/DemonHunterSoulFragmentsBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/DemonHunterSoulFragmentsBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/DevourerFuryBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/DevourerFuryBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/DevourerFuryBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/AlternatePowerBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/AlternatePowerBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/AlternatePowerBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/AlternatePowerBarBase.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/AlternatePowerBarBase.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/AlternatePowerBarBase.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/BuilderSpenderFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/BuilderSpenderFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/BuilderSpenderFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ClassPowerBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ClassPowerBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ClassPowerBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ClassResourceBarTemplate.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ClassResourceBarTemplate.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ClassResourceBarTemplate.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ComboFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ComboFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ComboFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/CompactArenaFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/CompactArenaFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/CompactArenaFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/CompactUnitFrameOptions.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/DruidComboPointBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/DruidComboPointBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/DruidComboPointBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/EssenceFramePlayer.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/EssenceFramePlayer.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/EssenceFramePlayer.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/EvokerEbonMightBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/EvokerEbonMightBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/EvokerEbonMightBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/InsanityBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/InsanityBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/InsanityBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/Localization.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MageArcaneChargesBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MageArcaneChargesBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MageArcaneChargesBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MonkHarmonyBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MonkHarmonyBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MonkHarmonyBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MonkStaggerBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MonkStaggerBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/MonkStaggerBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PaladinPowerBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PaladinPowerBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PaladinPowerBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PartyFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PartyFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PartyMemberFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PetFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PetFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PetFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PlayerFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PlayerFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PlayerFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/PowerBarColorUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/RogueComboPointBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/RogueComboPointBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/RogueComboPointBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/RuneFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/RuneFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/RuneFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ShardBar.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ShardBar.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/ShardBar.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/TargetFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/TargetFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/TargetFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/TotemFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/TotemFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/TotemFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/UnitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/UnitPowerBarAlt.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/UnitPowerBarAlt.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Mainline/UnitPowerBarAlt.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactPartyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactPartyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactPartyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactRaidGroup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactRaidGroup.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactRaidGroup.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactUnitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactUnitFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/CompactUnitFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PartyFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PartyFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PartyFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PartyFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PartyFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PartyMemberFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PlayerFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PlayerFrameTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/PlayerFrameTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/StatusBarOverlaySegment.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/StatusBarOverlaySegment.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/StatusBarOverlaySegment.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/TargetFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/UnitFrame.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/UnitFrame.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitFrame/Shared/UnitFrame.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/Blizzard_UnitPopup_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/Mainline/UnitPopup.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/Mainline/UnitPopupUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/UnitPopupCustomControls.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/UnitPopupCustomControls.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/UnitPopupCustomControls.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/UnitPopupSlider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/UnitPopupSlider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopup/UnitPopupSlider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopupShared/Blizzard_UnitPopupShared_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopupShared/Mainline/UnitPopupSharedButtonMixins.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopupShared/UnitPopupShared.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopupShared/UnitPopupSharedButtonMixins.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopupShared/UnitPopupSharedMenus.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_UnitPopupShared/UnitPopupSharedUtils.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_VoiceToggleButton/Blizzard_VoiceToggleButton.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_VoiceToggleButton/VoiceToggleButton.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_VoiceToggleButton/VoiceToggleButton.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_VoiceToggleButton/VoiceToggleButton.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WarfrontsPartyPoseUI/Blizzard_WarfrontsPartyPoseUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WarfrontsPartyPoseUI/Blizzard_WarfrontsPartyPoseUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WarfrontsPartyPoseUI/Blizzard_WarfrontsPartyPoseUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WarfrontsPartyPoseUI/Blizzard_WarfrontsPartyPoseUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WeeklyRewards/Blizzard_WeeklyRewards.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WeeklyRewards/Blizzard_WeeklyRewards.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WeeklyRewards/Blizzard_WeeklyRewards.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WeeklyRewards/Blizzard_WeeklyRewards.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WeeklyRewardsUtil/Blizzard_WeeklyRewardsUtil.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WeeklyRewardsUtil/Blizzard_WeeklyRewardsUtil.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldLootObjectList/Blizzard_WorldLootObjectList.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMap.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMap.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMap.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMapTemplates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMapTemplates.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMapTemplates.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/Blizzard_WorldMap_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/MapTexturePreloader.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/QuestLogOwnerMixin.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_DebugDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_DebugDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_DebugDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_EventOverlayDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_EventOverlayDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_EventOverlayDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_WorldQuestDataProvider.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_WorldQuestDataProvider.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WorldMap/WM_WorldQuestDataProvider.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowSurveyUI/Blizzard_WowSurveyUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowSurveyUI/Blizzard_WowSurveyUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowSurveyUI/Blizzard_WowSurveyUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowSurveyUI/Blizzard_WowSurveyUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUI.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUI.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUI.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUI.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUIInbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUIInsecure.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUIInsecure.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUIInsecure.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_WowTokenUI/Blizzard_WowTokenUIOutbound.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ZoneAbility/Blizzard_ZoneAbility_Mainline.toc create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ZoneAbility/ZoneAbility.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ZoneAbility/ZoneAbility.xml create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ZoneAbility/ZoneAbility.xml.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/_enums.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/Annotations/_templates.lua.annotated.lua create mode 100644 docs/annotations/Annotations/FrameXML/README.md create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AbbreviateConfigAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AbbreviatedNumberFormatterAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AccessibilityOptionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AccountConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ActionDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AddOnConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AddOnProfilerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AdventureJournalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ArrowCalloutConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AsyncAssistActionsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AuctionHouseConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AuctionHouseEnumsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AuraContainerSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AuraContainerUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AutoCompleteDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AutoCompleteSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AutoLootDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AzeriteConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BagConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BagIndexConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BankDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BattleNetSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BattlePetConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BattlePetDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BattlepayConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BlackMarketInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BlizzCon2026Documentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/Blizzard_APIDocumentationGenerated.toc create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BrowserDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ButtonStateDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CalendarConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CameraConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CatalogShopConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CharacterCreationConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CharacterSelectionConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CharacterServicesConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ChatSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CinematicConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClassTrialDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClientSceneDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClientSettingsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ClubSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ColorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ColorOverrideConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatAudioAlertConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatAudioAlertSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatLogConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CommentatorSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CompactUnitFramesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ConfigurationWarningConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ConfigurationWarningsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CooldownFrameConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CooldownViewerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantCallingsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantSanctumConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CraftingOrderUIConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CurrencyConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CurrencyConstants_MainlineDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CursorConstDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CursorUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DamageConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DamageMeterConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DeathAlertDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DiscordConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DiscordDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DuelInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DungeonEncounterConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DurationTextBindingObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DurationTextBindingSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EditModeManagerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncodingUtilConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterJournalConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterTimelineConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EventSchedulerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExpansionConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExpansionLandingPageConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExpansionLevelConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FlyoutDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FontDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ForbiddenAspectConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIArchaeologyDigsiteDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIBlobDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPICharacterModelBaseDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPICinematicModelDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPICooldownDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIDressUpModelDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIFogOfWarFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorBaseDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPINamePlateDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIQuestPOIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIScenarioPOIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPISimpleCheckoutDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPITabardModelBaseDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPITabardModelDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPITooltipDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameAPIUnitPositionFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GARRISON_TYPEConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GMTicketInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GamePadConstDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GameRulesConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GamepadTargetingDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GamepadUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GarrisonConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GlyphConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GlyphInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GossipConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GroupFinderConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GuildConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingBlueprintConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingBlueprintUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingCatalogSearcherAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingFixturePointFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingInspectModeUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingLayoutPinFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ImageSharingConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InputConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InputDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InputInterfaceStyleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/IntlDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/IntlSharedTypesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/IslandsInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemConstants_MainlineDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemQualitiesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemTextDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LFGListRolesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LegacyConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LevelConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LoadingScreenDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LogConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LogDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LogicConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LootConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LootConstants_MainlineDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LootDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LootFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LossOfControlConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaColorCurveObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaCurveObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaCurveObjectBaseAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaCurveObjectConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaDurationClockAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaDurationManualClockAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaDurationObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaDurationObjectSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaLocaleContextAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaMathExtensionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaStringExtensionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaTableExtensionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/LuaValuePredicatesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MacroConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MajorFactionsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MapConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MapDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MatrixSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MinimapConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MinimapFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ModelAnimationSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MoneyConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MountConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NameGenConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NamePlateConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NameUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativesConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NumericFormatterAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NumericRuleFormatterAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/NumericRuleFormatterSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/OsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PVPMgrConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PartyConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PartyInfoSystemStatusDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PartyPoseUIConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetBattleConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetConstants_SharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PetScalingConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PhotoSharingUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PingManagerSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PingPinFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlatformDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerChoiceConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerDataConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerHousingConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerMentorshipConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PonyDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PowerTypeConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ProceduralSpawnConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ProfessionConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PvPFactionConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PvpInfoConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestConstants_MainlineDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestSessionConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RaidMarkerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RecentAlliesConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RecruitAFriendSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RenownConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ReportSystemConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RestrictedActionsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RolesetSystemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/RolodexConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ScreenLocationConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ScriptWarningsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SeasonsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecondsFormatterAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecondsFormatterSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecretAspectConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecretPredicatesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecretWrapperConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SharedScriptObjectNamePlateFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SharedScriptObjectUnitPositionFrameDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SharedTraitsEnumsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimAlphaAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimFlipBookAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimGroupAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimPathAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimRadialProgressAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimRotationAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimScaleAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimScaleLineAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimTextureCoordTranslationAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationLineAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimVertexColorAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleAnimatableObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleBrowserAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleButtonAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleCheckboxAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleColorSelectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleControlPointAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleEditBoxAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleFontAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleFontStringAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleFrameScriptObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleFrameScriptObjectConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleHTMLAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleLineAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleMapSceneAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleMaskTextureAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleMessageFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleModelAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleModelFFXAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleMovieAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleObjectAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleOffScreenFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleRegionAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleScriptRegionAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleScriptRegionResizingAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleScrollFrameAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleSliderAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleStatusBarAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleStatusBarConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleTextureAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleTextureBaseAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SimpleVectorGraphicsAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SkillInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SocialConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SocialQueueSystemStatusDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SocialUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SoftTargetConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SoulbindsConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpecializationConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellBookConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellDiminishConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellIDDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SplashScreenConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SummonConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SuperTrackManagerSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SwingTimerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TalentAndGlyphConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TalentConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TalkingHeadDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TextureSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TimedSignalMapAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TimedSignalMapSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TimerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TimerunningConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TooltipConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TrainerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TrainerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TraitConfigDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TraitConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransformManipulatorConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogOutfitConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TransmogSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIActionConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIActionDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UICharacterClassConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UICovenantDisplayInfoConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIEventToastConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIFileAssetAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIFileAssetSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIModelInfoSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UITextureAssetSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UIWidgetManagerSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/URLDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UiModelSceneConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UiRpcRequestManagerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitAuraConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitAuraSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorAPIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitSexConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UnitSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ValidateNameConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VectorSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VehicleDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VignetteConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VisualAlertConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WarbandSceneInfoConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WeatherConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WeatherScriptDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WeeklyRewardsSharedDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WorldElapsedTimerConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WorldStateInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WowCSConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WowEntitlementInfoDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WowSurveyConstantsDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua create mode 100644 docs/blizzard-api/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua create mode 100644 docs/secrets.md diff --git a/.continue/rules/wow.md b/.continue/rules/wow.md new file mode 100644 index 0000000..1bbac61 --- /dev/null +++ b/.continue/rules/wow.md @@ -0,0 +1,13 @@ +--- +name: WoW addon rules +alwaysApply: true +--- +- Target: WoW Forever beta (interface 16001), Midnight-era retail API. +- Prefer the reference files in docs/ over memory. For each API call, say where + it came from. If you can't point to a source, add `-- UNVERIFIED` and tell me. +- Never sell, delete, send or use items without a preview/confirm step. + Skip equipped items and anything not explicitly listed. +- Don't edit files outside this project. Ask before running terminal commands. +- Read NOTES.md first. Keep files small and single-purpose. +- Known gotchas: (add a line each time it gets something wrong) +- Before using any API function, search docs/blizzard-api for its name, copy the signature from there, and mark it `-- UNVERIFIED` if it isn't found. \ No newline at end of file diff --git a/.continueignore b/.continueignore new file mode 100644 index 0000000..9ab1767 --- /dev/null +++ b/.continueignore @@ -0,0 +1,8 @@ +**/*.run.xml +.changes/ +.idea/ +.vscode/ +.archive/ +**/*.scm +**/*.diff +.continue/ \ No newline at end of file diff --git a/.wowluarc.json b/.wowluarc.json new file mode 100644 index 0000000..594b6ad --- /dev/null +++ b/.wowluarc.json @@ -0,0 +1,11 @@ +{ + "flavors": ["forever"], + "ignore": [ + "docs/", + ".git", + "*.md", + "LICENSE", + ".gitignore", + ".continueingore" + ] +} diff --git a/NOTES.md b/NOTES.md new file mode 100644 index 0000000..db45dbb --- /dev/null +++ b/NOTES.md @@ -0,0 +1,48 @@ +# SessionGoldTracker — Project Notes + +## Spec + +A small, movable HUD frame for WoW Forever beta (interface 16001, Midnight-era retail API). + +### What it does +- Tracks gold earned in the current play session (positive deltas only — spending does not count against the total). +- Displays: session gold earned, gold per hour rate, and time elapsed since session start or last reset. +- Provides a reset button on the frame that zeroes the session counters. +- Provides a `/gt` slash command: `/gt` toggles the frame, `/gt reset` resets the session counters. +- Saves frame position (point, x, y) and lifetime total gold earned across sessions via SavedVariables. +- Does NOT act on items, mail, trades, the auction house, or any unit data. + +### What it does NOT do +- No combat log parsing. +- No item selling, deleting, or using. +- No auction house or mail interaction. +- No unit-targeted API calls. + +--- + +## Target + +| Key | Value | +|---|---| +| Game | WoW Forever (beta) | +| Interface | 16001 | +| TOC suffix | `_Camelot` | +| API style | Midnight-era retail (`C_*` namespaces where they exist) | +| SavedVariables | `SessionGoldTrackerDB` | + +--- + +## File Layout + +## Build Order +Each step should be independently testable in game before moving on. +1. **Skeleton:** TOC files, empty Lua, SavedVariables declared, no errors on load. ✅ DONE +2. **DB init:** `PLAYER_LOGIN` handler, default DB, log starting gold to chat with `print()`. Verify money is a number. ✅ DONE +3. **Money tracking:** Register `PLAYER_MONEY`, compute delta, accumulate `sessionGross`. Log each delta. ✅ DONE +4. **Frame:** Movable frame with labels for earned gold and per-hour rate. No drag yet. ✅ DONE +5. **Drag and save position:** Drag support + save point on `OnDragStop` + restore on login. +6. **Reset button:** On-frame button that zeroes session counters and resets `sessionStart`. +7. **Slash command:** `/gt` toggle, `/gt reset` wired to the same reset logic. +8. **Lifetime total:** Add `sessionEarned` to `lifetimeTotal` on `PLAYER_LOGOUT`. +9. **Polish:** Format display cleanly, add a tooltip, test across a /reload. + diff --git a/STATUS.md b/STATUS.md new file mode 100644 index 0000000..30bd7c5 --- /dev/null +++ b/STATUS.md @@ -0,0 +1,54 @@ + +# SessionGoldTracker — STATUS.md + +## Completed Steps + +- [x] 1. Skeleton +- [x] 2. DB init +- [x] 3. Money tracking +- [x] 4. Frame + +## In Progress + +- [ ] 5. Drag and save position + +## Pending + +- [ ] 6. Reset button +- [ ] 7. Slash command +- [ ] 8. Lifetime total +- [ ] 9. Polish + +## API Verification Status + +| API | Source | Verified? | +|---|---|---| +| `GetMoney()` | PlayerScriptDocumentation.lua | ✅ VERIFIED | +| `GetTime()` | SystemTimeDocumentation.lua | ✅ VERIFIED | +| `MONEY_DISPLAY_UPDATING` | — | ❌ NOT FOUND (unverified) | +| `PLAYER_LOGIN` | SystemDocumentation.lua | ✅ VERIFIED | +| `PLAYER_MONEY` | CurrencyInfoDocumentation.lua | ✅ VERIFIED | +| `PLAYER_LOGOUT` | SystemDocumentation.lua | ✅ VERIFIED | +| `CreateFrame` | FrameAPI docs | ✅ VERIFIED | +| `frame:SetMovable(true)` | SimpleFrameAPIDocumentation.lua | ✅ VERIFIED | +| `frame:EnableMouse(true)` | SimpleScriptRegionAPIDocumentation.lua | ✅ VERIFIED | +| `frame:RegisterForDrag("LeftButton")` | SimpleFrameAPIDocumentation.lua | ✅ VERIFIED | +| `frame:SetScript("OnDragStart", ...)` | Frame scripts | ✅ VERIFIED | +| `frame:SetScript("OnDragStop", ...)` | Frame scripts | ✅ VERIFIED | +| `frame:GetPoint()` | SimpleScriptRegionResizingAPIDocumentation.lua | ✅ VERIFIED | +| `frame:SetPoint()` | SimpleScriptRegionResizingAPIDocumentation.lua | ✅ VERIFIED | +| `frame:SetClampedToScreen(true)` | SimpleFrameAPIDocumentation.lua | ✅ VERIFIED | +| `SlashCmdList` / `SLASH_GT1` | SlashCommandsRegistry.lua.annotated.lua | ✅ VERIFIED | +| `GetMoneyString()` | QuestInfo.lua, MerchantFrame.lua, etc. | ✅ VERIFIED | +| `SecondsToTime()` | SharedBasicControls.lua, Blizzard_TimeManager.lua | ✅ VERIFIED | + +## Design Decisions + +- **Gold per hour**: Shows "---" until 60 seconds have elapsed +- **Frame visible on login**: No — hidden by default, toggled with `/gt` +- **Session survives /reload**: Yes — restored from `lastSession` in SavedVariables +- **Lifetime total**: Accumulated on every positive money change (not only at logout), so Reset doesn't lose gold earned before reset + +## Known Issues + +(None yet) diff --git a/SessionGoldTracker.lua b/SessionGoldTracker.lua new file mode 100644 index 0000000..f39ef1b --- /dev/null +++ b/SessionGoldTracker.lua @@ -0,0 +1,197 @@ +-- SessionGoldTracker — DB Init & Session Restore +-- SavedVariables are auto-declared by the TOC as SessionGoldTrackerDB. + +SessionGoldTrackerDB = SessionGoldTrackerDB or {} + +-- --------------------------------------------------------------------------- +-- Defaults +-- --------------------------------------------------------------------------- +local DEFAULTS = { + position = { point = "CENTER", x = 0, y = 0 }, + lifetimeTotal = 0, + showOnLogin = false, + lastSession = { + sessionStart = 0, + sessionGoldStart = 0, + sessionGross = 0, + sessionNet = 0, + }, +} + +-- Fill in any missing keys +local function FillDefaults(t, defaults) + for k, v in pairs(defaults) do + if t[k] == nil then + if type(v) == "table" then + t[k] = {} + FillDefaults(t[k], v) + else + t[k] = v + end + end + end +end +FillDefaults(SessionGoldTrackerDB, DEFAULTS) + +-- --------------------------------------------------------------------------- +-- Session state (not saved — restored from lastSession on login/reload) +-- --------------------------------------------------------------------------- +local sessionStart = 0 +local sessionGoldStart = 0 +local sessionGross = 0 +local sessionNet = 0 +local lastMoney = 0 + +-- --------------------------------------------------------------------------- +-- Constants +-- --------------------------------------------------------------------------- +local GOLD_PER_HOUR_SHOW_AFTER = 60 -- seconds before showing gph + +-- --------------------------------------------------------------------------- +-- Helper: format copper as gold/silver/copper string +-- --------------------------------------------------------------------------- +local function FormatCopper(copper) + local absCopper = math.abs(copper) + local gold = floor(absCopper / 10000) + local silver = floor((absCopper % 10000) / 100) + local copper = absCopper % 100 + + local str = "" + if gold > 0 then + str = str .. gold .. "g " + end + if silver > 0 or gold > 0 then + str = str .. silver .. "s " + end + str = str .. copper .. "c" + + -- trim trailing space (standard Lua, no str:trim()) + str = str:gsub("^%s+", ""):gsub("%s+$", "") + + return (copper < 0 and "-" or "") .. str +end + +-- --------------------------------------------------------------------------- +-- Frame creation (Step 4: Frame) +-- --------------------------------------------------------------------------- +local frame = CreateFrame("Frame", "SessionGoldTrackerFrame", UIParent) +frame:SetSize(200, 60) +frame:SetFrameStrata("MEDIUM") +frame:SetClampedToScreen(true) +frame:Hide() -- hidden by default, toggled with /gt + +-- Title label +local title = frame:CreateFontString(nil, "OVERLAY", "GameFontNormalSmall") +title:SetPoint("TOPLEFT", frame, "TOPLEFT", 8, -4) +title:SetText("Session Gold Tracker") + +-- Session earned label +local earnedLabel = frame:CreateFontString(nil, "OVERLAY", "GameFontHighlight") +earnedLabel:SetPoint("TOPLEFT", title, "BOTTOMLEFT", 0, -8) +earnedLabel:SetText("Earned: 0c") + +-- Gold per hour label +local gphLabel = frame:CreateFontString(nil, "OVERLAY", "GameFontNormalSmall") +gphLabel:SetPoint("TOPLEFT", earnedLabel, "BOTTOMLEFT", 0, -4) +gphLabel:SetText("Rate: ---") + +-- Time elapsed label +local timeLabel = frame:CreateFontString(nil, "OVERLAY", "GameFontNormalSmall") +timeLabel:SetPoint("TOPLEFT", gphLabel, "BOTTOMLEFT", 0, -4) +timeLabel:SetText("Time: 0s") + +-- Update display function +local function UpdateDisplay() + local elapsed = GetTime() - sessionStart + local hours = elapsed / 3600 + + -- Earned (gross) + earnedLabel:SetText("Earned: " .. FormatCopper(sessionGross)) + + -- Gold per hour (show "---" until threshold) + if elapsed >= GOLD_PER_HOUR_SHOW_AFTER and hours > 0 then + local gph = sessionGross / hours + gphLabel:SetText("Rate: " .. FormatCopper(floor(gph)) .. "/hr") + else + gphLabel:SetText("Rate: ---") + end + + -- Time elapsed + local timeStr = SecondsToTime(elapsed, false, false, 1) + timeLabel:SetText("Time: " .. timeStr) +end + +-- --------------------------------------------------------------------------- +-- PLAYER_LOGIN handler +-- --------------------------------------------------------------------------- +local loginFrame = CreateFrame("Frame") +loginFrame:RegisterEvent("PLAYER_LOGIN") +loginFrame:SetScript("OnEvent", function(self, event) + self:UnregisterEvent(event) + + -- Merge any missing DB keys + FillDefaults(SessionGoldTrackerDB, DEFAULTS) + + -- Restore session state if we have a previous session (e.g. after /reload) + if SessionGoldTrackerDB.lastSession and SessionGoldTrackerDB.lastSession.sessionStart > 0 then + sessionStart = SessionGoldTrackerDB.lastSession.sessionStart + sessionGoldStart = SessionGoldTrackerDB.lastSession.sessionGoldStart + sessionGross = SessionGoldTrackerDB.lastSession.sessionGross or 0 + sessionNet = SessionGoldTrackerDB.lastSession.sessionNet or 0 + else + -- Fresh session + sessionStart = GetTime() + sessionGoldStart = GetMoney() + sessionGross = 0 + sessionNet = 0 + end + + lastMoney = GetMoney() + + print(("[SessionGoldTracker] Session started. Gold: %s"):format(GetMoneyString(sessionGoldStart))) + + -- Restore position + if SessionGoldTrackerDB.position then + local pos = SessionGoldTrackerDB.position + frame:ClearAllPoints() + frame:SetPoint(pos.point, UIParent, pos.point, pos.x, pos.y) + else + frame:ClearAllPoints() + frame:SetPoint("CENTER", UIParent, "CENTER", 0, 0) + end + + -- Show frame if showOnLogin is true + if SessionGoldTrackerDB.showOnLogin then + frame:Show() + end + + -- Start update ticker + frame:SetScript("OnUpdate", function(self, elapsed) + UpdateDisplay() + end) +end) + +-- --------------------------------------------------------------------------- +-- Money tracking (PLAYER_MONEY event) +-- --------------------------------------------------------------------------- +local moneyFrame = CreateFrame("Frame") +moneyFrame:RegisterEvent("PLAYER_MONEY") +moneyFrame:SetScript("OnEvent", function(self, event) + if event == "PLAYER_MONEY" then + local currentMoney = GetMoney() + local delta = currentMoney - lastMoney + + if delta > 0 then + sessionGross = sessionGross + delta + end + sessionNet = sessionNet + delta + + lastMoney = currentMoney + + print(("[SessionGoldTracker] Money change: %s (net: %s, gross: %s)"):format( + GetMoneyString(delta), + GetMoneyString(sessionNet), + GetMoneyString(sessionGross) + )) + end +end) diff --git a/SessionGoldTracker.toc b/SessionGoldTracker.toc new file mode 100644 index 0000000..b9e6078 --- /dev/null +++ b/SessionGoldTracker.toc @@ -0,0 +1,8 @@ +## Interface: 16001 +## Title: Session Gold Tracker +## Notes: Tracks gold earned during a play session since login. +## Author: Drink_Bepis +## Version: 1.0 + +SessionGoldTracker.lua + diff --git a/SessionGoldTracker_Camelot.toc b/SessionGoldTracker_Camelot.toc new file mode 100644 index 0000000..b9e6078 --- /dev/null +++ b/SessionGoldTracker_Camelot.toc @@ -0,0 +1,8 @@ +## Interface: 16001 +## Title: Session Gold Tracker +## Notes: Tracks gold earned during a play session since login. +## Author: Drink_Bepis +## Version: 1.0 + +SessionGoldTracker.lua + diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua new file mode 100644 index 0000000..99d2f17 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua @@ -0,0 +1,17 @@ +---@meta _ +C_AccountInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountInfo.GetIDFromBattleNetAccountGUID) +---@param battleNetAccountGUID WOWGUID +---@return number battleNetAccountID +function C_AccountInfo.GetIDFromBattleNetAccountGUID(battleNetAccountGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountInfo.IsGUIDBattleNetAccountType) +---@param guid WOWGUID +---@return boolean isBNet +function C_AccountInfo.IsGUIDBattleNetAccountType(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountInfo.IsGUIDRelatedToLocalAccount) +---@param guid WOWGUID +---@return boolean isLocalUser +function C_AccountInfo.IsGUIDRelatedToLocalAccount(guid) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua new file mode 100644 index 0000000..b910e25 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua @@ -0,0 +1,85 @@ +---@meta _ +C_AccountStore = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.BeginPurchase) +---@param itemID number +---@return boolean purchaseStarted +function C_AccountStore.BeginPurchase(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetCategories) +---@param storeFrontID number +---@return number[] categories +function C_AccountStore.GetCategories(storeFrontID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetCategoryInfo) +---@param categoryID number +---@return AccountStoreCategoryInfo info +function C_AccountStore.GetCategoryInfo(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetCategoryItems) +---@param categoryID number +---@return number[] itemIDs +function C_AccountStore.GetCategoryItems(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetCurrencyAvailable) +---@param currencyID number +---@return number amount +function C_AccountStore.GetCurrencyAvailable(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetCurrencyIDForStore) +---@param storeFrontID number +---@return number? currencyID +function C_AccountStore.GetCurrencyIDForStore(storeFrontID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetCurrencyInfo) +---@param currencyID number +---@return AccountStoreCurrencyInfo info +function C_AccountStore.GetCurrencyInfo(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetItemInfo) +---@param itemID number +---@return AccountStoreItemInfo? info +function C_AccountStore.GetItemInfo(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.GetStoreFrontState) +---@param storeFrontID number +---@return Enum.AccountStoreState state +function C_AccountStore.GetStoreFrontState(storeFrontID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.RefundItem) +---@param itemID number +---@return boolean refundStarted +function C_AccountStore.RefundItem(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountStore.RequestStoreFrontInfoUpdate) +---@param storeFrontID number +function C_AccountStore.RequestStoreFrontInfoUpdate(storeFrontID) end + +---@class AccountStoreCategoryInfo +---@field id number +---@field name string +---@field type Enum.AccountStoreCategoryType +---@field icon fileID + +---@class AccountStoreCurrencyInfo +---@field id number +---@field amount number +---@field maxQuantity number? +---@field name string +---@field icon fileID + +---@class AccountStoreItemInfo +---@field id number +---@field status Enum.AccountStoreItemStatus +---@field mode Enum.AccountStoreItemMode +---@field currencyID number +---@field flags Enum.AccountStoreItemFlag +---@field customUIModelSceneID number? +---@field name string +---@field description string? +---@field price number +---@field nonrefundable boolean +---@field creatureDisplayID number? +---@field transmogSetID number? +---@field displayIcon fileID? +---@field refundSecondsRemaining time_t? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua new file mode 100644 index 0000000..8be8903 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +C_AchievementInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementInfo.AreGuildAchievementsEnabled) +---@return boolean enabled +function C_AchievementInfo.AreGuildAchievementsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementInfo.GetRewardItemID) +---@param achievementID number +---@return number? rewardItemID +function C_AchievementInfo.GetRewardItemID(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementInfo.GetSupercedingAchievements) +---@param achievementID number +---@return number[] supercedingAchievements +function C_AchievementInfo.GetSupercedingAchievements(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementInfo.IsGuildAchievement) +---@param achievementId number +---@return boolean isGuild +function C_AchievementInfo.IsGuildAchievement(achievementId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementInfo.IsValidAchievement) +---@param achievementId number +---@return boolean isValidAchievement +function C_AchievementInfo.IsValidAchievement(achievementId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementInfo.SetPortraitTexture) +---@param textureObject SimpleTexture +function C_AchievementInfo.SetPortraitTexture(textureObject) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua new file mode 100644 index 0000000..59ad9a7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +C_AchievementTelemetry = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementTelemetry.LinkAchievementInClub) +---@param achievementID number +function C_AchievementTelemetry.LinkAchievementInClub(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementTelemetry.LinkAchievementInWhisper) +---@param achievementID number +function C_AchievementTelemetry.LinkAchievementInWhisper(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AchievementTelemetry.ShowAchievements) +function C_AchievementTelemetry.ShowAchievements() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua new file mode 100644 index 0000000..2470aa6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua @@ -0,0 +1,359 @@ +---@meta _ +C_ActionBar = {} + +---Used in conjunction with ActionRangeCheckUpdate to inform the UI when an action goes in or out of range with its current target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.EnableActionRangeCheck) +---@param actionID number +---@param enable boolean +function C_ActionBar.EnableActionRangeCheck(actionID, enable) end + +---Returns the list of action bar slots that contain the Assisted Combat action spell. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.FindAssistedCombatActionButtons) +---@return number[] slots +function C_ActionBar.FindAssistedCombatActionButtons() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.FindFlyoutActionButtons) +---@param flyoutID number +---@return number[] slots +function C_ActionBar.FindFlyoutActionButtons(flyoutID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.FindPetActionButtons) +---@param petActionID number +---@return number[] slots +function C_ActionBar.FindPetActionButtons(petActionID) end + +---Returns the list of action bar slots that contain a specified spell. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.FindSpellActionButtons) +---@param spellID SpellIdentifier +---@return number[] slots +function C_ActionBar.FindSpellActionButtons(spellID) end + +---Force updates some internals for an action button slot. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.ForceUpdateAction) +---@param slotID number +function C_ActionBar.ForceUpdateAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionAutocast) +---@param actionID number +---@return boolean autocastAllowed +---@return boolean autocastEnabled +function C_ActionBar.GetActionAutocast(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionBarPage) +---@return number currentPage +function C_ActionBar.GetActionBarPage() end + +---Returns a duration object describing the active recharge time for an action. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionChargeDuration) +---@param actionID number +---@return LuaDurationObject duration +function C_ActionBar.GetActionChargeDuration(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionCharges) +---@param actionID number +---@return SpellChargeInfo chargeInfo +function C_ActionBar.GetActionCharges(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionCooldown) +---@param actionID number +---@return SpellCooldownInfo cooldownInfo +function C_ActionBar.GetActionCooldown(actionID) end + +---Returns a duration object describing the active cooldown duration for an action. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionCooldownDuration) +---@param actionID number +---@param ignoreGCD? boolean Default = false +---@return LuaDurationObject duration +function C_ActionBar.GetActionCooldownDuration(actionID, ignoreGCD) end + +---Depending on the action type, return a string that is either the use count or number of charges. If value is beyond the display count parameter, returns the replacementString (defaults to '*'). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionDisplayCount) +---@param actionID number +---@param maxDisplayCount? number Default = 9999 +---@param replacementString? string Default = * +---@return string displayCount +function C_ActionBar.GetActionDisplayCount(actionID, maxDisplayCount, replacementString) end + +---Returns a duration object describing the active loss of control cooldown duration for an action. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionLossOfControlCooldownDuration) +---@param actionID number +---@return LuaDurationObject duration +function C_ActionBar.GetActionLossOfControlCooldownDuration(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionLossOfControlCooldownInfo) +---@param actionID number +---@return SpellLossOfControlInfo lossOfControlInfo +function C_ActionBar.GetActionLossOfControlCooldownInfo(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionText) +---@param actionID number +---@return string text +function C_ActionBar.GetActionText(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionTexture) +---@param actionID number +---@return fileID textureFileID +function C_ActionBar.GetActionTexture(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetActionUseCount) +---@param actionID number +---@return number count +function C_ActionBar.GetActionUseCount(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetBonusBarIndex) +---@return number bonusBarIndex +function C_ActionBar.GetBonusBarIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetBonusBarIndexForSlot) +---@param slotID number +---@return number? bonusBarIndex +function C_ActionBar.GetBonusBarIndexForSlot(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetBonusBarOffset) +---@return number bonusBarOffset +function C_ActionBar.GetBonusBarOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetExtraBarIndex) +---@return number extraBarIndex +function C_ActionBar.GetExtraBarIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetItemActionOnEquipSpellID) +---@param actionID number +---@return number? onEquipSpellID +function C_ActionBar.GetItemActionOnEquipSpellID(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetMultiCastBarIndex) +---@return number multiCastBarIndex +function C_ActionBar.GetMultiCastBarIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetOverrideBarIndex) +---@return number overrideBarIndex +function C_ActionBar.GetOverrideBarIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetOverrideBarSkin) +---@return fileID? textureFileID +function C_ActionBar.GetOverrideBarSkin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetPetActionPetBarIndices) +---@param petActionID number +---@return number[] slots +function C_ActionBar.GetPetActionPetBarIndices(petActionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetProfessionQuality) +---@param actionID number +---@return number? quality +function C_ActionBar.GetProfessionQuality(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetProfessionQualityInfo) +---@param actionID number +---@return CraftingQualityInfo? info +function C_ActionBar.GetProfessionQualityInfo(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetSpell) +---@param actionID number +---@return number spellID +function C_ActionBar.GetSpell(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetTempShapeshiftBarIndex) +---@return number tempShapeshiftBarIndex +function C_ActionBar.GetTempShapeshiftBarIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.GetVehicleBarIndex) +---@return number vehicleBarIndex +function C_ActionBar.GetVehicleBarIndex() end + +---Returns true if an actionbar slot is populated with an action. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasAction) +---@param actionID number +---@return boolean hasAction +function C_ActionBar.HasAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasAssistedCombatActionButtons) +---@return boolean hasButtons +function C_ActionBar.HasAssistedCombatActionButtons() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasBonusActionBar) +---@return boolean hasBonusActionBar +function C_ActionBar.HasBonusActionBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasExtraActionBar) +---@return boolean hasExtraActionBar +function C_ActionBar.HasExtraActionBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasFlyoutActionButtons) +---@param flyoutID number +---@return boolean hasFlyoutActionButtons +function C_ActionBar.HasFlyoutActionButtons(flyoutID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasOverrideActionBar) +---@return boolean hasOverrideActionBar +function C_ActionBar.HasOverrideActionBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasPetActionButtons) +---@param petActionID number +---@return boolean hasPetActionButtons +function C_ActionBar.HasPetActionButtons(petActionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasPetActionPetBarIndices) +---@param petActionID number +---@return boolean hasPetActionPetBarIndices +function C_ActionBar.HasPetActionPetBarIndices(petActionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasRangeRequirements) +---@param actionID number +---@return boolean hasRangeRequirements +function C_ActionBar.HasRangeRequirements(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasSpellActionButtons) +---@param spellID SpellIdentifier +---@return boolean hasSpellActionButtons +function C_ActionBar.HasSpellActionButtons(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasTempShapeshiftActionBar) +---@return boolean hasTempShapeshiftActionBar +function C_ActionBar.HasTempShapeshiftActionBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.HasVehicleActionBar) +---@return boolean hasVehicleActionBar +function C_ActionBar.HasVehicleActionBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsActionInRange) +---@param actionID number +---@param target? UnitToken +---@return boolean? isInRange +function C_ActionBar.IsActionInRange(actionID, target) end + +---Returns whether the given action button contains the Assisted Combat action spell. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsAssistedCombatAction) +---@param slotID number +---@return boolean isAssistedCombatAction +function C_ActionBar.IsAssistedCombatAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsAttackAction) +---@param actionID number +---@return boolean isAttackAction +function C_ActionBar.IsAttackAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsAutoCastPetAction) +---@param slotID number +---@return boolean isAutoCastPetAction +function C_ActionBar.IsAutoCastPetAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsAutoRepeatAction) +---@param actionID number +---@return boolean isAutoRepeatAction +function C_ActionBar.IsAutoRepeatAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsConsumableAction) +---@param actionID number +---@return boolean isConsumableAction +function C_ActionBar.IsConsumableAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsCurrentAction) +---@param actionID number +---@return boolean isCurrentAction +function C_ActionBar.IsCurrentAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsEnabledAutoCastPetAction) +---@param slotID number +---@return boolean isEnabledAutoCastPetAction +function C_ActionBar.IsEnabledAutoCastPetAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsEquippedAction) +---@param actionID number +---@return boolean isEquippedAction +function C_ActionBar.IsEquippedAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsEquippedGearOutfitAction) +---@param slotID number +---@return boolean isEquippedGearOutfitAction +function C_ActionBar.IsEquippedGearOutfitAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsHarmfulAction) +---@param actionID number +---@param useNeutral boolean +---@return boolean isHarmful +function C_ActionBar.IsHarmfulAction(actionID, useNeutral) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsHelpfulAction) +---@param actionID number +---@param useNeutral boolean +---@return boolean isHelpful +function C_ActionBar.IsHelpfulAction(actionID, useNeutral) end + +---Returns whether the given action button contains a spell that can interrupt spellcasting. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsInterruptAction) +---@param slotID number +---@return boolean isInterruptAction +function C_ActionBar.IsInterruptAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsItemAction) +---@param actionID number +---@return boolean isItemAction +function C_ActionBar.IsItemAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsOnBarOrSpecialBar) +---@param spellID SpellIdentifier +---@return boolean isOnBarOrSpecialBar +function C_ActionBar.IsOnBarOrSpecialBar(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsPossessBarVisible) +---@return boolean isPossessBarVisible +function C_ActionBar.IsPossessBarVisible() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsStackableAction) +---@param actionID number +---@return boolean isStackableAction +function C_ActionBar.IsStackableAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.IsUsableAction) +---@param actionID number +---@return boolean isUsable +---@return boolean isLackingResources +function C_ActionBar.IsUsableAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.PutActionInSlot) +---@param slotID number +function C_ActionBar.PutActionInSlot(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.RegisterActionUIButton) +---@param checkboxFrame SimpleCheckbox +---@param actionID number +---@param cooldownFrame CooldownFrame +function C_ActionBar.RegisterActionUIButton(checkboxFrame, actionID, cooldownFrame) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.SetActionBarPage) +---@param pageIndex number +function C_ActionBar.SetActionBarPage(pageIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.ShouldOverrideBarShowHealthBar) +---@return boolean showHealthBar +function C_ActionBar.ShouldOverrideBarShowHealthBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.ShouldOverrideBarShowManaBar) +---@return boolean showManaBar +function C_ActionBar.ShouldOverrideBarShowManaBar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.ToggleAutoCastPetAction) +---@param slotID number +function C_ActionBar.ToggleAutoCastPetAction(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.UnregisterActionUIButton) +---@param checkboxFrame SimpleCheckbox +function C_ActionBar.UnregisterActionUIButton(checkboxFrame) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ActionBar.UsesActionText) +---@param actionID number +---@return boolean usesActionText +function C_ActionBar.UsesActionText(actionID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua new file mode 100644 index 0000000..e06f68f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua @@ -0,0 +1,5 @@ +---@meta _ +---@class ActionUsableState +---@field slot number +---@field usable boolean +---@field noMana boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua new file mode 100644 index 0000000..8631092 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua @@ -0,0 +1,96 @@ +---@meta _ +C_AddOnProfiler = {} + +---Adds a measured event to any ongoing measured calls. If no such calls are currently taking place, this function does nothing. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.AddMeasuredCallEvent) +---@param name stringView +function C_AddOnProfiler.AddMeasuredCallEvent(name) end + +---Internal API for telemetry. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.AddPerformanceMessageShown) +---@param msg AddOnPerformanceMessage +function C_AddOnProfiler.AddPerformanceMessageShown(msg) end + +---Optimized check for determining if AddOns are severely impacting UI performance. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.CheckForPerformanceMessage) +---@return AddOnPerformanceMessage msg +function C_AddOnProfiler.CheckForPerformanceMessage() end + +---Gets an AddOn profiler value - all times returned are in milliseconds. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.GetAddOnMetric) +---@param name string +---@param metric Enum.AddOnProfilerMetric +---@return number result +function C_AddOnProfiler.GetAddOnMetric(name, metric) end + +---Overall profiling data for the entire application (not just the UI) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.GetApplicationMetric) +---@param metric Enum.AddOnProfilerMetric +---@return number result +function C_AddOnProfiler.GetApplicationMetric(metric) end + +---Overall profiling data for all addons +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.GetOverallMetric) +---@param metric Enum.AddOnProfilerMetric +---@return number result +function C_AddOnProfiler.GetOverallMetric(metric) end + +---Returns the number of profiling clock ticks that occur within a single real-time second. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.GetTicksPerSecond) +---@return BigInteger frequency +function C_AddOnProfiler.GetTicksPerSecond() end + +---Gets top K AddOns for a given metric. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.GetTopKAddOnsForMetric) +---@param metric Enum.AddOnProfilerMetric +---@param k number +---@return AddOnProfilerResult[] results +function C_AddOnProfiler.GetTopKAddOnsForMetric(metric, k) end + +---AddOn profiler will be enabled for all users, but this will return false if it ever isn't +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.IsEnabled) +---@return boolean enabled +function C_AddOnProfiler.IsEnabled() end + +---Performs a profiled measurement of a single function call with any supplied arguments. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOnProfiler.MeasureCall) +---@param func LuaValueVariant +---@param ... LuaValueVariant arguments +---@return AddOnProfilerCallResults results +---@return LuaValueVariant ... returns +function C_AddOnProfiler.MeasureCall(func, ...) end + +---@class AddOnPerformanceMessage +---@field type Enum.AddOnPerformanceMessageType +---@field metric Enum.AddOnProfilerMetric +---@field addOnName string? +---@field metricValue number +---@field thresholdValue number + +---@class AddOnProfilerCallEvent +---@field name string +---@field allocatedBytes BigUInteger +---@field deallocatedBytes BigUInteger +---@field elapsedMilliseconds number +---@field elapsedTicks BigInteger + +---@class AddOnProfilerCallResults +---@field elapsedMilliseconds number +---@field elapsedTicks BigInteger +---@field allocatedBytes BigUInteger +---@field deallocatedBytes BigUInteger +---@field events AddOnProfilerCallEvent[] + +---@class AddOnProfilerResult +---@field addOnName string +---@field metricValue number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua new file mode 100644 index 0000000..9aff3e4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua @@ -0,0 +1,161 @@ +---@meta _ +C_AddOns = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.DisableAddOn) +---@param name uiAddon +---@param character? string Default = 0 +function C_AddOns.DisableAddOn(name, character) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.DisableAllAddOns) +---@param character? string +function C_AddOns.DisableAllAddOns(character) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.DoesAddOnExist) +---@param name uiAddon +---@return boolean exists +function C_AddOns.DoesAddOnExist(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.DoesAddOnHaveLoadError) +---@param name uiAddon +---@return boolean hadError +function C_AddOns.DoesAddOnHaveLoadError(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.EnableAddOn) +---@param name uiAddon +---@param character? string Default = 0 +function C_AddOns.EnableAddOn(name, character) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.EnableAllAddOns) +---@param character? string +function C_AddOns.EnableAllAddOns(character) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnDependencies) +---@param name uiAddon +---@return string ... deps +function C_AddOns.GetAddOnDependencies(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnEnableState) +---@param name uiAddon +---@param character? string Default = 0 +---@return Enum.AddOnEnableState state +function C_AddOns.GetAddOnEnableState(name, character) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnInfo) +---@param name uiAddon +---@return string name +---@return string title +---@return string notes +---@return boolean loadable +---@return string reason +---@return string security +function C_AddOns.GetAddOnInfo(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnInterfaceVersion) +---@param name uiAddon +---@return number interfaceVersion +function C_AddOns.GetAddOnInterfaceVersion(name) end + +---Returns the addon table (passed as the second argument of ... to files) for any addon that opts in through setting AllowAddOnTableAccess: 1 in the toc file. Insecure code cannot query addon tables from Blizzard addons. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnLocalTable) +---@param name uiAddon +---@return LuaValueVariant table +function C_AddOns.GetAddOnLocalTable(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnMetadata) +---@param name uiAddon +---@param variable string +---@return string? value +function C_AddOns.GetAddOnMetadata(name, variable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnName) +---@param index uiAddon +---@return string name +function C_AddOns.GetAddOnName(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnNotes) +---@param name uiAddon +---@return string notes +function C_AddOns.GetAddOnNotes(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnOptionalDependencies) +---@param name uiAddon +---@return string ... deps +function C_AddOns.GetAddOnOptionalDependencies(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnSecurity) +---@param name uiAddon +---@return Enum.AddOnSecurityStatus security +function C_AddOns.GetAddOnSecurity(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetAddOnTitle) +---@param name uiAddon +---@return string title +function C_AddOns.GetAddOnTitle(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetNumAddOns) +---@return number numAddOns +function C_AddOns.GetNumAddOns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.GetScriptsDisallowedForBeta) +---@return boolean disallowed +function C_AddOns.GetScriptsDisallowedForBeta() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.IsAddOnDefaultEnabled) +---@param name uiAddon +---@return boolean defaultEnabled +function C_AddOns.IsAddOnDefaultEnabled(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.IsAddOnLoadOnDemand) +---@param name uiAddon +---@return boolean loadOnDemand +function C_AddOns.IsAddOnLoadOnDemand(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.IsAddOnLoadable) +---@param name uiAddon +---@param character? string Default = 0 +---@param demandLoaded? boolean Default = false +---@return boolean loadable +---@return string reason +function C_AddOns.IsAddOnLoadable(name, character, demandLoaded) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.IsAddOnLoaded) +---@param name uiAddon +---@return boolean loadedOrLoading +---@return boolean loaded +function C_AddOns.IsAddOnLoaded(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.IsAddonVersionCheckEnabled) +---@return boolean isEnabled +function C_AddOns.IsAddonVersionCheckEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.LoadAddOn) +---@param name uiAddon +---@return boolean? loaded +---@return string? value +function C_AddOns.LoadAddOn(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.ResetAddOns) +function C_AddOns.ResetAddOns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.ResetDisabledAddOns) +function C_AddOns.ResetDisabledAddOns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.SaveAddOns) +function C_AddOns.SaveAddOns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AddOns.SetAddonVersionCheck) +---@param enabled boolean +function C_AddOns.SetAddonVersionCheck(enabled) end + +---@class AddOnInfo +---@field name string +---@field title string +---@field notes string +---@field loadable boolean +---@field reason string +---@field security string + +---@class AddOnLoadableInfo +---@field loadable boolean +---@field reason string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua new file mode 100644 index 0000000..f91668a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua @@ -0,0 +1,18 @@ +---@meta _ +C_AdventureMap = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetAdventureMapTextureKit) +---@return textureKit adventureMapTextureKit +function C_AdventureMap.GetAdventureMapTextureKit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetQuestPortraitInfo) +---@param questID number +---@return AdventureMapQuestPortraitInfo info +function C_AdventureMap.GetQuestPortraitInfo(questID) end + +---@class AdventureMapQuestPortraitInfo +---@field portraitDisplayID number +---@field mountPortraitDisplayID number +---@field name string +---@field text string +---@field modelSceneID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua new file mode 100644 index 0000000..6c1652d --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +C_AlliedRaces = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AlliedRaces.GetAllRacialAbilitiesFromID) +---@param raceID number +---@return AlliedRaceRacialAbility[] allDisplayInfo +function C_AlliedRaces.GetAllRacialAbilitiesFromID(raceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AlliedRaces.GetRaceInfoByID) +---@param raceID number +---@return AlliedRaceInfo info +function C_AlliedRaces.GetRaceInfoByID(raceID) end + +---@class AlliedRaceInfo +---@field raceID number +---@field maleModelID number +---@field femaleModelID number +---@field achievementIds number[] +---@field maleName string +---@field femaleName string +---@field description string +---@field raceFileString string +---@field crestAtlas textureAtlas +---@field modelBackgroundAtlas textureAtlas +---@field bannerColor colorRGB + +---@class AlliedRaceRacialAbility +---@field description string +---@field name string +---@field icon fileID diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua new file mode 100644 index 0000000..bc32320 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua @@ -0,0 +1,48 @@ +---@meta _ +C_AnimaDiversion = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.CloseUI) +function C_AnimaDiversion.CloseUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.GetAnimaDiversionNodes) +---@return AnimaDiversionNodeInfo[] animaNodes +function C_AnimaDiversion.GetAnimaDiversionNodes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.GetOriginPosition) +---@return vector2? normalizedPosition +function C_AnimaDiversion.GetOriginPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.GetReinforceProgress) +---@return number progress +function C_AnimaDiversion.GetReinforceProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.GetTextureKit) +---@return textureKit textureKit +function C_AnimaDiversion.GetTextureKit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.OpenAnimaDiversionUI) +function C_AnimaDiversion.OpenAnimaDiversionUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AnimaDiversion.SelectAnimaNode) +---@param talentID number +---@param temporary boolean +function C_AnimaDiversion.SelectAnimaNode(talentID, temporary) end + +---@class AnimaDiversionCostInfo +---@field currencyID number +---@field quantity number + +---@class AnimaDiversionFrameInfo +---@field textureKit textureKit +---@field title string +---@field mapID number + +---@class AnimaDiversionNodeInfo +---@field talentID number +---@field name string +---@field description string +---@field costs AnimaDiversionCostInfo[] +---@field currencyID number +---@field icon number +---@field normalizedPosition vector2 +---@field state Enum.AnimaDiversionNodeState diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua new file mode 100644 index 0000000..3fdcd7f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua @@ -0,0 +1,20 @@ +---@meta _ +---@class AppearanceSourceInfo +---@field visualID number +---@field sourceID number +---@field isCollected boolean +---@field itemID number +---@field itemModID number +---@field invType number? Default = 0 +---@field categoryID Enum.TransmogCollectionType? Default = None +---@field playerCanCollect boolean +---@field isValidSourceForPlayer boolean +---@field canDisplayOnPlayer boolean +---@field inventorySlot number? +---@field sourceType number? +---@field name string? +---@field quality number? +---@field useError string? +---@field useErrorType Enum.TransmogUseErrorType? +---@field meetsTransmogPlayerCondition boolean? +---@field isHideVisual boolean? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua new file mode 100644 index 0000000..ca14fc8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua @@ -0,0 +1,15 @@ +---@meta _ +C_ArdenwealdGardening = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArdenwealdGardening.GetGardenData) +---@return ArdenwealdGardenData data +function C_ArdenwealdGardening.GetGardenData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArdenwealdGardening.IsGardenAccessible) +---@return boolean accessible +function C_ArdenwealdGardening.IsGardenAccessible() end + +---@class ArdenwealdGardenData +---@field active number +---@field ready number +---@field remainingSeconds time_t diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua new file mode 100644 index 0000000..8432a2a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua @@ -0,0 +1,78 @@ +---@meta _ +C_AreaPoiInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetAreaPOIForMap) +---@param uiMapID number +---@return number[] areaPoiIDs +function C_AreaPoiInfo.GetAreaPOIForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetAreaPOIInfo) +---@param uiMapID? number +---@param areaPoiID number +---@return AreaPOIInfo poiInfo +function C_AreaPoiInfo.GetAreaPOIInfo(uiMapID, areaPoiID) end + +---Returns the number of seconds until the POI expires. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetAreaPOISecondsLeft) +---@param areaPoiID number +---@return number secondsLeft +function C_AreaPoiInfo.GetAreaPOISecondsLeft(areaPoiID) end + +---Returns all area POIInfos flagged as delves for the given map. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetDelvesForMap) +---@param uiMapID number +---@return number[] areaPoiIDs +function C_AreaPoiInfo.GetDelvesForMap(uiMapID) end + +---Returns all area POIInfos flagged as dragonriding races for the given map. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetDragonridingRacesForMap) +---@param uiMapID number +---@return number[] areaPoiIDs +function C_AreaPoiInfo.GetDragonridingRacesForMap(uiMapID) end + +---Returns all area POIInfos flagged as events for the given map. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetEventsForMap) +---@param uiMapID number +---@return number[] areaPoiIDs +function C_AreaPoiInfo.GetEventsForMap(uiMapID) end + +---Returns all area POIInfos flagged as quest hubs for the given map. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.GetQuestHubsForMap) +---@param uiMapID number +---@return number[] areaPoiIDs +function C_AreaPoiInfo.GetQuestHubsForMap(uiMapID) end + +---This statically determines if the POI is timed, GetAreaPOITimeLeft retrieves the value from the server and may return nothing for long intervals +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AreaPoiInfo.IsAreaPOITimed) +---@param areaPoiID number +---@return boolean isTimed +---@return boolean? hideTimerInTooltip +function C_AreaPoiInfo.IsAreaPOITimed(areaPoiID) end + +---@class AreaPOIInfo +---@field areaPoiID number +---@field position vector2 +---@field name string +---@field description string? +---@field linkedUiMapID number? +---@field textureIndex number? +---@field tooltipWidgetSet number? +---@field iconWidgetSet number? +---@field atlasName string? +---@field uiTextureKit textureKit? +---@field shouldGlow boolean +---@field factionID number? +---@field isPrimaryMapForPOI boolean +---@field isAlwaysOnFlightmap boolean +---@field addPaddingAboveTooltipWidgets boolean? +---@field highlightWorldQuestsOnHover boolean +---@field highlightVignettesOnHover boolean +---@field isCurrentEvent boolean +---@field isSuppressible boolean +---@field isLocked boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArenaTeamDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArenaTeamDocumentation.lua new file mode 100644 index 0000000..b34e8c0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArenaTeamDocumentation.lua @@ -0,0 +1,29 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptArenaTeam) +function AcceptArenaTeam() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArenaTeamDisband) +---@param index number +function ArenaTeamDisband(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArenaTeamInviteByName) +---@param index number +---@param target string +function ArenaTeamInviteByName(index, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArenaTeamLeave) +---@param index number +function ArenaTeamLeave(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArenaTeamSetLeaderByName) +---@param index number +---@param target string +function ArenaTeamSetLeaderByName(index, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArenaTeamUninviteByName) +---@param index number +---@param target string +function ArenaTeamUninviteByName(index, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineArenaTeam) +function DeclineArenaTeam() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua new file mode 100644 index 0000000..ec5046b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua @@ -0,0 +1,432 @@ +---@meta _ +C_ArtifactUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.AddPower) +---@param powerID number +---@return boolean success +function C_ArtifactUI.AddPower(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.ApplyCursorRelicToSlot) +---@param relicSlotIndex number +function C_ArtifactUI.ApplyCursorRelicToSlot(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.CanApplyArtifactRelic) +---@param relicItemID number +---@param onlyUnlocked boolean +---@return boolean canApply +function C_ArtifactUI.CanApplyArtifactRelic(relicItemID, onlyUnlocked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.CanApplyCursorRelicToSlot) +---@param relicSlotIndex number +---@return boolean canApply +function C_ArtifactUI.CanApplyCursorRelicToSlot(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot) +---@param relicItemID number +---@param relicSlotIndex number +---@return boolean canApply +function C_ArtifactUI.CanApplyRelicItemIDToEquippedArtifactSlot(relicItemID, relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.CanApplyRelicItemIDToSlot) +---@param relicItemID number +---@param relicSlotIndex number +---@return boolean canApply +function C_ArtifactUI.CanApplyRelicItemIDToSlot(relicItemID, relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.CheckRespecNPC) +---@return boolean canRespec +function C_ArtifactUI.CheckRespecNPC() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.Clear) +function C_ArtifactUI.Clear() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.ClearForgeCamera) +function C_ArtifactUI.ClearForgeCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.ConfirmRespec) +function C_ArtifactUI.ConfirmRespec() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted) +---@return boolean hasAnyRelicsSlotted +function C_ArtifactUI.DoesEquippedArtifactHaveAnyRelicsSlotted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetAppearanceInfo) +---@param appearanceSetIndex number +---@param appearanceIndex number +---@return number artifactAppearanceID +---@return string appearanceName +---@return number displayIndex +---@return boolean unlocked +---@return string? failureDescription +---@return number uiCameraID +---@return number? altHandCameraID +---@return number swatchColorR +---@return number swatchColorG +---@return number swatchColorB +---@return number modelOpacity +---@return number modelSaturation +---@return boolean obtainable +function C_ArtifactUI.GetAppearanceInfo(appearanceSetIndex, appearanceIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetAppearanceInfoByID) +---@param artifactAppearanceID number +---@return number artifactAppearanceSetID +---@return number artifactAppearanceID +---@return string appearanceName +---@return number displayIndex +---@return boolean unlocked +---@return string? failureDescription +---@return number uiCameraID +---@return number? altHandCameraID +---@return number swatchColorR +---@return number swatchColorG +---@return number swatchColorB +---@return number modelOpacity +---@return number modelSaturation +---@return boolean obtainable +function C_ArtifactUI.GetAppearanceInfoByID(artifactAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetAppearanceSetInfo) +---@param appearanceSetIndex number +---@return number artifactAppearanceSetID +---@return string appearanceSetName +---@return string appearanceSetDescription +---@return number numAppearances +function C_ArtifactUI.GetAppearanceSetInfo(appearanceSetIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetArtifactArtInfo) +---@return ArtifactArtInfo artifactArtInfo +function C_ArtifactUI.GetArtifactArtInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetArtifactInfo) +---@return number itemID +---@return number? altItemID +---@return string name +---@return fileID icon +---@return number xp +---@return number pointsSpent +---@return number quality +---@return number artifactAppearanceID +---@return number appearanceModID +---@return number? itemAppearanceID +---@return number? altItemAppearanceID +---@return boolean altOnTop +---@return ArtifactTiers tier +function C_ArtifactUI.GetArtifactInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetArtifactItemID) +---@return number itemID +function C_ArtifactUI.GetArtifactItemID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetArtifactTier) +---@return ArtifactTiers? tier +function C_ArtifactUI.GetArtifactTier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetArtifactXPRewardTargetInfo) +---@param artifactCategoryID number +---@return string name +---@return fileID icon +function C_ArtifactUI.GetArtifactXPRewardTargetInfo(artifactCategoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetCostForPointAtRank) +---@param rank number +---@param tier ArtifactTiers +---@return number cost +function C_ArtifactUI.GetCostForPointAtRank(rank, tier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetEquippedArtifactArtInfo) +---@return ArtifactArtInfo artifactArtInfo +function C_ArtifactUI.GetEquippedArtifactArtInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetEquippedArtifactInfo) +---@return number itemID +---@return number? altItemID +---@return string name +---@return fileID icon +---@return number xp +---@return number pointsSpent +---@return number quality +---@return number artifactAppearanceID +---@return number appearanceModID +---@return number? itemAppearanceID +---@return number? altItemAppearanceID +---@return boolean altOnTop +---@return ArtifactTiers tier +function C_ArtifactUI.GetEquippedArtifactInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetEquippedArtifactItemID) +---@return number itemID +function C_ArtifactUI.GetEquippedArtifactItemID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetEquippedArtifactNumRelicSlots) +---@param onlyUnlocked? boolean Default = false +---@return number numRelicSlots +function C_ArtifactUI.GetEquippedArtifactNumRelicSlots(onlyUnlocked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetEquippedArtifactRelicInfo) +---@param relicSlotIndex number +---@return string name +---@return fileID icon +---@return string slotTypeName +---@return string link +function C_ArtifactUI.GetEquippedArtifactRelicInfo(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetEquippedRelicLockedReason) +---@param relicSlotIndex number +---@return string? lockedReason +function C_ArtifactUI.GetEquippedRelicLockedReason(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetForgeRotation) +---@return number forgeRotationX +---@return number forgeRotationY +---@return number forgeRotationZ +function C_ArtifactUI.GetForgeRotation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic) +---@param itemLinkOrID ItemInfo +---@return number itemIevelIncrease +function C_ArtifactUI.GetItemLevelIncreaseProvidedByRelic(itemLinkOrID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetMetaPowerInfo) +---@return number ... spellID +---@return number ... powerCost +---@return number ... currentRank +function C_ArtifactUI.GetMetaPowerInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetNumAppearanceSets) +---@return number numAppearanceSets +function C_ArtifactUI.GetNumAppearanceSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetNumObtainedArtifacts) +---@return number numObtainedArtifacts +function C_ArtifactUI.GetNumObtainedArtifacts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetNumRelicSlots) +---@param onlyUnlocked? boolean Default = false +---@return number numRelicSlots +function C_ArtifactUI.GetNumRelicSlots(onlyUnlocked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPointsRemaining) +---@return number pointsRemaining +function C_ArtifactUI.GetPointsRemaining() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPowerHyperlink) +---@param powerID number +---@return string link +function C_ArtifactUI.GetPowerHyperlink(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPowerInfo) +---@param powerID number +---@return ArtifactPowerInfo powerInfo +function C_ArtifactUI.GetPowerInfo(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPowerLinks) +---@param powerID number +---@return number[] linkingPowerID +function C_ArtifactUI.GetPowerLinks(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPowers) +---@return number[] powerID +function C_ArtifactUI.GetPowers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPowersAffectedByRelic) +---@param relicSlotIndex number +---@return number ... powerIDs +function C_ArtifactUI.GetPowersAffectedByRelic(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPowersAffectedByRelicItemLink) +---@param relicItemInfo ItemInfo +---@return number ... powerIDs +function C_ArtifactUI.GetPowersAffectedByRelicItemLink(relicItemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetPreviewAppearance) +---@return number? artifactAppearanceID +function C_ArtifactUI.GetPreviewAppearance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRelicInfo) +---@param relicSlotIndex number +---@return string name +---@return fileID icon +---@return string slotTypeName +---@return string link +function C_ArtifactUI.GetRelicInfo(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRelicInfoByItemID) +---@param itemID number +---@return string name +---@return fileID icon +---@return string slotTypeName +---@return string link +function C_ArtifactUI.GetRelicInfoByItemID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRelicLockedReason) +---@param relicSlotIndex number +---@return string? lockedReason +function C_ArtifactUI.GetRelicLockedReason(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRelicSlotType) +---@param relicSlotIndex number +---@return string slotTypeName +function C_ArtifactUI.GetRelicSlotType(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRespecArtifactArtInfo) +---@return ArtifactArtInfo artifactArtInfo +function C_ArtifactUI.GetRespecArtifactArtInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRespecArtifactInfo) +---@return number itemID +---@return number? altItemID +---@return string name +---@return fileID icon +---@return number xp +---@return number pointsSpent +---@return number quality +---@return number artifactAppearanceID +---@return number appearanceModID +---@return number? itemAppearanceID +---@return number? altItemAppearanceID +---@return boolean altOnTop +---@return ArtifactTiers tier +function C_ArtifactUI.GetRespecArtifactInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetRespecCost) +---@return number cost +function C_ArtifactUI.GetRespecCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetTotalPowerCost) +---@param startingTrait number +---@param numTraits number +---@param artifactTier ArtifactTiers +---@return number totalArtifactPowerCost +function C_ArtifactUI.GetTotalPowerCost(startingTrait, numTraits, artifactTier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.GetTotalPurchasedRanks) +---@return number totalPurchasedRanks +function C_ArtifactUI.GetTotalPurchasedRanks() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsArtifactDisabled) +---@return boolean artifactDisabled +function C_ArtifactUI.IsArtifactDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsArtifactItem) +---@param itemLocation ItemLocation +---@return boolean isArtifact +function C_ArtifactUI.IsArtifactItem(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsAtForge) +---@return boolean isAtForge +function C_ArtifactUI.IsAtForge() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsEquippedArtifactDisabled) +---@return boolean artifactDisabled +function C_ArtifactUI.IsEquippedArtifactDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsEquippedArtifactMaxed) +---@return boolean artifactMaxed +function C_ArtifactUI.IsEquippedArtifactMaxed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsMaxedByRulesOrEffect) +---@return boolean isEffectivelyMaxed +function C_ArtifactUI.IsMaxedByRulesOrEffect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsPowerKnown) +---@param powerID number +---@return boolean known +function C_ArtifactUI.IsPowerKnown(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.IsViewedArtifactEquipped) +---@return boolean isViewedArtifactEquipped +function C_ArtifactUI.IsViewedArtifactEquipped() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.SetAppearance) +---@param artifactAppearanceID number +function C_ArtifactUI.SetAppearance(artifactAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.SetForgeCamera) +function C_ArtifactUI.SetForgeCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.SetForgeRotation) +---@param forgeRotationX number +---@param forgeRotationY number +---@param forgeRotationZ number +function C_ArtifactUI.SetForgeRotation(forgeRotationX, forgeRotationY, forgeRotationZ) end + +---Call without an argument to clear the preview. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.SetPreviewAppearance) +---@param artifactAppearanceID? number Default = 0 +function C_ArtifactUI.SetPreviewAppearance(artifactAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArtifactUI.ShouldSuppressForgeRotation) +---@return boolean shouldSuppressForgeRotation +function C_ArtifactUI.ShouldSuppressForgeRotation() end + +---@class ArtifactAppearanceInfo +---@field artifactAppearanceID number +---@field appearanceName string +---@field displayIndex number +---@field unlocked boolean +---@field failureDescription string? +---@field uiCameraID number +---@field altHandCameraID number? +---@field swatchColor colorRGB +---@field modelOpacity number +---@field modelSaturation number +---@field obtainable boolean + +---@class ArtifactAppearanceSetInfo +---@field artifactAppearanceSetID number +---@field appearanceSetName string +---@field appearanceSetDescription string +---@field numAppearances number + +---@class ArtifactArtInfo +---@field textureKit textureKit +---@field titleName string +---@field titleColor colorRGB +---@field barConnectedColor colorRGB +---@field barDisconnectedColor colorRGB +---@field uiModelSceneID number +---@field spellVisualKitID number + +---@class ArtifactInfo +---@field itemID number +---@field altItemID number? +---@field name string +---@field icon fileID +---@field xp number +---@field pointsSpent number +---@field quality number +---@field artifactAppearanceID number +---@field appearanceModID number +---@field itemAppearanceID number? +---@field altItemAppearanceID number? +---@field altOnTop boolean +---@field tier ArtifactTiers + +---@class ArtifactMetaPowerInfo +---@field spellID number +---@field powerCost number +---@field currentRank number + +---@class ArtifactPowerInfo +---@field spellID number +---@field cost number +---@field currentRank number +---@field maxRank number +---@field bonusRanks number +---@field numMaxRankBonusFromTier number +---@field prereqsMet boolean +---@field isStart boolean +---@field isGoldMedal boolean +---@field isFinal boolean +---@field tier number +---@field position vector2 +---@field offset vector2? +---@field linearIndex number? + +---@class ArtifactRelicInfo +---@field name string +---@field icon fileID +---@field slotTypeName string +---@field link string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua new file mode 100644 index 0000000..a229e9b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua @@ -0,0 +1,20 @@ +---@meta _ +C_AssistedCombat = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AssistedCombat.GetActionSpell) +---@return number? spellID +function C_AssistedCombat.GetActionSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AssistedCombat.GetNextCastSpell) +---@param checkForVisibleButton? boolean Default = false +---@return number? spellID +function C_AssistedCombat.GetNextCastSpell(checkForVisibleButton) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AssistedCombat.GetRotationSpells) +---@return number[] spellIDs +function C_AssistedCombat.GetRotationSpells() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AssistedCombat.IsAvailable) +---@return boolean isAvailable +---@return string failureReason +function C_AssistedCombat.IsAvailable() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua new file mode 100644 index 0000000..c911e01 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua @@ -0,0 +1,567 @@ +---@meta _ +C_AuctionHouse = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CalculateCommodityDeposit) +---@param itemID number +---@param duration number +---@param quantity number +---@return number? depositCost +function C_AuctionHouse.CalculateCommodityDeposit(itemID, duration, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CalculateItemDeposit) +---@param item ItemLocation +---@param duration number +---@param quantity number +---@return number? depositCost +function C_AuctionHouse.CalculateItemDeposit(item, duration, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CanCancelAuction) +---@param ownedAuctionID number +---@return boolean canCancelAuction +function C_AuctionHouse.CanCancelAuction(ownedAuctionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CancelAuction) +---@param ownedAuctionID number +function C_AuctionHouse.CancelAuction(ownedAuctionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CancelCommoditiesPurchase) +function C_AuctionHouse.CancelCommoditiesPurchase() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CancelSell) +function C_AuctionHouse.CancelSell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.CloseAuctionHouse) +function C_AuctionHouse.CloseAuctionHouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.ConfirmCommoditiesPurchase) +---@param itemID number +---@param quantity number +function C_AuctionHouse.ConfirmCommoditiesPurchase(itemID, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.ConfirmPostCommodity) +---@param item ItemLocation +---@param duration number +---@param quantity number +---@param unitPrice BigUInteger +function C_AuctionHouse.ConfirmPostCommodity(item, duration, quantity, unitPrice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.ConfirmPostItem) +---@param item ItemLocation +---@param duration number +---@param quantity number +---@param bid? BigUInteger +---@param buyout? BigUInteger +function C_AuctionHouse.ConfirmPostItem(item, duration, quantity, bid, buyout) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.FavoritesAreAvailable) +---@return boolean favoritesAreAvailable +function C_AuctionHouse.FavoritesAreAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetAuctionInfoByID) +---@param auctionID number +---@return AuctionInfo? priceInfo +function C_AuctionHouse.GetAuctionInfoByID(auctionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetAuctionItemSubClasses) +---@param classID number +---@return number[] subClasses +function C_AuctionHouse.GetAuctionItemSubClasses(classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetAvailablePostCount) +---@param item ItemLocation +---@return number listCount +function C_AuctionHouse.GetAvailablePostCount(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetBidInfo) +---@param bidIndex number +---@return BidInfo? bid +function C_AuctionHouse.GetBidInfo(bidIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetBidType) +---@param bidTypeIndex number +---@return ItemKey? typeItemKey +function C_AuctionHouse.GetBidType(bidTypeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetBids) +---@return BidInfo[] bids +function C_AuctionHouse.GetBids() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetBrowseResults) +---@return BrowseResultInfo[] browseResults +function C_AuctionHouse.GetBrowseResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetCancelCost) +---@param ownedAuctionID number +---@return BigUInteger cancelCost +function C_AuctionHouse.GetCancelCost(ownedAuctionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetCommoditySearchResultInfo) +---@param itemID number +---@param commoditySearchResultIndex number +---@return CommoditySearchResultInfo? result +function C_AuctionHouse.GetCommoditySearchResultInfo(itemID, commoditySearchResultIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetCommoditySearchResultsQuantity) +---@param itemID number +---@return number totalQuantity +function C_AuctionHouse.GetCommoditySearchResultsQuantity(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetExtraBrowseInfo) +---@param itemKey ItemKey +---@return number extraInfo +function C_AuctionHouse.GetExtraBrowseInfo(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetFilterGroups) +---@return AuctionHouseFilterGroup[] filterGroups +function C_AuctionHouse.GetFilterGroups() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetItemCommodityStatus) +---@param item ItemLocation +---@return Enum.ItemCommodityStatus isCommodity +function C_AuctionHouse.GetItemCommodityStatus(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetItemKeyFromItem) +---@param item ItemLocation +---@return ItemKey itemKey +function C_AuctionHouse.GetItemKeyFromItem(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetItemKeyInfo) +---@param itemKey ItemKey +---@param restrictQualityToFilter? boolean Default = false +---@return ItemKeyInfo? itemKeyInfo +function C_AuctionHouse.GetItemKeyInfo(itemKey, restrictQualityToFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetItemKeyRequiredLevel) +---@param itemKey ItemKey +---@return number requiredLevel +function C_AuctionHouse.GetItemKeyRequiredLevel(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetItemSearchResultInfo) +---@param itemKey ItemKey +---@param itemSearchResultIndex number +---@return ItemSearchResultInfo? result +function C_AuctionHouse.GetItemSearchResultInfo(itemKey, itemSearchResultIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetItemSearchResultsQuantity) +---@param itemKey ItemKey +---@return number totalQuantity +function C_AuctionHouse.GetItemSearchResultsQuantity(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxBidItemBid) +---@return BigUInteger? maxBid +function C_AuctionHouse.GetMaxBidItemBid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxBidItemBuyout) +---@return BigUInteger? maxBuyout +function C_AuctionHouse.GetMaxBidItemBuyout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxCommoditySearchResultPrice) +---@param itemID number +---@return BigUInteger? maxUnitPrice +function C_AuctionHouse.GetMaxCommoditySearchResultPrice(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxItemSearchResultBid) +---@param itemKey ItemKey +---@return BigUInteger? maxBid +function C_AuctionHouse.GetMaxItemSearchResultBid(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxItemSearchResultBuyout) +---@param itemKey ItemKey +---@return BigUInteger? maxBuyout +function C_AuctionHouse.GetMaxItemSearchResultBuyout(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxOwnedAuctionBid) +---@return BigUInteger? maxBid +function C_AuctionHouse.GetMaxOwnedAuctionBid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetMaxOwnedAuctionBuyout) +---@return BigUInteger? maxBuyout +function C_AuctionHouse.GetMaxOwnedAuctionBuyout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumBidTypes) +---@return number numBidTypes +function C_AuctionHouse.GetNumBidTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumBids) +---@return number numBids +function C_AuctionHouse.GetNumBids() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumCommoditySearchResults) +---@param itemID number +---@return number numSearchResults +function C_AuctionHouse.GetNumCommoditySearchResults(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumItemSearchResults) +---@param itemKey ItemKey +---@return number numItemSearchResults +function C_AuctionHouse.GetNumItemSearchResults(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumOwnedAuctionTypes) +---@return number numOwnedAuctionTypes +function C_AuctionHouse.GetNumOwnedAuctionTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumOwnedAuctions) +---@return number numOwnedAuctions +function C_AuctionHouse.GetNumOwnedAuctions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetNumReplicateItems) +---@return number numReplicateItems +function C_AuctionHouse.GetNumReplicateItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetOwnedAuctionInfo) +---@param ownedAuctionIndex number +---@return OwnedAuctionInfo? ownedAuction +function C_AuctionHouse.GetOwnedAuctionInfo(ownedAuctionIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetOwnedAuctionType) +---@param ownedAuctionTypeIndex number +---@return ItemKey? typeItemKey +function C_AuctionHouse.GetOwnedAuctionType(ownedAuctionTypeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetOwnedAuctions) +---@return OwnedAuctionInfo[] ownedAuctions +function C_AuctionHouse.GetOwnedAuctions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetQuoteDurationRemaining) +---@return number quoteDurationSeconds +function C_AuctionHouse.GetQuoteDurationRemaining() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetReplicateItemBattlePetInfo) +---@param index number +---@return number creatureID +---@return number displayID +function C_AuctionHouse.GetReplicateItemBattlePetInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetReplicateItemInfo) +---@param index number +---@return string? name +---@return fileID? texture +---@return number count +---@return number qualityID +---@return boolean? usable +---@return number level +---@return string? levelType +---@return BigUInteger minBid +---@return BigUInteger minIncrement +---@return BigUInteger buyoutPrice +---@return BigUInteger bidAmount +---@return string? highBidder +---@return string? bidderFullName +---@return string? owner +---@return string? ownerFullName +---@return number saleStatus +---@return number itemID +---@return boolean? hasAllInfo +function C_AuctionHouse.GetReplicateItemInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetReplicateItemLink) +---@param index number +---@return string? itemLink +function C_AuctionHouse.GetReplicateItemLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetReplicateItemTimeLeft) +---@param index number +---@return number timeLeft +function C_AuctionHouse.GetReplicateItemTimeLeft(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.GetTimeLeftBandInfo) +---@param timeLeftBand Enum.AuctionHouseTimeLeftBand +---@return number timeLeftMinSeconds +---@return number timeLeftMaxSeconds +function C_AuctionHouse.GetTimeLeftBandInfo(timeLeftBand) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasFavorites) +---@return boolean hasFavorites +function C_AuctionHouse.HasFavorites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasFullBidResults) +---@return boolean hasFullBidResults +function C_AuctionHouse.HasFullBidResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasFullBrowseResults) +---@return boolean hasFullBrowseResults +function C_AuctionHouse.HasFullBrowseResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasFullCommoditySearchResults) +---@param itemID number +---@return boolean hasFullResults +function C_AuctionHouse.HasFullCommoditySearchResults(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasFullItemSearchResults) +---@param itemKey ItemKey +---@return boolean hasFullResults +function C_AuctionHouse.HasFullItemSearchResults(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasFullOwnedAuctionResults) +---@return boolean hasFullOwnedAuctionResults +function C_AuctionHouse.HasFullOwnedAuctionResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasMaxFavorites) +---@return boolean hasMaxFavorites +function C_AuctionHouse.HasMaxFavorites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.HasSearchResults) +---@param itemKey ItemKey +---@return boolean hasSearchResults +function C_AuctionHouse.HasSearchResults(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.IsFavoriteItem) +---@param itemKey ItemKey +---@return boolean isFavorite +function C_AuctionHouse.IsFavoriteItem(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.IsSellItemValid) +---@param item ItemLocation +---@param displayError? boolean Default = true +---@return boolean valid +function C_AuctionHouse.IsSellItemValid(item, displayError) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.IsThrottledMessageSystemReady) +---@return boolean canSendThrottledMessage +function C_AuctionHouse.IsThrottledMessageSystemReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.MakeItemKey) +---@param itemID number +---@param itemLevel? number Default = 0 +---@param itemSuffix? number Default = 0 +---@param battlePetSpeciesID? number Default = 0 +---@return ItemKey itemKey +function C_AuctionHouse.MakeItemKey(itemID, itemLevel, itemSuffix, battlePetSpeciesID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.PlaceBid) +---@param auctionID number +---@param bidAmount BigUInteger +function C_AuctionHouse.PlaceBid(auctionID, bidAmount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.PostCommodity) +---@param item ItemLocation +---@param duration number +---@param quantity number +---@param unitPrice BigUInteger +---@return boolean needsConfirmation +function C_AuctionHouse.PostCommodity(item, duration, quantity, unitPrice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.PostItem) +---@param item ItemLocation +---@param duration number +---@param quantity number +---@param bid? BigUInteger +---@param buyout? BigUInteger +---@return boolean needsConfirmation +function C_AuctionHouse.PostItem(item, duration, quantity, bid, buyout) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.QueryBids) +---@param sorts AuctionHouseSortType[] +---@param auctionIDs number[] +function C_AuctionHouse.QueryBids(sorts, auctionIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.QueryOwnedAuctions) +---@param sorts AuctionHouseSortType[] +function C_AuctionHouse.QueryOwnedAuctions(sorts) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.RefreshCommoditySearchResults) +---@param itemID number +function C_AuctionHouse.RefreshCommoditySearchResults(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.RefreshItemSearchResults) +---@param itemKey ItemKey +---@param minLevelFilter? number +---@param maxLevelFilter? number +function C_AuctionHouse.RefreshItemSearchResults(itemKey, minLevelFilter, maxLevelFilter) end + +---This function should be used in place of an 'allItem' QueryAuctionItems call to query the entire auction house. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.ReplicateItems) +function C_AuctionHouse.ReplicateItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.RequestMoreBrowseResults) +function C_AuctionHouse.RequestMoreBrowseResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.RequestMoreCommoditySearchResults) +---@param itemID number +---@return boolean hasFullResults +function C_AuctionHouse.RequestMoreCommoditySearchResults(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.RequestMoreItemSearchResults) +---@param itemKey ItemKey +---@return boolean hasFullResults +function C_AuctionHouse.RequestMoreItemSearchResults(itemKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.RequestOwnedAuctionBidderInfo) +---@param auctionID number +---@return string bidderName +function C_AuctionHouse.RequestOwnedAuctionBidderInfo(auctionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SearchForFavorites) +---@param sorts AuctionHouseSortType[] +function C_AuctionHouse.SearchForFavorites(sorts) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SearchForItemKeys) +---@param itemKeys ItemKey[] +---@param sorts AuctionHouseSortType[] +function C_AuctionHouse.SearchForItemKeys(itemKeys, sorts) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SendBrowseQuery) +---@param query AuctionHouseBrowseQuery +function C_AuctionHouse.SendBrowseQuery(query) end + +---Search queries are restricted to 100 calls per minute. These should not be used to query the entire auction house. See ReplicateItems +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SendSearchQuery) +---@param itemKey ItemKey +---@param sorts AuctionHouseSortType[] +---@param separateOwnerItems boolean +---@param minLevelFilter? number Default = 0 +---@param maxLevelFilter? number Default = 0 +function C_AuctionHouse.SendSearchQuery(itemKey, sorts, separateOwnerItems, minLevelFilter, maxLevelFilter) end + +---Search queries are restricted to 100 calls per minute. These should not be used to query the entire auction house. See ReplicateItems. ItemKey should have its iLVL and suffix cleared before calling. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SendSellSearchQuery) +---@param itemKey ItemKey +---@param sorts AuctionHouseSortType[] +---@param separateOwnerItems boolean +function C_AuctionHouse.SendSellSearchQuery(itemKey, sorts, separateOwnerItems) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SetFavoriteItem) +---@param itemKey ItemKey +---@param setFavorite boolean +function C_AuctionHouse.SetFavoriteItem(itemKey, setFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.ShouldAutoPopulatePrice) +---@return boolean shouldAutoPopulatePrice +function C_AuctionHouse.ShouldAutoPopulatePrice() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.StartCommoditiesPurchase) +---@param itemID number +---@param quantity number +function C_AuctionHouse.StartCommoditiesPurchase(itemID, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AuctionHouse.SupportsCopperValues) +---@return boolean supportsCopperValues +function C_AuctionHouse.SupportsCopperValues() end + +---@class AuctionHouseBrowseQuery +---@field searchString string +---@field sorts AuctionHouseSortType[] +---@field minLevel number? +---@field maxLevel number? +---@field filters Enum.AuctionHouseFilter[]? +---@field itemClassFilters AuctionHouseItemClassFilter[]? + +---@class AuctionHouseFilterGroup +---@field category Enum.AuctionHouseFilterCategory +---@field filters Enum.AuctionHouseFilter[] + +---@class AuctionHouseItemClassFilter +---@field classID number +---@field subClassID number? +---@field inventoryType Enum.InventoryType? + +---@class AuctionHouseSortType +---@field sortOrder Enum.AuctionHouseSortOrder +---@field reverseSort boolean + +---@class AuctionInfo +---@field itemKey ItemKey +---@field itemLink string? +---@field minBid WOWMONEY? +---@field bidAmount WOWMONEY? +---@field buyoutAmount WOWMONEY? +---@field bidder WOWGUID? + +---@class BidInfo +---@field auctionID number +---@field itemKey ItemKey +---@field itemLink string? +---@field timeLeft Enum.AuctionHouseTimeLeftBand +---@field minBid BigUInteger? +---@field bidAmount BigUInteger? +---@field buyoutAmount BigUInteger? +---@field bidder WOWGUID? + +---@class BrowseResultInfo +---@field itemKey ItemKey +---@field appearanceLink string? +---@field totalQuantity number +---@field minPrice BigUInteger +---@field containsOwnerItem boolean + +---@class CommoditySearchResultInfo +---@field itemID number +---@field quantity number +---@field unitPrice BigUInteger +---@field auctionID number +---@field owners string[] +---@field totalNumberOfOwners number +---@field timeLeftSeconds number? +---@field numOwnerItems number +---@field containsOwnerItem boolean +---@field containsAccountItem boolean + +---@class ItemKey +---@field itemID number +---@field itemLevel number? Default = 0 +---@field itemSuffix number? Default = 0 +---@field battlePetSpeciesID number? Default = 0 + +---@class ItemKeyInfo +---@field itemID number +---@field battlePetSpeciesID number +---@field itemName string +---@field battlePetLink string? +---@field appearanceLink string? +---@field quality Enum.ItemQuality +---@field iconFileID number +---@field isPet boolean +---@field isCommodity boolean +---@field isEquipment boolean + +---@class ItemSearchResultInfo +---@field itemKey ItemKey +---@field owners string[] +---@field totalNumberOfOwners number +---@field timeLeft Enum.AuctionHouseTimeLeftBand +---@field auctionID number +---@field quantity number +---@field itemLink string? +---@field containsOwnerItem boolean +---@field containsAccountItem boolean +---@field containsSocketedItem boolean +---@field bidder WOWGUID? +---@field minBid BigUInteger? +---@field bidAmount BigUInteger? +---@field buyoutAmount BigUInteger? +---@field timeLeftSeconds number? + +---@class OwnedAuctionInfo +---@field auctionID number +---@field itemKey ItemKey +---@field itemLink string? +---@field status Enum.AuctionStatus +---@field quantity number +---@field timeLeftSeconds number? +---@field timeLeft Enum.AuctionHouseTimeLeftBand? +---@field bidAmount BigUInteger? +---@field buyoutAmount BigUInteger? +---@field bidder string? + +---@class ReplicateItemInfo +---@field name string? +---@field texture fileID? +---@field count number +---@field qualityID number +---@field usable boolean? +---@field level number +---@field levelType string? +---@field minBid BigUInteger +---@field minIncrement BigUInteger +---@field buyoutPrice BigUInteger +---@field bidAmount BigUInteger +---@field highBidder string? +---@field bidderFullName string? +---@field owner string? +---@field ownerFullName string? +---@field saleStatus number +---@field itemID number +---@field hasAllInfo boolean? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AutoCompleteDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AutoCompleteDocumentation.lua new file mode 100644 index 0000000..f7638fe --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AutoCompleteDocumentation.lua @@ -0,0 +1,33 @@ +---@meta _ +C_AutoComplete = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AutoComplete.GetAutoCompletePresenceID) +---@param name string +---@return number? presenceID +function C_AutoComplete.GetAutoCompletePresenceID(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AutoComplete.GetAutoCompleteRealms) +---@return string[] realms +function C_AutoComplete.GetAutoCompleteRealms() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AutoComplete.GetAutoCompleteResults) +---@param name string +---@param numResults number +---@param cursorPosition number +---@param allowFullMatch boolean +---@param includeFlags number +---@param excludeFlags number +---@return AutoCompleteResult[] results +function C_AutoComplete.GetAutoCompleteResults(name, numResults, cursorPosition, allowFullMatch, includeFlags, excludeFlags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AutoComplete.IsRecognizedName) +---@param name string +---@param includeFlags number +---@param excludeFlags number +---@return boolean isRecognizedName +function C_AutoComplete.IsRecognizedName(name, includeFlags, excludeFlags) end + +---@class AutoCompleteResult +---@field name string +---@field priority Enum.AutoCompletePriority +---@field bnetID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua new file mode 100644 index 0000000..95e0570 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua @@ -0,0 +1,112 @@ +---@meta _ +C_AzeriteEmpoweredItem = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.CanSelectPower) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@param powerID number +---@return boolean canSelect +function C_AzeriteEmpoweredItem.CanSelectPower(azeriteEmpoweredItemLocation, powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +function C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec(azeriteEmpoweredItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.GetAllTierInfo) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@return AzeriteEmpoweredItemTierInfo[] tierInfo +function C_AzeriteEmpoweredItem.GetAllTierInfo(azeriteEmpoweredItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.GetAllTierInfoByItemID) +---@param itemInfo ItemInfo +---@param classID? number +---@return AzeriteEmpoweredItemTierInfo[] tierInfo +function C_AzeriteEmpoweredItem.GetAllTierInfoByItemID(itemInfo, classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost) +---@return number cost +function C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.GetPowerInfo) +---@param powerID number +---@return AzeriteEmpoweredItemPowerInfo powerInfo +function C_AzeriteEmpoweredItem.GetPowerInfo(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.GetPowerText) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@param powerID number +---@param level Enum.AzeritePowerLevel +---@return AzeriteEmpoweredItemPowerText powerText +function C_AzeriteEmpoweredItem.GetPowerText(azeriteEmpoweredItemLocation, powerID, level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.GetSpecsForPower) +---@param powerID number +---@return AzeriteSpecInfo[] specInfo +function C_AzeriteEmpoweredItem.GetSpecsForPower(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.HasAnyUnselectedPowers) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@return boolean hasAnyUnselectedPowers +function C_AzeriteEmpoweredItem.HasAnyUnselectedPowers(azeriteEmpoweredItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.HasBeenViewed) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@return boolean hasBeenViewed +function C_AzeriteEmpoweredItem.HasBeenViewed(azeriteEmpoweredItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem) +---@param itemLocation ItemLocation +---@return boolean isAzeriteEmpoweredItem +function C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID) +---@param itemInfo ItemInfo +---@return boolean isAzeriteEmpoweredItem +function C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable) +---@param itemInfo ItemInfo +---@param classID? number +---@return boolean isAzeritePreviewSourceDisplayable +function C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable(itemInfo, classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped) +---@return boolean isHeartOfAzerothEquipped +function C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.IsPowerAvailableForSpec) +---@param powerID number +---@param specID number +---@return boolean isPowerAvailableForSpec +function C_AzeriteEmpoweredItem.IsPowerAvailableForSpec(powerID, specID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.IsPowerSelected) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@param powerID number +---@return boolean isSelected +function C_AzeriteEmpoweredItem.IsPowerSelected(azeriteEmpoweredItemLocation, powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.SelectPower) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +---@param powerID number +---@return boolean success +function C_AzeriteEmpoweredItem.SelectPower(azeriteEmpoweredItemLocation, powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEmpoweredItem.SetHasBeenViewed) +---@param azeriteEmpoweredItemLocation AzeriteEmpoweredItemLocation +function C_AzeriteEmpoweredItem.SetHasBeenViewed(azeriteEmpoweredItemLocation) end + +---@class AzeriteEmpoweredItemPowerInfo +---@field azeritePowerID number +---@field spellID number + +---@class AzeriteEmpoweredItemPowerText +---@field name string +---@field description string + +---@class AzeriteEmpoweredItemTierInfo +---@field azeritePowerIDs number[] +---@field unlockLevel number + +---@class AzeriteSpecInfo +---@field classID number +---@field specID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua new file mode 100644 index 0000000..7f62716 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua @@ -0,0 +1,110 @@ +---@meta _ +C_AzeriteEssence = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.ActivateEssence) +---@param essenceID number +---@param milestoneID number +function C_AzeriteEssence.ActivateEssence(essenceID, milestoneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.CanActivateEssence) +---@param essenceID number +---@param milestoneID number +---@return boolean canActivate +function C_AzeriteEssence.CanActivateEssence(essenceID, milestoneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.CanDeactivateEssence) +---@param milestoneID number +---@return boolean canDeactivate +function C_AzeriteEssence.CanDeactivateEssence(milestoneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.CanOpenUI) +---@return boolean canOpen +function C_AzeriteEssence.CanOpenUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.ClearPendingActivationEssence) +function C_AzeriteEssence.ClearPendingActivationEssence() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.CloseForge) +function C_AzeriteEssence.CloseForge() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetEssenceHyperlink) +---@param essenceID number +---@param rank number +---@return string link +function C_AzeriteEssence.GetEssenceHyperlink(essenceID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetEssenceInfo) +---@param essenceID number +---@return AzeriteEssenceInfo info +function C_AzeriteEssence.GetEssenceInfo(essenceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetEssences) +---@return AzeriteEssenceInfo[] essences +function C_AzeriteEssence.GetEssences() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetMilestoneEssence) +---@param milestoneID number +---@return number essenceID +function C_AzeriteEssence.GetMilestoneEssence(milestoneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetMilestoneInfo) +---@param milestoneID number +---@return AzeriteMilestoneInfo info +function C_AzeriteEssence.GetMilestoneInfo(milestoneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetMilestoneSpell) +---@param milestoneID number +---@return number spellID +function C_AzeriteEssence.GetMilestoneSpell(milestoneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetMilestones) +---@return AzeriteMilestoneInfo[] milestones +function C_AzeriteEssence.GetMilestones() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetNumUnlockedEssences) +---@return number numUnlockedEssences +function C_AzeriteEssence.GetNumUnlockedEssences() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetNumUsableEssences) +---@return number numUsableEssences +function C_AzeriteEssence.GetNumUsableEssences() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.GetPendingActivationEssence) +---@return number essenceID +function C_AzeriteEssence.GetPendingActivationEssence() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.HasNeverActivatedAnyEssences) +---@return boolean hasNeverActivatedAnyEssences +function C_AzeriteEssence.HasNeverActivatedAnyEssences() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.HasPendingActivationEssence) +---@return boolean hasEssence +function C_AzeriteEssence.HasPendingActivationEssence() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.IsAtForge) +---@return boolean isAtForge +function C_AzeriteEssence.IsAtForge() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.SetPendingActivationEssence) +---@param essenceID number +function C_AzeriteEssence.SetPendingActivationEssence(essenceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteEssence.UnlockMilestone) +---@param milestoneID number +function C_AzeriteEssence.UnlockMilestone(milestoneID) end + +---@class AzeriteEssenceInfo +---@field ID number +---@field name string +---@field rank number +---@field unlocked boolean +---@field valid boolean +---@field icon fileID + +---@class AzeriteMilestoneInfo +---@field ID number +---@field requiredLevel number +---@field canUnlock boolean +---@field unlocked boolean +---@field rank number? +---@field slot Enum.AzeriteEssenceSlot? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua new file mode 100644 index 0000000..777b7bd --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua @@ -0,0 +1,53 @@ +---@meta _ +C_AzeriteItem = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.FindActiveAzeriteItem) +---@return AzeriteItemLocation activeAzeriteItemLocation +function C_AzeriteItem.FindActiveAzeriteItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.GetAzeriteItemXPInfo) +---@param azeriteItemLocation AzeriteItemLocation +---@return number xp +---@return number totalLevelXP +function C_AzeriteItem.GetAzeriteItemXPInfo(azeriteItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.GetPowerLevel) +---@param azeriteItemLocation AzeriteItemLocation +---@return number powerLevel +function C_AzeriteItem.GetPowerLevel(azeriteItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.GetUnlimitedPowerLevel) +---@param azeriteItemLocation AzeriteItemLocation +---@return number powerLevel +function C_AzeriteItem.GetUnlimitedPowerLevel(azeriteItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.HasActiveAzeriteItem) +---@return boolean hasActiveAzeriteItem +function C_AzeriteItem.HasActiveAzeriteItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.IsAzeriteItem) +---@param itemLocation ItemLocation +---@return boolean isAzeriteItem +function C_AzeriteItem.IsAzeriteItem(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.IsAzeriteItemAtMaxLevel) +---@return boolean isAtMax +function C_AzeriteItem.IsAzeriteItemAtMaxLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.IsAzeriteItemByID) +---@param itemInfo ItemInfo +---@return boolean isAzeriteItem +function C_AzeriteItem.IsAzeriteItemByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.IsAzeriteItemEnabled) +---@param azeriteItemLocation AzeriteItemLocation +---@return boolean isEnabled +function C_AzeriteItem.IsAzeriteItemEnabled(azeriteItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AzeriteItem.IsUnlimitedLevelingUnlocked) +---@return boolean isUnlimitedLevelingUnlocked +function C_AzeriteItem.IsUnlimitedLevelingUnlocked() end + +---@class UnlockedAzeriteEmpoweredItems +---@field unlockedItem AzeriteEmpoweredItemLocation +---@field tierIndex number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua new file mode 100644 index 0000000..036543a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearOutage) +function ClearOutage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_OutageDetected) +function OutageDetected() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BankDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BankDocumentation.lua new file mode 100644 index 0000000..b354fac --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BankDocumentation.lua @@ -0,0 +1,131 @@ +---@meta _ +C_Bank = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.AreAnyBankTypesViewable) +---@return boolean areAnyBankTypesViewable +function C_Bank.AreAnyBankTypesViewable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.AutoDepositItemsIntoBank) +---@param bankType Enum.BankType +function C_Bank.AutoDepositItemsIntoBank(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.CanDepositMoney) +---@param bankType Enum.BankType +---@return boolean canDepositMoney +function C_Bank.CanDepositMoney(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.CanPurchaseBankTab) +---@param bankType Enum.BankType +---@return boolean canPurchaseBankTab +function C_Bank.CanPurchaseBankTab(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.CanUseBank) +---@param bankType Enum.BankType +---@return boolean canUseBank +function C_Bank.CanUseBank(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.CanViewBank) +---@param bankType Enum.BankType +---@return boolean canViewBank +function C_Bank.CanViewBank(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.CanWithdrawMoney) +---@param bankType Enum.BankType +---@return boolean canWithdrawMoney +function C_Bank.CanWithdrawMoney(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.CloseBankFrame) +function C_Bank.CloseBankFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.DepositMoney) +---@param bankType Enum.BankType +---@param amount WOWMONEY +function C_Bank.DepositMoney(bankType, amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.DoesBankTypeSupportAutoDeposit) +---@param bankType Enum.BankType +---@return boolean doesBankTypeSupportAutoDeposit +function C_Bank.DoesBankTypeSupportAutoDeposit(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.DoesBankTypeSupportMoneyTransfer) +---@param bankType Enum.BankType +---@return boolean doesBankTypeSupportMoneyTransfer +function C_Bank.DoesBankTypeSupportMoneyTransfer(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchBankLockedReason) +---@param bankType Enum.BankType +---@return Enum.BankLockedReason? reason +function C_Bank.FetchBankLockedReason(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchDepositedMoney) +---@param bankType Enum.BankType +---@return WOWMONEY amount +function C_Bank.FetchDepositedMoney(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchNextPurchasableBankTabData) +---@param bankType Enum.BankType +---@return PurchasableBankTabData? nextPurchasableTabData +function C_Bank.FetchNextPurchasableBankTabData(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchNumPurchasedBankTabs) +---@param bankType Enum.BankType +---@return number numPurchasedBankTabs +function C_Bank.FetchNumPurchasedBankTabs(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchPurchasedBankTabData) +---@param bankType Enum.BankType +---@return BankTabData[] purchasedBankTabData +function C_Bank.FetchPurchasedBankTabData(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchPurchasedBankTabIDs) +---@param bankType Enum.BankType +---@return Enum.BagIndex[] purchasedBankTabIDs +function C_Bank.FetchPurchasedBankTabIDs(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.FetchViewableBankTypes) +---@return Enum.BankType[] viewableBankTypes +function C_Bank.FetchViewableBankTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.HasMaxBankTabs) +---@param bankType Enum.BankType +---@return boolean hasMaxBankTabs +function C_Bank.HasMaxBankTabs(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.IsItemAllowedInBankType) +---@param bankType Enum.BankType +---@param itemLocation ItemLocation +---@return boolean isItemAllowedInBankType +function C_Bank.IsItemAllowedInBankType(bankType, itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.PurchaseBankTab) +---@param bankType Enum.BankType +function C_Bank.PurchaseBankTab(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.UpdateBankTabSettings) +---@param bankType Enum.BankType +---@param tabID Enum.BagIndex +---@param tabName string +---@param tabIcon string +---@param depositFlags Enum.BagSlotFlags +function C_Bank.UpdateBankTabSettings(bankType, tabID, tabName, tabIcon, depositFlags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Bank.WithdrawMoney) +---@param bankType Enum.BankType +---@param amount WOWMONEY +function C_Bank.WithdrawMoney(bankType, amount) end + +---@class BankTabData +---@field ID number +---@field bankType Enum.BankType +---@field name string +---@field icon fileID +---@field depositFlags Enum.BagSlotFlags +---@field tabCleanupConfirmation string +---@field tabNameEditBoxHeader string + +---@class PurchasableBankTabData +---@field tabCost BigUInteger +---@field canAfford boolean +---@field purchasePromptTitle string +---@field purchasePromptBody string +---@field purchasePromptConfirmation string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua new file mode 100644 index 0000000..a7942d9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua @@ -0,0 +1,118 @@ +---@meta _ +C_BarberShop = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.ApplyCustomizationChoices) +---@return boolean success +function C_BarberShop.ApplyCustomizationChoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.Cancel) +function C_BarberShop.Cancel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.ClearPreviewChoices) +---@param clearSavedChoices? boolean Default = false +function C_BarberShop.ClearPreviewChoices(clearSavedChoices) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.GetAvailableCustomizations) +---@return CharCustomizationCategory[] categories +function C_BarberShop.GetAvailableCustomizations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.GetCurrentCameraZoom) +---@return number zoomLevel +function C_BarberShop.GetCurrentCameraZoom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.GetCurrentCharacterData) +---@return PlayerInfoCharacterData characterData +function C_BarberShop.GetCurrentCharacterData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.GetCurrentCost) +---@return number cost +function C_BarberShop.GetCurrentCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.GetViewingChrModel) +---@return number? chrModelID +function C_BarberShop.GetViewingChrModel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.HasAlteredForm) +---@return boolean hasAlteredForm +function C_BarberShop.HasAlteredForm() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.HasAnyChanges) +---@return boolean hasChanges +function C_BarberShop.HasAnyChanges() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.HasCustomizationFeature) +---@param featureMask Enum.ChrModelFeatureFlags +---@return boolean hasCustomizationFeature +function C_BarberShop.HasCustomizationFeature(featureMask) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.IsViewingAlteredForm) +---@return boolean isViewingAlteredForm +function C_BarberShop.IsViewingAlteredForm() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.MarkCustomizationChoiceAsSeen) +---@param choiceID number +function C_BarberShop.MarkCustomizationChoiceAsSeen(choiceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.MarkCustomizationOptionAsSeen) +---@param optionID number +function C_BarberShop.MarkCustomizationOptionAsSeen(optionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.PreviewCustomizationChoice) +---@param optionID number +---@param choiceID number +function C_BarberShop.PreviewCustomizationChoice(optionID, choiceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.RandomizeCustomizationChoices) +function C_BarberShop.RandomizeCustomizationChoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.ResetCameraRotation) +function C_BarberShop.ResetCameraRotation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.ResetCustomizationChoices) +function C_BarberShop.ResetCustomizationChoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.RotateCamera) +---@param diffDegrees number +function C_BarberShop.RotateCamera(diffDegrees) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SaveSeenChoices) +function C_BarberShop.SaveSeenChoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetCameraDistanceOffset) +---@param offset number +function C_BarberShop.SetCameraDistanceOffset(offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetCameraZoomLevel) +---@param zoomLevel number +---@param keepCustomZoom? boolean +function C_BarberShop.SetCameraZoomLevel(zoomLevel, keepCustomZoom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetCustomizationChoice) +---@param optionID number +---@param choiceID number +function C_BarberShop.SetCustomizationChoice(optionID, choiceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetModelDressState) +---@param dressedState boolean +function C_BarberShop.SetModelDressState(dressedState) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetSelectedSex) +---@param sex Enum.UnitSex +function C_BarberShop.SetSelectedSex(sex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetViewingAlteredForm) +---@param isViewingAlteredForm boolean +function C_BarberShop.SetViewingAlteredForm(isViewingAlteredForm) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetViewingChrModel) +---@param chrModelID? number +---@param spellShapeshiftFormID? number +function C_BarberShop.SetViewingChrModel(chrModelID, spellShapeshiftFormID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.SetViewingShapeshiftForm) +---@param shapeshiftFormID? number +function C_BarberShop.SetViewingShapeshiftForm(shapeshiftFormID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShop.ZoomCamera) +---@param zoomAmount number +function C_BarberShop.ZoomCamera(zoomAmount) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua new file mode 100644 index 0000000..614f97f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_BarberShopInternal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BarberShopInternal.SetQAMode) +---@param qaModeEnabled boolean +function C_BarberShopInternal.SetQAMode(qaModeEnabled) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua new file mode 100644 index 0000000..d30d83e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua @@ -0,0 +1,2 @@ +---@meta _ +---@class ScriptObject diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua new file mode 100644 index 0000000..a1fda96 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua @@ -0,0 +1,115 @@ +---@meta _ +C_BattleNet = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.BNCheckBattleTagInviteToRecentAlly) +---@param recentAllyGUID WOWGUID +function C_BattleNet.BNCheckBattleTagInviteToRecentAlly(recentAllyGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetAccountInfoByGUID) +---@param guid WOWGUID +---@return BNetAccountInfo? accountInfo +function C_BattleNet.GetAccountInfoByGUID(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetAccountInfoByID) +---@param id number +---@param wowAccountGUID? WOWGUID +---@return BNetAccountInfo? accountInfo +function C_BattleNet.GetAccountInfoByID(id, wowAccountGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetFriendAccountInfo) +---@param friendIndex number +---@param wowAccountGUID? WOWGUID +---@return BNetAccountInfo? accountInfo +function C_BattleNet.GetFriendAccountInfo(friendIndex, wowAccountGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetFriendGameAccountInfo) +---@param friendIndex number +---@param accountIndex number +---@return BNetGameAccountInfo? gameAccountInfo +function C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetFriendNumGameAccounts) +---@param friendIndex number +---@return number numGameAccounts +function C_BattleNet.GetFriendNumGameAccounts(friendIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetGameAccountInfoByGUID) +---@param guid WOWGUID +---@return BNetGameAccountInfo? gameAccountInfo +function C_BattleNet.GetGameAccountInfoByGUID(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.GetGameAccountInfoByID) +---@param id number +---@return BNetGameAccountInfo? gameAccountInfo +function C_BattleNet.GetGameAccountInfoByID(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.InstallHighResTextures) +function C_BattleNet.InstallHighResTextures() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.SendGameData) +---@param gameAccountID number +---@param prefix stringView +---@param data stringView +---@return Enum.SendAddonMessageResult result +function C_BattleNet.SendGameData(gameAccountID, prefix, data) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.SendWhisper) +---@param bnetAccountID number +---@param text stringView +---@return boolean success +function C_BattleNet.SendWhisper(bnetAccountID, text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.SetAFK) +---@param isAFK? boolean Default = true +function C_BattleNet.SetAFK(isAFK) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.SetCustomMessage) +---@param text string +---@return boolean success +function C_BattleNet.SetCustomMessage(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BattleNet.SetDND) +---@param isDND? boolean Default = true +function C_BattleNet.SetDND(isDND) end + +---@class BNetAccountInfo +---@field bnetAccountID number +---@field accountName string +---@field battleTag string +---@field isFriend boolean +---@field isBattleTagFriend boolean +---@field lastOnlineTime number +---@field isAFK boolean +---@field isDND boolean +---@field isFavorite boolean +---@field appearOffline boolean +---@field customMessage string +---@field customMessageTime number +---@field note string +---@field rafLinkType Enum.RafLinkType +---@field gameAccountInfo BNetGameAccountInfo + +---@class BNetGameAccountInfo +---@field gameAccountID number +---@field clientProgram string +---@field isOnline boolean +---@field isGameBusy boolean +---@field isGameAFK boolean +---@field wowProjectID number? +---@field characterName string? +---@field realmName string? +---@field realmDisplayName string? +---@field realmID number? +---@field factionName string? +---@field raceName string? +---@field classID number? +---@field className string? +---@field areaName string? +---@field characterLevel number? +---@field richPresence string? +---@field playerGuid WOWGUID? +---@field canSummon boolean +---@field hasFocus boolean +---@field regionID number +---@field isInCurrentRegion boolean +---@field timerunningSeasonID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua new file mode 100644 index 0000000..8b7f931 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +C_BehavioralMessaging = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BehavioralMessaging.SendNotificationReceipt) +---@param dbId NotificationDbId +---@param openTimeSeconds number +---@param readTimeSeconds number +function C_BehavioralMessaging.SendNotificationReceipt(dbId, openTimeSeconds, readTimeSeconds) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua new file mode 100644 index 0000000..7859e7e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +---@class BountyInfo +---@field questID number +---@field factionID number +---@field icon fileID +---@field numObjectives number +---@field turninRequirementText string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua new file mode 100644 index 0000000..695ff8a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua @@ -0,0 +1,51 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBuildInfo) +---@return string buildVersion +---@return string buildNumber +---@return string buildDate +---@return number interfaceVersion +---@return string localizedVersion +---@return string buildInfo +function GetBuildInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Is64BitClient) +---@return boolean is64Bit +function Is64BitClient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsBetaBuild) +---@return boolean isBetaBuild +function IsBetaBuild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsDebugBuild) +---@return boolean isDebugBuild +function IsDebugBuild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLinuxClient) +---@return boolean isLinux +function IsLinuxClient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMacClient) +---@return boolean isMac +function IsMacClient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPublicBuild) +---@return boolean isPublicBuild +function IsPublicBuild() end + +---Reflects the state of the OnlyBetaAndPTR TOC directive +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPublicTestClient) +---@return boolean isPublicTestClient +function IsPublicTestClient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsTestBuild) +---@return boolean isTestBuild +function IsTestBuild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsWindowsClient) +---@return boolean isWindows +function IsWindowsClient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SupportsClipCursor) +---@return boolean supportsClipCursor +function SupportsClipCursor() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua new file mode 100644 index 0000000..85e40a6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua @@ -0,0 +1,64 @@ +---@meta _ +C_CVar = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVar) +---@param name CVar +---@return string? value +function C_CVar.GetCVar(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarBitfield) +---@param name CVar +---@param index number +---@return boolean? value +function C_CVar.GetCVarBitfield(name, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarBool) +---@param name CVar +---@return boolean? value +function C_CVar.GetCVarBool(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarDefault) +---@param name CVar +---@return string? defaultValue +function C_CVar.GetCVarDefault(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarInfo) +---@param name string +---@return string value +---@return string defaultValue +---@return boolean isStoredServerAccount +---@return boolean isStoredServerCharacter +---@return boolean isLockedFromUser +---@return boolean isSecure +---@return boolean isReadOnly +function C_CVar.GetCVarInfo(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.RegisterCVar) +---@param name string +---@param value? string|number +function C_CVar.RegisterCVar(name, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.ResetTestCVars) +function C_CVar.ResetTestCVars() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.SetCVar) +---@param name CVar +---@param value? string|number +---@return boolean success +function C_CVar.SetCVar(name, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.SetCVarBitfield) +---@param name CVar +---@param index number +---@param value boolean +---@return boolean success +function C_CVar.SetCVarBitfield(name, index, value) end + +---@class CVarInfo +---@field value string +---@field defaultValue string +---@field isStoredServerAccount boolean +---@field isStoredServerCharacter boolean +---@field isLockedFromUser boolean +---@field isSecure boolean +---@field isReadOnly boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua new file mode 100644 index 0000000..a934ce5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua @@ -0,0 +1,507 @@ +---@meta _ +C_Calendar = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.AddEvent) +function C_Calendar.AddEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.AreNamesReady) +---@return boolean ready +function C_Calendar.AreNamesReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CanAddEvent) +---@return boolean canAddEvent +function C_Calendar.CanAddEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CanSendInvite) +---@return boolean canSendInvite +function C_Calendar.CanSendInvite() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CloseEvent) +function C_Calendar.CloseEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventCanComplain) +---@param offsetMonths number +---@param monthDay number +---@param eventIndex number +---@return boolean canComplain +function C_Calendar.ContextMenuEventCanComplain(offsetMonths, monthDay, eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventCanEdit) +---@param offsetMonths number +---@param monthDay number +---@param eventIndex number +---@return boolean canEdit +function C_Calendar.ContextMenuEventCanEdit(offsetMonths, monthDay, eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventCanRemove) +---@param offsetMonths number +---@param monthDay number +---@param eventIndex number +---@return boolean canRemove +function C_Calendar.ContextMenuEventCanRemove(offsetMonths, monthDay, eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventClipboard) +---@return boolean exists +function C_Calendar.ContextMenuEventClipboard() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventCopy) +function C_Calendar.ContextMenuEventCopy() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventGetCalendarType) +---@return string? calendarType +function C_Calendar.ContextMenuEventGetCalendarType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventPaste) +---@param offsetMonths number +---@param monthDay number +function C_Calendar.ContextMenuEventPaste(offsetMonths, monthDay) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventRemove) +function C_Calendar.ContextMenuEventRemove() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuEventSignUp) +function C_Calendar.ContextMenuEventSignUp() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuGetEventIndex) +---@return CalendarEventIndexInfo info +function C_Calendar.ContextMenuGetEventIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuInviteAvailable) +function C_Calendar.ContextMenuInviteAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuInviteDecline) +function C_Calendar.ContextMenuInviteDecline() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuInviteRemove) +function C_Calendar.ContextMenuInviteRemove() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuInviteTentative) +function C_Calendar.ContextMenuInviteTentative() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.ContextMenuSelectEvent) +---@param offsetMonths number +---@param monthDay number +---@param eventIndex number +function C_Calendar.ContextMenuSelectEvent(offsetMonths, monthDay, eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CreateCommunitySignUpEvent) +function C_Calendar.CreateCommunitySignUpEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CreateGuildAnnouncementEvent) +function C_Calendar.CreateGuildAnnouncementEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CreateGuildSignUpEvent) +function C_Calendar.CreateGuildSignUpEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.CreatePlayerEvent) +function C_Calendar.CreatePlayerEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventAvailable) +function C_Calendar.EventAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventCanEdit) +---@return boolean canEdit +function C_Calendar.EventCanEdit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventClearAutoApprove) +function C_Calendar.EventClearAutoApprove() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventClearLocked) +function C_Calendar.EventClearLocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventClearModerator) +---@param inviteIndex number +function C_Calendar.EventClearModerator(inviteIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventDecline) +function C_Calendar.EventDecline() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetCalendarType) +---@return string? calendarType +function C_Calendar.EventGetCalendarType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetClubId) +---@return ClubId? info +function C_Calendar.EventGetClubId() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetInvite) +---@param eventIndex number +---@return CalendarEventInviteInfo info +function C_Calendar.EventGetInvite(eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetInviteResponseTime) +---@param eventIndex number +---@return CalendarTime time +function C_Calendar.EventGetInviteResponseTime(eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetInviteSortCriterion) +---@return string criterion +---@return boolean reverse +function C_Calendar.EventGetInviteSortCriterion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetSelectedInvite) +---@return number? inviteIndex +function C_Calendar.EventGetSelectedInvite() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetStatusOptions) +---@param eventIndex number +---@return CalendarEventStatusOption[] options +function C_Calendar.EventGetStatusOptions(eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetTextures) +---@param eventType Enum.CalendarEventType +---@return CalendarEventTextureInfo[] textures +function C_Calendar.EventGetTextures(eventType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetTypes) +---@return string[] types +function C_Calendar.EventGetTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventGetTypesDisplayOrdered) +---@return CalendarEventTypeDisplayInfo[] infos +function C_Calendar.EventGetTypesDisplayOrdered() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventHasPendingInvite) +---@return boolean hasPendingInvite +function C_Calendar.EventHasPendingInvite() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventHaveSettingsChanged) +---@return boolean haveSettingsChanged +function C_Calendar.EventHaveSettingsChanged() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventInvite) +---@param name string +function C_Calendar.EventInvite(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventRemoveInvite) +---@param inviteIndex number +function C_Calendar.EventRemoveInvite(inviteIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventRemoveInviteByGuid) +---@param guid WOWGUID +function C_Calendar.EventRemoveInviteByGuid(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSelectInvite) +---@param inviteIndex number +function C_Calendar.EventSelectInvite(inviteIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetAutoApprove) +function C_Calendar.EventSetAutoApprove() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetClubId) +---@param clubId? ClubId +function C_Calendar.EventSetClubId(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetDate) +---@param month number +---@param monthDay number +---@param year number +function C_Calendar.EventSetDate(month, monthDay, year) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetDescription) +---@param description string +function C_Calendar.EventSetDescription(description) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetInviteStatus) +---@param eventIndex number +---@param status Enum.CalendarStatus +function C_Calendar.EventSetInviteStatus(eventIndex, status) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetLocked) +function C_Calendar.EventSetLocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetModerator) +---@param inviteIndex number +function C_Calendar.EventSetModerator(inviteIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetTextureID) +---@param textureIndex number +function C_Calendar.EventSetTextureID(textureIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetTime) +---@param hour number +---@param minute number +function C_Calendar.EventSetTime(hour, minute) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetTitle) +---@param title string +function C_Calendar.EventSetTitle(title) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSetType) +---@param typeIndex Enum.CalendarEventType +function C_Calendar.EventSetType(typeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSignUp) +function C_Calendar.EventSignUp() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventSortInvites) +---@param criterion string +---@param reverse boolean +function C_Calendar.EventSortInvites(criterion, reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.EventTentative) +function C_Calendar.EventTentative() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetClubCalendarEvents) +---@param clubId ClubId +---@param startTime CalendarTime +---@param endTime CalendarTime +---@return CalendarDayEvent[] events +function C_Calendar.GetClubCalendarEvents(clubId, startTime, endTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetDayEvent) +---@param monthOffset number +---@param monthDay number +---@param index number +---@return CalendarDayEvent event +function C_Calendar.GetDayEvent(monthOffset, monthDay, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetDefaultGuildFilter) +---@return CalendarGuildFilterInfo info +function C_Calendar.GetDefaultGuildFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetEventIndex) +---@return CalendarEventIndexInfo info +function C_Calendar.GetEventIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetEventIndexInfo) +---@param eventID CalendarEventID +---@param monthOffset? number +---@param monthDay? number +---@return CalendarEventIndexInfo? eventIndexInfo +function C_Calendar.GetEventIndexInfo(eventID, monthOffset, monthDay) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetEventInfo) +---@return CalendarEventInfo info +function C_Calendar.GetEventInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetFirstPendingInvite) +---@param offsetMonths number +---@param monthDay number +---@return number? firstPendingInvite +function C_Calendar.GetFirstPendingInvite(offsetMonths, monthDay) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetGuildEventInfo) +---@param index number +---@return CalendarGuildEventInfo info +function C_Calendar.GetGuildEventInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetGuildEventSelectionInfo) +---@param index number +---@return CalendarEventIndexInfo info +function C_Calendar.GetGuildEventSelectionInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetHolidayInfo) +---@param monthOffset number +---@param monthDay number +---@param index number +---@return CalendarHolidayInfo event +function C_Calendar.GetHolidayInfo(monthOffset, monthDay, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetMaxCreateDate) +---@return CalendarTime maxCreateDate +function C_Calendar.GetMaxCreateDate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetMinDate) +---@return CalendarTime minDate +function C_Calendar.GetMinDate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetMonthInfo) +---@param offsetMonths? number Default = 0 +---@return CalendarMonthInfo monthInfo +function C_Calendar.GetMonthInfo(offsetMonths) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetNextClubId) +---@return ClubId? clubId +function C_Calendar.GetNextClubId() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetNumDayEvents) +---@param offsetMonths number +---@param monthDay number +---@return number numDayEvents +function C_Calendar.GetNumDayEvents(offsetMonths, monthDay) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetNumGuildEvents) +---@return number numGuildEvents +function C_Calendar.GetNumGuildEvents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetNumInvites) +---@return number num +function C_Calendar.GetNumInvites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetNumPendingInvites) +---@return number num +function C_Calendar.GetNumPendingInvites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.GetRaidInfo) +---@param offsetMonths number +---@param monthDay number +---@param eventIndex number +---@return CalendarRaidInfo info +function C_Calendar.GetRaidInfo(offsetMonths, monthDay, eventIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.IsActionPending) +---@return boolean actionPending +function C_Calendar.IsActionPending() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.IsEventOpen) +---@return boolean isOpen +function C_Calendar.IsEventOpen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.MassInviteCommunity) +---@param clubId ClubId +---@param minLevel number +---@param maxLevel number +---@param maxRankOrder? number +function C_Calendar.MassInviteCommunity(clubId, minLevel, maxLevel, maxRankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.MassInviteGuild) +---@param minLevel number +---@param maxLevel number +---@param maxRankOrder number +function C_Calendar.MassInviteGuild(minLevel, maxLevel, maxRankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.OpenCalendar) +function C_Calendar.OpenCalendar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.OpenEvent) +---@param offsetMonths number +---@param monthDay number +---@param index number +---@return boolean success +function C_Calendar.OpenEvent(offsetMonths, monthDay, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.RemoveEvent) +function C_Calendar.RemoveEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.SetAbsMonth) +---@param month number +---@param year number +function C_Calendar.SetAbsMonth(month, year) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.SetMonth) +---@param offsetMonths number +function C_Calendar.SetMonth(offsetMonths) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.SetNextClubId) +---@param clubId? ClubId +function C_Calendar.SetNextClubId(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Calendar.UpdateEvent) +function C_Calendar.UpdateEvent() end + +---@class CalendarDayEvent +---@field eventID CalendarEventID +---@field title string +---@field isCustomTitle boolean +---@field startTime CalendarTime +---@field endTime CalendarTime +---@field calendarType string +---@field sequenceType string +---@field eventType Enum.CalendarEventType +---@field iconTexture fileID? +---@field modStatus string +---@field inviteStatus Enum.CalendarStatus +---@field invitedBy string +---@field difficulty number +---@field inviteType Enum.CalendarInviteType +---@field sequenceIndex number +---@field numSequenceDays number +---@field difficultyName string +---@field dontDisplayBanner boolean +---@field dontDisplayEnd boolean +---@field clubID ClubId +---@field isLocked boolean + +---@class CalendarEventIndexInfo +---@field offsetMonths number +---@field monthDay number +---@field eventIndex number + +---@class CalendarEventInfo +---@field title string +---@field description string +---@field creator string? +---@field eventType Enum.CalendarEventType +---@field repeatOption Enum.CalendarEventRepeatOptions +---@field maxSize number +---@field textureIndex number? +---@field time CalendarTime +---@field lockoutTime CalendarTime +---@field isLocked boolean +---@field isAutoApprove boolean +---@field hasPendingInvite boolean +---@field inviteStatus Enum.CalendarStatus? +---@field inviteType Enum.CalendarInviteType? +---@field calendarType string +---@field communityName string? + +---@class CalendarEventInviteInfo +---@field name string? +---@field level number +---@field className string? +---@field classFilename string? +---@field inviteStatus Enum.CalendarStatus? +---@field modStatus string? +---@field inviteIsMine boolean +---@field type Enum.CalendarInviteType +---@field notes string +---@field classID number? +---@field guid WOWGUID + +---@class CalendarEventStatusOption +---@field status Enum.CalendarStatus +---@field statusString string + +---@class CalendarEventTextureInfo +---@field title string +---@field iconTexture fileID +---@field expansionLevel number +---@field difficultyId number? +---@field mapId number? +---@field isLfr boolean? + +---@class CalendarEventTypeDisplayInfo +---@field displayString string +---@field eventType Enum.CalendarEventType + +---@class CalendarGuildEventInfo +---@field eventID CalendarEventID +---@field year number +---@field month number +---@field monthDay number +---@field weekday number +---@field hour number +---@field minute number +---@field eventType Enum.CalendarEventType +---@field title string +---@field calendarType string +---@field texture fileID +---@field inviteStatus Enum.CalendarStatus +---@field clubID ClubId + +---@class CalendarGuildFilterInfo +---@field minLevel number +---@field maxLevel number +---@field rank number + +---@class CalendarHolidayInfo +---@field name string +---@field description string +---@field texture fileID +---@field startTime CalendarTime? +---@field endTime CalendarTime? + +---@class CalendarMonthInfo +---@field month number +---@field year number +---@field numDays number +---@field firstWeekday number + +---@class CalendarRaidInfo +---@field name string +---@field calendarType string +---@field raidID number +---@field time CalendarTime +---@field difficulty number +---@field difficultyName string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua new file mode 100644 index 0000000..3f8b22c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua @@ -0,0 +1,20 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCameraFOVDefaults) +---@return number fieldOfViewDegreesDefault +---@return number fieldOfViewDegreesPlayerMin +---@return number fieldOfViewDegreesPlayerMax +function GetCameraFOVDefaults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUICameraInfo) +---@param uiCameraID number +---@return number posX +---@return number posY +---@return number posZ +---@return number lookAtX +---@return number lookAtY +---@return number lookAtZ +---@return number animID +---@return number animVariation +---@return number animFrame +---@return boolean useModelCenter +function GetUICameraInfo(uiCameraID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua new file mode 100644 index 0000000..15e4dc2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua @@ -0,0 +1,322 @@ +---@meta _ +C_CatalogShop = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.BulkPurchaseProducts) +---@param productIDs number[] +---@return boolean canPurchaseProducts +function C_CatalogShop.BulkPurchaseProducts(productIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.BulkRefundDecors) +---@param decorGUIDs WOWGUID[] +function C_CatalogShop.BulkRefundDecors(decorGUIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.CloseCatalogShopInteraction) +function C_CatalogShop.CloseCatalogShopInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.ConfirmHousingPurchase) +---@param productIDs number[] +function C_CatalogShop.ConfirmHousingPurchase(productIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.FindBestCurrencyProductForNeededAmount) +---@param vcCurrencyCode string +---@param amountNeeded number +---@return number? vcProductID +function C_CatalogShop.FindBestCurrencyProductForNeededAmount(vcCurrencyCode, amountNeeded) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetAvailableCategoryIDs) +---@return number[] categoryIDs +function C_CatalogShop.GetAvailableCategoryIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetAvailableTransmogRaceInfos) +---@return AvailableRaceInfo[] raceIDs +function C_CatalogShop.GetAvailableTransmogRaceInfos() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetCatalogShopProductDisplayInfo) +---@param catalogShopProductID number +---@return CatalogShopProductDisplayInfo item +function C_CatalogShop.GetCatalogShopProductDisplayInfo(catalogShopProductID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetCategoryInfo) +---@param categoryID number +---@return CatalogShopCategoryInfo categoryInfo +function C_CatalogShop.GetCategoryInfo(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetCategorySectionInfo) +---@param categoryID number +---@param sectionID number +---@return CatalogShopSectionInfo sectionInfo +function C_CatalogShop.GetCategorySectionInfo(categoryID, sectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetFailureInfo) +---@return StoreError? errorResultEnum +---@return number? errorResultRaw +function C_CatalogShop.GetFailureInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetFirstCategoryByProductID) +---@param productID number +---@return CatalogShopCategoryInfo? categoryInfo +function C_CatalogShop.GetFirstCategoryByProductID(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetNewProducts) +---@return number[] newProducts +function C_CatalogShop.GetNewProducts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetProductAvailabilityTimeRemainingSecs) +---@param catalogShopProductID number +---@return number? timeRemainingSecs +function C_CatalogShop.GetProductAvailabilityTimeRemainingSecs(catalogShopProductID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetProductIDsForBundle) +---@param bundleProductID number +---@return CatalogShopBundleChildInfo[] childIDs +function C_CatalogShop.GetProductIDsForBundle(bundleProductID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetProductIDsForCategory) +---@param categoryID number +---@return number[] productIDs +function C_CatalogShop.GetProductIDsForCategory(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetProductIDsForCategorySection) +---@param categoryID number +---@param sectionID number +---@return number[] productIDs +function C_CatalogShop.GetProductIDsForCategorySection(categoryID, sectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetProductInfo) +---@param productID number +---@return CatalogShopProductInfo? productInfo +function C_CatalogShop.GetProductInfo(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetProductSortOrder) +---@param categoryID number +---@param sectionID number +---@param productID number +---@return number? sortOrder +function C_CatalogShop.GetProductSortOrder(categoryID, sectionID, productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetRefundableDecors) +---@param productIdFilterOpt? number +---@return RefundableDecorInfo[] refundableDecorInfos +---@return time_t minTimeRemainingSeconds +function C_CatalogShop.GetRefundableDecors(productIdFilterOpt) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetSectionIDsForCategory) +---@param categoryID number +---@return number[] sectionIDs +function C_CatalogShop.GetSectionIDsForCategory(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetSpellVisualInfoForMount) +---@param spellVisualID number +---@return CatalogShopSpellVisualInfo spellVisualInfo +function C_CatalogShop.GetSpellVisualInfoForMount(spellVisualID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetVCProductInfos) +---@return CatalogShopVCProductInfo[] vcProductInfos +function C_CatalogShop.GetVCProductInfos() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.GetVirtualCurrencyBalance) +---@param currencyCode string +---@return string? balance +function C_CatalogShop.GetVirtualCurrencyBalance(currencyCode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.HasNewProducts) +---@return boolean hasNewProducts +function C_CatalogShop.HasNewProducts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.IsProductIncludedInAnyBundle) +---@param productID number +---@return boolean isIncludedInAnyBundle +function C_CatalogShop.IsProductIncludedInAnyBundle(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.IsShop2Enabled) +---@return boolean? value +function C_CatalogShop.IsShop2Enabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.OnLegalDisclaimerClicked) +---@param catalogShopProductID number +function C_CatalogShop.OnLegalDisclaimerClicked(catalogShopProductID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.OnLegalPersonalizedOptOutClicked) +function C_CatalogShop.OnLegalPersonalizedOptOutClicked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.OpenCatalogShopInteractionFromHouse) +---@return string shoppingSessionUUIDStr +function C_CatalogShop.OpenCatalogShopInteractionFromHouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.OpenCatalogShopInteractionFromShop) +---@return string shoppingSessionUUIDStr +function C_CatalogShop.OpenCatalogShopInteractionFromShop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.ProductDisplayedTelemetry) +---@param categoryId number +---@param sectionId number +---@param catalogShopProductID number +function C_CatalogShop.ProductDisplayedTelemetry(categoryId, sectionId, catalogShopProductID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.ProductSelectedTelemetry) +---@param categoryId number +---@param sectionId number +---@param catalogShopProductID number +---@param wasCodeSelection boolean +function C_CatalogShop.ProductSelectedTelemetry(categoryId, sectionId, catalogShopProductID, wasCodeSelection) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.PurchaseProduct) +---@param productID number +---@return boolean canPurchase +function C_CatalogShop.PurchaseProduct(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.RefreshRefundableDecors) +function C_CatalogShop.RefreshRefundableDecors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.RefreshVirtualCurrencyBalance) +---@param currencyCode string +function C_CatalogShop.RefreshVirtualCurrencyBalance(currencyCode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.ShouldShowHousingWarning) +---@return boolean shouldShowHousingWarning +function C_CatalogShop.ShouldShowHousingWarning() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CatalogShop.StartHousingVCPurchaseConfirmation) +---@param productID number +function C_CatalogShop.StartHousingVCPurchaseConfirmation(productID) end + +---@class AvailableRaceInfo +---@field raceID number +---@field displayName string + +---@class BulkPurchaseIndividualProductResult +---@field recordId number +---@field parentProductId number? +---@field entitlementId string +---@field externalTransactionId string +---@field status Enum.SimpleOrderStatus + +---@class CatalogShopBundleChildInfo +---@field childProductID number +---@field displayOrder number +---@field quantityInBundle number + +---@class CatalogShopCategoryInfo +---@field ID number +---@field displayName string +---@field iconTexture string +---@field linkTag string +---@field isDisabled boolean +---@field showPersistentRefundButton boolean + +---@class CatalogShopProductDisplayInfo +---@field defaultPreviewModelSceneID number +---@field defaultCardModelSceneID number +---@field defaultWideCardModelSceneID number +---@field itemID number +---@field overridePreviewModelSceneID number? +---@field overrideCardModelSceneID number? +---@field overrideWideCardModelSceneID number? +---@field creatureDisplayInfoIDs number[] +---@field spellVisualIDs number[] +---@field mainHandItemModifiedAppearanceID number? +---@field offHandItemModifiedAppearanceID number? +---@field itemModifiedAppearanceIDs number[] +---@field iconFileDataID number? +---@field iconTextureKit textureKit? +---@field productType string? +---@field itemDescription string? +---@field hasUnknownLicense boolean +---@field productPMTURL string? +---@field additionalProductPMTURLs string[] +---@field otherProductImageAtlasName string? +---@field otherProductGameTitleBaseTag string? +---@field otherProductGameType string? +---@field customLoopingSoundStart number? +---@field customLoopingSoundMiddle number? +---@field customLoopingSoundEnd number? +---@field specialActorID_1 string? +---@field specialActorID_2 string? +---@field specialActorID_3 string? +---@field specialActorID_4 string? +---@field specialActorID_5 string? +---@field gameFlavorID number? +---@field decorFileDataID number? +---@field quantity number? +---@field houseTextureAtlas textureAtlas? + +---@class CatalogShopProductInfo +---@field catalogShopProductID number +---@field name string +---@field type string? +---@field description string +---@field iconTexture string +---@field isFullyOwned boolean +---@field isPurchasePending boolean +---@field refundable boolean +---@field price string +---@field originalPrice string +---@field discountPercentage number +---@field itemID number +---@field mountID number +---@field mountTypeName string +---@field speciesID number +---@field transmogSetID number +---@field itemModifiedAppearanceID number +---@field subItems CatalogShopSubItemInfo[] +---@field subItemsLoaded boolean +---@field backgroundTexture string +---@field foregroundTexture string? +---@field smallCardBGTexture string? +---@field smallCardFGTexture string? +---@field wideCardBGTexture string? +---@field wideCardFGTexture string? +---@field previewIconTexture string? +---@field optionalWideCardBackgroundTexture string? +---@field isBundle boolean +---@field bundleChildrenSize number +---@field licenseTermType number +---@field licenseTermDuration number +---@field virtualCurrencies CatalogShopVirtualCurrency[] +---@field isHidden boolean +---@field hasPendingOrders boolean +---@field numBundleDetailCards number +---@field isDynamicallyDiscounted boolean +---@field shouldShowOriginalPrice boolean +---@field wideCardBGOverrideProductURL string? +---@field previewBGOverrideProductURL string? +---@field previewSmallBGOverrideProductURL string? +---@field decorQuantity DecorQuantity? +---@field isVCProduct boolean +---@field containsHousingItem boolean + +---@class CatalogShopSectionInfo +---@field ID number +---@field displayName string +---@field parentCatalogShopCategoryInfoID number? +---@field cardType string? +---@field scrollGridSize number? +---@field shouldShowRecommendationOptOutDisclaimer boolean + +---@class CatalogShopSpellVisualInfo +---@field animID number? +---@field spellVisualKitID number? + +---@class CatalogShopSubItemInfo +---@field name string +---@field itemID number +---@field itemAppearanceID number +---@field invType string +---@field quality Enum.ItemQuality + +---@class CatalogShopVCProductInfo +---@field vcProductID number + +---@class CatalogShopVirtualCurrency +---@field amount number +---@field currencyCode string + +---@class DecorQuantity +---@field placedQuantity number +---@field storedQuantity number + +---@class RefundableDecorInfo +---@field decorGUID WOWGUID +---@field timeRemainingSeconds time_t +---@field name string +---@field price string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua new file mode 100644 index 0000000..81ee33a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua @@ -0,0 +1,194 @@ +---@meta _ +C_ChallengeMode = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.CanUseKeystoneInCurrentMap) +---@param itemLocation ItemLocation +---@return boolean canUse +function C_ChallengeMode.CanUseKeystoneInCurrentMap(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.ClearKeystone) +function C_ChallengeMode.ClearKeystone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.CloseKeystoneFrame) +function C_ChallengeMode.CloseKeystoneFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetActiveChallengeMapID) +---@return number? mapChallengeModeID +function C_ChallengeMode.GetActiveChallengeMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetActiveKeystoneInfo) +---@return number activeKeystoneLevel +---@return number[] activeAffixIDs +---@return boolean wasActiveKeystoneCharged +function C_ChallengeMode.GetActiveKeystoneInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetAffixInfo) +---@param affixID number +---@return string name +---@return string description +---@return number filedataid +function C_ChallengeMode.GetAffixInfo(affixID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetChallengeCompletionInfo) +---@return ChallengeCompletionInfo info +function C_ChallengeMode.GetChallengeCompletionInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetDeathCount) +---@return number numDeaths +---@return number timeLost +function C_ChallengeMode.GetDeathCount() end + +---Returns a color value from the passed in overall season M+ rating. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetDungeonScoreRarityColor) +---@param dungeonScore number +---@return colorRGB scoreColor +function C_ChallengeMode.GetDungeonScoreRarityColor(dungeonScore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetGuildLeaders) +---@return ChallengeModeGuildTopAttempt[] topAttempt +function C_ChallengeMode.GetGuildLeaders() end + +---Returns a color value from the passed in keystone level. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetKeystoneLevelRarityColor) +---@param level number +---@return colorRGB levelScore +function C_ChallengeMode.GetKeystoneLevelRarityColor(level) end + +---Returns how much time is left before player is automatically flagged as a leaver (and removed from the group) for exiting a restricted challenge mode instance +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetLeaverPenaltyWarningTimeLeft) +---@return number? timeLeftSeconds Default = 0 +function C_ChallengeMode.GetLeaverPenaltyWarningTimeLeft() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetMapScoreInfo) +---@return MythicPlusRatingLinkInfo[] displayScores +function C_ChallengeMode.GetMapScoreInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetMapTable) +---@return number[] mapChallengeModeIDs +function C_ChallengeMode.GetMapTable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetMapUIInfo) +---@param mapChallengeModeID number +---@return string name +---@return number id +---@return number timeLimit +---@return number? texture +---@return number backgroundTexture +---@return number mapID +function C_ChallengeMode.GetMapUIInfo(mapChallengeModeID) end + +---Gets the overall season mythic+ rating for the player. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetOverallDungeonScore) +---@return number overallDungeonScore +function C_ChallengeMode.GetOverallDungeonScore() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetPowerLevelDamageHealthMod) +---@param powerLevel number +---@return number damageMod +---@return number healthMod +function C_ChallengeMode.GetPowerLevelDamageHealthMod(powerLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetSlottedKeystoneInfo) +---@return number mapChallengeModeID +---@return number[] affixIDs +---@return number keystoneLevel +function C_ChallengeMode.GetSlottedKeystoneInfo() end + +---Returns a color value from the passed in mythic+ rating from the combined affix scores for a specific dungeon +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetSpecificDungeonOverallScoreRarityColor) +---@param specificDungeonOverallScore number +---@return colorRGB specificDungeonOverallScoreColor +function C_ChallengeMode.GetSpecificDungeonOverallScoreRarityColor(specificDungeonOverallScore) end + +---Returns a color value from the passed in mythic+ rating for a specific dungeon. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetSpecificDungeonScoreRarityColor) +---@param specificDungeonScore number +---@return colorRGB specificDungeonScoreColor +function C_ChallengeMode.GetSpecificDungeonScoreRarityColor(specificDungeonScore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetStartTime) +---@return number startTime +function C_ChallengeMode.GetStartTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.HasSlottedKeystone) +---@return boolean hasSlottedKeystone +function C_ChallengeMode.HasSlottedKeystone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.IsChallengeModeActive) +---@return boolean challengeModeActive +function C_ChallengeMode.IsChallengeModeActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.IsChallengeModeResettable) +---@return boolean canReset +function C_ChallengeMode.IsChallengeModeResettable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.RemoveKeystone) +---@return boolean removalSuccessful +function C_ChallengeMode.RemoveKeystone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.RequestLeaders) +---@param mapChallengeModeID number +function C_ChallengeMode.RequestLeaders(mapChallengeModeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.Reset) +function C_ChallengeMode.Reset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.SlotKeystone) +function C_ChallengeMode.SlotKeystone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.StartChallengeMode) +---@return boolean success +function C_ChallengeMode.StartChallengeMode() end + +---@class ChallengeCompletionInfo +---@field mapChallengeModeID number? Default = 0 +---@field level number? Default = 0 +---@field time number? Default = 0 +---@field onTime boolean? Default = false +---@field keystoneUpgradeLevels number? Default = 0 +---@field practiceRun boolean? Default = false +---@field oldOverallDungeonScore number? +---@field newOverallDungeonScore number? +---@field isMapRecord boolean? Default = false +---@field isAffixRecord boolean? Default = false +---@field isEligibleForScore boolean? Default = false +---@field members ChallengeModeCompletionMemberInfo[] + +---@class ChallengeModeBestTime +---@field mapChallengeModeID number +---@field durationMs number +---@field members ChallengeModeBestTimeMember[] + +---@class ChallengeModeBestTimeMember +---@field name string +---@field classFileName string +---@field className string +---@field specializationID number + +---@class ChallengeModeCompletionMemberInfo +---@field memberGUID WOWGUID +---@field name string + +---@class ChallengeModeGuildAttemptMember +---@field name string +---@field classFileName string + +---@class ChallengeModeGuildTopAttempt +---@field name string +---@field classFileName string +---@field keystoneLevel number +---@field mapChallengeModeID number +---@field isYou boolean +---@field members ChallengeModeGuildAttemptMember[] + +---@class ChallengeModeReward +---@field rewardID number +---@field displayInfoID number +---@field quantity number +---@field isCurrency boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua new file mode 100644 index 0000000..d134425 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua @@ -0,0 +1,37 @@ +---@meta _ +---@class CharCustomizationCategory +---@field id number +---@field orderIndex number +---@field name string +---@field icon textureAtlas +---@field selectedIcon textureAtlas +---@field undressModel boolean +---@field subcategory boolean +---@field cameraZoomLevel number +---@field cameraDistanceOffset number +---@field spellShapeshiftFormID number? +---@field chrModelID number? +---@field options CharCustomizationOption[] +---@field hasNewChoices boolean +---@field needsNativeFormCategory boolean + +---@class CharCustomizationChoice +---@field id number +---@field name string +---@field ineligibleChoice boolean +---@field isNew boolean +---@field swatchColor1 colorRGB? +---@field swatchColor2 colorRGB? +---@field soundKit number? +---@field isLocked boolean +---@field lockedText string? + +---@class CharCustomizationOption +---@field id number +---@field name string +---@field orderIndex number +---@field optionType Enum.ChrCustomizationOptionType +---@field choices CharCustomizationChoice[] +---@field currentChoiceIndex number? +---@field hasNewChoices boolean +---@field isSound boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua new file mode 100644 index 0000000..796b192 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +C_ChatBubbles = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatBubbles.GetAllChatBubbles) +---@param includeForbidden? boolean Default = false +---@return ChatBubbleFrame[] chatBubbles +function C_ChatBubbles.GetAllChatBubbles(includeForbidden) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua new file mode 100644 index 0000000..179c470 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +---@class ChatChannelInfo +---@field name string +---@field shortcut string +---@field localID number +---@field instanceID number +---@field zoneChannelID number +---@field channelType Enum.PermanentChatChannelType diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua new file mode 100644 index 0000000..8e9f124 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua @@ -0,0 +1,260 @@ +---@meta _ +C_ChatInfo = {} + +---Returns false if addons are allowed to send outgoing chat messages. This is controlled on a realm-by-realm basis (tournament realms allow it), and the ability for addons to receive comms is controlled separately. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.AreOutgoingAddonChatMessagesRestricted) +---@return boolean isRestricted +function C_ChatInfo.AreOutgoingAddonChatMessagesRestricted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.CanPlayerSpeakLanguage) +---@param languageId number +---@return boolean canSpeakLanguage +function C_ChatInfo.CanPlayerSpeakLanguage(languageId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.CancelEmote) +function C_ChatInfo.CancelEmote() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.DropCautionaryChatMessage) +---@param confirmNumber number +function C_ChatInfo.DropCautionaryChatMessage(confirmNumber) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChannelInfoFromIdentifier) +---@param channelIdentifier string +---@return ChatChannelInfo? info +function C_ChatInfo.GetChannelInfoFromIdentifier(channelIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChannelRosterInfo) +---@param channelIndex number +---@param rosterIndex number +---@return string name +---@return boolean owner +---@return boolean moderator +---@return WOWGUID guid +function C_ChatInfo.GetChannelRosterInfo(channelIndex, rosterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChannelRuleset) +---@param channelIndex number +---@return Enum.ChatChannelRuleset ruleset +function C_ChatInfo.GetChannelRuleset(channelIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChannelRulesetForChannelID) +---@param channelID number +---@return Enum.ChatChannelRuleset ruleset +function C_ChatInfo.GetChannelRulesetForChannelID(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChannelShortcut) +---@param channelIndex number +---@return string shortcut +function C_ChatInfo.GetChannelShortcut(channelIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChannelShortcutForChannelID) +---@param channelID number +---@return string shortcut +function C_ChatInfo.GetChannelShortcutForChannelID(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChatLineSenderGUID) +---@param chatLine number +---@return WOWGUID guid +function C_ChatInfo.GetChatLineSenderGUID(chatLine) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChatLineSenderName) +---@param chatLine number +---@return string name +function C_ChatInfo.GetChatLineSenderName(chatLine) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChatLineText) +---@param chatLine number +---@return string text +function C_ChatInfo.GetChatLineText(chatLine) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetChatTypeName) +---@param typeID number +---@return string? name +function C_ChatInfo.GetChatTypeName(typeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetClubStreamIDs) +---@param clubID ClubId +---@return ClubStreamId[] ids +function C_ChatInfo.GetClubStreamIDs(clubID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetColorForChatType) +---@param chatType string +---@return colorRGB? color +function C_ChatInfo.GetColorForChatType(chatType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetGeneralChannelID) +---@return number channelID +function C_ChatInfo.GetGeneralChannelID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetGeneralChannelLocalID) +---@return number? localID +function C_ChatInfo.GetGeneralChannelLocalID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetMentorChannelID) +---@return number channelID +function C_ChatInfo.GetMentorChannelID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetNumActiveChannels) +---@return number numChannels +function C_ChatInfo.GetNumActiveChannels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetNumReservedChatWindows) +---@return number numReserved +function C_ChatInfo.GetNumReservedChatWindows() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.GetRegisteredAddonMessagePrefixes) +---@return string[] registeredPrefixes +function C_ChatInfo.GetRegisteredAddonMessagePrefixes() end + +---Returns true if API security restrictions regarding chat messaging are in effect. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.InChatMessagingLockdown) +---@return boolean isRestricted +function C_ChatInfo.InChatMessagingLockdown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsAddonMessagePrefixRegistered) +---@param prefix string +---@return boolean isRegistered +function C_ChatInfo.IsAddonMessagePrefixRegistered(prefix) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsChannelRegional) +---@param channelIndex number +---@return boolean isRegional +function C_ChatInfo.IsChannelRegional(channelIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsChannelRegionalForChannelID) +---@param channelID number +---@return boolean isRegional +function C_ChatInfo.IsChannelRegionalForChannelID(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsChatLineCensored) +---@param chatLine number +---@return boolean isCensored +function C_ChatInfo.IsChatLineCensored(chatLine) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsLoggingChat) +---@return boolean enabled +function C_ChatInfo.IsLoggingChat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsLoggingCombat) +---@return boolean enabled +---@return boolean advanced +function C_ChatInfo.IsLoggingCombat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsPartyChannelType) +---@param channelType Enum.ChatChannelType +---@return boolean isPartyChannelType +function C_ChatInfo.IsPartyChannelType(channelType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsRegionalServiceAvailable) +---@return boolean available +function C_ChatInfo.IsRegionalServiceAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsTimerunningPlayer) +---@param playerGUID WOWGUID +---@return boolean isTimerunning +function C_ChatInfo.IsTimerunningPlayer(playerGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsValidChatLine) +---@param chatLine? number +---@return boolean isValid +function C_ChatInfo.IsValidChatLine(chatLine) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.IsValidCombatFilterName) +---@param name string +---@return boolean isApproved +function C_ChatInfo.IsValidCombatFilterName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.PerformEmote) +---@param emoteName string +---@param targetName? string +---@param suppressMoveError? boolean Default = false +---@return boolean success +function C_ChatInfo.PerformEmote(emoteName, targetName, suppressMoveError) end + +---Registers interest in addon messages with this prefix, cannot be an empty string. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.RegisterAddonMessagePrefix) +---@param prefix string +---@return Enum.RegisterAddonMessagePrefixResult result +function C_ChatInfo.RegisterAddonMessagePrefix(prefix) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.ReplaceIconAndGroupExpressions) +---@param input string +---@param noIconReplacement? boolean +---@param noGroupReplacement? boolean +---@return string output +function C_ChatInfo.ReplaceIconAndGroupExpressions(input, noIconReplacement, noGroupReplacement) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.RequestCanLocalWhisperTarget) +---@param whisperTarget WOWGUID +function C_ChatInfo.RequestCanLocalWhisperTarget(whisperTarget) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.ResetDefaultZoneChannels) +function C_ChatInfo.ResetDefaultZoneChannels() end + +---Sends a text payload to other clients specified by chatChannel and target which are registered to listen for prefix. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.SendAddonMessage) +---@param prefix string +---@param message string +---@param chatType? string +---@param target? string +---@return Enum.SendAddonMessageResult result +function C_ChatInfo.SendAddonMessage(prefix, message, chatType, target) end + +---Sends a text payload to other clients specified by chatChannel and target which are registered to listen for prefix. Intended for plain text payloads; logged and throttled. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.SendAddonMessageLogged) +---@param prefix string +---@param message string +---@param chatType? string +---@param target? string +---@return Enum.SendAddonMessageResult? result +function C_ChatInfo.SendAddonMessageLogged(prefix, message, chatType, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.SendCautionaryChatMessage) +---@param confirmNumber number +function C_ChatInfo.SendCautionaryChatMessage(confirmNumber) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.SendChatMessage) +---@param message string +---@param chatType? SendChatMessageType +---@param languageID? number +---@param target? string +function C_ChatInfo.SendChatMessage(message, chatType, languageID, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.SwapChatChannelsByChannelIndex) +---@param firstChannelIndex number +---@param secondChannelIndex number +function C_ChatInfo.SwapChatChannelsByChannelIndex(firstChannelIndex, secondChannelIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.UncensorChatLine) +---@param chatLine number +function C_ChatInfo.UncensorChatLine(chatLine) end + +---@class ChatMessageEventParams +---@field text string +---@field playerName string +---@field languageName string +---@field channelName string +---@field playerName2 string +---@field specialFlags string +---@field zoneChannelID number +---@field channelIndex number +---@field channelBaseName string +---@field languageID number +---@field lineID number +---@field guid WOWGUID +---@field bnSenderID number +---@field isMobile boolean +---@field isSubtitle boolean +---@field hideSenderInLetterbox boolean +---@field suppressRaidIcons boolean + +---@class SendChatMessageParams +---@field message string +---@field chatType SendChatMessageType? +---@field languageID number? +---@field target string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatSharedDocumentation.lua new file mode 100644 index 0000000..da87c56 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChatSharedDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +---@class AddonMessageParams +---@field prefix string +---@field message string +---@field chatType string? +---@field target string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua new file mode 100644 index 0000000..f6f80af --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua @@ -0,0 +1,29 @@ +---@meta _ +C_ChromieTime = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChromieTime.CloseUI) +function C_ChromieTime.CloseUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChromieTime.GetChromieTimeExpansionOption) +---@param expansionRecID number +---@return ChromieTimeExpansionInfo? info +function C_ChromieTime.GetChromieTimeExpansionOption(expansionRecID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChromieTime.GetChromieTimeExpansionOptions) +---@return ChromieTimeExpansionInfo[] expansionOptions +function C_ChromieTime.GetChromieTimeExpansionOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ChromieTime.SelectChromieTimeOption) +---@param chromieTimeExpansionInfoId number +function C_ChromieTime.SelectChromieTimeOption(chromieTimeExpansionInfoId) end + +---@class ChromieTimeExpansionInfo +---@field id number +---@field name string +---@field description string +---@field mapAtlas textureAtlas +---@field previewAtlas textureAtlas +---@field completed boolean +---@field alreadyOn boolean +---@field recommended boolean +---@field sortPriority number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua new file mode 100644 index 0000000..3013566 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicFinished) +---@param movieType Enum.CinematicType +---@param userCanceled? boolean Default = false +---@param didError? boolean Default = false +function CinematicFinished(movieType, userCanceled, didError) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicStarted) +---@param movieType Enum.CinematicType +---@param movieID number +---@param canCancel? boolean Default = true +function CinematicStarted(movieType, movieID, canCancel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentCinematicSummary) +---@return string summary +function GetCurrentCinematicSummary() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InCinematic) +---@return boolean inCinematic +function InCinematic() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MouseOverrideCinematicDisable) +---@param doOverride? boolean Default = false +function MouseOverrideCinematicDisable(doOverride) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_OpeningCinematic) +function OpeningCinematic() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StopCinematic) +function StopCinematic() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua new file mode 100644 index 0000000..b4e355f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua @@ -0,0 +1,15 @@ +---@meta _ +C_CinematicList = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CinematicList.GetUICinematicList) +---@return UICinematic[] cinematics +function C_CinematicList.GetUICinematicList() end + +---@class UICinematic +---@field expansion number +---@field movieIDs number[] +---@field buttonUpAtlas textureAtlas +---@field buttonDownAtlas textureAtlas +---@field title string? +---@field disableAutoPlay boolean +---@field orderID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua new file mode 100644 index 0000000..c2a7a8c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +C_ClassColor = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassColor.GetClassColor) +---@param className ClassFile +---@return colorRGB classColor +function C_ClassColor.GetClassColor(className) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua new file mode 100644 index 0000000..efa27ac --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua @@ -0,0 +1,189 @@ +---@meta _ +C_ClassTalents = {} + +---Returns true only if the player has staged changes and can commit their talents in their current state. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.CanChangeTalents) +---@return boolean canChange +---@return boolean canAdd +---@return string? changeError +function C_ClassTalents.CanChangeTalents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.CanCreateNewConfig) +---@return boolean canCreate +function C_ClassTalents.CanCreateNewConfig() end + +---Returns true if the player could switch talents if they staged a proper loadout. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.CanEditTalents) +---@return boolean canEdit +---@return string changeError +function C_ClassTalents.CanEditTalents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.CommitConfig) +---@param savedConfigID? number +---@return boolean success +function C_ClassTalents.CommitConfig(savedConfigID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.DeleteConfig) +---@param configID number +---@return boolean success +function C_ClassTalents.DeleteConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetActiveConfigID) +---@return number? activeConfigID +function C_ClassTalents.GetActiveConfigID() end + +---Returns the SubTreeID of the player's active Hero Talent Specialization SubTree. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetActiveHeroTalentSpec) +---@return number? heroSpecID +function C_ClassTalents.GetActiveHeroTalentSpec() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetConfigIDsBySpecID) +---@param specID? number +---@return number[] configIDs +function C_ClassTalents.GetConfigIDsBySpecID(specID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetHasStarterBuild) +---@return boolean hasStarterBuild +function C_ClassTalents.GetHasStarterBuild() end + +---Returns the SubTreeIDs of the Hero Talent Specializations available to a Class Specialization and config; Returns nothing if none available +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetHeroTalentSpecsForClassSpec) +---@param configID? number +---@param classSpecID? number +---@return number[]? subTreeIDs +---@return number? requiredPlayerLevel +function C_ClassTalents.GetHeroTalentSpecsForClassSpec(configID, classSpecID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetLastSelectedSavedConfigID) +---@param specID number +---@return number? configID +function C_ClassTalents.GetLastSelectedSavedConfigID(specID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetNextStarterBuildPurchase) +---@return number? nodeID +---@return number? entryID +function C_ClassTalents.GetNextStarterBuildPurchase() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetStarterBuildActive) +---@return boolean isActive +function C_ClassTalents.GetStarterBuildActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.GetTraitTreeForSpec) +---@param specID number +---@return number? treeID +function C_ClassTalents.GetTraitTreeForSpec(specID) end + +---Returns whether the player has any unspent talent points in their active hero talent tree. If hasUnspentPoints is true, numHeroPoints will be greater than zero. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.HasUnspentHeroTalentPoints) +---@return boolean hasUnspentPoints +---@return number numHeroPoints +function C_ClassTalents.HasUnspentHeroTalentPoints() end + +---Returns whether the player has any unspent talent points in their class or spec talent trees. If hasUnspentPoints is true, the number of unspent points for at least one of the trees will be greater than zero. Hero talent points are not included by this function. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.HasUnspentTalentPoints) +---@return boolean hasUnspentPoints +---@return number numClassPoints +---@return number numSpecPoints +function C_ClassTalents.HasUnspentTalentPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.ImportLoadout) +---@param configID number +---@param entries ImportLoadoutEntryInfo[] +---@param name string +---@param importString? string +---@return boolean success +---@return string importError +function C_ClassTalents.ImportLoadout(configID, entries, name, importString) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.InitializeViewLoadout) +---@param specID number +---@param level number +function C_ClassTalents.InitializeViewLoadout(specID, level) end + +---New configs may or may not be populated and ready to load immediately after creation. Avoid calling for configs intentionally created empty. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.IsConfigPopulated) +---@param configID number +---@return boolean isPopulated +function C_ClassTalents.IsConfigPopulated(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.LoadConfig) +---@param configID number +---@param autoApply boolean +---@return Enum.LoadConfigResult result +---@return string? changeError +---@return number[] newLearnedNodeIDs +function C_ClassTalents.LoadConfig(configID, autoApply) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.RenameConfig) +---@param configID number +---@param name string +---@return boolean success +function C_ClassTalents.RenameConfig(configID, name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.RequestNewConfig) +---@param name string +---@return boolean success +function C_ClassTalents.RequestNewConfig(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SaveConfig) +---@param configID number +---@return boolean success +function C_ClassTalents.SaveConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SetStarterBuildActive) +---@param active boolean +---@return Enum.LoadConfigResult result +function C_ClassTalents.SetStarterBuildActive(active) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SetUsesSharedActionBars) +---@param configID number +---@param usesShared boolean +function C_ClassTalents.SetUsesSharedActionBars(configID, usesShared) end + +---Loads loadout for the current specialization by dropdown index. Indices start at 1. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SwitchToLoadoutByIndex) +---@param loadoutIndex number +function C_ClassTalents.SwitchToLoadoutByIndex(loadoutIndex) end + +---Loads loadout for the current specialization by name. Loads the first one found in the case of duplicate names. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SwitchToLoadoutByName) +---@param loadoutName string +function C_ClassTalents.SwitchToLoadoutByName(loadoutName) end + +---Activates specialization for the current class by index in the order within the Specializations tab. Indices start at 1. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SwitchToSpecializationByIndex) +---@param specIndex number +function C_ClassTalents.SwitchToSpecializationByIndex(specIndex) end + +---Activates specialization for the current class by spec name. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.SwitchToSpecializationByName) +---@param specName string +function C_ClassTalents.SwitchToSpecializationByName(specName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.UpdateLastSelectedSavedConfigID) +---@param specID number +---@param configID? number +function C_ClassTalents.UpdateLastSelectedSavedConfigID(specID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTalents.ViewLoadout) +---@param entries ImportLoadoutEntryInfo[] +---@param importString? string +---@return boolean success +function C_ClassTalents.ViewLoadout(entries, importString) end + +---@class ImportLoadoutEntryInfo +---@field nodeID number +---@field ranksGranted number +---@field ranksPurchased number +---@field selectionEntryID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua new file mode 100644 index 0000000..96fee4a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +---@class ClickBindingInfo +---@field type Enum.ClickBindingType +---@field actionID number +---@field button string +---@field modifiers number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua new file mode 100644 index 0000000..21e0af0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua @@ -0,0 +1,52 @@ +---@meta _ +C_ClickBindings = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.CanSpellBeClickBound) +---@param spellID SpellIdentifier +---@return boolean canBeBound +function C_ClickBindings.CanSpellBeClickBound(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.ExecuteBinding) +---@param targetToken string +---@param button string +---@param modifiers number +function C_ClickBindings.ExecuteBinding(targetToken, button, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.GetBindingType) +---@param button string +---@param modifiers number +---@return Enum.ClickBindingType type +function C_ClickBindings.GetBindingType(button, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.GetEffectiveInteractionButton) +---@param button string +---@param modifiers number +---@return string effectiveButton +function C_ClickBindings.GetEffectiveInteractionButton(button, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.GetProfileInfo) +---@return ClickBindingInfo[] infoVec +function C_ClickBindings.GetProfileInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.GetStringFromModifiers) +---@param modifiers number +---@return string modifierString +function C_ClickBindings.GetStringFromModifiers(modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.GetTutorialShown) +---@return boolean tutorialShown +function C_ClickBindings.GetTutorialShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.MakeModifiers) +---@return number modifiers +function C_ClickBindings.MakeModifiers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.ResetCurrentProfile) +function C_ClickBindings.ResetCurrentProfile() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.SetProfileByInfo) +---@param infoVec ClickBindingInfo[] +function C_ClickBindings.SetProfileByInfo(infoVec) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClickBindings.SetTutorialShown) +function C_ClickBindings.SetTutorialShown() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua new file mode 100644 index 0000000..fc06e81 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua @@ -0,0 +1,38 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlashClientIcon) +---@param briefly? boolean Default = false +function FlashClientIcon(briefly) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBillingTimeRested) +---@return number billingTimeRested +function GetBillingTimeRested() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFileIDFromPath) +---@param filePath string +---@return fileID fileID +function GetFileIDFromPath(filePath) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFramerate) +---@return number framerate +function GetFramerate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsCpuBound) +---@return boolean? isCpuBound +function IsCpuBound() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ReportBug) +---@param description string +function ReportBug(description) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ReportSuggestion) +---@param description string +function ReportSuggestion(description) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RestartGx) +function RestartGx() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Screenshot) +function Screenshot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UpdateWindow) +function UpdateWindow() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua new file mode 100644 index 0000000..454ad38 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua @@ -0,0 +1,661 @@ +---@meta _ +C_Club = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.AcceptInvitation) +---@param clubId ClubId +function C_Club.AcceptInvitation(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.AddClubStreamChatChannel) +---@param clubId ClubId +---@param streamId ClubStreamId +function C_Club.AddClubStreamChatChannel(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.AdvanceStreamViewMarker) +---@param clubId ClubId +---@param streamId ClubStreamId +function C_Club.AdvanceStreamViewMarker(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.AreMembersReady) +---@param clubId ClubId +---@return boolean membersReady +function C_Club.AreMembersReady(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.AssignMemberRole) +---@param clubId ClubId +---@param memberId number +---@param roleId Enum.ClubRoleIdentifier +function C_Club.AssignMemberRole(clubId, memberId, roleId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.CanResolvePlayerLocationFromClubMessageData) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param epoch BigUInteger +---@param position BigUInteger +---@return boolean canResolve +function C_Club.CanResolvePlayerLocationFromClubMessageData(clubId, streamId, epoch, position) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.ClearAutoAdvanceStreamViewMarker) +function C_Club.ClearAutoAdvanceStreamViewMarker() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.ClearClubPresenceSubscription) +function C_Club.ClearClubPresenceSubscription() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.CompareBattleNetDisplayName) +---@param clubId ClubId +---@param lhsMemberId number +---@param rhsMemberId number +---@return number comparison +function C_Club.CompareBattleNetDisplayName(clubId, lhsMemberId, rhsMemberId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.CreateClub) +---@param name string +---@param shortName? string +---@param description string +---@param clubType Enum.ClubType +---@param avatarId number +---@param isCrossFaction? boolean +function C_Club.CreateClub(name, shortName, description, clubType, avatarId, isCrossFaction) end + +---Check the canCreateStream privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.CreateStream) +---@param clubId ClubId +---@param name string +---@param subject string +---@param leadersAndModeratorsOnly boolean +function C_Club.CreateStream(clubId, name, subject, leadersAndModeratorsOnly) end + +---Check canCreateTicket privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.CreateTicket) +---@param clubId ClubId +---@param allowedRedeemCount? number +---@param duration? number +---@param defaultStreamId? ClubStreamId +---@param isCrossFaction? boolean +function C_Club.CreateTicket(clubId, allowedRedeemCount, duration, defaultStreamId, isCrossFaction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DeclineInvitation) +---@param clubId ClubId +function C_Club.DeclineInvitation(clubId) end + +---Check the canDestroy privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DestroyClub) +---@param clubId ClubId +function C_Club.DestroyClub(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DestroyMessage) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param messageId ClubMessageIdentifier +function C_Club.DestroyMessage(clubId, streamId, messageId) end + +---Check canDestroyStream privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DestroyStream) +---@param clubId ClubId +---@param streamId ClubStreamId +function C_Club.DestroyStream(clubId, streamId) end + +---Check canDestroyTicket privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DestroyTicket) +---@param clubId ClubId +---@param ticketId string +function C_Club.DestroyTicket(clubId, ticketId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DoesAnyCommunityHaveUnreadMessages) +---@return boolean hasUnreadMessages +function C_Club.DoesAnyCommunityHaveUnreadMessages() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.DoesCommunityHaveMembersOfTheOppositeFaction) +---@param clubId ClubId +---@return boolean hasMembersOfOppositeFaction +function C_Club.DoesCommunityHaveMembersOfTheOppositeFaction(clubId) end + +---nil arguments will not change existing club data +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.EditClub) +---@param clubId ClubId +---@param name? string +---@param shortName? string +---@param description? string +---@param avatarId? number +---@param broadcast? string +---@param crossFaction? boolean +function C_Club.EditClub(clubId, name, shortName, description, avatarId, broadcast, crossFaction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.EditMessage) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param messageId ClubMessageIdentifier +---@param message string +function C_Club.EditMessage(clubId, streamId, messageId, message) end + +---Check the canSetStreamName, canSetStreamSubject, canSetStreamAccess privileges. nil arguments will not change existing stream data. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.EditStream) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param name? string +---@param subject? string +---@param leadersAndModeratorsOnly? boolean +function C_Club.EditStream(clubId, streamId, name, subject, leadersAndModeratorsOnly) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.Flush) +function C_Club.Flush() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.FocusCommunityStreams) +function C_Club.FocusCommunityStreams() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.FocusMembers) +---@param clubId ClubId +function C_Club.FocusMembers(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.FocusStream) +---@param clubId ClubId +---@param streamId ClubStreamId +---@return boolean focused +function C_Club.FocusStream(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetAssignableRoles) +---@param clubId ClubId +---@param memberId number +---@return Enum.ClubRoleIdentifier[] assignableRoles +function C_Club.GetAssignableRoles(clubId, memberId) end + +---listen for AVATAR_LIST_UPDATED event. This can happen if we haven't downloaded the battle.net avatar list yet +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetAvatarIdList) +---@param clubType Enum.ClubType +---@return number[]? avatarIds +function C_Club.GetAvatarIdList(clubType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetClubCapacity) +---@return number capacity +function C_Club.GetClubCapacity() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetClubInfo) +---@param clubId ClubId +---@return ClubInfo? info +function C_Club.GetClubInfo(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetClubLimits) +---@param clubType Enum.ClubType +---@return ClubLimits clubLimits +function C_Club.GetClubLimits(clubType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetClubMembers) +---@param clubId ClubId +---@param streamId? ClubStreamId +---@return number[] members +function C_Club.GetClubMembers(clubId, streamId) end + +---The privileges for the logged in user for this club +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetClubPrivileges) +---@param clubId ClubId +---@return ClubPrivilegeInfo privilegeInfo +function C_Club.GetClubPrivileges(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetClubStreamNotificationSettings) +---@param clubId ClubId +---@return ClubStreamNotificationSetting[] settings +function C_Club.GetClubStreamNotificationSettings(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetCommunityNameResultText) +---@param result Enum.ValidateNameResult +---@return string? errorCode +function C_Club.GetCommunityNameResultText(result) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetGuildClubId) +---@return ClubId? guildClubId +function C_Club.GetGuildClubId() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetInfoFromLastCommunityChatLine) +---@return ClubMessageInfo messageInfo +---@return ClubId clubId +---@return ClubStreamId streamId +---@return Enum.ClubType clubType +function C_Club.GetInfoFromLastCommunityChatLine() end + +---Returns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetInvitationCandidates) +---@param filter? string +---@param maxResults? number +---@param cursorPosition? number +---@param allowFullMatch? boolean +---@param clubId ClubId +---@return ClubInvitationCandidateInfo[] candidates +function C_Club.GetInvitationCandidates(filter, maxResults, cursorPosition, allowFullMatch, clubId) end + +---Get info about a specific club the active player has been invited to. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetInvitationInfo) +---@param clubId ClubId +---@return ClubSelfInvitationInfo? invitation +function C_Club.GetInvitationInfo(clubId) end + +---Get the pending invitations for this club. Call RequestInvitationsForClub() to retrieve invitations from server. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetInvitationsForClub) +---@param clubId ClubId +---@return ClubInvitationInfo[] invitations +function C_Club.GetInvitationsForClub(clubId) end + +---These are the clubs the active player has been invited to. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetInvitationsForSelf) +---@return ClubSelfInvitationInfo[] invitations +function C_Club.GetInvitationsForSelf() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetLastTicketResponse) +---@param ticket string +---@return Enum.ClubErrorType error +---@return ClubInfo? info +---@return boolean showError +function C_Club.GetLastTicketResponse(ticket) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetMemberInfo) +---@param clubId ClubId +---@param memberId number +---@return ClubMemberInfo? info +function C_Club.GetMemberInfo(clubId, memberId) end + +---Info for the logged in user for this club +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetMemberInfoForSelf) +---@param clubId ClubId +---@return ClubMemberInfo? info +function C_Club.GetMemberInfoForSelf(clubId) end + +---Get info about a particular message. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetMessageInfo) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param messageId ClubMessageIdentifier +---@return ClubMessageInfo? message +function C_Club.GetMessageInfo(clubId, streamId, messageId) end + +---Get the ranges of the messages currently downloaded. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetMessageRanges) +---@param clubId ClubId +---@param streamId ClubStreamId +---@return ClubMessageRange[] ranges +function C_Club.GetMessageRanges(clubId, streamId) end + +---Get downloaded messages before (and including) the specified messageId limited by count. These are filtered by ignored players +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetMessagesBefore) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param newest ClubMessageIdentifier +---@param count number +---@return ClubMessageInfo[] messages +function C_Club.GetMessagesBefore(clubId, streamId, newest, count) end + +---Get downloaded messages in the given range. These are filtered by ignored players +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetMessagesInRange) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param oldest ClubMessageIdentifier +---@param newest ClubMessageIdentifier +---@return ClubMessageInfo[] messages +function C_Club.GetMessagesInRange(clubId, streamId, oldest, newest) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetStreamInfo) +---@param clubId ClubId +---@param streamId ClubStreamId +---@return ClubStreamInfo? streamInfo +function C_Club.GetStreamInfo(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetStreamViewMarker) +---@param clubId ClubId +---@param streamId ClubStreamId +---@return BigUInteger? lastReadTime +function C_Club.GetStreamViewMarker(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetStreams) +---@param clubId ClubId +---@return ClubStreamInfo[] streams +function C_Club.GetStreams(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetSubscribedClubs) +---@return ClubInfo[] clubs +function C_Club.GetSubscribedClubs() end + +---Get the existing tickets for this club. Call RequestTickets() to retrieve tickets from server. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.GetTickets) +---@param clubId ClubId +---@return ClubTicketInfo[] tickets +function C_Club.GetTickets(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.IsAccountMuted) +---@param clubId ClubId +---@return boolean accountMuted +function C_Club.IsAccountMuted(clubId) end + +---Returns whether the given message is the first message in the stream, taking into account ignored messages +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.IsBeginningOfStream) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param messageId ClubMessageIdentifier +---@return boolean isBeginningOfStream +function C_Club.IsBeginningOfStream(clubId, streamId, messageId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.IsEnabled) +---@return boolean clubsEnabled +function C_Club.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.IsRestricted) +---@return Enum.ClubRestrictionReason restrictionReason +function C_Club.IsRestricted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.IsSubscribedToStream) +---@param clubId ClubId +---@param streamId ClubStreamId +---@return boolean subscribed +function C_Club.IsSubscribedToStream(clubId, streamId) end + +---Check kickableRoleIds privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.KickMember) +---@param clubId ClubId +---@param memberId number +function C_Club.KickMember(clubId, memberId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.LeaveClub) +---@param clubId ClubId +function C_Club.LeaveClub(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.RedeemTicket) +---@param ticketId string +function C_Club.RedeemTicket(ticketId) end + +---Request invitations for this club from server. Check canGetInvitation privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.RequestInvitationsForClub) +---@param clubId ClubId +function C_Club.RequestInvitationsForClub(clubId) end + +---Call this when the user scrolls near the top of the message view, and more need to be displayed. The history will be downloaded backwards (newest to oldest). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.RequestMoreMessagesBefore) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param messageId? ClubMessageIdentifier +---@param count? number +---@return boolean alreadyHasMessages +function C_Club.RequestMoreMessagesBefore(clubId, streamId, messageId, count) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.RequestTicket) +---@param ticketId string +function C_Club.RequestTicket(ticketId) end + +---Request tickets from server. Check canGetTicket privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.RequestTickets) +---@param clubId ClubId +function C_Club.RequestTickets(clubId) end + +---Check canRevokeOwnInvitation or canRevokeOtherInvitation +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.RevokeInvitation) +---@param clubId ClubId +---@param memberId number +function C_Club.RevokeInvitation(clubId, memberId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SendBattleTagFriendRequest) +---@param guildClubId ClubId +---@param memberId number +function C_Club.SendBattleTagFriendRequest(guildClubId, memberId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SendCharacterInvitation) +---@param clubId ClubId +---@param character string +function C_Club.SendCharacterInvitation(clubId, character) end + +---Check the canSendInvitation privilege. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SendInvitation) +---@param clubId ClubId +---@param memberId number +function C_Club.SendInvitation(clubId, memberId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SendMessage) +---@param clubId ClubId +---@param streamId ClubStreamId +---@param message string +function C_Club.SendMessage(clubId, streamId, message) end + +---Only one stream can be set for auto-advance at a time. Focused streams will have their view times advanced automatically. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetAutoAdvanceStreamViewMarker) +---@param clubId ClubId +---@param streamId ClubStreamId +function C_Club.SetAutoAdvanceStreamViewMarker(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetAvatarTexture) +---@param texture SimpleTexture +---@param avatarId number +---@param clubType Enum.ClubType +function C_Club.SetAvatarTexture(texture, avatarId, clubType) end + +---Check the canSetOwnMemberNote and canSetOtherMemberNote privileges. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetClubMemberNote) +---@param clubId ClubId +---@param memberId number +---@param note string +function C_Club.SetClubMemberNote(clubId, memberId, note) end + +---You can only be subscribed to 0 or 1 clubs for presence. Subscribing to a new club automatically unsuscribes you to existing subscription. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetClubPresenceSubscription) +---@param clubId ClubId +function C_Club.SetClubPresenceSubscription(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetClubStreamNotificationSettings) +---@param clubId ClubId +---@param settings ClubStreamNotificationSetting[] +function C_Club.SetClubStreamNotificationSettings(clubId, settings) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetCommunityID) +---@param communityID BigUInteger +function C_Club.SetCommunityID(communityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetFavorite) +---@param clubId ClubId +---@param isFavorite boolean +function C_Club.SetFavorite(clubId, isFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.SetSocialQueueingEnabled) +---@param clubId ClubId +---@param enabled boolean +function C_Club.SetSocialQueueingEnabled(clubId, enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.ShouldAllowClubType) +---@param clubType Enum.ClubType +---@return boolean clubTypeIsAllowed +function C_Club.ShouldAllowClubType(clubType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.UnfocusAllStreams) +---@param unsubscribe boolean +function C_Club.UnfocusAllStreams(unsubscribe) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.UnfocusMembers) +---@param clubId ClubId +function C_Club.UnfocusMembers(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.UnfocusStream) +---@param clubId ClubId +---@param streamId ClubStreamId +function C_Club.UnfocusStream(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Club.ValidateText) +---@param clubType Enum.ClubType +---@param text string +---@param clubFieldType Enum.ClubFieldType +---@return Enum.ValidateNameResult result +function C_Club.ValidateText(clubType, text, clubFieldType) end + +---@class ClubInfo +---@field clubId ClubId +---@field name string +---@field shortName string? +---@field description string +---@field broadcast string +---@field clubType Enum.ClubType +---@field avatarId number +---@field memberCount number? +---@field favoriteTimeStamp BigUInteger? +---@field joinTime BigUInteger? +---@field socialQueueingEnabled boolean? +---@field crossFaction boolean? + +---@class ClubInvitationCandidateInfo +---@field memberId number +---@field name string +---@field priority number +---@field status Enum.ClubInvitationCandidateStatus + +---@class ClubInvitationInfo +---@field invitationId ClubInvitationId +---@field isMyInvitation boolean +---@field invitee ClubMemberInfo + +---@class ClubLimits +---@field maximumNumberOfStreams number + +---@class ClubMemberInfo +---@field isSelf boolean +---@field memberId number +---@field name string? +---@field role Enum.ClubRoleIdentifier? +---@field presence Enum.ClubMemberPresence +---@field clubType Enum.ClubType? +---@field guid WOWGUID? +---@field bnetAccountId number? +---@field memberNote string? +---@field officerNote string? +---@field classID number? +---@field race number? +---@field level number? +---@field zone string? +---@field achievementPoints number? +---@field profession1ID number? +---@field profession1Rank number? +---@field profession1Name string? +---@field profession2ID number? +---@field profession2Rank number? +---@field profession2Name string? +---@field lastOnlineYear number? +---@field lastOnlineMonth number? +---@field lastOnlineDay number? +---@field lastOnlineHour number? +---@field guildRank string? +---@field guildRankOrder number? +---@field isRemoteChat boolean? +---@field overallDungeonScore number? +---@field faction Enum.PvPFaction? +---@field timerunningSeasonID number? + +---@class ClubMessageIdentifier +---@field epoch BigUInteger +---@field position BigUInteger + +---@class ClubMessageInfo +---@field messageId ClubMessageIdentifier +---@field content kstringClubMessage +---@field author ClubMemberInfo +---@field destroyer ClubMemberInfo? +---@field destroyed boolean +---@field edited boolean + +---@class ClubMessageRange +---@field oldestMessageId ClubMessageIdentifier +---@field newestMessageId ClubMessageIdentifier + +---@class ClubPrivilegeInfo +---@field canDestroy boolean +---@field canSetAttribute boolean +---@field canSetName boolean +---@field canSetDescription boolean +---@field canSetAvatar boolean +---@field canSetBroadcast boolean +---@field canSetPrivacyLevel boolean +---@field canSetOwnMemberAttribute boolean +---@field canSetOtherMemberAttribute boolean +---@field canSetOwnMemberNote boolean +---@field canSetOtherMemberNote boolean +---@field canSetOwnVoiceState boolean +---@field canSetOwnPresenceLevel boolean +---@field canUseVoice boolean +---@field canVoiceMuteMemberForAll boolean +---@field canGetInvitation boolean +---@field canSendInvitation boolean +---@field canSendGuestInvitation boolean +---@field canRevokeOwnInvitation boolean +---@field canRevokeOtherInvitation boolean +---@field canGetBan boolean +---@field canGetSuggestion boolean +---@field canSuggestMember boolean +---@field canGetTicket boolean +---@field canCreateTicket boolean +---@field canDestroyTicket boolean +---@field canAddBan boolean +---@field canRemoveBan boolean +---@field canCreateStream boolean +---@field canDestroyStream boolean +---@field canSetStreamPosition boolean +---@field canSetStreamAttribute boolean +---@field canSetStreamName boolean +---@field canSetStreamSubject boolean +---@field canSetStreamAccess boolean +---@field canSetStreamVoiceLevel boolean +---@field canCreateMessage boolean +---@field canDestroyOwnMessage boolean +---@field canDestroyOtherMessage boolean +---@field canEditOwnMessage boolean +---@field canPinMessage boolean +---@field kickableRoleIds number[] + +---@class ClubRoleInfo +---@field roleId number +---@field name string +---@field required boolean +---@field unique boolean + +---@class ClubSelfInvitationInfo +---@field invitationId ClubInvitationId +---@field club ClubInfo +---@field inviter ClubMemberInfo +---@field leaders ClubMemberInfo[] + +---@class ClubStreamInfo +---@field streamId ClubStreamId +---@field name string +---@field subject string +---@field leadersAndModeratorsOnly boolean +---@field streamType Enum.ClubStreamType +---@field creationTime BigUInteger + +---@class ClubStreamNotificationSetting +---@field streamId ClubStreamId +---@field filter Enum.ClubStreamNotificationFilter + +---@class ClubTicketInfo +---@field ticketId string +---@field allowedRedeemCount number +---@field currentRedeemCount number +---@field creationTime BigUInteger +---@field expirationTime BigUInteger +---@field defaultStreamId ClubStreamId? +---@field creator ClubMemberInfo diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua new file mode 100644 index 0000000..33f6d53 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua @@ -0,0 +1,315 @@ +---@meta _ +C_ClubFinder = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ApplicantAcceptClubInvite) +---@param clubFinderGUID WOWGUID +function C_ClubFinder.ApplicantAcceptClubInvite(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ApplicantDeclineClubInvite) +---@param clubFinderGUID WOWGUID +function C_ClubFinder.ApplicantDeclineClubInvite(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.CancelMembershipRequest) +---@param clubFinderGUID WOWGUID +function C_ClubFinder.CancelMembershipRequest(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.CheckAllPlayerApplicantSettings) +function C_ClubFinder.CheckAllPlayerApplicantSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ClearAllFinderCache) +function C_ClubFinder.ClearAllFinderCache() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ClearClubApplicantsCache) +function C_ClubFinder.ClearClubApplicantsCache() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ClearClubFinderPostingsCache) +function C_ClubFinder.ClearClubFinderPostingsCache() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.DoesPlayerBelongToClubFromClubGUID) +---@param clubFinderGUID WOWGUID +---@return boolean belongsToClub +function C_ClubFinder.DoesPlayerBelongToClubFromClubGUID(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetClubFinderDisableReason) +---@return Enum.ClubFinderDisableReason? disableReason +function C_ClubFinder.GetClubFinderDisableReason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetClubRecruitmentSettings) +---@return ClubSettingsInfo settings +function C_ClubFinder.GetClubRecruitmentSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetClubTypeFromFinderGUID) +---@param clubFinderGUID WOWGUID +---@return Enum.ClubFinderRequestType clubType +function C_ClubFinder.GetClubTypeFromFinderGUID(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetFocusIndexFromFlag) +---@param flags number +---@return number index +function C_ClubFinder.GetFocusIndexFromFlag(flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetPlayerApplicantLocaleFlags) +---@return number localeFlags +function C_ClubFinder.GetPlayerApplicantLocaleFlags() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetPlayerApplicantSettings) +---@return ClubSettingsInfo settings +function C_ClubFinder.GetPlayerApplicantSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetPlayerClubApplicationStatus) +---@param clubFinderGUID WOWGUID +---@return Enum.PlayerClubRequestStatus clubStatus +function C_ClubFinder.GetPlayerClubApplicationStatus(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount) +---@return number focusCount +function C_ClubFinder.GetPlayerSettingsFocusFlagsSelectedCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetPostingIDFromClubFinderGUID) +---@param clubFinderGUID WOWGUID +---@return number? postingID +function C_ClubFinder.GetPostingIDFromClubFinderGUID(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetRecruitingClubInfoFromClubID) +---@param clubId ClubId +---@return RecruitingClubInfo? clubInfo +function C_ClubFinder.GetRecruitingClubInfoFromClubID(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetRecruitingClubInfoFromFinderGUID) +---@param clubFinderGUID WOWGUID +---@return RecruitingClubInfo clubInfo +function C_ClubFinder.GetRecruitingClubInfoFromFinderGUID(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetStatusOfPostingFromClubId) +---@param postingID ClubId +---@return Enum.ClubFinderClubPostingStatusFlags[] postingFlags +function C_ClubFinder.GetStatusOfPostingFromClubId(postingID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetTotalMatchingCommunityListSize) +---@return number totalSize +function C_ClubFinder.GetTotalMatchingCommunityListSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.GetTotalMatchingGuildListSize) +---@return number totalSize +function C_ClubFinder.GetTotalMatchingGuildListSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.HasAlreadyAppliedToLinkedPosting) +---@param clubFinderGUID WOWGUID +---@return boolean hasAlreadyApplied +function C_ClubFinder.HasAlreadyAppliedToLinkedPosting(clubFinderGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.HasPostingBeenDelisted) +---@param postingID ClubId +---@return boolean postingDelisted +function C_ClubFinder.HasPostingBeenDelisted(postingID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.IsCommunityFinderEnabled) +---@return boolean isEnabled +function C_ClubFinder.IsCommunityFinderEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.IsEnabled) +---@return boolean isEnabled +function C_ClubFinder.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.IsListingEnabledFromFlags) +---@param flags number +---@return boolean isListed +function C_ClubFinder.IsListingEnabledFromFlags(flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.IsPostingBanned) +---@param postingID ClubId +---@return boolean postingBanned +function C_ClubFinder.IsPostingBanned(postingID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.IsValidSearchString) +---@param name string +---@return boolean isApproved +function C_ClubFinder.IsValidSearchString(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.LookupClubPostingFromClubFinderGUID) +---@param clubFinderGUID WOWGUID +---@param isLinkedPosting boolean +function C_ClubFinder.LookupClubPostingFromClubFinderGUID(clubFinderGUID, isLinkedPosting) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.PlayerGetClubInvitationList) +---@return RecruitingClubInfo[] inviteList +function C_ClubFinder.PlayerGetClubInvitationList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.PlayerRequestPendingClubsList) +---@param type Enum.ClubFinderRequestType +function C_ClubFinder.PlayerRequestPendingClubsList(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.PlayerReturnPendingCommunitiesList) +---@return RecruitingClubInfo[] info +function C_ClubFinder.PlayerReturnPendingCommunitiesList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.PlayerReturnPendingGuildsList) +---@return RecruitingClubInfo[] info +function C_ClubFinder.PlayerReturnPendingGuildsList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.PostClub) +---@param clubId ClubId +---@param itemLevelRequirement number +---@param name string +---@param description string +---@param avatarId number +---@param specs number[] +---@param type Enum.ClubFinderRequestType +---@param crossFaction? boolean Default = false +---@return boolean succesful +function C_ClubFinder.PostClub(clubId, itemLevelRequirement, name, description, avatarId, specs, type, crossFaction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestApplicantList) +---@param type Enum.ClubFinderRequestType +function C_ClubFinder.RequestApplicantList(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestClubsList) +---@param guildListRequested boolean +---@param searchString string +---@param specIDs number[] +function C_ClubFinder.RequestClubsList(guildListRequested, searchString, specIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestMembershipToClub) +---@param clubFinderGUID WOWGUID +---@param comment string +---@param specIDs number[] +function C_ClubFinder.RequestMembershipToClub(clubFinderGUID, comment, specIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestNextCommunityPage) +---@param startingIndex number +---@param pageSize number +function C_ClubFinder.RequestNextCommunityPage(startingIndex, pageSize) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestNextGuildPage) +---@param startingIndex number +---@param pageSize number +function C_ClubFinder.RequestNextGuildPage(startingIndex, pageSize) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestPostingInformationFromClubId) +---@param clubId ClubId +---@return boolean success +function C_ClubFinder.RequestPostingInformationFromClubId(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RequestSubscribedClubPostingIDs) +function C_ClubFinder.RequestSubscribedClubPostingIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ResetClubPostingMapCache) +function C_ClubFinder.ResetClubPostingMapCache() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.RespondToApplicant) +---@param clubFinderGUID WOWGUID +---@param playerGUID WOWGUID +---@param shouldAccept boolean +---@param requestType Enum.ClubFinderRequestType +---@param playerName string +---@param forceAccept boolean +---@param reported? boolean +function C_ClubFinder.RespondToApplicant(clubFinderGUID, playerGUID, shouldAccept, requestType, playerName, forceAccept, reported) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ReturnClubApplicantList) +---@param clubId ClubId +---@return ClubFinderApplicantInfo[] info +function C_ClubFinder.ReturnClubApplicantList(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ReturnMatchingCommunityList) +---@return RecruitingClubInfo[] recruitingClubs +function C_ClubFinder.ReturnMatchingCommunityList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ReturnMatchingGuildList) +---@return RecruitingClubInfo[] recruitingClubs +function C_ClubFinder.ReturnMatchingGuildList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ReturnPendingClubApplicantList) +---@param clubId ClubId +---@return ClubFinderApplicantInfo[] info +function C_ClubFinder.ReturnPendingClubApplicantList(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.SendChatWhisper) +---@param clubFinderGUID WOWGUID +---@param playerGUID WOWGUID +---@param applicantType Enum.ClubFinderRequestType +---@param name string +function C_ClubFinder.SendChatWhisper(clubFinderGUID, playerGUID, applicantType, name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.SetAllRecruitmentSettings) +---@param value number +function C_ClubFinder.SetAllRecruitmentSettings(value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.SetPlayerApplicantLocaleFlags) +---@param localeFlags number +function C_ClubFinder.SetPlayerApplicantLocaleFlags(localeFlags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.SetPlayerApplicantSettings) +---@param index number +---@param checked boolean +function C_ClubFinder.SetPlayerApplicantSettings(index, checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.SetRecruitmentLocale) +---@param locale number +function C_ClubFinder.SetRecruitmentLocale(locale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.SetRecruitmentSettings) +---@param index number +---@param checked boolean +function C_ClubFinder.SetRecruitmentSettings(index, checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClubFinder.ShouldShowClubFinder) +---@return boolean shouldShow +function C_ClubFinder.ShouldShowClubFinder() end + +---@class ClubFinderApplicantInfo +---@field clubFinderGUID WOWGUID +---@field playerGUID WOWGUID +---@field closed number +---@field name string +---@field message string +---@field level number +---@field classID number +---@field ilvl number +---@field specIds number[] +---@field requestStatus Enum.PlayerClubRequestStatus +---@field lookupSuccess boolean +---@field lastUpdatedTime BigInteger +---@field faction number + +---@class ClubSettingsInfo +---@field playStyleDungeon boolean +---@field playStyleRaids boolean +---@field playStylePvp boolean +---@field playStyleRP boolean +---@field playStyleSocial boolean +---@field roleTank boolean +---@field roleHealer boolean +---@field roleDps boolean +---@field sizeSmall boolean +---@field sizeMedium boolean +---@field sizeLarge boolean +---@field maxLevelOnly boolean +---@field enableListing boolean +---@field sortRelevance boolean +---@field sortMembers boolean +---@field sortNewest boolean +---@field autoAccept boolean +---@field crossFaction boolean + +---@class RecruitingClubInfo +---@field clubFinderGUID WOWGUID +---@field numActiveMembers number +---@field name string +---@field comment string +---@field guildLeader string +---@field isGuild boolean +---@field emblemInfo number +---@field tabardInfo GuildTabardInfo? +---@field recruitingSpecIds number[] +---@field recruitmentFlags number +---@field localeSet boolean +---@field recruitmentLocale number +---@field minILvl number +---@field cached number +---@field cacheRequested number +---@field lastPosterGUID WOWGUID +---@field clubId ClubId +---@field lastUpdatedTime BigInteger +---@field isCrossFaction boolean +---@field realmName string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua new file mode 100644 index 0000000..f038fcb --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua @@ -0,0 +1,34 @@ +---@meta _ +C_ColorOverrides = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorOverrides.ClearColorOverrides) +function C_ColorOverrides.ClearColorOverrides() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorOverrides.GetColorForQuality) +---@param quality Enum.ItemQuality +---@return colorRGBA color +function C_ColorOverrides.GetColorForQuality(quality) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorOverrides.GetColorOverrideInfo) +---@param overrideType Enum.ColorOverride +---@return ColorOverrideInfo? overrideInfo +function C_ColorOverrides.GetColorOverrideInfo(overrideType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorOverrides.GetDefaultColorForQuality) +---@param quality Enum.ItemQuality +---@return colorRGBA color +function C_ColorOverrides.GetDefaultColorForQuality(quality) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorOverrides.RemoveColorOverride) +---@param overrideType Enum.ColorOverride +function C_ColorOverrides.RemoveColorOverride(overrideType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorOverrides.SetColorOverride) +---@param overrideType Enum.ColorOverride +---@param color colorRGBA +function C_ColorOverrides.SetColorOverride(overrideType, color) end + +---@class ColorOverrideInfo +---@field overrideType Enum.ColorOverride +---@field overrideColor colorRGB +---@field overrideColorString string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua new file mode 100644 index 0000000..5ddfb50 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua @@ -0,0 +1,69 @@ +---@meta _ +C_ColorUtil = {} + +---Converts an unpacked HSL color to HSV. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.ConvertHSLToHSV) +---@param hslH number +---@param hslS number +---@param hslL number +---@return number hsvH +---@return number hsvS +---@return number hsvV +function C_ColorUtil.ConvertHSLToHSV(hslH, hslS, hslL) end + +---Converts an unpacked HSV color to HSL. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.ConvertHSVToHSL) +---@param hsvH number +---@param hsvS number +---@param hsvV number +---@return number hslH +---@return number hslS +---@return number hslL +function C_ColorUtil.ConvertHSVToHSL(hsvH, hsvS, hsvV) end + +---Converts an unpacked HSV color to RGB. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.ConvertHSVToRGB) +---@param hsvH number +---@param hsvS number +---@param hsvV number +---@return number rgbR +---@return number rgbG +---@return number rgbB +function C_ColorUtil.ConvertHSVToRGB(hsvH, hsvS, hsvV) end + +---Converts an unpacked RGB color to HSV. For achromatic inputs, the returned hue will be -1. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.ConvertRGBToHSV) +---@param rgbR number +---@param rgbG number +---@param rgbB number +---@return number hsvH +---@return number hsvS +---@return number hsvV +function C_ColorUtil.ConvertRGBToHSV(rgbR, rgbG, rgbB) end + +---Generates a hex color code suitable for use in text color code markup. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.GenerateTextColorCode) +---@param color colorRGB +---@return string textColorCode +function C_ColorUtil.GenerateTextColorCode(color) end + +---Wraps a given string with color code markup. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.WrapTextInColor) +---@param text string +---@param color colorRGB +---@return string coloredText +function C_ColorUtil.WrapTextInColor(text, color) end + +---Wraps a given string with color code markup. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ColorUtil.WrapTextInColorCode) +---@param text string +---@param textColorCode string +---@return string coloredText +function C_ColorUtil.WrapTextInColorCode(text, textColorCode) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua new file mode 100644 index 0000000..7af3162 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua @@ -0,0 +1,88 @@ +---@meta _ +C_CombatAudioAlert = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.AddToKnownTargetingList) +---@param unit UnitToken +---@return boolean added +function C_CombatAudioAlert.AddToKnownTargetingList(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.GetCategoryVoice) +---@param category Enum.CombatAudioAlertCategory +---@return number voice +function C_CombatAudioAlert.GetCategoryVoice(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.GetCategoryVolume) +---@param category Enum.CombatAudioAlertCategory +---@return number volume +function C_CombatAudioAlert.GetCategoryVolume(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.GetFormatSetting) +---@param unit Enum.CombatAudioAlertUnit +---@param alertType Enum.CombatAudioAlertType +---@return number formatVal +function C_CombatAudioAlert.GetFormatSetting(unit, alertType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.GetSpeakerSpeed) +---@return number speed +function C_CombatAudioAlert.GetSpeakerSpeed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.GetSpecSetting) +---@param setting Enum.CombatAudioAlertSpecSetting +---@return number value +function C_CombatAudioAlert.GetSpecSetting(setting) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.GetThrottle) +---@param throttleType Enum.CombatAudioAlertThrottle +---@return number throttle +function C_CombatAudioAlert.GetThrottle(throttleType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.IsEnabled) +---@return boolean isEnabled +function C_CombatAudioAlert.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.RemoveFromKnownTargetingList) +---@param unit UnitToken +---@return boolean removed +function C_CombatAudioAlert.RemoveFromKnownTargetingList(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SetCategoryVoice) +---@param category Enum.CombatAudioAlertCategory +---@param newVal number +---@return boolean success +function C_CombatAudioAlert.SetCategoryVoice(category, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SetCategoryVolume) +---@param category Enum.CombatAudioAlertCategory +---@param newVal number +---@return boolean success +function C_CombatAudioAlert.SetCategoryVolume(category, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SetFormatSetting) +---@param unit Enum.CombatAudioAlertUnit +---@param alertType Enum.CombatAudioAlertType +---@param newVal number +---@return boolean success +function C_CombatAudioAlert.SetFormatSetting(unit, alertType, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SetSpeakerSpeed) +---@param newVal number +---@return boolean success +function C_CombatAudioAlert.SetSpeakerSpeed(newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SetSpecSetting) +---@param setting Enum.CombatAudioAlertSpecSetting +---@param newVal number +---@return boolean success +function C_CombatAudioAlert.SetSpecSetting(setting, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SetThrottle) +---@param throttleType Enum.CombatAudioAlertThrottle +---@param newVal number +---@return boolean success +function C_CombatAudioAlert.SetThrottle(throttleType, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatAudioAlert.SpeakText) +---@param text string +---@param category Enum.CombatAudioAlertCategory +---@param allowOverlap? boolean Default = true +function C_CombatAudioAlert.SpeakText(text, category, allowOverlap) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua new file mode 100644 index 0000000..91c88ce --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua @@ -0,0 +1,46 @@ +---@meta _ +C_CombatLog = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.ApplyFilterSettings) +---@param filterSettings LuaValueVariant +function C_CombatLog.ApplyFilterSettings(filterSettings) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.AreFilteredEventsEnabled) +---@return boolean enabled +function C_CombatLog.AreFilteredEventsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.ClearEntries) +function C_CombatLog.ClearEntries() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.DoesObjectMatchFilter) +---@param mask Enum.CombatLogObject +---@param flags Enum.CombatLogObject +---@return boolean matches +function C_CombatLog.DoesObjectMatchFilter(mask, flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.GetEntryRetentionTime) +---@return number retentionTime +function C_CombatLog.GetEntryRetentionTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.GetMessageLimit) +---@return number messageLimit +function C_CombatLog.GetMessageLimit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.IsCombatLogRestricted) +---@return boolean restricted +function C_CombatLog.IsCombatLogRestricted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.RefilterEntries) +function C_CombatLog.RefilterEntries() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.SetEntryRetentionTime) +---@param retentionTime number +function C_CombatLog.SetEntryRetentionTime(retentionTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.SetFilteredEventsEnabled) +---@param enabled boolean +function C_CombatLog.SetFilteredEventsEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLog.SetMessageLimit) +---@param messageLimit number +function C_CombatLog.SetMessageLimit(messageLimit) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua new file mode 100644 index 0000000..292cb70 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua @@ -0,0 +1,5 @@ +---@meta _ +C_CombatLogInternal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogInternal.GetCurrentEventInfo) +function C_CombatLogInternal.GetCurrentEventInfo() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua new file mode 100644 index 0000000..f6901fc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +C_CombatLogSecure = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.AddEventFilter) +function C_CombatLogSecure.AddEventFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.ClearEventFilters) +function C_CombatLogSecure.ClearEventFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.CreateCombatLogMessage) +---@param message string +---@param colorR number +---@param colorG number +---@param colorB number +---@param order Enum.CombatLogMessageOrder +function C_CombatLogSecure.CreateCombatLogMessage(message, colorR, colorG, colorB, order) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.GetCurrentEntryInfo) +function C_CombatLogSecure.GetCurrentEntryInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.GetCurrentEventInfo) +function C_CombatLogSecure.GetCurrentEventInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.GetEntryCount) +---@param ignoreFilter? boolean Default = false +---@return number count +function C_CombatLogSecure.GetEntryCount(ignoreFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.SeekToNewestEntry) +---@param ignoreFilter? boolean Default = false +---@return boolean isValidEntry +function C_CombatLogSecure.SeekToNewestEntry(ignoreFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.SeekToPreviousEntry) +---@param ignoreFilter? boolean Default = false +---@return boolean isValidEntry +function C_CombatLogSecure.SeekToPreviousEntry(ignoreFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatLogSecure.ShouldShowCurrentEntry) +---@return boolean shouldShow +function C_CombatLogSecure.ShouldShowCurrentEntry() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua new file mode 100644 index 0000000..5fcc9bc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua @@ -0,0 +1,2 @@ +---@meta _ +---@class CombatLogEventInfo diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua new file mode 100644 index 0000000..0bfc9bf --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +C_CombatText = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatText.GetActiveUnit) +---@return string? unitTarget +function C_CombatText.GetActiveUnit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatText.GetCurrentEventInfo) +function C_CombatText.GetCurrentEventInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CombatText.SetActiveUnit) +---@param unitToken UnitToken +function C_CombatText.SetActiveUnit(unitToken) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua new file mode 100644 index 0000000..871e82f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua @@ -0,0 +1,2 @@ +---@meta _ +---@class CombatTextEventInfo diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua new file mode 100644 index 0000000..7c0d020 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua @@ -0,0 +1,782 @@ +---@meta _ +C_Commentator = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AddPlayerOverrideName) +---@param playerName string +---@param overrideName string +function C_Commentator.AddPlayerOverrideName(playerName, overrideName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AddTrackedDefensiveAuras) +---@param spellIDs number[] +function C_Commentator.AddTrackedDefensiveAuras(spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AddTrackedOffensiveAuras) +---@param spellIDs number[] +function C_Commentator.AddTrackedOffensiveAuras(spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AreTeamsSwapped) +---@return boolean teamsAreSwapped +function C_Commentator.AreTeamsSwapped() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AssignPlayerToTeam) +---@param playerName string +---@param teamName string +function C_Commentator.AssignPlayerToTeam(playerName, teamName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AssignPlayersToTeam) +---@param playerName string[] +---@param teamName string +function C_Commentator.AssignPlayersToTeam(playerName, teamName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.AssignPlayersToTeamInCurrentInstance) +---@param teamIndex number +---@param teamName string +function C_Commentator.AssignPlayersToTeamInCurrentInstance(teamIndex, teamName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.CanUseCommentatorCheats) +---@return boolean canUseCommentatorCheats +function C_Commentator.CanUseCommentatorCheats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ClearCameraTarget) +function C_Commentator.ClearCameraTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ClearFollowTarget) +function C_Commentator.ClearFollowTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ClearLookAtTarget) +---@param lookAtIndex? number +function C_Commentator.ClearLookAtTarget(lookAtIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.EnterInstance) +function C_Commentator.EnterInstance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ExitInstance) +function C_Commentator.ExitInstance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.FindSpectatedUnit) +---@param unitToken UnitToken +---@return number playerIndex +---@return number teamIndex +---@return boolean isPet +function C_Commentator.FindSpectatedUnit(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.FindTeamNameInCurrentInstance) +---@param teamIndex number +---@return string? teamName +function C_Commentator.FindTeamNameInCurrentInstance(teamIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.FindTeamNameInDirectory) +---@param playerNames string[] +---@return string? teamName +function C_Commentator.FindTeamNameInDirectory(playerNames) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.FlushCommentatorHistory) +function C_Commentator.FlushCommentatorHistory() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.FollowPlayer) +---@param factionIndex number +---@param playerIndex number +---@param forceInstantTransition? boolean +function C_Commentator.FollowPlayer(factionIndex, playerIndex, forceInstantTransition) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.FollowUnit) +---@param token string +function C_Commentator.FollowUnit(token) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ForceFollowTransition) +function C_Commentator.ForceFollowTransition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetAdditionalCameraWeight) +---@return number teamIndex +---@return number playerIndex +function C_Commentator.GetAdditionalCameraWeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetAdditionalCameraWeightByToken) +---@param unitToken UnitToken +---@return number weight +function C_Commentator.GetAdditionalCameraWeightByToken(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetAllPlayerOverrideNames) +---@return NameOverrideEntry[] nameEntries +function C_Commentator.GetAllPlayerOverrideNames() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCamera) +---@return number xPos +---@return number yPos +---@return number zPos +---@return number yaw +---@return number pitch +---@return number roll +---@return number fov +function C_Commentator.GetCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCameraCollision) +---@return boolean isColliding +function C_Commentator.GetCameraCollision() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCameraPosition) +---@return number xPos +---@return number yPos +---@return number zPos +function C_Commentator.GetCameraPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCombatEventInfo) +function C_Commentator.GetCombatEventInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCommentatorHistory) +---@return CommentatorHistory history +function C_Commentator.GetCommentatorHistory() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCommentatorMatchDataState) +---@return CommentatorMatchDataState state +function C_Commentator.GetCommentatorMatchDataState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetCurrentMapID) +---@return number? mapID +function C_Commentator.GetCurrentMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetDampeningPercent) +---@return number percentage +function C_Commentator.GetDampeningPercent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetDistanceBeforeForcedHorizontalConvergence) +---@return number distance +function C_Commentator.GetDistanceBeforeForcedHorizontalConvergence() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetDurationToForceHorizontalConvergence) +---@return number ms +function C_Commentator.GetDurationToForceHorizontalConvergence() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetExcludeDistance) +---@return number excludeDistance +function C_Commentator.GetExcludeDistance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetHardlockWeight) +---@return number weight +function C_Commentator.GetHardlockWeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetHorizontalAngleThresholdToSmooth) +---@return number angle +function C_Commentator.GetHorizontalAngleThresholdToSmooth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetIndirectSpellID) +---@param trackedSpellID number +---@return number indirectSpellID +function C_Commentator.GetIndirectSpellID(trackedSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetInstanceInfo) +---@param mapIndex number +---@param instanceIndex number +---@return number mapID +---@return string? mapName +---@return number status +---@return number instanceIDLow +---@return number instanceIDHigh +function C_Commentator.GetInstanceInfo(mapIndex, instanceIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetLookAtLerpAmount) +---@return number amount +function C_Commentator.GetLookAtLerpAmount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMapInfo) +---@param mapIndex number +---@return number teamSize +---@return number minLevel +---@return number maxLevel +---@return number numInstances +function C_Commentator.GetMapInfo(mapIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMatchDuration) +---@return time_t seconds +function C_Commentator.GetMatchDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMaxNumPlayersPerTeam) +---@return number maxNumPlayersPerTeam +function C_Commentator.GetMaxNumPlayersPerTeam() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMaxNumTeams) +---@return number maxNumTeams +function C_Commentator.GetMaxNumTeams() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMode) +---@return number commentatorMode +function C_Commentator.GetMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMsToHoldForHorizontalMovement) +---@return number ms +function C_Commentator.GetMsToHoldForHorizontalMovement() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMsToHoldForVerticalMovement) +---@return number ms +function C_Commentator.GetMsToHoldForVerticalMovement() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMsToSmoothHorizontalChange) +---@return number ms +function C_Commentator.GetMsToSmoothHorizontalChange() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetMsToSmoothVerticalChange) +---@return number ms +function C_Commentator.GetMsToSmoothVerticalChange() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetNumMaps) +---@return number numMaps +function C_Commentator.GetNumMaps() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetNumPlayers) +---@param factionIndex number +---@return number numPlayers +function C_Commentator.GetNumPlayers(factionIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetOrCreateSeries) +---@param teamName1 string +---@param teamName2 string +---@return CommentatorSeries data +function C_Commentator.GetOrCreateSeries(teamName1, teamName2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerAuraInfo) +---@param teamIndex number +---@param playerIndex number +---@param spellID number +---@return number startTime +---@return number duration +---@return boolean enable +function C_Commentator.GetPlayerAuraInfo(teamIndex, playerIndex, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerAuraInfoByUnit) +---@param token UnitToken +---@param spellID number +---@return number startTime +---@return number duration +---@return boolean enable +function C_Commentator.GetPlayerAuraInfoByUnit(token, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerCooldownInfo) +---@param teamIndex number +---@param playerIndex number +---@param spellID number +---@return number startTime +---@return number duration +---@return boolean enable +function C_Commentator.GetPlayerCooldownInfo(teamIndex, playerIndex, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerCooldownInfoByUnit) +---@param unitToken UnitToken +---@param spellID number +---@return number startTime +---@return number duration +---@return boolean enable +function C_Commentator.GetPlayerCooldownInfoByUnit(unitToken, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerCrowdControlInfo) +---@param teamIndex number +---@param playerIndex number +---@return number spellID +---@return number expiration +---@return number duration +function C_Commentator.GetPlayerCrowdControlInfo(teamIndex, playerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerCrowdControlInfoByUnit) +---@param token UnitToken +---@return number spellID +---@return number expiration +---@return number duration +function C_Commentator.GetPlayerCrowdControlInfoByUnit(token) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerData) +---@param teamIndex number +---@param playerIndex number +---@return CommentatorPlayerData? info +function C_Commentator.GetPlayerData(teamIndex, playerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerFlagInfo) +---@param teamIndex number +---@param playerIndex number +---@return boolean hasFlag +function C_Commentator.GetPlayerFlagInfo(teamIndex, playerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerFlagInfoByUnit) +---@param unitToken UnitToken +---@return boolean hasFlag +function C_Commentator.GetPlayerFlagInfoByUnit(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerItemCooldownInfo) +---@param teamIndex number +---@param playerIndex number +---@param itemID number +---@return number startTime +---@return number duration +---@return boolean enable +function C_Commentator.GetPlayerItemCooldownInfo(teamIndex, playerIndex, itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerItemCooldownInfoByUnit) +---@param unitToken UnitToken +---@param itemID number +---@return number startTime +---@return number duration +---@return boolean enable +function C_Commentator.GetPlayerItemCooldownInfoByUnit(unitToken, itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerOverrideName) +---@param originalName string +---@return string overrideName +function C_Commentator.GetPlayerOverrideName(originalName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerSpellCharges) +---@param teamIndex number +---@param playerIndex number +---@param spellID number +---@return number charges +---@return number maxCharges +---@return number startTime +---@return number duration +function C_Commentator.GetPlayerSpellCharges(teamIndex, playerIndex, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPlayerSpellChargesByUnit) +---@param unitToken UnitToken +---@param spellID number +---@return number charges +---@return number maxCharges +---@return number startTime +---@return number duration +function C_Commentator.GetPlayerSpellChargesByUnit(unitToken, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetPositionLerpAmount) +---@return number amount +function C_Commentator.GetPositionLerpAmount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetSmoothFollowTransitioning) +---@return boolean enabled +function C_Commentator.GetSmoothFollowTransitioning() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetSoftlockWeight) +---@return number weight +function C_Commentator.GetSoftlockWeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetSpeedFactor) +---@return number factor +function C_Commentator.GetSpeedFactor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetStartLocation) +---@param mapID number +---@return vector3 pos +function C_Commentator.GetStartLocation(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetTeamColor) +---@param teamIndex number +---@return colorRGB color +function C_Commentator.GetTeamColor(teamIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetTeamColorByUnit) +---@param unitToken UnitToken +---@return colorRGB color +function C_Commentator.GetTeamColorByUnit(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetTimeLeftInMatch) +---@return number? timeLeft +function C_Commentator.GetTimeLeftInMatch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetTrackedSpellID) +---@param indirectSpellID number +---@return number trackedSpellID +function C_Commentator.GetTrackedSpellID(indirectSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetTrackedSpells) +---@param teamIndex number +---@param playerIndex number +---@param category Enum.TrackedSpellCategory +---@return number[]? spells +---@return TrackedSpellsResult result +function C_Commentator.GetTrackedSpells(teamIndex, playerIndex, category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetTrackedSpellsByUnit) +---@param unitToken UnitToken +---@param category Enum.TrackedSpellCategory +---@return number[]? spells +---@return TrackedSpellsResult result +function C_Commentator.GetTrackedSpellsByUnit(unitToken, category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetUnitData) +---@param unitToken UnitToken +---@return CommentatorUnitData data +function C_Commentator.GetUnitData(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.GetWargameInfo) +---@param listID number +---@return string name +---@return number minPlayers +---@return number maxPlayers +---@return boolean isArena +function C_Commentator.GetWargameInfo(listID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.HasTrackedAuras) +---@param token UnitToken +---@return boolean hasOffensiveAura +---@return boolean hasDefensiveAura +function C_Commentator.HasTrackedAuras(token) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsSmartCameraLocked) +---@return boolean isSmartCameraLocked +function C_Commentator.IsSmartCameraLocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsSpectating) +---@return boolean isSpectating +function C_Commentator.IsSpectating() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsTrackedDefensiveAura) +---@param spellID number +---@return boolean isDefensiveTrigger +function C_Commentator.IsTrackedDefensiveAura(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsTrackedOffensiveAura) +---@param spellID number +---@return boolean isOffensiveTrigger +function C_Commentator.IsTrackedOffensiveAura(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsTrackedSpell) +---@param teamIndex number +---@param playerIndex number +---@param spellID number +---@param category Enum.TrackedSpellCategory +---@return boolean isTracked +function C_Commentator.IsTrackedSpell(teamIndex, playerIndex, spellID, category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsTrackedSpellByUnit) +---@param unitToken UnitToken +---@param spellID number +---@param category Enum.TrackedSpellCategory +---@return boolean isTracked +function C_Commentator.IsTrackedSpellByUnit(unitToken, spellID, category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.IsUsingSmartCamera) +---@return boolean isUsingSmartCamera +function C_Commentator.IsUsingSmartCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.LookAtPlayer) +---@param factionIndex number +---@param playerIndex number +---@param lookAtIndex? number +function C_Commentator.LookAtPlayer(factionIndex, playerIndex, lookAtIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.RemoveAllOverrideNames) +function C_Commentator.RemoveAllOverrideNames() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.RemovePlayerOverrideName) +---@param originalPlayerName string +function C_Commentator.RemovePlayerOverrideName(originalPlayerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.RequestPlayerCooldownInfo) +---@param teamIndex number +---@param playerIndex number +function C_Commentator.RequestPlayerCooldownInfo(teamIndex, playerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ResetFoVTarget) +function C_Commentator.ResetFoVTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ResetSeriesScores) +---@param teamName1 string +---@param teamName2 string +function C_Commentator.ResetSeriesScores(teamName1, teamName2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ResetSettings) +function C_Commentator.ResetSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ResetTrackedAuras) +function C_Commentator.ResetTrackedAuras() end + +---Works the same as C_ChatInfo.SendAddonMessage but accepts secrets and is only allowed when outgoing addon comms are allowed (i.e. on tournament realms) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SendAddonMessage) +---@param prefix string +---@param message string +---@param chatType? string +---@param target? string +---@return Enum.SendAddonMessageResult result +function C_Commentator.SendAddonMessage(prefix, message, chatType, target) end + +---Works the same as C_ChatInfo.SendAddonMessageLogged but accepts secrets and is only allowed when outgoing addon comms are allowed (i.e. on tournament realms) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SendAddonMessageLogged) +---@param prefix string +---@param message string +---@param chatType? string +---@param target? string +---@return Enum.SendAddonMessageResult? result +function C_Commentator.SendAddonMessageLogged(prefix, message, chatType, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetAdditionalCameraWeight) +---@param teamIndex number +---@param playerIndex number +---@param weight number +function C_Commentator.SetAdditionalCameraWeight(teamIndex, playerIndex, weight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetAdditionalCameraWeightByToken) +---@param unitToken UnitToken +---@param weight number +function C_Commentator.SetAdditionalCameraWeightByToken(unitToken, weight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetBlocklistedAuras) +---@param spellIDs number[] +function C_Commentator.SetBlocklistedAuras(spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetBlocklistedCooldowns) +---@param specID number +---@param spellIDs number[] +function C_Commentator.SetBlocklistedCooldowns(specID, spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetBlocklistedItemCooldowns) +---@param itemIDs number[] +function C_Commentator.SetBlocklistedItemCooldowns(itemIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetCamera) +---@param xPos number +---@param yPos number +---@param zPos number +---@param yaw number +---@param pitch number +---@param roll number +---@param fov number +function C_Commentator.SetCamera(xPos, yPos, zPos, yaw, pitch, roll, fov) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetCameraCollision) +---@param collide boolean +function C_Commentator.SetCameraCollision(collide) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetCameraPosition) +---@param xPos number +---@param yPos number +---@param zPos number +---@param snapToLocation boolean +function C_Commentator.SetCameraPosition(xPos, yPos, zPos, snapToLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetCheatsEnabled) +---@param enableCheats boolean +function C_Commentator.SetCheatsEnabled(enableCheats) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetCommentatorHistory) +---@param history CommentatorHistory +function C_Commentator.SetCommentatorHistory(history) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetDistanceBeforeForcedHorizontalConvergence) +---@param distance number +function C_Commentator.SetDistanceBeforeForcedHorizontalConvergence(distance) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetDurationToForceHorizontalConvergence) +---@param ms number +function C_Commentator.SetDurationToForceHorizontalConvergence(ms) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetExcludeDistance) +---@param excludeDistance number +function C_Commentator.SetExcludeDistance(excludeDistance) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetFollowCameraSpeeds) +---@param elasticSpeed number +---@param minSpeed number +function C_Commentator.SetFollowCameraSpeeds(elasticSpeed, minSpeed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetHardlockWeight) +---@param weight number +function C_Commentator.SetHardlockWeight(weight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetHorizontalAngleThresholdToSmooth) +---@param angle number +function C_Commentator.SetHorizontalAngleThresholdToSmooth(angle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetLookAtLerpAmount) +---@param amount number +function C_Commentator.SetLookAtLerpAmount(amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMapAndInstanceIndex) +---@param mapIndex number +---@param instanceIndex number +function C_Commentator.SetMapAndInstanceIndex(mapIndex, instanceIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMouseDisabled) +---@param disabled boolean +function C_Commentator.SetMouseDisabled(disabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMoveSpeed) +---@param newSpeed number +function C_Commentator.SetMoveSpeed(newSpeed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMsToHoldForHorizontalMovement) +---@param ms number +function C_Commentator.SetMsToHoldForHorizontalMovement(ms) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMsToHoldForVerticalMovement) +---@param ms number +function C_Commentator.SetMsToHoldForVerticalMovement(ms) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMsToSmoothHorizontalChange) +---@param ms number +function C_Commentator.SetMsToSmoothHorizontalChange(ms) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetMsToSmoothVerticalChange) +---@param ms number +function C_Commentator.SetMsToSmoothVerticalChange(ms) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetPositionLerpAmount) +---@param amount number +function C_Commentator.SetPositionLerpAmount(amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetRequestedDebuffCooldowns) +---@param specID number +---@param spellIDs number[] +function C_Commentator.SetRequestedDebuffCooldowns(specID, spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetRequestedDefensiveCooldowns) +---@param specID number +---@param spellIDs number[] +function C_Commentator.SetRequestedDefensiveCooldowns(specID, spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetRequestedItemCooldowns) +---@param itemIDs number[] +function C_Commentator.SetRequestedItemCooldowns(itemIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetRequestedOffensiveCooldowns) +---@param specID number +---@param spellIDs number[] +function C_Commentator.SetRequestedOffensiveCooldowns(specID, spellIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetSeriesScore) +---@param teamName1 string +---@param teamName2 string +---@param scoringTeamName string +---@param score number +function C_Commentator.SetSeriesScore(teamName1, teamName2, scoringTeamName, score) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetSeriesScores) +---@param teamName1 string +---@param teamName2 string +---@param score1 number +---@param score2 number +function C_Commentator.SetSeriesScores(teamName1, teamName2, score1, score2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetSmartCameraLocked) +---@param locked boolean +function C_Commentator.SetSmartCameraLocked(locked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetSmoothFollowTransitioning) +---@param enabled boolean +function C_Commentator.SetSmoothFollowTransitioning(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetSoftlockWeight) +---@param weight number +function C_Commentator.SetSoftlockWeight(weight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetSpeedFactor) +---@param factor number +function C_Commentator.SetSpeedFactor(factor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetTargetHeightOffset) +---@param offset number +function C_Commentator.SetTargetHeightOffset(offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SetUseSmartCamera) +---@param useSmartCamera boolean +function C_Commentator.SetUseSmartCamera(useSmartCamera) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SnapCameraLookAtPoint) +function C_Commentator.SnapCameraLookAtPoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SpellUsesItemCharges) +---@param spellID number +---@return boolean spellUsesItemCharges +function C_Commentator.SpellUsesItemCharges(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.StartWargame) +---@param listID number +---@param teamSize number +---@param tournamentRules boolean +---@param teamOneCaptain string +---@param teamTwoCaptain string +function C_Commentator.StartWargame(listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.SwapTeamSides) +function C_Commentator.SwapTeamSides() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ToggleCheats) +function C_Commentator.ToggleCheats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.UpdateMapInfo) +---@param targetPlayer? string +function C_Commentator.UpdateMapInfo(targetPlayer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.UpdatePlayerInfo) +function C_Commentator.UpdatePlayerInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ZoomIn) +function C_Commentator.ZoomIn() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ZoomIn_Position) +---@param zoomAmount? number +function C_Commentator.ZoomIn_Position(zoomAmount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ZoomOut) +function C_Commentator.ZoomOut() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Commentator.ZoomOut_Position) +---@param zoomAmount? number +function C_Commentator.ZoomOut_Position(zoomAmount) end + +---@class CommentatorHistory +---@field series CommentatorSeries[] +---@field teamDirectory CommentatorTeamDirectoryEntry[] +---@field overrideNameDirectory CommentatorOverrideNameEntry[] + +---@class CommentatorMatchDataState +---@field receivedPlayerInfo boolean +---@field setInstancePlayers boolean +---@field requestedCooldownInfo boolean +---@field requestedPlayerCooldowns TeamPlayerRequestedCooldownInfo[] + +---@class CommentatorOverrideNameEntry +---@field originalName string +---@field newName string + +---@class CommentatorPlayerData +---@field unitToken string +---@field name string +---@field faction number +---@field specialization number +---@field damageDone number +---@field damageTaken number +---@field healingDone number +---@field healingTaken number +---@field kills number +---@field deaths number +---@field soloShuffleRoundWins number +---@field soloShuffleRoundLosses number + +---@class CommentatorSeries +---@field teams CommentatorSeriesTeam[] + +---@class CommentatorSeriesTeam +---@field name string +---@field score number + +---@class CommentatorTeamDirectoryEntry +---@field playerName string +---@field teamName string + +---@class CommentatorTrackedItemCooldown +---@field spellID number +---@field category Enum.TrackedSpellCategory + +---@class CommentatorUnitData +---@field healthMax number +---@field health number +---@field absorbTotal number +---@field isDeadOrGhost boolean +---@field isFeignDeath boolean +---@field powerTypeToken string +---@field power number +---@field powerMax number + +---@class NameOverrideEntry +---@field originalName string +---@field overrideName string + +---@class TeamPlayerRequestedCooldownInfo +---@field teamIndex number +---@field playerIndex number +---@field cooldownsRequested number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua new file mode 100644 index 0000000..53c938a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua @@ -0,0 +1,45 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelLogout) +function CancelLogout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ForceLogout) +function ForceLogout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ForceQuit) +function ForceQuit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNativeRealmID) +---@return number nativeRealmID +function GetNativeRealmID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNetIpTypes) +---@return ConnectionIptype ... ipTypes +function GetNetIpTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNetStats) +---@return number in +---@return number out +---@return number ... latencyList +function GetNetStats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRealmID) +---@return number realmID +function GetRealmID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRealmName) +---@return string realmName +function GetRealmName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsOnTournamentRealm) +---@return boolean result +function IsOnTournamentRealm() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Logout) +function Logout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Quit) +function Quit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SelectedRealmName) +---@return string selectedRealmName +function SelectedRealmName() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua new file mode 100644 index 0000000..1584960 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua @@ -0,0 +1,56 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CalculateStringEditDistance) +---@param firstString stringView +---@param secondString stringView +---@return number distance +function CalculateStringEditDistance(firstString, secondString) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleEcho) +---@param command string +---@param addToHistory? boolean Default = false +---@param prefix? string +---@return boolean result +function ConsoleEcho(command, addToHistory, prefix) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleExec) +---@param command string +---@param addToHistory? boolean Default = false +---@return boolean result +function ConsoleExec(command, addToHistory) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleGetAllCommands) +---@return ConsoleCommandInfo[] commands +function ConsoleGetAllCommands() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleGetColorFromType) +---@param colorType Enum.ConsoleColorType +---@return colorRGB color +function ConsoleGetColorFromType(colorType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleGetFontHeight) +---@return number fontHeightInPixels +function ConsoleGetFontHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleIsActive) +---@return boolean consoleIsActive +function ConsoleIsActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsolePrintAllMatchingCommands) +---@param partialCommandText string +function ConsolePrintAllMatchingCommands(partialCommandText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConsoleSetFontHeight) +---@param fontHeightInPixels number +function ConsoleSetFontHeight(fontHeightInPixels) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetConsoleKey) +---@param keystring string +function SetConsoleKey(keystring) end + +---@class ConsoleCommandInfo +---@field command string +---@field help string +---@field category Enum.ConsoleCategory +---@field commandType Enum.ConsoleCommandType +---@field scriptContents string +---@field scriptParameters string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua new file mode 100644 index 0000000..b4135c3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua @@ -0,0 +1,42 @@ +---@meta _ +C_ConsoleScriptCollection = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ConsoleScriptCollection.GetCollectionDataByID) +---@param collectionID number +---@return ConsoleScriptCollectionData? data +function C_ConsoleScriptCollection.GetCollectionDataByID(collectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ConsoleScriptCollection.GetCollectionDataByTag) +---@param collectionTag string +---@return ConsoleScriptCollectionData? data +function C_ConsoleScriptCollection.GetCollectionDataByTag(collectionTag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ConsoleScriptCollection.GetElements) +---@param collectionID number +---@return ConsoleScriptCollectionElementData[] elementIDs +function C_ConsoleScriptCollection.GetElements(collectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ConsoleScriptCollection.GetScriptData) +---@param consoleScriptID number +---@return ConsoleScriptData data +function C_ConsoleScriptCollection.GetScriptData(consoleScriptID) end + +---@class ConsoleScriptCollectionData +---@field ID number +---@field name string + +---@class ConsoleScriptCollectionElementData +---@field collectionID number? +---@field consoleScriptID number? + +---@class ConsoleScriptData +---@field ID number +---@field name string +---@field help string +---@field script string +---@field params string +---@field isLuaScript boolean + +---@class ConsoleScriptParameter +---@field name string +---@field description string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua new file mode 100644 index 0000000..fe721b1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua @@ -0,0 +1,279 @@ +---@meta _ +C_Container = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.ContainerIDToInventoryID) +---@param containerID Enum.BagIndex +---@return number inventoryID +function C_Container.ContainerIDToInventoryID(containerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.ContainerRefundItemPurchase) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@param isEquipped? boolean Default = false +function C_Container.ContainerRefundItemPurchase(containerIndex, slotIndex, isEquipped) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetBackpackAutosortDisabled) +---@return boolean isDisabled +function C_Container.GetBackpackAutosortDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetBackpackSellJunkDisabled) +---@return boolean isDisabled +function C_Container.GetBackpackSellJunkDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetBagName) +---@param bagIndex Enum.BagIndex +---@return string name +function C_Container.GetBagName(bagIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetBagSlotFlag) +---@param bagIndex Enum.BagIndex +---@param flag Enum.BagSlotFlags +---@return boolean isSet +function C_Container.GetBagSlotFlag(bagIndex, flag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetBankAutosortDisabled) +---@return boolean isDisabled +function C_Container.GetBankAutosortDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerFreeSlots) +---@param containerIndex Enum.BagIndex +---@return number[] freeSlots +function C_Container.GetContainerFreeSlots(containerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemCooldown) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return number startTime +---@return number duration +---@return number enable +function C_Container.GetContainerItemCooldown(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemDurability) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return number durability +---@return number maxDurability +function C_Container.GetContainerItemDurability(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemEquipmentSetInfo) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return boolean inSet +---@return string setList +function C_Container.GetContainerItemEquipmentSetInfo(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemID) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return number containerID +function C_Container.GetContainerItemID(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemInfo) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return ContainerItemInfo containerInfo +function C_Container.GetContainerItemInfo(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemLink) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return string itemLink +function C_Container.GetContainerItemLink(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemPurchaseCurrency) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@param itemIndex number +---@param isEquipped boolean +---@return ItemPurchaseCurrency currencyInfo +function C_Container.GetContainerItemPurchaseCurrency(containerIndex, slotIndex, itemIndex, isEquipped) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemPurchaseInfo) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@param isEquipped boolean +---@return ItemPurchaseInfo info +function C_Container.GetContainerItemPurchaseInfo(containerIndex, slotIndex, isEquipped) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemPurchaseItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@param itemIndex number +---@param isEquipped boolean +---@return ItemPurchaseItem itemInfo +function C_Container.GetContainerItemPurchaseItem(containerIndex, slotIndex, itemIndex, isEquipped) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerItemQuestInfo) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return ItemQuestInfo questInfo +function C_Container.GetContainerItemQuestInfo(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerNumFreeSlots) +---@param bagIndex Enum.BagIndex +---@return number numFreeSlots +---@return number? bagFamily +function C_Container.GetContainerNumFreeSlots(bagIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetContainerNumSlots) +---@param containerIndex Enum.BagIndex +---@return number numSlots +function C_Container.GetContainerNumSlots(containerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetInsertItemsLeftToRight) +---@return boolean isEnabled +function C_Container.GetInsertItemsLeftToRight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetItemCooldown) +---@param itemID number +---@return number startTime +---@return number duration +---@return number enable +function C_Container.GetItemCooldown(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetMaxArenaCurrency) +---@return number maxCurrency +function C_Container.GetMaxArenaCurrency() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.GetSortBagsRightToLeft) +---@return boolean isEnabled +function C_Container.GetSortBagsRightToLeft() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.HasContainerItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return boolean hasItem +function C_Container.HasContainerItem(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.IsBattlePayItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return boolean isBattlePayItem +function C_Container.IsBattlePayItem(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.IsContainerFiltered) +---@param containerIndex Enum.BagIndex +---@return boolean isFiltered +function C_Container.IsContainerFiltered(containerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.PickupContainerItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +function C_Container.PickupContainerItem(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.PlayerHasHearthstone) +---@return number? itemID +function C_Container.PlayerHasHearthstone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetBackpackAutosortDisabled) +---@param disable boolean +function C_Container.SetBackpackAutosortDisabled(disable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetBackpackSellJunkDisabled) +---@param disable boolean +function C_Container.SetBackpackSellJunkDisabled(disable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetBagPortraitTexture) +---@param texture SimpleTexture +---@param bagIndex Enum.BagIndex +function C_Container.SetBagPortraitTexture(texture, bagIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetBagSlotFlag) +---@param bagIndex Enum.BagIndex +---@param flag Enum.BagSlotFlags +---@param isSet boolean +function C_Container.SetBagSlotFlag(bagIndex, flag, isSet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetBankAutosortDisabled) +---@param disable boolean +function C_Container.SetBankAutosortDisabled(disable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetInsertItemsLeftToRight) +---@param enable boolean +function C_Container.SetInsertItemsLeftToRight(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetItemSearch) +---@param searchString string +function C_Container.SetItemSearch(searchString) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SetSortBagsRightToLeft) +---@param enable boolean +function C_Container.SetSortBagsRightToLeft(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.ShowContainerSellCursor) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +function C_Container.ShowContainerSellCursor(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SocketContainerItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return boolean success +function C_Container.SocketContainerItem(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SortAccountBankBags) +function C_Container.SortAccountBankBags() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SortBags) +function C_Container.SortBags() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SortBank) +---@param bankType Enum.BankType +function C_Container.SortBank(bankType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SortBankBags) +function C_Container.SortBankBags() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.SplitContainerItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@param amount number +function C_Container.SplitContainerItem(containerIndex, slotIndex, amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.UseContainerItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@param unitToken? UnitToken +---@param bankType? Enum.BankType +---@param reagentBankOpen? boolean Default = false +function C_Container.UseContainerItem(containerIndex, slotIndex, unitToken, bankType, reagentBankOpen) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Container.UseHearthstone) +---@return boolean used +function C_Container.UseHearthstone() end + +---@class ContainerItemInfo +---@field iconFileID fileID +---@field stackCount number +---@field isLocked boolean +---@field quality Enum.ItemQuality? +---@field isReadable boolean +---@field hasLoot boolean +---@field hyperlink string +---@field isFiltered boolean +---@field hasNoValue boolean +---@field itemID number +---@field isBound boolean +---@field itemName string + +---@class ItemPurchaseCurrency +---@field iconFileID number? +---@field currencyCount number +---@field name string + +---@class ItemPurchaseInfo +---@field money WOWMONEY +---@field itemCount number +---@field refundSeconds time_t +---@field currencyCount number +---@field hasEnchants boolean + +---@class ItemPurchaseItem +---@field iconFileID number? +---@field itemCount number +---@field hyperlink string + +---@class ItemQuestInfo +---@field isQuestItem boolean +---@field questID number? +---@field isActive boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua new file mode 100644 index 0000000..00df28e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua @@ -0,0 +1,114 @@ +---@meta _ +C_ContentTracking = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetBestMapForTrackable) +---@param trackableType Enum.ContentTrackingType +---@param trackableID number +---@param ignoreWaypoint? boolean Default = false +---@return Enum.ContentTrackingResult result +---@return number? mapID +function C_ContentTracking.GetBestMapForTrackable(trackableType, trackableID, ignoreWaypoint) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetCollectableSourceTrackingEnabled) +---@return boolean isEnabled +function C_ContentTracking.GetCollectableSourceTrackingEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetCollectableSourceTypes) +---@return Enum.ContentTrackingType[] collectableSourceTypes +function C_ContentTracking.GetCollectableSourceTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetCurrentTrackingTarget) +---@param type Enum.ContentTrackingType +---@param id number +---@return Enum.ContentTrackingTargetType targetType +---@return number targetID +function C_ContentTracking.GetCurrentTrackingTarget(type, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetEncounterTrackingInfo) +---@param journalEncounterID number +---@return EncounterTrackingInfo trackingInfo +function C_ContentTracking.GetEncounterTrackingInfo(journalEncounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetNextWaypointForTrackable) +---@param trackableType Enum.ContentTrackingType +---@param trackableID number +---@param uiMapID number +---@return Enum.ContentTrackingResult result +---@return ContentTrackingMapInfo? mapInfo +function C_ContentTracking.GetNextWaypointForTrackable(trackableType, trackableID, uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetObjectiveText) +---@param targetType Enum.ContentTrackingTargetType +---@param targetID number +---@param includeHyperlinks? boolean Default = true +---@return string objectiveText +function C_ContentTracking.GetObjectiveText(targetType, targetID, includeHyperlinks) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetTitle) +---@param trackableType Enum.ContentTrackingType +---@param trackableID number +---@return string title +function C_ContentTracking.GetTitle(trackableType, trackableID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetTrackablesOnMap) +---@param trackableType Enum.ContentTrackingType +---@param uiMapID number +---@return Enum.ContentTrackingResult result +---@return ContentTrackingMapInfo[] trackableMapInfos +function C_ContentTracking.GetTrackablesOnMap(trackableType, uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetTrackedIDs) +---@param trackableType Enum.ContentTrackingType +---@return number[] entryIDs +function C_ContentTracking.GetTrackedIDs(trackableType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetVendorTrackingInfo) +---@param collectableEntryID number +---@return VendorTrackingInfo vendorTrackingInfo +function C_ContentTracking.GetVendorTrackingInfo(collectableEntryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.GetWaypointText) +---@param trackableType Enum.ContentTrackingType +---@param trackableID number +---@return string waypointText +function C_ContentTracking.GetWaypointText(trackableType, trackableID) end + +---If successful, returns if the trackable is either on your current map, or if we're able to determine a route to that map from your location via waypoints. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.IsNavigable) +---@param trackableType Enum.ContentTrackingType +---@param trackableID number +---@return Enum.ContentTrackingResult result +---@return boolean isNavigable +function C_ContentTracking.IsNavigable(trackableType, trackableID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.IsTrackable) +---@param type Enum.ContentTrackingType +---@param id number +---@return boolean isTrackable +function C_ContentTracking.IsTrackable(type, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.IsTracking) +---@param type Enum.ContentTrackingType +---@param id number +---@return boolean isTracking +function C_ContentTracking.IsTracking(type, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.StartTracking) +---@param type Enum.ContentTrackingType +---@param id number +---@return Enum.ContentTrackingError? error +function C_ContentTracking.StartTracking(type, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.StopTracking) +---@param type Enum.ContentTrackingType +---@param id number +---@param stopType Enum.ContentTrackingStopType +function C_ContentTracking.StopTracking(type, id, stopType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContentTracking.ToggleTracking) +---@param type Enum.ContentTrackingType +---@param id number +---@param stopType Enum.ContentTrackingStopType +---@return Enum.ContentTrackingError? error +function C_ContentTracking.ToggleTracking(type, id, stopType) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua new file mode 100644 index 0000000..f4550d6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua @@ -0,0 +1,25 @@ +---@meta _ +---@class ContentTrackingMapInfo +---@field x number +---@field y number +---@field trackableType Enum.ContentTrackingType +---@field trackableID number +---@field targetType Enum.ContentTrackingTargetType +---@field targetID number +---@field waypointText string + +---@class EncounterTrackingInfo +---@field encounterName string +---@field journalEncounterID number? +---@field journalInstanceID number? +---@field instanceName string +---@field subText string? +---@field difficultyID number? +---@field lfgDungeonID number? +---@field groupFinderActivityID number? + +---@class VendorTrackingInfo +---@field creatureName string +---@field zoneName string? +---@field currencyType number? +---@field cost BigUInteger? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua new file mode 100644 index 0000000..e140b83 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua @@ -0,0 +1,110 @@ +---@meta _ +C_ContributionCollector = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.Close) +function C_ContributionCollector.Close() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.Contribute) +---@param contributionID number +function C_ContributionCollector.Contribute(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetActive) +---@return number ... contributionID +function C_ContributionCollector.GetActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetAtlases) +---@param contributionID number +---@return textureAtlas[] atlasName +function C_ContributionCollector.GetAtlases(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetBuffs) +---@param contributionID number +---@return number ... spellID +function C_ContributionCollector.GetBuffs(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetContributionAppearance) +---@param contributionID number +---@param contributionState Enum.ContributionState +---@return ContributionAppearance? appearance +function C_ContributionCollector.GetContributionAppearance(contributionID, contributionState) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetContributionCollectorsForMap) +---@param uiMapID number +---@return ContributionMapInfo[] contributionCollectors +function C_ContributionCollector.GetContributionCollectorsForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetContributionResult) +---@param contributionID number +---@return Enum.ContributionResult result +function C_ContributionCollector.GetContributionResult(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetDescription) +---@param contributionID number +---@return string? description Default = +function C_ContributionCollector.GetDescription(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetManagedContributionsForCreatureID) +---@param creatureID number +---@return number ... contributionID +function C_ContributionCollector.GetManagedContributionsForCreatureID(creatureID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetName) +---@param contributionID number +---@return string? name Default = +function C_ContributionCollector.GetName(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetOrderIndex) +---@param contributionID number +---@return number orderIndex +function C_ContributionCollector.GetOrderIndex(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetRequiredContributionCurrency) +---@param contributionID number +---@return number? currencyID Default = 0 +---@return number? currencyAmount Default = 0 +function C_ContributionCollector.GetRequiredContributionCurrency(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetRequiredContributionItem) +---@param contributionID number +---@return number? itemID Default = 0 +---@return number? itemCount Default = 0 +function C_ContributionCollector.GetRequiredContributionItem(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetRewardQuestID) +---@param contributionID number +---@return number questID +function C_ContributionCollector.GetRewardQuestID(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.GetState) +---@param contributionID number +---@return Enum.ContributionState? contributionState Default = None +---@return number contributionPercentageComplete +---@return time_t? timeOfNextStateChange +---@return time_t startTime +function C_ContributionCollector.GetState(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.HasPendingContribution) +---@param contributionID number +---@return boolean hasPending +function C_ContributionCollector.HasPendingContribution(contributionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ContributionCollector.IsAwaitingRewardQuestData) +---@param contributionID number +---@return boolean awaitingData +function C_ContributionCollector.IsAwaitingRewardQuestData(contributionID) end + +---@class ContributionAppearance +---@field stateName string +---@field stateColor colorRGB +---@field tooltipLine string +---@field tooltipUseTimeRemaining boolean +---@field statusBarAtlas textureAtlas +---@field borderAtlas textureAtlas +---@field bannerAtlas textureAtlas + +---@class ContributionMapInfo +---@field areaPoiID number +---@field position vector2 +---@field name string +---@field atlasName string +---@field collectorCreatureID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua new file mode 100644 index 0000000..c2a154c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua @@ -0,0 +1,44 @@ +---@meta _ +C_CooldownViewer = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CooldownViewer.GetCooldownViewerCategorySet) +---@param category Enum.CooldownViewerCategory +---@param allowUnlearned? boolean Default = false +---@return number[] cooldownIDs +function C_CooldownViewer.GetCooldownViewerCategorySet(category, allowUnlearned) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CooldownViewer.GetCooldownViewerCooldownInfo) +---@param cooldownID number +---@return CooldownViewerCooldown cooldownInfo +function C_CooldownViewer.GetCooldownViewerCooldownInfo(cooldownID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CooldownViewer.GetLayoutData) +---@return string data +function C_CooldownViewer.GetLayoutData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CooldownViewer.GetValidAlertTypes) +---@param cooldownID number +---@return Enum.CooldownViewerAlertEventType[] validAlertTypes +function C_CooldownViewer.GetValidAlertTypes(cooldownID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CooldownViewer.IsCooldownViewerAvailable) +---@return boolean isAvailable +---@return string failureReason +function C_CooldownViewer.IsCooldownViewerAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CooldownViewer.SetLayoutData) +---@param data string +function C_CooldownViewer.SetLayoutData(data) end + +---@class CooldownViewerCooldown +---@field cooldownID number +---@field spellID number +---@field overrideSpellID number? +---@field overrideTooltipSpellID number? +---@field linkedSpellIDs number[] +---@field selfAura boolean +---@field hasAura boolean +---@field charges boolean +---@field isKnown boolean +---@field flags Enum.CooldownSetSpellFlags +---@field category Enum.CooldownViewerCategory diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua new file mode 100644 index 0000000..33c79fd --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua @@ -0,0 +1,9 @@ +---@meta _ +C_CovenantCallings = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantCallings.AreCallingsUnlocked) +---@return boolean unlocked +function C_CovenantCallings.AreCallingsUnlocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantCallings.RequestCallings) +function C_CovenantCallings.RequestCallings() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua new file mode 100644 index 0000000..091eb32 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua @@ -0,0 +1,39 @@ +---@meta _ +C_CovenantPreview = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantPreview.CloseFromUI) +function C_CovenantPreview.CloseFromUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID) +---@param playerChoiceResponseID number +---@return CovenantPreviewInfo previewInfo +function C_CovenantPreview.GetCovenantInfoForPlayerChoiceResponseID(playerChoiceResponseID) end + +---@class CovenantAbilityInfo +---@field spellID number +---@field type Enum.CovenantAbilityType + +---@class CovenantFeatureInfo +---@field name string +---@field description string +---@field texture number + +---@class CovenantPreviewInfo +---@field textureKit textureKit +---@field transmogSetID number +---@field mountID number +---@field covenantName string +---@field covenantZone string +---@field description string +---@field covenantCrest textureAtlas +---@field covenantAbilities CovenantAbilityInfo[] +---@field fromPlayerChoice boolean +---@field covenantSoulbinds CovenantSoulbindInfo[] +---@field featureInfo CovenantFeatureInfo + +---@class CovenantSoulbindInfo +---@field spellID number +---@field uiTextureKit textureKit +---@field name string +---@field description string +---@field sortOrder number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua new file mode 100644 index 0000000..9242bd9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua @@ -0,0 +1,93 @@ +---@meta _ +C_CovenantSanctumUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.CanAccessReservoir) +---@return boolean canAccess +function C_CovenantSanctumUI.CanAccessReservoir() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.CanDepositAnima) +---@return boolean canDeposit +function C_CovenantSanctumUI.CanDepositAnima() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.DepositAnima) +function C_CovenantSanctumUI.DepositAnima() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.EndInteraction) +function C_CovenantSanctumUI.EndInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetAnimaInfo) +---@return number currencyID +---@return number maxDisplayableValue +function C_CovenantSanctumUI.GetAnimaInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetCurrentTalentTreeID) +---@return number? currentTalentTreeID +function C_CovenantSanctumUI.GetCurrentTalentTreeID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetFeatures) +---@return CovenantSanctumFeatureInfo[] features +function C_CovenantSanctumUI.GetFeatures() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetRenownLevel) +---@return number level +function C_CovenantSanctumUI.GetRenownLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetRenownLevels) +---@param covenantID number +---@return CovenantSanctumRenownLevelInfo[] levels +function C_CovenantSanctumUI.GetRenownLevels(covenantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetRenownRewardsForLevel) +---@param covenantID number +---@param renownLevel number +---@return CovenantSanctumRenownRewardInfo[] rewards +function C_CovenantSanctumUI.GetRenownRewardsForLevel(covenantID, renownLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetSanctumType) +---@return Enum.GarrTalentFeatureSubtype? sanctumType +function C_CovenantSanctumUI.GetSanctumType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.GetSoulCurrencies) +---@return number[] currencyIDs +function C_CovenantSanctumUI.GetSoulCurrencies() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.HasMaximumRenown) +---@return boolean hasMaxRenown +function C_CovenantSanctumUI.HasMaximumRenown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.IsPlayerInRenownCatchUpMode) +---@return boolean isInCatchUpMode +function C_CovenantSanctumUI.IsPlayerInRenownCatchUpMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.IsWeeklyRenownCapped) +---@return boolean isWeeklyCapped +function C_CovenantSanctumUI.IsWeeklyRenownCapped() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CovenantSanctumUI.RequestCatchUpState) +function C_CovenantSanctumUI.RequestCatchUpState() end + +---@class CovenantSanctumFeatureInfo +---@field garrTalentTreeID number +---@field featureType number +---@field uiOrder number + +---@class CovenantSanctumRenownLevelInfo +---@field level number +---@field locked boolean +---@field isMilestone boolean +---@field isCapstone boolean + +---@class CovenantSanctumRenownRewardInfo +---@field uiOrder number +---@field itemID number? +---@field spellID number? +---@field mountID number? +---@field transmogID number? +---@field transmogSetID number? +---@field titleMaskID number? +---@field garrFollowerID number? +---@field transmogIllusionSourceID number? +---@field icon fileID? +---@field name string? +---@field description string? +---@field toastDescription string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua new file mode 100644 index 0000000..d3b5fdd --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua @@ -0,0 +1,32 @@ +---@meta _ +C_Covenants = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Covenants.GetActiveCovenantID) +---@return number covenantID +function C_Covenants.GetActiveCovenantID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Covenants.GetCovenantData) +---@param covenantID number +---@return CovenantData? data +function C_Covenants.GetCovenantData(covenantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Covenants.GetCovenantIDs) +---@return number[] covenantID +function C_Covenants.GetCovenantIDs() end + +---@class CovenantData +---@field ID number +---@field textureKit textureKit +---@field celebrationSoundKit number +---@field animaChannelSelectSoundKit number +---@field animaChannelActiveSoundKit number +---@field animaGemsFullSoundKit number +---@field animaNewGemSoundKit number +---@field animaReinforceSelectSoundKit number +---@field upgradeTabSelectSoundKitID number +---@field reservoirFullSoundKitID number +---@field beginResearchSoundKitID number +---@field renownFanfareSoundKitID number +---@field factionID number +---@field name string +---@field soulbindIDs number[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua new file mode 100644 index 0000000..f8e9cf8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua @@ -0,0 +1,174 @@ +---@meta _ +C_CraftingOrders = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.AreOrderNotesDisabled) +---@return boolean areNotesDisabled +function C_CraftingOrders.AreOrderNotesDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.CalculateCraftingOrderPostingFee) +---@param skillLineAbilityID number +---@param orderType Enum.CraftingOrderType +---@param orderDuration Enum.CraftingOrderDuration +---@return WOWMONEY deposit +function C_CraftingOrders.CalculateCraftingOrderPostingFee(skillLineAbilityID, orderType, orderDuration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.CanOrderSkillAbility) +---@param skillLineAbilityID number +---@return boolean canOrder +function C_CraftingOrders.CanOrderSkillAbility(skillLineAbilityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.CancelOrder) +---@param orderID BigUInteger +function C_CraftingOrders.CancelOrder(orderID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.ClaimOrder) +---@param orderID BigUInteger +---@param profession Enum.Profession +function C_CraftingOrders.ClaimOrder(orderID, profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.CloseCrafterCraftingOrders) +function C_CraftingOrders.CloseCrafterCraftingOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.CloseCustomerCraftingOrders) +function C_CraftingOrders.CloseCustomerCraftingOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.FulfillOrder) +---@param orderID BigUInteger +---@param crafterNote string +---@param profession Enum.Profession +function C_CraftingOrders.FulfillOrder(orderID, crafterNote, profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetClaimedOrder) +---@return CraftingOrderInfo? order +function C_CraftingOrders.GetClaimedOrder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetCrafterBuckets) +---@return CraftingOrderBucketInfo[] buckets +function C_CraftingOrders.GetCrafterBuckets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetCrafterOrders) +---@return CraftingOrderInfo[] orders +function C_CraftingOrders.GetCrafterOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetCraftingOrderTime) +---@return BigUInteger time +function C_CraftingOrders.GetCraftingOrderTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetCustomerCategories) +---@return CraftingOrderCustomerCategory[] categories +function C_CraftingOrders.GetCustomerCategories() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetCustomerOptions) +---@param params CraftingOrderCustomerSearchParams +---@return CraftingOrderCustomerSearchResults results +function C_CraftingOrders.GetCustomerOptions(params) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetCustomerOrders) +---@return CraftingOrderInfo[] customerOrders +function C_CraftingOrders.GetCustomerOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetDefaultOrdersSkillLine) +---@return number? skillLineID +function C_CraftingOrders.GetDefaultOrdersSkillLine() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetMyOrders) +---@return CraftingOrderInfo[] myOrders +function C_CraftingOrders.GetMyOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetNumFavoriteCustomerOptions) +---@return BigUInteger numFavorites +function C_CraftingOrders.GetNumFavoriteCustomerOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetOrderClaimInfo) +---@param profession Enum.Profession +---@return CraftingOrderClaimsRemainingInfo claimInfo +function C_CraftingOrders.GetOrderClaimInfo(profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.GetPersonalOrdersInfo) +---@return CraftingOrderPersonalOrdersInfo[] infos +function C_CraftingOrders.GetPersonalOrdersInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.HasFavoriteCustomerOptions) +---@return boolean hasFavorites +function C_CraftingOrders.HasFavoriteCustomerOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.IsCustomerOptionFavorited) +---@param recipeID number +---@return boolean favorited +function C_CraftingOrders.IsCustomerOptionFavorited(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.ListMyOrders) +---@param request CraftingOrderRequestMyOrdersInfo +function C_CraftingOrders.ListMyOrders(request) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.OpenCrafterCraftingOrders) +function C_CraftingOrders.OpenCrafterCraftingOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.OpenCustomerCraftingOrders) +function C_CraftingOrders.OpenCustomerCraftingOrders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.OrderCanBeRecrafted) +---@param orderID BigUInteger +---@return boolean recraftable +function C_CraftingOrders.OrderCanBeRecrafted(orderID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.ParseCustomerOptions) +function C_CraftingOrders.ParseCustomerOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.PlaceNewOrder) +---@param orderInfo NewCraftingOrderInfo +function C_CraftingOrders.PlaceNewOrder(orderInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.RejectOrder) +---@param orderID BigUInteger +---@param crafterNote string +---@param profession Enum.Profession +function C_CraftingOrders.RejectOrder(orderID, crafterNote, profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.ReleaseOrder) +---@param orderID BigUInteger +---@param profession Enum.Profession +function C_CraftingOrders.ReleaseOrder(orderID, profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.RequestCrafterOrders) +---@param request CraftingOrderRequestInfo +function C_CraftingOrders.RequestCrafterOrders(request) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.RequestCustomerOrders) +---@param request CraftingOrderRequestInfo +function C_CraftingOrders.RequestCustomerOrders(request) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.SetCustomerOptionFavorited) +---@param recipeID number +---@param favorited boolean +function C_CraftingOrders.SetCustomerOptionFavorited(recipeID, favorited) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.ShouldShowCraftingOrderTab) +---@return boolean showTab +function C_CraftingOrders.ShouldShowCraftingOrderTab() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.SkillLineHasOrders) +---@param skillLineID number +---@return boolean hasOrders +function C_CraftingOrders.SkillLineHasOrders(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CraftingOrders.UpdateIgnoreList) +function C_CraftingOrders.UpdateIgnoreList() end + +---@class CraftingOrderRequestInfo +---@field orderType Enum.CraftingOrderType +---@field selectedSkillLineAbility number? +---@field searchFavorites boolean +---@field initialNonPublicSearch boolean +---@field primarySort CraftingOrderSortInfo +---@field secondarySort CraftingOrderSortInfo +---@field forCrafter boolean +---@field offset number +---@field callback CraftingOrderRequestCallback +---@field profession Enum.Profession? + +---@class CraftingOrderRequestMyOrdersInfo +---@field primarySort CraftingOrderSortInfo +---@field secondarySort CraftingOrderSortInfo +---@field offset number +---@field callback CraftingOrderRequestMyOrdersCallback diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua new file mode 100644 index 0000000..6902bde --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua @@ -0,0 +1,144 @@ +---@meta _ +---@class CraftingOrderBucketInfo +---@field itemID number +---@field spellID number +---@field skillLineAbilityID number +---@field tipAmountAvg WOWMONEY +---@field tipAmountMax WOWMONEY +---@field numAvailable number + +---@class CraftingOrderClaimsRemainingInfo +---@field claimsRemaining number? Default = 0 +---@field secondsToRecharge number? + +---@class CraftingOrderCustomerCategory +---@field categoryName string +---@field categoryID number +---@field uiSortOrder number +---@field primaryCategorySortOrder number? +---@field secondaryCategorySortOrder number? +---@field type Enum.CraftingOrderCustomerCategoryType + +---@class CraftingOrderCustomerCategoryFilters +---@field primaryCategoryID number? +---@field secondaryCategoryID number? +---@field tertiaryCategoryID number? + +---@class CraftingOrderCustomerOptionInfo +---@field skillLineAbilityID number +---@field professionID number +---@field skillUpSkillLineID number +---@field spellID number +---@field itemID number +---@field itemName string +---@field primaryCategoryID number +---@field iLvlMin number +---@field iLvlMax number? +---@field canUse boolean +---@field bindOnPickup boolean +---@field qualityIlvlBonuses number[]? +---@field craftingQualityIDs number[]? +---@field quality Enum.ItemQuality? +---@field slots number? +---@field level number? +---@field skill number? +---@field secondaryCategoryID number? +---@field tertiaryCategoryID number? +---@field expansionID number? + +---@class CraftingOrderCustomerSearchParams +---@field categoryFilters CraftingOrderCustomerCategoryFilters +---@field searchText string? +---@field minLevel number +---@field maxLevel number +---@field uncollectedOnly boolean +---@field usableOnly boolean +---@field upgradesOnly boolean +---@field currentExpansionOnly boolean +---@field includePoor boolean +---@field includeCommon boolean +---@field includeUncommon boolean +---@field includeRare boolean +---@field includeEpic boolean +---@field includeLegendary boolean +---@field includeArtifact boolean +---@field isFavoritesSearch boolean + +---@class CraftingOrderCustomerSearchResults +---@field options CraftingOrderCustomerOptionInfo[] +---@field extraColumnType Enum.AuctionHouseExtraColumn? + +---@class CraftingOrderInfo +---@field orderID BigUInteger +---@field itemID number +---@field spellID number +---@field skillLineAbilityID number +---@field orderType Enum.CraftingOrderType +---@field orderState Enum.CraftingOrderState +---@field expirationTime time_t +---@field claimEndTime time_t +---@field minQuality number +---@field tipAmount WOWMONEY +---@field consortiumCut WOWMONEY +---@field isRecraft boolean +---@field isFulfillable boolean +---@field reagentState Enum.CraftingOrderReagentsType +---@field customerGuid WOWGUID? +---@field customerName string? +---@field crafterGuid WOWGUID? +---@field crafterName string? +---@field npcCustomerCreatureID number? +---@field customerNotes string +---@field reagents CraftingOrderReagentInfo[] +---@field outputItemHyperlink string? +---@field outputItemGUID WOWGUID? +---@field recraftItemHyperlink string? +---@field npcOrderRewards CraftingOrderRewardInfo[] +---@field npcCraftingOrderSetID number +---@field npcTreasureID number + +---@class CraftingOrderMailInfo +---@field reason Enum.RcoCloseReason +---@field recipeName string +---@field commissionPaid WOWMONEY? +---@field crafterNote string? +---@field crafterGUID WOWGUID? +---@field crafterName string? +---@field customerGUID WOWGUID? +---@field customerName string? + +---@class CraftingOrderPersonalOrdersInfo +---@field profession Enum.Profession +---@field numPersonalOrders number +---@field professionName string + +---@class CraftingOrderReagentInfo +---@field reagentInfo CraftingReagentInfo +---@field slotIndex number +---@field source Enum.CraftingOrderReagentSource +---@field isBasicReagent boolean + +---@class CraftingOrderRewardInfo +---@field itemLink string? +---@field currencyType number? +---@field count number + +---@class CraftingOrderSortInfo +---@field sortType Enum.CraftingOrderSortType +---@field reversed boolean + +---@class NewCraftingOrderInfo +---@field skillLineAbilityID number +---@field orderType Enum.CraftingOrderType +---@field orderDuration Enum.CraftingOrderDuration +---@field tipAmount WOWMONEY +---@field customerNotes string +---@field reagentInfos RegularReagentInfo[] +---@field craftingReagentItems CraftingReagentInfo[] +---@field minCraftingQualityID number? +---@field orderTarget string? +---@field recraftItem WOWGUID? + +---@alias CraftingOrderRequestCallback FunctionContainer|fun(result: Enum.CraftingOrderResult, orderType: Enum.CraftingOrderType, displayBuckets: boolean, expectMoreRows: boolean, offset: number, isSorted: boolean) + +---@alias CraftingOrderRequestMyOrdersCallback FunctionContainer|fun(result: Enum.CraftingOrderResult, expectMoreRows: boolean, offset: number, isSorted: boolean) diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua new file mode 100644 index 0000000..f0f06e6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua @@ -0,0 +1,63 @@ +---@meta _ +C_CreatureInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetClassInfo) +---@param classID number +---@return ClassInfo? classInfo +function C_CreatureInfo.GetClassInfo(classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetCreatureFamilyIDs) +---@return number[] creatureFamilyIDs +function C_CreatureInfo.GetCreatureFamilyIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetCreatureFamilyInfo) +---@param creatureFamilyID number +---@return CreatureFamilyInfo? creatureFamilyInfo +function C_CreatureInfo.GetCreatureFamilyInfo(creatureFamilyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetCreatureID) +---@param creatureGUID WOWGUID +---@return number? creatureID +function C_CreatureInfo.GetCreatureID(creatureGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetCreatureTypeIDs) +---@return number[] creatureTypeIDs +function C_CreatureInfo.GetCreatureTypeIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetCreatureTypeInfo) +---@param creatureTypeID number +---@return CreatureTypeInfo? creatureTypeInfo +function C_CreatureInfo.GetCreatureTypeInfo(creatureTypeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetFactionInfo) +---@param raceID number +---@return FactionInfo? factionInfo +function C_CreatureInfo.GetFactionInfo(raceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CreatureInfo.GetRaceInfo) +---@param raceID number +---@return RaceInfo? raceInfo +function C_CreatureInfo.GetRaceInfo(raceID) end + +---@class ClassInfo +---@field className string +---@field classFile string +---@field classID number + +---@class CreatureFamilyInfo +---@field id number +---@field name string +---@field iconFile fileID? + +---@class CreatureTypeInfo +---@field id number +---@field name string + +---@class FactionInfo +---@field name string +---@field groupTag string + +---@class RaceInfo +---@field raceName string +---@field clientFileString string +---@field raceID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua new file mode 100644 index 0000000..470fde2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua @@ -0,0 +1,282 @@ +---@meta _ +C_CurrencyInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.CanTransferCurrency) +---@param currencyID number +---@return boolean canTransferCurrency +---@return Enum.AccountCurrencyTransferResult? failureReason +function C_CurrencyInfo.CanTransferCurrency(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.DoesCurrentFilterRequireAccountCurrencyData) +---@return boolean doesCurrentFilterRequireAccountCurrencyData +function C_CurrencyInfo.DoesCurrentFilterRequireAccountCurrencyData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.DoesWarModeBonusApply) +---@param currencyID number +---@return boolean? warModeApplies +---@return boolean? limitOncePerTooltip +function C_CurrencyInfo.DoesWarModeBonusApply(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.ExpandCurrencyList) +---@param index number +---@param expand boolean +function C_CurrencyInfo.ExpandCurrencyList(index, expand) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.FetchCurrencyDataFromAccountCharacters) +---@param currencyID number +---@return CharacterCurrencyData[] accountCurrencyData +function C_CurrencyInfo.FetchCurrencyDataFromAccountCharacters(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.FetchCurrencyTransferTransactions) +---@return CurrencyTransferTransaction[] currencyTransferTransactions +function C_CurrencyInfo.FetchCurrencyTransferTransactions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetAzeriteCurrencyID) +---@return number azeriteCurrencyID +function C_CurrencyInfo.GetAzeriteCurrencyID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetBackpackCurrencyInfo) +---@param index number +---@return BackpackCurrencyInfo info +function C_CurrencyInfo.GetBackpackCurrencyInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetBasicCurrencyInfo) +---@param currencyType number +---@param quantity? number +---@return CurrencyDisplayInfo info +function C_CurrencyInfo.GetBasicCurrencyInfo(currencyType, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCoinIcon) +---@param amount WOWMONEY +---@return fileID result +function C_CurrencyInfo.GetCoinIcon(amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCoinText) +---@param amount WOWMONEY +---@param separator? string Default = , +---@return string result +function C_CurrencyInfo.GetCoinText(amount, separator) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCoinTextureString) +---@param amount WOWMONEY +---@param fontHeight? number Default = 14 +---@return string result +function C_CurrencyInfo.GetCoinTextureString(amount, fontHeight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCostToTransferCurrency) +---@param currencyID number +---@param quantity number +---@return number? totalQuantityConsumed +function C_CurrencyInfo.GetCostToTransferCurrency(currencyID, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyContainerInfo) +---@param currencyType number +---@param quantity number +---@return CurrencyDisplayInfo info +function C_CurrencyInfo.GetCurrencyContainerInfo(currencyType, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyDescription) +---@param type number +---@return string description +function C_CurrencyInfo.GetCurrencyDescription(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyFilter) +---@return Enum.CurrencyFilterType filterType +function C_CurrencyInfo.GetCurrencyFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyIDFromLink) +---@param currencyLink string +---@return number currencyID +function C_CurrencyInfo.GetCurrencyIDFromLink(currencyLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyInfo) +---@param type number +---@return CurrencyInfo info +function C_CurrencyInfo.GetCurrencyInfo(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyInfoFromLink) +---@param link string +---@return CurrencyInfo info +function C_CurrencyInfo.GetCurrencyInfoFromLink(link) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyLink) +---@param type number +---@param amount? number +---@return string link +function C_CurrencyInfo.GetCurrencyLink(type, amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyListInfo) +---@param index number +---@return CurrencyInfo info +function C_CurrencyInfo.GetCurrencyListInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyListLink) +---@param index number +---@return string link +function C_CurrencyInfo.GetCurrencyListLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCurrencyListSize) +---@return number currencyListSize +function C_CurrencyInfo.GetCurrencyListSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetDragonIslesSuppliesCurrencyID) +---@return number dragonIslesSuppliesCurrencyID +function C_CurrencyInfo.GetDragonIslesSuppliesCurrencyID() end + +---Gets the faction ID for currency that is immediately converted into reputation with that faction instead. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetFactionGrantedByCurrency) +---@param currencyID number +---@return number? factionID +function C_CurrencyInfo.GetFactionGrantedByCurrency(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetMaxTransferableAmountFromQuantity) +---@param currencyID number +---@param requestedQuantity number +---@return number? maxTransferableAmount +function C_CurrencyInfo.GetMaxTransferableAmountFromQuantity(currencyID, requestedQuantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetPlayerCurrencyCategoryInfo) +---@param categoryID number +---@param includeAccountWide? boolean Default = true +---@return PlayerCurrencyCategoryInfo info +function C_CurrencyInfo.GetPlayerCurrencyCategoryInfo(categoryID, includeAccountWide) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetWarResourcesCurrencyID) +---@return number warResourceCurrencyID +function C_CurrencyInfo.GetWarResourcesCurrencyID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.IsAccountCharacterCurrencyDataReady) +---@return boolean isReady +function C_CurrencyInfo.IsAccountCharacterCurrencyDataReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.IsAccountTransferableCurrency) +---@param currencyID number +---@return boolean isAccountTransferableCurrency +function C_CurrencyInfo.IsAccountTransferableCurrency(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.IsAccountWideCurrency) +---@param currencyID number +---@return boolean isAccountWideCurrency +function C_CurrencyInfo.IsAccountWideCurrency(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.IsCurrencyContainer) +---@param currencyID number +---@param quantity number +---@return boolean isCurrencyContainer +function C_CurrencyInfo.IsCurrencyContainer(currencyID, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.IsCurrencyTransferInProgress) +---@return boolean currencyTransferInProgress +function C_CurrencyInfo.IsCurrencyTransferInProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.IsCurrencyTransferTransactionDataReady) +---@return boolean isReady +function C_CurrencyInfo.IsCurrencyTransferTransactionDataReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.PickupCurrency) +---@param type number +function C_CurrencyInfo.PickupCurrency(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.PlayerHasMaxQuantity) +---@param currencyID number +---@return boolean hasMaxQuantity +function C_CurrencyInfo.PlayerHasMaxQuantity(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.PlayerHasMaxWeeklyQuantity) +---@param currencyID number +---@return boolean hasMaxWeeklyQuantity +function C_CurrencyInfo.PlayerHasMaxWeeklyQuantity(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.RequestCurrencyDataForAccountCharacters) +function C_CurrencyInfo.RequestCurrencyDataForAccountCharacters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.RequestCurrencyFromAccountCharacter) +---@param sourceCharacterGUID WOWGUID +---@param currencyID number +---@param quantity number +function C_CurrencyInfo.RequestCurrencyFromAccountCharacter(sourceCharacterGUID, currencyID, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.SetCurrencyBackpack) +---@param index number +---@param backpack boolean +function C_CurrencyInfo.SetCurrencyBackpack(index, backpack) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.SetCurrencyBackpackByID) +---@param currencyType number +---@param backpack boolean +function C_CurrencyInfo.SetCurrencyBackpackByID(currencyType, backpack) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.SetCurrencyFilter) +---@param filterType Enum.CurrencyFilterType +function C_CurrencyInfo.SetCurrencyFilter(filterType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.SetCurrencyUnused) +---@param index number +---@param unused boolean +function C_CurrencyInfo.SetCurrencyUnused(index, unused) end + +---@class BackpackCurrencyInfo +---@field name string +---@field quantity number +---@field iconFileID fileID +---@field currencyTypesID number + +---@class CharacterCurrencyData +---@field characterGUID WOWGUID +---@field characterName string +---@field fullCharacterName string +---@field currencyID number +---@field quantity number + +---@class CurrencyDisplayInfo +---@field name string +---@field description string +---@field icon number +---@field quality number +---@field displayAmount number +---@field actualAmount number + +---@class CurrencyInfo +---@field name string +---@field description string +---@field currencyID number +---@field isHeader boolean +---@field isHeaderExpanded boolean +---@field currencyListDepth number +---@field isTypeUnused boolean +---@field isShowInBackpack boolean +---@field quantity number +---@field trackedQuantity number +---@field iconFileID fileID +---@field maxQuantity number +---@field canEarnPerWeek boolean +---@field quantityEarnedThisWeek number +---@field isTradeable boolean +---@field quality Enum.ItemQuality +---@field maxWeeklyQuantity number +---@field totalEarned number +---@field discovered boolean +---@field useTotalEarnedForMaxQty boolean +---@field isAccountWide boolean +---@field isAccountTransferable boolean +---@field transferPercentage number? +---@field rechargingCycleDurationMS number +---@field rechargingAmountPerCycle number + +---@class CurrencyTransferTransaction +---@field sourceCharacterGUID WOWGUID +---@field sourceCharacterName string? Default = +---@field fullSourceCharacterName string? Default = +---@field destinationCharacterGUID WOWGUID +---@field destinationCharacterName string? Default = +---@field fullDestinationCharacterName string? Default = +---@field currencyType number +---@field quantityTransferred number +---@field totalQuantityConsumed number +---@field timestamp time_t + +---@class PlayerCurrencyCategoryInfo +---@field categoryName string +---@field currencyTypes number[] +---@field childCategories number[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua new file mode 100644 index 0000000..21a955a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_Cursor = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Cursor.GetCursorItem) +---@return ItemLocation item +function C_Cursor.GetCursorItem() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua new file mode 100644 index 0000000..4385dfa --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua @@ -0,0 +1,38 @@ +---@meta _ +C_CurveUtil = {} + +---Returns a new color curve object with no assigned points. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurveUtil.CreateColorCurve) +---@return LuaColorCurveObject curve +function C_CurveUtil.CreateColorCurve() end + +---Returns a new curve object with no assigned points. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurveUtil.CreateCurve) +---@return LuaCurveObject curve +function C_CurveUtil.CreateCurve() end + +---Evaluates a potentially-secret boolean value and returns a color. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurveUtil.EvaluateColorFromBoolean) +---@param boolean boolean +---@param valueIfTrue colorRGBA +---@param valueIfFalse colorRGBA +---@return colorRGBA value +function C_CurveUtil.EvaluateColorFromBoolean(boolean, valueIfTrue, valueIfFalse) end + +---Evaluates a potentially-secret boolean value and returns a single color component (eg. alpha). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurveUtil.EvaluateColorValueFromBoolean) +---@param boolean boolean +---@param valueIfTrue SingleColorValue +---@param valueIfFalse SingleColorValue +---@return SingleColorValue value +function C_CurveUtil.EvaluateColorValueFromBoolean(boolean, valueIfTrue, valueIfFalse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CurveUtil.EvaluateGameCurve) +---@param curveID number +---@param x number +---@return number y +function C_CurveUtil.EvaluateGameCurve(curveID, x) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua new file mode 100644 index 0000000..aff40c8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua @@ -0,0 +1,112 @@ +---@meta _ +C_DamageMeter = {} + +---Returns a list of combat sessions currently being tracked. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.GetAvailableCombatSessions) +---@return DamageMeterAvailableCombatSession[] availableSessions +function C_DamageMeter.GetAvailableCombatSessions() end + +---Returns the data for the player's combat session with the specified ID. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.GetCombatSessionFromID) +---@param sessionID number +---@param type Enum.DamageMeterType +---@return DamageMeterCombatSession session +function C_DamageMeter.GetCombatSessionFromID(sessionID, type) end + +---Returns the data for the player's current combat session. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.GetCombatSessionFromType) +---@param sessionType Enum.DamageMeterSessionType +---@param type Enum.DamageMeterType +---@return DamageMeterCombatSession session +function C_DamageMeter.GetCombatSessionFromType(sessionType, type) end + +---Returns the data for a single source (unit) in the player's current combat session with the specified ID. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.GetCombatSessionSourceFromID) +---@param sessionID number +---@param type Enum.DamageMeterType +---@param sourceGUID? WOWGUID +---@param sourceCreatureID? number +---@return DamageMeterCombatSessionSource sessionSource +function C_DamageMeter.GetCombatSessionSourceFromID(sessionID, type, sourceGUID, sourceCreatureID) end + +---Returns the data for a single source (unit) in the player's current combat session. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.GetCombatSessionSourceFromType) +---@param sessionType Enum.DamageMeterSessionType +---@param type Enum.DamageMeterType +---@param sourceGUID? WOWGUID +---@param sourceCreatureID? number +---@return DamageMeterCombatSessionSource sessionSource +function C_DamageMeter.GetCombatSessionSourceFromType(sessionType, type, sourceGUID, sourceCreatureID) end + +---Returns the amount of time a combat session has lasted +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.GetSessionDurationSeconds) +---@param sessionType Enum.DamageMeterSessionType +---@return number? durationSeconds +function C_DamageMeter.GetSessionDurationSeconds(sessionType) end + +---Returns whether the player can enable and use the Damage Meter. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.IsDamageMeterAvailable) +---@return boolean isAvailable +---@return string failureReason +function C_DamageMeter.IsDamageMeterAvailable() end + +---Clears the data for all the player's combat sessions. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DamageMeter.ResetAllCombatSessions) +function C_DamageMeter.ResetAllCombatSessions() end + +---@class DamageMeterAvailableCombatSession +---@field sessionID number +---@field name string +---@field durationSeconds number? + +---@class DamageMeterCombatSession +---@field combatSources DamageMeterCombatSource[] +---@field maxAmount number? Default = 0 +---@field totalAmount number? Default = 0 +---@field durationSeconds number? + +---@class DamageMeterCombatSessionSource +---@field combatSpells DamageMeterCombatSpell[] +---@field maxAmount number? Default = 0 +---@field totalAmount number? Default = 0 + +---@class DamageMeterCombatSource +---@field sourceGUID WOWGUID? +---@field sourceCreatureID number? +---@field name string +---@field classFilename string +---@field specIconID fileID +---@field totalAmount number +---@field amountPerSecond number +---@field isLocalPlayer boolean +---@field deathRecapID number +---@field deathTimeSeconds number +---@field classification string +---@field sourceDisplayType Enum.DamageMeterSourceDisplayType + +---@class DamageMeterCombatSpell +---@field spellID number +---@field totalAmount number +---@field amountPerSecond number +---@field creatureName string +---@field overkillAmount number +---@field isAvoidable boolean +---@field isDeadly boolean +---@field combatSpellDetails DamageMeterCombatSpellUnitDetails + +---@class DamageMeterCombatSpellUnitDetails +---@field unitName string +---@field unitClassFilename string +---@field classification string +---@field isPet boolean +---@field isMob boolean +---@field amount number +---@field specIconID fileID diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua new file mode 100644 index 0000000..e84fa85 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua @@ -0,0 +1,51 @@ +---@meta _ +C_DateAndTime = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.AdjustTimeByDays) +---@param date CalendarTime +---@param days number +---@return CalendarTime newDate +function C_DateAndTime.AdjustTimeByDays(date, days) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.AdjustTimeByMinutes) +---@param date CalendarTime +---@param minutes number +---@return CalendarTime newDate +function C_DateAndTime.AdjustTimeByMinutes(date, minutes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.AdjustTimeByMonths) +---@param date CalendarTime +---@param months number +---@return CalendarTime newDate +function C_DateAndTime.AdjustTimeByMonths(date, months) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.CompareCalendarTime) +---@param lhsCalendarTime CalendarTime +---@param rhsCalendarTime CalendarTime +---@return number comparison +function C_DateAndTime.CompareCalendarTime(lhsCalendarTime, rhsCalendarTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.GetCalendarTimeFromEpoch) +---@param epoch BigUInteger +---@return CalendarTime date +function C_DateAndTime.GetCalendarTimeFromEpoch(epoch) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.GetCurrentCalendarTime) +---@return CalendarTime date +function C_DateAndTime.GetCurrentCalendarTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.GetSecondsUntilDailyReset) +---@return time_t seconds +function C_DateAndTime.GetSecondsUntilDailyReset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.GetSecondsUntilWeeklyReset) +---@return time_t seconds +function C_DateAndTime.GetSecondsUntilWeeklyReset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.GetServerTimeLocal) +---@return time_t serverTimeLocal +function C_DateAndTime.GetServerTimeLocal() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DateAndTime.GetWeeklyResetStartTime) +---@return time_t seconds +function C_DateAndTime.GetWeeklyResetStartTime() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua new file mode 100644 index 0000000..c3a9065 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua @@ -0,0 +1,42 @@ +---@meta _ +C_DeathInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathInfo.GetCorpseMapPosition) +---@param uiMapID number +---@return vector2? position +function C_DeathInfo.GetCorpseMapPosition(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathInfo.GetDeathReleasePosition) +---@param uiMapID number +---@return vector2? position +function C_DeathInfo.GetDeathReleasePosition(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathInfo.GetGraveyardsForMap) +---@param uiMapID number +---@return GraveyardMapInfo[] graveyards +function C_DeathInfo.GetGraveyardsForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathInfo.GetSelfResurrectOptions) +---@return SelfResurrectOption[] options +function C_DeathInfo.GetSelfResurrectOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathInfo.UseSelfResurrectOption) +---@param optionType Enum.SelfResurrectOptionType +---@param id number +function C_DeathInfo.UseSelfResurrectOption(optionType, id) end + +---@class GraveyardMapInfo +---@field areaPoiID number +---@field position vector2 +---@field name string +---@field textureIndex number +---@field graveyardID number +---@field isGraveyardSelectable boolean + +---@class SelfResurrectOption +---@field name string +---@field optionType Enum.SelfResurrectOptionType +---@field id number +---@field canUse boolean +---@field isLimited boolean +---@field priority number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua new file mode 100644 index 0000000..13ec939 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua @@ -0,0 +1,26 @@ +---@meta _ +C_DeathRecap = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathRecap.GetRecapEvents) +---@param recapID? number +---@return DeathRecapEventInfo[] events +function C_DeathRecap.GetRecapEvents(recapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathRecap.GetRecapLink) +---@param recapID? number +---@return string link +function C_DeathRecap.GetRecapLink(recapID) end + +---Returns the max health for the unit that died in the provided death recap. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathRecap.GetRecapMaxHealth) +---@param recapID? number +---@return number maxHealth +function C_DeathRecap.GetRecapMaxHealth(recapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DeathRecap.HasRecapEvents) +---@param recapID? number +---@return boolean hasEvents +function C_DeathRecap.HasRecapEvents(recapID) end + +---@class DeathRecapEventInfo diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua new file mode 100644 index 0000000..b491ac1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua @@ -0,0 +1,28 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsCollisionEnabled) +---@return boolean result +function IsCollisionEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleAnimKitDisplay) +function ToggleAnimKitDisplay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleCollision) +function ToggleCollision() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleCollisionDisplay) +function ToggleCollisionDisplay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleDebugAIDisplay) +function ToggleDebugAIDisplay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleGravity) +function ToggleGravity() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TogglePlayerBounds) +function TogglePlayerBounds() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TogglePortals) +function TogglePortals() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleTris) +function ToggleTris() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua new file mode 100644 index 0000000..34bd84d --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +---@class DelveAssistActionData +---@field assistedPlayer string +---@field mapName string? +---@field creatureName string? +---@field receivedSpellID number? +---@field assistAction Enum.AssistActionType diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua new file mode 100644 index 0000000..2646e28 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua @@ -0,0 +1,178 @@ +---@meta _ +C_DelvesUI = {} + +---Returns the entrance tier information for the active Delve (via party data). Assumes only Delves use this type for now. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetActiveDelveTier) +---@return TieredEntranceTierInfo tierInfo +function C_DelvesUI.GetActiveDelveTier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetCompanionInfoForActivePlayer) +---@return number playerCompanionInfoID +function C_DelvesUI.GetCompanionInfoForActivePlayer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetCreatureDisplayInfoForCompanion) +---@param companionID? number +---@return number creatureDisplayInfoID +function C_DelvesUI.GetCreatureDisplayInfoForCompanion(companionID) end + +---Given the spell ID for an owned curio and its rarity, return a spell link style hyperlink for the curio spell, since they aren't items when learned +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetCurioLink) +---@param spellID SpellIdentifier +---@param rarity Enum.CurioRarity +---@return string curioLink +function C_DelvesUI.GetCurioLink(spellID, rarity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetCurioNodeForCompanion) +---@param curioType Enum.CurioType +---@param companionID? number +---@return number nodeID +function C_DelvesUI.GetCurioNodeForCompanion(curioType, companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetCurioRarityByTraitCondAccountElementID) +---@param traitCondAccountElementID number +---@return Enum.CurioRarity rarity +function C_DelvesUI.GetCurioRarityByTraitCondAccountElementID(traitCondAccountElementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetCurrentDelvesSeasonNumber) +---@return number seasonNumber +function C_DelvesUI.GetCurrentDelvesSeasonNumber() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelveEntranceBackgroundWidgetSetID) +---@return number backgroundWidgetSetID +function C_DelvesUI.GetDelveEntranceBackgroundWidgetSetID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelveEntranceDescriptionString) +---@return string? description +function C_DelvesUI.GetDelveEntranceDescriptionString() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelveEntranceHeaderString) +---@return string? header +function C_DelvesUI.GetDelveEntranceHeaderString() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelveEntranceMapID) +---@return number mapID +function C_DelvesUI.GetDelveEntranceMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelveEntranceTiers) +---@return TieredEntranceTierInfo[] levelInfo +function C_DelvesUI.GetDelveEntranceTiers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelvesAffixSpellsForSeason) +---@return number[] affixSpellIDs +function C_DelvesUI.GetDelvesAffixSpellsForSeason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelvesFactionForSeason) +---@return number factionID +function C_DelvesUI.GetDelvesFactionForSeason() end + +---Players must be at or above the min level + offset to enter Delves. This function returns that min level. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetDelvesMinRequiredLevel) +---@return number? minRequiredLevel +function C_DelvesUI.GetDelvesMinRequiredLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetFactionForCompanion) +---@param companionID? number +---@return number factionID +function C_DelvesUI.GetFactionForCompanion(companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetLockedTextForCompanion) +---@param companionID? number +---@return string text +function C_DelvesUI.GetLockedTextForCompanion(companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetModelSceneForCompanion) +---@param companionID? number +---@return number modelSceneID +function C_DelvesUI.GetModelSceneForCompanion(companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetPlayerCompanionPDEID) +---@param companionID? number +---@return number pdeID +function C_DelvesUI.GetPlayerCompanionPDEID(companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetRoleNodeForCompanion) +---@param companionID? number +---@return number nodeID +function C_DelvesUI.GetRoleNodeForCompanion(companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetRoleSubtreeForCompanion) +---@param roleType Enum.CompanionRoleType +---@param companionID? number +---@return number subTreeID +function C_DelvesUI.GetRoleSubtreeForCompanion(roleType, companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetTieredEntranceOptionalAffixTraitTreeID) +---@return number? treeID +function C_DelvesUI.GetTieredEntranceOptionalAffixTraitTreeID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetTieredEntrancePDEID) +---@return number pdeID +function C_DelvesUI.GetTieredEntrancePDEID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetTieredEntranceType) +---@return number entranceType +function C_DelvesUI.GetTieredEntranceType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetTraitTreeForCompanion) +---@param companionID? number +---@return number treeID +function C_DelvesUI.GetTraitTreeForCompanion(companionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.GetUnseenCuriosBySlotType) +---@param slotType Enum.CompanionConfigSlotTypes +---@param ownedCurioNodeIDs number[] +---@return number[] unseenCurioNodeIDs +function C_DelvesUI.GetUnseenCuriosBySlotType(slotType, ownedCurioNodeIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.HasActiveDelve) +---@return boolean result +function C_DelvesUI.HasActiveDelve() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.IsDelveEntranceTierEnabled) +---@param tier number +---@return boolean isEnabled +---@return string? failureReason +function C_DelvesUI.IsDelveEntranceTierEnabled(tier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.IsEligibleForActiveDelveRewards) +---@param unit UnitToken +---@return boolean result +function C_DelvesUI.IsEligibleForActiveDelveRewards(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.IsTraitTreeForCompanion) +---@param traitTreeID number +---@return boolean isForCompanion +function C_DelvesUI.IsTraitTreeForCompanion(traitTreeID) end + +---Queries private party members to see what level they have unlocked for the Delve. Ineligible members are added to the tooltip of dropdown entries. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.RequestPartyEligibilityForDelveTiers) +---@param mapID number +function C_DelvesUI.RequestPartyEligibilityForDelveTiers(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.SaveSeenCuriosBySlotType) +---@param slotType Enum.CompanionConfigSlotTypes +---@param ownedCurioNodeIDs number[] +function C_DelvesUI.SaveSeenCuriosBySlotType(slotType, ownedCurioNodeIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DelvesUI.SelectDelveEntranceTier) +---@param tier number +function C_DelvesUI.SelectDelveEntranceTier(tier) end + +---@class TieredEntranceRewardInfo +---@field id number +---@field quantity number +---@field rewardType Enum.TieredEntranceRewardType +---@field context Enum.ItemCreationContext + +---@class TieredEntranceTierInfo +---@field tier number +---@field suggestedILvl number +---@field unlocked boolean +---@field tierDescription string +---@field rewards TieredEntranceRewardInfo[] +---@field modifierUIWidgetSetID number +---@field lockedReason string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua new file mode 100644 index 0000000..e2d55bc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua @@ -0,0 +1,14 @@ +---@meta _ +C_DurationUtil = {} + +---Creates a zero duration container that can represent a time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DurationUtil.CreateDuration) +---@return LuaDurationObject duration +function C_DurationUtil.CreateDuration() end + +---Returns the current time used by duration objects. Equivalent to GetTime() in public builds. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DurationUtil.GetCurrentTime) +---@return FrameTime currentTime +function C_DurationUtil.GetCurrentTime() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua new file mode 100644 index 0000000..e939d97 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua @@ -0,0 +1,44 @@ +---@meta _ +C_DyeColor = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetAllDyeColorCategories) +---@return number[] dyeColorCategoryIDs +function C_DyeColor.GetAllDyeColorCategories() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetAllDyeColors) +---@param ownedColorsOnly? boolean Default = false +---@return number[] dyeColorIDs +function C_DyeColor.GetAllDyeColors(ownedColorsOnly) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetDyeColorCategoryInfo) +---@param dyeColorCategoryID number +---@return DyeColorCategoryDisplayInfo? dyeColorCategoryInfo +function C_DyeColor.GetDyeColorCategoryInfo(dyeColorCategoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetDyeColorForItem) +---@param itemLinkOrID ItemInfo +---@return number? dyeColorID +function C_DyeColor.GetDyeColorForItem(itemLinkOrID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetDyeColorForItemLocation) +---@param itemLocation ItemLocation +---@return number? dyeColorID +function C_DyeColor.GetDyeColorForItemLocation(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetDyeColorInfo) +---@param dyeColorID number +---@return DyeColorDisplayInfo? dyeColorInfo +function C_DyeColor.GetDyeColorInfo(dyeColorID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.GetDyeColorsInCategory) +---@param dyeColorCategory number +---@param ownedColorsOnly? boolean Default = false +---@return number[] dyeColorIDs +function C_DyeColor.GetDyeColorsInCategory(dyeColorCategory, ownedColorsOnly) end + +---True if the player owns any of the consumable item used to apply the specified dye +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_DyeColor.IsDyeColorOwned) +---@param dyeColorID number +---@return boolean isOwned +function C_DyeColor.IsDyeColorOwned(dyeColorID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua new file mode 100644 index 0000000..0ea4ebc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua @@ -0,0 +1,14 @@ +---@meta _ +---@class DyeColorCategoryDisplayInfo +---@field ID number +---@field name string + +---@class DyeColorDisplayInfo +---@field ID number +---@field dyeColorCategoryID number +---@field name string +---@field sortOrder number +---@field swatchColorStart colorRGB +---@field swatchColorEnd colorRGB +---@field itemID number? +---@field numOwned number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua new file mode 100644 index 0000000..b0efe32 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua @@ -0,0 +1,79 @@ +---@meta _ +C_EditMode = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.ConvertLayoutInfoToString) +---@param layoutInfo EditModeLayoutInfo +---@return string layoutInfoAsString +function C_EditMode.ConvertLayoutInfoToString(layoutInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.ConvertStringToLayoutInfo) +---@param layoutInfoAsString string +---@return EditModeLayoutInfo layoutInfo +function C_EditMode.ConvertStringToLayoutInfo(layoutInfoAsString) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.GetAccountSettings) +---@return EditModeSettingInfo[] accountSettings +function C_EditMode.GetAccountSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.GetLayouts) +---@return EditModeLayouts layoutInfo +function C_EditMode.GetLayouts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.IsValidLayoutName) +---@param name string +---@return boolean isApproved +function C_EditMode.IsValidLayoutName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.OnEditModeExit) +function C_EditMode.OnEditModeExit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.OnLayoutAdded) +---@param addedLayoutIndex number +---@param activateNewLayout boolean +---@param isLayoutImported boolean +function C_EditMode.OnLayoutAdded(addedLayoutIndex, activateNewLayout, isLayoutImported) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.OnLayoutDeleted) +---@param deletedLayoutIndex number +function C_EditMode.OnLayoutDeleted(deletedLayoutIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.SaveLayouts) +---@param saveInfo EditModeLayouts +function C_EditMode.SaveLayouts(saveInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.SetAccountSetting) +---@param setting Enum.EditModeAccountSetting +---@param value number +function C_EditMode.SetAccountSetting(setting, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EditMode.SetActiveLayout) +---@param activeLayout number +function C_EditMode.SetActiveLayout(activeLayout) end + +---@class EditModeAnchorInfo +---@field point FramePoint +---@field relativeTo string +---@field relativePoint FramePoint +---@field offsetX number +---@field offsetY number + +---@class EditModeLayoutInfo +---@field layoutName string +---@field layoutType Enum.EditModeLayoutType +---@field systems EditModeSystemInfo[] + +---@class EditModeLayouts +---@field layouts EditModeLayoutInfo[] +---@field activeLayout number + +---@class EditModeSettingInfo +---@field setting number +---@field value number + +---@class EditModeSystemInfo +---@field system Enum.EditModeSystem +---@field systemIndex number? +---@field anchorInfo EditModeAnchorInfo +---@field anchorInfo2 EditModeAnchorInfo? +---@field settings EditModeSettingInfo[] +---@field isInDefaultPosition boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua new file mode 100644 index 0000000..c377db2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua @@ -0,0 +1,65 @@ +---@meta _ +C_EncodingUtil = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.CompressString) +---@param source stringView +---@param method? Enum.CompressionMethod Default = Deflate +---@param level? Enum.CompressionLevel Default = Default +---@return string output +function C_EncodingUtil.CompressString(source, method, level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.DecodeBase64) +---@param source stringView +---@param variant? Enum.Base64Variant Default = Standard +---@return string output +function C_EncodingUtil.DecodeBase64(source, variant) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.DecodeHex) +---@param source string +---@return string output +function C_EncodingUtil.DecodeHex(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.DecompressString) +---@param source stringView +---@param method? Enum.CompressionMethod Default = Deflate +---@return string output +function C_EncodingUtil.DecompressString(source, method) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.DeserializeCBOR) +---@param source stringView +---@return LuaValueVariant? value +function C_EncodingUtil.DeserializeCBOR(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.DeserializeJSON) +---@param source string +---@return LuaValueVariant? value +function C_EncodingUtil.DeserializeJSON(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.EncodeBase64) +---@param source stringView +---@param variant? Enum.Base64Variant Default = Standard +---@return string output +function C_EncodingUtil.EncodeBase64(source, variant) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.EncodeHex) +---@param source stringView +---@return string output +function C_EncodingUtil.EncodeHex(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.SerializeCBOR) +---@param value? LuaValueVariant +---@param options? CBORSerializationOptions +---@return string output +function C_EncodingUtil.SerializeCBOR(value, options) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncodingUtil.SerializeJSON) +---@param value? LuaValueVariant +---@param options? JSONSerializationOptions +---@return string output +function C_EncodingUtil.SerializeJSON(value, options) end + +---@class CBORSerializationOptions +---@field ignoreSerializationErrors boolean? Default = false + +---@class JSONSerializationOptions +---@field ignoreSerializationErrors boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua new file mode 100644 index 0000000..5402458 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua @@ -0,0 +1,60 @@ +---@meta _ +C_EncounterEvents = {} + +---Returns any custom color override applied for an encounter event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.GetEventColor) +---@param encounterEventID number +---@return colorRGB? color +function C_EncounterEvents.GetEventColor(encounterEventID) end + +---Returns information about an encounter event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.GetEventInfo) +---@param encounterEventID number +---@return EncounterEventInfo encounterEventInfo +function C_EncounterEvents.GetEventInfo(encounterEventID) end + +---Returns a list of all encounter event IDs. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.GetEventList) +---@return number[] encounterEventIDs +function C_EncounterEvents.GetEventList() end + +---Returns information on a custom sound file to be played when an encounter event trigger occurs. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.GetEventSound) +---@param encounterEventID number +---@param trigger Enum.EncounterEventSoundTrigger +---@return EncounterEventSoundInfo sound +function C_EncounterEvents.GetEventSound(encounterEventID, trigger) end + +---Returns true if an encounter event record with a specified ID exists. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.HasEventInfo) +---@param encounterEventID number +---@return boolean exists +function C_EncounterEvents.HasEventInfo(encounterEventID) end + +---Plays any registered custom sound file for a given encounter event trigger. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.PlayEventSound) +---@param encounterEventID number +---@param trigger Enum.EncounterEventSoundTrigger +---@return SoundHandle handle +function C_EncounterEvents.PlayEventSound(encounterEventID, trigger) end + +---Sets a custom color override for an encounter event. This can be used to colorize text or timer bars individually. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.SetEventColor) +---@param encounterEventID number +---@param color? colorRGB +function C_EncounterEvents.SetEventColor(encounterEventID, color) end + +---Sets a custom sound file to be played when an encounter event trigger occurs. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterEvents.SetEventSound) +---@param encounterEventID number +---@param trigger Enum.EncounterEventSoundTrigger +---@param sound? EncounterEventSoundInfo +function C_EncounterEvents.SetEventSound(encounterEventID, trigger, sound) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua new file mode 100644 index 0000000..29ddd8b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua @@ -0,0 +1,14 @@ +---@meta _ +---@class EncounterEventInfo +---@field encounterEventID number +---@field enabled boolean +---@field spellID number +---@field iconFileID number +---@field severity Enum.EncounterEventSeverity +---@field icons Enum.EncounterEventIconmask +---@field color colorRGB? + +---@class EncounterEventSoundInfo +---@field file FileAsset +---@field channel UISoundSubType? Default = g_defaultSI3UISoundSubTypeForLua +---@field volume number? Default = 1 diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua new file mode 100644 index 0000000..8c3ce51 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua @@ -0,0 +1,139 @@ +---@meta _ +C_EncounterJournal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetDungeonEntrancesForMap) +---@param uiMapID number +---@return DungeonEntranceMapInfo[] dungeonEntrances +function C_EncounterJournal.GetDungeonEntrancesForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetEncounterJournalLink) +---@param linkType Enum.JournalLinkTypes +---@param ID number +---@param displayText string +---@param difficultyID number +---@return string link +function C_EncounterJournal.GetEncounterJournalLink(linkType, ID, displayText, difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetEncountersOnMap) +---@param uiMapID number +---@return EncounterJournalMapEncounterInfo[] encounters +function C_EncounterJournal.GetEncountersOnMap(uiMapID) end + +---GameMap as opposed to UIMap since we use a mapID not a uiMapID. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetInstanceForGameMap) +---@param mapID number +---@return number? journalInstanceID +function C_EncounterJournal.GetInstanceForGameMap(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetLootInfo) +---@param id number +---@return EncounterJournalItemInfo itemInfo +function C_EncounterJournal.GetLootInfo(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetLootInfoByIndex) +---@param index number +---@param encounterIndex? number +---@return EncounterJournalItemInfo itemInfo +function C_EncounterJournal.GetLootInfoByIndex(index, encounterIndex) end + +---Represents the icon indices for this EJ section. An icon index can be used to arrive at texture coordinates for specific encounter types, e.g.: EncounterJournal_SetFlagIcon +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetSectionIconFlags) +---@param sectionID number +---@return number[]? iconFlags +function C_EncounterJournal.GetSectionIconFlags(sectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetSectionInfo) +---@param sectionID number +---@return EncounterJournalSectionInfo info +function C_EncounterJournal.GetSectionInfo(sectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.GetSlotFilter) +---@return Enum.ItemSlotFilterType filter +function C_EncounterJournal.GetSlotFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.InitalizeSelectedTier) +function C_EncounterJournal.InitalizeSelectedTier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.InstanceHasLoot) +---@param instanceID? number +---@return boolean hasLoot +function C_EncounterJournal.InstanceHasLoot(instanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.IsEncounterComplete) +---@param journalEncounterID number +---@return boolean isEncounterComplete +function C_EncounterJournal.IsEncounterComplete(journalEncounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.OnClose) +function C_EncounterJournal.OnClose() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.OnOpen) +function C_EncounterJournal.OnOpen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.ResetSlotFilter) +function C_EncounterJournal.ResetSlotFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.SetPreviewMythicPlusLevel) +---@param level number +function C_EncounterJournal.SetPreviewMythicPlusLevel(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.SetPreviewPvpTier) +---@param tier number +function C_EncounterJournal.SetPreviewPvpTier(tier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.SetSlotFilter) +---@param filterSlot Enum.ItemSlotFilterType +function C_EncounterJournal.SetSlotFilter(filterSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.SetTab) +---@param tabIdx number +function C_EncounterJournal.SetTab(tabIdx) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterJournal.StartArathiRPE) +function C_EncounterJournal.StartArathiRPE() end + +---@class DungeonEntranceMapInfo +---@field areaPoiID number +---@field position vector2 +---@field name string +---@field description string +---@field atlasName string +---@field journalInstanceID number + +---@class EncounterJournalItemInfo +---@field itemID number +---@field encounterID number? +---@field name string? +---@field itemQuality string? +---@field filterType Enum.ItemSlotFilterType? +---@field icon fileID? +---@field slot string? +---@field armorType string? +---@field link string? +---@field handError boolean? +---@field weaponTypeError boolean? +---@field displayAsPerPlayerLoot boolean? +---@field displayAsVeryRare boolean? +---@field displayAsExtremelyRare boolean? +---@field displaySeasonID number? + +---@class EncounterJournalMapEncounterInfo +---@field encounterID number +---@field mapX number +---@field mapY number + +---@class EncounterJournalSectionInfo +---@field spellID number +---@field title string +---@field description string? +---@field headerType number +---@field abilityIcon fileID +---@field creatureDisplayID number +---@field uiModelSceneID number +---@field siblingSectionID number? +---@field firstChildSectionID number? +---@field filteredByDifficulty boolean +---@field link string +---@field startsOpen boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua new file mode 100644 index 0000000..995b2ec --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua @@ -0,0 +1,256 @@ +---@meta _ +C_EncounterTimeline = {} + +---Adds a predefined set of events to the timeline for display in Edit Mode. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.AddEditModeEvents) +---@return DurationSeconds loopTimerDuration +function C_EncounterTimeline.AddEditModeEvents() end + +---Adds a custom event to the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.AddScriptEvent) +---@param eventInfo EncounterTimelineScriptEventRequest +---@return EncounterTimelineEventID eventID +function C_EncounterTimeline.AddScriptEvent(eventInfo) end + +---Cancels all custom timeline events, removing them from the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.CancelAllScriptEvents) +function C_EncounterTimeline.CancelAllScriptEvents() end + +---Removes all Edit Mode events from the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.CancelEditModeEvents) +function C_EncounterTimeline.CancelEditModeEvents() end + +---Cancels a custom timeline event, removing it from the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.CancelScriptEvent) +---@param eventID EncounterTimelineEventID +function C_EncounterTimeline.CancelScriptEvent(eventID) end + +---Finishes a custom timeline event, removing it from the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.FinishScriptEvent) +---@param eventID EncounterTimelineEventID +function C_EncounterTimeline.FinishScriptEvent(eventID) end + +---Returns the current timestamp used for rendering the timeline display. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetCurrentTime) +---@return DurationSeconds currentTime +function C_EncounterTimeline.GetCurrentTime() end + +---Returns the number of present events in the timeline by their source type. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventCountBySource) +---@param source Enum.EncounterTimelineEventSource +---@return number count +function C_EncounterTimeline.GetEventCountBySource(source) end + +---Returns the duration at which timeline events will be highlighted for imminency. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventHighlightTime) +---@return DurationSeconds highlightTime +function C_EncounterTimeline.GetEventHighlightTime() end + +---Returns information about a timeline event. This data is generally expected to be static for the lifetime of an event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventInfo) +---@param eventID EncounterTimelineEventID +---@return EncounterTimelineEventInfo info +function C_EncounterTimeline.GetEventInfo(eventID) end + +---Returns an unsorted list of event IDs present in the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventList) +---@return EncounterTimelineEventID[] events +function C_EncounterTimeline.GetEventList() end + +---Returns the current state of a timeline event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventState) +---@param eventID EncounterTimelineEventID +---@return Enum.EncounterTimelineEventState state +function C_EncounterTimeline.GetEventState(eventID) end + +---Returns the elapsed duration of a timeline event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventTimeElapsed) +---@param eventID EncounterTimelineEventID +---@return DurationSeconds timeElapsed +function C_EncounterTimeline.GetEventTimeElapsed(eventID) end + +---Returns the remaining duration of a timeline event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventTimeRemaining) +---@param eventID EncounterTimelineEventID +---@return DurationSeconds timeRemaining +function C_EncounterTimeline.GetEventTimeRemaining(eventID) end + +---Returns a Duration object that tracks the elapsed duration of a timeline event. This object tracks the range [0, duration] of the event and automatically pauses its progression based on event state. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventTimer) +---@param eventID EncounterTimelineEventID +---@return LuaDurationObject? duration +function C_EncounterTimeline.GetEventTimer(eventID) end + +---Returns information about the position of an event on the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetEventTrack) +---@param eventID EncounterTimelineEventID +---@return Enum.EncounterTimelineTrack track +---@return number? trackSortIndex +function C_EncounterTimeline.GetEventTrack(eventID) end + +---Returns a sorted list of event IDs present in the timeline from shortest to longest remaining durations, meeting the requirements of the specified filters. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetSortedEventList) +---@param maxEventCount? number +---@param maxEventDuration? DurationSeconds +---@param excludeTerminalStates? boolean Default = true +---@param excludeHiddenEvents? boolean Default = true +---@return EncounterTimelineEventID[] events +function C_EncounterTimeline.GetSortedEventList(maxEventCount, maxEventDuration, excludeTerminalStates, excludeHiddenEvents) end + +---Returns information for a single timeline track. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetTrackInfo) +---@param track Enum.EncounterTimelineTrack +---@return EncounterTimelineTrackInfo trackInfo +function C_EncounterTimeline.GetTrackInfo(track) end + +---Returns information about all timeline tracks. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetTrackList) +---@return EncounterTimelineTrackInfo[] tracks +function C_EncounterTimeline.GetTrackList() end + +---Returns the maximum permitted event duration on a single timeline track. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetTrackMaxEventDuration) +---@param track Enum.EncounterTimelineTrack +---@return DurationSeconds maxEventDuration +function C_EncounterTimeline.GetTrackMaxEventDuration(track) end + +---Returns the type of a single timeline track. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetTrackType) +---@param track Enum.EncounterTimelineTrack +---@return Enum.EncounterTimelineTrackType trackType +function C_EncounterTimeline.GetTrackType(track) end + +---Returns the current view type of the timeline. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.GetViewType) +---@return Enum.EncounterTimelineViewType viewType +function C_EncounterTimeline.GetViewType() end + +---Returns true if the timeline contains any events in the active state. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.HasActiveEvents) +---@return boolean hasActiveEvents +function C_EncounterTimeline.HasActiveEvents() end + +---Returns true if the timeline contains any events in any state. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.HasAnyEvents) +---@return boolean hasAnyEvents +function C_EncounterTimeline.HasAnyEvents() end + +---Returns true if the timeline contains any events in the paused state. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.HasPausedEvents) +---@return boolean hasPausedEvents +function C_EncounterTimeline.HasPausedEvents() end + +---Returns true if the timeline contains any events that are on visible tracks. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.HasVisibleEvents) +---@return boolean hasVisibleEvents +function C_EncounterTimeline.HasVisibleEvents() end + +---Returns true if the event is in a 'blocked' state, where the cast for this event may not occur due to encounter conditions not being met. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.IsEventBlocked) +---@param eventID EncounterTimelineEventID +---@return boolean blocked +function C_EncounterTimeline.IsEventBlocked(eventID) end + +---Returns true if the encounter timeline feature is available on this client. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.IsFeatureAvailable) +---@return boolean isAvailable +function C_EncounterTimeline.IsFeatureAvailable() end + +---Returns true if the encounter timeline feature has been enabled by the player. This function will always return false if the feature is not available. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.IsFeatureEnabled) +---@return boolean isAvailableAndEnabled +function C_EncounterTimeline.IsFeatureEnabled() end + +---Pauses a custom timeline event, hiding it from the timeline. A paused event can later be resumed to show it again, or canceled. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.PauseScriptEvent) +---@param eventID EncounterTimelineEventID +function C_EncounterTimeline.PauseScriptEvent(eventID) end + +---Resumes a custom timeline event, showing it on the timeline again if it is currently paused. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.ResumeScriptEvent) +---@param eventID EncounterTimelineEventID +function C_EncounterTimeline.ResumeScriptEvent(eventID) end + +---Updates a given vector of texture objects to reference art assets for icons associated with an event. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.SetEventIconTextures) +---@param eventID EncounterTimelineEventID +---@param includeIcons Enum.EncounterEventIconmask +---@param textures SimpleTexture[] +function C_EncounterTimeline.SetEventIconTextures(eventID, includeIcons, textures) end + +---Changes the view type for the timeline. This adjusts track layouts to be more appropriate for a specific mode and optimizes event processing. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterTimeline.SetViewType) +---@param viewType Enum.EncounterTimelineViewType +function C_EncounterTimeline.SetViewType(viewType) end + +---@class EncounterTimelineEventFilter +---@field maxEventCount number? +---@field maxEventDuration DurationSeconds? +---@field excludeTerminalStates boolean? Default = true +---@field excludeHiddenEvents boolean? Default = true + +---@class EncounterTimelineEventInfo +---@field id EncounterTimelineEventID +---@field source Enum.EncounterTimelineEventSource +---@field spellName string +---@field spellID number +---@field iconFileID fileID +---@field duration DurationSeconds +---@field maxQueueDuration DurationSeconds +---@field icons Enum.EncounterEventIconmask +---@field severity Enum.EncounterEventSeverity +---@field color colorRGB +---@field isApproximate boolean + +---@class EncounterTimelineScriptEventRequest +---@field spellID number +---@field iconFileID fileID +---@field duration DurationSeconds +---@field maxQueueDuration DurationSeconds? Default = 0 +---@field overrideName stringView? Default = +---@field icons Enum.EncounterEventIconmask? +---@field severity Enum.EncounterEventSeverity? Default = Medium +---@field paused boolean? Default = false + +---@class EncounterTimelineTrackInfo +---@field id Enum.EncounterTimelineTrack +---@field type Enum.EncounterTimelineTrackType +---@field minimumDuration DurationSeconds? +---@field maximumDuration DurationSeconds? +---@field minimumEventIntroDuration DurationSeconds? +---@field minimumEventGapDuration DurationSeconds? +---@field maximumEventCount number? +---@field sortDirection Enum.EncounterTimelineEventSortDirection? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua new file mode 100644 index 0000000..4732e18 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua @@ -0,0 +1,70 @@ +---@meta _ +C_EncounterWarnings = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.GetColorForSeverity) +---@param severity Enum.EncounterEventSeverity +---@return colorRGB color +function C_EncounterWarnings.GetColorForSeverity(severity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.GetEditModeWarningInfo) +---@param severity Enum.EncounterEventSeverity +---@return EncounterWarningInfo warningInfo +function C_EncounterWarnings.GetEditModeWarningInfo(severity) end + +---Returns true if custom sound alerts are allowed to play for hidden warning messages. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.GetPlayCustomSoundsWhenHidden) +---@return boolean play +function C_EncounterWarnings.GetPlayCustomSoundsWhenHidden() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.GetSoundKitForSeverity) +---@param severity Enum.EncounterEventSeverity +---@return number soundKitID +function C_EncounterWarnings.GetSoundKitForSeverity(severity) end + +---Returns true if text messages for encounter events are allowed to be shown. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.GetWarningsShown) +---@return boolean shown +function C_EncounterWarnings.GetWarningsShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.IsFeatureAvailable) +---@return boolean isAvailable +function C_EncounterWarnings.IsFeatureAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.IsFeatureEnabled) +---@return boolean isAvailableAndEnabled +function C_EncounterWarnings.IsFeatureEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.PlaySound) +---@param severity Enum.EncounterEventSeverity +---@return number soundHandle +function C_EncounterWarnings.PlaySound(severity) end + +---Controls whether custom sound alerts for encounter events are allowed to play for warning messages that are hidden. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.SetPlayCustomSoundsWhenHidden) +---@param play boolean +function C_EncounterWarnings.SetPlayCustomSoundsWhenHidden(play) end + +---Controls whether text messages for encounter events are allowed to be shown. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EncounterWarnings.SetWarningsShown) +---@param shown boolean +function C_EncounterWarnings.SetWarningsShown(shown) end + +---@class EncounterWarningInfo +---@field text string +---@field casterGUID WOWGUID +---@field casterName string +---@field targetGUID WOWGUID +---@field targetName string +---@field iconFileID number +---@field tooltipSpellID number +---@field isDeadly boolean +---@field color colorRGB +---@field duration DurationSeconds +---@field severity Enum.EncounterEventSeverity +---@field shouldPlaySound boolean +---@field shouldShowChatMessage boolean +---@field shouldShowWarning boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua new file mode 100644 index 0000000..0426930 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua @@ -0,0 +1,15 @@ +---@meta _ +C_EndOfMatchUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EndOfMatchUI.GetEndOfMatchDetails) +---@return MatchDetails? matchDetails +function C_EndOfMatchUI.GetEndOfMatchDetails() end + +---@class MatchDetail +---@field type Enum.MatchDetailType +---@field value number + +---@class MatchDetails +---@field matchType Enum.EndOfMatchType +---@field matchEnded boolean +---@field detailsList MatchDetail[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua new file mode 100644 index 0000000..0ab27e5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua @@ -0,0 +1,116 @@ +---@meta _ +C_EquipmentSet = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.AssignSpecToEquipmentSet) +---@param equipmentSetID number +---@param specIndex number +function C_EquipmentSet.AssignSpecToEquipmentSet(equipmentSetID, specIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.CanUseEquipmentSets) +---@return boolean canUseEquipmentSets +function C_EquipmentSet.CanUseEquipmentSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.ClearIgnoredSlotsForSave) +function C_EquipmentSet.ClearIgnoredSlotsForSave() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.CreateEquipmentSet) +---@param equipmentSetName string +---@param icon? string +function C_EquipmentSet.CreateEquipmentSet(equipmentSetName, icon) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.DeleteEquipmentSet) +---@param equipmentSetID number +function C_EquipmentSet.DeleteEquipmentSet(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.EquipmentSetContainsLockedItems) +---@param equipmentSetID number +---@return boolean hasLockedItems +function C_EquipmentSet.EquipmentSetContainsLockedItems(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetEquipmentSetAssignedSpec) +---@param equipmentSetID number +---@return number specIndex +function C_EquipmentSet.GetEquipmentSetAssignedSpec(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetEquipmentSetForSpec) +---@param specIndex number +---@return number equipmentSetID +function C_EquipmentSet.GetEquipmentSetForSpec(specIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetEquipmentSetID) +---@param equipmentSetName string +---@return number equipmentSetID +function C_EquipmentSet.GetEquipmentSetID(equipmentSetName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetEquipmentSetIDs) +---@return number[] equipmentSetIDs +function C_EquipmentSet.GetEquipmentSetIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetEquipmentSetInfo) +---@param equipmentSetID number +---@return string name +---@return number iconFileID +---@return number setID +---@return boolean isEquipped +---@return number numItems +---@return number numEquipped +---@return number numInInventory +---@return number numLost +---@return number numIgnored +function C_EquipmentSet.GetEquipmentSetInfo(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetIgnoredSlots) +---@param equipmentSetID number +---@return boolean[] slotIgnored +function C_EquipmentSet.GetIgnoredSlots(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetItemIDs) +---@param equipmentSetID number +---@return number[] itemIDs +function C_EquipmentSet.GetItemIDs(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetItemLocations) +---@param equipmentSetID number +---@return number[] locations +function C_EquipmentSet.GetItemLocations(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.GetNumEquipmentSets) +---@return number numEquipmentSets +function C_EquipmentSet.GetNumEquipmentSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.IgnoreSlotForSave) +---@param slot number +function C_EquipmentSet.IgnoreSlotForSave(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.IsSlotIgnoredForSave) +---@param slot number +---@return boolean isSlotIgnored +function C_EquipmentSet.IsSlotIgnoredForSave(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.ModifyEquipmentSet) +---@param equipmentSetID number +---@param newName string +---@param newIcon? string +function C_EquipmentSet.ModifyEquipmentSet(equipmentSetID, newName, newIcon) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.PickupEquipmentSet) +---@param equipmentSetID number +function C_EquipmentSet.PickupEquipmentSet(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.SaveEquipmentSet) +---@param equipmentSetID number +---@param icon? string +function C_EquipmentSet.SaveEquipmentSet(equipmentSetID, icon) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.UnassignEquipmentSetSpec) +---@param equipmentSetID number +function C_EquipmentSet.UnassignEquipmentSetSpec(equipmentSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.UnignoreSlotForSave) +---@param slot number +function C_EquipmentSet.UnignoreSlotForSave(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EquipmentSet.UseEquipmentSet) +---@param equipmentSetID number +---@return boolean setWasEquipped +function C_EquipmentSet.UseEquipmentSet(equipmentSetID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua new file mode 100644 index 0000000..9dcf132 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua @@ -0,0 +1,91 @@ +---@meta _ +C_EventScheduler = {} + +---Returns true if there are any events eligible to show for the player. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.CanShowEvents) +---@return boolean canShow +function C_EventScheduler.CanShowEvents() end + +---Clears reminder on a scheduled event. Must use endTime to identify which specific instance in the case of repeating ones. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.ClearReminder) +---@param eventKey string +function C_EventScheduler.ClearReminder(eventKey) end + +---Returns the name of the continent with current events +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.GetActiveContinentName) +---@return string name +function C_EventScheduler.GetActiveContinentName() end + +---Will try to figure out a UiMap for an areaPOI. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.GetEventUiMapID) +---@param areaPoiID number +---@return number? uiMapID +function C_EventScheduler.GetEventUiMapID(areaPoiID) end + +---Will try to figure out a map zone name for an areaPOI +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.GetEventZoneName) +---@param areaPoiID number +---@return string? name +function C_EventScheduler.GetEventZoneName(areaPoiID) end + +---Will request data from the server on a throttle +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.GetOngoingEvents) +---@return OngoingEventInfo[] events +function C_EventScheduler.GetOngoingEvents() end + +---Will request data from the server on a throttle +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.GetScheduledEvents) +---@return ScheduledEventInfo[] events +function C_EventScheduler.GetScheduledEvents() end + +---True if the server sent a list, even if the list had 0 events. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.HasData) +---@return boolean hasData +function C_EventScheduler.HasData() end + +---Returns whether there are any event reminders saved. Can include reminders that have expired since set and haven't gotten removed yet. Has to be called after cvars are loaded. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.HasSavedReminders) +---@return boolean hasSavedReminders +function C_EventScheduler.HasSavedReminders() end + +---Requests events from the server, subject to throttle +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.RequestEvents) +function C_EventScheduler.RequestEvents() end + +---Sets reminder on a scheduled event. Must use endTime to identify which specific instance in the case of repeating ones. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventScheduler.SetReminder) +---@param eventKey string +function C_EventScheduler.SetReminder(eventKey) end + +---@class EventDisplayInfo +---@field hideTimeLeft boolean? Default = false +---@field hideDescription boolean? Default = false +---@field overrideAtlas textureAtlas? +---@field overrideTooltipWidgetSetID number? + +---@class OngoingEventInfo +---@field areaPoiID number +---@field rewardsClaimed boolean? Default = false +---@field displayInfo EventDisplayInfo + +---@class ScheduledEventInfo +---@field eventKey string +---@field eventID number +---@field areaPoiID number +---@field startTime time_t +---@field endTime time_t +---@field duration time_t +---@field hasReminder boolean? Default = false +---@field rewardsClaimed boolean? Default = false +---@field displayInfo EventDisplayInfo diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua new file mode 100644 index 0000000..6201100 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua @@ -0,0 +1,12 @@ +---@meta _ +C_EventUtils = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventUtils.IsCallbackEvent) +---@param eventName stringView +---@return boolean isCallbackEvent +function C_EventUtils.IsCallbackEvent(eventName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventUtils.IsEventValid) +---@param eventName stringView +---@return boolean valid +function C_EventUtils.IsEventValid(eventName) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua new file mode 100644 index 0000000..37b54b0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua @@ -0,0 +1,114 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanUpgradeToCurrentExpansion) +---@return boolean canUpgradeExpansion +function CanUpgradeToCurrentExpansion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DoesCurrentLocaleSellExpansionLevels) +---@return boolean regionSellsExpansions +function DoesCurrentLocaleSellExpansionLevels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAccountExpansionLevel) +---@return number expansionLevel +function GetAccountExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetClientDisplayExpansionLevel) +---@return number expansionLevel +function GetClientDisplayExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentRegionName) +---@return string regionName +function GetCurrentRegionName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetExpansionDisplayInfo) +---@param expansionLevel number +---@param desiredReleaseType? Enum.ReleaseType +---@return ExpansionDisplayInfo? info +function GetExpansionDisplayInfo(expansionLevel, desiredReleaseType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetExpansionForLevel) +---@param playerLevel number +---@return number expansionLevel +function GetExpansionForLevel(playerLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetExpansionLevel) +---@return number expansionLevel +function GetExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetExpansionTrialInfo) +---@return boolean isExpansionTrialAccount +---@return time_t? expansionTrialRemainingSeconds +function GetExpansionTrialInfo() end + +---Maps an expansion level to a maximum character level for that expansion. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxLevelForExpansionLevel) +---@param expansionLevel number +---@return number maxLevel +function GetMaxLevelForExpansionLevel(expansionLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxLevelForLatestExpansion) +---@return number maxLevel +function GetMaxLevelForLatestExpansion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxLevelForPlayerExpansion) +---@return number maxLevel +function GetMaxLevelForPlayerExpansion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaximumExpansionLevel) +---@return number expansionLevel +function GetMaximumExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMinimumExpansionLevel) +---@return number expansionLevel +function GetMinimumExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumExpansions) +---@return number numExpansions +function GetNumExpansions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetServerExpansionLevel) +---@return number serverExpansionLevel +function GetServerExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUpgradeExpansionLevel) +---@return number upgradeExpansionLevel +function GetUpgradeExpansionLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsDemonHunterAvailable) +---@return boolean available +function IsDemonHunterAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsExpansionTrial) +---@return boolean isExpansionTrialAccount +function IsExpansionTrial() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsTrialAccount) +---@return boolean isTrialAccount +function IsTrialAccount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsVeteranTrialAccount) +---@return boolean isVeteranTrialAccount +function IsVeteranTrialAccount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SendSubscriptionInterstitialResponse) +---@param response Enum.SubscriptionInterstitialResponseType +function SendSubscriptionInterstitialResponse(response) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShouldShowExpansionUpgradeBanner) +---@return boolean showUpgradeBanner +function ShouldShowExpansionUpgradeBanner() end + +---@class ExpansionDisplayInfo +---@field logo fileID +---@field banner textureAtlas +---@field features ExpansionDisplayInfoFeature[] +---@field highResBackgroundID fileID +---@field lowResBackgroundID fileID +---@field textureKit textureKit +---@field glueAmbianceSoundKit number? +---@field glueMusicSoundKit number? +---@field glueCreditsSoundKit number? + +---@class ExpansionDisplayInfoFeature +---@field icon fileID +---@field text string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua new file mode 100644 index 0000000..2483285 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua @@ -0,0 +1,14 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClassicExpansionAtLeast) +---@param expansionLevel number +---@return boolean isAtLeast +function ClassicExpansionAtLeast(expansionLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClassicExpansionAtMost) +---@param expansionLevel number +---@return boolean isAtMost +function ClassicExpansionAtMost(expansionLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetClassicExpansionLevel) +---@return number expansionLevel +function GetClassicExpansionLevel() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua new file mode 100644 index 0000000..94a4b5d --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +C_ExpansionTrial = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ExpansionTrial.OnTrialLevelUpDialogClicked) +function C_ExpansionTrial.OnTrialLevelUpDialogClicked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ExpansionTrial.OnTrialLevelUpDialogShown) +function C_ExpansionTrial.OnTrialLevelUpDialogShown() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua new file mode 100644 index 0000000..7065213 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +C_ExternalEventURL = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ExternalEventURL.HasURL) +---@return boolean hasURL +function C_ExternalEventURL.HasURL() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ExternalEventURL.IsNew) +---@return boolean isNew +function C_ExternalEventURL.IsNew() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ExternalEventURL.LaunchURL) +function C_ExternalEventURL.LaunchURL() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua new file mode 100644 index 0000000..905326a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua @@ -0,0 +1,18 @@ +---@meta _ +C_FogOfWar = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FogOfWar.GetFogOfWarForMap) +---@param uiMapID number +---@return number? fogOfWarID +function C_FogOfWar.GetFogOfWarForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FogOfWar.GetFogOfWarInfo) +---@param fogOfWarID number +---@return FogOfWarInfo? fogOfWarInfo +function C_FogOfWar.GetFogOfWarInfo(fogOfWarID) end + +---@class FogOfWarInfo +---@field fogOfWarID number +---@field backgroundAtlas textureAtlas +---@field maskAtlas textureAtlas +---@field maskScalar number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FontDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FontDocumentation.lua new file mode 100644 index 0000000..427776a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FontDocumentation.lua @@ -0,0 +1,34 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateFontFamily) +---@param name string +---@param members CreateFontFamilyMemberInfo[] +---@return SimpleFont fontFamily +function CreateFontFamily(name, members) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFontInfo) +---@param fontObject SimpleFont +---@return FontScriptInfo? info +function GetFontInfo(fontObject) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFonts) +---@return string[] fontNames +function GetFonts() end + +---@class CreateFontFamilyMemberInfo +---@field alphabet FontAlphabet +---@field file string +---@field height uiFontHeight +---@field flags TBFFlags + +---@class FontScriptInfo +---@field color colorRGBA +---@field height number +---@field outline string +---@field shadow FontScriptShadowInfo? +---@field fontObject SimpleFont +---@field canBeUserScaled boolean + +---@class FontScriptShadowInfo +---@field color colorRGBA +---@field x number +---@field y number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua new file mode 100644 index 0000000..6516568 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua @@ -0,0 +1,203 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AddSourceLocationExclude) +---@param fileName string +function AddSourceLocationExclude(fileName) end + +---Returns true if the immediate calling function has appropriate permissions to access and operate on all supplied values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_canaccessallvalues) +---@param ... LuaValueReference values +---@return boolean canAccessAllValues +function canaccessallvalues(...) end + +---Returns true if the immediate calling function has appropriate permissions to access or operate on secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_canaccesssecrets) +---@return boolean canAccessSecrets +function canaccesssecrets() end + +---Returns true if the immediate calling function has appropriate permissions to index secret tables. This will return false if the caller cannot access the table value itself, or if access to the table contents is disallowed by taint. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_canaccesstable) +---@param table LuaValueReference +---@return boolean canAccessTable +function canaccesstable(table) end + +---Returns true if the immediate calling function has appropriate permissions to access and operate on a specific value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_canaccessvalue) +---@param value LuaValueReference +---@return boolean canAccessValue +function canaccessvalue(value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateFromMixins) +---@param ... LuaValueVariant mixins +---@return LuaValueVariant object +function CreateFromMixins(...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateSecureDelegate) +---@param luaFunction LuaValueReference +---@return LuaValueReference secureDelegateFunction +function CreateSecureDelegate(luaFunction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateWindow) +---@param popupStyle? boolean Default = true +---@param topMost? boolean Default = false +---@return SimpleWindow? window +function CreateWindow(popupStyle, topMost) end + +---Removes the ability for the immediate calling function to access secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_dropsecretaccess) +function dropsecretaccess() end + +---Invokes the '__dump' metamethod on any value (if present), returning its result. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_dumpobject) +---@param value? LuaValueReference +---@return LuaValueReference? result +function dumpobject(value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCallstackHeight) +---@return number height +function GetCallstackHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentEventID) +---@return number? eventID +function GetCurrentEventID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetErrorCallstackHeight) +---@return number? height +function GetErrorCallstackHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetEventTime) +---@param eventProfileIndex number +---@return number totalElapsedTime +---@return number numExecutedHandlers +---@return string slowestHandlerName +---@return number slowestHandlerTime +function GetEventTime(eventProfileIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSourceLocation) +---@return string location +function GetSourceLocation() end + +---Returns true if a supplied value is a secret value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_hasanysecretvalues) +---@param ... LuaValueReference values +---@return boolean isAnyValueSecret +function hasanysecretvalues(...) end + +---Returns true if a supplied value is a secret table. This function will return true if the table value itself is secret, or if flags on the table are set such that accesses of the table would produce secrets. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_issecrettable) +---@param table LuaValueReference +---@return boolean isSecretOrContentsSecret +function issecrettable(table) end + +---Returns true if a supplied value is a secret value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_issecretvalue) +---@param value LuaValueReference +---@return boolean isSecret +function issecretvalue(value) end + +---Applies a given function over all supplied values individually, replacing the value with the result of the call. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_mapvalues) +---@param func LuaValueReference +---@param ... LuaValueReference values +---@return LuaValueReference ... mapped +function mapvalues(func, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Mixin) +---@param object LuaValueVariant +---@param ... LuaValueVariant mixins +---@return LuaValueVariant outObject +function Mixin(object, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RegisterEventCallback) +---@param eventName string +---@param callback EventCallbackType +function RegisterEventCallback(eventName, callback) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RegisterUnitEventCallback) +---@param eventName string +---@param callback EventCallbackType +---@param unit UnitToken +function RegisterUnitEventCallback(eventName, callback, unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RunScript) +---@param text string +function RunScript(text) end + +---Returns a transformed list of values with inputs that are secret values replaced by nil values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_scrubsecretvalues) +---@param ... LuaValueReference values +---@return LuaValueReference ... scrubbed +function scrubsecretvalues(...) end + +---Returns a transformed list of values with inputs that are either secret or are not string, number, or boolean type replaced by nil values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_scrub) +---@param ... LuaValueReference values +---@return LuaValueReference ... scrubbed +function scrub(...) end + +---Unwraps all supplied secrets, converting them back to regular values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_secretunwrap) +---@param ... LuaValueReference values +---@return LuaValueReference ... unwrapped +function secretunwrap(...) end + +---Converts all supplied values to secret values, preventing most operations on them from occurring on tainted code paths. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_secretwrap) +---@param ... LuaValueReference values +---@return LuaValueReference ... wrapped +function secretwrap(...) end + +---Invokes a named method on an object with a secure call barrier that prevents errors or taint from function lookup and execution from propagating to the caller. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_securecallmethod) +---@param object LuaValueReference +---@param method string +---@param ... LuaValueReference arguments +---@return LuaValueReference ... results +function securecallmethod(object, method, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetErrorCallstackHeight) +---@param height? number +function SetErrorCallstackHeight(height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetTableSecurityOption) +---@param table LuaValueVariant +---@param option Enum.TableSecurityOption +function SetTableSecurityOption(table, option) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnregisterEventCallback) +---@param eventName string +---@param callback EventCallbackType +function UnregisterEventCallback(eventName, callback) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnregisterUnitEventCallback) +---@param eventName string +---@param callback EventCallbackType +---@param unit UnitToken +function UnregisterUnitEventCallback(eventName, callback, unit) end + +---Starts a timer for profiling. The final time can be obtained by calling debugprofilestop. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_debugprofilestart) +function debugprofilestart() end + +---Returns the time in milliseconds since the last debugprofilestart call. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_debugprofilestop) +---@return number elapsedMilliseconds +function debugprofilestop() end + +---@alias EventCallbackType FunctionContainer|fun() diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua new file mode 100644 index 0000000..c3cf52d --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua @@ -0,0 +1,162 @@ +---@meta _ +C_FriendList = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.AddFriend) +---@param name string +---@param notes? string +function C_FriendList.AddFriend(name, notes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.AddIgnore) +---@param name string +---@return boolean added +function C_FriendList.AddIgnore(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.AddOrDelIgnore) +---@param name string +function C_FriendList.AddOrDelIgnore(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.AddOrRemoveFriend) +---@param name string +---@param notes string +function C_FriendList.AddOrRemoveFriend(name, notes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.DelIgnore) +---@param name string +---@return boolean removed +function C_FriendList.DelIgnore(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.DelIgnoreByIndex) +---@param index number +function C_FriendList.DelIgnoreByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetFriendInfo) +---@param name string +---@return FriendInfo info +function C_FriendList.GetFriendInfo(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetFriendInfoByIndex) +---@param index number +---@return FriendInfo info +function C_FriendList.GetFriendInfoByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetIgnoreName) +---@param index number +---@return string? name +function C_FriendList.GetIgnoreName(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetNumFriends) +---@return number numFriends +function C_FriendList.GetNumFriends() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetNumIgnores) +---@return number numIgnores +function C_FriendList.GetNumIgnores() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetNumOnlineFriends) +---@return number numOnline +function C_FriendList.GetNumOnlineFriends() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetNumWhoResults) +---@return number numWhos +---@return number totalNumWhos +function C_FriendList.GetNumWhoResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetSelectedFriend) +---@return number? index +function C_FriendList.GetSelectedFriend() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetSelectedIgnore) +---@return number? index +function C_FriendList.GetSelectedIgnore() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.GetWhoInfo) +---@param index number +---@return WhoInfo info +function C_FriendList.GetWhoInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.IsFriend) +---@param guid WOWGUID +---@return boolean isFriend +function C_FriendList.IsFriend(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.IsIgnored) +---@param token string +---@return boolean isIgnored +function C_FriendList.IsIgnored(token) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.IsIgnoredByGuid) +---@param guid WOWGUID +---@return boolean isIgnored +function C_FriendList.IsIgnoredByGuid(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.IsOnIgnoredList) +---@param token string +---@return boolean isIgnored +function C_FriendList.IsOnIgnoredList(token) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.RemoveFriend) +---@param name string +---@return boolean removed +function C_FriendList.RemoveFriend(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.RemoveFriendByIndex) +---@param index number +function C_FriendList.RemoveFriendByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SendWho) +---@param filter string +---@param origin? number +function C_FriendList.SendWho(filter, origin) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SetFriendNotes) +---@param name string +---@param notes string +---@return boolean found +function C_FriendList.SetFriendNotes(name, notes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SetFriendNotesByIndex) +---@param index number +---@param notes string +function C_FriendList.SetFriendNotesByIndex(index, notes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SetSelectedFriend) +---@param index number +function C_FriendList.SetSelectedFriend(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SetSelectedIgnore) +---@param index number +function C_FriendList.SetSelectedIgnore(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SetWhoToUi) +---@param whoToUi boolean +function C_FriendList.SetWhoToUi(whoToUi) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.ShowFriends) +function C_FriendList.ShowFriends() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FriendList.SortWho) +---@param sorting string +function C_FriendList.SortWho(sorting) end + +---@class FriendInfo +---@field connected boolean +---@field name string +---@field className string? +---@field area string? +---@field notes string? +---@field guid WOWGUID +---@field level number +---@field dnd boolean +---@field afk boolean +---@field rafLinkType Enum.RafLinkType + +---@class WhoInfo +---@field fullName string +---@field fullGuildName string +---@field level number +---@field raceStr string +---@field classStr string +---@field area string +---@field filename string? +---@field gender number +---@field timerunningSeasonID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua new file mode 100644 index 0000000..71505ea --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua @@ -0,0 +1,72 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearCursor) +function ClearCursor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearCursorHoveredItem) +function ClearCursorHoveredItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CursorHasItem) +---@return boolean result +function CursorHasItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CursorHasMacro) +---@return boolean result +function CursorHasMacro() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CursorHasMoney) +---@return boolean result +function CursorHasMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CursorHasSpell) +---@return boolean result +function CursorHasSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeleteCursorItem) +function DeleteCursorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DropCursorMoney) +function DropCursorMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EquipCursorItem) +---@param slot number +function EquipCursorItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCursorInfo) +function GetCursorInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCursorMoney) +---@return number amount +function GetCursorMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupPlayerMoney) +---@param amount WOWMONEY +function PickupPlayerMoney(amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetCursor) +function ResetCursor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SellCursorItem) +function SellCursorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCursor) +---@param name? string +---@return boolean result +function SetCursor(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCursorByMode) +---@param mode Enum.Cursormode +---@return boolean result +function SetCursorByMode(mode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCursorHoveredItem) +---@param item ItemLocation +function SetCursorHoveredItem(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCursorHoveredItemTradeItem) +---@param enabled boolean +function SetCursorHoveredItemTradeItem(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCursorVirtualItem) +---@param itemInfo ItemInfo +---@param cursorType Enum.UICursorType +function SetCursorVirtualItem(itemInfo, cursorType) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua new file mode 100644 index 0000000..5fc48ed --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGameMessageInfo) +---@param gameErrorIndex number +---@return string errorName +---@return number? soundKitID +---@return number? voiceID +function GetGameMessageInfo(gameErrorIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_NotWhileDeadError) +function NotWhileDeadError() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua new file mode 100644 index 0000000..438b3a3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua @@ -0,0 +1,172 @@ +---@meta _ +C_GamePad = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.AddSDLMapping) +---@param platform Enum.ClientPlatformType +---@param mapping string +---@return boolean success +function C_GamePad.AddSDLMapping(platform, mapping) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.ApplyConfigs) +function C_GamePad.ApplyConfigs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.AxisIndexToConfigName) +---@param axisIndex number +---@return string? configName +function C_GamePad.AxisIndexToConfigName(axisIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.ButtonBindingToIndex) +---@param bindingName string +---@return number? buttonIndex +function C_GamePad.ButtonBindingToIndex(bindingName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.ButtonIndexToBinding) +---@param buttonIndex number +---@return string? bindingName +function C_GamePad.ButtonIndexToBinding(buttonIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.ButtonIndexToConfigName) +---@param buttonIndex number +---@return string? configName +function C_GamePad.ButtonIndexToConfigName(buttonIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.ClearLedColor) +function C_GamePad.ClearLedColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.DeleteConfig) +---@param configID GamePadConfigID +function C_GamePad.DeleteConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetActiveDeviceID) +---@return number deviceID +function C_GamePad.GetActiveDeviceID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetAllConfigIDs) +---@return GamePadConfigID[] configIDs +function C_GamePad.GetAllConfigIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetAllDeviceIDs) +---@return number[] deviceIDs +function C_GamePad.GetAllDeviceIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetCombinedDeviceID) +---@return number deviceID +function C_GamePad.GetCombinedDeviceID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetConfig) +---@param configID GamePadConfigID +---@return GamePadConfig? config +function C_GamePad.GetConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetDeviceMappedState) +---@param deviceID? number +---@return GamePadMappedState? state +function C_GamePad.GetDeviceMappedState(deviceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetDeviceRawState) +---@param deviceID number +---@return GamePadRawState? rawState +function C_GamePad.GetDeviceRawState(deviceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetLedColor) +---@return colorRGB color +function C_GamePad.GetLedColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.GetPowerLevel) +---@param deviceID? number +---@return Enum.GamePadPowerLevel powerLevel +function C_GamePad.GetPowerLevel(deviceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.IsEnabled) +---@return boolean enabled +function C_GamePad.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.SetConfig) +---@param config GamePadConfig +function C_GamePad.SetConfig(config) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.SetLedColor) +---@param color colorRGB +function C_GamePad.SetLedColor(color) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.SetVibration) +---@param vibrationType string +---@param intensity number +function C_GamePad.SetVibration(vibrationType, intensity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.StickIndexToConfigName) +---@param stickIndex number +---@return string? configName +function C_GamePad.StickIndexToConfigName(stickIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GamePad.StopVibration) +function C_GamePad.StopVibration() end + +---@class GamePadAxisConfig +---@field axis string +---@field shift number? +---@field scale number? +---@field deadzone number? +---@field buttonThreshold number? +---@field buttonPos string? +---@field buttonNeg string? +---@field comment string? + +---@class GamePadConfig +---@field comment string? +---@field name string? +---@field configID GamePadConfigID +---@field labelStyle string? +---@field rawButtonMappings GamePadRawButtonMapping[] +---@field rawAxisMappings GamePadRawAxisMapping[] +---@field axisConfigs GamePadAxisConfig[] +---@field stickConfigs GamePadStickConfig[] + +---@class GamePadConfigID +---@field vendorID number? +---@field productID number? + +---@class GamePadMappedState +---@field name string +---@field labelStyle string +---@field buttonCount number +---@field axisCount number +---@field stickCount number +---@field buttons boolean[] +---@field axes number[] +---@field sticks GamePadStick[] + +---@class GamePadRawAxisMapping +---@field rawIndex number +---@field axis string? +---@field comment string? + +---@class GamePadRawButtonMapping +---@field rawIndex number +---@field button string? +---@field axis string? +---@field axisValue number? +---@field comment string? + +---@class GamePadRawState +---@field name string +---@field vendorID number +---@field productID number +---@field rawButtonCount number +---@field rawAxisCount number +---@field rawButtons boolean[] +---@field rawAxes number[] + +---@class GamePadStick +---@field x number +---@field y number +---@field len number + +---@class GamePadStickConfig +---@field stick string +---@field axisX string? +---@field axisY string? +---@field deadzone number? +---@field deadzoneX number? +---@field deadzoneY number? +---@field comment string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua new file mode 100644 index 0000000..647ab28 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua @@ -0,0 +1,115 @@ +---@meta _ +C_GameRules = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.AutoConnectToGameModeRealm) +---@param gameModeRecordID number +function C_GameRules.AutoConnectToGameModeRealm(gameModeRecordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.DoesGameModeHavePromo) +---@param gameModeRecordID number +---@return boolean hasPromo +function C_GameRules.DoesGameModeHavePromo(gameModeRecordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetActiveGameMode) +---@return Enum.GameMode gameMode +function C_GameRules.GetActiveGameMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetCurrentEventRealmQueues) +---@return Enum.EventRealmQueues eventRealmQueues +function C_GameRules.GetCurrentEventRealmQueues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetCurrentGameModeDisplayInfo) +---@return GameModeDisplayInfo? info +function C_GameRules.GetCurrentGameModeDisplayInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetCurrentGameModeRecordID) +---@return number gameModeRecordID +function C_GameRules.GetCurrentGameModeRecordID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetDisplayedGameModeRecordIDAtIndex) +---@param displayIndex number +---@return number gameModeRecordID +function C_GameRules.GetDisplayedGameModeRecordIDAtIndex(displayIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetGameModeDisplayInfoByRecordID) +---@param gameModeRecordID number +---@return GameModeDisplayInfo? info +function C_GameRules.GetGameModeDisplayInfoByRecordID(gameModeRecordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetGameModeGlueScreenName) +---@return string screenName +function C_GameRules.GetGameModeGlueScreenName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetGameModePromoGlobalString) +---@param gameModeRecordID number +---@return string promoGlobalString +function C_GameRules.GetGameModePromoGlobalString(gameModeRecordID) end + +---Returns the numeric value specified in the Game Rule, multiplied by 0.1 for every decimal place requested +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetGameRuleAsFloat) +---@param gameRule Enum.GameRule +---@param decimalPlaces? number Default = 0 +---@return number value +function C_GameRules.GetGameRuleAsFloat(gameRule, decimalPlaces) end + +---Returns the value specified in the Game Rule converted to a frame strata +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetGameRuleAsFrameStrata) +---@param gameRule Enum.GameRule +---@return string frameStrata +function C_GameRules.GetGameRuleAsFrameStrata(gameRule) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.GetNumDisplayedGameModes) +---@return number numDisplayedGameModes +function C_GameRules.GetNumDisplayedGameModes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsCharacterlessLoginActive) +---@return boolean active +function C_GameRules.IsCharacterlessLoginActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsClassAllowedForGameMode) +---@param classID number +---@return boolean valid +function C_GameRules.IsClassAllowedForGameMode(classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsGameModeEnabled) +---@param gameModeRecordID number +---@return boolean enabled +function C_GameRules.IsGameModeEnabled(gameModeRecordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsGameRuleActive) +---@param gameRule Enum.GameRule +---@return boolean isActive +function C_GameRules.IsGameRuleActive(gameRule) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsMultiActionBarVisibilityForced) +---@return boolean valid +function C_GameRules.IsMultiActionBarVisibilityForced() end + +---Checks the game rule as well as nameplateShowSelf +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsPersonalResourceDisplayEnabled) +---@return boolean isPersonalResourceDisplayEnabled +function C_GameRules.IsPersonalResourceDisplayEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsPlunderstorm) +---@return boolean active +function C_GameRules.IsPlunderstorm() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsStandard) +---@return boolean active +function C_GameRules.IsStandard() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GameRules.IsWoWHack) +---@return boolean active +function C_GameRules.IsWoWHack() end + +---@class GameModeDisplayInfo +---@field logo fileID +---@field logoHeight number +---@field logoVerticalOffset number +---@field logoShrunkenHeight number +---@field logoUsesDarkBackdrop boolean +---@field characterCreateExtraHeight number +---@field characterCreateOuterBorder fileID diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua new file mode 100644 index 0000000..1ef9311 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetInWorldUIVisibility) +---@param visible boolean +function SetInWorldUIVisibility(visible) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetUIVisibility) +---@param visible boolean +function SetUIVisibility(visible) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua new file mode 100644 index 0000000..01642ad --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua @@ -0,0 +1,398 @@ +---@meta _ +C_Garrison = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.AddFollowerToMission) +---@param missionID number +---@param followerID GarrisonFollower +---@param boardIndex? number +---@return boolean followerAdded +function C_Garrison.AddFollowerToMission(missionID, followerID, boardIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAutoCombatDamageClassValues) +---@return AutoCombatDamageClassString[] damageClassStrings +function C_Garrison.GetAutoCombatDamageClassValues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAutoMissionBoardState) +---@param missionID number +---@return AutoMissionTargetingInfo[] targetInfo +function C_Garrison.GetAutoMissionBoardState(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAutoMissionEnvironmentEffect) +---@param missionID number +---@return AutoMissionEnvironmentEffect? autoMissionEnvEffect +function C_Garrison.GetAutoMissionEnvironmentEffect(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAutoMissionTargetingInfo) +---@param missionID number +---@param followerID GarrisonFollower +---@param casterBoardIndex number +---@return AutoMissionTargetingInfo[] targetInfo +function C_Garrison.GetAutoMissionTargetingInfo(missionID, followerID, casterBoardIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAutoMissionTargetingInfoForSpell) +---@param missionID number +---@param autoCombatSpellID number +---@param casterBoardIndex number +---@return AutoMissionTargetingInfo[] targetInfo +function C_Garrison.GetAutoMissionTargetingInfoForSpell(missionID, autoCombatSpellID, casterBoardIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAutoTroops) +---@param followerType number +---@return AutoCombatTroopInfo[] autoTroopInfo +function C_Garrison.GetAutoTroops(followerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCombatLogSpellInfo) +---@param autoCombatSpellID number +---@return AutoCombatSpellInfo? spellInfo +function C_Garrison.GetCombatLogSpellInfo(autoCombatSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCurrentCypherEquipmentLevel) +---@return number equipmentLevel +function C_Garrison.GetCurrentCypherEquipmentLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID) +---@return number? currentGarrTalentTreeFriendshipFactionID +function C_Garrison.GetCurrentGarrTalentTreeFriendshipFactionID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCurrentGarrTalentTreeID) +---@return number? currentGarrTalentTreeID +function C_Garrison.GetCurrentGarrTalentTreeID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCyphersToNextEquipmentLevel) +---@return number? cyphersToNext +function C_Garrison.GetCyphersToNextEquipmentLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAutoCombatSpells) +---@param garrFollowerID GarrisonFollower +---@param followerLevel number +---@return AutoCombatSpellInfo[] autoCombatSpells +---@return AutoCombatSpellInfo? autoCombatAutoAttack +function C_Garrison.GetFollowerAutoCombatSpells(garrFollowerID, followerLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAutoCombatStats) +---@param garrFollowerID GarrisonFollower +---@return FollowerAutoCombatStatsInfo? autoCombatInfo +function C_Garrison.GetFollowerAutoCombatStats(garrFollowerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerMissionCompleteInfo) +---@param followerID GarrisonFollower +---@return FollowerMissionCompleteInfo followerMissionCompleteInfo +function C_Garrison.GetFollowerMissionCompleteInfo(followerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetGarrisonPlotsInstancesForMap) +---@param uiMapID number +---@return GarrisonPlotInstanceMapInfo[] garrisonPlotInstances +function C_Garrison.GetGarrisonPlotsInstancesForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetGarrisonTalentTreeCurrencyTypes) +---@param garrTalentTreeID number +---@return number? garrTalentTreeCurrencyType +function C_Garrison.GetGarrisonTalentTreeCurrencyTypes(garrTalentTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetGarrisonTalentTreeType) +---@param garrTalentTreeID number +---@return number garrTalentTreeType +function C_Garrison.GetGarrisonTalentTreeType(garrTalentTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMaxCypherEquipmentLevel) +---@return number maxEquipmentLevel +function C_Garrison.GetMaxCypherEquipmentLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionCompleteEncounters) +---@param missionID number +---@return GarrisonEnemyEncounterInfo[] encounters +function C_Garrison.GetMissionCompleteEncounters(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionDeploymentInfo) +---@param missionID number +---@return MissionDeploymentInfo missionDeploymentInfo +function C_Garrison.GetMissionDeploymentInfo(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionEncounterIconInfo) +---@param missionID number +---@return MissionEncounterIconInfo missionEncounterIconInfo +function C_Garrison.GetMissionEncounterIconInfo(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentInfo) +---@param talentID number +---@return GarrisonTalentInfo info +function C_Garrison.GetTalentInfo(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentPointsSpentInTalentTree) +---@param garrTalentTreeID number +---@return number talentPoints +function C_Garrison.GetTalentPointsSpentInTalentTree(garrTalentTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentTreeIDsByClassID) +---@param garrType number +---@param classID number +---@return number[] treeIDs +function C_Garrison.GetTalentTreeIDsByClassID(garrType, classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentTreeInfo) +---@param treeID number +---@return GarrisonTalentTreeInfo info +function C_Garrison.GetTalentTreeInfo(treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentTreeResetInfo) +---@param garrTalentTreeID number +---@return number goldCost +---@return GarrisonTalentCurrencyCostInfo[] currencyCosts +function C_Garrison.GetTalentTreeResetInfo(garrTalentTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentTreeTalentPointResearchInfo) +---@param garrTalentID number +---@param researchRank number +---@param garrTalentTreeID number +---@param talentPointIndex number +---@param isRespec boolean +---@return number goldCost +---@return GarrisonTalentCurrencyCostInfo[] currencyCosts +---@return number durationSecs +function C_Garrison.GetTalentTreeTalentPointResearchInfo(garrTalentID, researchRank, garrTalentTreeID, talentPointIndex, isRespec) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTalentUnlockWorldQuest) +---@param talentID number +---@return number worldQuestID +function C_Garrison.GetTalentUnlockWorldQuest(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.HasAdventures) +---@return boolean hasAdventures +function C_Garrison.HasAdventures() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsAtGarrisonMissionNPC) +---@return boolean atGarrisonMissionNPC +function C_Garrison.IsAtGarrisonMissionNPC() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsEnvironmentCountered) +---@param missionID number +---@return boolean environmentCountered +function C_Garrison.IsEnvironmentCountered(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsFollowerOnCompletedMission) +---@param followerID GarrisonFollower +---@return boolean followerOnCompletedMission +function C_Garrison.IsFollowerOnCompletedMission(followerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsLandingPageMinimapButtonVisible) +---@param garrType number +---@return boolean isLandingPageMinimapButtonVisible +function C_Garrison.IsLandingPageMinimapButtonVisible(garrType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsTalentConditionMet) +---@param talentID number +---@return boolean isMet +---@return string? failureString +function C_Garrison.IsTalentConditionMet(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RegenerateCombatLog) +---@param missionID number +---@return boolean success +function C_Garrison.RegenerateCombatLog(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RemoveFollowerFromMission) +---@param missionID number +---@param followerID GarrisonFollower +---@param boardIndex? number +function C_Garrison.RemoveFollowerFromMission(missionID, followerID, boardIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RushHealAllFollowers) +---@param followerType number +function C_Garrison.RushHealAllFollowers(followerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RushHealFollower) +---@param garrFollowerID GarrisonFollower +function C_Garrison.RushHealFollower(garrFollowerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetAutoCombatSpellFastForward) +---@param state boolean +function C_Garrison.SetAutoCombatSpellFastForward(state) end + +---@class AutoCombatDamageClassString +---@field damageClassValue number +---@field locString string + +---@class AutoCombatResult +---@field winner boolean +---@field combatLog AutoMissionRound[] + +---@class AutoCombatSpellInfo +---@field autoCombatSpellID number +---@field name string +---@field description string +---@field cooldown number +---@field duration number +---@field schoolMask number +---@field previewMask number +---@field icon fileID +---@field spellTutorialFlag number +---@field hasThornsEffect boolean + +---@class AutoCombatTroopInfo +---@field name string +---@field followerID GarrisonFollower +---@field garrFollowerID GarrisonFollower +---@field followerTypeID number +---@field displayIDs FollowerDisplayID[] +---@field level number +---@field quality number +---@field levelXP number +---@field maxXP number +---@field height number +---@field scale number +---@field displayScale number? +---@field displayHeight number? +---@field classSpec number? +---@field className string? +---@field flavorText string? +---@field classAtlas textureAtlas +---@field portraitIconID fileID +---@field textureKit textureKit +---@field isTroop boolean +---@field raceID number +---@field health number +---@field maxHealth number +---@field role number +---@field isAutoTroop boolean +---@field isSoulbind boolean +---@field isCollected boolean +---@field autoCombatStats FollowerAutoCombatStatsInfo + +---@class AutoMissionCombatEventInfo +---@field boardIndex number +---@field oldHealth number +---@field newHealth number +---@field maxHealth number +---@field points number? + +---@class AutoMissionEnvironmentEffect +---@field name string +---@field autoCombatSpellInfo AutoCombatSpellInfo + +---@class AutoMissionEvent +---@field type number +---@field spellID number +---@field schoolMask number +---@field effectIndex number +---@field casterBoardIndex number +---@field auraType number +---@field targetInfo AutoMissionCombatEventInfo[] + +---@class AutoMissionRound +---@field events AutoMissionEvent[] + +---@class AutoMissionTargetingInfo +---@field targetIndex number +---@field previewType number +---@field spellID number +---@field effectIndex number + +---@class FollowerAutoCombatStatsInfo +---@field currentHealth number +---@field maxHealth number +---@field attack number +---@field healingTimestamp time_t +---@field healCost number +---@field minutesHealingRemaining number + +---@class FollowerDisplayID +---@field id number +---@field followerPageScale number +---@field showWeapon boolean + +---@class FollowerMissionCompleteInfo +---@field name string +---@field displayIDs FollowerDisplayID[] +---@field level number +---@field quality number +---@field currentXP number +---@field maxXP number +---@field height number +---@field scale number +---@field movementType number? +---@field impactDelay number? +---@field castID number? +---@field castSoundID number? +---@field impactID number? +---@field impactSoundID number? +---@field targetImpactID number? +---@field targetImpactSoundID number? +---@field className string? +---@field classAtlas textureAtlas +---@field portraitIconID fileID +---@field textureKit textureKit +---@field isTroop boolean +---@field boardIndex number +---@field health number +---@field maxHealth number +---@field role number + +---@class GarrisonAbilityCounterInfo +---@field id number +---@field icon fileID +---@field name string +---@field factor number +---@field description string + +---@class GarrisonAbilityInfo +---@field id number +---@field name string +---@field description string +---@field icon fileID +---@field isTrait boolean +---@field isSpecialization boolean +---@field temporary boolean +---@field category string? +---@field counters GarrisonAbilityCounterInfo[] +---@field isEmptySlot boolean + +---@class GarrisonEnemyEncounterInfo +---@field name string +---@field displayID fileID +---@field portraitFileDataID fileID +---@field textureKit textureKit +---@field scale number +---@field height number +---@field mechanics GarrisonMechanicInfo[] +---@field autoCombatSpells AutoCombatSpellInfo[] +---@field autoCombatAutoAttack AutoCombatSpellInfo? +---@field role number +---@field health number +---@field maxHealth number +---@field attack number +---@field boardIndex number +---@field isElite boolean + +---@class GarrisonFollowerDeathInfo +---@field followerID GarrisonFollower +---@field state number + +---@class GarrisonMechanicInfo +---@field mechanicTypeID number +---@field icon fileID +---@field name string +---@field factor number +---@field description string +---@field ability GarrisonAbilityInfo? + +---@class GarrisonPlotInstanceMapInfo +---@field buildingPlotInstanceID number +---@field position vector2 +---@field name string +---@field atlasName textureAtlas + +---@class MissionDeploymentInfo +---@field location string +---@field xp number +---@field environment string? +---@field environmentDesc string? +---@field environmentTexture fileID +---@field locTextureKit textureKit +---@field isExhausting boolean +---@field enemies GarrisonEnemyEncounterInfo[] + +---@class MissionEncounterIconInfo +---@field portraitFileDataID fileID +---@field missionScalar number +---@field isElite boolean +---@field isRare boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua new file mode 100644 index 0000000..c4d61a8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua @@ -0,0 +1,66 @@ +---@meta _ +---@class GarrisonAbilityEffect +---@field name string +---@field description string +---@field icon number +---@field factor number + +---@class GarrisonFollowerAbilityInfo +---@field id number +---@field name string +---@field description string +---@field icon number +---@field isTrait boolean +---@field isSpecialization boolean +---@field temporary boolean +---@field category string? +---@field counters GarrisonAbilityEffect[] +---@field isEmptySlot boolean + +---@class GarrisonTalentCurrencyCostInfo +---@field currencyType number +---@field currencyQuantity number + +---@class GarrisonTalentInfo +---@field id number +---@field ability GarrisonFollowerAbilityInfo +---@field name string +---@field icon number +---@field tier number +---@field uiOrder number +---@field type number +---@field prerequisiteTalentID number? +---@field selected boolean +---@field researched boolean +---@field ignoreTalent boolean +---@field researchDuration time_t +---@field startTime time_t +---@field timeRemaining time_t +---@field researchGoldCost number +---@field researchCurrencyCosts GarrisonTalentCurrencyCostInfo[] +---@field talentAvailability Enum.GarrisonTalentAvailability +---@field talentRank number +---@field talentMaxRank number +---@field isBeingResearched boolean +---@field description string +---@field perkSpellID number +---@field researchDescription string? +---@field playerConditionReason string? +---@field socketInfo GarrisonTalentSocketInfo +---@field treeID number + +---@class GarrisonTalentSocketInfo +---@field socketType number +---@field socketSubtype number +---@field misc0 number +---@field misc1 number + +---@class GarrisonTalentTreeInfo +---@field treeID number +---@field title string +---@field textureKit textureKit +---@field talents GarrisonTalentInfo[] +---@field isClassAgnostic boolean +---@field isThemed boolean +---@field featureType number +---@field featureSubtype number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua new file mode 100644 index 0000000..0af02d4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +C_Glue = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Glue.IsFirstLoadThisSession) +---@return boolean IsFirstLoadThisSession +function C_Glue.IsFirstLoadThisSession() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Glue.IsOnGlueScreen) +---@return boolean isOnGlueScreen +function C_Glue.IsOnGlueScreen() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua new file mode 100644 index 0000000..08122f5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua @@ -0,0 +1,150 @@ +---@meta _ +C_GossipInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.CloseGossip) +function C_GossipInfo.CloseGossip() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.ForceGossip) +---@return boolean forceGossip +function C_GossipInfo.ForceGossip() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetActiveQuests) +---@return GossipQuestUIInfo[] info +function C_GossipInfo.GetActiveQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetAvailableQuests) +---@return GossipQuestUIInfo[] info +function C_GossipInfo.GetAvailableQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetCompletedOptionDescriptionString) +---@return string? description +function C_GossipInfo.GetCompletedOptionDescriptionString() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetCustomGossipDescriptionString) +---@return string? description +function C_GossipInfo.GetCustomGossipDescriptionString() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetFriendshipReputation) +---@param friendshipFactionID number +---@return FriendshipReputationInfo reputationInfo +function C_GossipInfo.GetFriendshipReputation(friendshipFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetFriendshipReputationRanks) +---@param friendshipFactionID number +---@return FriendshipReputationRankInfo rankInfo +function C_GossipInfo.GetFriendshipReputationRanks(friendshipFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetNumActiveQuests) +---@return number numQuests +function C_GossipInfo.GetNumActiveQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetNumAvailableQuests) +---@return number numQuests +function C_GossipInfo.GetNumAvailableQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetOptionUIWidgetSetsAndTypesByOptionID) +---@param gossipOptionID number +---@return GossipOptionUIWidgetSetAndType[]? gossipOptionUIWidgetSetsAndTypes +function C_GossipInfo.GetOptionUIWidgetSetsAndTypesByOptionID(gossipOptionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetOptions) +---@return GossipOptionUIInfo[] info +function C_GossipInfo.GetOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetPoiForUiMapID) +---@param uiMapID number +---@return number? gossipPoiID +function C_GossipInfo.GetPoiForUiMapID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetPoiInfo) +---@param uiMapID number +---@param gossipPoiID number +---@return GossipPoiInfo? gossipPoiInfo +function C_GossipInfo.GetPoiInfo(uiMapID, gossipPoiID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.GetText) +---@return string gossipText +function C_GossipInfo.GetText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.RefreshOptions) +function C_GossipInfo.RefreshOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.SelectActiveQuest) +---@param optionID number +function C_GossipInfo.SelectActiveQuest(optionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.SelectAvailableQuest) +---@param optionID number +function C_GossipInfo.SelectAvailableQuest(optionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.SelectOption) +---@param optionID number +---@param text? string +---@param confirmed? boolean +function C_GossipInfo.SelectOption(optionID, text, confirmed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GossipInfo.SelectOptionByIndex) +---@param optionID number +---@param text? string +---@param confirmed? boolean +function C_GossipInfo.SelectOptionByIndex(optionID, text, confirmed) end + +---@class FriendshipReputationInfo +---@field friendshipFactionID number +---@field standing number +---@field maxRep number +---@field name string? +---@field text string +---@field texture number +---@field reaction string +---@field reactionThreshold number +---@field nextThreshold number? +---@field reversedColor boolean +---@field overrideColor number? + +---@class FriendshipReputationRankInfo +---@field currentLevel number +---@field maxLevel number + +---@class GossipOptionRewardInfo +---@field id number +---@field quantity number +---@field rewardType Enum.GossipOptionRewardType +---@field context Enum.ItemCreationContext + +---@class GossipOptionUIInfo +---@field gossipOptionID number? +---@field name string +---@field icon fileID +---@field rewards GossipOptionRewardInfo[] +---@field status Enum.GossipOptionStatus +---@field spellID number? +---@field flags number +---@field overrideIconID fileID? +---@field selectOptionWhenOnlyOption boolean +---@field orderIndex number +---@field failureDescription string? + +---@class GossipOptionUIWidgetSetAndType +---@field widgetType number +---@field uiWidgetSetID number + +---@class GossipPoiInfo +---@field name string +---@field textureIndex number +---@field position vector2 +---@field inBattleMap boolean + +---@class GossipQuestUIInfo +---@field title string +---@field questLevel number +---@field isTrivial boolean +---@field frequency number? +---@field repeatable boolean? +---@field isComplete boolean? +---@field isLegendary boolean +---@field isIgnored boolean +---@field questID number +---@field isImportant boolean +---@field isMeta boolean +---@field questInfoID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua new file mode 100644 index 0000000..f3be36a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_GuildBank = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildBank.IsGuildBankEnabled) +---@return boolean enabled +function C_GuildBank.IsGuildBankEnabled() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua new file mode 100644 index 0000000..13db7d5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua @@ -0,0 +1,175 @@ +---@meta _ +C_GuildInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.AreGuildEventsEnabled) +---@return boolean enabled +function C_GuildInfo.AreGuildEventsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.CanEditOfficerNote) +---@return boolean canEditOfficerNote +function C_GuildInfo.CanEditOfficerNote() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.CanSpeakInGuildChat) +---@return boolean canSpeakInGuildChat +function C_GuildInfo.CanSpeakInGuildChat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.CanViewOfficerNote) +---@return boolean canViewOfficerNote +function C_GuildInfo.CanViewOfficerNote() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Demote) +---@param name string +function C_GuildInfo.Demote(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Disband) +function C_GuildInfo.Disband() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GetGuildNewsInfo) +---@param index number +---@return GuildNewsInfo newsInfo +function C_GuildInfo.GetGuildNewsInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GetGuildRankOrder) +---@param guid WOWGUID +---@return number rankOrder +function C_GuildInfo.GetGuildRankOrder(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GetGuildTabardInfo) +---@param unit? UnitToken +---@return GuildTabardInfo? tabardInfo +function C_GuildInfo.GetGuildTabardInfo(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GetInfoText) +---@return string infoText +function C_GuildInfo.GetInfoText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GetMOTD) +---@return string motd +function C_GuildInfo.GetMOTD() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GuildControlGetRankFlags) +---@param rankOrder number +---@return boolean[] permissions +function C_GuildInfo.GuildControlGetRankFlags(rankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.GuildRoster) +function C_GuildInfo.GuildRoster() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Invite) +---@param name string +function C_GuildInfo.Invite(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.IsEncounterGuildNewsEnabled) +---@return boolean enabled +function C_GuildInfo.IsEncounterGuildNewsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.IsGuildOfficer) +---@return boolean isOfficer +function C_GuildInfo.IsGuildOfficer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.IsGuildRankAssignmentAllowed) +---@param guid WOWGUID +---@param rankOrder number +---@return boolean isGuildRankAssignmentAllowed +function C_GuildInfo.IsGuildRankAssignmentAllowed(guid, rankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.IsGuildReputationEnabled) +---@return boolean enabled +function C_GuildInfo.IsGuildReputationEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Leave) +function C_GuildInfo.Leave() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.MemberExistsByName) +---@param name string +---@return boolean exists +function C_GuildInfo.MemberExistsByName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Promote) +---@param name string +function C_GuildInfo.Promote(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.QueryGuildMemberRecipes) +---@param guildMemberGUID WOWGUID +---@param skillLineID number +function C_GuildInfo.QueryGuildMemberRecipes(guildMemberGUID, skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.QueryGuildMembersForRecipe) +---@param skillLineID number +---@param recipeSpellID number +---@param recipeLevel? number +---@return number updatedRecipeSpellID +function C_GuildInfo.QueryGuildMembersForRecipe(skillLineID, recipeSpellID, recipeLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.RemoveFromGuild) +---@param guid WOWGUID +function C_GuildInfo.RemoveFromGuild(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.RequestGuildRename) +---@param desiredName string +function C_GuildInfo.RequestGuildRename(desiredName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.RequestGuildRenameRefund) +function C_GuildInfo.RequestGuildRenameRefund() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.RequestRenameNameCheck) +---@param desiredName string +function C_GuildInfo.RequestRenameNameCheck(desiredName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.RequestRenameStatus) +---@return boolean ableToRequest +function C_GuildInfo.RequestRenameStatus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetGuildRankOrder) +---@param guid WOWGUID +---@param rankOrder number +function C_GuildInfo.SetGuildRankOrder(guid, rankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetInfoText) +---@param infoText string +function C_GuildInfo.SetInfoText(infoText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetLeader) +---@param name string +function C_GuildInfo.SetLeader(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetMOTD) +---@param motd string +function C_GuildInfo.SetMOTD(motd) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetNote) +---@param guid WOWGUID +---@param note string +---@param isPublic boolean +function C_GuildInfo.SetNote(guid, note, isPublic) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Uninvite) +---@param name string +function C_GuildInfo.Uninvite(name) end + +---@class GuildNewsInfo +---@field isSticky boolean +---@field isHeader boolean +---@field newsType number +---@field whoText string? +---@field whatText string? +---@field newsDataID number +---@field data number[] +---@field weekday number +---@field day number +---@field month number +---@field year number +---@field guildMembersPresent number + +---@class GuildRenameStatus +---@field isNameChangeEnabled boolean +---@field isPlayerGuildMaster boolean +---@field refundEligibleEndTime time_t +---@field nextRenameTime time_t +---@field renamePrice WOWMONEY +---@field refundAmount WOWMONEY +---@field currentGuildMoney WOWMONEY +---@field result Enum.GuildErrorType +---@field oldGuildName string +---@field reservedName string +---@field reservedNameExpirationTime time_t diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua new file mode 100644 index 0000000..c8b5b3c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +---@class GuildTabardInfo +---@field backgroundColor colorRGB +---@field borderColor colorRGB +---@field emblemColor colorRGB +---@field emblemFileID number +---@field emblemStyle number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua new file mode 100644 index 0000000..d943cf9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +C_HeirloomInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.AreAllCollectionFiltersChecked) +---@return boolean areAllCollectionFiltersChecked +function C_HeirloomInfo.AreAllCollectionFiltersChecked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.AreAllSourceFiltersChecked) +---@return boolean areAllSourceFiltersChecked +function C_HeirloomInfo.AreAllSourceFiltersChecked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.IsHeirloomSourceValid) +---@param source number +---@return boolean isHeirloomSourceValid +function C_HeirloomInfo.IsHeirloomSourceValid(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.IsUsingDefaultFilters) +---@return boolean isUsingDefaultFilters +function C_HeirloomInfo.IsUsingDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.SetAllCollectionFilters) +---@param checked boolean +function C_HeirloomInfo.SetAllCollectionFilters(checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.SetAllSourceFilters) +---@param checked boolean +function C_HeirloomInfo.SetAllSourceFilters(checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HeirloomInfo.SetDefaultFilters) +function C_HeirloomInfo.SetDefaultFilters() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua new file mode 100644 index 0000000..65bf06a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua @@ -0,0 +1,54 @@ +---@meta _ +C_HouseEditor = {} + +---Attempts switch the House Editor to a specific House Editor mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.ActivateHouseEditorMode) +---@param editMode Enum.HouseEditorMode +---@return Enum.HousingResult result +function C_HouseEditor.ActivateHouseEditorMode(editMode) end + +---Attempts to open the House Editor to the default House Editor mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.EnterHouseEditor) +---@return Enum.HousingResult result +function C_HouseEditor.EnterHouseEditor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.GetActiveHouseEditorMode) +---@return Enum.HouseEditorMode editMode +function C_HouseEditor.GetActiveHouseEditorMode() end + +---Returns the availability state of the House Editor overall +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.GetHouseEditorAvailability) +---@return Enum.HousingResult result +function C_HouseEditor.GetHouseEditorAvailability() end + +---Returns the availability of a specific House Editor mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.GetHouseEditorModeAvailability) +---@param editMode Enum.HouseEditorMode +---@return Enum.HousingResult result +function C_HouseEditor.GetHouseEditorModeAvailability(editMode) end + +---Returns whether the House Editor is active, in any mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.IsHouseEditorActive) +---@return boolean isEditorActive +function C_HouseEditor.IsHouseEditorActive() end + +---Returns whether the specific House Editor mode is active +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.IsHouseEditorModeActive) +---@param editMode Enum.HouseEditorMode +---@return boolean isModeActive +function C_HouseEditor.IsHouseEditorModeActive(editMode) end + +---Returns true if the HouseEditor currently able process mode availability and switching; May be false if not in a house or plot, or while waiting to get house settings back from the server +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.IsHouseEditorStatusAvailable) +---@return boolean editorStatusAvailable +function C_HouseEditor.IsHouseEditorStatusAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseEditor.LeaveHouseEditor) +function C_HouseEditor.LeaveHouseEditor() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua new file mode 100644 index 0000000..3d94a59 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua @@ -0,0 +1,40 @@ +---@meta _ +---@class HouseExteriorSizeOption +---@field size Enum.HousingFixtureSize +---@field name string +---@field isLocked boolean + +---@class HouseExteriorSizeOptionsInfo +---@field selectedSize Enum.HousingFixtureSize +---@field options HouseExteriorSizeOption[] + +---@class HouseExteriorTypeOption +---@field houseExteriorTypeID number +---@field name string +---@field isLocked boolean +---@field lockReasonString string + +---@class HouseExteriorTypeOptionsInfo +---@field selectedExteriorType number +---@field options HouseExteriorTypeOption[] + +---@class HousingCoreFixtureInfo +---@field selectedVariantFixtureID number +---@field selectedStyleFixtureID number +---@field currentStyleVariantOptions HousingFixtureOption[] +---@field styleOptions HousingFixtureOption[] + +---@class HousingFixtureOption +---@field fixtureID number +---@field name string +---@field typeID number +---@field typeName string +---@field isLocked boolean +---@field lockReasonString string +---@field colorID number + +---@class HousingFixturePointInfo +---@field ownerHash number +---@field selectedFixtureID number? +---@field fixtureOptions HousingFixtureOption[] +---@field canSelectionBeRemoved boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua new file mode 100644 index 0000000..45c2aa9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua @@ -0,0 +1,98 @@ +---@meta _ +C_HouseExterior = {} + +---Cancels all in-progress editing of house exterior fixtures, which will deselect any active targets +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.CancelActiveExteriorEditing) +function C_HouseExterior.CancelActiveExteriorEditing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetCoreFixtureOptionsInfo) +---@param coreFixtureType Enum.HousingFixtureType +---@return HousingCoreFixtureInfo? coreFixtureOptionsInfo +function C_HouseExterior.GetCoreFixtureOptionsInfo(coreFixtureType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetCurrentHouseExteriorSize) +---@return Enum.HousingFixtureSize? houseExteriorSize +function C_HouseExterior.GetCurrentHouseExteriorSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetCurrentHouseExteriorType) +---@return number? houseExteriorTypeID +---@return string? houseExteriorTypeName +function C_HouseExterior.GetCurrentHouseExteriorType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetHouseExteriorSizeOptions) +---@return HouseExteriorSizeOptionsInfo? options +function C_HouseExterior.GetHouseExteriorSizeOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetHouseExteriorTypeOptions) +---@return HouseExteriorTypeOptionsInfo? options +function C_HouseExterior.GetHouseExteriorTypeOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetSelectedFixturePointInfo) +---@return HousingFixturePointInfo? fixturePointInfo +function C_HouseExterior.GetSelectedFixturePointInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.HasHoveredFixture) +---@return boolean anyHoveredFixture +function C_HouseExterior.HasHoveredFixture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.HasSelectedFixturePoint) +---@return boolean anySelectedFixturePoint +function C_HouseExterior.HasSelectedFixturePoint() end + +---Returns true if any decor is attached to the specified core fixture type, OR any child fixtures attached to it; Will also return false if the type provided is not a core fixture type, or if not in Exterior Customization mode on an owned plot +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.IsAnyDecorAttachedToCoreFixture) +---@param coreFixtureType Enum.HousingFixtureType +---@return boolean anyAttachedDecor +function C_HouseExterior.IsAnyDecorAttachedToCoreFixture(coreFixtureType) end + +---Returns true if any decor is attached to the current House Exterior's door; Will also return false if not in Exterior Customization mode on an owned plot +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.IsAnyDecorAttachedToDoor) +---@return boolean anyAttachedDecor +function C_HouseExterior.IsAnyDecorAttachedToDoor() end + +---Returns true if any decor is attached to any component of the current House Exterior; Will also return false if not in House Exterior Customization mode on an owned Plot +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.IsAnyDecorAttachedToHouseExterior) +---@return boolean anyAttachedDecor +function C_HouseExterior.IsAnyDecorAttachedToHouseExterior() end + +---Returns true if any decor is attached to the Fixture occupying the currently selected fixture point; Will also return false if no point is currently selected, or if there is currently no Fixture there +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.IsAnyDecorAttachedToSelectedFixturePoint) +---@return boolean anyAttachedDecor +function C_HouseExterior.IsAnyDecorAttachedToSelectedFixturePoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.IsExteriorDecorHidden) +---@return boolean decorHidden +function C_HouseExterior.IsExteriorDecorHidden() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.RemoveFixtureFromSelectedPoint) +---@param attachedDecorAction? Enum.HousingFixtureDecorAction Default = Store +function C_HouseExterior.RemoveFixtureFromSelectedPoint(attachedDecorAction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.SelectCoreFixtureOption) +---@param fixtureID number +---@param attachedDecorAction? Enum.HousingFixtureDecorAction Default = Store +function C_HouseExterior.SelectCoreFixtureOption(fixtureID, attachedDecorAction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.SelectFixtureOption) +---@param fixtureID number +---@param attachedDecorAction? Enum.HousingFixtureDecorAction Default = Store +function C_HouseExterior.SelectFixtureOption(fixtureID, attachedDecorAction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.SetExteriorDecorHidden) +---@param decorHidden boolean +function C_HouseExterior.SetExteriorDecorHidden(decorHidden) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.SetHouseExteriorSize) +---@param size Enum.HousingFixtureSize +---@param attachedDecorAction? Enum.HousingFixtureDecorAction Default = Store +function C_HouseExterior.SetHouseExteriorSize(size, attachedDecorAction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.SetHouseExteriorType) +---@param houseExteriorTypeID number +---@param attachedDecorAction? Enum.HousingFixtureDecorAction Default = Store +function C_HouseExterior.SetHouseExteriorType(houseExteriorTypeID, attachedDecorAction) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua new file mode 100644 index 0000000..8c04c82 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua @@ -0,0 +1,114 @@ +---@meta _ +C_HousingBasicMode = {} + +---Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target; Un-placed decor will be returned to the house chest +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.CancelActiveEditing) +function C_HousingBasicMode.CancelActiveEditing() end + +---Attempt to save the changes made to the currently selected decor instance +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.CommitDecorMovement) +function C_HousingBasicMode.CommitDecorMovement() end + +---Attempt to save the changes made to the House Exterior's position within the plot +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.CommitHouseExteriorPosition) +function C_HousingBasicMode.CommitHouseExteriorPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.FinishPlacingNewDecor) +function C_HousingBasicMode.FinishPlacingNewDecor() end + +---Returns info for the placed decor instance currently being hovered, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.GetHoveredDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingBasicMode.GetHoveredDecorInfo() end + +---Returns info for the decor instance that's currently selected, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.GetSelectedDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingBasicMode.GetSelectedDecorInfo() end + +---Returns true if a decor instance is currently selected and being dragged +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsDecorSelected) +---@return boolean hasSelectedDecor +function C_HousingBasicMode.IsDecorSelected() end + +---When free place is enabled, collision checks while dragging decor/the house exterior are ignored +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsFreePlaceEnabled) +---@return boolean freePlaceEnabled +function C_HousingBasicMode.IsFreePlaceEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsGridSnapEnabled) +---@return boolean isGridSnapEnabled +function C_HousingBasicMode.IsGridSnapEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsGridVisible) +---@return boolean gridVisible +function C_HousingBasicMode.IsGridVisible() end + +---Returns true if the house's exterior is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsHouseExteriorHovered) +---@return boolean isHouseExteriorHovered +function C_HousingBasicMode.IsHouseExteriorHovered() end + +---Returns true if the house's exterior is currently selected and being moved +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsHouseExteriorSelected) +---@return boolean isHouseExteriorSelected +function C_HousingBasicMode.IsHouseExteriorSelected() end + +---Returns true if a placed decor instance is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsHoveringDecor) +---@return boolean isHoveringDecor +function C_HousingBasicMode.IsHoveringDecor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.IsPlacingNewDecor) +---@return boolean hasPendingDecor +function C_HousingBasicMode.IsPlacingNewDecor() end + +---Attempt to return the currently selected decor instance back to the house chest +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.RemoveSelectedDecor) +function C_HousingBasicMode.RemoveSelectedDecor() end + +---Rotates the currently selected decor along a single axis; For wall decor, rotates such that the object stays flat against its current wall; For all other decor, rotates around the Z (vertical) axis +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.RotateDecor) +---@param rotDegrees number +function C_HousingBasicMode.RotateDecor(rotDegrees) end + +---Rotates the House Exterior around the Z (vertical) axis +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.RotateHouseExterior) +---@param rotDegrees number +function C_HousingBasicMode.RotateHouseExterior(rotDegrees) end + +---Set whether free place is enabled; When free place is enabled, collision checks while dragging decor/the house exterior are ignored +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.SetFreePlaceEnabled) +---@param freePlaceEnabled boolean +function C_HousingBasicMode.SetFreePlaceEnabled(freePlaceEnabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.SetGridSnapEnabled) +---@param isGridSnapEnabled boolean +function C_HousingBasicMode.SetGridSnapEnabled(isGridSnapEnabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.SetGridVisible) +---@param gridVisible boolean +function C_HousingBasicMode.SetGridVisible(gridVisible) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.StartPlacingNewDecor) +---@param catalogEntryVariantID HousingCatalogEntryVariantID +function C_HousingBasicMode.StartPlacingNewDecor(catalogEntryVariantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingBasicMode.StartPlacingPreviewDecor) +---@param decorRecordID number +---@param bundleCatalogShopProductID? number +function C_HousingBasicMode.StartPlacingPreviewDecor(decorRecordID, bundleCatalogShopProductID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua new file mode 100644 index 0000000..8685f27 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua @@ -0,0 +1,20 @@ +---@meta _ +---@class HousingCatalogEntryID +---@field recordID number +---@field entryType Enum.HousingCatalogEntryType + +---@class HousingCatalogEntryVariantID +---@field recordID number +---@field entryType Enum.HousingCatalogEntryType +---@field variantIdentifier number + +---@class HousingCatalogFilterTagGroupInfo +---@field groupID number +---@field groupName string +---@field tags HousingCatalogFilterTagInfo[] + +---@class HousingCatalogFilterTagInfo +---@field tagID number +---@field tagName string +---@field orderIndex number +---@field anyAssociatedEntries boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua new file mode 100644 index 0000000..44a6571 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua @@ -0,0 +1,255 @@ +---@meta _ +C_HousingCatalog = {} + +---Creates a new instance of a HousingCatalog searcher; This can be used to asynchronously search/filter the HousingCatalog without affecting/being restricted by the filter state of other Housing Catalog UI displays +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.CreateCatalogSearcher) +---@return HousingCatalogSearcher searcher +function C_HousingCatalog.CreateCatalogSearcher() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.DeletePreviewCartDecor) +---@param decorGUID WOWGUID +function C_HousingCatalog.DeletePreviewCartDecor(decorGUID) end + +---Attempt to delete the entry from storage +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.DestroyEntry) +---@param entryVariantID HousingCatalogEntryVariantID +---@param destroyAll boolean +function C_HousingCatalog.DestroyEntry(entryVariantID, destroyAll) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetAllFilterTagGroups) +---@return HousingCatalogFilterTagGroupInfo[] filterTagGroups +function C_HousingCatalog.GetAllFilterTagGroups() end + +---Returns variant info for all variants of a given catalog entry; Variants represent different visual modifications of the same base entry (ex: dyed versions) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetAllVariantInfosForEntry) +---@param entryID HousingCatalogEntryID +---@return HousingCatalogEntryVariantInfo[] variantInfos +function C_HousingCatalog.GetAllVariantInfosForEntry(entryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetBundleInfo) +---@param bundleCatalogShopProductID number +---@return HousingBundleInfo? bundleInfo +function C_HousingCatalog.GetBundleInfo(bundleCatalogShopProductID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCartSizeLimit) +---@return number cartSizeLimit +function C_HousingCatalog.GetCartSizeLimit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogCategoryInfo) +---@param categoryID number +---@return HousingCatalogCategoryInfo? info +function C_HousingCatalog.GetCatalogCategoryInfo(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogEntryInfo) +---@param entryID HousingCatalogEntryID +---@return HousingCatalogEntryInfo? info +function C_HousingCatalog.GetCatalogEntryInfo(entryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogEntryInfoByItem) +---@param itemInfo ItemInfo +---@return HousingCatalogEntryInfo? info +function C_HousingCatalog.GetCatalogEntryInfoByItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogEntryInfoByRecordID) +---@param entryType Enum.HousingCatalogEntryType +---@param recordID number +---@return HousingCatalogEntryInfo? info +function C_HousingCatalog.GetCatalogEntryInfoByRecordID(entryType, recordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogEntryRefundTimeStampByRecordID) +---@param entryType Enum.HousingCatalogEntryType +---@param recordID number +---@return time_t? refundTimeStamp +function C_HousingCatalog.GetCatalogEntryRefundTimeStampByRecordID(entryType, recordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogEntryVariantInfo) +---@param entryVariantID HousingCatalogEntryVariantID +---@return HousingCatalogEntryVariantInfo? info +function C_HousingCatalog.GetCatalogEntryVariantInfo(entryVariantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogSubcategoryInfo) +---@param subcategoryID number +---@return HousingCatalogSubcategoryInfo? info +function C_HousingCatalog.GetCatalogSubcategoryInfo(subcategoryID) end + +---Returns the maximum total number of decor that can be in storage/in the house chest; Note that not all decor entries in storage count towards this limit (see GetDecorTotalOwnedCount) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetDecorMaxOwnedCount) +---@return number maxOwnedCount +function C_HousingCatalog.GetDecorMaxOwnedCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetDecorTotalOwnedCount) +---@return number totalOwnedCount +---@return number exemptDecorCount +function C_HousingCatalog.GetDecorTotalOwnedCount() end + +---Returns the number of instances that can be to be destroyed in storage; These instances count towards the max storage limit +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetDestroyableInstanceCount) +---@param entryVariantID HousingCatalogEntryVariantID +---@return number destroyableInstanceCount +function C_HousingCatalog.GetDestroyableInstanceCount(entryVariantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetFeaturedBundles) +---@return HousingBundleInfo[] bundleInfos +function C_HousingCatalog.GetFeaturedBundles() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetFeaturedSmallProducts) +---@return HousingFeaturedSmallProductInfo[] infos +function C_HousingCatalog.GetFeaturedSmallProducts() end + +---Returns market info for a specific decor. This is decor-only for now but should be extended to support entry type and recordID generically +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetMarketInfoForDecor) +---@param decorID number +---@return HousingMarketInfo? marketInfo +function C_HousingCatalog.GetMarketInfoForDecor(decorID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.HasFeaturedEntries) +---@return boolean hasEntries +function C_HousingCatalog.HasFeaturedEntries() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.HousingMarketActionAddToCart) +---@param productID number +---@param withPreview boolean +function C_HousingCatalog.HousingMarketActionAddToCart(productID, withPreview) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.HousingMarketActionClearCart) +function C_HousingCatalog.HousingMarketActionClearCart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.HousingMarketActionRemoveFromCart) +---@param productID number +function C_HousingCatalog.HousingMarketActionRemoveFromCart(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.HousingMarketActionViewBundle) +---@param productID number +function C_HousingCatalog.HousingMarketActionViewBundle(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.HousingMarketActionViewInStore) +---@param productID number +function C_HousingCatalog.HousingMarketActionViewInStore(productID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.IsPreviewCartItemShown) +---@param decorGUID WOWGUID +---@return boolean isShown +function C_HousingCatalog.IsPreviewCartItemShown(decorGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.PromotePreviewDecor) +---@param decorID number +---@param previewDecorGUID WOWGUID +---@return boolean success +function C_HousingCatalog.PromotePreviewDecor(decorID, previewDecorGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.RequestHousingMarketInfoRefresh) +function C_HousingCatalog.RequestHousingMarketInfoRefresh() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.RequestHousingMarketRefundInfo) +function C_HousingCatalog.RequestHousingMarketRefundInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.SearchCatalogCategories) +---@param searchParams HousingCategorySearchInfo +---@return number[] categoryIDs +function C_HousingCatalog.SearchCatalogCategories(searchParams) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.SearchCatalogSubcategories) +---@param searchParams HousingCategorySearchInfo +---@return number[] subcategoryIDs +function C_HousingCatalog.SearchCatalogSubcategories(searchParams) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.SetPreviewCartItemShown) +---@param decorGUID WOWGUID +---@param shown boolean +function C_HousingCatalog.SetPreviewCartItemShown(decorGUID, shown) end + +---@class HousingBundleDecorEntryInfo +---@field decorID number +---@field quantity number + +---@class HousingBundleInfo +---@field productID number +---@field price number +---@field originalPrice number? +---@field nonDecorProducts number[] +---@field decorEntries HousingBundleDecorEntryInfo[] +---@field canPreview boolean? Default = true + +---@class HousingCatalogCategoryInfo +---@field ID number +---@field orderIndex number +---@field name string? +---@field icon textureAtlas? +---@field subcategoryIDs number[] +---@field anyStoredEntries boolean + +---@class HousingCatalogEntryInfo +---@field recordID number +---@field entryType Enum.HousingCatalogEntryType +---@field itemID number? +---@field name string +---@field asset ModelAsset? +---@field iconTexture FileAsset? +---@field iconAtlas textureAtlas? +---@field uiModelSceneID number? +---@field categoryIDs number[] +---@field subcategoryIDs number[] +---@field dataTagsByID LuaValueVariant +---@field size Enum.HousingCatalogEntrySize +---@field placementCost number +---@field totalNumStored number +---@field remainingRedeemable number +---@field totalNumPlaced number +---@field destroyableInstanceCount number +---@field isUniqueTrophy boolean +---@field isAllowedOutdoors boolean +---@field isAllowedIndoors boolean +---@field canCustomize boolean +---@field isPrefab boolean +---@field quality Enum.ItemQuality? +---@field firstAcquisitionBonus number +---@field sourceText string + +---@class HousingCatalogEntryVariantInfo +---@field entryVariantID HousingCatalogEntryVariantID +---@field numStored number +---@field dyeSlots HousingDecorDyeSlot[] + +---@class HousingCatalogSubcategoryInfo +---@field ID number +---@field orderIndex number +---@field parentCategoryID number +---@field name string? +---@field icon textureAtlas? +---@field anyStoredEntries boolean + +---@class HousingCategorySearchInfo +---@field withStoredEntriesOnly boolean? Default = false +---@field includeFeaturedCategory boolean? Default = false +---@field editorModeContext Enum.HouseEditorMode? + +---@class HousingFeaturedSmallProductInfo +---@field entryVariantID HousingCatalogEntryVariantID? +---@field productID number +---@field price number +---@field originalPrice number? +---@field canPreview boolean + +---@class HousingMarketInfo +---@field price number +---@field productID number +---@field bundleIDs number[] + +---@class HousingPreviewItemData +---@field decorGUID WOWGUID? +---@field productID number? +---@field bundleCatalogShopProductID number? +---@field isBundleParent boolean +---@field isBundleChild boolean +---@field id number +---@field decorID number +---@field name string +---@field icon number +---@field price number +---@field salePrice number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua new file mode 100644 index 0000000..7048dac --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +C_HousingCleanupMode = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCleanupMode.GetHoveredDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingCleanupMode.GetHoveredDecorInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCleanupMode.IsHoveringDecor) +---@return boolean isHoveringDecor +function C_HousingCleanupMode.IsHoveringDecor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCleanupMode.RemoveSelectedDecor) +function C_HousingCleanupMode.RemoveSelectedDecor() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua new file mode 100644 index 0000000..85817ff --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua @@ -0,0 +1,202 @@ +---@meta _ +C_HousingCustomizeMode = {} + +---If a dyeable decor is selected, applies a specific dye color in a specific slot as a preview; See CommitDyesForSelectedDecor to actually save applied dye changes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ApplyDyeToSelectedDecor) +---@param dyeSlotID number +---@param dyeColorID? number +function C_HousingCustomizeMode.ApplyDyeToSelectedDecor(dyeSlotID, dyeColorID) end + +---Attempt to apply a specific theme set (aka style) to all applicable room components in the current room +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ApplyThemeToRoom) +---@param themeSetID number +function C_HousingCustomizeMode.ApplyThemeToRoom(themeSetID) end + +---Attempt to apply a specific theme set (aka style) to the currently selected room component only +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ApplyThemeToSelectedRoomComponent) +---@param themeSetID number +function C_HousingCustomizeMode.ApplyThemeToSelectedRoomComponent(themeSetID) end + +---Attempt to apply a specific wallpaper (aka material/texture) to all applicable room components in the current room +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ApplyWallpaperToAllWalls) +---@param roomComponentTextureRecID number +function C_HousingCustomizeMode.ApplyWallpaperToAllWalls(roomComponentTextureRecID) end + +---Attempt to apply a specific wallpaper (aka material/texture) to the currently selected room component only +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ApplyWallpaperToSelectedRoomComponent) +---@param roomComponentTextureRecID number +function C_HousingCustomizeMode.ApplyWallpaperToSelectedRoomComponent(roomComponentTextureRecID) end + +---Cancels all in-progress editing of the selected target, which will reset any unapplied customization changes and deselect the active target +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.CancelActiveEditing) +function C_HousingCustomizeMode.CancelActiveEditing() end + +---Clears all previewed dye changes on the selected decor; Does not clear any already saved dyes that were previously applied +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ClearDyesForSelectedDecor) +function C_HousingCustomizeMode.ClearDyesForSelectedDecor() end + +---Deselect the currently selected room component, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.ClearTargetRoomComponent) +function C_HousingCustomizeMode.ClearTargetRoomComponent() end + +---Attempt to save all previewed dye changes made to the selected decor +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.CommitDyesForSelectedDecor) +---@return boolean hasChanges +function C_HousingCustomizeMode.CommitDyesForSelectedDecor() end + +---Returns info for the placed decor instance currently being hovered, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetHoveredDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingCustomizeMode.GetHoveredDecorInfo() end + +---Returns info for the room component currently being hovered, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetHoveredRoomComponentInfo) +---@return HousingRoomComponentInstanceInfo? info +function C_HousingCustomizeMode.GetHoveredRoomComponentInfo() end + +---If a dyeable decor instance is selected, returns how many dye slots would be cleared on applying all currently previewed dye changes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetNumDyesToRemoveOnSelectedDecor) +---@return number numDyesToRemove +function C_HousingCustomizeMode.GetNumDyesToRemoveOnSelectedDecor() end + +---If a dyeable decor instance is selected, returns how many dye items would be spent on applying all currently previewed dye changes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetNumDyesToSpendOnSelectedDecor) +---@return number numDyesToSpend +function C_HousingCustomizeMode.GetNumDyesToSpendOnSelectedDecor() end + +---If a dyeable decor instance is selected, returns info structs for each new/changed dye currently being previewed +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetPreviewDyesOnSelectedDecor) +---@return PreviewDyeSlotInfo[] previewDyes +function C_HousingCustomizeMode.GetPreviewDyesOnSelectedDecor() end + +---Returns a list of ids for the dyes most recently applied by the player, if any +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetRecentlyUsedDyes) +---@return number[] recentDyes +function C_HousingCustomizeMode.GetRecentlyUsedDyes() end + +---Returns a list of ids for the theme sets (aka styles) most recently applied by the player, if any +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetRecentlyUsedThemeSets) +---@return number[] recentThemeSets +function C_HousingCustomizeMode.GetRecentlyUsedThemeSets() end + +---Returns a list of ids for the wallpapers most recently applied by the player, if any +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetRecentlyUsedWallpapers) +---@return number[] recentWallpapers +function C_HousingCustomizeMode.GetRecentlyUsedWallpapers() end + +---Returns info for the decor instance that's currently selected, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetSelectedDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingCustomizeMode.GetSelectedDecorInfo() end + +---Returns info for the currently selected room component, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetSelectedRoomComponentInfo) +---@return HousingRoomComponentInstanceInfo? info +function C_HousingCustomizeMode.GetSelectedRoomComponentInfo() end + +---Returns the name of the specified theme set (aka style) if it exists +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetThemeSetInfo) +---@param themeSetID number +---@return string? name +function C_HousingCustomizeMode.GetThemeSetInfo(themeSetID) end + +---Get all wallpapers (aka materials/textures) available for the selected room component type, if any +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.GetWallpapersForRoomComponentType) +---@param type Enum.HousingRoomComponentType +---@return RoomComponentWallpaper[] availableWallpapers +function C_HousingCustomizeMode.GetWallpapersForRoomComponentType(type) end + +---Returns true if a decor instance is currently selected for customization +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.IsDecorSelected) +---@return boolean hasSelectedDecor +function C_HousingCustomizeMode.IsDecorSelected() end + +---Returns true if the entry door of the house's exterior is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.IsHouseExteriorDoorHovered) +---@return boolean isHouseExteriorDoorHovered +function C_HousingCustomizeMode.IsHouseExteriorDoorHovered() end + +---Returns true if a placed decor instance is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.IsHoveringDecor) +---@return boolean isHoveringDecor +function C_HousingCustomizeMode.IsHoveringDecor() end + +---Returns true if a room component is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.IsHoveringRoomComponent) +---@return boolean isHovering +function C_HousingCustomizeMode.IsHoveringRoomComponent() end + +---Returns true if a room component is currently selected for customization +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.IsRoomComponentSelected) +---@return boolean hasSelectedComponent +function C_HousingCustomizeMode.IsRoomComponentSelected() end + +---Check whether a specific room component supports a particular variant; What kind of id or enum 'variant' equates to is complicated, as it depends on the component type +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.RoomComponentSupportsVariant) +---@param componentID number +---@param variant number +---@return boolean variantSupported +function C_HousingCustomizeMode.RoomComponentSupportsVariant(componentID, variant) end + +---Attempt to set a specific ceiling component, within a specific room, to a specific new ceiling type +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.SetRoomComponentCeilingType) +---@param roomGUID WOWGUID +---@param componentID number +---@param ceilingType Enum.HousingRoomComponentCeilingType +function C_HousingCustomizeMode.SetRoomComponentCeilingType(roomGUID, componentID, ceilingType) end + +---Attempt to set a specific door component, within a specific room, to a specific new door type +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCustomizeMode.SetRoomComponentDoorType) +---@param roomGUID WOWGUID +---@param componentID number +---@param newDoortype Enum.HousingRoomComponentDoorType +function C_HousingCustomizeMode.SetRoomComponentDoorType(roomGUID, componentID, newDoortype) end + +---@class HousingRoomComponentInstanceInfo +---@field roomGUID WOWGUID +---@field type Enum.HousingRoomComponentType +---@field componentID number +---@field canBeCustomized boolean +---@field currentThemeSet number? +---@field availableThemeSets number[] +---@field currentWallpaper number? +---@field currentRoomComponentTextureRecID number? +---@field ceilingType Enum.HousingRoomComponentCeilingType +---@field doorType Enum.HousingRoomComponentDoorType + +---@class PreviewDyeSlotInfo +---@field dyeColorID number +---@field dyeSlotID number + +---@class RoomComponentWallpaper +---@field name string +---@field roomComponentTextureRecID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua new file mode 100644 index 0000000..d04f9c5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua @@ -0,0 +1,22 @@ +---@meta _ +---@class HousingDecorDyeSlot +---@field ID number +---@field dyeColorCategoryID number +---@field orderIndex number +---@field channel number +---@field dyeColorID number? +---@field dyeColorName string? + +---@class HousingDecorInstanceInfo +---@field decorGUID WOWGUID +---@field decorID number +---@field name string +---@field isLocked boolean +---@field canBeCustomized boolean +---@field canBeRemoved boolean +---@field isAllowedOutdoors boolean +---@field isAllowedIndoors boolean +---@field isRefundable boolean +---@field dyeSlots HousingDecorDyeSlot[] +---@field dataTagsByID LuaValueVariant +---@field size Enum.HousingCatalogEntrySize diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua new file mode 100644 index 0000000..4ef253c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua @@ -0,0 +1,156 @@ +---@meta _ +C_HousingDecor = {} + +---Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.CancelActiveEditing) +function C_HousingDecor.CancelActiveEditing() end + +---Attempt to save the changes made to the currently selected decor instance +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.CommitDecorMovement) +function C_HousingDecor.CommitDecorMovement() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.EnterPreviewState) +function C_HousingDecor.EnterPreviewState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.ExitPreviewState) +function C_HousingDecor.ExitPreviewState() end + +---Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetAllPlacedDecor) +---@return HousingDecorInstanceListEntry[] placedDecor +function C_HousingDecor.GetAllPlacedDecor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetDecorHyperlink) +---@param decorID number +---@return string hyperLink +function C_HousingDecor.GetDecorHyperlink(decorID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetDecorIcon) +---@param decorID number +---@return fileID icon +function C_HousingDecor.GetDecorIcon(decorID) end + +---Returns info for the placed decor instance associated with the passed Decor GUID, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetDecorInstanceInfoForGUID) +---@param decorGUID WOWGUID +---@return HousingDecorInstanceInfo? info +function C_HousingDecor.GetDecorInstanceInfoForGUID(decorGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetDecorName) +---@param decorID number +---@return string name +function C_HousingDecor.GetDecorName(decorID) end + +---Returns info for the placed decor instance currently being hovered, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetHoveredDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingDecor.GetHoveredDecorInfo() end + +---Returns the max decor placement budget for the current house interior or plot; Can be increased via house level +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetMaxPlacementBudget) +---@return number maxBudget +function C_HousingDecor.GetMaxPlacementBudget() end + +---Returns the number of individual decor objects placed in the current house or plot; This is NOT the value used in placement budget calculations, see GetSpentPlacementBudget for that +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetNumDecorPlaced) +---@return number numPlaced +function C_HousingDecor.GetNumDecorPlaced() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetNumPreviewDecor) +---@return number numDecor +function C_HousingDecor.GetNumPreviewDecor() end + +---Returns info for the placed decor instance that's currently selected, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetSelectedDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingDecor.GetSelectedDecorInfo() end + +---Returns how much of the current house interior or plot's decor placement budget has been spent; Different kinds of decor take up different budget amounts, so this value isn't an individual decor count, see GetNumDecorPlaced for that +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetSpentPlacementBudget) +---@return number totalCost +function C_HousingDecor.GetSpentPlacementBudget() end + +---Returns whether there's a max decor placement budget available and active for the current player, in the current house interior or plot +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.HasMaxPlacementBudget) +---@return boolean hasMaxBudget +function C_HousingDecor.HasMaxPlacementBudget() end + +---Returns true if a placed decor instance is currently selected +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsDecorSelected) +---@return boolean hasSelectedDecor +function C_HousingDecor.IsDecorSelected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsGridVisible) +---@return boolean gridVisible +function C_HousingDecor.IsGridVisible() end + +---Returns true if the entry door of the house's exterior is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsHouseExteriorDoorHovered) +---@return boolean isHouseExteriorDoorHovered +function C_HousingDecor.IsHouseExteriorDoorHovered() end + +---Returns true if the house's exterior is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsHouseExteriorHovered) +---@return boolean isHouseExteriorHovered +function C_HousingDecor.IsHouseExteriorHovered() end + +---Returns true if a placed decor instance is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsHoveringDecor) +---@return boolean isHoveringDecor +function C_HousingDecor.IsHoveringDecor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsModeDisabledForPreviewState) +---@param mode Enum.HouseEditorMode +---@return boolean isModeDisabled +function C_HousingDecor.IsModeDisabledForPreviewState(mode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.IsPreviewState) +---@return boolean isPreviewState +function C_HousingDecor.IsPreviewState() end + +---Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.RemovePlacedDecorEntry) +---@param decorGUID WOWGUID +function C_HousingDecor.RemovePlacedDecorEntry(decorGUID) end + +---Attempt to return the currently selected decor instance back to the house chest +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.RemoveSelectedDecor) +function C_HousingDecor.RemoveSelectedDecor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.SetGridVisible) +---@param gridVisible boolean +function C_HousingDecor.SetGridVisible(gridVisible) end + +---Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.SetPlacedDecorEntryHovered) +---@param decorGUID WOWGUID +---@param hovered boolean +function C_HousingDecor.SetPlacedDecorEntryHovered(decorGUID, hovered) end + +---Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.SetPlacedDecorEntrySelected) +---@param decorGUID WOWGUID +---@param selected boolean +function C_HousingDecor.SetPlacedDecorEntrySelected(decorGUID, selected) end + +---@class HousingDecorInstanceListEntry +---@field decorGUID WOWGUID +---@field name string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua new file mode 100644 index 0000000..6a07d99 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua @@ -0,0 +1,103 @@ +---@meta _ +C_HousingExpertMode = {} + +---Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target; Will not reset any already-applied changes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.CancelActiveEditing) +function C_HousingExpertMode.CancelActiveEditing() end + +---Attempt to save the changes made to the currently selected decor instance +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.CommitDecorMovement) +function C_HousingExpertMode.CommitDecorMovement() end + +---Attempt to save the changes made to the House Exterior's position within the plot +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.CommitHouseExteriorPosition) +function C_HousingExpertMode.CommitHouseExteriorPosition() end + +---Returns info for the placed decor instance currently being hovered, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.GetHoveredDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingExpertMode.GetHoveredDecorInfo() end + +---Returns the currently active Expert submode, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.GetPrecisionSubmode) +---@return Enum.HousingPrecisionSubmode? activeSubMode +function C_HousingExpertMode.GetPrecisionSubmode() end + +---Returns the type of restriction currently active on the submode; Will return HousingExpertSubmodeRestriction:None if submode is not currently restricted +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.GetPrecisionSubmodeRestriction) +---@param subMode Enum.HousingPrecisionSubmode +---@return Enum.HousingExpertSubmodeRestriction restriction +function C_HousingExpertMode.GetPrecisionSubmodeRestriction(subMode) end + +---Returns info for the placed decor instance that's currently selected, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.GetSelectedDecorInfo) +---@return HousingDecorInstanceInfo? info +function C_HousingExpertMode.GetSelectedDecorInfo() end + +---Returns true if a placed decor instance is currently selected +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.IsDecorSelected) +---@return boolean hasSelectedDecor +function C_HousingExpertMode.IsDecorSelected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.IsGridVisible) +---@return boolean gridVisible +function C_HousingExpertMode.IsGridVisible() end + +---Returns true if the house's exterior is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.IsHouseExteriorHovered) +---@return boolean isHouseExteriorHovered +function C_HousingExpertMode.IsHouseExteriorHovered() end + +---Returns true if the house's exterior is currently selected +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.IsHouseExteriorSelected) +---@return boolean isHouseExteriorSelected +function C_HousingExpertMode.IsHouseExteriorSelected() end + +---Returns true if a placed decor instance is currently being hovered +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.IsHoveringDecor) +---@return boolean isHoveringDecor +function C_HousingExpertMode.IsHoveringDecor() end + +---Attempt to return the currently selected decor instance back to the house chest +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.RemoveSelectedDecor) +function C_HousingExpertMode.RemoveSelectedDecor() end + +---Reset the selected target's transform back to default values; This is NOT an undo, meaning it will completely reset the transform value to default, NOT just recently-made changes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.ResetPrecisionChanges) +---@param activeSubmodeOnly boolean +function C_HousingExpertMode.ResetPrecisionChanges(activeSubmodeOnly) end + +---In the rotation submode, swaps the selected axis to the next available one, in order of X -> Y -> Z (wrapping back around to X again, etc); If no axis is selected, selects the first available one, also in that order +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.SelectNextRotationAxis) +function C_HousingExpertMode.SelectNextRotationAxis() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.SetGridVisible) +---@param gridVisible boolean +function C_HousingExpertMode.SetGridVisible(gridVisible) end + +---Sets a specific type of incremental change active or inactive; Whilever that type is active and target stays selected, incremental changes of that type will continue to be made every frame +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.SetPrecisionIncrementingActive) +---@param incrementType Enum.HousingIncrementType +---@param active boolean +function C_HousingExpertMode.SetPrecisionIncrementingActive(incrementType, active) end + +---Activate a specific Expert submode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingExpertMode.SetPrecisionSubmode) +---@param subMode Enum.HousingPrecisionSubmode +function C_HousingExpertMode.SetPrecisionSubmode(subMode) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingInspectModeUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingInspectModeUIDocumentation.lua new file mode 100644 index 0000000..f897ccf --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingInspectModeUIDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +C_HousingInspectMode = {} + +---Enters inspect mode, enabling decor inspection +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingInspectMode.EnterInspectMode) +function C_HousingInspectMode.EnterInspectMode() end + +---Exits inspect mode, disabling decor inspection +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingInspectMode.ExitInspectMode) +function C_HousingInspectMode.ExitInspectMode() end + +---Returns the GUID of the decor instance currently being hovered, if there is one +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingInspectMode.GetHoveredDecorGUID) +---@return WOWGUID decorGUID +function C_HousingInspectMode.GetHoveredDecorGUID() end + +---Returns true if a decor instance is currently being hovered in inspect mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingInspectMode.IsHoveringDecor) +---@return boolean isHoveringDecor +function C_HousingInspectMode.IsHoveringDecor() end + +---Returns true if the player is currently in inspect mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingInspectMode.IsInInspectMode) +---@return boolean isInInspectMode +function C_HousingInspectMode.IsInInspectMode() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua new file mode 100644 index 0000000..7673748 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua @@ -0,0 +1,173 @@ +---@meta _ +C_HousingLayout = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.AnyRoomsOnFloor) +---@param floor number +---@return boolean anyRooms +function C_HousingLayout.AnyRoomsOnFloor(floor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.CancelActiveLayoutEditing) +function C_HousingLayout.CancelActiveLayoutEditing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.ConfirmStairChoice) +---@param choice? Enum.HousingLayoutStairDirection +function C_HousingLayout.ConfirmStairChoice(choice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.DeselectFloorplan) +function C_HousingLayout.DeselectFloorplan() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.DeselectRoomOrDoor) +function C_HousingLayout.DeselectRoomOrDoor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetNumActiveRooms) +---@return number numRooms +function C_HousingLayout.GetNumActiveRooms() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetNumFloors) +---@return number numFloors +function C_HousingLayout.GetNumFloors() end + +---Returns the max room placement budget for the current house interior; Can be increased via house level +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetRoomPlacementBudget) +---@return number placementBudget +function C_HousingLayout.GetRoomPlacementBudget() end + +---If a door is selected, returns its component id and the guid of the room it belongs to; Otherwise returns nothing +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetSelectedDoor) +---@return number selectedDoorComponentID +---@return WOWGUID roomGUID +function C_HousingLayout.GetSelectedDoor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetSelectedFloorplan) +---@return number? roomID +function C_HousingLayout.GetSelectedFloorplan() end + +---If a Room is selected, returns the room's guid; Otherwise returns nothing +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetSelectedRoom) +---@return WOWGUID roomGUID +function C_HousingLayout.GetSelectedRoom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetSelectedStairwellRoomCount) +---@return number stairwellRoomCount +function C_HousingLayout.GetSelectedStairwellRoomCount() end + +---Returns how much of the current house's room placement budget has been spent; Different kinds of rooms take up different budget amounts, so this value isn't an individual room count, see GetNumActiveRooms for that +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetSpentPlacementBudget) +---@return number spentPlacementBudget +function C_HousingLayout.GetSpentPlacementBudget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.GetViewedFloor) +---@return number floor +function C_HousingLayout.GetViewedFloor() end + +---Returns true if any room, door, or floorplan is currently selected or being dragged +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasAnySelections) +---@return boolean hasAnySelections +function C_HousingLayout.HasAnySelections() end + +---Returns whether there's a max room placement budget available and active for the current player, in the current house interior +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasRoomPlacementBudget) +---@return boolean hasBudget +function C_HousingLayout.HasRoomPlacementBudget() end + +---Returns true if a door component is currently selected +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasSelectedDoor) +---@return boolean hasSelectedDoor +function C_HousingLayout.HasSelectedDoor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasSelectedFloorplan) +---@return boolean hasSelectedFloorplan +function C_HousingLayout.HasSelectedFloorplan() end + +---Returns true if a room is selected, will NOT return true if a door is selected +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasSelectedRoom) +---@return boolean hasSelectedRoom +function C_HousingLayout.HasSelectedRoom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasStairs) +---@param roomRecordID number +---@return boolean hasStairs +function C_HousingLayout.HasStairs(roomRecordID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.HasValidConnection) +---@param roomGUID WOWGUID +---@param componentID number +---@param roomId number +---@return boolean canPlace +function C_HousingLayout.HasValidConnection(roomGUID, componentID, roomId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.IsBaseRoom) +---@param roomGUID WOWGUID +---@return boolean isBaseRoom +function C_HousingLayout.IsBaseRoom(roomGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.IsDraggingRoom) +---@return boolean isDragging +---@return boolean isAccessibleDrag +function C_HousingLayout.IsDraggingRoom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.IsDraggingStairwell) +---@return boolean isDraggingStairwell +function C_HousingLayout.IsDraggingStairwell() end + +---Attempt to move the room currently being dragged to a specific connection point on a specific other room +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.MoveDraggedRoom) +---@param sourceDoorIndex number +---@param destRoom WOWGUID +---@param destDoorIndex number +function C_HousingLayout.MoveDraggedRoom(sourceDoorIndex, destRoom, destDoorIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.MoveLayoutCamera) +---@param direction Enum.HousingLayoutCameraDirection +---@param isPressed boolean +function C_HousingLayout.MoveLayoutCamera(direction, isPressed) end + +---Attempt to return a previously placed room to the House Chest +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.RemoveRoom) +---@param roomGUID WOWGUID +function C_HousingLayout.RemoveRoom(roomGUID) end + +---Rotates either the currently dragged or currently selected room, if either exist +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.RotateFocusedRoom) +---@param isLeft boolean +function C_HousingLayout.RotateFocusedRoom(isLeft) end + +---Attempt to rotate an already placed room +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.RotateRoom) +---@param roomGUID WOWGUID +---@param isLeft boolean +function C_HousingLayout.RotateRoom(roomGUID, isLeft) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.SelectFloorplan) +---@param roomID number +function C_HousingLayout.SelectFloorplan(roomID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.SetViewedFloor) +---@param floor number +function C_HousingLayout.SetViewedFloor(floor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.StartDrag) +function C_HousingLayout.StartDrag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.StopDrag) +function C_HousingLayout.StopDrag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.StopDraggingRoom) +function C_HousingLayout.StopDraggingRoom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingLayout.ZoomLayoutCamera) +---@param zoomIn boolean +---@return boolean zoomChanged +function C_HousingLayout.ZoomLayoutCamera(zoomIn) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua new file mode 100644 index 0000000..e58062b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +---@class DoorConnectionInfo +---@field doorID number +---@field connectionType Enum.HousingRoomComponentType +---@field doorFacing number + +---@class RoomOptionInfo +---@field roomName string +---@field roomID number +---@field learned boolean +---@field numOwned number + +---@alias PinUpdatedCallback FunctionContainer|fun() diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua new file mode 100644 index 0000000..9998326 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua @@ -0,0 +1,156 @@ +---@meta _ +C_HousingNeighborhood = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.CanReturnAfterVisitingHouse) +---@return boolean canReturn +function C_HousingNeighborhood.CanReturnAfterVisitingHouse() end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.CancelInviteToNeighborhood) +---@param playerName string +function C_HousingNeighborhood.CancelInviteToNeighborhood(playerName) end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.DemoteToResident) +---@param playerGUID WOWGUID +function C_HousingNeighborhood.DemoteToResident(playerGUID) end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetCornerstoneHouseInfo) +---@return HouseInfo houseInfo +function C_HousingNeighborhood.GetCornerstoneHouseInfo() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetCornerstoneNeighborhoodInfo) +---@return NeighborhoodInfo neighborhoodInfo +function C_HousingNeighborhood.GetCornerstoneNeighborhoodInfo() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetCornerstonePurchaseMode) +---@return Enum.CornerstonePurchaseMode purchaseMode +function C_HousingNeighborhood.GetCornerstonePurchaseMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetCurrentNeighborhoodTextureSuffix) +---@return string neighborhoodTextureSuffix +function C_HousingNeighborhood.GetCurrentNeighborhoodTextureSuffix() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetDiscountedMovePrice) +---@return number movePrice +function C_HousingNeighborhood.GetDiscountedMovePrice() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetMoveCooldownTime) +---@return number movecooldownTime +function C_HousingNeighborhood.GetMoveCooldownTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetNeighborhoodMapData) +---@return NeighborhoodPlotMapInfo[] neighborhoodPlots +function C_HousingNeighborhood.GetNeighborhoodMapData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetNeighborhoodName) +---@return string neighborhoodName +function C_HousingNeighborhood.GetNeighborhoodName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetNeighborhoodPlotName) +---@param plotIndex number +---@return string neighborhoodName +function C_HousingNeighborhood.GetNeighborhoodPlotName(plotIndex) end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.GetPreviousHouseIdentifier) +---@return string previousHouseIdentifier +function C_HousingNeighborhood.GetPreviousHouseIdentifier() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.HasPermissionToPurchase) +---@return Enum.PurchaseHouseDisabledReason cantPurchaseReason +function C_HousingNeighborhood.HasPermissionToPurchase() end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.InvitePlayerToNeighborhood) +---@param playerName string +function C_HousingNeighborhood.InvitePlayerToNeighborhood(playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.IsNeighborhoodManager) +---@return boolean isManager +function C_HousingNeighborhood.IsNeighborhoodManager() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.IsNeighborhoodOwner) +---@return boolean isOwner +function C_HousingNeighborhood.IsNeighborhoodOwner() end + +---This returns true if the player is in a plot that is owned by another player +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.IsPlayerInOtherPlayersPlot) +---@return boolean isInUnownedPlot +function C_HousingNeighborhood.IsPlayerInOtherPlayersPlot() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.IsPlotAvailableForPurchase) +---@return boolean isAvailable +function C_HousingNeighborhood.IsPlotAvailableForPurchase() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.IsPlotOwnedByPlayer) +---@return boolean isPlayerOwned +function C_HousingNeighborhood.IsPlotOwnedByPlayer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.OnBulletinBoardClosed) +function C_HousingNeighborhood.OnBulletinBoardClosed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.OnCornerstoneClosed) +function C_HousingNeighborhood.OnCornerstoneClosed() end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.PromoteToManager) +---@param playerGUID WOWGUID +function C_HousingNeighborhood.PromoteToManager(playerGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.RequestNeighborhoodInfo) +function C_HousingNeighborhood.RequestNeighborhoodInfo() end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.RequestNeighborhoodRoster) +function C_HousingNeighborhood.RequestNeighborhoodRoster() end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.RequestPendingNeighborhoodInvites) +function C_HousingNeighborhood.RequestPendingNeighborhoodInvites() end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.TransferNeighborhoodOwnership) +---@param playerGUID WOWGUID +function C_HousingNeighborhood.TransferNeighborhoodOwnership(playerGUID) end + +---Only available when interacting with a bulletin board game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.TryEvictPlayer) +---@param plotID number +function C_HousingNeighborhood.TryEvictPlayer(plotID) end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.TryMoveHouse) +function C_HousingNeighborhood.TryMoveHouse() end + +---Only available when interacting with a cornerstone game object +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingNeighborhood.TryPurchasePlot) +function C_HousingNeighborhood.TryPurchasePlot() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua new file mode 100644 index 0000000..2e6779e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua @@ -0,0 +1,40 @@ +---@meta _ +C_HousingPhotoSharing = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.BeginAuthorizationFlow) +function C_HousingPhotoSharing.BeginAuthorizationFlow() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.ClearAuthorization) +function C_HousingPhotoSharing.ClearAuthorization() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.CompleteAuthorizationFlow) +---@param callbackURL string +function C_HousingPhotoSharing.CompleteAuthorizationFlow(callbackURL) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.GetCropRatio) +---@return number cropRatio +function C_HousingPhotoSharing.GetCropRatio() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.GetPhotoSharingAuthURL) +---@return string authUrl +function C_HousingPhotoSharing.GetPhotoSharingAuthURL() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.IsAuthorized) +---@return boolean authorized +function C_HousingPhotoSharing.IsAuthorized() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.IsEnabled) +---@return boolean enabled +function C_HousingPhotoSharing.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.SetScreenshotPreviewTexture) +---@param textureObject SimpleTexture +function C_HousingPhotoSharing.SetScreenshotPreviewTexture(textureObject) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.TakePhoto) +function C_HousingPhotoSharing.TakePhoto() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingPhotoSharing.UploadPhotoToService) +---@param optionalTitle? string Default = +---@param optionalDescription? string Default = +function C_HousingPhotoSharing.UploadPhotoToService(optionalTitle, optionalDescription) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua new file mode 100644 index 0000000..1b7a0c3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua @@ -0,0 +1,234 @@ +---@meta _ +C_Housing = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.AcceptNeighborhoodOwnership) +function C_Housing.AcceptNeighborhoodOwnership() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.CanEditCharter) +---@return boolean canEditCharter +function C_Housing.CanEditCharter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.CanTakeReportScreenshot) +---@param plotIndex number +---@return Enum.InvalidPlotScreenshotReason reason +function C_Housing.CanTakeReportScreenshot(plotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.CreateGuildNeighborhood) +---@param neighborhoodName string +function C_Housing.CreateGuildNeighborhood(neighborhoodName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.CreateNeighborhoodCharter) +---@param neighborhoodName string +function C_Housing.CreateNeighborhoodCharter(neighborhoodName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.DeclineNeighborhoodOwnership) +function C_Housing.DeclineNeighborhoodOwnership() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.DoesFactionMatchNeighborhood) +---@param neighborhoodGUID WOWGUID +---@return boolean factionMatches +function C_Housing.DoesFactionMatchNeighborhood(neighborhoodGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.EditNeighborhoodCharter) +---@param neighborhoodName string +function C_Housing.EditNeighborhoodCharter(neighborhoodName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetCurrentHouseInfo) +---@return HouseInfo? houseInfo +function C_Housing.GetCurrentHouseInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetCurrentHouseLevelFavor) +---@param houseGuid WOWGUID +function C_Housing.GetCurrentHouseLevelFavor(houseGuid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetCurrentHouseRefundAmount) +---@return number refundAmount +function C_Housing.GetCurrentHouseRefundAmount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetCurrentNeighborhoodGUID) +---@return WOWGUID? neighborhoodGUID +function C_Housing.GetCurrentNeighborhoodGUID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetHouseLevelFavorForLevel) +---@param level number +---@return number houseFavor +function C_Housing.GetHouseLevelFavorForLevel(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetHouseLevelRewardsForLevel) +---@param level number +function C_Housing.GetHouseLevelRewardsForLevel(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetHousingAccessFlags) +---@return Enum.HouseSettingFlags accessFlags +function C_Housing.GetHousingAccessFlags() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetMaxHouseLevel) +---@return number level +function C_Housing.GetMaxHouseLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetNeighborhoodTextureSuffix) +---@param neighborhoodGUID WOWGUID +---@return string neighborhoodTextureSuffix +function C_Housing.GetNeighborhoodTextureSuffix(neighborhoodGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetOthersOwnedHouses) +---@param playerGUID? WOWGUID +---@param bnetID? number +---@param isInPlayersGuild boolean +function C_Housing.GetOthersOwnedHouses(playerGUID, bnetID, isInPlayersGuild) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetPlayerOwnedHouses) +function C_Housing.GetPlayerOwnedHouses() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetTrackedHouseGuid) +---@return WOWGUID? trackedHouse +function C_Housing.GetTrackedHouseGuid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetUIMapIDForNeighborhood) +---@param neighborhoodGuid WOWGUID +---@return number? uiMapID +function C_Housing.GetUIMapIDForNeighborhood(neighborhoodGuid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.GetVisitCooldownInfo) +---@return SpellCooldownInfo spellCooldownInfo +function C_Housing.GetVisitCooldownInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.HasHousingExpansionAccess) +---@return boolean hasAccess +function C_Housing.HasHousingExpansionAccess() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.HouseFinderDeclineNeighborhoodInvitation) +function C_Housing.HouseFinderDeclineNeighborhoodInvitation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.HouseFinderRequestNeighborhoods) +function C_Housing.HouseFinderRequestNeighborhoods() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.HouseFinderRequestReservationAndPort) +---@param neighborhoodGuid WOWGUID +---@param plotID number +function C_Housing.HouseFinderRequestReservationAndPort(neighborhoodGuid, plotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsHousingMarketCartFullRemoveEnabled) +---@return boolean isHousingMarketCartFullRemoveEnabled +function C_Housing.IsHousingMarketCartFullRemoveEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsHousingMarketEnabled) +---@return boolean isHousingMarketEnabled +function C_Housing.IsHousingMarketEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsHousingMarketShopEnabled) +---@return boolean isHousingMarketShopEnabled +function C_Housing.IsHousingMarketShopEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsHousingServiceEnabled) +---@return boolean isAvailable +function C_Housing.IsHousingServiceEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsInsideHouse) +---@return boolean isInside +function C_Housing.IsInsideHouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsInsideHouseOrPlot) +---@return boolean isInside +function C_Housing.IsInsideHouseOrPlot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsInsideOwnHouse) +---@return boolean isInsideOwnHouse +function C_Housing.IsInsideOwnHouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsInsidePlot) +---@return boolean isInside +function C_Housing.IsInsidePlot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.IsOnNeighborhoodMap) +---@return boolean isOnNeighborhoodMap +function C_Housing.IsOnNeighborhoodMap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.LeaveHouse) +function C_Housing.LeaveHouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnCharterConfirmationAccepted) +function C_Housing.OnCharterConfirmationAccepted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnCharterConfirmationClosed) +function C_Housing.OnCharterConfirmationClosed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnCreateCharterNeighborhoodClosed) +function C_Housing.OnCreateCharterNeighborhoodClosed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnCreateGuildNeighborhoodClosed) +function C_Housing.OnCreateGuildNeighborhoodClosed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnHouseFinderClickPlot) +---@param plotID number +function C_Housing.OnHouseFinderClickPlot(plotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnRequestSignatureClicked) +function C_Housing.OnRequestSignatureClicked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.OnSignCharterClicked) +---@param charterOwnerGUID WOWGUID +function C_Housing.OnSignCharterClicked(charterOwnerGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.RelinquishHouse) +---@param houseGuid WOWGUID +function C_Housing.RelinquishHouse(houseGuid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.RequestCurrentHouseInfo) +function C_Housing.RequestCurrentHouseInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.RequestHouseFinderNeighborhoodData) +---@param neighborhoodGuid WOWGUID +---@param neighborhoodName string +function C_Housing.RequestHouseFinderNeighborhoodData(neighborhoodGuid, neighborhoodName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.RequestPlayerCharacterList) +function C_Housing.RequestPlayerCharacterList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.ReturnAfterVisitingHouse) +function C_Housing.ReturnAfterVisitingHouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.SaveHouseSettings) +---@param playerGUID WOWGUID +---@param accessFlags Enum.HouseSettingFlags +function C_Housing.SaveHouseSettings(playerGUID, accessFlags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.SearchBNetFriendNeighborhoods) +---@param bnetName string +---@return boolean isValidBnetFriend +function C_Housing.SearchBNetFriendNeighborhoods(bnetName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.SearchBNetFriendNeighborhoodsByID) +---@param bnetID number +---@return boolean isValidBnetFriend +function C_Housing.SearchBNetFriendNeighborhoodsByID(bnetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.SetTrackedHouseGuid) +---@param trackedHouse? WOWGUID +function C_Housing.SetTrackedHouseGuid(trackedHouse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.StartTutorial) +function C_Housing.StartTutorial() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.TeleportHome) +---@param neighborhoodGUID WOWGUID +---@param houseGUID WOWGUID +---@param plotID number +function C_Housing.TeleportHome(neighborhoodGUID, houseGUID, plotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.TryRenameNeighborhood) +---@param neighborhoodName string +function C_Housing.TryRenameNeighborhood(neighborhoodName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.ValidateCreateGuildNeighborhoodSize) +function C_Housing.ValidateCreateGuildNeighborhoodSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.ValidateNeighborhoodName) +---@param neighborhoodName string +function C_Housing.ValidateNeighborhoodName(neighborhoodName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Housing.VisitHouse) +---@param neighborhoodGUID WOWGUID +---@param houseGUID WOWGUID +---@param plotID number +function C_Housing.VisitHouse(neighborhoodGUID, houseGUID, plotID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua new file mode 100644 index 0000000..ad698bb --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua @@ -0,0 +1,75 @@ +---@meta _ +---@class HouseInfo +---@field plotID number +---@field houseName string? +---@field ownerName string? +---@field plotCost number? +---@field neighborhoodName string? +---@field moveOutTime time_t? +---@field plotReserved boolean? +---@field neighborhoodGUID WOWGUID? +---@field houseGUID WOWGUID? + +---@class HouseLevelFavor +---@field houseGUID WOWGUID? +---@field houseLevel number +---@field houseFavor number + +---@class HouseLevelInfo +---@field level number +---@field interiorDecorPlacementBudget number +---@field exteriorDecorPlacementBudget number +---@field roomPlacementBudget number +---@field exteriorFixtureBudget number + +---@class HouseLevelReward +---@field type Enum.HouseLevelRewardType +---@field asset ModelAsset? +---@field iconTexture FileAsset? +---@field iconAtlas textureAtlas? +---@field objectName string? +---@field tooltipText string? +---@field valueType Enum.HouseLevelRewardValueType? +---@field oldValue number? +---@field newValue number? + +---@class HouseOwnerCharacterInfo +---@field characterName string +---@field classID number +---@field error Enum.HouseOwnerError +---@field playerGUID WOWGUID + +---@class HouseholdMemberInfo +---@field characterName string +---@field classID number + +---@class NeighborhoodInfo +---@field neighborhoodType Enum.NeighborhoodType +---@field neighborhoodOwnerType Enum.NeighborhoodOwnerType? Default = None +---@field neighborhoodName string +---@field neighborhoodGUID WOWGUID +---@field ownerGUID WOWGUID +---@field suggestionReason Enum.HouseFinderSuggestionReason? +---@field ownerName string? +---@field locationName string? + +---@class NeighborhoodPlotMapInfo +---@field mapPosition vector2 +---@field plotDataID number +---@field plotID number +---@field ownerType Enum.HousingPlotOwnerType? Default = None +---@field plotCost number? +---@field ownerName string? + +---@class NeighborhoodRosterMemberInfo +---@field playerGUID WOWGUID +---@field residentName string +---@field residentType Enum.ResidentType +---@field isOnline boolean +---@field plotID number +---@field subdivision number? + +---@class NeighborhoodRosterMemberUpdateInfo +---@field playerGUID WOWGUID +---@field residentType Enum.ResidentType +---@field isOnline boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua new file mode 100644 index 0000000..1aa260f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_ImmersiveInteraction = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ImmersiveInteraction.HasImmersiveInteraction) +---@return boolean immersiveInteraction +function C_ImmersiveInteraction.HasImmersiveInteraction() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua new file mode 100644 index 0000000..f18ebd1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua @@ -0,0 +1,26 @@ +---@meta _ +C_Navigation = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Navigation.GetDistance) +---@return number distance +function C_Navigation.GetDistance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Navigation.GetFrame) +---@return ScriptRegion? frame +function C_Navigation.GetFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Navigation.GetNearestPartyMemberToken) +---@return string unitToken +function C_Navigation.GetNearestPartyMemberToken() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Navigation.GetTargetState) +---@return Enum.NavigationState state +function C_Navigation.GetTargetState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Navigation.HasValidScreenPosition) +---@return boolean hasValidScreenPosition +function C_Navigation.HasValidScreenPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Navigation.WasClampedToScreen) +---@return boolean wasClamped +function C_Navigation.WasClampedToScreen() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua new file mode 100644 index 0000000..9d31b63 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua @@ -0,0 +1,12 @@ +---@meta _ +C_IncomingSummon = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IncomingSummon.HasIncomingSummon) +---@param unit UnitToken +---@return boolean summon +function C_IncomingSummon.HasIncomingSummon(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IncomingSummon.IncomingSummonStatus) +---@param unit UnitToken +---@return Enum.SummonStatus status +function C_IncomingSummon.IncomingSummonStatus(unit) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InputDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InputDocumentation.lua new file mode 100644 index 0000000..468a6ea --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InputDocumentation.lua @@ -0,0 +1,125 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCursorDelta) +---@return number deltaX +---@return number deltaY +function GetCursorDelta() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCursorPosition) +---@return number posX +---@return number posY +function GetCursorPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMouseButtonClicked) +---@return string buttonName +function GetMouseButtonClicked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMouseButtonName) +---@param button mouseButton +---@return string buttonName +function GetMouseButtonName(button) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMouseFoci) +---@return ScriptRegion[] region +function GetMouseFoci() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsAltKeyDown) +---@return boolean down +function IsAltKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsControlKeyDown) +---@return boolean down +function IsControlKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsKeyDown) +---@param keyOrMouseName string +---@param excludeBindingState? boolean Default = false +---@return boolean? down +function IsKeyDown(keyOrMouseName, excludeBindingState) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLeftAltKeyDown) +---@return boolean down +function IsLeftAltKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLeftControlKeyDown) +---@return boolean down +function IsLeftControlKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLeftMetaKeyDown) +---@return boolean down +function IsLeftMetaKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLeftShiftKeyDown) +---@return boolean down +function IsLeftShiftKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMetaKeyDown) +---@return boolean down +function IsMetaKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsModifierKeyDown) +---@return boolean down +function IsModifierKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMouseButtonDown) +---@param button? mouseButton +---@return boolean down +function IsMouseButtonDown(button) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRightAltKeyDown) +---@return boolean down +function IsRightAltKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRightControlKeyDown) +---@return boolean down +function IsRightControlKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRightMetaKeyDown) +---@return boolean down +function IsRightMetaKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRightShiftKeyDown) +---@return boolean down +function IsRightShiftKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsShiftKeyDown) +---@return boolean down +function IsShiftKeyDown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsUsingGamepad) +---@return boolean down +function IsUsingGamepad() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsUsingMouse) +---@return boolean down +function IsUsingMouse() end + +---Insecure code can only call this once in response to gamepad input hardware events. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCursorPosition) +---@param xPosition uiUnit +---@param yPosition uiUnit +function SetCursorPosition(xPosition, yPosition) end + +---Effectively the same as SimulateMouseDown plus SimulateMouseUp and consumes limited input for both. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimulateMouseClick) +---@param button mouseButton +function SimulateMouseClick(button) end + +---Insecure code can only call this once in response to gamepad input hardware events. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimulateMouseDown) +---@param button mouseButton +function SimulateMouseDown(button) end + +---Insecure code can only call this once in response to gamepad input hardware events. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimulateMouseUp) +---@param button mouseButton +function SimulateMouseUp(button) end + +---Insecure code can only call this once in response to gamepad input hardware events. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimulateMouseWheel) +---@param delta number +function SimulateMouseWheel(delta) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua new file mode 100644 index 0000000..3b0019e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua @@ -0,0 +1,131 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanChangePlayerDifficulty) +---@return boolean canChange +---@return boolean notOnCooldown +function CanChangePlayerDifficulty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanMapChangeDifficulty) +---@param mapID? number +---@return boolean canChange +function CanMapChangeDifficulty(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanShowResetInstances) +---@return boolean result +function CanShowResetInstances() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDifficultyInfo) +---@param difficultyID number +---@return string name +---@return string instanceType +---@return boolean isHeroic +---@return boolean isChallengeMode +---@return boolean displayHeroic +---@return boolean displayMythic +---@return number? toggleDifficultyID +---@return boolean isLFR +---@return number? minPlayers +---@return number? maxPlayers +---@return boolean isUserSelectable +function GetDifficultyInfo(difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDungeonDifficultyID) +---@return number result +function GetDungeonDifficultyID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInstanceBootTimeRemaining) +---@return number result +function GetInstanceBootTimeRemaining() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInstanceInfo) +---@return string name +---@return string instanceType +---@return number difficultyID +---@return string difficultyName +---@return number maxPlayers +---@return number dynamicDifficulty +---@return boolean? isDynamic +---@return number instanceID +---@return number instanceGroupSize +---@return number? lfgDungeonID +function GetInstanceInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInstanceLockTimeRemaining) +---@return number timeLeft +---@return boolean extending +---@return number encountersTotal +---@return number encountersCompleted +function GetInstanceLockTimeRemaining() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInstanceLockTimeRemainingEncounter) +---@param encounterIndex number +---@return string encounterName +---@return string texture +---@return boolean isKilled +---@return boolean ineligible +function GetInstanceLockTimeRemainingEncounter(encounterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLegacyRaidDifficultyID) +---@return number? result +function GetLegacyRaidDifficultyID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidDifficultyID) +---@return number? result +function GetRaidDifficultyID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInInstance) +---@return boolean isInInstance +---@return string instanceType +function IsInInstance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLegacyDifficulty) +---@param difficultyID number +---@return boolean? result +function IsLegacyDifficulty(difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetInstances) +function ResetInstances() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetDungeonDifficultyID) +---@param difficultyID number +function SetDungeonDifficultyID(difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLegacyRaidDifficultyID) +---@param difficultyID number +---@param force? boolean Default = false +function SetLegacyRaidDifficultyID(difficultyID, force) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetRaidDifficultyID) +---@param difficultyID number +---@param force? boolean Default = false +function SetRaidDifficultyID(difficultyID, force) end + +---@class DifficultyInfo +---@field name string +---@field instanceType string +---@field isHeroic boolean +---@field isChallengeMode boolean +---@field displayHeroic boolean +---@field displayMythic boolean +---@field toggleDifficultyID number? +---@field isLFR boolean +---@field minPlayers number? +---@field maxPlayers number? +---@field isUserSelectable boolean + +---@class DungeonEncounterInfo +---@field encounterName string +---@field texture string +---@field isKilled boolean +---@field ineligible boolean + +---@class InstanceInfo +---@field name string +---@field instanceType string +---@field difficultyID number +---@field difficultyName string +---@field maxPlayers number +---@field dynamicDifficulty number +---@field isDynamic boolean? +---@field instanceID number +---@field instanceGroupSize number +---@field lfgDungeonID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua new file mode 100644 index 0000000..20bee9c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua @@ -0,0 +1,18 @@ +---@meta _ +C_InstanceEncounter = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InstanceEncounter.IsEncounterInProgress) +---@return boolean isInProgress +function C_InstanceEncounter.IsEncounterInProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InstanceEncounter.IsEncounterLimitingResurrections) +---@return boolean isLimitingResurrections +function C_InstanceEncounter.IsEncounterLimitingResurrections() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InstanceEncounter.IsEncounterSuppressingRelease) +---@return boolean isSuppressingRelease +function C_InstanceEncounter.IsEncounterSuppressingRelease() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InstanceEncounter.ShouldShowTimelineForEncounter) +---@return boolean shouldShow +function C_InstanceEncounter.ShouldShowTimelineForEncounter() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua new file mode 100644 index 0000000..705b3aa --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +C_InstanceLeaver = {} + +---Returns whether the player is considered a leaver for repeatedly abandoning mythic+ groups. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InstanceLeaver.IsPlayerLeaver) +---@return boolean isLeaver +function C_InstanceLeaver.IsPlayerLeaver() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua new file mode 100644 index 0000000..1ac36cd --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_InterfaceFileManifest = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InterfaceFileManifest.GetInterfaceArtFiles) +---@return string[] images +function C_InterfaceFileManifest.GetInterfaceArtFiles() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua new file mode 100644 index 0000000..77e6971 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +C_InvasionInfo = {} + +---Returns true if invasions are active in the same physical area as the player. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InvasionInfo.AreInvasionsAvailable) +---@return boolean areInvasionsAvailable +function C_InvasionInfo.AreInvasionsAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InvasionInfo.GetInvasionForUiMapID) +---@param uiMapID number +---@return number? invasionID +function C_InvasionInfo.GetInvasionForUiMapID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InvasionInfo.GetInvasionInfo) +---@param invasionID number +---@return InvasionMapInfo invasionInfo +function C_InvasionInfo.GetInvasionInfo(invasionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_InvasionInfo.GetInvasionTimeLeft) +---@param invasionID number +---@return number? timeLeftMinutes +function C_InvasionInfo.GetInvasionTimeLeft(invasionID) end + +---@class InvasionMapInfo +---@field invasionID number +---@field name string +---@field position vector2 +---@field atlasName textureAtlas +---@field rewardQuestID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua new file mode 100644 index 0000000..007a520 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua @@ -0,0 +1,29 @@ +---@meta _ +C_IslandsQueue = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IslandsQueue.CloseIslandsQueueScreen) +function C_IslandsQueue.CloseIslandsQueueScreen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IslandsQueue.GetIslandDifficultyInfo) +---@return IslandsQueueDifficultyInfo[] islandDifficultyInfo +function C_IslandsQueue.GetIslandDifficultyInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IslandsQueue.GetIslandsMaxGroupSize) +---@return number maxGroupSize +function C_IslandsQueue.GetIslandsMaxGroupSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IslandsQueue.GetIslandsWeeklyQuestID) +---@return number? questID +function C_IslandsQueue.GetIslandsWeeklyQuestID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IslandsQueue.QueueForIsland) +---@param difficultyID number +function C_IslandsQueue.QueueForIsland(difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_IslandsQueue.RequestPreloadRewardData) +---@param questId number +function C_IslandsQueue.RequestPreloadRewardData(questId) end + +---@class IslandsQueueDifficultyInfo +---@field difficultyId number +---@field previewRewardQuestId number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua new file mode 100644 index 0000000..4bbabf8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua @@ -0,0 +1,2 @@ +---@meta _ +---@class MainlineInclude diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua new file mode 100644 index 0000000..8d65eed --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua @@ -0,0 +1,658 @@ +---@meta _ +C_Item = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ActionBindsItem) +function C_Item.ActionBindsItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.BindEnchant) +function C_Item.BindEnchant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.CanBeRefunded) +---@param itemLocation ItemLocation +---@return boolean canBeRefunded +function C_Item.CanBeRefunded(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.CanItemTransmogAppearance) +---@param itemLoc ItemLocation +---@return boolean canTransmog +---@return Enum.TransmogOutfitSlotError errorCode +function C_Item.CanItemTransmogAppearance(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.CanScrapItem) +---@param itemLoc ItemLocation +---@return boolean canBeScrapped +function C_Item.CanScrapItem(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.CanViewItemPowers) +---@param itemLoc ItemLocation +---@return boolean isItemViewable +function C_Item.CanViewItemPowers(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ConfirmBindOnUse) +function C_Item.ConfirmBindOnUse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ConfirmNoRefundOnUse) +function C_Item.ConfirmNoRefundOnUse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ConfirmOnUse) +function C_Item.ConfirmOnUse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemContainSpec) +---@param itemInfo ItemInfo +---@param classID number +---@param specID? number Default = 0 +---@return boolean result +function C_Item.DoesItemContainSpec(itemInfo, classID, specID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemExist) +---@param emptiableItemLocation EmptiableItemLocation +---@return boolean itemExists +function C_Item.DoesItemExist(emptiableItemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemExistByID) +---@param itemInfo ItemInfo +---@return boolean itemExists +function C_Item.DoesItemExistByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemMatchBonusTreeReplacement) +---@param itemLoc ItemLocation +---@return boolean matchesBonusTree +function C_Item.DoesItemMatchBonusTreeReplacement(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemMatchTargetEnchantingSpell) +---@param itemLoc ItemLocation +---@return boolean matchesTargetEnchantingSpell +function C_Item.DoesItemMatchTargetEnchantingSpell(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemMatchTrackJump) +---@param itemLoc ItemLocation +---@return boolean matchesTrackJump +function C_Item.DoesItemMatchTrackJump(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.DropItemOnUnit) +---@param unitGUID UnitToken +function C_Item.DropItemOnUnit(unitGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.EndBoundTradeable) +---@param type string +function C_Item.EndBoundTradeable(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.EndRefund) +---@param type number +function C_Item.EndRefund(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.EquipItemByName) +---@param itemInfo ItemInfo +---@param dstSlot? number +function C_Item.EquipItemByName(itemInfo, dstSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetAppliedItemTransmogInfo) +---@param itemLoc ItemLocation +---@return ItemTransmogInfo? info +function C_Item.GetAppliedItemTransmogInfo(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetBaseItemTransmogInfo) +---@param itemLoc ItemLocation +---@return ItemTransmogInfo? info +function C_Item.GetBaseItemTransmogInfo(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetCurrentItemLevel) +---@param itemLocation ItemLocation +---@return number? currentItemLevel +function C_Item.GetCurrentItemLevel(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetCurrentItemTransmogInfo) +---@param itemLoc ItemLocation +---@return ItemTransmogInfo? info +function C_Item.GetCurrentItemTransmogInfo(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetDelvePreviewItemLink) +---@param itemID number +---@param context Enum.ItemCreationContext +---@return string? itemLink +function C_Item.GetDelvePreviewItemLink(itemID, context) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetDelvePreviewItemQuality) +---@param itemID number +---@param context Enum.ItemCreationContext +---@return Enum.ItemQuality itemQuality +function C_Item.GetDelvePreviewItemQuality(itemID, context) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetDetailedItemLevelInfo) +---@param itemInfo ItemInfo +---@return number actualItemLevel +---@return boolean previewLevel +---@return number sparseItemLevel +function C_Item.GetDetailedItemLevelInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetFirstTriggeredSpellForItem) +---@param itemID number +---@param itemQuality number +---@return number? spellID +function C_Item.GetFirstTriggeredSpellForItem(itemID, itemQuality) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemChildInfo) +---@param itemInfo ItemInfo +---@param slotID? number +---@return number[] result +function C_Item.GetItemChildInfo(itemInfo, slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemClassInfo) +---@param itemClassID number +---@return string result +function C_Item.GetItemClassInfo(itemClassID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemConversionOutputIcon) +---@param itemLoc ItemLocation +---@return fileID? icon +function C_Item.GetItemConversionOutputIcon(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemCooldown) +---@param itemInfo ItemInfo +---@return number startTimeSeconds +---@return number durationSeconds +---@return boolean enableCooldownTimer +function C_Item.GetItemCooldown(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemCount) +---@param itemInfo ItemInfo +---@param includeBank? boolean Default = false +---@param includeUses? boolean Default = false +---@param includeReagentBank? boolean Default = false +---@param includeAccountBank? boolean Default = false +---@return number count +function C_Item.GetItemCount(itemInfo, includeBank, includeUses, includeReagentBank, includeAccountBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemCreationContext) +---@param itemInfo ItemInfo +---@return number itemID +---@return string creationContext +function C_Item.GetItemCreationContext(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemFamily) +---@param itemInfo ItemInfo +---@return number? result +function C_Item.GetItemFamily(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemGUID) +---@param itemLocation ItemLocation +---@return WOWGUID itemGUID +function C_Item.GetItemGUID(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemGem) +---@param hyperlink string +---@param index number +---@return string gemName +---@return string gemLink +function C_Item.GetItemGem(hyperlink, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemGemID) +---@param itemInfo ItemInfo +---@param index number +---@return number gemID +function C_Item.GetItemGemID(itemInfo, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemID) +---@param itemLocation ItemLocation +---@return number itemID +function C_Item.GetItemID(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemIDByGUID) +---@param itemGUID WOWGUID +---@return number? itemID +function C_Item.GetItemIDByGUID(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemIDForItemInfo) +---@param itemInfo ItemInfo +---@return number itemID +function C_Item.GetItemIDForItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemIcon) +---@param itemLocation ItemLocation +---@return fileID? icon +function C_Item.GetItemIcon(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemIconByID) +---@param itemInfo ItemInfo +---@return fileID? icon +function C_Item.GetItemIconByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInfo) +---@param itemInfo ItemInfo +---@return string itemName +---@return string itemLink +---@return Enum.ItemQuality itemQuality +---@return number itemLevel +---@return number itemMinLevel +---@return string itemType +---@return string itemSubType +---@return number itemStackCount +---@return string itemEquipLoc +---@return fileID itemTexture +---@return number sellPrice +---@return number classID +---@return number subclassID +---@return number bindType +---@return number expansionID +---@return number? setID +---@return boolean isCraftingReagent +---@return string itemDescription +function C_Item.GetItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInfoInstant) +---@param itemInfo ItemInfo +---@return number itemID +---@return string itemType +---@return string itemSubType +---@return string itemEquipLoc +---@return fileID icon +---@return number classID +---@return number subClassID +function C_Item.GetItemInfoInstant(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInventorySlotInfo) +---@param inventorySlot Enum.InventoryType +---@return string result +function C_Item.GetItemInventorySlotInfo(inventorySlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInventorySlotKey) +---@param inventorySlot Enum.InventoryType +---@return string result +function C_Item.GetItemInventorySlotKey(inventorySlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInventoryType) +---@param itemLocation ItemLocation +---@return Enum.InventoryType? inventoryType +function C_Item.GetItemInventoryType(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInventoryTypeByID) +---@param itemInfo ItemInfo +---@return Enum.InventoryType? inventoryType +function C_Item.GetItemInventoryTypeByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemLearnTransmogSet) +---@param itemInfo ItemInfo +---@return number? setID +function C_Item.GetItemLearnTransmogSet(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemLink) +---@param itemLocation ItemLocation +---@return string? itemLink +function C_Item.GetItemLink(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemLinkByGUID) +---@param itemGUID WOWGUID +---@return string? itemLink +function C_Item.GetItemLinkByGUID(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemLocation) +---@param itemGUID WOWGUID +---@return ItemLocation? itemLocation +function C_Item.GetItemLocation(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemMaxStackSize) +---@param itemLocation ItemLocation +---@return number? stackSize +function C_Item.GetItemMaxStackSize(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemMaxStackSizeByID) +---@param itemInfo ItemInfo +---@return number? stackSize +function C_Item.GetItemMaxStackSizeByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemName) +---@param itemLocation ItemLocation +---@return string? itemName +function C_Item.GetItemName(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemNameByID) +---@param itemInfo ItemInfo +---@return string? itemName +function C_Item.GetItemNameByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemNumAddedSockets) +---@param itemInfo ItemInfo +---@return number socketCount +function C_Item.GetItemNumAddedSockets(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemNumSockets) +---@param itemInfo ItemInfo +---@return number socketCount +function C_Item.GetItemNumSockets(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemQuality) +---@param itemLocation ItemLocation +---@return Enum.ItemQuality? itemQuality +function C_Item.GetItemQuality(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemQualityByID) +---@param itemInfo ItemInfo +---@return Enum.ItemQuality? itemQuality +function C_Item.GetItemQualityByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemQualityColor) +---@param quality Enum.ItemQuality +---@return number colorRGBR +---@return number colorRGBG +---@return number colorRGBB +---@return string qualityString +function C_Item.GetItemQualityColor(quality) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSetInfo) +---@param setID number +---@return string result +function C_Item.GetItemSetInfo(setID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSpecInfo) +---@param itemInfo ItemInfo +---@return number[] specTable +function C_Item.GetItemSpecInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSpell) +---@param itemInfo ItemInfo +---@return string spellName +---@return number spellID +function C_Item.GetItemSpell(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemStatDelta) +---@param itemLink1 string +---@param itemLink2 string +---@return LuaValueVariant statTable +function C_Item.GetItemStatDelta(itemLink1, itemLink2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemStats) +---@param itemLink string +---@return LuaValueVariant statTable +function C_Item.GetItemStats(itemLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSubClassInfo) +---@param itemClassID number +---@param itemSubClassID number +---@return string subClassName +---@return boolean subClassUsesInvType +function C_Item.GetItemSubClassInfo(itemClassID, itemSubClassID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemUniqueness) +---@param itemInfo ItemInfo +---@return number limitCategory +---@return number limitMax +function C_Item.GetItemUniqueness(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemUniquenessByID) +---@param itemInfo ItemInfo +---@return boolean isUnique +---@return string? limitCategoryName +---@return number? limitCategoryCount +---@return number? limitCategoryID +function C_Item.GetItemUniquenessByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemUpgradeInfo) +---@param itemInfo ItemInfo +---@return ItemUpgradeInfo? itemUpgradeInfo +function C_Item.GetItemUpgradeInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetLimitedCurrencyItemInfo) +---@param itemInfo ItemInfo +---@return string name +---@return fileID icon +---@return number quantity +---@return number maxQuantity +---@return number totalEarned +function C_Item.GetLimitedCurrencyItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetSetBonusesForSpecializationByItemID) +---@param specID number +---@param itemID number +---@return number[] itemSetSpellIDs +function C_Item.GetSetBonusesForSpecializationByItemID(specID, itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.GetStackCount) +---@param itemLocation ItemLocation +---@return number stackCount +function C_Item.GetStackCount(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsAnimaItemByID) +---@param itemInfo ItemInfo +---@return boolean isAnimaItem +function C_Item.IsAnimaItemByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsArtifactPowerItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsArtifactPowerItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsBound) +---@param itemLocation ItemLocation +---@return boolean isBound +function C_Item.IsBound(itemLocation) end + +---You can use IsItemBindToAccountUntilEquip instead if the item is not in your inventory +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsBoundToAccountUntilEquip) +---@param itemLocation ItemLocation +---@return boolean isBoundToAccountUntilEquip +function C_Item.IsBoundToAccountUntilEquip(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsConsumableItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsConsumableItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsCorruptedItem) +---@param itemInfo ItemInfo +---@return boolean? result +function C_Item.IsCorruptedItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsCosmeticItem) +---@param itemInfo ItemInfo +---@return boolean? result +function C_Item.IsCosmeticItem(itemInfo) end + +---Returns whether the item is a consumable curio that can be applied to a delves companion. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsCurioItem) +---@param itemInfo ItemInfo +---@return boolean? result +function C_Item.IsCurioItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsCurrentItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsCurrentItem(itemInfo) end + +---Returns whether the item is a consumable decor item. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsDecorItem) +---@param itemInfo ItemInfo +---@return boolean? isDecor +function C_Item.IsDecorItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsDressableItemByID) +---@param itemInfo ItemInfo +---@return boolean isDressableItem +function C_Item.IsDressableItemByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsEquippableItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsEquippableItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsEquippedItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsEquippedItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsEquippedItemType) +---@param type string +---@return boolean result +function C_Item.IsEquippedItemType(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsHarmfulItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsHarmfulItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsHelpfulItem) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.IsHelpfulItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemBindToAccount) +---@param itemInfo ItemInfo +---@return boolean isItemBindToAccount +function C_Item.IsItemBindToAccount(itemInfo) end + +---You can use IsBoundToAccountUntilEquip instead if the item exists in your inventory +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemBindToAccountUntilEquip) +---@param itemInfo ItemInfo +---@return boolean isItemBindToAccountUntilEquip +function C_Item.IsItemBindToAccountUntilEquip(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemConduit) +---@param itemLoc ItemLocation +---@return boolean isConduit +function C_Item.IsItemConduit(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemConvertibleAndValidForPlayer) +---@param itemLoc ItemLocation +---@return boolean isItemConvertibleAndValidForPlayer +function C_Item.IsItemConvertibleAndValidForPlayer(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemCorrupted) +---@param itemLoc ItemLocation +---@return boolean isCorrupted +function C_Item.IsItemCorrupted(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemCorruptionRelated) +---@param itemLoc ItemLocation +---@return boolean isCorruptionRelated +function C_Item.IsItemCorruptionRelated(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemCorruptionResistant) +---@param itemLoc ItemLocation +---@return boolean isCorruptionResistant +function C_Item.IsItemCorruptionResistant(itemLoc) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemDataCached) +---@param itemLocation ItemLocation +---@return boolean isCached +function C_Item.IsItemDataCached(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemDataCachedByID) +---@param itemInfo ItemInfo +---@return boolean isCached +function C_Item.IsItemDataCachedByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemGUIDInInventory) +---@param itemGUID WOWGUID +---@return boolean valid +function C_Item.IsItemGUIDInInventory(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemInRange) +---@param itemInfo ItemInfo +---@param targetToken string +---@return boolean? result +function C_Item.IsItemInRange(itemInfo, targetToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemKeystoneByID) +---@param itemInfo ItemInfo +---@return boolean isKeystone +function C_Item.IsItemKeystoneByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemSpecificToPlayerClass) +---@param itemInfo ItemInfo +---@return boolean isItemSpecificToPlayerClass +function C_Item.IsItemSpecificToPlayerClass(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsLocked) +---@param itemLocation ItemLocation +---@return boolean isLocked +function C_Item.IsLocked(itemLocation) end + +---Returns whether the item is a consumable relic that can be applied to an artifact weapon. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsRelicItem) +---@param itemInfo ItemInfo +---@return boolean? result +function C_Item.IsRelicItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.IsUsableItem) +---@param itemInfo ItemInfo +---@return boolean usable +---@return boolean noMana +function C_Item.IsUsableItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ItemHasRange) +---@param itemInfo ItemInfo +---@return boolean result +function C_Item.ItemHasRange(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.LockItem) +---@param itemLocation ItemLocation +function C_Item.LockItem(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.LockItemByGUID) +---@param itemGUID WOWGUID +function C_Item.LockItemByGUID(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.PickupItem) +---@param itemInfo ItemInfo +function C_Item.PickupItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ReplaceEnchant) +function C_Item.ReplaceEnchant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ReplaceTradeEnchant) +function C_Item.ReplaceTradeEnchant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.ReplaceTradeskillEnchant) +function C_Item.ReplaceTradeskillEnchant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.RequestLoadItemData) +---@param itemLocation ItemLocation +function C_Item.RequestLoadItemData(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.RequestLoadItemDataByID) +---@param itemInfo ItemInfo +function C_Item.RequestLoadItemDataByID(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.UnlockItem) +---@param itemLocation ItemLocation +function C_Item.UnlockItem(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.UnlockItemByGUID) +---@param itemGUID WOWGUID +function C_Item.UnlockItemByGUID(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Item.UseItemByName) +---@param itemInfo ItemInfo +---@param target? string +function C_Item.UseItemByName(itemInfo, target) end + +---@class ItemInfoResult +---@field itemName string +---@field itemLink string +---@field itemQuality Enum.ItemQuality +---@field itemLevel number +---@field itemMinLevel number +---@field itemType string +---@field itemSubType string +---@field itemStackCount number +---@field itemEquipLoc string +---@field itemTexture fileID +---@field sellPrice number +---@field classID number +---@field subclassID number +---@field bindType number +---@field expansionID number +---@field setID number? +---@field isCraftingReagent boolean +---@field itemDescription string + +---@class ItemUpgradeInfo +---@field currentLevel number +---@field maxLevel number +---@field maxItemLevel number +---@field trackString string? +---@field trackStringID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua new file mode 100644 index 0000000..c1aed71 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua @@ -0,0 +1,65 @@ +---@meta _ +C_ItemInteraction = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.ClearPendingItem) +function C_ItemInteraction.ClearPendingItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.CloseUI) +function C_ItemInteraction.CloseUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.GetChargeInfo) +---@return ItemInteractionChargeInfo chargeInfo +function C_ItemInteraction.GetChargeInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.GetItemConversionCurrencyCost) +---@param item ItemLocation +---@return ConversionCurrencyCost conversionCost +function C_ItemInteraction.GetItemConversionCurrencyCost(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.GetItemInteractionInfo) +---@return ItemInteractionFrameInfo? info +function C_ItemInteraction.GetItemInteractionInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.GetItemInteractionSpellId) +---@return number spellId +function C_ItemInteraction.GetItemInteractionSpellId() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.InitializeFrame) +function C_ItemInteraction.InitializeFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.PerformItemInteraction) +function C_ItemInteraction.PerformItemInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.Reset) +function C_ItemInteraction.Reset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemInteraction.SetPendingItem) +---@param item? ItemLocation +---@return boolean success +function C_ItemInteraction.SetPendingItem(item) end + +---@class ConversionCurrencyCost +---@field currencyID number +---@field amount number + +---@class ItemInteractionChargeInfo +---@field newChargeAmount number +---@field rechargeRate number +---@field timeToNextCharge number + +---@class ItemInteractionFrameInfo +---@field textureKit textureKit +---@field openSoundKitID number +---@field closeSoundKitID number +---@field titleText string +---@field tutorialText string +---@field buttonText string +---@field interactionType Enum.UIItemInteractionType +---@field flags Enum.UIItemInteractionFlags +---@field description string? +---@field buttonTooltip string? +---@field confirmationDescription string? +---@field slotTooltip string? +---@field cost number? +---@field currencyTypeId number? +---@field dropInSlotSoundKitId number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua new file mode 100644 index 0000000..4a09376 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua @@ -0,0 +1,85 @@ +---@meta _ +C_ItemSocketInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.AcceptSockets) +function C_ItemSocketInfo.AcceptSockets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.ClickSocketButton) +---@param index number +function C_ItemSocketInfo.ClickSocketButton(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.CloseSocketInfo) +function C_ItemSocketInfo.CloseSocketInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.CompleteSocketing) +function C_ItemSocketInfo.CompleteSocketing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetCurrUIType) +---@return Enum.ItemSocketInfoUIType uiType +function C_ItemSocketInfo.GetCurrUIType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetExistingSocketInfo) +---@param index number +---@return string? name +---@return fileID? icon +---@return boolean gemMatchesSocket +function C_ItemSocketInfo.GetExistingSocketInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetExistingSocketLink) +---@param index number +---@return string? existingSocketLink +function C_ItemSocketInfo.GetExistingSocketLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetNewSocketInfo) +---@param index number +---@return string? name +---@return fileID? icon +---@return boolean gemMatchesSocket +function C_ItemSocketInfo.GetNewSocketInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetNewSocketLink) +---@param index number +---@return string? newSocketLink +function C_ItemSocketInfo.GetNewSocketLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetNumSockets) +---@return number numSockets +function C_ItemSocketInfo.GetNumSockets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetSocketItemBoundTradeable) +---@return boolean socketItemTradeable +function C_ItemSocketInfo.GetSocketItemBoundTradeable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetSocketItemInfo) +---@return string? name +---@return fileID? icon +---@return Enum.ItemQuality quality +function C_ItemSocketInfo.GetSocketItemInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetSocketItemRefundable) +---@return boolean socketItemRefundable +function C_ItemSocketInfo.GetSocketItemRefundable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.GetSocketTypes) +---@param index number +---@return string? socketType +function C_ItemSocketInfo.GetSocketTypes(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.HasBoundGemProposed) +---@return boolean hasBoundGemProposed +function C_ItemSocketInfo.HasBoundGemProposed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemSocketInfo.IsArtifactRelicItem) +---@param info ItemInfo +---@return boolean isArtifactRelicItem +function C_ItemSocketInfo.IsArtifactRelicItem(info) end + +---@class SocketInfo +---@field name string? +---@field icon fileID? +---@field gemMatchesSocket boolean + +---@class SocketItemInfo +---@field name string? +---@field icon fileID? +---@field quality Enum.ItemQuality diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua new file mode 100644 index 0000000..2a85c40 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua @@ -0,0 +1,127 @@ +---@meta _ +C_ItemUpgrade = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.CanUpgradeItem) +---@param baseItem ItemLocation +---@return boolean isValid +function C_ItemUpgrade.CanUpgradeItem(baseItem) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.ClearItemUpgrade) +function C_ItemUpgrade.ClearItemUpgrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.CloseItemUpgrade) +function C_ItemUpgrade.CloseItemUpgrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetHighWatermarkForItem) +---@param itemInfo ItemInfo +---@return number characterHighWatermark +---@return number accountHighWatermark +function C_ItemUpgrade.GetHighWatermarkForItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetHighWatermarkForSlot) +---@param itemRedundancySlot number +---@return number characterHighWatermark +---@return number accountHighWatermark +function C_ItemUpgrade.GetHighWatermarkForSlot(itemRedundancySlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetHighWatermarkSlotForItem) +---@param itemInfo ItemInfo +---@return number itemRedundancySlot +function C_ItemUpgrade.GetHighWatermarkSlotForItem(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetItemHyperlink) +---@return string link +function C_ItemUpgrade.GetItemHyperlink() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetItemUpgradeCurrentLevel) +---@return number itemLevel +---@return boolean isPvpItemLevel +function C_ItemUpgrade.GetItemUpgradeCurrentLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetItemUpgradeEffect) +---@param effectIndex number +---@param numUpgradeLevels? number +---@return string outBaseEffect +---@return string outUpgradedEffect +function C_ItemUpgrade.GetItemUpgradeEffect(effectIndex, numUpgradeLevels) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetItemUpgradeItemInfo) +---@return ItemUpgradeItemInfo itemInfo +function C_ItemUpgrade.GetItemUpgradeItemInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetItemUpgradePvpItemLevelDeltaValues) +---@param numUpgradeLevels number +---@return number currentPvPItemLevel +---@return number upgradedPvPItemLevel +function C_ItemUpgrade.GetItemUpgradePvpItemLevelDeltaValues(numUpgradeLevels) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.GetNumItemUpgradeEffects) +---@return number numItemUpgradeEffects +function C_ItemUpgrade.GetNumItemUpgradeEffects() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.IsItemBound) +---@return boolean isBound +function C_ItemUpgrade.IsItemBound() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.SetItemUpgradeFromCursorItem) +function C_ItemUpgrade.SetItemUpgradeFromCursorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.SetItemUpgradeFromLocation) +---@param itemToSet ItemLocation +function C_ItemUpgrade.SetItemUpgradeFromLocation(itemToSet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ItemUpgrade.UpgradeItem) +---@param numUpgrades? number Default = 1 +function C_ItemUpgrade.UpgradeItem(numUpgrades) end + +---@class ItemUpgradeCostDiscountInfo +---@field isDiscounted boolean +---@field discountHighWatermark number +---@field isPartialTwoHandDiscount boolean +---@field isAccountWideDiscount boolean +---@field doesCurrentCharacterMeetHighWatermark boolean + +---@class ItemUpgradeCurrencyCost +---@field cost number +---@field currencyID number +---@field discountInfo ItemUpgradeCostDiscountInfo + +---@class ItemUpgradeItemCost +---@field cost number +---@field itemID number +---@field discountInfo ItemUpgradeCostDiscountInfo + +---@class ItemUpgradeItemInfo +---@field iconID number +---@field name string +---@field itemUpgradeable boolean +---@field displayQuality number +---@field highWatermarkSlot number +---@field currUpgrade number +---@field maxUpgrade number +---@field minItemLevel number +---@field maxItemLevel number +---@field upgradeLevelInfos ItemUpgradeLevelInfo[] +---@field customUpgradeString string? +---@field upgradeCostTypesForSeason ItemUpgradeSeasonalCostType[] + +---@class ItemUpgradeLevelInfo +---@field upgradeLevel number +---@field displayQuality number +---@field itemLevelIncrement number +---@field levelStats ItemUpgradeStat[] +---@field currencyCostsToUpgrade ItemUpgradeCurrencyCost[] +---@field itemCostsToUpgrade ItemUpgradeItemCost[] +---@field moneyCost WOWMONEY? +---@field failureMessage string? + +---@class ItemUpgradeSeasonalCostType +---@field itemID number? +---@field currencyID number? +---@field orderIndex number +---@field sourceString string? + +---@class ItemUpgradeStat +---@field displayString string +---@field statValue number +---@field active boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua new file mode 100644 index 0000000..73c91f3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua @@ -0,0 +1,56 @@ +---@meta _ +C_KeyBindings = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.ActivateBindingContext) +---@param newContext Enum.BindingContext +function C_KeyBindings.ActivateBindingContext(newContext) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.DeactivateBindingContext) +---@param context Enum.BindingContext +function C_KeyBindings.DeactivateBindingContext(context) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.GetBindingByKey) +---@param action string +---@param context? Enum.BindingContext +---@return string binding +function C_KeyBindings.GetBindingByKey(action, context) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.GetBindingContextForAction) +---@param action string +---@return Enum.BindingContext? context +function C_KeyBindings.GetBindingContextForAction(action) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.GetBindingIndex) +---@param action string +---@return number? bindingIndex +function C_KeyBindings.GetBindingIndex(action) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.GetCustomBindingType) +---@param bindingIndex number +---@return Enum.CustomBindingType? customBindingType +function C_KeyBindings.GetCustomBindingType(bindingIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.GetSearchTagsForAction) +---@param action string +---@return string[]? searchTags +function C_KeyBindings.GetSearchTagsForAction(action) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.GetTurnStrafeStyle) +---@return Enum.TurnStrafeStyle style +function C_KeyBindings.GetTurnStrafeStyle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.IsBindingContextActive) +---@param context Enum.BindingContext +---@return boolean isActive +function C_KeyBindings.IsBindingContextActive(context) end + +---Can only set to Modern or Legacy. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.SetTurnStrafeStyle) +---@param style Enum.TurnStrafeStyle +function C_KeyBindings.SetTurnStrafeStyle(style) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_KeyBindings.UpdateTurnStrafeBindingsForCharacter) +function C_KeyBindings.UpdateTurnStrafeBindingsForCharacter() end + +---@alias InputCommandCallback FunctionContainer|fun(keystate: string) diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua new file mode 100644 index 0000000..05b3ab7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua @@ -0,0 +1,5 @@ +---@meta _ +---@class LFGRoles +---@field tank boolean +---@field healer boolean +---@field dps boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua new file mode 100644 index 0000000..6a0380e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua @@ -0,0 +1,111 @@ +---@meta _ +C_LFGInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.AreCrossFactionGroupQueuesAllowed) +---@param lfgDungeonID number +---@return boolean areCrossFactionGroupQueuesAllowed +function C_LFGInfo.AreCrossFactionGroupQueuesAllowed(lfgDungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.CanPlayerUseGroupFinder) +---@return boolean canUse +---@return string failureReason +function C_LFGInfo.CanPlayerUseGroupFinder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.CanPlayerUseLFD) +---@return boolean canUse +---@return string failureReason +function C_LFGInfo.CanPlayerUseLFD() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.CanPlayerUseLFR) +---@return boolean canUse +---@return string failureReason +function C_LFGInfo.CanPlayerUseLFR() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.CanPlayerUsePVP) +---@return boolean canUse +---@return string failureReason +function C_LFGInfo.CanPlayerUsePVP() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.CanPlayerUsePremadeGroup) +---@return boolean canUse +---@return string failureReason +function C_LFGInfo.CanPlayerUsePremadeGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.CanPlayerUseScenarioFinder) +---@return boolean canUse +---@return string failureReason +function C_LFGInfo.CanPlayerUseScenarioFinder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.ConfirmLfgExpandSearch) +function C_LFGInfo.ConfirmLfgExpandSearch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.DoesActivePartyMeetPremadeLaunchCount) +---@param lfgDungeonID number +---@return boolean doesActivePartyMeetPremadeLaunchCount +function C_LFGInfo.DoesActivePartyMeetPremadeLaunchCount(lfgDungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.DoesCrossFactionQueueRequireFullPremade) +---@param lfgDungeonID number +---@return boolean doesCrossFactionQueueRequireFullPremade +function C_LFGInfo.DoesCrossFactionQueueRequireFullPremade(lfgDungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.GetAllEntriesForCategory) +---@param category number +---@return number[] lfgDungeonIDs +function C_LFGInfo.GetAllEntriesForCategory(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.GetDungeonInfo) +---@param lfgDungeonID number +---@return LFGDungeonInfo dungeonInfo +function C_LFGInfo.GetDungeonInfo(lfgDungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.GetLFDLockStates) +---@return LFGLockInfo[] lockInfo +function C_LFGInfo.GetLFDLockStates() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.GetLevelUpInstances) +---@param currPlayerLevel number +---@param isRaid boolean +---@return number[] instances +function C_LFGInfo.GetLevelUpInstances(currPlayerLevel, isRaid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.GetRoleCheckDifficultyDetails) +---@return number? maxLevel +---@return boolean isLevelReduced +function C_LFGInfo.GetRoleCheckDifficultyDetails() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.HideNameFromUI) +---@param dungeonID number +---@return boolean shouldHide +function C_LFGInfo.HideNameFromUI(dungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.IsGroupFinderEnabled) +---@return boolean enabled +function C_LFGInfo.IsGroupFinderEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.IsInLFGFollowerDungeon) +---@return boolean result +function C_LFGInfo.IsInLFGFollowerDungeon() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.IsLFDEnabled) +---@return boolean enabled +function C_LFGInfo.IsLFDEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.IsLFGFollowerDungeon) +---@param dungeonID number +---@return boolean result +function C_LFGInfo.IsLFGFollowerDungeon(dungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGInfo.IsLFREnabled) +---@return boolean enabled +function C_LFGInfo.IsLFREnabled() end + +---@class LFGDungeonInfo +---@field name string +---@field iconID fileID +---@field link string? + +---@class LFGLockInfo +---@field lfgID number +---@field reason number +---@field hideEntry boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua new file mode 100644 index 0000000..dd6ba49 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua @@ -0,0 +1,415 @@ +---@meta _ +C_LFGList = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CanActiveEntryUseAutoAccept) +---@return boolean canUseAutoAccept +function C_LFGList.CanActiveEntryUseAutoAccept() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CanCreateQuestGroup) +---@param questID number +---@return boolean canCreate +function C_LFGList.CanCreateQuestGroup(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CanCreateScenarioGroup) +---@param scenarioID number +---@return boolean canCreate +function C_LFGList.CanCreateScenarioGroup(scenarioID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ClearApplicationTextFields) +function C_LFGList.ClearApplicationTextFields() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ClearCreationTextFields) +function C_LFGList.ClearCreationTextFields() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ClearSearchTextFields) +function C_LFGList.ClearSearchTextFields() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CopyActiveEntryInfoToCreationFields) +function C_LFGList.CopyActiveEntryInfoToCreationFields() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CreateListing) +---@param createData LfgListingCreateData +---@return boolean success +function C_LFGList.CreateListing(createData) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CreateScenarioListing) +---@param activityID number +---@param itemLevel number +---@param autoAccept boolean +---@param privateGroup boolean +---@param scenarioID number +---@return boolean canCreate +function C_LFGList.CreateScenarioListing(activityID, itemLevel, autoAccept, privateGroup, scenarioID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.DoesEntryTitleMatchPrebuiltTitle) +---@param activityID number +---@param groupID number +---@param playstyle? Enum.LFGEntryPlaystyle +---@param generalPlaystyle? Enum.LFGEntryGeneralPlaystyle +---@return boolean matches +function C_LFGList.DoesEntryTitleMatchPrebuiltTitle(activityID, groupID, playstyle, generalPlaystyle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetActiveEntryInfo) +---@return LfgEntryData entryData +function C_LFGList.GetActiveEntryInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetActivityFullName) +---@param activityID number +---@param questID? number +---@param showWarmode? boolean +---@return string fullName +function C_LFGList.GetActivityFullName(activityID, questID, showWarmode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetActivityGroupInfo) +---@param groupID number +---@return string name +---@return number orderIndex +function C_LFGList.GetActivityGroupInfo(groupID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetActivityInfoTable) +---@param activityID number +---@param questID? number +---@param showWarmode? boolean +---@return GroupFinderActivityInfo activityInfo +function C_LFGList.GetActivityInfoTable(activityID, questID, showWarmode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetAdvancedFilter) +---@return AdvancedFilterOptions options +function C_LFGList.GetAdvancedFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicantBestDungeonScore) +---@param localID number +---@param applicantIndex number +---@return BestDungeonScoreMapInfo bestDungeonScoreForListing +function C_LFGList.GetApplicantBestDungeonScore(localID, applicantIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicantDungeonScoreForListing) +---@param localID number +---@param applicantIndex number +---@param activityID number +---@return BestDungeonScoreMapInfo bestDungeonScoreForListing +function C_LFGList.GetApplicantDungeonScoreForListing(localID, applicantIndex, activityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicantInfo) +---@param applicantID number +---@return LfgApplicantData applicantData +function C_LFGList.GetApplicantInfo(applicantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicantPvpRatingInfoForListing) +---@param localID number +---@param applicantIndex number +---@param activityID number +---@return PvpRatingInfo pvpRatingInfo +function C_LFGList.GetApplicantPvpRatingInfoForListing(localID, applicantIndex, activityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetAvailableActivityGroups) +---@param categoryID number +---@param filter? number Default = 0 +---@return number[] activityIDs +function C_LFGList.GetAvailableActivityGroups(categoryID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetFilteredSearchResults) +---@return number? totalResultsFound Default = 0 +---@return number[] filteredResults +function C_LFGList.GetFilteredSearchResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetGroupLeaverCountsByRole) +---@return number tankLeavers +---@return number healerLeavers +---@return number damageLeavers +function C_LFGList.GetGroupLeaverCountsByRole() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetKeystoneForActivity) +---@param activityID number +---@return number level +function C_LFGList.GetKeystoneForActivity(activityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetLfgCategoryInfo) +---@param categoryID number +---@return LfgCategoryData categoryData +function C_LFGList.GetLfgCategoryInfo(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetOwnedKeystoneActivityAndGroupAndLevel) +---@param getTimewalking? boolean Default = false +---@return number activityID +---@return number groupID +---@return number keystoneLevel +function C_LFGList.GetOwnedKeystoneActivityAndGroupAndLevel(getTimewalking) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetPlaystyleString) +---@param playstyle Enum.LFGEntryPlaystyle +---@param generalPlaystyle Enum.LFGEntryGeneralPlaystyle +---@param activityInfo GroupFinderActivityInfo +---@return string playstyleString +function C_LFGList.GetPlaystyleString(playstyle, generalPlaystyle, activityInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetPremadeGroupFinderStyle) +---@return Enum.PremadeGroupFinderStyle style +function C_LFGList.GetPremadeGroupFinderStyle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResultInfo) +---@param searchResultID number +---@return LfgSearchResultData searchResultData +function C_LFGList.GetSearchResultInfo(searchResultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResultLeaderInfo) +---@param searchResultID number +---@return LfgSearchResultPlayerInfo leaderInfo +function C_LFGList.GetSearchResultLeaderInfo(searchResultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResultPlayerInfo) +---@param searchResultID number +---@param memberIndex number +---@return LfgSearchResultPlayerInfo playerInfo +function C_LFGList.GetSearchResultPlayerInfo(searchResultID, memberIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResults) +---@return number? totalResultsFound Default = 0 +---@return number[] results +function C_LFGList.GetSearchResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.HasActiveEntryInfo) +---@return boolean hasActiveEntryInfo +function C_LFGList.HasActiveEntryInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.HasSearchResultInfo) +---@param searchResultID number +---@return boolean hasSearchResultInfo +function C_LFGList.HasSearchResultInfo(searchResultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.IsPlayerAuthenticatedForLFG) +---@param activityCategoryID? number +---@return boolean isAuthenticated +function C_LFGList.IsPlayerAuthenticatedForLFG(activityCategoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.IsPlayerValidForEndgameFieldEdits) +---@return boolean isValid +function C_LFGList.IsPlayerValidForEndgameFieldEdits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.IsPremadeGroupFinderEnabled) +---@return boolean enabled +function C_LFGList.IsPremadeGroupFinderEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ListingUsesEndgameEditRestrictions) +---@param activityID number +---@return boolean isEndgameListing +function C_LFGList.ListingUsesEndgameEditRestrictions(activityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ReportGroupAsAdvertisement) +---@param searchResultID number +function C_LFGList.ReportGroupAsAdvertisement(searchResultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SaveAdvancedFilter) +---@param options AdvancedFilterOptions +function C_LFGList.SaveAdvancedFilter(options) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.Search) +---@param categoryID number +---@param filter? number Default = 0 +---@param preferredFilters? number Default = 0 +---@param languageFilter? WowLocale +---@param searchCrossFactionListings? boolean Default = false +---@param advancedFilter? AdvancedFilterOptions +---@param activityIDsFilter? number[] +function C_LFGList.Search(categoryID, filter, preferredFilters, languageFilter, searchCrossFactionListings, advancedFilter, activityIDsFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SetEntryTitle) +---@param activityID number +---@param groupID number +---@param playstyle? Enum.LFGEntryPlaystyle +---@param generalPlaystyle? Enum.LFGEntryGeneralPlaystyle +function C_LFGList.SetEntryTitle(activityID, groupID, playstyle, generalPlaystyle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SetSearchToActivity) +---@param activityID number +function C_LFGList.SetSearchToActivity(activityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SetSearchToQuestID) +---@param questID number +function C_LFGList.SetSearchToQuestID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SetSearchToScenarioID) +---@param scenarioID number +function C_LFGList.SetSearchToScenarioID(scenarioID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.UpdateListing) +---@param createData LfgListingCreateData +---@return boolean success +function C_LFGList.UpdateListing(createData) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ValidateRequiredDungeonScore) +---@param dungeonScore number +---@return boolean passes +function C_LFGList.ValidateRequiredDungeonScore(dungeonScore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ValidateRequiredPvpRatingForActivity) +---@param activityID number +---@param rating number +---@return boolean passes +function C_LFGList.ValidateRequiredPvpRatingForActivity(activityID, rating) end + +---@class AdvancedFilterOptions +---@field needsTank boolean? Default = false +---@field needsHealer boolean? Default = false +---@field needsDamage boolean? Default = false +---@field needsMyClass boolean? Default = false +---@field hasTank boolean? Default = false +---@field hasHealer boolean? Default = false +---@field activities number[] +---@field minimumRating number? Default = 0 +---@field difficultyNormal boolean? Default = false +---@field difficultyHeroic boolean? Default = false +---@field difficultyMythic boolean? Default = false +---@field difficultyMythicPlus boolean? Default = false +---@field generalPlaystyle1 boolean? Default = false +---@field generalPlaystyle2 boolean? Default = false +---@field generalPlaystyle3 boolean? Default = false +---@field generalPlaystyle4 boolean? Default = false + +---@class BestDungeonScoreMapInfo +---@field mapScore number +---@field mapName string +---@field bestRunLevel number +---@field finishedSuccess boolean +---@field bestRunDurationMs number +---@field bestLevelIncrement number + +---@class GroupFinderActivityInfo +---@field fullName string +---@field shortName string +---@field categoryID number +---@field groupFinderActivityGroupID number +---@field ilvlSuggestion number +---@field filters number +---@field minLevel number +---@field minLevelSuggestion number +---@field maxLevelSuggestion number +---@field maxNumPlayers number +---@field displayType Enum.LFGListDisplayType +---@field orderIndex number +---@field useHonorLevel boolean +---@field showQuickJoinToast boolean +---@field isMythicPlusActivity boolean +---@field isRatedPvpActivity boolean +---@field isCurrentRaidActivity boolean +---@field isPvpActivity boolean +---@field isMythicActivity boolean +---@field allowCrossFaction boolean +---@field isHeroicActivity boolean +---@field isNormalActivity boolean +---@field mapID number +---@field difficultyID number +---@field redirectedDifficultyID number +---@field useDungeonRoleExpectations boolean + +---@class LfgApplicantData +---@field applicantID number +---@field applicationStatus string +---@field pendingApplicationStatus string? +---@field numMembers number +---@field isNew boolean +---@field comment kstringLfgListApplicant +---@field displayOrderID number + +---@class LfgCategoryData +---@field name string +---@field searchPromptOverride string? +---@field separateRecommended boolean +---@field autoChooseActivity boolean +---@field preferCurrentArea boolean +---@field showPlaystyleDropdown boolean +---@field allowCrossFaction boolean + +---@class LfgEntryData +---@field activityIDs number[] +---@field requiredItemLevel number +---@field requiredHonorLevel number +---@field name kstringLfgListApplicant +---@field comment kstringLfgListApplicant +---@field voiceChat kstringLfgListApplicant +---@field duration time_t +---@field autoAccept boolean +---@field privateGroup boolean +---@field questID number? +---@field requiredDungeonScore number? +---@field requiredPvpRating number? +---@field playstyle Enum.LFGEntryPlaystyle? +---@field generalPlaystyle Enum.LFGEntryGeneralPlaystyle? +---@field isCrossFactionListing boolean +---@field newPlayerFriendly boolean + +---@class LfgListingCreateData +---@field activityIDs number[] +---@field questID number? +---@field isAutoAccept boolean? Default = false +---@field isCrossFactionListing boolean? Default = false +---@field isPrivateGroup boolean? Default = false +---@field newPlayerFriendly boolean? Default = false +---@field playstyle Enum.LFGEntryPlaystyle? Default = None +---@field generalPlaystyle Enum.LFGEntryGeneralPlaystyle? Default = None +---@field requiredDungeonScore number? Default = 0 +---@field requiredItemLevel number? Default = 0 +---@field requiredPvpRating number? Default = 0 + +---@class LfgSearchResultData +---@field searchResultID number +---@field activityIDs number[] +---@field leaderName string? +---@field name kstringLfgListSearch +---@field comment kstringLfgListSearch +---@field voiceChat kstringLfgListSearch +---@field requiredItemLevel number +---@field requiredHonorLevel number +---@field hasSelf boolean +---@field numMembers number +---@field numBNetFriends number +---@field numCharFriends number +---@field numGuildMates number +---@field isDelisted boolean +---@field autoAccept boolean +---@field isWarMode boolean +---@field age time_t +---@field questID number? +---@field leaderOverallDungeonScore number? +---@field leaderDungeonScoreInfo BestDungeonScoreMapInfo[] +---@field leaderBestDungeonScoreInfo BestDungeonScoreMapInfo? +---@field leaderPvpRatingInfo PvpRatingInfo[] +---@field requiredDungeonScore number? +---@field requiredPvpRating number? +---@field playstyle Enum.LFGEntryPlaystyle? +---@field generalPlaystyle Enum.LFGEntryGeneralPlaystyle? +---@field crossFactionListing boolean? +---@field leaderFactionGroup number +---@field newPlayerFriendly boolean? +---@field partyGUID WOWGUID + +---@class LfgSearchResultPlayerInfo +---@field name string? +---@field level number? +---@field areaName string? +---@field className string +---@field classFilename string +---@field specName string? +---@field assignedRole string +---@field lfgRoles LFGRoles +---@field isLeader boolean +---@field isLeaver boolean? Default = false + +---@class PvpRatingInfo +---@field bracket number +---@field rating number +---@field activityName string +---@field tier number + +---@class WowLocale +---@field enUS boolean? Default = false +---@field koKR boolean? Default = false +---@field frFR boolean? Default = false +---@field deDE boolean? Default = false +---@field zhCN boolean? Default = false +---@field zhTW boolean? Default = false +---@field esES boolean? Default = false +---@field esMX boolean? Default = false +---@field ruRU boolean? Default = false +---@field ptBR boolean? Default = false +---@field itIT boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua new file mode 100644 index 0000000..cde4ac5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua @@ -0,0 +1,111 @@ +---@meta _ +C_LegendaryCrafting = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.CloseRuneforgeInteraction) +function C_LegendaryCrafting.CloseRuneforgeInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.CraftRuneforgeLegendary) +---@param description RuneforgeLegendaryCraftDescription +function C_LegendaryCrafting.CraftRuneforgeLegendary(description) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeItemPreviewInfo) +---@param baseItem ItemLocation +---@param runeforgePowerID? number +---@param modifiers? number[] +---@return RuneforgeItemPreviewInfo? info +function C_LegendaryCrafting.GetRuneforgeItemPreviewInfo(baseItem, runeforgePowerID, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo) +---@param runeforgeLegendary ItemLocation +---@return RuneforgeLegendaryComponentInfo componentInfo +function C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo(runeforgeLegendary) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeLegendaryCost) +---@param baseItem ItemLocation +---@return CurrencyCost[] cost +function C_LegendaryCrafting.GetRuneforgeLegendaryCost(baseItem) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID) +---@return number spellID +function C_LegendaryCrafting.GetRuneforgeLegendaryCraftSpellID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies) +---@return number[] currencies +function C_LegendaryCrafting.GetRuneforgeLegendaryCurrencies() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost) +---@param runeforgeLegendary ItemLocation +---@param upgradeItem ItemLocation +---@return CurrencyCost[] cost +function C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost(runeforgeLegendary, upgradeItem) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeModifierInfo) +---@param baseItem ItemLocation +---@param powerID? number +---@param addedModifierIndex number +---@param modifiers number[] +---@return string name +---@return string[] description +function C_LegendaryCrafting.GetRuneforgeModifierInfo(baseItem, powerID, addedModifierIndex, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgeModifiers) +---@return number[] modifiedReagentItemIDs +function C_LegendaryCrafting.GetRuneforgeModifiers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgePowerInfo) +---@param runeforgePowerID number +---@return RuneforgePower power +function C_LegendaryCrafting.GetRuneforgePowerInfo(runeforgePowerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgePowerSlots) +---@param runeforgePowerID number +---@return string[] slotNames +function C_LegendaryCrafting.GetRuneforgePowerSlots(runeforgePowerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgePowers) +---@param baseItem? ItemLocation +---@param filter? Enum.RuneforgePowerFilter +---@return number[] primaryRuneforgePowerIDs +---@return number[] otherRuneforgePowerIDs +function C_LegendaryCrafting.GetRuneforgePowers(baseItem, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.GetRuneforgePowersByClassSpecAndCovenant) +---@param classID? number +---@param specID? number +---@param covenantID? number +---@param filter? Enum.RuneforgePowerFilter +---@return number[] runeforgePowerIDs +function C_LegendaryCrafting.GetRuneforgePowersByClassSpecAndCovenant(classID, specID, covenantID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.IsRuneforgeLegendary) +---@param item ItemLocation +---@return boolean isRuneforgeLegendary +function C_LegendaryCrafting.IsRuneforgeLegendary(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel) +---@param runeforgeLegendary ItemLocation +---@return boolean isMaxLevel +function C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel(runeforgeLegendary) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary) +---@param runeforgeLegendary ItemLocation +---@param upgradeItem ItemLocation +---@return boolean isValid +function C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary(runeforgeLegendary, upgradeItem) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.IsValidRuneforgeBaseItem) +---@param baseItem ItemLocation +---@return boolean isValid +function C_LegendaryCrafting.IsValidRuneforgeBaseItem(baseItem) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.MakeRuneforgeCraftDescription) +---@param baseItem ItemLocation +---@param runeforgePowerID number +---@param modifiers number[] +---@return RuneforgeLegendaryCraftDescription description +function C_LegendaryCrafting.MakeRuneforgeCraftDescription(baseItem, runeforgePowerID, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LegendaryCrafting.UpgradeRuneforgeLegendary) +---@param runeforgeLegendary ItemLocation +---@param upgradeItem ItemLocation +function C_LegendaryCrafting.UpgradeRuneforgeLegendary(runeforgeLegendary, upgradeItem) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua new file mode 100644 index 0000000..93171fc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua @@ -0,0 +1,32 @@ +---@meta _ +---@class CurrencyCost +---@field currencyID number +---@field amount number + +---@class RuneforgeItemPreviewInfo +---@field itemGUID WOWGUID +---@field itemLevel number +---@field itemName string + +---@class RuneforgeLegendaryComponentInfo +---@field powerID number +---@field modifiers number[] + +---@class RuneforgeLegendaryCraftDescription +---@field baseItem ItemLocation +---@field runeforgePowerID number +---@field modifiers number[] + +---@class RuneforgePower +---@field runeforgePowerID number +---@field state Enum.RuneforgePowerState +---@field name string +---@field descriptionSpellID number +---@field description string +---@field source string? +---@field iconFileID fileID +---@field specName string? +---@field matchesSpec boolean +---@field matchesCovenant boolean +---@field covenantID number? +---@field slots string[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua new file mode 100644 index 0000000..4e82174 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua @@ -0,0 +1,12 @@ +---@meta _ +C_LevelLink = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LevelLink.IsActionLocked) +---@param actionID number +---@return boolean isLocked +function C_LevelLink.IsActionLocked(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LevelLink.IsSpellLocked) +---@param spellID number +---@return boolean isLocked +function C_LevelLink.IsSpellLocked(spellID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua new file mode 100644 index 0000000..0501621 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +C_LevelSquish = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LevelSquish.ConvertFollowerLevel) +---@param level number +---@param maxFollowerLevel number +---@return number squishedLevel +function C_LevelSquish.ConvertFollowerLevel(level, maxFollowerLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LevelSquish.ConvertPlayerLevel) +---@param level number +---@return number squishedLevel +function C_LevelSquish.ConvertPlayerLevel(level) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua new file mode 100644 index 0000000..6492577 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +C_LimitedInput = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LimitedInput.LimitedInputAllowed) +---@param type Enum.LimitedInputType +---@return boolean allowed +function C_LimitedInput.LimitedInputAllowed(type) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua new file mode 100644 index 0000000..11b70ff --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +C_LiveEvent = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LiveEvent.OnLiveEventBannerClicked) +---@param timerunningSeasonID number +function C_LiveEvent.OnLiveEventBannerClicked(timerunningSeasonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LiveEvent.OnLiveEventPopupClicked) +---@param timerunningSeasonID number +function C_LiveEvent.OnLiveEventPopupClicked(timerunningSeasonID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua new file mode 100644 index 0000000..5cde635 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua @@ -0,0 +1,39 @@ +---@meta _ +C_LobbyMatchmakerInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.AbandonQueue) +function C_LobbyMatchmakerInfo.AbandonQueue() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.EnterQueue) +---@param playlistEntry Enum.PartyPlaylistEntry +function C_LobbyMatchmakerInfo.EnterQueue(playlistEntry) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.GetCurrQueuePlaylistEntry) +---@return Enum.PartyPlaylistEntry playlistEntry +function C_LobbyMatchmakerInfo.GetCurrQueuePlaylistEntry() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.GetCurrQueueState) +---@return Enum.PlunderstormQueueState queueState +function C_LobbyMatchmakerInfo.GetCurrQueueState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.GetQueueFromMainlineEnabled) +---@return boolean queueFromMainlineEnabled +function C_LobbyMatchmakerInfo.GetQueueFromMainlineEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.GetQueueStartTime) +---@return number queueStartTime +function C_LobbyMatchmakerInfo.GetQueueStartTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.IsInQueue) +---@return boolean isInQueue +function C_LobbyMatchmakerInfo.IsInQueue() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LobbyMatchmakerInfo.RespondToQueuePop) +---@param acceptQueue boolean +function C_LobbyMatchmakerInfo.RespondToQueuePop(acceptQueue) end + +---@class LobbyMatchmakerQueueInfo +---@field isQueueActive boolean? Default = false +---@field playlistEntryID Enum.PartyPlaylistEntry +---@field queueState Enum.PlunderstormQueueState +---@field queueStartTime number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua new file mode 100644 index 0000000..931e747 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua @@ -0,0 +1,26 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvailableLocaleInfo) +---@param ignoreLocaleRestrictions? boolean Default = false +---@return LocaleInfo[] localeInfos +function GetAvailableLocaleInfo(ignoreLocaleRestrictions) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvailableLocales) +---@param ignoreLocaleRestrictions? boolean Default = false +---@return string ... localeName +function GetAvailableLocales(ignoreLocaleRestrictions) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentRegion) +---@return number region +function GetCurrentRegion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLocale) +---@return string localeName +function GetLocale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetOSLocale) +---@return string localeName +function GetOSLocale() end + +---@class LocaleInfo +---@field localeId number +---@field localeName string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua new file mode 100644 index 0000000..852b020 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua @@ -0,0 +1,64 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AbbreviateLargeNumbers) +---@param number number +---@param options? NumberAbbrevOptions +---@return string result +function AbbreviateLargeNumbers(number, options) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AbbreviateNumbers) +---@param number number +---@param options? NumberAbbrevOptions +---@return string result +function AbbreviateNumbers(number, options) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BreakUpLargeNumbers) +---@param largeNumber number +---@param natural? boolean Default = false +---@return string result +function BreakUpLargeNumbers(largeNumber, natural) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CaseAccentInsensitiveParse) +---@param name string +---@return string result +function CaseAccentInsensitiveParse(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateAbbreviateConfig) +---@param data NumberAbbreviationBreakpoint[] +---@return AbbreviateConfig config +function CreateAbbreviateConfig(data) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineName) +---@param name string +---@param gender? Enum.UnitSex +---@param declensionSet number +---@return string ... declinedNames +function DeclineName(name, gender, declensionSet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDefaultAbbreviationBreakpoints) +---@param locale? WowLocale +---@return NumberAbbreviationBreakpoint[] breakpoints +function GetDefaultAbbreviationBreakpoints(locale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumDeclensionSets) +---@param name string +---@param gender? Enum.UnitSex +---@return number numDeclensionSets +function GetNumDeclensionSets(name, gender) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsEuropeanNumbers) +---@return boolean enabled +function IsEuropeanNumbers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LocalizedClassList) +---@param isFemale? boolean Default = false +---@return LuaValueVariant result +function LocalizedClassList(isFemale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetEuropeanNumbers) +---@param enabled boolean +function SetEuropeanNumbers(enabled) end + +---@class NumberAbbrevOptions +---@field breakpointData NumberAbbreviationBreakpoint[]? +---@field locale string? +---@field config AbbreviateConfig? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua new file mode 100644 index 0000000..9832041 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +---@class NumberAbbreviationBreakpoint +---@field breakpoint number +---@field abbreviation string +---@field significandDivisor number +---@field fractionDivisor number +---@field abbreviationIsGlobal boolean? Default = true diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LogDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LogDocumentation.lua new file mode 100644 index 0000000..593ec3f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LogDocumentation.lua @@ -0,0 +1,19 @@ +---@meta _ +C_Log = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Log.LogErrorMessage) +---@param message string +function C_Log.LogErrorMessage(message) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Log.LogMessage) +---@param message string +function C_Log.LogMessage(message) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Log.LogMessageWithPriority) +---@param priority Enum.LogPriority +---@param message string +function C_Log.LogMessageWithPriority(priority, message) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Log.LogWarningMessage) +---@param message string +function C_Log.LogWarningMessage(message) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootDocumentation.lua new file mode 100644 index 0000000..27baf99 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootDocumentation.lua @@ -0,0 +1,11 @@ +---@meta _ +C_Loot = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Loot.GetLootRollDuration) +---@param rollID number +---@return number? duration +function C_Loot.GetLootRollDuration(rollID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Loot.IsLegacyLootModeEnabled) +---@return boolean isLegacyLootModeEnabled +function C_Loot.IsLegacyLootModeEnabled() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua new file mode 100644 index 0000000..cc47c54 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua @@ -0,0 +1,57 @@ +---@meta _ +C_LootHistory = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootHistory.GetAllEncounterInfos) +---@return EncounterLootInfo[] infos +function C_LootHistory.GetAllEncounterInfos() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootHistory.GetInfoForEncounter) +---@param encounterID number +---@return EncounterLootInfo? info +function C_LootHistory.GetInfoForEncounter(encounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootHistory.GetLootHistoryTime) +---@return number time +function C_LootHistory.GetLootHistoryTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootHistory.GetSortedDropsForEncounter) +---@param encounterID number +---@return EncounterLootDropInfo[]? drops +function C_LootHistory.GetSortedDropsForEncounter(encounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootHistory.GetSortedInfoForDrop) +---@param encounterID number +---@param lootListID number +---@return EncounterLootDropInfo? info +function C_LootHistory.GetSortedInfoForDrop(encounterID, lootListID) end + +---@class EncounterLootDropInfo +---@field lootListID number +---@field itemHyperlink string +---@field playerRollState Enum.EncounterLootDropRollState +---@field currentLeader EncounterLootDropRollInfo? +---@field isTied boolean? Default = false +---@field winner EncounterLootDropRollInfo? +---@field allPassed boolean? Default = false +---@field rollInfos EncounterLootDropRollInfo[] +---@field startTime number +---@field duration number + +---@class EncounterLootDropRollInfo +---@field playerName string +---@field playerGUID WOWGUID +---@field playerClass string +---@field isSelf boolean +---@field state Enum.EncounterLootDropRollState +---@field isWinner boolean? Default = false +---@field roll number? + +---@class EncounterLootDrops +---@field encounterID number +---@field drops EncounterLootDropInfo[] + +---@class EncounterLootInfo +---@field encounterName string +---@field encounterID number +---@field startTime number +---@field duration number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua new file mode 100644 index 0000000..15e319f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua @@ -0,0 +1,23 @@ +---@meta _ +C_LootJournal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootJournal.GetItemSetItems) +---@param setID number +---@return LootJournalItemInfo[] items +function C_LootJournal.GetItemSetItems(setID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LootJournal.GetItemSets) +---@param classID? number +---@param specID? number +---@return LootJournalItemSetInfo[] itemSets +function C_LootJournal.GetItemSets(classID, specID) end + +---@class LootJournalItemInfo +---@field itemID number +---@field icon fileID +---@field invType number + +---@class LootJournalItemSetInfo +---@field setID number +---@field itemLevel number +---@field name string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua new file mode 100644 index 0000000..760aee8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +C_LoreText = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LoreText.RequestLoreTextForCampaignID) +---@param campaignID number +function C_LoreText.RequestLoreTextForCampaignID(campaignID) end + +---@class LoreTextEntry +---@field text string +---@field isHeader boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua new file mode 100644 index 0000000..75aeb3e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +C_LossOfControl = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LossOfControl.GetActiveLossOfControlData) +---@param index number +---@return LossOfControlData? event +function C_LossOfControl.GetActiveLossOfControlData(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LossOfControl.GetActiveLossOfControlDataByUnit) +---@param unitToken UnitToken +---@param index number +---@return LossOfControlData? event +function C_LossOfControl.GetActiveLossOfControlDataByUnit(unitToken, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LossOfControl.GetActiveLossOfControlDataCount) +---@return number count +function C_LossOfControl.GetActiveLossOfControlDataCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LossOfControl.GetActiveLossOfControlDataCountByUnit) +---@param unitToken UnitToken +---@return number count +function C_LossOfControl.GetActiveLossOfControlDataCountByUnit(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LossOfControl.GetActiveLossOfControlDuration) +---@param unitToken UnitToken +---@param index number +---@return LuaDurationObject? duration +function C_LossOfControl.GetActiveLossOfControlDuration(unitToken, index) end + +---@class LossOfControlData +---@field locType string +---@field spellID number +---@field displayText string +---@field iconTexture number +---@field startTime number? +---@field timeRemaining number? +---@field duration number? +---@field lockoutSchool number +---@field priority number +---@field displayType number +---@field auraInstanceID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua new file mode 100644 index 0000000..ceb3c3c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua @@ -0,0 +1,36 @@ +---@meta _ +C_TableUtil = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TableUtil.count) +---@param table LuaValueReference +---@return number numTableNodes +---@return number numArrayNodes +---@return number maxArrayIndex +function C_TableUtil.count(table) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TableUtil.create) +---@param arraySizeHint number +---@param nodeSizeHint? number Default = 0 +---@return LuaValueReference table +function C_TableUtil.create(arraySizeHint, nodeSizeHint) end + +---Given two tables, finds the first index in the range (1, #t1) and (1, #t2) where two elements compare as inequal, or nil if no such elements are found. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TableUtil.FindIndexedMismatch) +---@param t1 LuaValueReference +---@param t2 LuaValueReference +---@return number? index +function C_TableUtil.FindIndexedMismatch(t1, t2) end + +---Marks a supplied table as frozen, preventing any modifications to its contents, or replacement of its metatable. If the table has a pre-existing metatable with a '__newindex' table or function, assignments will pass through without raising errors. For tainted code, only tables created by the same addon making this function call are permitted to be frozen. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TableUtil.freeze) +---@param table LuaValueReference +function C_TableUtil.freeze(table) end + +---Returns true if a table has been marked as frozen. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TableUtil.isfrozen) +---@param table LuaValueReference +---@return boolean frozen +function C_TableUtil.isfrozen(table) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua new file mode 100644 index 0000000..2a596b0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua @@ -0,0 +1,40 @@ +---@meta _ +C_MacOptions = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.AreOSShortcutsDisabled) +---@return boolean? osShortcutsDisabledCVar +---@return boolean osShortcutsDisabled +function C_MacOptions.AreOSShortcutsDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.GetGameBundleName) +---@return string result +function C_MacOptions.GetGameBundleName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.HasNewStyleInputMonitoring) +---@return boolean result +function C_MacOptions.HasNewStyleInputMonitoring() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.IsInputMonitoringEnabled) +---@return boolean result +function C_MacOptions.IsInputMonitoringEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.IsMicrophoneEnabled) +---@return boolean result +function C_MacOptions.IsMicrophoneEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.IsUniversalAccessEnabled) +---@return boolean result +function C_MacOptions.IsUniversalAccessEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.OpenInputMonitoring) +function C_MacOptions.OpenInputMonitoring() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.OpenMicrophoneRequestDialogue) +function C_MacOptions.OpenMicrophoneRequestDialogue() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.OpenUniversalAccess) +function C_MacOptions.OpenUniversalAccess() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MacOptions.SetOSShortcutsDisabled) +---@param disable boolean +function C_MacOptions.SetOSShortcutsDisabled(disable) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua new file mode 100644 index 0000000..dd65a58 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua @@ -0,0 +1,25 @@ +---@meta _ +C_Mail = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Mail.CanCheckInbox) +---@return boolean canCheckInbox +---@return number secondsUntilAllowed +function C_Mail.CanCheckInbox() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Mail.GetCraftingOrderMailInfo) +---@param inboxIndex number +---@return CraftingOrderMailInfo? info +function C_Mail.GetCraftingOrderMailInfo(inboxIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Mail.HasInboxMoney) +---@param inboxIndex number +---@return boolean inboxItemHasMoneyAttached +function C_Mail.HasInboxMoney(inboxIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Mail.IsCommandPending) +---@return boolean isCommandPending +function C_Mail.IsCommandPending() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Mail.SetOpeningAll) +---@param openingAll boolean +function C_Mail.SetOpeningAll(openingAll) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua new file mode 100644 index 0000000..06f9637 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua @@ -0,0 +1,119 @@ +---@meta _ +C_MajorFactions = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetCurrentRenownLevel) +---@param majorFactionID number +---@return number level +function C_MajorFactions.GetCurrentRenownLevel(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetMajorFactionData) +---@param majorFactionID number +---@return MajorFactionData? data +function C_MajorFactions.GetMajorFactionData(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetMajorFactionIDs) +---@param expansionID? number +---@return number[] majorFactionIDs +function C_MajorFactions.GetMajorFactionIDs(expansionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetMajorFactionRenownInfo) +---@param majorFactionID number +---@return MajorFactionRenownInfo? data +function C_MajorFactions.GetMajorFactionRenownInfo(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetRenownLevels) +---@param majorFactionID number +---@return MajorFactionRenownLevelInfo[] levels +function C_MajorFactions.GetRenownLevels(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetRenownNPCFactionID) +---@return number renownNPCFactionID +function C_MajorFactions.GetRenownNPCFactionID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.GetRenownRewardsForLevel) +---@param majorFactionID number +---@param renownLevel number +---@return MajorFactionRenownRewardInfo[] rewards +function C_MajorFactions.GetRenownRewardsForLevel(majorFactionID, renownLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.HasMaximumRenown) +---@param majorFactionID number +---@return boolean hasMaxRenown +function C_MajorFactions.HasMaximumRenown(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.IsMajorFactionHiddenFromExpansionPage) +---@param majorFactionID number +---@return boolean isHidden +function C_MajorFactions.IsMajorFactionHiddenFromExpansionPage(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.IsWeeklyRenownCapped) +---@param majorFactionID number +---@return boolean isWeeklyCapped +function C_MajorFactions.IsWeeklyRenownCapped(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.ShouldDisplayMajorFactionAsJourney) +---@param majorFactionID number +---@return boolean shouldDisplayMajorFactionAsJourney +function C_MajorFactions.ShouldDisplayMajorFactionAsJourney(majorFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MajorFactions.ShouldUseJourneyRewardTrack) +---@param majorFactionID number +---@return boolean shouldUseJourneyRewardTrack +function C_MajorFactions.ShouldUseJourneyRewardTrack(majorFactionID) end + +---@class MajorFactionData +---@field name string +---@field description string +---@field highlights RenownHighlightInfo[] +---@field factionID number +---@field expansionID number +---@field bountySetID number +---@field isUnlocked boolean +---@field useJourneyUnlockToast boolean +---@field unlockDescription string? +---@field uiPriority number +---@field renownLevel number +---@field maxLevel number +---@field renownReputationEarned number +---@field renownLevelThreshold number +---@field textureKit textureKit +---@field celebrationSoundKit number +---@field renownFanfareSoundKitID number +---@field factionFontColor DBColorExport? +---@field renownTrackLevelEffectID number? +---@field playerCompanionID number? + +---@class MajorFactionRenownInfo +---@field renownLevel number +---@field renownReputationEarned number +---@field renownLevelThreshold number + +---@class MajorFactionRenownLevelInfo +---@field factionID number +---@field level number +---@field locked boolean +---@field isMilestone boolean +---@field isCapstone boolean + +---@class MajorFactionRenownRewardInfo +---@field renownRewardID number +---@field uiOrder number +---@field isAccountUnlock boolean +---@field itemID number? +---@field spellID number? +---@field mountID number? +---@field transmogID number? +---@field transmogSetID number? +---@field titleMaskID number? +---@field transmogIllusionSourceID number? +---@field icon fileID? +---@field name string? +---@field description string? +---@field toastDescription string? +---@field rewardType number? +---@field isCollected boolean? + +---@class RenownHighlightInfo +---@field title string +---@field description string +---@field level number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapDocumentation.lua new file mode 100644 index 0000000..cf10cc6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapDocumentation.lua @@ -0,0 +1,277 @@ +---@meta _ +C_Map = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.CanSetUserWaypointOnMap) +---@param uiMapID number +---@return boolean canSet +function C_Map.CanSetUserWaypointOnMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.ClearUserWaypoint) +function C_Map.ClearUserWaypoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.CloseWorldMapInteraction) +function C_Map.CloseWorldMapInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetAreaInfo) +---@param areaID number +---@return string name +function C_Map.GetAreaInfo(areaID) end + +---Only works for the player and party members. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetBestMapForUnit) +---@param unitToken UnitToken +---@return number? uiMapID +function C_Map.GetBestMapForUnit(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetBountySetMaps) +---@param bountySetID number +---@return number[] mapIDs +function C_Map.GetBountySetMaps(bountySetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetFallbackWorldMapID) +---@return number uiMapID +function C_Map.GetFallbackWorldMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapArtBackgroundAtlas) +---@param uiMapID number +---@return textureAtlas atlasName +function C_Map.GetMapArtBackgroundAtlas(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapArtHelpTextPosition) +---@param uiMapID number +---@return Enum.MapCanvasPosition position +function C_Map.GetMapArtHelpTextPosition(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapArtID) +---@param uiMapID number +---@return number uiMapArtID +function C_Map.GetMapArtID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapArtLayerTextures) +---@param uiMapID number +---@param layerIndex number +---@return fileID[] textures +function C_Map.GetMapArtLayerTextures(uiMapID, layerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapArtLayers) +---@param uiMapID number +---@return UiMapLayerInfo[] layerInfo +function C_Map.GetMapArtLayers(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapArtZoneTextPosition) +---@param uiMapID number +---@return Enum.MapCanvasPosition position +function C_Map.GetMapArtZoneTextPosition(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapBannersForMap) +---@param uiMapID number +---@return MapBannerInfo[] mapBanners +function C_Map.GetMapBannersForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapChildrenInfo) +---@param uiMapID number +---@param mapType? Enum.UIMapType +---@param allDescendants? boolean +---@return UiMapDetails[] info +function C_Map.GetMapChildrenInfo(uiMapID, mapType, allDescendants) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapDisplayInfo) +---@param uiMapID number +---@return boolean hideIcons +function C_Map.GetMapDisplayInfo(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapGroupID) +---@param uiMapID number +---@return number uiMapGroupID +function C_Map.GetMapGroupID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapGroupMembersInfo) +---@param uiMapGroupID number +---@return UiMapGroupMemberInfo[] info +function C_Map.GetMapGroupMembersInfo(uiMapGroupID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapHighlightInfoAtPosition) +---@param uiMapID number +---@param x number +---@param y number +---@return fileID fileDataID +---@return textureAtlas atlasID +---@return number texturePercentageX +---@return number texturePercentageY +---@return number textureX +---@return number textureY +---@return number scrollChildX +---@return number scrollChildY +function C_Map.GetMapHighlightInfoAtPosition(uiMapID, x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapHighlightPulseInfo) +---@param uiMapID number +---@return fileID fileDataID +---@return textureAtlas atlasID +---@return number texturePercentageX +---@return number texturePercentageY +---@return number textureX +---@return number textureY +---@return number scrollChildX +---@return number scrollChildY +function C_Map.GetMapHighlightPulseInfo(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapInfo) +---@param uiMapID number +---@return UiMapDetails info +function C_Map.GetMapInfo(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapInfoAtPosition) +---@param uiMapID number +---@param x number +---@param y number +---@param ignoreZoneMapPositionData? boolean +---@return UiMapDetails info +function C_Map.GetMapInfoAtPosition(uiMapID, x, y, ignoreZoneMapPositionData) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapLevels) +---@param uiMapID number +---@return number playerMinLevel +---@return number playerMaxLevel +---@return number? petMinLevel Default = 0 +---@return number? petMaxLevel Default = 0 +function C_Map.GetMapLevels(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapLinksForMap) +---@param uiMapID number +---@return MapLinkInfo[] mapLinks +function C_Map.GetMapLinksForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapPosFromWorldPos) +---@param continentID number +---@param worldPosition vector2 +---@param overrideUiMapID? number +---@return number uiMapID +---@return vector2 mapPosition +function C_Map.GetMapPosFromWorldPos(continentID, worldPosition, overrideUiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapRectOnMap) +---@param uiMapID number +---@param topUiMapID number +---@return number minX +---@return number maxX +---@return number minY +---@return number maxY +function C_Map.GetMapRectOnMap(uiMapID, topUiMapID) end + +---Returns the size in yards of the area represented by the map. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetMapWorldSize) +---@param uiMapID number +---@return number width +---@return number height +function C_Map.GetMapWorldSize(uiMapID) end + +---Only works for the player and party members. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetPlayerMapPosition) +---@param uiMapID number +---@param unitToken UnitToken +---@return vector2? position +function C_Map.GetPlayerMapPosition(uiMapID, unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetUserWaypoint) +---@return UiMapPoint point +function C_Map.GetUserWaypoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetUserWaypointFromHyperlink) +---@param hyperlink string +---@return UiMapPoint point +function C_Map.GetUserWaypointFromHyperlink(hyperlink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetUserWaypointHyperlink) +---@return string hyperlink +function C_Map.GetUserWaypointHyperlink() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetUserWaypointPositionForMap) +---@param uiMapID number +---@return vector2 mapPosition +function C_Map.GetUserWaypointPositionForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.GetWorldPosFromMapPos) +---@param uiMapID number +---@param mapPosition vector2 +---@return number continentID +---@return vector2 worldPosition +function C_Map.GetWorldPosFromMapPos(uiMapID, mapPosition) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.HasUserWaypoint) +---@return boolean hasUserWaypoint +function C_Map.HasUserWaypoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.IsCityMap) +---@param uiMapID number +---@return boolean isCityMap +function C_Map.IsCityMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.IsMapValidForNavBarDropdown) +---@param uiMapID number +---@return boolean isValid +function C_Map.IsMapValidForNavBarDropdown(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.MapHasArt) +---@param uiMapID number +---@return boolean hasArt +function C_Map.MapHasArt(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.OpenWorldMap) +---@param uiMapID? number +function C_Map.OpenWorldMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.RequestPreloadMap) +---@param uiMapID number +function C_Map.RequestPreloadMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Map.SetUserWaypoint) +---@param point UiMapPoint +function C_Map.SetUserWaypoint(point) end + +---@class MapBannerInfo +---@field areaPoiID number +---@field name string +---@field atlasName string +---@field uiTextureKit textureKit? + +---@class MapLinkInfo +---@field areaPoiID number +---@field position vector2 +---@field name string +---@field atlasName string +---@field linkedUiMapID number + +---@class UiMapDetails +---@field mapID number +---@field name string +---@field mapType Enum.UIMapType +---@field parentMapID number +---@field flags Enum.UIMapFlag + +---@class UiMapGroupMemberInfo +---@field mapID number +---@field relativeHeightIndex number +---@field name string + +---@class UiMapHighlightInfo +---@field fileDataID fileID +---@field atlasID textureAtlas +---@field texturePercentageX number +---@field texturePercentageY number +---@field textureX number +---@field textureY number +---@field scrollChildX number +---@field scrollChildY number + +---@class UiMapLayerInfo +---@field layerWidth number +---@field layerHeight number +---@field tileWidth number +---@field tileHeight number +---@field minScale number +---@field maxScale number +---@field additionalZoomSteps number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua new file mode 100644 index 0000000..cee09d3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua @@ -0,0 +1,29 @@ +---@meta _ +C_MapExplorationInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MapExplorationInfo.GetExploredAreaIDsAtPosition) +---@param uiMapID number +---@param normalizedPosition vector2 +---@return number[]? areaID +function C_MapExplorationInfo.GetExploredAreaIDsAtPosition(uiMapID, normalizedPosition) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MapExplorationInfo.GetExploredMapTextures) +---@param uiMapID number +---@return UiMapExplorationInfo[] overlayInfo +function C_MapExplorationInfo.GetExploredMapTextures(uiMapID) end + +---@class UiMapExplorationHitRect +---@field top number +---@field bottom number +---@field left number +---@field right number + +---@class UiMapExplorationInfo +---@field textureWidth number +---@field textureHeight number +---@field offsetX number +---@field offsetY number +---@field isShownByMouseOver boolean +---@field isDrawOnTopLayer boolean +---@field fileDataIDs number[] +---@field hitRect UiMapExplorationHitRect diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua new file mode 100644 index 0000000..7fd4bdb --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +C_MerchantFrame = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.GetBuybackItemID) +---@param buybackSlotIndex number +---@return number buybackItemID +function C_MerchantFrame.GetBuybackItemID(buybackSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.GetItemInfo) +---@param index number +---@return MerchantItemInfo info +function C_MerchantFrame.GetItemInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.GetNumJunkItems) +---@return number numJunkItems +function C_MerchantFrame.GetNumJunkItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.IsMerchantItemRefundable) +---@param index number +---@return boolean refundable +function C_MerchantFrame.IsMerchantItemRefundable(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.IsSellAllJunkEnabled) +---@return boolean enabled +function C_MerchantFrame.IsSellAllJunkEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.SellAllJunkItems) +function C_MerchantFrame.SellAllJunkItems() end + +---@class MerchantItemInfo +---@field name string? +---@field texture fileID +---@field price number? Default = 0 +---@field stackCount number? Default = 0 +---@field numAvailable number? Default = 0 +---@field isPurchasable boolean? Default = false +---@field isUsable boolean? Default = false +---@field hasExtendedCost boolean? Default = false +---@field currencyID number? +---@field spellID number? +---@field isQuestStartItem boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua new file mode 100644 index 0000000..c9cca47 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua @@ -0,0 +1,124 @@ +---@meta _ +C_Minimap = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.CanTrackBattlePets) +---@return boolean CanTrackBattlePets +function C_Minimap.CanTrackBattlePets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.ClearAllTracking) +function C_Minimap.ClearAllTracking() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.ClearMinimapInsetInfo) +function C_Minimap.ClearMinimapInsetInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetDefaultTrackingValue) +---@param filterType Enum.MinimapTrackingFilter +---@return boolean defaultValue +function C_Minimap.GetDefaultTrackingValue(filterType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetDrawGroundTextures) +---@return boolean draw +function C_Minimap.GetDrawGroundTextures() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetNumQuestPOIWorldEffects) +---@return number worldEffectCount +function C_Minimap.GetNumQuestPOIWorldEffects() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetNumTrackingTypes) +---@return number numTrackingTypes +function C_Minimap.GetNumTrackingTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetObjectIconTextureCoords) +---@param index? number +---@return number textureCoordsX +---@return number textureCoordsY +---@return number textureCoordsZ +---@return number textureCoordsW +function C_Minimap.GetObjectIconTextureCoords(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetPOITextureCoords) +---@param index? number +---@return number textureCoordsX +---@return number textureCoordsY +---@return number textureCoordsZ +---@return number textureCoordsW +function C_Minimap.GetPOITextureCoords(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetTrackingFilter) +---@param spellIndex number +---@return MinimapScriptTrackingFilter trackingType +function C_Minimap.GetTrackingFilter(spellIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetTrackingInfo) +---@param spellIndex number +---@return MinimapScriptTrackingInfo? trackingInfo +function C_Minimap.GetTrackingInfo(spellIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetUiMapID) +---@return number? uiMapID +function C_Minimap.GetUiMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.GetViewRadius) +---@return number yards +function C_Minimap.GetViewRadius() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.IsFilteredOut) +---@param filterType Enum.MinimapTrackingFilter +---@return boolean isFiltered +function C_Minimap.IsFilteredOut(filterType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.IsInsideQuestBlob) +---@param questID number +---@return boolean isInside +function C_Minimap.IsInsideQuestBlob(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.IsRotateMinimapIgnored) +---@return boolean isIgnored +function C_Minimap.IsRotateMinimapIgnored() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.IsTrackingAccountCompletedQuests) +---@return boolean IsTrackingAccountCompletedQuests +function C_Minimap.IsTrackingAccountCompletedQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.IsTrackingBattlePets) +---@return boolean isTrackingBattlePets +function C_Minimap.IsTrackingBattlePets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.IsTrackingHiddenQuests) +---@return boolean isTrackingHiddenQuests +function C_Minimap.IsTrackingHiddenQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.SetDrawGroundTextures) +---@param draw boolean +function C_Minimap.SetDrawGroundTextures(draw) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.SetIgnoreRotateMinimap) +---@param ignore boolean +function C_Minimap.SetIgnoreRotateMinimap(ignore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.SetMinimapInsetInfo) +---@param minAngle number +---@param maxAngle number +---@param scalar number +function C_Minimap.SetMinimapInsetInfo(minAngle, maxAngle, scalar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.SetTracking) +---@param index number +---@param on boolean +function C_Minimap.SetTracking(index, on) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Minimap.ShouldUseHybridMinimap) +---@return boolean shouldUse +function C_Minimap.ShouldUseHybridMinimap() end + +---@class MinimapScriptTrackingFilter +---@field spellID number? +---@field filterID Enum.MinimapTrackingFilter? + +---@class MinimapScriptTrackingInfo +---@field name string +---@field texture fileID +---@field active boolean +---@field type string +---@field subType number +---@field spellID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua new file mode 100644 index 0000000..ded2504 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua @@ -0,0 +1,25 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMirrorTimerInfo) +---@param timerIndex number +---@return string name +---@return number startValue +---@return number maxValue +---@return number scale +---@return number paused +---@return string label +---@return number spellID +function GetMirrorTimerInfo(timerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMirrorTimerProgress) +---@param timerName string +---@return number? progress +function GetMirrorTimerProgress(timerName) end + +---@class MirrorTimerInfo +---@field name string +---@field startValue number +---@field maxValue number +---@field scale number +---@field paused number +---@field label string +---@field spellID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua new file mode 100644 index 0000000..a956a60 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua @@ -0,0 +1,291 @@ +---@meta _ +C_MountJournal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.ApplyMountEquipment) +---@param itemLocation ItemLocation +---@return boolean canContinue +function C_MountJournal.ApplyMountEquipment(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.AreMountEquipmentEffectsSuppressed) +---@return boolean areEffectsSuppressed +function C_MountJournal.AreMountEquipmentEffectsSuppressed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.ClearFanfare) +---@param mountID number +function C_MountJournal.ClearFanfare(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.ClearRecentFanfares) +function C_MountJournal.ClearRecentFanfares() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.Dismiss) +function C_MountJournal.Dismiss() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetAllCreatureDisplayIDsForMountID) +---@param mountID number +---@return number[] creatureDisplayIDs +function C_MountJournal.GetAllCreatureDisplayIDsForMountID(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetAppliedMountEquipmentID) +---@return number? itemID +function C_MountJournal.GetAppliedMountEquipmentID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetCollectedDragonridingMounts) +---@return number[] mountIDs +function C_MountJournal.GetCollectedDragonridingMounts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetCollectedFilterSetting) +---@param filterIndex number +---@return boolean isChecked +function C_MountJournal.GetCollectedFilterSetting(filterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo) +---@param mountIndex number +---@return MountCreatureDisplayInfo[] allDisplayInfo +function C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo(mountIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetDisplayedMountID) +---@param displayIndex number +---@return number mountID +function C_MountJournal.GetDisplayedMountID(displayIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetDisplayedMountInfo) +---@param displayIndex number +---@return string name +---@return number spellID +---@return fileID icon +---@return boolean isActive +---@return boolean isUsable +---@return number sourceType +---@return boolean isFavorite +---@return boolean isFactionSpecific +---@return Enum.PvPFaction? faction +---@return boolean shouldHideOnChar +---@return boolean isCollected +---@return number mountID +---@return boolean isSteadyFlight +function C_MountJournal.GetDisplayedMountInfo(displayIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetDisplayedMountInfoExtra) +---@param mountIndex number +---@return number? creatureDisplayInfoID +---@return string description +---@return string source +---@return boolean isSelfMount +---@return number mountTypeID +---@return number uiModelSceneID +---@return number animID +---@return number spellVisualKitID +---@return boolean disablePlayerMountPreview +function C_MountJournal.GetDisplayedMountInfoExtra(mountIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetDynamicFlightModeSpellID) +---@return number spellID +function C_MountJournal.GetDynamicFlightModeSpellID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetIsFavorite) +---@param mountIndex number +---@return boolean isFavorite +---@return boolean canSetFavorite +function C_MountJournal.GetIsFavorite(mountIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountAllCreatureDisplayInfoByID) +---@param mountID number +---@return MountCreatureDisplayInfo[] allDisplayInfo +function C_MountJournal.GetMountAllCreatureDisplayInfoByID(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountEquipmentUnlockLevel) +---@return number level +function C_MountJournal.GetMountEquipmentUnlockLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountFromItem) +---@param itemID number +---@return number? mountID +function C_MountJournal.GetMountFromItem(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountFromSpell) +---@param spellID SpellIdentifier +---@return number? mountID +function C_MountJournal.GetMountFromSpell(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountIDs) +---@return number[] mountIDs +function C_MountJournal.GetMountIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountInfoByID) +---@param mountID number +---@return string name +---@return number spellID +---@return fileID icon +---@return boolean isActive +---@return boolean isUsable +---@return number sourceType +---@return boolean isFavorite +---@return boolean isFactionSpecific +---@return Enum.PvPFaction? faction +---@return boolean shouldHideOnChar +---@return boolean isCollected +---@return number mountID +---@return boolean isSteadyFlight +function C_MountJournal.GetMountInfoByID(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountInfoExtraByID) +---@param mountID number +---@return number? creatureDisplayInfoID +---@return string description +---@return string source +---@return boolean isSelfMount +---@return number mountTypeID +---@return number uiModelSceneID +---@return number animID +---@return number spellVisualKitID +---@return boolean disablePlayerMountPreview +function C_MountJournal.GetMountInfoExtraByID(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountLink) +---@param spellID number +---@return string? mountCreatureDisplayInfoLink +function C_MountJournal.GetMountLink(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetMountUsabilityByID) +---@param mountID number +---@param checkIndoors boolean +---@return boolean isUsable +---@return string? useError +function C_MountJournal.GetMountUsabilityByID(mountID, checkIndoors) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetNumDisplayedMounts) +---@return number numMounts +function C_MountJournal.GetNumDisplayedMounts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetNumMounts) +---@return number numMounts +function C_MountJournal.GetNumMounts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.GetNumMountsNeedingFanfare) +---@return number numMountsNeedingFanfare +function C_MountJournal.GetNumMountsNeedingFanfare() end + +---Returns whether the player has unlocked the ability to switch between Skyriding and steady flight styles for flying mounts . +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsDragonridingUnlocked) +---@return boolean isUnlocked +function C_MountJournal.IsDragonridingUnlocked() end + +---Determines if the item is mount equipment based on its class and subclass. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsItemMountEquipment) +---@param itemLocation ItemLocation +---@return boolean isMountEquipment +function C_MountJournal.IsItemMountEquipment(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsMountEquipmentApplied) +---@return boolean isApplied +function C_MountJournal.IsMountEquipmentApplied() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsSourceChecked) +---@param filterIndex number +---@return boolean isChecked +function C_MountJournal.IsSourceChecked(filterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsTypeChecked) +---@param filterIndex number +---@return boolean isChecked +function C_MountJournal.IsTypeChecked(filterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsUsingDefaultFilters) +---@return boolean isUsingDefaultFilters +function C_MountJournal.IsUsingDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsValidSourceFilter) +---@param filterIndex number +---@return boolean isValid +function C_MountJournal.IsValidSourceFilter(filterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.IsValidTypeFilter) +---@param filterIndex number +---@return boolean isValid +function C_MountJournal.IsValidTypeFilter(filterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.NeedsFanfare) +---@param mountID number +---@return boolean needsFanfare +function C_MountJournal.NeedsFanfare(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.Pickup) +---@param displayIndex number +function C_MountJournal.Pickup(displayIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.PickupDynamicFlightMode) +function C_MountJournal.PickupDynamicFlightMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetAllSourceFilters) +---@param isChecked boolean +function C_MountJournal.SetAllSourceFilters(isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetAllTypeFilters) +---@param isChecked boolean +function C_MountJournal.SetAllTypeFilters(isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetCollectedFilterSetting) +---@param filterIndex number +---@param isChecked boolean +function C_MountJournal.SetCollectedFilterSetting(filterIndex, isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetDefaultFilters) +function C_MountJournal.SetDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetIsFavorite) +---@param mountIndex number +---@param isFavorite boolean +function C_MountJournal.SetIsFavorite(mountIndex, isFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetSearch) +---@param searchValue string +function C_MountJournal.SetSearch(searchValue) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetSourceFilter) +---@param filterIndex number +---@param isChecked boolean +function C_MountJournal.SetSourceFilter(filterIndex, isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SetTypeFilter) +---@param filterIndex number +---@param isChecked boolean +function C_MountJournal.SetTypeFilter(filterIndex, isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SummonByID) +---@param mountID number +function C_MountJournal.SummonByID(mountID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MountJournal.SwapDynamicFlightMode) +function C_MountJournal.SwapDynamicFlightMode() end + +---@class MountCreatureDisplayInfo +---@field creatureDisplayID number +---@field isVisible boolean + +---@class MountInfo +---@field name string +---@field spellID number +---@field icon fileID +---@field isActive boolean +---@field isUsable boolean +---@field sourceType number +---@field isFavorite boolean +---@field isFactionSpecific boolean +---@field faction Enum.PvPFaction? +---@field shouldHideOnChar boolean +---@field isCollected boolean +---@field mountID number +---@field isSteadyFlight boolean + +---@class MountInfoExtra +---@field creatureDisplayInfoID number? +---@field description string +---@field source string +---@field isSelfMount boolean +---@field mountTypeID number +---@field uiModelSceneID number +---@field animID number +---@field spellVisualKitID number +---@field disablePlayerMountPreview boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua new file mode 100644 index 0000000..4ff0006 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelPreloadingMovie) +---@param movieId number +function CancelPreloadingMovie(movieId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMovieDownloadProgress) +---@param movieId number +---@return boolean inProgress +---@return BigUInteger downloaded +---@return BigUInteger total +function GetMovieDownloadProgress(movieId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMovieLocal) +---@param movieId number +---@return boolean isLocal +function IsMovieLocal(movieId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMoviePlayable) +---@param movieId number +---@return boolean isPlayable +function IsMoviePlayable(movieId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMovieReadable) +---@param movieId number +---@return boolean readable +function IsMovieReadable(movieId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PreloadMovie) +---@param movieId number +function PreloadMovie(movieId) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua new file mode 100644 index 0000000..4ad35bc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua @@ -0,0 +1,149 @@ +---@meta _ +C_MythicPlus = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetCurrentAffixes) +---@return MythicPlusKeystoneAffix[] affixIDs +function C_MythicPlus.GetCurrentAffixes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetCurrentSeason) +---@return number seasonID +function C_MythicPlus.GetCurrentSeason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetCurrentSeasonValues) +---@return number displaySeasonID +---@return number milestoneSeasonID +---@return number rewardSeasonID +function C_MythicPlus.GetCurrentSeasonValues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetCurrentUIDisplaySeason) +---@return number? seasonID +function C_MythicPlus.GetCurrentUIDisplaySeason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetEndOfRunGearSequenceLevel) +---@param keystoneLevel number +---@return number? sequenceLevel +function C_MythicPlus.GetEndOfRunGearSequenceLevel(keystoneLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetLastWeeklyBestInformation) +---@return number challengeMapId +---@return number level +function C_MythicPlus.GetLastWeeklyBestInformation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetOwnedKeystoneChallengeMapID) +---@return number challengeMapID +function C_MythicPlus.GetOwnedKeystoneChallengeMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetOwnedKeystoneLevel) +---@return number keyStoneLevel +function C_MythicPlus.GetOwnedKeystoneLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetOwnedKeystoneMapID) +---@return number mapID +function C_MythicPlus.GetOwnedKeystoneMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetRewardLevelForDifficultyLevel) +---@param difficultyLevel number +---@return number weeklyRewardLevel +---@return number endOfRunRewardLevel +function C_MythicPlus.GetRewardLevelForDifficultyLevel(difficultyLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetRewardLevelFromKeystoneLevel) +---@param keystoneLevel number +---@return number? rewardLevel +function C_MythicPlus.GetRewardLevelFromKeystoneLevel(keystoneLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetRunHistory) +---@param includePreviousWeeks? boolean Default = false +---@param includeIncompleteRuns? boolean Default = false +---@param currentSeasonOnly? boolean Default = false +---@return MythicPlusRunInfo[] runs +function C_MythicPlus.GetRunHistory(includePreviousWeeks, includeIncompleteRuns, currentSeasonOnly) end + +---Gets the active players best runs by the seasonal tracked affixes as well as their overall score for the current season. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetSeasonBestAffixScoreInfoForMap) +---@param mapChallengeModeID number +---@return MythicPlusAffixScoreInfo[] affixScores +---@return number bestOverAllScore +function C_MythicPlus.GetSeasonBestAffixScoreInfoForMap(mapChallengeModeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetSeasonBestForMap) +---@param mapChallengeModeID number +---@return MapSeasonBestInfo? intimeInfo +---@return MapSeasonBestInfo? overtimeInfo +function C_MythicPlus.GetSeasonBestForMap(mapChallengeModeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetSeasonBestMythicRatingFromThisExpansion) +---@return number bestSeasonScore +---@return number bestSeason +function C_MythicPlus.GetSeasonBestMythicRatingFromThisExpansion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetWeeklyBestForMap) +---@param mapChallengeModeID number +---@return number durationSec +---@return number level +---@return MythicPlusDate completionDate +---@return number[] affixIDs +---@return MythicPlusMember[] members +---@return number dungeonScore +function C_MythicPlus.GetWeeklyBestForMap(mapChallengeModeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.GetWeeklyChestRewardLevel) +---@return number currentWeekBestLevel +---@return number weeklyRewardLevel +---@return number nextDifficultyWeeklyRewardLevel +---@return number nextBestLevel +function C_MythicPlus.GetWeeklyChestRewardLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.IsMythicPlusActive) +---@return boolean isMythicPlusActive +function C_MythicPlus.IsMythicPlusActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.RequestCurrentAffixes) +function C_MythicPlus.RequestCurrentAffixes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.RequestMapInfo) +function C_MythicPlus.RequestMapInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_MythicPlus.RequestRewards) +function C_MythicPlus.RequestRewards() end + +---@class MapSeasonBestInfo +---@field durationSec number +---@field level number +---@field completionDate MythicPlusDate +---@field affixIDs number[] +---@field members MythicPlusMember[] +---@field dungeonScore number + +---@class MythicPlusDate +---@field year number +---@field month number +---@field day number +---@field hour number +---@field minute number +---@field weekday number + +---@class MythicPlusKeystoneAffix +---@field id number +---@field seasonID number + +---@class MythicPlusMember +---@field name string? +---@field specID number +---@field classID number + +---@class MythicPlusRunInfo +---@field mapChallengeModeID number +---@field level number +---@field thisWeek boolean +---@field completed boolean +---@field runScore number +---@field durationSec number +---@field completionDate MythicPlusDate +---@field season number + +---@class SeasonTimeInfo +---@field bestTime number +---@field lastTime number +---@field medal number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua new file mode 100644 index 0000000..d362e54 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua @@ -0,0 +1,22 @@ +---@meta _ +---@class MythicPlusAffixScoreInfo +---@field name string +---@field score number +---@field level number +---@field durationSec number +---@field overTime boolean + +---@class MythicPlusLeaderboardPlayerResult +---@field playerGUID WOWGUID +---@field specID number + +---@class MythicPlusLeaderboardResult +---@field completionTime number +---@field players MythicPlusLeaderboardPlayerResult[] + +---@class MythicPlusRatingLinkInfo +---@field mapChallengeModeID number +---@field level number +---@field completedInTime number +---@field dungeonScore number +---@field name string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua new file mode 100644 index 0000000..efc8111 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua @@ -0,0 +1,22 @@ +---@meta _ +C_NamePlate = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlate.GetNamePlateForUnit) +---@param unitToken UnitTokenNamePlate +---@param includeForbidden? boolean Default = false +---@return NamePlateFrame nameplate +function C_NamePlate.GetNamePlateForUnit(unitToken, includeForbidden) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlate.GetNamePlateSize) +---@return uiUnit width +---@return uiUnit height +function C_NamePlate.GetNamePlateSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlate.GetNamePlates) +---@return NamePlateFrame[] nameplates +function C_NamePlate.GetNamePlates() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlate.SetNamePlateSize) +---@param width uiUnit +---@param height uiUnit +function C_NamePlate.SetNamePlateSize(width, height) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua new file mode 100644 index 0000000..cca6bb1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua @@ -0,0 +1,36 @@ +---@meta _ +C_NamePlateManager = {} + +---Returns the values used to adjust the hit testing area for nameplates. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlateManager.GetNamePlateHitTestInsets) +---@param type Enum.NamePlateType +---@return uiUnit left +---@return uiUnit right +---@return uiUnit top +---@return uiUnit bottom +function C_NamePlateManager.GetNamePlateHitTestInsets(type) end + +---Returns whether the unit to which the nameplate is attached is behind the player's camera. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlateManager.IsNamePlateUnitBehindCamera) +---@param unitToken UnitTokenNamePlate +---@return boolean isBehindCamera +function C_NamePlateManager.IsNamePlateUnitBehindCamera(unitToken) end + +---Provide values to adjust the hit testing area for nameplates. Positive values will decrease the hit test area, negative values will increase it. Note that all hit testing is clamped to the bounds of the nameplate and can not be moved outside it. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlateManager.SetNamePlateHitTestInsets) +---@param type Enum.NamePlateType +---@param left uiUnit +---@param right uiUnit +---@param top uiUnit +---@param bottom uiUnit +function C_NamePlateManager.SetNamePlateHitTestInsets(type, left, right, top, bottom) end + +---Set whether the nameplate attached to a unit is considered simplified, which can change the way it's displayed. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NamePlateManager.SetNamePlateSimplified) +---@param unitToken UnitTokenNamePlate +---@param isSimplified boolean +function C_NamePlateManager.SetNamePlateSimplified(unitToken, isSimplified) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua new file mode 100644 index 0000000..9320d73 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua @@ -0,0 +1,138 @@ +---@meta _ +C_NeighborhoodInitiative = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.AddTrackedInitiativeTask) +---@param initiativeTaskID number +function C_NeighborhoodInitiative.AddTrackedInitiativeTask(initiativeTaskID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetActiveNeighborhood) +---@return WOWGUID neighborhoodGUID +function C_NeighborhoodInitiative.GetActiveNeighborhood() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetAvailableHouseXP) +---@return number availabeXP +function C_NeighborhoodInitiative.GetAvailableHouseXP() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetInitiativeActivityLogInfo) +---@return InitiativeActivityLogInfo? info +function C_NeighborhoodInitiative.GetInitiativeActivityLogInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetInitiativeTaskChatLink) +---@param initiativeTaskID number +---@return string link +function C_NeighborhoodInitiative.GetInitiativeTaskChatLink(initiativeTaskID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetInitiativeTaskInfo) +---@param initiativeTaskID number +---@return InitiativeTaskInfo? info +function C_NeighborhoodInitiative.GetInitiativeTaskInfo(initiativeTaskID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetNeighborhoodInitiativeInfo) +---@return NeighborhoodInitiativeInfo? info +function C_NeighborhoodInitiative.GetNeighborhoodInitiativeInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetRequiredLevel) +---@return number reqLevel +function C_NeighborhoodInitiative.GetRequiredLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.GetTrackedInitiativeTasks) +---@return InitiativeTasksTracked trackedInitiativeTasks +function C_NeighborhoodInitiative.GetTrackedInitiativeTasks() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.IsInitiativeEnabled) +---@return boolean enabled +function C_NeighborhoodInitiative.IsInitiativeEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.IsPlayerInNeighborhoodGroup) +---@return boolean inValidGroup +function C_NeighborhoodInitiative.IsPlayerInNeighborhoodGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.IsViewingActiveNeighborhood) +---@return boolean isViewingActiveNeighborhood +function C_NeighborhoodInitiative.IsViewingActiveNeighborhood() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.PlayerHasInitiativeAccess) +---@return boolean success +function C_NeighborhoodInitiative.PlayerHasInitiativeAccess() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.PlayerMeetsRequiredLevel) +---@return boolean success +function C_NeighborhoodInitiative.PlayerMeetsRequiredLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.RemoveTrackedInitiativeTask) +---@param initiativeTaskID number +function C_NeighborhoodInitiative.RemoveTrackedInitiativeTask(initiativeTaskID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.RequestInitiativeActivityLog) +function C_NeighborhoodInitiative.RequestInitiativeActivityLog() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.RequestNeighborhoodInitiativeInfo) +function C_NeighborhoodInitiative.RequestNeighborhoodInitiativeInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.SetActiveNeighborhood) +---@param neighborhoodGUID WOWGUID +function C_NeighborhoodInitiative.SetActiveNeighborhood(neighborhoodGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NeighborhoodInitiative.SetViewingNeighborhood) +---@param neighborhoodGUID WOWGUID +function C_NeighborhoodInitiative.SetViewingNeighborhood(neighborhoodGUID) end + +---@class InitiativeActivityLogEntry +---@field taskID number +---@field playerName string +---@field taskName string +---@field completionTime time_t +---@field amount number + +---@class InitiativeActivityLogInfo +---@field isLoaded boolean +---@field neighborhoodGUID WOWGUID +---@field nextUpdateTime time_t +---@field taskActivity InitiativeActivityLogEntry[] + +---@class InitiativeMilestoneInfo +---@field milestoneOrderIndex number +---@field requiredContributionAmount number +---@field rewards InitiativeMilestoneRewardInfo[] + +---@class InitiativeMilestoneRewardInfo +---@field title string +---@field description string +---@field decorID number +---@field decorQuantity number +---@field favor number +---@field money WOWMONEY +---@field rewardQuestID number + +---@class InitiativeTaskInfo +---@field ID number +---@field taskName string +---@field description string +---@field progressContributionAmount number +---@field tracked boolean +---@field supersedes number +---@field timesCompleted number +---@field completed boolean +---@field inProgress boolean +---@field taskType Enum.NeighborhoodInitiativeTaskType +---@field sortOrder number +---@field rewardQuestID number +---@field requirementsList CriteriaRequirement[] +---@field criteriaList CriteriaRequiredValue[] + +---@class InitiativeTasksTracked +---@field trackedIDs number[] + +---@class NeighborhoodInitiativeInfo +---@field isLoaded boolean +---@field neighborhoodGUID WOWGUID +---@field initiativeID number +---@field currentCycleID number +---@field progressRequired number +---@field currentProgress number +---@field playerTotalContribution number +---@field duration time_t +---@field tasks InitiativeTaskInfo[] +---@field milestones InitiativeMilestoneInfo[] +---@field title string +---@field description string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua new file mode 100644 index 0000000..9a682c2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua @@ -0,0 +1,16 @@ +---@meta _ +C_NewItems = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NewItems.ClearAll) +function C_NewItems.ClearAll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NewItems.IsNewItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +---@return boolean isNew +function C_NewItems.IsNewItem(containerIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_NewItems.RemoveNewItem) +---@param containerIndex Enum.BagIndex +---@param slotIndex number +function C_NewItems.RemoveNewItem(containerIndex, slotIndex) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NumericRuleFormatterSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NumericRuleFormatterSharedDocumentation.lua new file mode 100644 index 0000000..6f5ad7e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/NumericRuleFormatterSharedDocumentation.lua @@ -0,0 +1,15 @@ +---@meta _ +---@class NumericRuleFormatBreakpoint +---@field threshold number +---@field step number? +---@field rounding Enum.NumericRuleFormatRounding? Default = Nearest +---@field min number? +---@field max number? +---@field format string +---@field components NumericRuleFormatComponent[]? + +---@class NumericRuleFormatComponent +---@field div number? +---@field mod number? +---@field step number? +---@field rounding Enum.NumericRuleFormatRounding? Default = Nearest diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/OsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/OsDocumentation.lua new file mode 100644 index 0000000..ebef8c6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/OsDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CopyToClipboard) +---@param text string +---@param removeMarkup? boolean Default = false +---@return number length +function CopyToClipboard(text, removeMarkup) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTimePreciseSec) +---@return number time +function GetTimePreciseSec() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua new file mode 100644 index 0000000..c5e819f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua @@ -0,0 +1,98 @@ +---@meta _ +C_PaperDollInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.CanAutoEquipCursorItem) +---@return boolean canAutoEquip +function C_PaperDollInfo.CanAutoEquipCursorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.CanCursorCanGoInSlot) +---@param slotIndex number +---@return boolean canOccupySlot +function C_PaperDollInfo.CanCursorCanGoInSlot(slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetArmorEffectiveness) +---@param armor number +---@param attackerLevel number +---@return number effectiveness +function C_PaperDollInfo.GetArmorEffectiveness(armor, attackerLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetArmorEffectivenessAgainstTarget) +---@param armor number +---@return number? effectiveness +function C_PaperDollInfo.GetArmorEffectivenessAgainstTarget(armor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices) +---@param unit UnitToken +---@param equipmentSlotIndex number +---@return number[] azeritePowerIDs +function C_PaperDollInfo.GetInspectAzeriteItemEmpoweredChoices(unit, equipmentSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetInspectGuildInfo) +---@param unitString string +---@return number achievementPoints +---@return number numMembers +---@return string guildName +---@return string realmName +function C_PaperDollInfo.GetInspectGuildInfo(unitString) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetInspectItemLevel) +---@param unit UnitToken +---@return number equippedItemLevel +function C_PaperDollInfo.GetInspectItemLevel(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetInspectRatedBGBlitzData) +---@return InspectPVPData ratedBGBlitzData +function C_PaperDollInfo.GetInspectRatedBGBlitzData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetInspectRatedBGData) +---@return InspectRatedBGData ratedBGData +function C_PaperDollInfo.GetInspectRatedBGData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetInspectRatedSoloShuffleData) +---@return InspectPVPData ratedSoloShuffleData +function C_PaperDollInfo.GetInspectRatedSoloShuffleData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetMinItemLevel) +---@return number? minItemLevel +function C_PaperDollInfo.GetMinItemLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.GetStaggerPercentage) +---@param unit UnitToken +---@return number stagger +---@return number? staggerAgainstTarget +function C_PaperDollInfo.GetStaggerPercentage(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.IsInventorySlotEnabled) +---@param slotName stringView +---@return boolean isEnabled +function C_PaperDollInfo.IsInventorySlotEnabled(slotName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.IsRangedSlotShown) +---@return boolean isShown +function C_PaperDollInfo.IsRangedSlotShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.OffhandHasShield) +---@return boolean offhandHasShield +function C_PaperDollInfo.OffhandHasShield() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PaperDollInfo.OffhandHasWeapon) +---@return boolean offhandHasWeapon +function C_PaperDollInfo.OffhandHasWeapon() end + +---@class InspectGuildInfo +---@field achievementPoints number +---@field numMembers number +---@field guildName string +---@field realmName string + +---@class InspectPVPData +---@field rating number +---@field gamesWon number +---@field gamesPlayed number +---@field roundsWon number +---@field roundsPlayed number + +---@class InspectRatedBGData +---@field rating number +---@field played number +---@field won number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua new file mode 100644 index 0000000..f823577 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua @@ -0,0 +1,4 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSecondsUntilParentalControlsKick) +---@return number? remaining +function GetSecondsUntilParentalControlsKick() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua new file mode 100644 index 0000000..3d40e11 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua @@ -0,0 +1,240 @@ +---@meta _ +C_PartyInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.AllowedToDoPartyConversion) +---@param toRaid boolean +---@return boolean allowed +function C_PartyInfo.AllowedToDoPartyConversion(toRaid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.CanFormCrossFactionParties) +---@return boolean canFormCrossFactionParties +function C_PartyInfo.CanFormCrossFactionParties() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.CanInvite) +---@return boolean allowedToInvite +function C_PartyInfo.CanInvite() end + +---Returns whether it's possible to start a vote at this time +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.CanStartInstanceAbandonVote) +---@return boolean canStart +function C_PartyInfo.CanStartInstanceAbandonVote() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ChallengeModeRestrictionsActive) +---@return boolean restrictionsActive +function C_PartyInfo.ChallengeModeRestrictionsActive() end + +---Immediately convert to raid with no regard for potentially destructive actions. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConfirmConvertToRaid) +function C_PartyInfo.ConfirmConvertToRaid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConfirmInviteTravelPass) +---@param targetName string +---@param targetGUID WOWGUID +function C_PartyInfo.ConfirmInviteTravelPass(targetName, targetGUID) end + +---Immediately invites the named unit to a party, with no regard for potentially destructive actions. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConfirmInviteUnit) +---@param targetName string +function C_PartyInfo.ConfirmInviteUnit(targetName) end + +---Immediately leave the party with no regard for potentially destructive actions +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConfirmLeaveParty) +---@param category? number +function C_PartyInfo.ConfirmLeaveParty(category) end + +---Immediately request an invite into the target party, this is the confirmation function to call after RequestInviteFromUnit, or if you would like to skip the confirmation process. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConfirmRequestInviteFromUnit) +---@param targetName string +---@param tank? boolean +---@param healer? boolean +---@param dps? boolean +function C_PartyInfo.ConfirmRequestInviteFromUnit(targetName, tank, healer, dps) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConvertToParty) +function C_PartyInfo.ConvertToParty() end + +---Usually this will convert to raid immediately. In some cases (e.g. PartySync) the user will be prompted to confirm converting to raid, because it's potentially destructive. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.ConvertToRaid) +function C_PartyInfo.ConvertToRaid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.DelveTeleportOut) +function C_PartyInfo.DelveTeleportOut() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.DoCountdown) +---@param seconds number +---@return boolean success +function C_PartyInfo.DoCountdown(seconds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetActiveCategories) +---@return number[] categories +function C_PartyInfo.GetActiveCategories() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetAvailableLootMethods) +---@return Enum.LootMethod[] methods +function C_PartyInfo.GetAvailableLootMethods() end + +---Returns the total duration of the shutdown time after a vote passes and how much time is left before it ends +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInstanceAbandonShutdownTime) +---@return number? durationSeconds Default = 0 +---@return number? timeLeftSeconds Default = 0 +function C_PartyInfo.GetInstanceAbandonShutdownTime() end + +---Returns the total duration of the abandon vote cooldown and how much time is left before it ends +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInstanceAbandonVoteCooldownTime) +---@return number? durationSeconds Default = 0 +---@return number? timeLeftSeconds Default = 0 +function C_PartyInfo.GetInstanceAbandonVoteCooldownTime() end + +---Returns values controlling the vote +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInstanceAbandonVoteRequirements) +---@return number? votesRequired Default = 0 +---@return number? keystoneOwnerVoteWeight Default = 0 +function C_PartyInfo.GetInstanceAbandonVoteRequirements() end + +---Returns how the player voted, nil for not yet +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInstanceAbandonVoteResponse) +---@return boolean? response +function C_PartyInfo.GetInstanceAbandonVoteResponse() end + +---Returns the total duration of the vote and how much time is left before it ends +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInstanceAbandonVoteTime) +---@return number? durationSeconds Default = 0 +---@return number? timeLeftSeconds Default = 0 +function C_PartyInfo.GetInstanceAbandonVoteTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInviteConfirmationInvalidQueues) +---@param inviteGUID WOWGUID +---@return QueueSpecificInfo[] invalidQueues +function C_PartyInfo.GetInviteConfirmationInvalidQueues(inviteGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetInviteReferralInfo) +---@param inviteGUID WOWGUID +---@return WOWGUID outReferredByGuid +---@return string outReferredByName +---@return Enum.PartyRequestJoinRelation outRelationType +---@return boolean outIsQuickJoin +---@return ClubId outClubId +function C_PartyInfo.GetInviteReferralInfo(inviteGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetLootMethod) +---@return Enum.LootMethod method +---@return number? masterLootPartyID +---@return number? masterLooterRaidID +function C_PartyInfo.GetLootMethod() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetLootMethodStyle) +---@return Enum.LootMethodStyles methodStyle +function C_PartyInfo.GetLootMethodStyle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetMinItemLevel) +---@param avgItemLevelCategory Enum.AvgItemLevelCategories +---@return number minItemLevel +---@return string playerNameWithLowestItemLevel +function C_PartyInfo.GetMinItemLevel(avgItemLevelCategory) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetMinLevel) +---@param category? number +---@return number minLevel +function C_PartyInfo.GetMinLevel(category) end + +---Returns how many players have voted either way +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetNumInstanceAbandonGroupVoteResponses) +---@return number count +function C_PartyInfo.GetNumInstanceAbandonGroupVoteResponses() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.GetRestrictPings) +---@return Enum.RestrictPingsTo restrictTo +function C_PartyInfo.GetRestrictPings() end + +---Attempt to invite the named unit to a party, requires confirmation in some cases (e.g. the party will convert to a raid, or if there is a party sync in progress). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.InviteUnit) +---@param targetName string +function C_PartyInfo.InviteUnit(targetName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsChallengeModeActive) +---@return boolean active +function C_PartyInfo.IsChallengeModeActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsChallengeModeKeystoneOwner) +---@return boolean isKeystoneOwner +function C_PartyInfo.IsChallengeModeKeystoneOwner() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsCrossFactionParty) +---@param category? number +---@return boolean isCrossFactionParty +function C_PartyInfo.IsCrossFactionParty(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsDelveComplete) +---@return boolean isDelveComplete +function C_PartyInfo.IsDelveComplete() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsDelveInProgress) +---@return boolean isDelveComplete +function C_PartyInfo.IsDelveInProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsLootMethodAvailable) +---@param method Enum.LootMethod +---@return boolean available +function C_PartyInfo.IsLootMethodAvailable(method) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsPartyFull) +---@param category? number +---@return boolean isFull +function C_PartyInfo.IsPartyFull(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsPartyInJailersTower) +---@return boolean isPartyInJailersTower +function C_PartyInfo.IsPartyInJailersTower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.IsPartyWalkIn) +---@return boolean isPartyWalkIn +function C_PartyInfo.IsPartyWalkIn() end + +---Usually this will leave the party immediately. In some cases (e.g. PartySync) the user will be prompted to confirm leaving the party, because it's potentially destructive +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.LeaveParty) +---@param category? number +function C_PartyInfo.LeaveParty(category) end + +---Attempt to request an invite into the target party, requires confirmation in some cases (e.g. there is a party sync in progress). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.RequestInviteFromUnit) +---@param targetName string +---@param tank? boolean +---@param healer? boolean +---@param dps? boolean +function C_PartyInfo.RequestInviteFromUnit(targetName, tank, healer, dps) end + +---Vote on whether to abandon instance, true for yes, false for no +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.SetInstanceAbandonVoteResponse) +---@param response boolean +function C_PartyInfo.SetInstanceAbandonVoteResponse(response) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.SetLootMethod) +---@param method Enum.LootMethod +---@param lootMaster? string +---@return boolean success +function C_PartyInfo.SetLootMethod(method, lootMaster) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.SetRestrictPings) +---@param restrictTo Enum.RestrictPingsTo +function C_PartyInfo.SetRestrictPings(restrictTo) end + +---Start the vote +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyInfo.StartInstanceAbandonVote) +function C_PartyInfo.StartInstanceAbandonVote() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua new file mode 100644 index 0000000..2dc0a8f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua @@ -0,0 +1,34 @@ +---@meta _ +C_PartyPose = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyPose.ExtraAction) +---@param partyPoseID number +function C_PartyPose.ExtraAction(partyPoseID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyPose.GetPartyPoseInfoByID) +---@param mapID number +---@return PartyPoseInfo info +function C_PartyPose.GetPartyPoseInfoByID(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyPose.GetPartyPoseInfoByMapID) +---@param mapID number +---@return PartyPoseInfo info +function C_PartyPose.GetPartyPoseInfoByMapID(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PartyPose.HasExtraAction) +---@param partyPoseID number +---@return boolean hasExtraAction +function C_PartyPose.HasExtraAction(partyPoseID) end + +---@class PartyPoseInfo +---@field partyPoseID number +---@field mapID number +---@field widgetSetID number? +---@field victoryModelSceneID number +---@field defeatModelSceneID number +---@field victorySoundKitID number +---@field defeatSoundKitID number +---@field uiTextureKit textureKit? +---@field titleText string? +---@field extraButtonText string? +---@field flags Enum.PartyPoseFlags diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua new file mode 100644 index 0000000..b9c0c7f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua @@ -0,0 +1,26 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAddOnCPUUsage) +---@param name uiAddon +---@return number result +function GetAddOnCPUUsage(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAddOnMemoryUsage) +---@param name uiAddon +---@return number result +function GetAddOnMemoryUsage(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFrameCPUUsage) +---@param frame SimpleFrame +---@param includeChildren? boolean Default = false +---@return number call_time +---@return number call_count +function GetFrameCPUUsage(frame, includeChildren) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetCPUUsage) +function ResetCPUUsage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UpdateAddOnCPUUsage) +function UpdateAddOnCPUUsage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UpdateAddOnMemoryUsage) +function UpdateAddOnMemoryUsage() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua new file mode 100644 index 0000000..273a7d3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua @@ -0,0 +1,90 @@ +---@meta _ +C_PerksActivities = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.AddTrackedPerksActivity) +---@param perksActivityID number +function C_PerksActivities.AddTrackedPerksActivity(perksActivityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.ClearPerksActivitiesPendingCompletion) +function C_PerksActivities.ClearPerksActivitiesPendingCompletion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetAllPerksActivityTags) +---@return PerksActivityTags tags +function C_PerksActivities.GetAllPerksActivityTags() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetPerksActivitiesInfo) +---@return PerksActivitiesInfo info +function C_PerksActivities.GetPerksActivitiesInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetPerksActivitiesPendingCompletion) +---@return PerksActivitiesPending pending +function C_PerksActivities.GetPerksActivitiesPendingCompletion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetPerksActivityChatLink) +---@param perksActivityID number +---@return string link +function C_PerksActivities.GetPerksActivityChatLink(perksActivityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetPerksActivityInfo) +---@param perksActivityID number +---@return PerksActivityInfo? info +function C_PerksActivities.GetPerksActivityInfo(perksActivityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetPerksUIThemePrefix) +---@return string kitPrefix +function C_PerksActivities.GetPerksUIThemePrefix() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.GetTrackedPerksActivities) +---@return PerksActivitiesTracked trackedPerksActivities +function C_PerksActivities.GetTrackedPerksActivities() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksActivities.RemoveTrackedPerksActivity) +---@param perksActivityID number +function C_PerksActivities.RemoveTrackedPerksActivity(perksActivityID) end + +---@class PerksActivitiesInfo +---@field activePerksMonth number +---@field displayMonthName string +---@field secondsRemaining time_t +---@field activities PerksActivityInfo[] +---@field thresholds PerksActivityThresholdInfo[] + +---@class PerksActivitiesPending +---@field pendingIDs number[] + +---@class PerksActivitiesTracked +---@field trackedIDs number[] + +---@class PerksActivityCondition +---@field isMet boolean +---@field text string +---@field uiPriority number + +---@class PerksActivityInfo +---@field ID number +---@field activityName string +---@field description string +---@field thresholdContributionAmount number +---@field completed boolean +---@field inProgress boolean +---@field tracked boolean +---@field supersedes number +---@field uiPriority number +---@field areAllConditionsMet boolean +---@field conditions PerksActivityCondition[] +---@field eventName string? +---@field eventStartTime time_t? +---@field eventEndTime time_t? +---@field requirementsList CriteriaRequirement[] +---@field criteriaList CriteriaRequiredValue[] +---@field tagNames string[] + +---@class PerksActivityTags +---@field tagName string[] + +---@class PerksActivityThresholdInfo +---@field thresholdOrderIndex number +---@field currencyAwardAmount number +---@field requiredContributionAmount number +---@field pendingReward boolean +---@field itemReward number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua new file mode 100644 index 0000000..79cd3a8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua @@ -0,0 +1,156 @@ +---@meta _ +C_PerksProgram = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.ClearFrozenPerksVendorItem) +function C_PerksProgram.ClearFrozenPerksVendorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.CloseInteraction) +function C_PerksProgram.CloseInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetAvailableCategoryIDs) +---@return number[] categoryIDs +function C_PerksProgram.GetAvailableCategoryIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetAvailableVendorItemIDs) +---@return number[] vendorItemIDs +function C_PerksProgram.GetAvailableVendorItemIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetCategoryInfo) +---@param categoryID number +---@return PerksVendorCategoryInfo categoryInfo +function C_PerksProgram.GetCategoryInfo(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetCurrencyAmount) +---@return number currencyAmount +function C_PerksProgram.GetCurrencyAmount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetDraggedPerksVendorItem) +---@return number perksVendorItemID +function C_PerksProgram.GetDraggedPerksVendorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetFrozenPerksVendorItemInfo) +---@return PerksVendorItemInfo vendorItemInfo +function C_PerksProgram.GetFrozenPerksVendorItemInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetPendingChestRewards) +---@return PerksProgramPendingChestRewards[] pendingRewards +function C_PerksProgram.GetPendingChestRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetPerksProgramItemDisplayInfo) +---@param id number +---@return PerksProgramItemDisplayInfo item +function C_PerksProgram.GetPerksProgramItemDisplayInfo(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetTimeRemaining) +---@param vendorItemID number +---@return time_t timeRemaining +function C_PerksProgram.GetTimeRemaining(vendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetVendorItemInfo) +---@param vendorItemID number +---@return PerksVendorItemInfo vendorItemInfo +function C_PerksProgram.GetVendorItemInfo(vendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.GetVendorItemInfoRefundTimeLeft) +---@param vendorItemID number +---@return time_t refundTimeRemaining +function C_PerksProgram.GetVendorItemInfoRefundTimeLeft(vendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.IsAttackAnimToggleEnabled) +---@return boolean isAttackAnimToggleEnabled +function C_PerksProgram.IsAttackAnimToggleEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.IsFrozenPerksVendorItem) +---@param perksVendorItemID number +---@return boolean isFrozen +function C_PerksProgram.IsFrozenPerksVendorItem(perksVendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.IsMountSpecialAnimToggleEnabled) +---@return boolean isMountSpecialAnimToggleEnabled +function C_PerksProgram.IsMountSpecialAnimToggleEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.ItemSelectedTelemetry) +---@param perksVendorItemID number +function C_PerksProgram.ItemSelectedTelemetry(perksVendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.PickupPerksVendorItem) +---@param perksVendorItemID number +function C_PerksProgram.PickupPerksVendorItem(perksVendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.RequestCartCheckout) +---@param perksVendorItemIDs number[] +function C_PerksProgram.RequestCartCheckout(perksVendorItemIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.RequestPendingChestRewards) +function C_PerksProgram.RequestPendingChestRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.RequestPurchase) +---@param perksVendorItemID number +function C_PerksProgram.RequestPurchase(perksVendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.RequestRefund) +---@param perksVendorItemID number +function C_PerksProgram.RequestRefund(perksVendorItemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.ResetHeldItemDragAndDrop) +function C_PerksProgram.ResetHeldItemDragAndDrop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PerksProgram.SetFrozenPerksVendorItem) +function C_PerksProgram.SetFrozenPerksVendorItem() end + +---@class PerksProgramItemDisplayInfo +---@field overrideModelSceneID number? +---@field creatureDisplayInfoID number? +---@field mainHandItemModifiedAppearanceID number? +---@field offHandItemModifiedAppearanceID number? + +---@class PerksProgramPendingChestRewards +---@field rewardTypeID number +---@field perksVendorItemID number? +---@field rewardAmount number +---@field monthRewarded string? +---@field activityMonthID number +---@field thresholdOrderIndex number + +---@class PerksVendorCategoryInfo +---@field ID number +---@field displayName string +---@field defaultUIModelSceneID number + +---@class PerksVendorItemInfo +---@field name string +---@field perksVendorCategoryID number +---@field description string +---@field timeRemaining time_t +---@field purchased boolean +---@field refundable boolean +---@field subItemsLoaded boolean +---@field isPurchasePending boolean +---@field doesNotExpire boolean +---@field price number +---@field originalPrice number? +---@field showSaleBanner boolean +---@field perksVendorItemID number +---@field itemID number +---@field iconTexture string +---@field mountID number +---@field mountTypeName string +---@field speciesID number +---@field transmogSetID number +---@field itemModifiedAppearanceID number +---@field subItems PerksVendorSubItemInfo[] +---@field uiGroupInfo PerksVendorItemUIGroupInfo? +---@field invType string +---@field quality Enum.ItemQuality + +---@class PerksVendorItemUIGroupInfo +---@field ID number +---@field name string +---@field priority number + +---@class PerksVendorSubItemInfo +---@field name string +---@field itemID number +---@field itemModifiedAppearanceID number +---@field invType string +---@field quality Enum.ItemQuality diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua new file mode 100644 index 0000000..d21a685 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +---@class CriteriaRequiredValue +---@field criteriaID number +---@field requiredValue number + +---@class CriteriaRequirement +---@field completed boolean +---@field requirementText string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua new file mode 100644 index 0000000..d9a84ac --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua @@ -0,0 +1,29 @@ +---@meta _ +C_PetBattles = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetBreedQuality) +---@param petOwner Enum.BattlePetOwner +---@param slot number +---@return Enum.BattlePetBreedQuality quality +function C_PetBattles.GetBreedQuality(petOwner, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetIcon) +---@param petOwner Enum.BattlePetOwner +---@param slot number +---@return fileID iconFileID +function C_PetBattles.GetIcon(petOwner, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetName) +---@param petOwner Enum.BattlePetOwner +---@param slot number +---@return string customName +---@return string speciesName +function C_PetBattles.GetName(petOwner, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.IsPlayerNPC) +---@return boolean isPlayerNPC +function C_PetBattles.IsPlayerNPC() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.IsWildBattle) +---@return boolean isWildBattle +function C_PetBattles.IsWildBattle() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua new file mode 100644 index 0000000..10eaa08 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +C_PetInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.GetPetTalentTree) +---@return stringView talentTreeName +function C_PetInfo.GetPetTalentTree() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.GetPetTamersForMap) +---@param uiMapID number +---@return PetTamerMapInfo[] petTamers +function C_PetInfo.GetPetTamersForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.GetSpellForPetAction) +---@param actionID number +---@return number? spellID +function C_PetInfo.GetSpellForPetAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.IsPetActionPassive) +---@param actionID number +---@return boolean isPassive +function C_PetInfo.IsPetActionPassive(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.PetAbandon) +---@param petNumber? number +function C_PetInfo.PetAbandon(petNumber) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.PetAssistMode) +function C_PetInfo.PetAssistMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetInfo.PetRename) +---@param name string +---@param petNumber? number +---@param declensions? string[] +function C_PetInfo.PetRename(name, petNumber, declensions) end + +---@class PetTamerMapInfo +---@field areaPoiID number +---@field position vector2 +---@field name string +---@field atlasName string? +---@field textureIndex number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua new file mode 100644 index 0000000..db9b293 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua @@ -0,0 +1,143 @@ +---@meta _ +C_PetJournal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.ClearHoveredBattlePet) +function C_PetJournal.ClearHoveredBattlePet() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.ClearSearchFilter) +function C_PetJournal.ClearSearchFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.DismissSummonedPet) +---@param petID WOWGUID +function C_PetJournal.DismissSummonedPet(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetDisplayIDByIndex) +---@param speciesID number +---@param index number +---@return number? displayID +function C_PetJournal.GetDisplayIDByIndex(speciesID, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetDisplayProbabilityByIndex) +---@param speciesID number +---@param index number +---@return number? displayProbability +function C_PetJournal.GetDisplayProbabilityByIndex(speciesID, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNonBattlePetLinkByIndex) +---@param index number +---@return string link +function C_PetJournal.GetNonBattlePetLinkByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumDisplays) +---@param speciesID number +---@return number? numDisplays +function C_PetJournal.GetNumDisplays(speciesID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumPetsInJournal) +---@param creatureID number +---@return number maxAllowed +---@return number numPets +function C_PetJournal.GetNumPetsInJournal(creatureID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetOwnedPetIDs) +---@return WOWGUID[] ownedPetIDs +function C_PetJournal.GetOwnedPetIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetAbilityInfo) +---@param abilityID number +---@return string name +---@return fileID icon +---@return number petType +function C_PetJournal.GetPetAbilityInfo(abilityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetAbilityListTable) +---@param speciesID number +---@return PetAbilityLevelInfo[] info +function C_PetJournal.GetPetAbilityListTable(speciesID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetInfoTableByPetID) +---@param petID WOWGUID +---@return PetJournalPetInfo info +function C_PetJournal.GetPetInfoTableByPetID(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetLoadOutInfo) +---@param slot number +---@return WOWGUID? petID +---@return number ability1ID +---@return number ability2ID +---@return number ability3ID +---@return boolean locked +function C_PetJournal.GetPetLoadOutInfo(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetSummonInfo) +---@param battlePetGUID WOWGUID +---@return boolean isSummonable +---@return Enum.PetJournalError error +---@return string errorText +function C_PetJournal.GetPetSummonInfo(battlePetGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetSearchFilter) +---@return string filterText +function C_PetJournal.GetSearchFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.HasFavoritePets) +---@return boolean hasFavorites +function C_PetJournal.HasFavoritePets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsCurrentlySummoned) +---@param petID WOWGUID +---@return boolean isSummoned +function C_PetJournal.IsCurrentlySummoned(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsUsingDefaultFilters) +---@return boolean isUsingDefaultFilters +function C_PetJournal.IsUsingDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsSummonable) +---@param battlePetGUID WOWGUID +---@return boolean isSummonable +function C_PetJournal.PetIsSummonable(battlePetGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetUsesRandomDisplay) +---@param speciesID number +---@return boolean? usesRandomDisplay +function C_PetJournal.PetUsesRandomDisplay(speciesID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetDefaultFilters) +function C_PetJournal.SetDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetHoveredBattlePet) +---@param battlePetGUID WOWGUID +function C_PetJournal.SetHoveredBattlePet(battlePetGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetSearchFilter) +---@param filterText string +function C_PetJournal.SetSearchFilter(filterText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SpellTargetBattlePet) +---@param battlePetGUID WOWGUID +function C_PetJournal.SpellTargetBattlePet(battlePetGUID) end + +---@class PetAbilityLevelInfo +---@field abilityID number +---@field level number + +---@class PetJournalPetInfo +---@field speciesID number +---@field customName string? +---@field petLevel number +---@field xp number +---@field maxXP number +---@field displayID number +---@field isFavorite boolean +---@field icon fileID +---@field petType number +---@field creatureID number +---@field name string? +---@field sourceText string +---@field description string +---@field isWild boolean +---@field canBattle boolean +---@field tradable boolean +---@field unique boolean +---@field obtainable boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PhotoSharingUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PhotoSharingUIDocumentation.lua new file mode 100644 index 0000000..0e3a9b9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PhotoSharingUIDocumentation.lua @@ -0,0 +1,44 @@ +---@meta _ +C_PhotoSharing = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.BeginAuthorizationFlow) +function C_PhotoSharing.BeginAuthorizationFlow() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.ClearAuthorization) +function C_PhotoSharing.ClearAuthorization() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.CompleteAuthorizationFlow) +---@param callbackURL string +function C_PhotoSharing.CompleteAuthorizationFlow(callbackURL) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.GetCropRatio) +---@return number cropRatio +function C_PhotoSharing.GetCropRatio() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.GetPhotoSharingAuthURL) +---@return string authUrl +function C_PhotoSharing.GetPhotoSharingAuthURL() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.GetStatus) +---@return Enum.PhotoSharingStatus status +function C_PhotoSharing.GetStatus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.IsAuthorized) +---@return boolean authorized +function C_PhotoSharing.IsAuthorized() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.IsEnabled) +---@return boolean enabled +function C_PhotoSharing.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.SetScreenshotPreviewTexture) +---@param textureObject SimpleTexture +function C_PhotoSharing.SetScreenshotPreviewTexture(textureObject) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.TakePhoto) +function C_PhotoSharing.TakePhoto() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PhotoSharing.UploadPhotoToService) +---@param optionalTitle? string Default = +---@param optionalDescription? string Default = +function C_PhotoSharing.UploadPhotoToService(optionalTitle, optionalDescription) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua new file mode 100644 index 0000000..16a328c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +---@class ContextualWorldPingResult +---@field contextualPingType Enum.PingSubjectType? +---@field result Enum.PingResult + +---@class PingCooldownInfo +---@field startTimeMs number +---@field endTimeMs number + +---@class PingTypeInfo +---@field orderIndex number +---@field type Enum.PingSubjectType +---@field uiTextureKitID textureKit diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua new file mode 100644 index 0000000..d840fc5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua @@ -0,0 +1,33 @@ +---@meta _ +C_Ping = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.GetContextualPingTypeForUnit) +---@param targetUnit? WOWGUID +---@return Enum.PingSubjectType type +function C_Ping.GetContextualPingTypeForUnit(targetUnit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.GetCooldownInfo) +---@return PingCooldownInfo cooldownInfo +function C_Ping.GetCooldownInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.GetDefaultPingOptions) +---@return PingTypeInfo[] pingTypes +function C_Ping.GetDefaultPingOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.GetTextureKitForType) +---@param type Enum.PingSubjectType +---@return textureKit uiTextureKitID +function C_Ping.GetTextureKitForType(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.IsPingSystemEnabled) +---@return boolean isEnabled +function C_Ping.IsPingSystemEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.SendMacroPing) +---@param type? Enum.PingSubjectType +---@param targetToken? string +function C_Ping.SendMacroPing(type, targetToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Ping.TogglePingListener) +---@param down boolean +function C_Ping.TogglePingListener(down) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua new file mode 100644 index 0000000..cd4f27a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua @@ -0,0 +1,82 @@ +---@meta _ +C_PingSecure = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.ClearPendingPingInfo) +function C_PingSecure.ClearPendingPingInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.CreateFrame) +function C_PingSecure.CreateFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.DisplayError) +---@param error string +function C_PingSecure.DisplayError(error) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.GetTargetPingReceiver) +---@param mousePosX number +---@param mousePosY number +---@return ScriptRegion frame +function C_PingSecure.GetTargetPingReceiver(mousePosX, mousePosY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.GetTargetWorldPing) +---@param mousePosX number +---@param mousePosY number +---@return boolean foundTarget +function C_PingSecure.GetTargetWorldPing(mousePosX, mousePosY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.GetTargetWorldPingAndSend) +---@return ContextualWorldPingResult result +function C_PingSecure.GetTargetWorldPingAndSend() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SendPing) +---@param type Enum.PingSubjectType +---@param target? WOWGUID +---@return Enum.PingResult result +function C_PingSecure.SendPing(type, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetPendingPingOffScreenCallback) +---@param cb PendingPingOffScreenCallback +function C_PingSecure.SetPendingPingOffScreenCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetPingCooldownStartedCallback) +---@param cb PingCooldownStartedCallback +function C_PingSecure.SetPingCooldownStartedCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetPingPinFrameAddedCallback) +---@param cb PingPinFrameAddedCallback +function C_PingSecure.SetPingPinFrameAddedCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetPingPinFrameRemovedCallback) +---@param cb PingPinFrameRemovedCallback +function C_PingSecure.SetPingPinFrameRemovedCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetPingPinFrameScreenClampStateUpdatedCallback) +---@param cb PingPinFrameScreenClampStateUpdatedCallback +function C_PingSecure.SetPingPinFrameScreenClampStateUpdatedCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetPingRadialWheelCreatedCallback) +---@param cb PingRadialWheelCreatedCallback +function C_PingSecure.SetPingRadialWheelCreatedCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetSendMacroPingCallback) +---@param cb SendMacroPingCallback +function C_PingSecure.SetSendMacroPingCallback(cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PingSecure.SetTogglePingListenerCallback) +---@param cb TogglePingListenerCallback +function C_PingSecure.SetTogglePingListenerCallback(cb) end + +---@alias PendingPingOffScreenCallback FunctionContainer|fun() + +---@alias PingCooldownStartedCallback FunctionContainer|fun(info: PingCooldownInfo) + +---@alias PingPinFrameAddedCallback FunctionContainer|fun(region: ScriptRegion, uiTextureKit: textureKit, isWorldPoint: boolean) + +---@alias PingPinFrameRemovedCallback FunctionContainer|fun(region: ScriptRegion) + +---@alias PingPinFrameScreenClampStateUpdatedCallback FunctionContainer|fun(region: ScriptRegion, state: boolean) + +---@alias PingRadialWheelCreatedCallback FunctionContainer|fun(region: ScriptRegion) + +---@alias SendMacroPingCallback FunctionContainer|fun(type?: Enum.PingSubjectType, targetToken?: string) + +---@alias TogglePingListenerCallback FunctionContainer|fun(down: boolean) diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua new file mode 100644 index 0000000..3d8a068 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua @@ -0,0 +1,96 @@ +---@meta _ +C_PlayerChoice = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.GetCurrentPlayerChoiceInfo) +---@return PlayerChoiceInfo choiceInfo +function C_PlayerChoice.GetCurrentPlayerChoiceInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.GetNumRerolls) +---@return number numRerolls +function C_PlayerChoice.GetNumRerolls() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.GetRemainingTime) +---@return number? remainingTime +function C_PlayerChoice.GetRemainingTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.IsWaitingForPlayerChoiceResponse) +---@return boolean isWaitingForResponse +function C_PlayerChoice.IsWaitingForPlayerChoiceResponse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.OnUIClosed) +function C_PlayerChoice.OnUIClosed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.RequestRerollPlayerChoice) +function C_PlayerChoice.RequestRerollPlayerChoice() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerChoice.SendPlayerChoiceResponse) +---@param responseID number +function C_PlayerChoice.SendPlayerChoiceResponse(responseID) end + +---@class PlayerChoiceInfo +---@field objectGUID WOWGUID +---@field choiceID number +---@field questionText string +---@field pendingChoiceText string +---@field uiTextureKit textureKit +---@field hideWarboardHeader boolean +---@field keepOpenAfterChoice boolean +---@field showChoicesAsList boolean +---@field requiresSelection boolean +---@field options PlayerChoiceOptionInfo[] +---@field soundKitID number? +---@field closeUISoundKitID number? + +---@class PlayerChoiceOptionButtonInfo +---@field id number +---@field text string +---@field disabled boolean +---@field showCheckmark boolean +---@field hideButtonShowText boolean +---@field selected boolean +---@field confirmation string? +---@field tooltip string? +---@field rewardQuestID number? +---@field soundKitID number? +---@field listText string? + +---@class PlayerChoiceOptionInfo +---@field id number +---@field description string +---@field header string +---@field choiceArtID number +---@field desaturatedArt boolean +---@field disabledOption boolean +---@field hasRewards boolean +---@field rewardInfo PlayerChoiceOptionRewardInfo +---@field uiTextureKit textureKit +---@field maxStacks number +---@field buttons PlayerChoiceOptionButtonInfo[] +---@field widgetSetID number? +---@field spellID number? +---@field rarity Enum.PlayerChoiceRarity? +---@field typeArtID number? +---@field headerIconAtlasElement string? +---@field subHeader string? +---@field consolidateWidgets boolean + +---@class PlayerChoiceOptionRewardInfo +---@field currencyRewards PlayerChoiceRewardCurrencyInfo[] +---@field itemRewards PlayerChoiceRewardItemInfo[] +---@field repRewards PlayerChoiceRewardReputationInfo[] + +---@class PlayerChoiceRewardCurrencyInfo +---@field currencyId number +---@field name string +---@field currencyTexture number +---@field quantity number +---@field isCurrencyContainer boolean + +---@class PlayerChoiceRewardItemInfo +---@field itemId number +---@field name string +---@field quantity number + +---@class PlayerChoiceRewardReputationInfo +---@field factionId number +---@field quantity number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua new file mode 100644 index 0000000..42bdebe --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua @@ -0,0 +1,153 @@ +---@meta _ +C_PlayerInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.CanPlayerEnterChromieTime) +---@return boolean canEnter +function C_PlayerInfo.CanPlayerEnterChromieTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.CanPlayerUseAreaLoot) +---@return boolean canUseAreaLoot +function C_PlayerInfo.CanPlayerUseAreaLoot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.CanPlayerUseMountEquipment) +---@return boolean canUseMountEquipment +---@return string failureReason +function C_PlayerInfo.CanPlayerUseMountEquipment() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.CanUseItem) +---@param itemID number +---@return boolean isUseable +function C_PlayerInfo.CanUseItem(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetAlternateFormInfo) +---@return boolean hasAlternateForm +---@return boolean inAlternateForm +function C_PlayerInfo.GetAlternateFormInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetContentDifficultyCreatureForPlayer) +---@param unitToken UnitToken +---@return Enum.RelativeContentDifficulty difficulty +function C_PlayerInfo.GetContentDifficultyCreatureForPlayer(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetContentDifficultyQuestForPlayer) +---@param questID number +---@return Enum.RelativeContentDifficulty difficulty +function C_PlayerInfo.GetContentDifficultyQuestForPlayer(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetDisplayID) +---@return number displayID +function C_PlayerInfo.GetDisplayID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetGlidingInfo) +---@return boolean isGliding +---@return boolean canGlide +---@return number forwardSpeed +function C_PlayerInfo.GetGlidingInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetInstancesUnlockedAtLevel) +---@param level number +---@param isRaid boolean +---@return number[] dungeonID +function C_PlayerInfo.GetInstancesUnlockedAtLevel(level, isRaid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetNativeDisplayID) +---@return number nativeDisplayID +function C_PlayerInfo.GetNativeDisplayID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetPetStableCreatureDisplayInfoID) +---@param index number +---@return number creatureDisplayInfoID +function C_PlayerInfo.GetPetStableCreatureDisplayInfoID(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetPlayerCharacterData) +---@return PlayerInfoCharacterData characterData +function C_PlayerInfo.GetPlayerCharacterData() end + +---Returns the players mythic+ rating summary which includes the runs they've completed as well as their current season m+ rating +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetPlayerMythicPlusRatingSummary) +---@param playerToken UnitToken +---@return MythicPlusRatingSummary ratingSummary +function C_PlayerInfo.GetPlayerMythicPlusRatingSummary(playerToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.HasAccountInventoryLock) +---@return boolean hasAccountInventoryLock +function C_PlayerInfo.HasAccountInventoryLock() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.HasVisibleInvSlot) +---@param slot number +---@return boolean isVisible +function C_PlayerInfo.HasVisibleInvSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsAccountBankEnabled) +---@return boolean isAccountBankEnabled +function C_PlayerInfo.IsAccountBankEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsCharacterBankEnabled) +---@return boolean isCharacterBankEnabled +function C_PlayerInfo.IsCharacterBankEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsDisplayRaceNative) +---@return boolean isDisplayRaceNative +function C_PlayerInfo.IsDisplayRaceNative() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsMirrorImage) +---@return boolean isMirrorImage +function C_PlayerInfo.IsMirrorImage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsPlayerEligibleForNPE) +---@return boolean isEligible +---@return string failureReason +function C_PlayerInfo.IsPlayerEligibleForNPE() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsPlayerEligibleForNPEv2) +---@return boolean isEligible +---@return string failureReason +function C_PlayerInfo.IsPlayerEligibleForNPEv2() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsPlayerInChromieTime) +---@return boolean inChromieTime +function C_PlayerInfo.IsPlayerInChromieTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsPlayerInRPE) +---@return boolean isInRPE +function C_PlayerInfo.IsPlayerInRPE() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsPlayerInTimerunningHeroicWorldTier) +---@return boolean inTimerunningHeroicWorldTier +function C_PlayerInfo.IsPlayerInTimerunningHeroicWorldTier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsPlayerNPERestricted) +---@return boolean isRestricted +function C_PlayerInfo.IsPlayerNPERestricted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsReturningCharacter) +---@return boolean isReturning +function C_PlayerInfo.IsReturningCharacter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsSelfFoundActive) +---@return boolean active +function C_PlayerInfo.IsSelfFoundActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsTradingPostAvailable) +---@return boolean isAvailable +function C_PlayerInfo.IsTradingPostAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsTravelersLogAvailable) +---@return boolean isAvailable +function C_PlayerInfo.IsTravelersLogAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsTutorialsTabAvailable) +---@return boolean isAvailable +function C_PlayerInfo.IsTutorialsTabAvailable() end + +---@class MythicPlusRatingMapSummary +---@field challengeModeID number +---@field mapScore number +---@field bestRunLevel number +---@field bestRunDurationMS number +---@field finishedSuccess boolean + +---@class MythicPlusRatingSummary +---@field currentSeasonScore number +---@field runs MythicPlusRatingMapSummary[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua new file mode 100644 index 0000000..616be04 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +---@class CharacterAlternateFormData +---@field raceID number +---@field name string +---@field fileName string +---@field createScreenIconAtlas textureAtlas + +---@class PlayerInfoCharacterData +---@field name string +---@field fileName string +---@field alternateFormRaceData CharacterAlternateFormData? +---@field createScreenIconAtlas textureAtlas +---@field sex Enum.UnitSex diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua new file mode 100644 index 0000000..f15d673 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua @@ -0,0 +1,34 @@ +---@meta _ +C_PlayerInteractionManager = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.ClearInteraction) +---@param type? Enum.PlayerInteractionType +function C_PlayerInteractionManager.ClearInteraction(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.ConfirmationInteraction) +---@param type? Enum.PlayerInteractionType +function C_PlayerInteractionManager.ConfirmationInteraction(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.InteractUnit) +---@param unit string +---@param exactMatch? boolean Default = false +---@param looseTargeting? boolean Default = true +---@return boolean success +function C_PlayerInteractionManager.InteractUnit(unit, exactMatch, looseTargeting) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.IsInteractingWithNpcOfType) +---@param type Enum.PlayerInteractionType +---@return boolean interacting +function C_PlayerInteractionManager.IsInteractingWithNpcOfType(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.IsReplacingUnit) +---@return boolean replacing +function C_PlayerInteractionManager.IsReplacingUnit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.IsValidNPCInteraction) +---@param type Enum.PlayerInteractionType +---@return boolean isValidInteraction +function C_PlayerInteractionManager.IsValidNPCInteraction(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInteractionManager.ReopenInteraction) +function C_PlayerInteractionManager.ReopenInteraction() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua new file mode 100644 index 0000000..ff1902e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua @@ -0,0 +1,39 @@ +---@meta _ +C_PlayerInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GUIDIsPlayer) +---@param guid WOWGUID +---@return boolean isPlayer +function C_PlayerInfo.GUIDIsPlayer(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetClass) +---@param playerLocation PlayerLocation +---@return string? className +---@return string? classFilename +---@return number? classID +function C_PlayerInfo.GetClass(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetName) +---@param playerLocation PlayerLocation +---@return string? name +function C_PlayerInfo.GetName(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetRace) +---@param playerLocation PlayerLocation +---@return number? raceID +function C_PlayerInfo.GetRace(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.GetSex) +---@param playerLocation PlayerLocation +---@return Enum.UnitSex? sex +function C_PlayerInfo.GetSex(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.IsConnected) +---@param playerLocation? PlayerLocation +---@return boolean? isConnected +function C_PlayerInfo.IsConnected(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerInfo.UnitIsSameServer) +---@param playerLocation PlayerLocation +---@return boolean unitIsSameServer +function C_PlayerInfo.UnitIsSameServer(playerLocation) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua new file mode 100644 index 0000000..4604573 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua @@ -0,0 +1,25 @@ +---@meta _ +C_PlayerMentorship = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerMentorship.GetMentorLevelRequirement) +---@return number? level +function C_PlayerMentorship.GetMentorLevelRequirement() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerMentorship.GetMentorRequirements) +---@return number[] achievementIDs +---@return number[] optionalAchievementIDs +---@return number optionalCompleteAtLeastCount +function C_PlayerMentorship.GetMentorRequirements() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerMentorship.GetMentorshipStatus) +---@param playerLocation PlayerLocation +---@return Enum.PlayerMentorshipStatus status +function C_PlayerMentorship.GetMentorshipStatus(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerMentorship.IsActivePlayerConsideredNewcomer) +---@return boolean isConsideredNewcomer +function C_PlayerMentorship.IsActivePlayerConsideredNewcomer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PlayerMentorship.IsMentorRestricted) +---@return boolean isRestricted +function C_PlayerMentorship.IsMentorRestricted() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua new file mode 100644 index 0000000..f610eb1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua @@ -0,0 +1,714 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptAreaSpiritHeal) +function AcceptAreaSpiritHeal() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptGuild) +function AcceptGuild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptResurrect) +function AcceptResurrect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Ambiguate) +---@param fullName string +---@param context string +---@return string result +function Ambiguate(fullName, context) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AutoEquipCursorItem) +function AutoEquipCursorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BeginTrade) +function BeginTrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanDualWield) +---@return boolean result +function CanDualWield() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanInspect) +---@param targetGUID UnitToken +---@return boolean result +function CanInspect(targetGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanLootUnit) +---@param targetUnit WOWGUID +---@return boolean hasLoot +---@return boolean canLoot +function CanLootUnit(targetUnit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelAreaSpiritHeal) +function CancelAreaSpiritHeal() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelPendingEquip) +---@param index number +function CancelPendingEquip(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelTrade) +function CancelTrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckInteractDistance) +---@param unitGUID UnitToken +---@param distIndex number +---@return boolean result +function CheckInteractDistance(unitGUID, distIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckTalentMasterDist) +---@return boolean result +function CheckTalentMasterDist() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearPendingBindConversionItem) +function ClearPendingBindConversionItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConfirmTalentWipe) +function ConfirmTalentWipe() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConvertItemToBindToAccount) +function ConvertItemToBindToAccount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineGuild) +function DeclineGuild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineResurrect) +function DeclineResurrect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Dismount) +function Dismount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EquipPendingItem) +---@param index number +function EquipPendingItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FollowUnit) +---@param name? string Default = 0 +---@param exactMatch? boolean Default = false +function FollowUnit(name, exactMatch) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAllowLowLevelRaid) +---@return boolean result +function GetAllowLowLevelRaid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAllowRecentAlliesSeeLocation) +---@return boolean allowRecentAlliesSeeLocation +function GetAllowRecentAlliesSeeLocation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAreaSpiritHealerTime) +---@return number result +function GetAreaSpiritHealerTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAttackPowerForStat) +---@param stat number +---@param value number +---@return number result +function GetAttackPowerForStat(stat, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAutoDeclineGuildInvites) +---@return boolean result +function GetAutoDeclineGuildInvites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAutoDeclineNeighborhoodInvites) +---@return boolean result +function GetAutoDeclineNeighborhoodInvites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvoidance) +---@return number result +function GetAvoidance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBindLocation) +---@return string result +function GetBindLocation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBlockChance) +---@return number result +function GetBlockChance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCemeteryPreference) +---@return number result +function GetCemeteryPreference() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCollapsingStarCost) +---@return number cost +function GetCollapsingStarCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCombatRating) +---@param ratingIndex number +---@return number? result +function GetCombatRating(ratingIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCombatRatingBonus) +---@param ratingIndex number +---@return number? result +function GetCombatRatingBonus(ratingIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCombatRatingBonusForCombatRatingValue) +---@param ratingIndex number +---@param value number +---@return number? result +function GetCombatRatingBonusForCombatRatingValue(ratingIndex, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCorpseRecoveryDelay) +---@return number result +function GetCorpseRecoveryDelay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCorruption) +---@return number result +function GetCorruption() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCorruptionResistance) +---@return number result +function GetCorruptionResistance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCritChance) +---@return number result +function GetCritChance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCritChanceProvidesParryEffect) +---@return boolean result +function GetCritChanceProvidesParryEffect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDodgeChance) +---@return number result +function GetDodgeChance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDodgeChanceFromAttribute) +---@return number result +function GetDodgeChanceFromAttribute() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetExpertise) +---@return number mainhandExpertise +---@return number offhandExpertise +---@return number rangedExpertise +function GetExpertise() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetExpertisePercent) +---@return number mainhandExpertisePercent +---@return number offhandExpertisePercent +---@return number rangedExpertisePercent +function GetExpertisePercent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetHaste) +---@return number result +function GetHaste() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetHitModifier) +---@return number result +function GetHitModifier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetJailersTowerLevel) +---@return number result +function GetJailersTowerLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLifesteal) +---@return number result +function GetLifesteal() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootSpecialization) +---@return number specializationID +function GetLootSpecialization() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetManaRegen) +---@return number baseManaRegen +---@return number castingManaRegen +function GetManaRegen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMastery) +---@return number result +function GetMastery() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMasteryEffect) +---@return number masteryEffect +---@return number bonusCoefficient +function GetMasteryEffect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxPlayerLevel) +---@return number maxPlayerLevel +function GetMaxPlayerLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMeleeHaste) +---@return number result +function GetMeleeHaste() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetModResilienceDamageReduction) +---@return number result +function GetModResilienceDamageReduction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMoney) +---@return number result +function GetMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNormalizedRealmName) +---@return string result +function GetNormalizedRealmName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetOverrideAPBySpellPower) +---@return number result +function GetOverrideAPBySpellPower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetOverrideSpellPowerByAP) +---@return number result +function GetOverrideSpellPowerByAP() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPDesired) +---@return boolean result +function GetPVPDesired() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPGearStatRules) +---@return boolean result +function GetPVPGearStatRules() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPLifetimeStats) +---@return number lifetimeHonorableKills +---@return Enum.PvPRanks lifetimeMaxPVPRank +function GetPVPLifetimeStats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPSessionStats) +---@return number honorableKills +---@return number dishonorableKills +function GetPVPSessionStats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPTimer) +---@return number result +function GetPVPTimer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPYesterdayStats) +---@return number honorableKills +---@return number dishonorableKills +function GetPVPYesterdayStats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetParryChance) +---@return number result +function GetParryChance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetParryChanceFromAttribute) +---@return number result +function GetParryChanceFromAttribute() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetMeleeHaste) +---@return number result +function GetPetMeleeHaste() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetSpellBonusDamage) +---@return number result +function GetPetSpellBonusDamage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPlayerFacing) +---@return number? result +function GetPlayerFacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPlayerInfoByGUID) +---@param guid WOWGUID +---@return string localizedClass +---@return string englishClass +---@return string localizedRace +---@return string englishRace +---@return number sex +---@return string name +---@return string realmName +function GetPlayerInfoByGUID(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPowerRegen) +---@return number basePowerRegen +---@return number castingPowerRegen +function GetPowerRegen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPowerRegenForPowerType) +---@param powerType number +---@return number basePowerRegen +---@return number castingPowerRegen +function GetPowerRegenForPowerType(powerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPvpPowerDamage) +---@return number result +function GetPvpPowerDamage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPvpPowerHealing) +---@return number result +function GetPvpPowerHealing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRangedCritChance) +---@return number result +function GetRangedCritChance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRangedHaste) +---@return number result +function GetRangedHaste() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetReleaseTimeRemaining) +---@return number result +function GetReleaseTimeRemaining() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetResSicknessDuration) +---@return string? result +function GetResSicknessDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRestState) +---@return number exhaustionID +---@return string name +---@return number factor +function GetRestState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRestrictedAccountData) +---@return number maxLevel +---@return WOWMONEY maxMoney +---@return number professionCap +function GetRestrictedAccountData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRuneCooldown) +---@param runeIndex number +---@return number startTime +---@return number duration +---@return boolean isRuneReady +function GetRuneCooldown(runeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRuneCount) +---@param runeIndex number +---@return number result +function GetRuneCount(runeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSheathState) +---@return number? result +function GetSheathState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetShieldBlock) +---@return number result +function GetShieldBlock() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpeed) +---@return number result +function GetSpeed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellBonusDamage) +---@param school number +---@return number? result +function GetSpellBonusDamage(school) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellBonusHealing) +---@return number result +function GetSpellBonusHealing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellCritChance) +---@return number result +function GetSpellCritChance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellHitModifier) +---@return number result +function GetSpellHitModifier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellPenetration) +---@return number result +function GetSpellPenetration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSturdiness) +---@return number result +function GetSturdiness() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTaxiBenchmarkMode) +---@return boolean result +function GetTaxiBenchmarkMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetVersatilityBonus) +---@param combatRating number +---@return number result +function GetVersatilityBonus(combatRating) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetXPExhaustion) +---@return number? result +function GetXPExhaustion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasAPEffectsSpellPower) +---@return boolean result +function HasAPEffectsSpellPower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasDualWieldPenalty) +---@return boolean result +function HasDualWieldPenalty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasFullControl) +---@return boolean result +function HasFullControl() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasIgnoreDualWieldWeapon) +---@return boolean result +function HasIgnoreDualWieldWeapon() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasKey) +---@return boolean hasKey +function HasKey() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasNoReleaseAura) +---@return boolean hasCannotReleaseEffect +---@return number longestDuration +---@return boolean hasUntilCancelledDuration +function HasNoReleaseAura() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasSPEffectsAttackPower) +---@return boolean result +function HasSPEffectsAttackPower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InitiateTrade) +---@param guid UnitToken +function InitiateTrade(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsAccountSecured) +---@return boolean result +function IsAccountSecured() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsAdvancedFlyableArea) +---@return boolean result +function IsAdvancedFlyableArea() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsCemeterySelectionAvailable) +---@return boolean result +function IsCemeterySelectionAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsCharacterNewlyBoosted) +---@return boolean newlyBoosted +function IsCharacterNewlyBoosted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsDrivableArea) +---@return boolean result +function IsDrivableArea() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsDualWielding) +---@return boolean result +function IsDualWielding() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsFlyableArea) +---@return boolean result +function IsFlyableArea() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGuildLeader) +---@return boolean result +function IsGuildLeader() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInGuild) +---@return boolean result +function IsInGuild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInJailersTower) +---@return boolean result +function IsInJailersTower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsIndoors) +---@return boolean result +function IsIndoors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInsane) +---@return boolean result +function IsInsane() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsItemPreferredArmorType) +---@param itemLocation ItemLocation +---@return boolean isItemPreferredArmorType +function IsItemPreferredArmorType(itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsJailersTowerLayerTimeLocked) +---@param layerLevel number +---@return string result +function IsJailersTowerLayerTimeLocked(layerLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLoggedIn) +---@return boolean result +function IsLoggedIn() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMounted) +---@return boolean result +function IsMounted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsOnGroundFloorInJailersTower) +---@return boolean result +function IsOnGroundFloorInJailersTower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsOutOfBounds) +---@return boolean result +function IsOutOfBounds() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsOutdoors) +---@return boolean result +function IsOutdoors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPVPTimerRunning) +---@return boolean result +function IsPVPTimerRunning() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPlayerInWorld) +---@return boolean result +function IsPlayerInWorld() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPlayerMoving) +---@return boolean result +function IsPlayerMoving() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRangedWeapon) +---@return boolean result +function IsRangedWeapon() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsResting) +---@return boolean result +function IsResting() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRestrictedAccount) +---@return boolean result +function IsRestrictedAccount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsStealthed) +---@return boolean result +function IsStealthed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsXPUserDisabled) +---@return boolean result +function IsXPUserDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_NoPlayTime) +---@return boolean? result +function NoPlayTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_NotifyInspect) +---@param targetGUID UnitToken +function NotifyInspect(targetGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PartialPlayTime) +---@return boolean? result +function PartialPlayTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerCanTeleport) +---@return boolean result +function PlayerCanTeleport() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerEffectiveAttackPower) +---@return number mainHandAttackPower +---@return number offHandAttackPower +---@return number rangedAttackPower +---@return number baseAttackPower +---@return number baseRangedAttackPower +function PlayerEffectiveAttackPower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerGetTimerunningSeasonID) +---@return number? timerunningSeasonID +function PlayerGetTimerunningSeasonID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerIsInCombat) +---@return boolean playerIsInCombat +function PlayerIsInCombat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerIsTimerunning) +---@return boolean playerIsTimerunning +function PlayerIsTimerunning() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PortGraveyard) +function PortGraveyard() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RandomRoll) +---@param min number +---@param max number +function RandomRoll(min, max) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RepopMe) +function RepopMe() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestTimePlayed) +function RequestTimePlayed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RespondInstanceLock) +---@param acceptLock boolean +function RespondInstanceLock(acceptLock) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResurrectGetOfferer) +---@return string name +function ResurrectGetOfferer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResurrectHasSickness) +---@return boolean result +function ResurrectHasSickness() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResurrectHasTimer) +---@return boolean result +function ResurrectHasTimer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RetrieveCorpse) +function RetrieveCorpse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAllowLowLevelRaid) +---@param allow? boolean Default = false +function SetAllowLowLevelRaid(allow) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAllowRecentAlliesSeeLocation) +---@param allowRecentAlliesSeeLocation boolean +function SetAllowRecentAlliesSeeLocation(allowRecentAlliesSeeLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAutoDeclineGuildInvites) +---@param allow? boolean Default = false +function SetAutoDeclineGuildInvites(allow) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAutoDeclineNeighborhoodInvites) +---@param allow? boolean Default = false +function SetAutoDeclineNeighborhoodInvites(allow) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCemeteryPreference) +---@param cemetaryID number +function SetCemeteryPreference(cemetaryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLootSpecialization) +---@param specializationID number +function SetLootSpecialization(specializationID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetTaxiBenchmarkMode) +---@param enable? boolean Default = false +function SetTaxiBenchmarkMode(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShouldShowIslandsWeeklyPOI) +---@return boolean result +function ShouldShowIslandsWeeklyPOI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShouldShowSpecialSplashScreen) +---@return boolean result +function ShouldShowSpecialSplashScreen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowCloak) +---@param show boolean +function ShowCloak(show) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowHelm) +---@param show boolean +function ShowHelm(show) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowingCloak) +---@return boolean result +function ShowingCloak() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowingHelm) +---@return boolean result +function ShowingHelm() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SitStandOrDescendStart) +function SitStandOrDescendStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SplashFrameCanBeShown) +---@return boolean result +function SplashFrameCanBeShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartAttack) +---@param name? string Default = 0 +---@param exactMatch? boolean Default = false +function StartAttack(name, exactMatch) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StopAttack) +function StopAttack() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Stuck) +function Stuck() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TimeoutResurrect) +function TimeoutResurrect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleSelfHighlight) +---@return boolean enabled +function ToggleSelfHighlight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleSheath) +function ToggleSheath() end + +---@class PlayerAttackPowerInfo +---@field mainHandAttackPower number +---@field offHandAttackPower number +---@field rangedAttackPower number +---@field baseAttackPower number +---@field baseRangedAttackPower number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PortraitDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PortraitDocumentation.lua new file mode 100644 index 0000000..12666e3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PortraitDocumentation.lua @@ -0,0 +1,5 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPortraitToTexture) +---@param texture SimpleTexture +---@param asset TextureAssetDisk +function SetPortraitToTexture(texture, asset) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua new file mode 100644 index 0000000..4939b8f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua @@ -0,0 +1,22 @@ +---@meta _ +---@class ProfTabHighlight +---@field description string + +---@class ProfTabInfo +---@field rootNodeID number +---@field name string +---@field description string +---@field rootIconID number +---@field highlights ProfTabHighlight[] + +---@class SpecPerkInfo +---@field perkID number +---@field isMajorPerk boolean + +---@class SpecializationCurrencyInfo +---@field numAvailable number +---@field currencyName string + +---@class SpecializationTabInfo +---@field enabled boolean? Default = true +---@field errorReason string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua new file mode 100644 index 0000000..e510fc7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua @@ -0,0 +1,138 @@ +---@meta _ +C_ProfSpecs = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.CanRefundPath) +---@param pathID number +---@param configID number +---@return boolean canRefund +function C_ProfSpecs.CanRefundPath(pathID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.CanUnlockTab) +---@param tabTreeID number +---@param configID number +---@return boolean canUnlock +function C_ProfSpecs.CanUnlockTab(tabTreeID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetChildrenForPath) +---@param pathID number +---@return number[] childIDs +function C_ProfSpecs.GetChildrenForPath(pathID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetConfigIDForSkillLine) +---@param skillLineID number +---@return number configID +function C_ProfSpecs.GetConfigIDForSkillLine(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetCurrencyInfoForSkillLine) +---@param skillLineID number +---@return SpecializationCurrencyInfo info +function C_ProfSpecs.GetCurrencyInfoForSkillLine(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetDefaultSpecSkillLine) +---@return number? defaultSpecSkillLine +function C_ProfSpecs.GetDefaultSpecSkillLine() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetDescriptionForPath) +---@param pathID number +---@return string description +function C_ProfSpecs.GetDescriptionForPath(pathID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetDescriptionForPerk) +---@param perkID number +---@return string description +function C_ProfSpecs.GetDescriptionForPerk(perkID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetEntryIDForPerk) +---@param perkID number +---@return number entryID +function C_ProfSpecs.GetEntryIDForPerk(perkID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetNewSpecReminderProfName) +---@return string? profName +function C_ProfSpecs.GetNewSpecReminderProfName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetPerksForPath) +---@param pathID number +---@return SpecPerkInfo[] perkInfos +function C_ProfSpecs.GetPerksForPath(pathID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetRootPathForTab) +---@param tabTreeID number +---@return number? rootPathID +function C_ProfSpecs.GetRootPathForTab(tabTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetSourceTextForPath) +---@param pathID number +---@param configID number +---@return string sourceText +function C_ProfSpecs.GetSourceTextForPath(pathID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetSpecTabIDsForSkillLine) +---@param skillLineID number +---@return number[] specTabIDs +function C_ProfSpecs.GetSpecTabIDsForSkillLine(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetSpecTabInfo) +---@return SpecializationTabInfo specTabInfo +function C_ProfSpecs.GetSpecTabInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetSpendCurrencyForPath) +---@param pathID number +---@return number? currencyID +function C_ProfSpecs.GetSpendCurrencyForPath(pathID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetSpendEntryForPath) +---@param pathID number +---@return number entryID +function C_ProfSpecs.GetSpendEntryForPath(pathID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetStateForPath) +---@param pathID number +---@param configID number +---@return Enum.ProfessionsSpecPathState state +function C_ProfSpecs.GetStateForPath(pathID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetStateForPerk) +---@param perkID number +---@param configID number +---@return Enum.ProfessionsSpecPerkState state +function C_ProfSpecs.GetStateForPerk(perkID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetStateForTab) +---@param tabTreeID number +---@param configID number +---@return Enum.ProfessionsSpecTabState tabInfo +function C_ProfSpecs.GetStateForTab(tabTreeID, configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetTabInfo) +---@param tabTreeID number +---@return ProfTabInfo? tabInfo +function C_ProfSpecs.GetTabInfo(tabTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetUnlockEntryForPath) +---@param pathID number +---@return number entryID +function C_ProfSpecs.GetUnlockEntryForPath(pathID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.GetUnlockRankForPerk) +---@param perkID number +---@return number? unlockRank +function C_ProfSpecs.GetUnlockRankForPerk(perkID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.ShouldShowPointsReminder) +---@return boolean showReminder +function C_ProfSpecs.ShouldShowPointsReminder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.ShouldShowPointsReminderForSkillLine) +---@param skillLineID number +---@return boolean showReminder +function C_ProfSpecs.ShouldShowPointsReminderForSkillLine(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.ShouldShowSpecTab) +---@return boolean showSpecTab +function C_ProfSpecs.ShouldShowSpecTab() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ProfSpecs.SkillLineHasSpecialization) +---@param skillLineID number +---@return boolean hasSpecialization +function C_ProfSpecs.SkillLineHasSpecialization(skillLineID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua new file mode 100644 index 0000000..f4b31cc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua @@ -0,0 +1,738 @@ +---@meta _ +C_PvP = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.ArePvpTalentsUnlocked) +---@return boolean arePvpTalentsUnlocked +function C_PvP.ArePvpTalentsUnlocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.AreTrainingGroundsEnabled) +---@return boolean areTrainingGroundsEnabled +function C_PvP.AreTrainingGroundsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.CanDisplayDeaths) +---@return boolean canDisplay +function C_PvP.CanDisplayDeaths() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.CanDisplayHonorableKills) +---@return boolean canDisplay +function C_PvP.CanDisplayHonorableKills() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.CanPlayerUseRatedPVPUI) +---@return boolean canUse +---@return string failureReason +function C_PvP.CanPlayerUseRatedPVPUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.CanPlayerUseTrainingGroundsUI) +---@return boolean canUseTrainingGroundsUI +---@return string failureReason +function C_PvP.CanPlayerUseTrainingGroundsUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.CanToggleWarMode) +---@param toggle boolean +---@return boolean canTogglePvP +function C_PvP.CanToggleWarMode(toggle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.CanToggleWarModeInArea) +---@return boolean canTogglePvPInArea +function C_PvP.CanToggleWarModeInArea() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.DoesMatchOutcomeAffectRating) +---@return boolean doesAffect +function C_PvP.DoesMatchOutcomeAffectRating() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetActiveBrawlInfo) +---@return PvpBrawlInfo? brawlInfo +function C_PvP.GetActiveBrawlInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetActiveMatchBracket) +---@return number bracket +function C_PvP.GetActiveMatchBracket() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetActiveMatchDuration) +---@return time_t seconds +function C_PvP.GetActiveMatchDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetActiveMatchState) +---@return Enum.PvPMatchState state +function C_PvP.GetActiveMatchState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetActiveMatchWinner) +---@return number winner +function C_PvP.GetActiveMatchWinner() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetArenaCrowdControlDuration) +---@param playerToken UnitToken +---@return LuaDurationObject duration +function C_PvP.GetArenaCrowdControlDuration(playerToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetArenaCrowdControlInfo) +---@param playerToken UnitToken +---@return number spellID +---@return number startTime +---@return number duration +function C_PvP.GetArenaCrowdControlInfo(playerToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetArenaRewards) +---@param teamSize number +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetArenaRewards(teamSize) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetArenaSkirmishRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetArenaSkirmishRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetAssignedSpecForBattlefieldQueue) +---@param queueID number +---@return number? specializationID +function C_PvP.GetAssignedSpecForBattlefieldQueue(queueID) end + +---If nil is returned, PVP_BRAWL_INFO_UPDATED event will be sent when the data is ready. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetAvailableBrawlInfo) +---@return PvpBrawlInfo? brawlInfo +function C_PvP.GetAvailableBrawlInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetBattlefieldFlagPosition) +---@param flagIndex number +---@param uiMapId number +---@return number? uiPosx +---@return number? uiPosy +---@return number flagTexture +function C_PvP.GetBattlefieldFlagPosition(flagIndex, uiMapId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetBattlefieldVehicleInfo) +---@param vehicleIndex number +---@param uiMapID number +---@return BattlefieldVehicleInfo info +function C_PvP.GetBattlefieldVehicleInfo(vehicleIndex, uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetBattlefieldVehicles) +---@param uiMapID number +---@return BattlefieldVehicleInfo[] vehicles +function C_PvP.GetBattlefieldVehicles(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetBattlegroundInfo) +---@param battlegroundIndex number +---@return BattlegroundInfo? battlegroundInfo +function C_PvP.GetBattlegroundInfo(battlegroundIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetBrawlRewards) +---@param brawlType Enum.BrawlType +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +---@return boolean hasWon +function C_PvP.GetBrawlRewards(brawlType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetBrawlSoloRBGMinItemLevel) +---@return number minItemLevel +function C_PvP.GetBrawlSoloRBGMinItemLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetCustomVictoryStatID) +---@return number statID +function C_PvP.GetCustomVictoryStatID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetGlobalPvpScalingInfoForSpecID) +---@param specializationID number +---@return PvpScalingData[] pvpScalingData +function C_PvP.GetGlobalPvpScalingInfoForSpecID(specializationID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetHonorRewardInfo) +---@param honorLevel number +---@return HonorRewardInfo? info +function C_PvP.GetHonorRewardInfo(honorLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetLevelUpBattlegrounds) +---@param level number +---@return LevelUpBattlegroundInfo[] battlefields +function C_PvP.GetLevelUpBattlegrounds(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetMatchPVPStatColumn) +---@param pvpStatID number +---@return MatchPVPStatColumn? info +function C_PvP.GetMatchPVPStatColumn(pvpStatID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetMatchPVPStatColumns) +---@return MatchPVPStatColumn[] columns +function C_PvP.GetMatchPVPStatColumns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetNextHonorLevelForReward) +---@param honorLevel number +---@return number? nextHonorLevelWithReward +function C_PvP.GetNextHonorLevelForReward(honorLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetOutdoorPvPWaitTime) +---@param uiMapID number +---@return time_t pvpWaitTime +function C_PvP.GetOutdoorPvPWaitTime(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPVPActiveMatchPersonalRatedInfo) +---@return PVPPersonalRatedInfo? info +function C_PvP.GetPVPActiveMatchPersonalRatedInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPVPActiveRatedMatchDeserterPenalty) +---@return RatedMatchDeserterPenalty? deserterPenalty +function C_PvP.GetPVPActiveRatedMatchDeserterPenalty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPVPSeasonRewardAchievementID) +---@return number achievementID +function C_PvP.GetPVPSeasonRewardAchievementID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPersonalRatedBGBlitzSpecStats) +---@return RatedBGBlitzSpecStats? specStats +function C_PvP.GetPersonalRatedBGBlitzSpecStats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPersonalRatedSoloShuffleSpecStats) +---@return RatedSoloShuffleSpecStats? specStats +function C_PvP.GetPersonalRatedSoloShuffleSpecStats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPostMatchCurrencyRewards) +---@return PVPPostMatchCurrencyReward[] rewards +function C_PvP.GetPostMatchCurrencyRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPostMatchItemRewards) +---@return PVPPostMatchItemReward[] rewards +function C_PvP.GetPostMatchItemRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPvpTalentsUnlockedLevel) +---@return number unlockLevel +function C_PvP.GetPvpTalentsUnlockedLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPvpTierID) +---@param tierEnum number +---@param bracketEnum number +---@return number? id +function C_PvP.GetPvpTierID(tierEnum, bracketEnum) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetPvpTierInfo) +---@param tierID number +---@return PvpTierInfo? pvpTierInfo +function C_PvP.GetPvpTierInfo(tierID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRandomBGInfo) +---@return RandomBGInfo info +function C_PvP.GetRandomBGInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRandomBGRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetRandomBGRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRandomEpicBGInfo) +---@return RandomBGInfo info +function C_PvP.GetRandomEpicBGInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRandomEpicBGRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetRandomEpicBGRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRandomTrainingGroundRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetRandomTrainingGroundRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRatedBGRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetRatedBGRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRatedSoloRBGMinItemLevel) +---@return number minItemLevel +function C_PvP.GetRatedSoloRBGMinItemLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRatedSoloRBGRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetRatedSoloRBGRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRatedSoloShuffleMinItemLevel) +---@return number minItemLevel +function C_PvP.GetRatedSoloShuffleMinItemLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRatedSoloShuffleRewards) +---@return number honor +---@return number experience +---@return BattlefieldItemReward[]? itemRewards +---@return BattlefieldCurrencyReward[]? currencyRewards +---@return RoleShortageReward? roleShortageBonus +function C_PvP.GetRatedSoloShuffleRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetRewardItemLevelsByTierEnum) +---@param pvpTierEnum number +---@return number activityItemLevel +---@return number weeklyItemLevel +function C_PvP.GetRewardItemLevelsByTierEnum(pvpTierEnum) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetScoreInfo) +---@param offsetIndex number +---@return PVPScoreInfo? info +function C_PvP.GetScoreInfo(offsetIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetScoreInfoByPlayerGuid) +---@param guid WOWGUID +---@return PVPScoreInfo? info +function C_PvP.GetScoreInfoByPlayerGuid(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetSeasonBestInfo) +---@return number tierID +---@return number? nextTierID +function C_PvP.GetSeasonBestInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetSkirmishInfo) +---@param pvpBracket number +---@return BattlemasterListInfo battlemasterListInfo +function C_PvP.GetSkirmishInfo(pvpBracket) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetSpecialEventBrawlInfo) +---@return PvpBrawlInfo? brawlInfo +function C_PvP.GetSpecialEventBrawlInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetTeamInfo) +---@param factionIndex number +---@return PVPTeamInfo? info +function C_PvP.GetTeamInfo(factionIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetTrainingGrounds) +---@return BattlegroundInfo[] trainingGrounds +function C_PvP.GetTrainingGrounds() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetUIDisplaySeason) +---@return number uiDisplaySeason +function C_PvP.GetUIDisplaySeason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetWarModeRewardBonus) +---@return number rewardBonus +function C_PvP.GetWarModeRewardBonus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetWarModeRewardBonusDefault) +---@return number defaultBonus +function C_PvP.GetWarModeRewardBonusDefault() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetWeeklyChestInfo) +---@return boolean rewardAchieved +---@return boolean lastWeekRewardAchieved +---@return boolean lastWeekRewardClaimed +---@return number pvpTierMaxFromWins +function C_PvP.GetWeeklyChestInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.GetZonePVPInfo) +---@return string pvpType +---@return boolean isSubZonePvP +---@return string? factionName +function C_PvP.GetZonePVPInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.HasArenaSkirmishWinToday) +---@return boolean hasArenaSkirmishWinToday +function C_PvP.HasArenaSkirmishWinToday() end + +---Returns true if a match is either active or complete. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.HasMatchStarted) +---@return boolean hasStarted +function C_PvP.HasMatchStarted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.HasRandomTrainingGroundWinToday) +---@return boolean hasRandomTrainingGroundWinToday +function C_PvP.HasRandomTrainingGroundWinToday() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsActiveBattlefield) +---@return boolean isActiveBattlefield +function C_PvP.IsActiveBattlefield() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsActiveMatchRegistered) +---@return boolean registered +function C_PvP.IsActiveMatchRegistered() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsArena) +---@return boolean isArena +function C_PvP.IsArena() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsBattleground) +---@return boolean isBattleground +function C_PvP.IsBattleground() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsBattlegroundEnlistmentBonusActive) +---@return boolean battlegroundActive +---@return boolean brawlActive +function C_PvP.IsBattlegroundEnlistmentBonusActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsBrawlSoloRBG) +---@return boolean isBrawlSoloRBG +function C_PvP.IsBrawlSoloRBG() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsBrawlSoloShuffle) +---@return boolean isBrawlSoloShuffle +function C_PvP.IsBrawlSoloShuffle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsInBrawl) +---@return boolean isInBrawl +function C_PvP.IsInBrawl() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsInRatedMatchWithDeserterPenalty) +---@return boolean isInRatedMatchWithDeserterPenalty +function C_PvP.IsInRatedMatchWithDeserterPenalty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsMatchActive) +---@return boolean isActive +function C_PvP.IsMatchActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsMatchComplete) +---@return boolean isComplete +function C_PvP.IsMatchComplete() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsMatchConsideredArena) +---@return boolean asArena +function C_PvP.IsMatchConsideredArena() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsMatchFactional) +---@return boolean isFactional +function C_PvP.IsMatchFactional() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsPVPMap) +---@return boolean isPVPMap +function C_PvP.IsPVPMap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsRatedArena) +---@return boolean isRatedArena +function C_PvP.IsRatedArena() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsRatedBattleground) +---@return boolean isRatedBattleground +function C_PvP.IsRatedBattleground() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsRatedMap) +---@return boolean isRatedMap +function C_PvP.IsRatedMap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsRatedSoloRBG) +---@return boolean isRatedSoloRBG +function C_PvP.IsRatedSoloRBG() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsRatedSoloShuffle) +---@return boolean isRatedSoloShuffle +function C_PvP.IsRatedSoloShuffle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsSoloRBG) +---@return boolean isSoloRBG +function C_PvP.IsSoloRBG() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsSoloShuffle) +---@return boolean isSoloShuffle +function C_PvP.IsSoloShuffle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsSubZonePVPPOI) +---@return boolean result +function C_PvP.IsSubZonePVPPOI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsWarModeActive) +---@return boolean warModeActive +function C_PvP.IsWarModeActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsWarModeDesired) +---@return boolean warModeDesired +function C_PvP.IsWarModeDesired() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.IsWarModeFeatureEnabled) +---@return boolean warModeEnabled +function C_PvP.IsWarModeFeatureEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.JoinBattlefield) +---@param battlemasterListId number +function C_PvP.JoinBattlefield(battlemasterListId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.JoinBrawl) +---@param isSpecialBrawl? boolean Default = false +function C_PvP.JoinBrawl(isSpecialBrawl) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.JoinRandomTrainingGround) +function C_PvP.JoinRandomTrainingGround() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.JoinRatedBGBlitz) +function C_PvP.JoinRatedBGBlitz() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.JoinTrainingGround) +---@param trainingGroundID number +function C_PvP.JoinTrainingGround(trainingGroundID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.RequestCrowdControlSpell) +---@param playerToken UnitToken +function C_PvP.RequestCrowdControlSpell(playerToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.SetPVP) +---@param enablePVP? boolean Default = false +function C_PvP.SetPVP(enablePVP) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.SetWarModeDesired) +---@param warModeDesired boolean +function C_PvP.SetWarModeDesired(warModeDesired) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.StartSoloRBGWarGameByName) +---@param args string +---@return number success +function C_PvP.StartSoloRBGWarGameByName(args) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.StartSpectatorSoloRBGWarGame) +---@param opaqueID1 number +---@param opaqueID2 number +---@param specifiedMap string +---@param tournamentRules boolean +---@return number success +function C_PvP.StartSpectatorSoloRBGWarGame(opaqueID1, opaqueID2, specifiedMap, tournamentRules) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.TogglePVP) +function C_PvP.TogglePVP() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PvP.ToggleWarMode) +function C_PvP.ToggleWarMode() end + +---@class BattlefieldCurrencyReward +---@field id number +---@field quantity number + +---@class BattlefieldItemReward +---@field id number +---@field name string +---@field texture fileID +---@field quantity number + +---@class BattlefieldRewards +---@field honor number +---@field experience number +---@field itemRewards BattlefieldItemReward[]? +---@field currencyRewards BattlefieldCurrencyReward[]? +---@field roleShortageBonus RoleShortageReward? + +---@class BattlefieldVehicleInfo +---@field x number +---@field y number +---@field name string +---@field isOccupied boolean +---@field atlas textureAtlas +---@field textureWidth number +---@field textureHeight number +---@field facing number +---@field isPlayer boolean +---@field isAlive boolean +---@field shouldDrawBelowPlayerBlips boolean + +---@class BattlegroundInfo +---@field name string +---@field icon fileID? +---@field gameType string +---@field shortDescription string +---@field longDescription string +---@field mapDescription string +---@field maxPlayers number +---@field battlegroundID number? +---@field lfgDungeonID number? +---@field mapID number? +---@field isHoliday boolean +---@field isRandom boolean +---@field canEnter boolean +---@field isTrainingGround boolean + +---@class BattlemasterListInfo +---@field name string +---@field matchmakingType Enum.PvPMatchmakingType +---@field minPlayers number +---@field maxPlayers number +---@field icon fileID +---@field longDescription string +---@field shortDescription string + +---@class HonorRewardInfo +---@field honorLevelName string +---@field badgeFileDataID fileID +---@field achievementRewardedID number + +---@class LevelUpBattlegroundInfo +---@field id number +---@field icon fileID +---@field name string +---@field isEpic boolean + +---@class MatchPVPStatColumn +---@field pvpStatID number +---@field columnHeaderID number +---@field orderIndex number +---@field name string +---@field tooltipTitle string +---@field tooltip string + +---@class PvpBrawlInfo +---@field brawlID number +---@field name string +---@field shortDescription string +---@field longDescription string +---@field canQueue boolean +---@field minLevel number +---@field maxLevel number +---@field groupsAllowed boolean +---@field crossFactionAllowed boolean? Default = false +---@field timeLeftUntilNextChange number? +---@field brawlType Enum.BrawlType +---@field mapNames string[] +---@field includesAllArenas boolean? Default = false +---@field minItemLevel number? Default = 0 +---@field shouldHideRewardIcon boolean? Default = false + +---@class PVPPersonalRatedInfo +---@field personalRating number +---@field bestSeasonRating number +---@field bestWeeklyRating number +---@field seasonPlayed number +---@field seasonWon number +---@field weeklyPlayed number +---@field weeklyWon number +---@field lastWeeksBestRating number +---@field hasWonBracketToday boolean +---@field tier number +---@field ranking number? +---@field roundsSeasonPlayed number +---@field roundsSeasonWon number +---@field roundsWeeklyPlayed number +---@field roundsWeeklyWon number + +---@class PVPPostMatchCurrencyReward +---@field currencyType number +---@field quantityChanged number + +---@class PVPPostMatchItemReward +---@field type string +---@field link string +---@field quantity number +---@field specID number +---@field sex number +---@field isUpgraded boolean + +---@class PvpReadyCheckInfo +---@field roles PvpRoleQueueInfo[] +---@field numPlayersAccepted number +---@field numPlayersDeclined number +---@field totalNumPlayers number + +---@class PvpRoleQueueInfo +---@field role string +---@field totalRole number +---@field totalAccepted number +---@field totalDeclined number + +---@class PvpScalingData +---@field scalingDataID number +---@field specializationID number +---@field name string +---@field value number + +---@class PVPScoreInfo +---@field name string +---@field guid WOWGUID +---@field killingBlows number +---@field honorableKills number +---@field deaths number +---@field honorGained number +---@field faction number +---@field raceName string +---@field className string +---@field classToken string +---@field damageDone number +---@field healingDone number +---@field rating number +---@field ratingChange number +---@field prematchMMR number +---@field mmrChange number +---@field postmatchMMR number +---@field talentSpec string +---@field honorLevel number +---@field roleAssigned number +---@field stats PVPStatInfo[] + +---@class PVPStatInfo +---@field pvpStatID number +---@field pvpStatValue number +---@field orderIndex number +---@field name string +---@field tooltip string +---@field iconName string + +---@class PVPTeamInfo +---@field name string +---@field size number +---@field rating number +---@field ratingNew number +---@field ratingMMR number + +---@class PvpTierInfo +---@field name string +---@field descendRating number +---@field ascendRating number +---@field descendTier number +---@field ascendTier number +---@field pvpTierEnum number +---@field tierIconID fileID + +---@class RandomBGInfo +---@field canQueue boolean +---@field bgID number +---@field bgIndex number +---@field hasRandomWinToday boolean +---@field minLevel number +---@field maxLevel number +---@field name string + +---@class RatedBGBlitzSpecStats +---@field weeklyMostPlayedSpecID number +---@field weeklyMostPlayedSpecGames number +---@field seasonMostPlayedSpecID number +---@field seasonMostPlayedSpecGames number + +---@class RatedMatchDeserterPenalty +---@field personalRatingChange number +---@field queuePenaltySpellID number +---@field queuePenaltyDuration number + +---@class RatedSoloShuffleSpecStats +---@field weeklyMostPlayedSpecID number +---@field weeklyMostPlayedSpecRounds number +---@field seasonMostPlayedSpecID number +---@field seasonMostPlayedSpecRounds number + +---@class RoleShortageReward +---@field validRoles string[] +---@field rewardSpellID number +---@field rewardItemID number + +---@class WorldPVPBattlegroundInfo +---@field bgID number +---@field name string +---@field isActive boolean +---@field canQueue boolean +---@field canEnter boolean +---@field startTime time_t +---@field minLevel number +---@field maxLevel number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua new file mode 100644 index 0000000..a96dbdd --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +C_QuestHub = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestHub.IsQuestCurrentlyRelatedToHub) +---@param questID number +---@param areaPoiID number +---@return boolean isRelated +function C_QuestHub.IsQuestCurrentlyRelatedToHub(questID, areaPoiID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua new file mode 100644 index 0000000..62eef4f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua @@ -0,0 +1,15 @@ +---@meta _ +---@class QuestPOIMapInfo +---@field childDepth number? +---@field questTagType Enum.QuestTagType? +---@field questID number +---@field numObjectives number +---@field mapID number +---@field x number +---@field y number +---@field isQuestStart boolean +---@field isDaily boolean +---@field isCombatAllyQuest boolean +---@field isMeta boolean +---@field inProgress boolean +---@field isMapIndicatorQuest boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua new file mode 100644 index 0000000..3caaa38 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua @@ -0,0 +1,45 @@ +---@meta _ +C_QuestInfoSystem = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestClassification) +---@param questID? number +---@param questInfoID? number +---@return Enum.QuestClassification classification +function C_QuestInfoSystem.GetQuestClassification(questID, questInfoID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestLogRewardFavor) +---@param questID? number +---@param clampFavorToCycleCap? boolean +---@return number amount +function C_QuestInfoSystem.GetQuestLogRewardFavor(questID, clampFavorToCycleCap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestRewardCurrencies) +---@param questID? number +---@return QuestRewardCurrencyInfo[] questRewardCurrencyInfo +function C_QuestInfoSystem.GetQuestRewardCurrencies(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestRewardSpellInfo) +---@param questID? number +---@param spellID number +---@return QuestRewardSpellInfo? info +function C_QuestInfoSystem.GetQuestRewardSpellInfo(questID, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestRewardSpells) +---@param questID? number +---@return number[] spellIDs +function C_QuestInfoSystem.GetQuestRewardSpells(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestShouldToastCompletion) +---@param questID? number +---@return boolean shouldToast +function C_QuestInfoSystem.GetQuestShouldToastCompletion(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.HasQuestRewardCurrencies) +---@param questID? number +---@return boolean hasQuestRewardCurrencies +function C_QuestInfoSystem.HasQuestRewardCurrencies(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.HasQuestRewardSpells) +---@param questID? number +---@return boolean hasRewardSpells +function C_QuestInfoSystem.HasQuestRewardSpells(questID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua new file mode 100644 index 0000000..9823bd0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua @@ -0,0 +1,9 @@ +---@meta _ +C_QuestItemUse = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestItemUse.CanUseQuestItemOnObject) +---@param item ItemLocation +---@param unit UnitToken +---@param checkRange? boolean +---@return boolean canUse +function C_QuestItemUse.CanUseQuestItemOnObject(item, unit, checkRange) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua new file mode 100644 index 0000000..c2f4116 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua @@ -0,0 +1,60 @@ +---@meta _ +C_QuestLine = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.GetAvailableQuestLines) +---@param uiMapID number +---@return QuestLineInfo[] questLines +function C_QuestLine.GetAvailableQuestLines(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.GetForceVisibleQuests) +---@param uiMapID number +---@return number[] questIDs +function C_QuestLine.GetForceVisibleQuests(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.GetQuestLineInfo) +---@param questID number +---@param uiMapID? number +---@param displayableOnly? boolean Default = false +---@return QuestLineInfo? questLineInfo +function C_QuestLine.GetQuestLineInfo(questID, uiMapID, displayableOnly) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.GetQuestLineQuests) +---@param questLineID number +---@return number[] questIDs +function C_QuestLine.GetQuestLineQuests(questLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.IsComplete) +---@param questLineID number +---@return boolean isComplete +function C_QuestLine.IsComplete(questLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.QuestLineIgnoresAccountCompletedFiltering) +---@param uiMapID number +---@param questLineID number +---@return boolean questLineIgnoresAccountCompletedFiltering +function C_QuestLine.QuestLineIgnoresAccountCompletedFiltering(uiMapID, questLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLine.RequestQuestLinesForMap) +---@param uiMapID number +function C_QuestLine.RequestQuestLinesForMap(uiMapID) end + +---@class QuestLineInfo +---@field questLineName string +---@field questName string +---@field questLineID number +---@field questID number +---@field x number +---@field y number +---@field isHidden boolean +---@field isLegendary boolean +---@field isLocalStory boolean +---@field isDaily boolean +---@field isCampaign boolean +---@field isImportant boolean +---@field isAccountCompleted boolean +---@field isCombatAllyQuest boolean +---@field isMeta boolean +---@field inProgress boolean +---@field isQuestStart boolean +---@field floorLocation Enum.QuestLineFloorLocation +---@field startMapID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua new file mode 100644 index 0000000..f388eca --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua @@ -0,0 +1,525 @@ +---@meta _ +C_QuestLog = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.AbandonQuest) +function C_QuestLog.AbandonQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.AddQuestWatch) +---@param questID number +---@return boolean wasWatched +function C_QuestLog.AddQuestWatch(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.AddWorldQuestWatch) +---@param questID number +---@param watchType? Enum.QuestWatchType +---@return boolean wasWatched +function C_QuestLog.AddWorldQuestWatch(questID, watchType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.CanAbandonQuest) +---@param questID number +---@return boolean canAbandon +function C_QuestLog.CanAbandonQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.DoesQuestAwardReputationWithFaction) +---@param questID number +---@param targetFactionID number +---@return boolean awardsReputation +function C_QuestLog.DoesQuestAwardReputationWithFaction(questID, targetFactionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetAbandonQuest) +---@return number questID +function C_QuestLog.GetAbandonQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetAbandonQuestItems) +---@return number[] itemIDs +function C_QuestLog.GetAbandonQuestItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetActivePreyQuest) +---@return number questID +function C_QuestLog.GetActivePreyQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetActiveThreatMaps) +---@return number[] uiMapIDs +function C_QuestLog.GetActiveThreatMaps() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetAllCompletedQuestIDs) +---@return number[] quests +function C_QuestLog.GetAllCompletedQuestIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetBountiesForMapID) +---@param uiMapID number +---@return BountyInfo[]? bounties +function C_QuestLog.GetBountiesForMapID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetBountySetInfoForMapID) +---@param uiMapID number +---@return Enum.MapOverlayDisplayLocation displayLocation +---@return number lockQuestID +---@return number bountySetID +---@return boolean isActivitySet +function C_QuestLog.GetBountySetInfoForMapID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetDistanceSqToQuest) +---@param questID number +---@return number distanceSq +---@return boolean onContinent +function C_QuestLog.GetDistanceSqToQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetHeaderIndexForQuest) +---@param questID number +---@return number? index +function C_QuestLog.GetHeaderIndexForQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetInfo) +---@param questLogIndex number +---@return QuestInfo? info +function C_QuestLog.GetInfo(questLogIndex) end + +---Only returns a log index for actual quests, not headers +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetLogIndexForQuestID) +---@param questID number +---@return number? questLogIndex +function C_QuestLog.GetLogIndexForQuestID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetMapForQuestPOIs) +---@return number uiMapID +function C_QuestLog.GetMapForQuestPOIs() end + +---This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries etc +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetMaxNumQuests) +---@return number maxNumQuests +function C_QuestLog.GetMaxNumQuests() end + +---This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetMaxNumQuestsCanAccept) +---@return number maxNumQuestsCanAccept +function C_QuestLog.GetMaxNumQuestsCanAccept() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNextWaypoint) +---@param questID number +---@return number mapID +---@return number x +---@return number y +function C_QuestLog.GetNextWaypoint(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNextWaypointForMap) +---@param questID number +---@param uiMapID number +---@return number x +---@return number y +function C_QuestLog.GetNextWaypointForMap(questID, uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNextWaypointText) +---@param questID number +---@return string waypointText +function C_QuestLog.GetNextWaypointText(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNumQuestLogEntries) +---@return number numShownEntries +---@return number numQuests +function C_QuestLog.GetNumQuestLogEntries() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNumQuestObjectives) +---@param questID number +---@return number leaderboardCount +function C_QuestLog.GetNumQuestObjectives(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNumQuestWatches) +---@return number numQuestWatches +function C_QuestLog.GetNumQuestWatches() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetNumWorldQuestWatches) +---@return number numQuestWatches +function C_QuestLog.GetNumWorldQuestWatches() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestAdditionalHighlights) +---@param questID number +---@return number uiMapID +---@return boolean worldQuests +---@return boolean worldQuestsElite +---@return boolean dungeons +---@return boolean treasures +function C_QuestLog.GetQuestAdditionalHighlights(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestDetailsTheme) +---@param questID number +---@return QuestTheme? theme +function C_QuestLog.GetQuestDetailsTheme(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestDifficultyLevel) +---@param questID number +---@return number level +function C_QuestLog.GetQuestDifficultyLevel(questID) end + +---Only returns a questID for actual quests, not headers +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestIDForLogIndex) +---@param questLogIndex number +---@return number? questID +function C_QuestLog.GetQuestIDForLogIndex(questLogIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestIDForQuestWatchIndex) +---@param questWatchIndex number +---@return number? questID +function C_QuestLog.GetQuestIDForQuestWatchIndex(questWatchIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestIDForWorldQuestWatchIndex) +---@param questWatchIndex number +---@return number? questID +function C_QuestLog.GetQuestIDForWorldQuestWatchIndex(questWatchIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestLogMajorFactionReputationRewards) +---@param questID number +---@return QuestRewardReputationInfo[] reputationRewards +function C_QuestLog.GetQuestLogMajorFactionReputationRewards(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestLogPortraitGiver) +---@param questLogIndex? number +---@return number portraitGiver +---@return string portraitGiverText +---@return string portraitGiverName +---@return number portraitGiverMount +---@return number? portraitGiverModelSceneID +function C_QuestLog.GetQuestLogPortraitGiver(questLogIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestObjectives) +---@param questID number +---@return QuestObjectiveInfo[] objectives +function C_QuestLog.GetQuestObjectives(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestRewardCurrencies) +---@param questID number +---@return QuestRewardCurrencyInfo[] questRewardCurrencies +function C_QuestLog.GetQuestRewardCurrencies(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestRewardCurrencyInfo) +---@param questID number +---@param currencyIndex number +---@param isChoice boolean +---@return QuestRewardCurrencyInfo? questRewardCurrencyInfo +function C_QuestLog.GetQuestRewardCurrencyInfo(questID, currencyIndex, isChoice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestTagInfo) +---@param questID number +---@return QuestTagInfo? info +function C_QuestLog.GetQuestTagInfo(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestType) +---@param questID number +---@return number? questType +function C_QuestLog.GetQuestType(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestWatchType) +---@param questID number +---@return Enum.QuestWatchType? watchType +function C_QuestLog.GetQuestWatchType(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetQuestsOnMap) +---@param uiMapID number +---@return QuestPOIMapInfo[] quests +function C_QuestLog.GetQuestsOnMap(uiMapID) end + +---Uses the selected quest if no questID is provided +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetRequiredMoney) +---@param questID? number +---@return number requiredMoney +function C_QuestLog.GetRequiredMoney(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetSelectedQuest) +---@return number questID +function C_QuestLog.GetSelectedQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetSuggestedGroupSize) +---@param questID number +---@return number suggestedGroupSize +function C_QuestLog.GetSuggestedGroupSize(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetTimeAllowed) +---@param questID number +---@return number totalTime +---@return number elapsedTime +function C_QuestLog.GetTimeAllowed(questID) end + +---Returns a valid title for anything that is in the quest log. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetTitleForLogIndex) +---@param questLogIndex number +---@return string? title +function C_QuestLog.GetTitleForLogIndex(questLogIndex) end + +---Only returns a valid title for quests, header titles cannot be discovered using this. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetTitleForQuestID) +---@param questID number +---@return string? title +function C_QuestLog.GetTitleForQuestID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.GetZoneStoryInfo) +---@param uiMapID number +---@return number achievementID +---@return number storyMapID +function C_QuestLog.GetZoneStoryInfo(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.HasActiveThreats) +---@return boolean hasActiveThreats +function C_QuestLog.HasActiveThreats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsAccountQuest) +---@param questID number +---@return boolean isAccountQuest +function C_QuestLog.IsAccountQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsComplete) +---@param questID number +---@return boolean isComplete +function C_QuestLog.IsComplete(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsFailed) +---@param questID number +---@return boolean isFailed +function C_QuestLog.IsFailed(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsImportantQuest) +---@param questID number +---@return boolean isImportant +function C_QuestLog.IsImportantQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsMetaQuest) +---@param questID number +---@return boolean isMeta +function C_QuestLog.IsMetaQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsOnMap) +---@param questID number +---@return boolean onMap +---@return boolean hasLocalPOI +function C_QuestLog.IsOnMap(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsOnQuest) +---@param questID number +---@return boolean isOnQuest +function C_QuestLog.IsOnQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsPushableQuest) +---@param questID number +---@return boolean isPushable +function C_QuestLog.IsPushableQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestBounty) +---@param questID number +---@return boolean isBounty +function C_QuestLog.IsQuestBounty(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestCalling) +---@param questID number +---@return boolean isCalling +function C_QuestLog.IsQuestCalling(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestCriteriaForBounty) +---@param questID number +---@param bountyQuestID number +---@return boolean isCriteriaForBounty +function C_QuestLog.IsQuestCriteriaForBounty(questID, bountyQuestID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestDisabledForSession) +---@param questID number +---@return boolean isDisabled +function C_QuestLog.IsQuestDisabledForSession(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestFlaggedCompleted) +---@param questID number +---@return boolean isCompleted +function C_QuestLog.IsQuestFlaggedCompleted(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestFlaggedCompletedOnAccount) +---@param questID number +---@return boolean isCompletedOnAccount +function C_QuestLog.IsQuestFlaggedCompletedOnAccount(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestFromContentPush) +---@param questID number +---@return boolean isFromContentPush +function C_QuestLog.IsQuestFromContentPush(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestInvasion) +---@param questID number +---@return boolean isInvasion +function C_QuestLog.IsQuestInvasion(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestReplayable) +---@param questID number +---@return boolean isReplayable +function C_QuestLog.IsQuestReplayable(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestReplayedRecently) +---@param questID number +---@return boolean recentlyReplayed +function C_QuestLog.IsQuestReplayedRecently(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestTask) +---@param questID number +---@return boolean isTask +function C_QuestLog.IsQuestTask(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsQuestTrivial) +---@param questID number +---@return boolean isTrivial +function C_QuestLog.IsQuestTrivial(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsRepeatableQuest) +---@param questID number +---@return boolean isRepeatable +function C_QuestLog.IsRepeatableQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsThreatQuest) +---@param questID number +---@return boolean isThreat +function C_QuestLog.IsThreatQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsUnitOnQuest) +---@param unit UnitToken +---@param questID number +---@return boolean isOnQuest +function C_QuestLog.IsUnitOnQuest(unit, questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.IsWorldQuest) +---@param questID number +---@return boolean isWorldQuest +function C_QuestLog.IsWorldQuest(questID) end + +---Tests whether a quest is eligible for warmode bonuses (e.g. most world quests, some daily quests +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.QuestCanHaveWarModeBonus) +---@param questID number +---@return boolean hasBonus +function C_QuestLog.QuestCanHaveWarModeBonus(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.QuestContainsFirstTimeRepBonusForPlayer) +---@param questID number +---@return boolean questContainsFirstTimeRepBonusForPlayer +function C_QuestLog.QuestContainsFirstTimeRepBonusForPlayer(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.QuestHasQuestSessionBonus) +---@param questID number +---@return boolean hasBonus +function C_QuestLog.QuestHasQuestSessionBonus(questID) end + +---Tests whether a quest in the player's quest log that is eligible for warmode bonuses (see 'QuestCanHaveWarModeBOnus') has been completed in warmode (including accepting it) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.QuestHasWarModeBonus) +---@param questID number +---@return boolean hasBonus +function C_QuestLog.QuestHasWarModeBonus(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.QuestIgnoresAccountCompletedFiltering) +---@param questID number +---@return boolean questIgnoresAccountCompletedFiltering +function C_QuestLog.QuestIgnoresAccountCompletedFiltering(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.ReadyForTurnIn) +---@param questID number +---@return boolean? readyForTurnIn +function C_QuestLog.ReadyForTurnIn(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.RemoveQuestWatch) +---@param questID number +---@return boolean wasRemoved +function C_QuestLog.RemoveQuestWatch(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.RemoveWorldQuestWatch) +---@param questID number +---@return boolean wasRemoved +function C_QuestLog.RemoveWorldQuestWatch(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.RequestLoadQuestByID) +---@param questID number +function C_QuestLog.RequestLoadQuestByID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.SetAbandonQuest) +function C_QuestLog.SetAbandonQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.SetMapForQuestPOIs) +---@param uiMapID number +function C_QuestLog.SetMapForQuestPOIs(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.SetSelectedQuest) +---@param questID number +function C_QuestLog.SetSelectedQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.ShouldDisplayTimeRemaining) +---@param questID number +---@return boolean displayTimeRemaining +function C_QuestLog.ShouldDisplayTimeRemaining(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.ShouldShowQuestRewards) +---@param questID number +---@return boolean shouldShow +function C_QuestLog.ShouldShowQuestRewards(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.SortQuestWatches) +function C_QuestLog.SortQuestWatches() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.UnitIsRelatedToActiveQuest) +---@param unit UnitToken +---@return boolean isRelatedToActiveQuest +function C_QuestLog.UnitIsRelatedToActiveQuest(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestLog.UpdateCampaignHeaders) +function C_QuestLog.UpdateCampaignHeaders() end + +---@class QuestInfo +---@field title string +---@field questLogIndex number +---@field questID number +---@field campaignID number? +---@field level number +---@field difficultyLevel number +---@field suggestedGroup number +---@field frequency Enum.QuestFrequency? +---@field isHeader boolean +---@field useMinimalHeader boolean +---@field sortAsNormalQuest boolean +---@field isCollapsed boolean +---@field startEvent boolean +---@field isTask boolean +---@field isBounty boolean +---@field isStory boolean +---@field isScaling boolean +---@field isOnMap boolean +---@field hasLocalPOI boolean +---@field isHidden boolean +---@field isAutoComplete boolean +---@field overridesSortOrder boolean +---@field readyForTranslation boolean? Default = true +---@field isInternalOnly boolean +---@field isAbandonOnDisable boolean +---@field headerSortKey number? +---@field questClassification Enum.QuestClassification + +---@class QuestObjectiveInfo +---@field text string +---@field type string +---@field finished boolean +---@field numFulfilled number +---@field numRequired number +---@field objectiveType QuestObjectiveType? + +---@class QuestTagInfo +---@field tagName string +---@field tagID number +---@field worldQuestType number? +---@field quality Enum.WorldQuestQuality? +---@field tradeskillLineID number? +---@field isElite boolean? +---@field displayExpiration boolean? + +---@class QuestTheme +---@field background textureAtlas +---@field seal textureAtlas +---@field signature string +---@field poiIcon textureAtlas +---@field mapPinInfo UIMapPinInfo? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua new file mode 100644 index 0000000..6541079 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua @@ -0,0 +1,28 @@ +---@meta _ +C_QuestOffer = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestOffer.GetHideRequiredItems) +---@return boolean hideRequiredItems +function C_QuestOffer.GetHideRequiredItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestOffer.GetQuestOfferMajorFactionReputationRewards) +---@return QuestRewardReputationInfo[] reputationRewards +function C_QuestOffer.GetQuestOfferMajorFactionReputationRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestOffer.GetQuestRequiredCurrencyInfo) +---@param questRewardIndex number +---@return QuestRequiredCurrencyInfo? questRequiredCurrencyInfo +function C_QuestOffer.GetQuestRequiredCurrencyInfo(questRewardIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestOffer.GetQuestRewardCurrencyInfo) +---@param questInfoType string +---@param questRewardIndex number +---@return QuestRewardCurrencyInfo? questRewardCurrencyInfo +function C_QuestOffer.GetQuestRewardCurrencyInfo(questInfoType, questRewardIndex) end + +---@class QuestRequiredCurrencyInfo +---@field texture fileID +---@field name string +---@field currencyID number +---@field quality number +---@field requiredAmount number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua new file mode 100644 index 0000000..58fd760 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua @@ -0,0 +1,25 @@ +---@meta _ +---@class QuestRewardCurrencyInfo +---@field texture fileID +---@field name string +---@field currencyID number +---@field quality number +---@field baseRewardAmount number +---@field bonusRewardAmount number +---@field totalRewardAmount number +---@field questRewardContextFlags Enum.QuestRewardContextFlags? + +---@class QuestRewardReputationInfo +---@field factionID number +---@field rewardAmount number + +---@class QuestRewardSpellInfo +---@field texture fileID +---@field name string +---@field garrFollowerID number? +---@field isTradeskill boolean +---@field isSpellLearned boolean +---@field hideSpellLearnText boolean +---@field isBoostSpell boolean +---@field genericUnlock boolean +---@field type Enum.QuestCompleteSpellType diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua new file mode 100644 index 0000000..6975765 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua @@ -0,0 +1,61 @@ +---@meta _ +C_QuestSession = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.CanStart) +---@return boolean allowed +function C_QuestSession.CanStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.CanStop) +---@return boolean allowed +function C_QuestSession.CanStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.Exists) +---@return boolean exists +function C_QuestSession.Exists() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.GetAvailableSessionCommand) +---@return Enum.QuestSessionCommand command +function C_QuestSession.GetAvailableSessionCommand() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.GetPendingCommand) +---@return Enum.QuestSessionCommand command +function C_QuestSession.GetPendingCommand() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.GetProposedMaxLevelForSession) +---@return number proposedMaxLevel +function C_QuestSession.GetProposedMaxLevelForSession() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.GetSessionBeginDetails) +---@return QuestSessionPlayerDetails? details +function C_QuestSession.GetSessionBeginDetails() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.GetSuperTrackedQuest) +---@return number? questID +function C_QuestSession.GetSuperTrackedQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.HasJoined) +---@return boolean hasJoined +function C_QuestSession.HasJoined() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.HasPendingCommand) +---@return boolean hasPendingCommand +function C_QuestSession.HasPendingCommand() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.RequestSessionStart) +function C_QuestSession.RequestSessionStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.RequestSessionStop) +function C_QuestSession.RequestSessionStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.SendSessionBeginResponse) +---@param beginSession boolean +function C_QuestSession.SendSessionBeginResponse(beginSession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_QuestSession.SetQuestIsSuperTracked) +---@param questID number +---@param superTrack boolean +function C_QuestSession.SetQuestIsSuperTracked(questID, superTrack) end + +---@class QuestSessionPlayerDetails +---@field name string +---@field guid WOWGUID diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua new file mode 100644 index 0000000..47eb427 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua @@ -0,0 +1,66 @@ +---@meta _ +C_TaskQuest = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.DoesMapShowTaskQuestObjectives) +---@param uiMapID number +---@return boolean showsTaskQuestObjectives +function C_TaskQuest.DoesMapShowTaskQuestObjectives(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestInfoByQuestID) +---@param questID number +---@return string questTitle +---@return number? factionID +---@return boolean? capped +---@return boolean? displayAsObjective +function C_TaskQuest.GetQuestInfoByQuestID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestLocation) +---@param questID number +---@param uiMapID number +---@return number locationX +---@return number locationY +function C_TaskQuest.GetQuestLocation(questID, uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestProgressBarInfo) +---@param questID number +---@return number progress +function C_TaskQuest.GetQuestProgressBarInfo(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestTimeLeftMinutes) +---@param questID number +---@return number minutesLeft +function C_TaskQuest.GetQuestTimeLeftMinutes(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestTimeLeftSeconds) +---@param questID number +---@return number secondsLeft +function C_TaskQuest.GetQuestTimeLeftSeconds(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestUIWidgetSetByType) +---@param questID number +---@param type Enum.MapIconUIWidgetSetType +---@return number widgetSet +function C_TaskQuest.GetQuestUIWidgetSetByType(questID, type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestZoneID) +---@param questID number +---@return number uiMapID +function C_TaskQuest.GetQuestZoneID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestsOnMap) +---@param uiMapID number +---@return QuestPOIMapInfo[] taskPOIs +function C_TaskQuest.GetQuestsOnMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetThreatQuests) +---@return number[] quests +function C_TaskQuest.GetThreatQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.IsActive) +---@param questID number +---@return boolean active +function C_TaskQuest.IsActive(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.RequestPreloadRewardData) +---@param questID number +function C_TaskQuest.RequestPreloadRewardData(questID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua new file mode 100644 index 0000000..14bce77 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua @@ -0,0 +1,12 @@ +---@meta _ +---@class QueueSpecificInfo +---@field queueType string +---@field lfgIDs number[]? +---@field lfgListID number? +---@field activityID number? +---@field battlefieldType string? +---@field listID number? +---@field mapName string? +---@field rated boolean? +---@field isBrawl boolean? +---@field teamSize number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua new file mode 100644 index 0000000..9324427 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua @@ -0,0 +1,19 @@ +---@meta _ +C_RaidLocks = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RaidLocks.GetRedirectedDifficultyID) +---@param mapID number +---@param difficultyID number +---@return number redirectedDifficultyID +function C_RaidLocks.GetRedirectedDifficultyID(mapID, difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RaidLocks.IsEncounterComplete) +---@param mapID number +---@param encounterID number +---@param difficultyID? number +---@return boolean encounterIsComplete +function C_RaidLocks.IsEncounterComplete(mapID, encounterID, difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RaidLocks.IsRaidLockExtendFeatureEnabled) +---@return boolean raidLockExtendFeatureEnabled +function C_RaidLocks.IsRaidLockExtendFeatureEnabled() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua new file mode 100644 index 0000000..34d47f5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua @@ -0,0 +1,38 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanBeRaidTarget) +---@param target UnitToken +---@return boolean result +function CanBeRaidTarget(target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearRaidMarker) +---@param raidMarkerIndex number +function ClearRaidMarker(raidMarkerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidTargetIndex) +---@param target UnitToken +---@return number? result +function GetRaidTargetIndex(target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRaidMarkerActive) +---@param index number +---@return boolean result +function IsRaidMarkerActive(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsRaidMarkerSystemEnabled) +---@return boolean enabled +function IsRaidMarkerSystemEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlaceRaidMarker) +---@param index number +---@param token? string +function PlaceRaidMarker(index, token) end + +---Removes all assigned raid target markers. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemoveRaidTargets) +function RemoveRaidTargets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetRaidTarget) +---@param target UnitToken +---@param userIndex number +function SetRaidTarget(target, userIndex) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua new file mode 100644 index 0000000..7eff455 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua @@ -0,0 +1,100 @@ +---@meta _ +C_RecentAllies = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.CanSetRecentAllyNote) +---@param characterGUID WOWGUID +---@return boolean canSetNote +function C_RecentAllies.CanSetRecentAllyNote(characterGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.GetRecentAllies) +---@return RecentAllyData[] recentAlliesData +function C_RecentAllies.GetRecentAllies() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.GetRecentAllyByFullName) +---@param fullCharacterName string +---@return RecentAllyData? recentAllyData +function C_RecentAllies.GetRecentAllyByFullName(fullCharacterName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.GetRecentAllyByGUID) +---@param characterGUID WOWGUID +---@return RecentAllyData? recentAllyData +function C_RecentAllies.GetRecentAllyByGUID(characterGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.IsRecentAllyByFullName) +---@param fullCharacterName string +---@return boolean isRecentAlly +function C_RecentAllies.IsRecentAllyByFullName(fullCharacterName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.IsRecentAllyByGUID) +---@param characterGUID WOWGUID +---@return boolean isRecentAlly +function C_RecentAllies.IsRecentAllyByGUID(characterGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.IsRecentAllyDataReady) +---@return boolean isReady +function C_RecentAllies.IsRecentAllyDataReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.IsRecentAllyPinned) +---@param characterGUID WOWGUID +---@return boolean isPinned +function C_RecentAllies.IsRecentAllyPinned(characterGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.IsSystemEnabled) +---@return boolean isRecentAllySystemEnabled +function C_RecentAllies.IsSystemEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.IsSystemSupported) +---@return boolean isRecentAllySystemSupported +function C_RecentAllies.IsSystemSupported() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.SetRecentAllyNote) +---@param characterGUID WOWGUID +---@param note string +function C_RecentAllies.SetRecentAllyNote(characterGUID, note) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.SetRecentAllyPinned) +---@param characterGUID WOWGUID +---@param isPinned boolean +function C_RecentAllies.SetRecentAllyPinned(characterGUID, isPinned) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecentAllies.TryRequestRecentAlliesData) +function C_RecentAllies.TryRequestRecentAlliesData() end + +---@class RecentAllyCharacterData +---@field guid WOWGUID +---@field name string +---@field fullName string +---@field realmName string +---@field level number +---@field classID number +---@field raceID number +---@field sex Enum.UnitSex + +---@class RecentAllyData +---@field stateData RecentAllyStateData +---@field characterData RecentAllyCharacterData +---@field interactionData RecentAllyInteractionData + +---@class RecentAllyInteraction +---@field type Enum.RolodexType +---@field description string +---@field timestamp time_t +---@field contextData RecentAllyInteractionContextData + +---@class RecentAllyInteractionContextData +---@field itemID number? +---@field locationName string? +---@field activityDifficultyID number? +---@field activityDifficultyLevel number? + +---@class RecentAllyInteractionData +---@field interactions RecentAllyInteraction[] +---@field note string? + +---@class RecentAllyStateData +---@field isOnline boolean +---@field isDND boolean +---@field isAFK boolean +---@field pinExpirationDate time_t? +---@field friendRequestSentThisSession boolean +---@field currentLocation string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua new file mode 100644 index 0000000..46145e6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua @@ -0,0 +1,170 @@ +---@meta _ +C_RecruitAFriend = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.CanSummonFriend) +---@param guid WOWGUID +---@return boolean result +function C_RecruitAFriend.CanSummonFriend(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.ClaimActivityReward) +---@param activityID number +---@param acceptanceID RecruitAcceptanceID +---@return boolean success +function C_RecruitAFriend.ClaimActivityReward(activityID, acceptanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.ClaimNextReward) +---@param rafVersion? Enum.RecruitAFriendRewardsVersion +---@return boolean success +function C_RecruitAFriend.ClaimNextReward(rafVersion) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.GenerateRecruitmentLink) +---@return boolean success +function C_RecruitAFriend.GenerateRecruitmentLink() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.GetRAFInfo) +---@return RafInfo info +function C_RecruitAFriend.GetRAFInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.GetRAFSystemInfo) +---@return RafSystemInfo systemInfo +function C_RecruitAFriend.GetRAFSystemInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.GetRecruitActivityRequirementsText) +---@param activityID number +---@param acceptanceID RecruitAcceptanceID +---@return string[] requirementsText +function C_RecruitAFriend.GetRecruitActivityRequirementsText(activityID, acceptanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.GetRecruitInfo) +---@return boolean active +---@return number faction +function C_RecruitAFriend.GetRecruitInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.GetSummonFriendCooldown) +---@return number startTimeSeconds +---@return number durationSeconds +---@return boolean enableCooldownTimer +function C_RecruitAFriend.GetSummonFriendCooldown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.IsEnabled) +---@return boolean enabled +function C_RecruitAFriend.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.IsRecruitAFriendLinked) +---@param guid WOWGUID +---@return boolean result +function C_RecruitAFriend.IsRecruitAFriendLinked(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.IsRecruitingEnabled) +---@return boolean enabled +function C_RecruitAFriend.IsRecruitingEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.RemoveRAFRecruit) +---@param wowAccountGUID WOWGUID +---@return boolean success +function C_RecruitAFriend.RemoveRAFRecruit(wowAccountGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.RequestUpdatedRecruitmentInfo) +---@return boolean success +function C_RecruitAFriend.RequestUpdatedRecruitmentInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RecruitAFriend.SummonFriend) +---@param target WOWGUID +---@param name string +function C_RecruitAFriend.SummonFriend(target, name) end + +---@class RafAppearanceInfo +---@field appearanceID number + +---@class RafAppearanceSetInfo +---@field setID number +---@field setName string +---@field appearanceIDs number[] + +---@class RafIllusionInfo +---@field spellItemEnchantmentID number + +---@class RafInfo +---@field versions RafVersionInfo[] +---@field recruitmentInfo RafRecruitmentinfo? +---@field recruits RafRecruit[] +---@field claimInProgress boolean + +---@class RafMonthCount +---@field lifetimeMonths number +---@field spentMonths number +---@field availableMonths number + +---@class RafMountInfo +---@field spellID number +---@field mountID number + +---@class RafPetInfo +---@field creatureID number +---@field speciesID number +---@field displayID number +---@field speciesName string +---@field description string + +---@class RafRecruit +---@field bnetAccountID number +---@field wowAccountGUID WOWGUID +---@field battleTag string +---@field monthsRemaining number +---@field subStatus Enum.RafRecruitSubStatus +---@field acceptanceID RecruitAcceptanceID +---@field versionRecruited Enum.RecruitAFriendRewardsVersion +---@field activities RafRecruitActivity[] + +---@class RafRecruitActivity +---@field activityID number +---@field rewardQuestID number +---@field state Enum.RafRecruitActivityState + +---@class RafRecruitmentinfo +---@field recruitmentCode string +---@field recruitmentURL string +---@field expireTime number +---@field remainingTimeSeconds number +---@field totalUses number +---@field remainingUses number +---@field sourceRealm string +---@field sourceFaction string + +---@class RafReward +---@field rewardID number +---@field rafVersion Enum.RecruitAFriendRewardsVersion +---@field itemID number +---@field rewardType Enum.RafRewardType +---@field petInfo RafPetInfo? +---@field mountInfo RafMountInfo? +---@field appearanceInfo RafAppearanceInfo? +---@field titleInfo RafTitleInfo? +---@field appearanceSetInfo RafAppearanceSetInfo? +---@field illusionInfo RafIllusionInfo? +---@field canClaim boolean +---@field claimed boolean +---@field canAfford boolean +---@field repeatable boolean +---@field repeatableClaimCount number +---@field monthsRequired number +---@field monthCost number +---@field availableInMonths number +---@field iconID fileID + +---@class RafSystemInfo +---@field maxRecruits number +---@field maxRecruitMonths number +---@field maxRecruitmentUses number +---@field daysInCycle number + +---@class RafTitleInfo +---@field titleMaskID number + +---@class RafVersionInfo +---@field rafVersion Enum.RecruitAFriendRewardsVersion +---@field monthCount RafMonthCount +---@field rewards RafReward[] +---@field nextReward RafReward? +---@field numAffordableRewards number +---@field numRecruits number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua new file mode 100644 index 0000000..a8a4023 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua @@ -0,0 +1,61 @@ +---@meta _ +C_RemixArtifactUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.ClearRemixArtifactItem) +function C_RemixArtifactUI.ClearRemixArtifactItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.GetAppearanceInfoByID) +---@param artifactAppearanceID number +---@return number uiCameraID +---@return number? altHandUICameraID +function C_RemixArtifactUI.GetAppearanceInfoByID(artifactAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.GetArtifactArtInfo) +---@return RemixArtifactArtInfo artifactArtInfo +function C_RemixArtifactUI.GetArtifactArtInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.GetArtifactItemInfo) +---@return number itemID +---@return number? altItemID +---@return number artifactAppearanceID +---@return number appearanceModID +---@return number? itemAppearanceID +---@return number? altItemAppearanceID +---@return boolean altOnTop +function C_RemixArtifactUI.GetArtifactItemInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.GetCurrArtifactItemID) +---@return number? reqitemID +function C_RemixArtifactUI.GetCurrArtifactItemID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.GetCurrItemSpecIndex) +---@return number? specIndex +function C_RemixArtifactUI.GetCurrItemSpecIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.GetCurrTraitTreeID) +---@return number? traitTreeID +function C_RemixArtifactUI.GetCurrTraitTreeID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RemixArtifactUI.ItemInSlotIsRemixArtifact) +---@param invSlot number +---@return boolean isRemixArtifact +function C_RemixArtifactUI.ItemInSlotIsRemixArtifact(invSlot) end + +---@class RemixArtifactAppearanceInfo +---@field uiCameraID number +---@field altHandUICameraID number? + +---@class RemixArtifactArtInfo +---@field textureKit textureKit +---@field titleName string +---@field uiModelSceneID number +---@field spellVisualKitID number + +---@class RemixArtifactInfo +---@field itemID number +---@field altItemID number? +---@field artifactAppearanceID number +---@field appearanceModID number +---@field itemAppearanceID number? +---@field altItemAppearanceID number? +---@field altOnTop boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua new file mode 100644 index 0000000..1413c16 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua @@ -0,0 +1,59 @@ +---@meta _ +C_ReportSystem = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.CanReportPlayer) +---@param playerLocation PlayerLocation +---@return boolean canReport +function C_ReportSystem.CanReportPlayer(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.CanReportPlayerForLanguage) +---@param playerLocation PlayerLocation +---@return boolean canReport +function C_ReportSystem.CanReportPlayerForLanguage(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.GetMajorCategoriesForReportType) +---@param reportType Enum.ReportType +---@return Enum.ReportMajorCategory[] majorCategories +function C_ReportSystem.GetMajorCategoriesForReportType(reportType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.GetMajorCategoryString) +---@param majorCategory Enum.ReportMajorCategory +---@return string majorCategoryString +function C_ReportSystem.GetMajorCategoryString(majorCategory) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory) +---@param reportType Enum.ReportType +---@param majorCategory Enum.ReportMajorCategory +---@return Enum.ReportMinorCategory[] minorCategories +function C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory(reportType, majorCategory) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.GetMinorCategoryString) +---@param minorCategory Enum.ReportMinorCategory +---@return string minorCategoryString +function C_ReportSystem.GetMinorCategoryString(minorCategory) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.ReportServerLag) +function C_ReportSystem.ReportServerLag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.ReportStuckInCombat) +function C_ReportSystem.ReportStuckInCombat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.RequiresScreenshotForReportType) +---@param reportType Enum.ReportType +---@param majorCategory Enum.ReportMajorCategory +---@return boolean requiresScreenshot +function C_ReportSystem.RequiresScreenshotForReportType(reportType, majorCategory) end + +---Not allowed to be called by addons +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.SendReport) +---@param reportInfo ReportInfo +---@param playerLocation? PlayerLocation +function C_ReportSystem.SendReport(reportInfo, playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.SetScreenshotPreviewTexture) +---@param textureObject SimpleTexture +function C_ReportSystem.SetScreenshotPreviewTexture(textureObject) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReportSystem.TakeReportScreenshot) +function C_ReportSystem.TakeReportScreenshot() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua new file mode 100644 index 0000000..b2fde9b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua @@ -0,0 +1,141 @@ +---@meta _ +C_Reputation = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.AreLegacyReputationsShown) +---@return boolean areLegacyReputationsShown +function C_Reputation.AreLegacyReputationsShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.CollapseAllFactionHeaders) +function C_Reputation.CollapseAllFactionHeaders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.CollapseFactionHeader) +---@param factionSortIndex number +function C_Reputation.CollapseFactionHeader(factionSortIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.ExpandAllFactionHeaders) +function C_Reputation.ExpandAllFactionHeaders() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.ExpandFactionHeader) +---@param factionSortIndex number +function C_Reputation.ExpandFactionHeader(factionSortIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetFactionDataByID) +---@param factionID number +---@return FactionData? factionData +function C_Reputation.GetFactionDataByID(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetFactionDataByIndex) +---@param factionSortIndex number +---@return FactionData? factionData +function C_Reputation.GetFactionDataByIndex(factionSortIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetFactionParagonInfo) +---@param factionID number +---@return number currentValue +---@return number threshold +---@return number rewardQuestID +---@return boolean hasRewardPending +---@return boolean tooLowLevelForParagon +---@return number paragonStorageLevel +function C_Reputation.GetFactionParagonInfo(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetGuildFactionData) +---@return FactionData? guildFactionData +function C_Reputation.GetGuildFactionData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetGuildRepExpirationTime) +---@return number? expirationTime +function C_Reputation.GetGuildRepExpirationTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetNumFactions) +---@return number numFactions +function C_Reputation.GetNumFactions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetReputationSortType) +---@return Enum.ReputationSortType sortType +function C_Reputation.GetReputationSortType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetSelectedFaction) +---@return number selectedFactionSortIndex +function C_Reputation.GetSelectedFaction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.GetWatchedFactionData) +---@return FactionData? watchedFactionData +function C_Reputation.GetWatchedFactionData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.IsAccountWideReputation) +---@param factionID number +---@return boolean isAccountWide +function C_Reputation.IsAccountWideReputation(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.IsFactionActive) +---@param factionSortIndex number +---@return boolean isActive +function C_Reputation.IsFactionActive(factionSortIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.IsFactionParagon) +---@param factionID number +---@return boolean factionIsParagon +function C_Reputation.IsFactionParagon(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.IsFactionParagonForCurrentPlayer) +---@param factionID number +---@return boolean currentPlayerHasParagon +function C_Reputation.IsFactionParagonForCurrentPlayer(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.IsMajorFaction) +---@param factionID number +---@return boolean isMajorFaction +function C_Reputation.IsMajorFaction(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.RequestFactionParagonPreloadRewardData) +---@param factionID number +function C_Reputation.RequestFactionParagonPreloadRewardData(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.SetFactionActive) +---@param factionSortIndex number +---@param setActive boolean +function C_Reputation.SetFactionActive(factionSortIndex, setActive) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.SetLegacyReputationsShown) +---@param showLegacyReputations boolean +function C_Reputation.SetLegacyReputationsShown(showLegacyReputations) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.SetReputationSortType) +---@param sortType Enum.ReputationSortType +function C_Reputation.SetReputationSortType(sortType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.SetSelectedFaction) +---@param factionSortIndex number +function C_Reputation.SetSelectedFaction(factionSortIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.SetWatchedFactionByID) +---@param factionID number +function C_Reputation.SetWatchedFactionByID(factionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.SetWatchedFactionByIndex) +---@param factionSortIndex number +function C_Reputation.SetWatchedFactionByIndex(factionSortIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reputation.ToggleFactionAtWar) +---@param factionSortIndex number +function C_Reputation.ToggleFactionAtWar(factionSortIndex) end + +---@class FactionData +---@field factionID number +---@field name string +---@field description string +---@field reaction number +---@field currentReactionThreshold number +---@field nextReactionThreshold number +---@field currentStanding number +---@field atWarWith boolean +---@field canToggleAtWar boolean +---@field isChild boolean +---@field isHeader boolean +---@field isHeaderWithRep boolean +---@field isCollapsed boolean +---@field isWatched boolean +---@field hasBonusRepGain boolean +---@field canSetInactive boolean +---@field isAccountWide boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua new file mode 100644 index 0000000..6f7c32c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua @@ -0,0 +1,14 @@ +---@meta _ +C_ResearchInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ResearchInfo.GetDigSitesForMap) +---@param uiMapID number +---@return DigSiteMapInfo[] digSites +function C_ResearchInfo.GetDigSitesForMap(uiMapID) end + +---@class DigSiteMapInfo +---@field researchSiteID number +---@field position vector2 +---@field name string +---@field poiBlobID number +---@field textureIndex number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua new file mode 100644 index 0000000..b38e259 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua @@ -0,0 +1,28 @@ +---@meta _ +C_RestrictedActions = {} + +---Returns true if the calling context has permissions to call protected functions on the supplied object. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RestrictedActions.CheckAllowProtectedFunctions) +---@param object FrameScriptObject +---@param silent? boolean Default = false +---@return boolean protectedFunctionsAllowed +function C_RestrictedActions.CheckAllowProtectedFunctions(object, silent) end + +---Returns the current state of an addon restriction type. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RestrictedActions.GetAddOnRestrictionState) +---@param type Enum.AddOnRestrictionType +---@return Enum.AddOnRestrictionState state +function C_RestrictedActions.GetAddOnRestrictionState(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RestrictedActions.InCombatLockdown) +---@return boolean inCombatLockdown +function C_RestrictedActions.InCombatLockdown() end + +---Returns true if an addon restriction type is in an active state. Will always return false during dispatch of ADDON_RESTRICTION_STATE_CHANGED. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_RestrictedActions.IsAddOnRestrictionActive) +---@param type Enum.AddOnRestrictionType +---@return boolean active +function C_RestrictedActions.IsAddOnRestrictionActive(type) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReturningPlayerUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReturningPlayerUIDocumentation.lua new file mode 100644 index 0000000..704aaa3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ReturningPlayerUIDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +C_ReturningPlayerUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReturningPlayerUI.AcceptPrompt) +function C_ReturningPlayerUI.AcceptPrompt() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ReturningPlayerUI.DeclinePrompt) +function C_ReturningPlayerUI.DeclinePrompt() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua new file mode 100644 index 0000000..7b5a463 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua @@ -0,0 +1,99 @@ +---@meta _ +C_ScenarioInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetCriteriaInfo) +---@param criteriaIndex number +---@return ScenarioCriteriaInfo scenarioCriteriaInfo +function C_ScenarioInfo.GetCriteriaInfo(criteriaIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetCriteriaInfoByStep) +---@param stepID number +---@param criteriaIndex number +---@return ScenarioCriteriaInfo scenarioCriteriaInfo +function C_ScenarioInfo.GetCriteriaInfoByStep(stepID, criteriaIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetDisplayInfo) +---@return ScenarioDisplayInfo info +function C_ScenarioInfo.GetDisplayInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetJailersTowerTypeString) +---@param runType Enum.JailersTowerType +---@return string? typeString +function C_ScenarioInfo.GetJailersTowerTypeString(runType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetScenarioInfo) +---@return ScenarioInformation scenarioInfo +function C_ScenarioInfo.GetScenarioInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetScenarioStepInfo) +---@param scenarioStepID? number +---@return ScenarioStepInfo scenarioStepInfo +function C_ScenarioInfo.GetScenarioStepInfo(scenarioStepID) end + +---Returns list of active challenge spells if inside a tiered entrance scenario +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetTieredEntranceActiveSpells) +---@return number[]? spellIDs +function C_ScenarioInfo.GetTieredEntranceActiveSpells() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.GetUnitCriteriaProgressValues) +---@param unit UnitToken +---@return number actualValue +---@return number percentValue +---@return string percentValueString +function C_ScenarioInfo.GetUnitCriteriaProgressValues(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScenarioInfo.IsTieredEntranceScenario) +---@return boolean isTieredEntrance +function C_ScenarioInfo.IsTieredEntranceScenario() end + +---@class ScenarioCriteriaInfo +---@field description string +---@field criteriaType number? Default = 0 +---@field completed boolean? Default = false +---@field quantity number? Default = 0 +---@field totalQuantity number? Default = 0 +---@field flags number? Default = 0 +---@field assetID number? Default = 0 +---@field criteriaID number +---@field duration number? Default = 0 +---@field elapsed number? Default = 0 +---@field failed boolean? Default = false +---@field isWeightedProgress boolean? Default = false +---@field isFormatted boolean? Default = false +---@field quantityString string + +---@class ScenarioDisplayInfo +---@field themeColor colorRGB + +---@class ScenarioInformation +---@field name string +---@field currentStage number +---@field numStages number +---@field flags number +---@field isComplete boolean +---@field xp number +---@field money number +---@field type number +---@field area string +---@field uiTextureKit textureKit +---@field scenarioID number + +---@class ScenarioStepInfo +---@field title string +---@field description string +---@field numCriteria number +---@field stepFailed boolean +---@field isBonusStep boolean +---@field isForCurrentStepOnly boolean +---@field shouldShowBonusObjective boolean +---@field spells ScenarioStepSpellInfo[] +---@field weightedProgress number? +---@field rewardQuestID number +---@field widgetSetID number? +---@field stepID number + +---@class ScenarioStepSpellInfo +---@field spellID number +---@field name string +---@field icon number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua new file mode 100644 index 0000000..68a5d6e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua @@ -0,0 +1,42 @@ +---@meta _ +C_ScrappingMachineUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.CloseScrappingMachine) +function C_ScrappingMachineUI.CloseScrappingMachine() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.DropPendingScrapItemFromCursor) +---@param index number +function C_ScrappingMachineUI.DropPendingScrapItemFromCursor(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex) +---@param index number +---@return ItemLocation itemLoc +function C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.GetScrapSpellID) +---@return number spellID +function C_ScrappingMachineUI.GetScrapSpellID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.GetScrappingMachineName) +---@return string name +function C_ScrappingMachineUI.GetScrappingMachineName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.HasScrappableItems) +---@return boolean hasScrappableItems +function C_ScrappingMachineUI.HasScrappableItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.RemoveAllScrapItems) +function C_ScrappingMachineUI.RemoveAllScrapItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.RemoveCurrentScrappingItem) +function C_ScrappingMachineUI.RemoveCurrentScrappingItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.RemoveItemToScrap) +---@param index number +function C_ScrappingMachineUI.RemoveItemToScrap(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.ScrapItems) +function C_ScrappingMachineUI.ScrapItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScrappingMachineUI.ValidateScrappingList) +function C_ScrappingMachineUI.ValidateScrappingList() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua new file mode 100644 index 0000000..db48006 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua @@ -0,0 +1,21 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDefaultScale) +---@return number scale +function GetDefaultScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPhysicalScreenSize) +---@return number sizeX +---@return number sizeY +function GetPhysicalScreenSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetScreenDPIScale) +---@return number scale +function GetScreenDPIScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetScreenHeight) +---@return number height +function GetScreenHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetScreenWidth) +---@return number width +function GetScreenWidth() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua new file mode 100644 index 0000000..1b41211 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua @@ -0,0 +1,35 @@ +---@meta _ +C_ScriptedAnimations = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ScriptedAnimations.GetAllScriptedAnimationEffects) +---@return ScriptedAnimationEffect[] scriptedAnimationEffects +function C_ScriptedAnimations.GetAllScriptedAnimationEffects() end + +---@class ScriptedAnimationEffect +---@field id number +---@field visual fileID +---@field visualScale number +---@field duration number +---@field trajectory Enum.ScriptedAnimationTrajectory +---@field yawRadians number +---@field pitchRadians number +---@field rollRadians number +---@field offsetX number +---@field offsetY number +---@field offsetZ number +---@field animation number +---@field animationSpeed number +---@field alpha number +---@field useTargetAsSource boolean +---@field startBehavior Enum.ScriptedAnimationBehavior? +---@field startSoundKitID number? +---@field finishEffectID number? +---@field finishBehavior Enum.ScriptedAnimationBehavior? +---@field finishSoundKitID number? +---@field startAlphaFade number? +---@field startAlphaFadeDuration number? +---@field endAlphaFade number? +---@field endAlphaFadeDuration number? +---@field animationStartOffset number? +---@field loopingSoundKitID number? +---@field particleOverrideScale number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua new file mode 100644 index 0000000..35af673 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +C_SeasonInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SeasonInfo.GetCurrentDisplaySeasonExpansion) +---@return number? expansionID +function C_SeasonInfo.GetCurrentDisplaySeasonExpansion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SeasonInfo.GetCurrentDisplaySeasonID) +---@return number seasonID +function C_SeasonInfo.GetCurrentDisplaySeasonID() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua new file mode 100644 index 0000000..afe29e4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua @@ -0,0 +1,199 @@ +---@meta _ +C_Secrets = {} + +---Returns true if queries to compare two input unit tokens are permitted. If this returns false, APIs guarded by the RequiresComparableUnitTokens predicate will fail. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.CanCompareUnitTokens) +---@param unit1 UnitToken +---@param unit2 UnitToken +---@return boolean isUnitComparisonPermitted +function C_Secrets.CanCompareUnitTokens(unit1, unit2) end + +---Queries the base secrecy for a power type. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.GetPowerTypeSecrecy) +---@param powerType Enum.PowerType +---@return Enum.SecrecyLevel secrecy +function C_Secrets.GetPowerTypeSecrecy(powerType) end + +---Queries the base secrecy for a spell if queried as an aura. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.GetSpellAuraSecrecy) +---@param spellIdentifier SpellIdentifier +---@return Enum.SecrecyLevel secrecy +function C_Secrets.GetSpellAuraSecrecy(spellIdentifier) end + +---Queries the base secrecy for a spell if queried as a cast. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.GetSpellCastSecrecy) +---@param spellIdentifier SpellIdentifier +---@return Enum.SecrecyLevel secrecy +function C_Secrets.GetSpellCastSecrecy(spellIdentifier) end + +---Queries the base secrecy for a spell if queried as a cooldown. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.GetSpellCooldownSecrecy) +---@param spellIdentifier SpellIdentifier +---@return Enum.SecrecyLevel secrecy +function C_Secrets.GetSpellCooldownSecrecy(spellIdentifier) end + +---Returns true if this client build has secret value restrictions enabled. If false, all APIs that are tagged as potentially returning secrets will never do so. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.HasSecretRestrictions) +---@return boolean hasSecretRestrictions +function C_Secrets.HasSecretRestrictions() end + +---Returns true if a given action bar slot ID will produce secret values for cooldowns if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldActionCooldownBeSecret) +---@param actionID number +---@return boolean isCooldownSecret +function C_Secrets.ShouldActionCooldownBeSecret(actionID) end + +---Returns true if queries for aura data will generally produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldAurasBeSecret) +---@return boolean hasSecretAuras +function C_Secrets.ShouldAurasBeSecret() end + +---Returns true if queries for cooldown data will generally produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldCooldownsBeSecret) +---@return boolean hasSecretCooldowns +function C_Secrets.ShouldCooldownsBeSecret() end + +---Returns true if a given spell identifier would, if applied as an aura, produce secret values when queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldSpellAuraBeSecret) +---@param spellIdentifier SpellIdentifier +---@return boolean isAuraSecret +function C_Secrets.ShouldSpellAuraBeSecret(spellIdentifier) end + +---Returns true if a given spellbook item will produce secret values for cooldowns if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldSpellBookItemCooldownBeSecret) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isCooldownSecret +function C_Secrets.ShouldSpellBookItemCooldownBeSecret(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if a given spell identifier will produce secret values for cooldowns if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldSpellCooldownBeSecret) +---@param spellIdentifier SpellIdentifier +---@return boolean isCooldownSecret +function C_Secrets.ShouldSpellCooldownBeSecret(spellIdentifier) end + +---Returns true if information about a totem slot will produce secret values if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldTotemSlotBeSecret) +---@param slot number +---@return boolean isTotemSecret +function C_Secrets.ShouldTotemSlotBeSecret(slot) end + +---Returns true if information about a spell when associated with a totem slot will produce secret values if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldTotemSpellBeSecret) +---@param spellID number +---@return boolean isTotemSecret +function C_Secrets.ShouldTotemSpellBeSecret(spellID) end + +---Returns true if a given aura index will produce secret values if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitAuraIndexBeSecret) +---@param unit UnitToken +---@param index number +---@param filter? AuraFilters +---@return boolean isAuraSecret +function C_Secrets.ShouldUnitAuraIndexBeSecret(unit, index, filter) end + +---Returns true if a given aura instance ID will produce secret values if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitAuraInstanceBeSecret) +---@param unit UnitToken +---@param auraInstanceID number +---@return boolean isAuraSecret +function C_Secrets.ShouldUnitAuraInstanceBeSecret(unit, auraInstanceID) end + +---Returns true if a given aura slot ID will produce secret values if queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitAuraSlotBeSecret) +---@param unit UnitToken +---@param slot number +---@return boolean isAuraSecret +function C_Secrets.ShouldUnitAuraSlotBeSecret(unit, slot) end + +---Returns true if queries that compare units will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitComparisonBeSecret) +---@param unit1 UnitToken +---@param unit2 UnitToken +---@return boolean isUnitComparisonSecret +function C_Secrets.ShouldUnitComparisonBeSecret(unit1, unit2) end + +---Returns true if queries for maximum unit health will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitHealthMaxBeSecret) +---@param unit UnitToken +---@return boolean isUnitHealthMaxSecret +function C_Secrets.ShouldUnitHealthMaxBeSecret(unit) end + +---Returns true if queries for unit identity (such as name or GUID) will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitIdentityBeSecret) +---@param unit UnitToken +---@return boolean isUnitIdentitySecret +function C_Secrets.ShouldUnitIdentityBeSecret(unit) end + +---Returns true if queries for unit power will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitPowerBeSecret) +---@param unit UnitToken +---@param powerType? Enum.PowerType +---@return boolean isUnitPowerSecret +function C_Secrets.ShouldUnitPowerBeSecret(unit, powerType) end + +---Returns true if queries for maximum unit power will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitPowerMaxBeSecret) +---@param unit UnitToken +---@param powerType? Enum.PowerType +---@return boolean isUnitPowerMaxSecret +function C_Secrets.ShouldUnitPowerMaxBeSecret(unit, powerType) end + +---Returns true if queries for spell casting information for a unit would produce secret values when queried. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitSpellCastBeSecret) +---@param unit UnitToken +---@param spellIdentifier SpellIdentifier +---@return boolean isSpellCastSecret +function C_Secrets.ShouldUnitSpellCastBeSecret(unit, spellIdentifier) end + +---Returns true if queries for spell casting information for a specific unit will generally produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitSpellCastingBeSecret) +---@param unit UnitToken +---@return boolean isSpellCastingSecret +function C_Secrets.ShouldUnitSpellCastingBeSecret(unit) end + +---Returns true if queries for unit statistics will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitStatsBeSecret) +---@return boolean hasSecretStats +function C_Secrets.ShouldUnitStatsBeSecret() end + +---Returns true if queries for unit threat status will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitThreatStateBeSecret) +---@param unit UnitToken +---@param mobUnit? UnitToken +---@return boolean isUnitThreatSecret +function C_Secrets.ShouldUnitThreatStateBeSecret(unit, mobUnit) end + +---Returns true if queries for unit threat values will produce secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Secrets.ShouldUnitThreatValuesBeSecret) +---@param unit UnitToken +---@param mobUnit UnitToken +---@return boolean isUnitThreatSecret +function C_Secrets.ShouldUnitThreatValuesBeSecret(unit, mobUnit) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua new file mode 100644 index 0000000..5fe3e77 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua @@ -0,0 +1,45 @@ +---@meta _ +C_SecureTransfer = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.AcceptTrade) +function C_SecureTransfer.AcceptTrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.Cancel) +function C_SecureTransfer.Cancel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.CompleteHousingPurchase) +function C_SecureTransfer.CompleteHousingPurchase() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.CompleteHousingVCPurchase) +function C_SecureTransfer.CompleteHousingVCPurchase() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.GetHousingPurchaseCost) +---@return number totalCost +function C_SecureTransfer.GetHousingPurchaseCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.GetHousingPurchaseQuantity) +---@return number quantity +function C_SecureTransfer.GetHousingPurchaseQuantity() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.GetHousingVCPurchaseProductID) +---@return number productID +function C_SecureTransfer.GetHousingVCPurchaseProductID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.GetMailInfo) +---@return MailInfo mailInfo +function C_SecureTransfer.GetMailInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.GetTradePartner) +---@return string? name +function C_SecureTransfer.GetTradePartner() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.SendMail) +function C_SecureTransfer.SendMail() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SecureTransfer.ShouldShowTradeOfferWarning) +---@return boolean shouldShow +function C_SecureTransfer.ShouldShowTradeOfferWarning() end + +---@class MailInfo +---@field target string +---@field sendMoney number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua new file mode 100644 index 0000000..ec167e5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua @@ -0,0 +1,10 @@ +---@meta _ +C_SettingsUtil = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SettingsUtil.NotifySettingsLoaded) +function C_SettingsUtil.NotifySettingsLoaded() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SettingsUtil.OpenSettingsPanel) +---@param openToCategoryID? number +---@param scrollToElementName? stringView +function C_SettingsUtil.OpenSettingsPanel(openToCategoryID, scrollToElementName) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua new file mode 100644 index 0000000..cae64cb --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +---@class ModelLight +---@field omnidirectional boolean? Default = false +---@field point vector3 +---@field ambientIntensity number? Default = 0 +---@field ambientColor colorRGB? +---@field diffuseIntensity number? Default = 0 +---@field diffuseColor colorRGB? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua new file mode 100644 index 0000000..12038af --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua @@ -0,0 +1,416 @@ +---@meta _ +C_Traits = {} + +---Returns whether the player can make changes to the specified talent config. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.CanEditConfig) +---@param configID number +---@return boolean canEdit +---@return string errorMessage +function C_Traits.CanEditConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.CanPurchaseRank) +---@param configID number +---@param nodeID number +---@param nodeEntryID number +---@return boolean canPurchase +function C_Traits.CanPurchaseRank(configID, nodeID, nodeEntryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.CanRefundRank) +---@param configID number +---@param nodeID number +---@return boolean canRefund +function C_Traits.CanRefundRank(configID, nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.CascadeRepurchaseRanks) +---@param configID number +---@param nodeID number +---@param entryID? number +---@return boolean success +function C_Traits.CascadeRepurchaseRanks(configID, nodeID, entryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.ClearCascadeRepurchaseHistory) +---@param configID number +function C_Traits.ClearCascadeRepurchaseHistory(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.CloseTraitSystemInteraction) +function C_Traits.CloseTraitSystemInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.CommitConfig) +---@param configID number +---@return boolean success +function C_Traits.CommitConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.ConfigHasStagedChanges) +---@param configID number +---@return boolean hasChanges +function C_Traits.ConfigHasStagedChanges(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GenerateImportString) +---@param configID number +---@return string importString +function C_Traits.GenerateImportString(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GenerateInspectImportString) +---@param target string +---@return string importString +function C_Traits.GenerateInspectImportString(target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetConditionInfo) +---@param configID number +---@param condID number +---@return TraitCondInfo condInfo +function C_Traits.GetConditionInfo(configID, condID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetConfigIDBySystemID) +---@param systemID number +---@return number configID +function C_Traits.GetConfigIDBySystemID(systemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetConfigIDByTreeID) +---@param treeID number +---@return number configID +function C_Traits.GetConfigIDByTreeID(treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetConfigInfo) +---@param configID number +---@return TraitConfigInfo configInfo +function C_Traits.GetConfigInfo(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetConfigVariationID) +---@param systemID number +---@return number variationID +function C_Traits.GetConfigVariationID(systemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetConfigsByType) +---@param configType Enum.TraitConfigType +---@return number[] configIDs +function C_Traits.GetConfigsByType(configType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetDefinitionInfo) +---@param definitionID number +---@return TraitDefinitionInfo definitionInfo +function C_Traits.GetDefinitionInfo(definitionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetEntryInfo) +---@param configID number +---@param entryID number +---@return TraitEntryInfo entryInfo +function C_Traits.GetEntryInfo(configID, entryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetIncreasedTraitData) +---@param nodeID number +---@param entryID number +---@return IncreasedTraitData[] itemName +function C_Traits.GetIncreasedTraitData(nodeID, entryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetLoadoutSerializationVersion) +---@return number serializationVersion +function C_Traits.GetLoadoutSerializationVersion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetNodeCost) +---@param configID number +---@param nodeID number +---@return TraitCurrencyCost[] costs +function C_Traits.GetNodeCost(configID, nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetNodeInfo) +---@param configID number +---@param nodeID number +---@return TraitNodeInfo nodeInfo +function C_Traits.GetNodeInfo(configID, nodeID) end + +---Returns IDs of Trait Nodes with pending changes, grouped by the type of change; Returns nothing if there are no pending changes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetStagedChanges) +---@param configID number +---@return number[] nodeIDsWithPurchases +---@return number[] nodeIDsWithRefunds +---@return number[] nodeIDsWithSelectionSwaps +function C_Traits.GetStagedChanges(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetStagedChangesCost) +---@param configID number +---@return TraitCurrencyCost[] costs +function C_Traits.GetStagedChangesCost(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetSubTreeInfo) +---@param configID number +---@param subTreeID number +---@return TraitSubTreeInfo subTreeInfo +function C_Traits.GetSubTreeInfo(configID, subTreeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetSystemIDByTreeID) +---@param treeID number +---@return number systemID +function C_Traits.GetSystemIDByTreeID(treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTraitCurrencyInfo) +---@param traitCurrencyID number +---@return number flags +---@return number type +---@return number? currencyTypesID +---@return number? icon +function C_Traits.GetTraitCurrencyInfo(traitCurrencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTraitDescription) +---@param entryID number +---@param rank number +---@return string description +function C_Traits.GetTraitDescription(entryID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTraitSystemFlags) +---@param configID number +---@return number flags +function C_Traits.GetTraitSystemFlags(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTraitSystemWidgetSetID) +---@param configID number +---@return number uiWidgetSetID +function C_Traits.GetTraitSystemWidgetSetID(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTreeCurrencyInfo) +---@param configID number +---@param treeID number +---@param excludeStagedChanges boolean +---@return TreeCurrencyInfo[] treeCurrencyInfo +function C_Traits.GetTreeCurrencyInfo(configID, treeID, excludeStagedChanges) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTreeHash) +---@param treeID number +---@return number[] result +function C_Traits.GetTreeHash(treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTreeInfo) +---@param configID number +---@param treeID number +---@return TraitTreeInfo treeInfo +function C_Traits.GetTreeInfo(configID, treeID) end + +---Returns a list of nodeIDs, sorted ascending, for a given treeID. Contains nodes for all class specializations. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.GetTreeNodes) +---@param treeID number +---@return number[] nodeIDs +function C_Traits.GetTreeNodes(treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.HasValidInspectData) +---@return boolean hasValidInspectData +function C_Traits.HasValidInspectData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.IsReadyForCommit) +---@return boolean isReadyForCommit +function C_Traits.IsReadyForCommit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.PurchaseAllRanks) +---@param configID number +---@param nodeID number +---@param ignoreCost boolean +---@return boolean success +function C_Traits.PurchaseAllRanks(configID, nodeID, ignoreCost) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.PurchaseRank) +---@param configID number +---@param nodeID number +---@return boolean success +function C_Traits.PurchaseRank(configID, nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.RefundAllRanks) +---@param configID number +---@param nodeID number +---@return boolean success +function C_Traits.RefundAllRanks(configID, nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.RefundRank) +---@param configID number +---@param nodeID number +---@param clearEdges? boolean +---@return boolean success +function C_Traits.RefundRank(configID, nodeID, clearEdges) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.ResetTree) +---@param configID number +---@param treeID number +---@return boolean success +function C_Traits.ResetTree(configID, treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.ResetTreeByCurrency) +---@param configID number +---@param treeID number +---@param traitCurrencyID number +---@return boolean success +function C_Traits.ResetTreeByCurrency(configID, treeID, traitCurrencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.RollbackConfig) +---@param configID number +---@return boolean success +function C_Traits.RollbackConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.SetSelection) +---@param configID number +---@param nodeID number +---@param nodeEntryID? number +---@param clearEdges? boolean +---@return boolean success +function C_Traits.SetSelection(configID, nodeID, nodeEntryID, clearEdges) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.StageConfig) +---@param configID number +---@return boolean success +function C_Traits.StageConfig(configID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.TalentTestUnlearnSpells) +function C_Traits.TalentTestUnlearnSpells() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.TryPurchaseAllRanks) +---@param configID number +---@param nodeID number +---@return boolean success +function C_Traits.TryPurchaseAllRanks(configID, nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.TryPurchaseToNode) +---@param configID number +---@param nodeID number +---@return boolean success +function C_Traits.TryPurchaseToNode(configID, nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Traits.TryRefundToNode) +---@param configID number +---@param nodeID number +---@param entryID number +---@return boolean success +function C_Traits.TryRefundToNode(configID, nodeID, entryID) end + +---@class IncreasedTraitData +---@field itemNameIncreasing string +---@field itemQualityIncreasing Enum.ItemQuality +---@field numPointsIncreased number + +---@class TraitCondInfo +---@field condID number +---@field ranksGranted number? +---@field isAlwaysMet boolean +---@field isMet boolean +---@field isGate boolean +---@field isSufficient boolean +---@field type number +---@field questID number? +---@field achievementID number? +---@field specSetID number? +---@field playerLevel number? +---@field traitCurrencyID number? +---@field spentAmountRequired number? +---@field tooltipFormat string? +---@field traitCondAccountElementID number? + +---@class TraitConfigInfo +---@field ID number +---@field type Enum.TraitConfigType +---@field name string +---@field treeIDs number[] +---@field usesSharedActionBars boolean + +---@class TraitCurrencyCost +---@field ID number +---@field amount number + +---@class TraitDefinitionInfo +---@field spellID number? +---@field overrideName string? +---@field overrideSubtext string? +---@field overrideDescription string? +---@field overrideIcon number? +---@field overriddenSpellID number? +---@field subType Enum.TraitDefinitionSubType? + +---@class TraitEntryInfo +---@field definitionID number? +---@field subTreeID number? +---@field type Enum.TraitNodeEntryType +---@field maxRanks number +---@field isAvailable boolean +---@field isDisplayError boolean +---@field conditionIDs number[] + +---@class TraitEntryRankInfo +---@field entryID number +---@field rank number + +---@class TraitGateInfo +---@field topLeftNodeID number +---@field conditionID number + +---@class TraitNodeInfo +---@field ID number +---@field posX number +---@field posY number +---@field flags number +---@field entryIDs number[] +---@field entryIDsWithCommittedRanks number[] +---@field canPurchaseRank boolean +---@field canRefundRank boolean +---@field isAvailable boolean +---@field isVisible boolean +---@field isDisplayError boolean +---@field ranksPurchased number +---@field ranksIncreased number +---@field entryIDToRanksIncreased LuaValueVariant +---@field activeRank number +---@field currentRank number +---@field activeEntry TraitEntryRankInfo? +---@field nextEntry TraitEntryRankInfo? +---@field maxRanks number +---@field totalMaxRanks number +---@field type Enum.TraitNodeType +---@field visibleEdges TraitOutEdgeInfo[] +---@field meetsEdgeRequirements boolean +---@field groupIDs number[] +---@field conditionIDs number[] +---@field isCascadeRepurchasable boolean +---@field cascadeRepurchaseEntryID number? +---@field subTreeID number? +---@field subTreeActive boolean? + +---@class TraitNodeInfoPartial +---@field canPurchaseRank boolean? +---@field canRefundRank boolean? +---@field isAvailable boolean? +---@field isVisible boolean? +---@field ranksPurchased number? +---@field activeRank number? +---@field currentRank number? +---@field meetsEdgeRequirements boolean? +---@field isCascadeRepurchasable boolean? +---@field activeEntryID number? +---@field subTreeActive boolean? + +---@class TraitOutEdgeInfo +---@field targetNode number +---@field type number +---@field visualStyle number +---@field isActive boolean + +---@class TraitSubTreeInfo +---@field ID number +---@field name string? +---@field description string? +---@field iconElementID textureAtlas? +---@field traitCurrencyID number? +---@field isActive boolean +---@field subTreeSelectionNodeIDs number[] +---@field posX number +---@field posY number + +---@class TraitTreeInfo +---@field ID number +---@field gates TraitGateInfo[] +---@field hideSingleRankNumbers boolean +---@field rootNodeID number? +---@field uiTextureKit textureKit +---@field titleText string? + +---@class TreeCurrencyInfo +---@field traitCurrencyID number +---@field quantity number +---@field maxQuantity number? +---@field spent number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua new file mode 100644 index 0000000..2d81c3f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua @@ -0,0 +1,5 @@ +---@meta _ +---@class HTMLContentNode +---@field text string +---@field type HTMLTextType +---@field align JustifyHorizontal diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua new file mode 100644 index 0000000..c01da4c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AreDangerousScriptsAllowed) +---@return boolean allowed +function AreDangerousScriptsAllowed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAllowDangerousScripts) +---@param allowed? boolean Default = false +function SetAllowDangerousScripts(allowed) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua new file mode 100644 index 0000000..a77213d --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua @@ -0,0 +1,101 @@ +---@meta _ +C_SocialQueue = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.GetAllGroups) +---@param allowNonJoinable? boolean Default = false +---@param allowNonQueuedGroups? boolean Default = false +---@return WOWGUID[] groupGUIDs +function C_SocialQueue.GetAllGroups(allowNonJoinable, allowNonQueuedGroups) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.GetConfig) +---@return SocialQueueConfig config +function C_SocialQueue.GetConfig() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.GetGroupForPlayer) +---@param playerGUID WOWGUID +---@return WOWGUID groupGUID +---@return boolean isSoloQueueParty +function C_SocialQueue.GetGroupForPlayer(playerGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.GetGroupInfo) +---@param groupGUID WOWGUID +---@return boolean canJoin +---@return number numQueues +---@return boolean needTank +---@return boolean needHealer +---@return boolean needDamage +---@return boolean isSoloQueueParty +---@return boolean questSessionActive +---@return WOWGUID leaderGUID +function C_SocialQueue.GetGroupInfo(groupGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.GetGroupMembers) +---@param groupGUID WOWGUID +---@return SocialQueuePlayerInfo[] groupMembers +function C_SocialQueue.GetGroupMembers(groupGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.GetGroupQueues) +---@param groupGUID WOWGUID +---@return SocialQueueGroupQueueInfo[] queues +function C_SocialQueue.GetGroupQueues(groupGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.RequestToJoin) +---@param groupGUID WOWGUID +---@param applyAsTank? boolean Default = false +---@param applyAsHealer? boolean Default = false +---@param applyAsDamage? boolean Default = false +---@return boolean requestSuccessful +function C_SocialQueue.RequestToJoin(groupGUID, applyAsTank, applyAsHealer, applyAsDamage) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialQueue.SignalToastDisplayed) +---@param groupGUID WOWGUID +---@param priority number +function C_SocialQueue.SignalToastDisplayed(groupGUID, priority) end + +---@class SocialQueueConfig +---@field TOASTS_DISABLED boolean +---@field TOAST_DURATION number +---@field DELAY_DURATION number +---@field QUEUE_MULTIPLIER number +---@field PLAYER_MULTIPLIER number +---@field PLAYER_FRIEND_VALUE number +---@field PLAYER_GUILD_VALUE number +---@field THROTTLE_INITIAL_THRESHOLD number +---@field THROTTLE_DECAY_TIME number +---@field THROTTLE_PRIORITY_SPIKE number +---@field THROTTLE_MIN_THRESHOLD number +---@field THROTTLE_PVP_PRIORITY_NORMAL number +---@field THROTTLE_PVP_PRIORITY_LOW number +---@field THROTTLE_PVP_HONOR_THRESHOLD number +---@field THROTTLE_LFGLIST_PRIORITY_DEFAULT number +---@field THROTTLE_LFGLIST_PRIORITY_ABOVE number +---@field THROTTLE_LFGLIST_PRIORITY_BELOW number +---@field THROTTLE_LFGLIST_ILVL_SCALING_ABOVE number +---@field THROTTLE_LFGLIST_ILVL_SCALING_BELOW number +---@field THROTTLE_RF_PRIORITY_ABOVE number +---@field THROTTLE_RF_ILVL_SCALING_ABOVE number +---@field THROTTLE_DF_MAX_ITEM_LEVEL number +---@field THROTTLE_DF_BEST_PRIORITY number + +---@class SocialQueueGroupInfo +---@field canJoin boolean +---@field numQueues number +---@field needTank boolean +---@field needHealer boolean +---@field needDamage boolean +---@field isSoloQueueParty boolean +---@field questSessionActive boolean +---@field leaderGUID WOWGUID + +---@class SocialQueueGroupQueueInfo +---@field clientID number +---@field eligible boolean +---@field needTank boolean +---@field needHealer boolean +---@field needDamage boolean +---@field isAutoAccept boolean +---@field queueData QueueSpecificInfo + +---@class SocialQueuePlayerInfo +---@field guid WOWGUID +---@field clubId ClubId? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua new file mode 100644 index 0000000..6a2fc11 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua @@ -0,0 +1,37 @@ +---@meta _ +C_SocialRestrictions = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.AcknowledgeRegionalChatDisabled) +function C_SocialRestrictions.AcknowledgeRegionalChatDisabled() end + +---Returns true if the player meets all conditions that allow them to receive chat messages. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.CanReceiveChat) +---@return boolean canReceiveChat +function C_SocialRestrictions.CanReceiveChat() end + +---Returns true if the player meets all conditions that allow them to send chat messages. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.CanSendChat) +---@return boolean canSendChat +function C_SocialRestrictions.CanSendChat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.IsChatDisabled) +---@return boolean disabled +function C_SocialRestrictions.IsChatDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.IsMuted) +---@return boolean isMuted +function C_SocialRestrictions.IsMuted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.IsSilenced) +---@return boolean isSilenced +function C_SocialRestrictions.IsSilenced() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.IsSquelched) +---@return boolean isSquelched +function C_SocialRestrictions.IsSquelched() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SocialRestrictions.SetChatDisabled) +---@param disabled boolean +function C_SocialRestrictions.SetChatDisabled(disabled) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua new file mode 100644 index 0000000..1581156 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua @@ -0,0 +1,247 @@ +---@meta _ +C_Soulbinds = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.ActivateSoulbind) +---@param soulbindID number +function C_Soulbinds.ActivateSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.CanActivateSoulbind) +---@param soulbindID number +---@return boolean result +---@return string? errorDescription +function C_Soulbinds.CanActivateSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.CanModifySoulbind) +---@return boolean result +function C_Soulbinds.CanModifySoulbind() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.CanResetConduitsInSoulbind) +---@param soulbindID number +---@return boolean result +---@return string? errorDescription +function C_Soulbinds.CanResetConduitsInSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.CanSwitchActiveSoulbindTreeBranch) +---@return boolean result +function C_Soulbinds.CanSwitchActiveSoulbindTreeBranch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.CloseUI) +function C_Soulbinds.CloseUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.CommitPendingConduitsInSoulbind) +---@param soulbindID number +function C_Soulbinds.CommitPendingConduitsInSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.FindNodeIDActuallyInstalled) +---@param soulbindID number +---@param conduitID number +---@return number nodeID +function C_Soulbinds.FindNodeIDActuallyInstalled(soulbindID, conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.FindNodeIDAppearingInstalled) +---@param soulbindID number +---@param conduitID number +---@return number nodeID +function C_Soulbinds.FindNodeIDAppearingInstalled(soulbindID, conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.FindNodeIDPendingInstall) +---@param soulbindID number +---@param conduitID number +---@return number nodeID +function C_Soulbinds.FindNodeIDPendingInstall(soulbindID, conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.FindNodeIDPendingUninstall) +---@param soulbindID number +---@param conduitID number +---@return number nodeID +function C_Soulbinds.FindNodeIDPendingUninstall(soulbindID, conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetActiveSoulbindID) +---@return number soulbindID +function C_Soulbinds.GetActiveSoulbindID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitCollection) +---@param conduitType Enum.SoulbindConduitType +---@return ConduitCollectionData[] collectionData +function C_Soulbinds.GetConduitCollection(conduitType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitCollectionCount) +---@return number count +function C_Soulbinds.GetConduitCollectionCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitCollectionData) +---@param conduitID number +---@return ConduitCollectionData? collectionData +function C_Soulbinds.GetConduitCollectionData(conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitCollectionDataAtCursor) +---@return ConduitCollectionData? collectionData +function C_Soulbinds.GetConduitCollectionDataAtCursor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitCollectionDataByVirtualID) +---@param virtualID number +---@return ConduitCollectionData? collectionData +function C_Soulbinds.GetConduitCollectionDataByVirtualID(virtualID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitDisplayed) +---@param nodeID number +---@return number conduitID +function C_Soulbinds.GetConduitDisplayed(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitHyperlink) +---@param conduitID number +---@param rank number +---@return string link +function C_Soulbinds.GetConduitHyperlink(conduitID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitIDPendingInstall) +---@param nodeID number +---@return number conduitID +function C_Soulbinds.GetConduitIDPendingInstall(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitQuality) +---@param conduitID number +---@param rank number +---@return number quality +function C_Soulbinds.GetConduitQuality(conduitID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitRank) +---@param conduitID number +---@return number conduitRank +function C_Soulbinds.GetConduitRank(conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetConduitSpellID) +---@param conduitID number +---@param conduitRank number +---@return number spellID +function C_Soulbinds.GetConduitSpellID(conduitID, conduitRank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetInstalledConduitID) +---@param nodeID number +---@return number conduitID +function C_Soulbinds.GetInstalledConduitID(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetNode) +---@param nodeID number +---@return SoulbindNode node +function C_Soulbinds.GetNode(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetSoulbindData) +---@param soulbindID number +---@return SoulbindData data +function C_Soulbinds.GetSoulbindData(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetSpecsAssignedToSoulbind) +---@param soulbindID number +---@return number[] specIDs +function C_Soulbinds.GetSpecsAssignedToSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.GetTree) +---@param treeID number +---@return SoulbindTree tree +function C_Soulbinds.GetTree(treeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.HasAnyInstalledConduitInSoulbind) +---@param soulbindID number +---@return boolean result +function C_Soulbinds.HasAnyInstalledConduitInSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.HasAnyPendingConduits) +---@return boolean result +function C_Soulbinds.HasAnyPendingConduits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.HasPendingConduitsInSoulbind) +---@param soulbindID number +---@return boolean result +function C_Soulbinds.HasPendingConduitsInSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.IsConduitInstalled) +---@param nodeID number +---@return boolean result +function C_Soulbinds.IsConduitInstalled(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.IsConduitInstalledInSoulbind) +---@param soulbindID number +---@param conduitID number +---@return boolean result +function C_Soulbinds.IsConduitInstalledInSoulbind(soulbindID, conduitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.IsItemConduitByItemInfo) +---@param itemInfo ItemInfo +---@return boolean result +function C_Soulbinds.IsItemConduitByItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.IsNodePendingModify) +---@param nodeID number +---@return boolean result +function C_Soulbinds.IsNodePendingModify(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.IsUnselectedConduitPendingInSoulbind) +---@param soulbindID number +---@return boolean result +function C_Soulbinds.IsUnselectedConduitPendingInSoulbind(soulbindID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.ModifyNode) +---@param nodeID number +---@param conduitID number +---@param type Enum.SoulbindConduitTransactionType +function C_Soulbinds.ModifyNode(nodeID, conduitID, type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.SelectNode) +---@param nodeID number +function C_Soulbinds.SelectNode(nodeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Soulbinds.UnmodifyNode) +---@param nodeID number +function C_Soulbinds.UnmodifyNode(nodeID) end + +---@class ConduitCollectionData +---@field conduitID number +---@field conduitRank number +---@field conduitItemLevel number +---@field conduitType Enum.SoulbindConduitType +---@field conduitSpecSetID number +---@field conduitSpecIDs number[] +---@field conduitSpecName string? +---@field covenantID number? +---@field conduitItemID number + +---@class SoulbindConduitData +---@field conduitID number +---@field conduitRank number + +---@class SoulbindData +---@field ID number +---@field covenantID number +---@field name string +---@field description string +---@field textureKit textureKit +---@field unlocked boolean +---@field cvarIndex number +---@field tree SoulbindTree +---@field modelSceneData SoulbindModelSceneData +---@field activationSoundKitID number +---@field playerConditionReason string? + +---@class SoulbindModelSceneData +---@field creatureDisplayInfoID number +---@field modelSceneActorID number + +---@class SoulbindNode +---@field ID number +---@field row number +---@field column number +---@field icon fileID +---@field spellID number +---@field playerConditionReason string? +---@field conduitID number +---@field conduitRank number +---@field state Enum.SoulbindNodeState +---@field conduitType Enum.SoulbindConduitType? +---@field parentNodeIDs number[] +---@field failureRenownRequirement number? +---@field socketEnhanced boolean? + +---@class SoulbindTree +---@field editable boolean +---@field nodes SoulbindNode[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua new file mode 100644 index 0000000..75a3256 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua @@ -0,0 +1,42 @@ +---@meta _ +C_Sound = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Sound.GetSoundScaledVolume) +---@param soundHandle number +---@return number scaledVolume +function C_Sound.GetSoundScaledVolume(soundHandle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Sound.IsPlaying) +---@param soundHandle number +---@return boolean isPlaying +function C_Sound.IsPlaying(soundHandle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Sound.PlayItemSound) +---@param soundType Enum.ItemSoundType +---@param itemLocation ItemLocation +function C_Sound.PlayItemSound(soundType, itemLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Sound.PlaySound) +---@param soundKitID number +---@param uiSoundSubType? UISoundSubType Default = g_defaultSI3UISoundSubTypeForLua +---@param forceNoDuplicates? boolean Default = false +---@param runFinishCallback? boolean Default = false +---@param overridePriority? number +---@return boolean success +---@return SoundHandle soundHandle +function C_Sound.PlaySound(soundKitID, uiSoundSubType, forceNoDuplicates, runFinishCallback, overridePriority) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Sound.PlayVocalErrorSound) +---@param vocalErrorSoundID Enum.Vocalerrorsounds +function C_Sound.PlayVocalErrorSound(vocalErrorSoundID) end + +---@class PlaySoundParams +---@field soundKitID number +---@field uiSoundSubType UISoundSubType? Default = g_defaultSI3UISoundSubTypeForLua +---@field forceNoDuplicates boolean? Default = false +---@field runFinishCallback boolean? Default = false +---@field overridePriority number? + +---@class PlaySoundResult +---@field success boolean +---@field soundHandle SoundHandle diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua new file mode 100644 index 0000000..b490e64 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua @@ -0,0 +1,216 @@ +---@meta _ +C_SpecializationInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.CanPlayerUsePVPTalentUI) +---@return boolean canUse +---@return string failureReason +function C_SpecializationInfo.CanPlayerUsePVPTalentUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.CanPlayerUseTalentSpecUI) +---@return boolean canUse +---@return string failureReason +function C_SpecializationInfo.CanPlayerUseTalentSpecUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.CanPlayerUseTalentUI) +---@return boolean canUse +---@return string failureReason +function C_SpecializationInfo.CanPlayerUseTalentUI() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetActiveSpecGroup) +---@param isInspect? boolean +---@param isPet? boolean +---@return number groupIndex +function C_SpecializationInfo.GetActiveSpecGroup(isInspect, isPet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetAllSelectedPvpTalentIDs) +---@return number[] selectedPvpTalentIDs +function C_SpecializationInfo.GetAllSelectedPvpTalentIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetClassIDFromSpecID) +---@param specID number +---@return number? classID +function C_SpecializationInfo.GetClassIDFromSpecID(specID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetInspectSelectedPvpTalent) +---@param inspectedUnit UnitToken +---@param talentIndex number +---@return number? selectedTalentID +function C_SpecializationInfo.GetInspectSelectedPvpTalent(inspectedUnit, talentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetNumSpecializationsForClassID) +---@param classID number +---@return number specCount +function C_SpecializationInfo.GetNumSpecializationsForClassID(classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetPvpTalentAlertStatus) +---@return boolean hasUnspentSlot +---@return boolean hasNewTalent +function C_SpecializationInfo.GetPvpTalentAlertStatus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetPvpTalentInfo) +---@param talentID number +---@return PvpTalentInfo? talentInfo +function C_SpecializationInfo.GetPvpTalentInfo(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetPvpTalentSlotInfo) +---@param talentIndex number +---@return PvpTalentSlotInfo? slotInfo +function C_SpecializationInfo.GetPvpTalentSlotInfo(talentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetPvpTalentSlotUnlockLevel) +---@param talentIndex number +---@return number? requiredLevel +function C_SpecializationInfo.GetPvpTalentSlotUnlockLevel(talentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetPvpTalentUnlockLevel) +---@param talentID number +---@return number? requiredLevel +function C_SpecializationInfo.GetPvpTalentUnlockLevel(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecIDs) +---@param specSetID number +---@return number[] specIDs +function C_SpecializationInfo.GetSpecIDs(specSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecialization) +---@param isInspect? boolean +---@param isPet? boolean +---@param specGroupIndex? number +---@return number specializationIndex +function C_SpecializationInfo.GetSpecialization(isInspect, isPet, specGroupIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecializationInfo) +---@param specializationIndex number +---@param isInspect? boolean Default = false +---@param isPet? boolean Default = false +---@param inspectTarget? string +---@param sex? number +---@param groupIndex? number +---@param classID? number +---@return number? specId Default = 0 +---@return string? name +---@return string? description +---@return fileID? icon +---@return string? role +---@return number? primaryStat +---@return number? pointsSpent Default = 0 +---@return string? background +---@return number? previewPointsSpent Default = 0 +---@return boolean? isUnlocked Default = true +function C_SpecializationInfo.GetSpecializationInfo(specializationIndex, isInspect, isPet, inspectTarget, sex, groupIndex, classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecializationMasterySpells) +---@param specializationIndex number +---@param isInspect? boolean +---@param isPet? boolean +---@return number[] spellIDs +function C_SpecializationInfo.GetSpecializationMasterySpells(specializationIndex, isInspect, isPet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpellsDisplay) +---@param specializationID number +---@return number[] spellID +function C_SpecializationInfo.GetSpellsDisplay(specializationID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetTalentInfo) +---@param query TalentInfoQuery +---@return TalentInfoResult? result +function C_SpecializationInfo.GetTalentInfo(query) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.IsInitialized) +---@return boolean isSpecializationDataInitialized +function C_SpecializationInfo.IsInitialized() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.IsPvpTalentLocked) +---@param talentID number +---@return boolean locked +function C_SpecializationInfo.IsPvpTalentLocked(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.MatchesCurrentSpecSet) +---@param specSetID number +---@return boolean matches +function C_SpecializationInfo.MatchesCurrentSpecSet(specSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.SetPetSpecialization) +---@param specIndex number +---@param petNumber? number +function C_SpecializationInfo.SetPetSpecialization(specIndex, petNumber) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.SetPvpTalentLocked) +---@param talentID number +---@param locked boolean +function C_SpecializationInfo.SetPvpTalentLocked(talentID, locked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.SetSpecialization) +---@param specIndex number +---@return boolean success +function C_SpecializationInfo.SetSpecialization(specIndex) end + +---@class PvpTalentInfo +---@field talentID number +---@field name string +---@field icon number +---@field selected boolean +---@field available boolean +---@field spellID number +---@field unlocked boolean +---@field known boolean +---@field grantedByAura boolean +---@field dependenciesUnmet boolean +---@field dependenciesUnmetReason string? + +---@class PvpTalentSlotInfo +---@field enabled boolean +---@field level number +---@field selectedTalentID number? +---@field availableTalentIDs number[] + +---@class SpecializationInfoOutput +---@field specId number? Default = 0 +---@field name string? +---@field description string? +---@field icon fileID? +---@field role string? +---@field primaryStat number? +---@field pointsSpent number? Default = 0 +---@field background string? +---@field previewPointsSpent number? Default = 0 +---@field isUnlocked boolean? Default = true + +---@class SpecializationInfoQuery +---@field specializationIndex number +---@field isInspect boolean? Default = false +---@field isPet boolean? Default = false +---@field inspectTarget string? +---@field sex number? +---@field groupIndex number? +---@field classID number? + +---@class TalentInfoQuery +---@field groupIndex number? +---@field isInspect boolean? Default = false +---@field tier number? +---@field column number? +---@field target UnitToken? +---@field specializationIndex number? +---@field talentIndex number? +---@field isPet boolean? Default = false + +---@class TalentInfoResult +---@field talentID number? Default = 0 +---@field name string +---@field icon fileID +---@field tier number +---@field column number +---@field selected boolean? Default = false +---@field available boolean? Default = false +---@field spellID number? Default = 0 +---@field isPVPTalentUnlocked boolean? Default = false +---@field known boolean? Default = false +---@field grantedByAura boolean? Default = false +---@field rank number +---@field maxRank number +---@field meetsPrereq boolean? Default = false +---@field previewRank number +---@field meetsPreviewPrereq boolean? Default = false +---@field isExceptional boolean? Default = false +---@field hasGoldBorder boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua new file mode 100644 index 0000000..333cfe6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua @@ -0,0 +1,50 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationInfoForClassID) +---@param classID number +---@param index number +---@param gender? Enum.UnitSex +---@return number id +---@return string name +---@return string description +---@return fileID icon +---@return string role +---@return boolean recommended +---@return boolean allowedForBoost +---@return number? masterySpell1 +---@return number? masterySpell2 +function GetSpecializationInfoForClassID(classID, index, gender) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationInfoForSpecID) +---@param specID number +---@param gender? Enum.UnitSex +---@return number id +---@return string name +---@return string description +---@return fileID icon +---@return string role +---@return boolean recommended +---@return boolean allowedForBoost +---@return number? masterySpell1 +---@return number? masterySpell2 +function GetSpecializationInfoForSpecID(specID, gender) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationNameForSpecID) +---@param specID number +---@param gender? Enum.UnitSex +---@return string? name +function GetSpecializationNameForSpecID(specID, gender) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasLootSpecializations) +---@return boolean hasLootSpecializations +function HasLootSpecializations() end + +---@class SpecializationInfoResult +---@field id number +---@field name string +---@field description string +---@field icon fileID +---@field role string +---@field recommended boolean +---@field allowedForBoost boolean +---@field masterySpell1 number? +---@field masterySpell2 number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua new file mode 100644 index 0000000..2c1dbf5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +C_SpellActivationOverlay = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellActivationOverlay.IsSpellOverlayed) +---@param spellID number +---@return boolean isSpellOverlayed +function C_SpellActivationOverlay.IsSpellOverlayed(spellID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua new file mode 100644 index 0000000..431e417 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua @@ -0,0 +1,360 @@ +---@meta _ +C_SpellBook = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.CastSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@param targetSelf? boolean Default = false +function C_SpellBook.CastSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank, targetSelf) end + +---Returns true if player knows any Disenchant spells +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.ContainsAnyDisenchantSpell) +---@return boolean contains +function C_SpellBook.ContainsAnyDisenchantSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.FindBaseSpellByID) +---@param spellID number +---@return number? baseSpellID +function C_SpellBook.FindBaseSpellByID(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.FindFlyoutSlotBySpellID) +---@param spellID number +---@return number flyoutSlot +function C_SpellBook.FindFlyoutSlotBySpellID(spellID) end + +---If found, returns the first slot position of a SpellBookItem matching the specified spell and criteria +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.FindSpellBookSlotForSpell) +---@param spellIdentifier SpellIdentifier +---@param includeHidden? boolean Default = false +---@param includeFlyouts? boolean Default = true +---@param includeFutureSpells? boolean Default = false +---@param includeOffSpec? boolean Default = false +---@return number spellBookItemSlotIndex +---@return Enum.SpellBookSpellBank spellBookItemSpellBank +function C_SpellBook.FindSpellBookSlotForSpell(spellIdentifier, includeHidden, includeFlyouts, includeFutureSpells, includeOffSpec) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.FindSpellOverrideByID) +---@param spellID number +---@return number? overrideSpellID +function C_SpellBook.FindSpellOverrideByID(spellID) end + +---Returns general, class, and active spec spells that are learned at the specified level +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetCurrentLevelSpells) +---@param level number +---@return number[] spellIDs +function C_SpellBook.GetCurrentLevelSpells(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetNumSpellBookSkillLines) +---@return number numSpellBookSkillLines +function C_SpellBook.GetNumSpellBookSkillLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSkillLineIndexByID) +---@param skillLineID number +---@return number? skillIndex +function C_SpellBook.GetSkillLineIndexByID(skillLineID) end + +---Returns nothing if item doesn't exist or isn't a spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemAutoCast) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean autoCastAllowed +---@return boolean autoCastEnabled +function C_SpellBook.GetSpellBookItemAutoCast(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns number of times a SpellBookItem can be cast, typically based on availability of things like required reagent items; Always returns 0 if item is not found or is not a spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemCastCount) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return number castCount +function C_SpellBook.GetSpellBookItemCastCount(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns a duration object describing the active recharge time for a spellbook item. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemChargeDuration) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return LuaDurationObject duration +function C_SpellBook.GetSpellBookItemChargeDuration(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns a table of info about the charges of a charge-accumulating SpellBookItem; May return nil if item is not found or is not charge-based +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemCharges) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return SpellChargeInfo chargeInfo +function C_SpellBook.GetSpellBookItemCharges(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns nil if item doesn't exist or if this kind of item doesn't display cooldowns (ex: future or offspec spells) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemCooldown) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return SpellCooldownInfo spellCooldownInfo +function C_SpellBook.GetSpellBookItemCooldown(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns a duration object describing the active cooldown duration for a spellbook item. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemCooldownDuration) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@param ignoreGCD? boolean Default = false +---@return LuaDurationObject duration +function C_SpellBook.GetSpellBookItemCooldownDuration(spellBookItemSlotIndex, spellBookItemSpellBank, ignoreGCD) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemDescription) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return string description +function C_SpellBook.GetSpellBookItemDescription(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemInfo) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return SpellBookItemInfo spellBookItemInfo +function C_SpellBook.GetSpellBookItemInfo(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns the level the spell is learned at; May return a different value if the player is currently Level Linked with another player; Returns 0 if item is not a Spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemLevelLearned) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return number levelLearned +function C_SpellBook.GetSpellBookItemLevelLearned(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemLink) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@param glyphID? number +---@return string spellLink +function C_SpellBook.GetSpellBookItemLink(spellBookItemSlotIndex, spellBookItemSpellBank, glyphID) end + +---Returns a duration object describing the active loss of control cooldown duration for a spellbook item. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemLossOfControlCooldownDuration) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return LuaDurationObject duration +function C_SpellBook.GetSpellBookItemLossOfControlCooldownDuration(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns nil if item doesn't exist or if this kind of item doesn't display cooldowns (ex: future or offspec spells) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemLossOfControlCooldownInfo) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return SpellLossOfControlInfo lossOfControlInfo +function C_SpellBook.GetSpellBookItemLossOfControlCooldownInfo(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemName) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return string name +---@return string subName +function C_SpellBook.GetSpellBookItemName(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns a table containing one or more SpellPowerCostInfos, one for each power type a SpellBookItem costs; May return nil if item is not found or has no resource costs +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemPowerCost) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return SpellPowerCostInfo[] powerCosts +function C_SpellBook.GetSpellBookItemPowerCost(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Get the index of the SkillLine this SpellBookItem is part of +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemSkillLineIndex) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return number? skillLineIndex +function C_SpellBook.GetSpellBookItemSkillLineIndex(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemTexture) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return fileID iconID +function C_SpellBook.GetSpellBookItemTexture(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns nil if SpellBookItem is not associated with a trade skill +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemTradeSkillLink) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return string spellLink +function C_SpellBook.GetSpellBookItemTradeSkillLink(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookItemType) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return Enum.SpellBookItemType itemType +---@return number actionID +---@return number? spellID +function C_SpellBook.GetSpellBookItemType(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.GetSpellBookSkillLineInfo) +---@param skillLineIndex number +---@return SpellBookSkillLineInfo skillLineInfo +function C_SpellBook.GetSpellBookSkillLineInfo(skillLineIndex) end + +---Returns nothing if player has no pet spells +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.HasPetSpells) +---@return number numPetSpells +---@return string petNameToken +function C_SpellBook.HasPetSpells() end + +---Returns true if the SpellBookItem is the player's melee Auto Attack spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsAutoAttackSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isAutoAttack +function C_SpellBook.IsAutoAttackSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the SpellBookItem comes from a Class Talent +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsClassTalentSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isClassTalent +function C_SpellBook.IsClassTalentSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the SpellBookItem comes from a PvP Talent +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsPvPTalentSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isPvPTalent +function C_SpellBook.IsPvPTalentSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the SpellBookItem is the player's ranged Auto Attack spell (ex: Shoot, Auto Shot, etc) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsRangedAutoAttackSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isRangedAutoAttack +function C_SpellBook.IsRangedAutoAttackSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the SpellBookIem can be cast on hostile targets +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellBookItemHarmful) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isHarmful +function C_SpellBook.IsSpellBookItemHarmful(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the SpellBookIem can be cast on the player or other friendly targets +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellBookItemHelpful) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isHelpful +function C_SpellBook.IsSpellBookItemHelpful(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the current target is within range of the SpellBookIem; False if out of range; Nil if range check was invalid +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellBookItemInRange) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@param targetUnit? UnitToken +---@return boolean? inRange +function C_SpellBook.IsSpellBookItemInRange(spellBookItemSlotIndex, spellBookItemSpellBank, targetUnit) end + +---Returns true if the SpellBookItem belongs to a non-active class specialization +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellBookItemOffSpec) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isOffSpec +function C_SpellBook.IsSpellBookItemOffSpec(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if the SpellBookItem is a passive spell; Will always return false if it is not a spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellBookItemPassive) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isPassive +function C_SpellBook.IsSpellBookItemPassive(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns whether the SpellBookIem is currently castable; Typically based on things like learned status, required resources, etc +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellBookItemUsable) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean isUsable +---@return boolean insufficientPower +function C_SpellBook.IsSpellBookItemUsable(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---Returns true if a spell should be found in the spellbook. This function can also return true for spells that aren't known, such as override spells granted by an aura linked to class talents +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellInSpellBook) +---@param spellID number +---@param spellBank? Enum.SpellBookSpellBank Default = Player +---@param includeOverrides? boolean Default = true +---@return boolean isInSpellBook +function C_SpellBook.IsSpellInSpellBook(spellID, spellBank, includeOverrides) end + +---Returns true if a player knows a spell. This function can also return true for spells that aren't in the spellbook, such as temporarily-granted abilities +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellKnown) +---@param spellID number +---@param spellBank? Enum.SpellBookSpellBank Default = Player +---@return boolean isKnown +function C_SpellBook.IsSpellKnown(spellID, spellBank) end + +---Returns true if a spell is considered to be known or present in the spellbook +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellKnownOrInSpellBook) +---@param spellID number +---@param spellBank? Enum.SpellBookSpellBank Default = Player +---@param includeOverrides? boolean Default = true +---@return boolean isKnownOrInSpellBook +function C_SpellBook.IsSpellKnownOrInSpellBook(spellID, spellBank, includeOverrides) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.PickupSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +function C_SpellBook.PickupSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.SetSpellBookItemAutoCastEnabled) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@param enabled boolean +function C_SpellBook.SetSpellBookItemAutoCastEnabled(spellBookItemSlotIndex, spellBookItemSpellBank, enabled) end + +---Returns true if the SpellBookIem has a min and/or max range greater than 0; Will always return false if it is not a spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.SpellBookItemHasRange) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return boolean hasRange +function C_SpellBook.SpellBookItemHasRange(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellBook.ToggleSpellBookItemAutoCast) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +function C_SpellBook.ToggleSpellBookItemAutoCast(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---@class SpellBookItemInfo +---@field actionID number +---@field spellID number? +---@field itemType Enum.SpellBookItemType +---@field name string +---@field subName string +---@field iconID fileID +---@field isPassive boolean +---@field isOffSpec boolean +---@field skillLineIndex number? + +---@class SpellBookSkillLineInfo +---@field name string +---@field iconID fileID +---@field itemIndexOffset number +---@field numSpellBookItems number +---@field isGuild boolean +---@field shouldHide boolean +---@field specID number? +---@field offSpecID number? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua new file mode 100644 index 0000000..5186f29 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua @@ -0,0 +1,34 @@ +---@meta _ +C_SpellDiminish = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellDiminish.GetAllSpellDiminishCategories) +---@param ruleset? Enum.SpellDiminishRuleset +---@return SpellDiminishCategoryInfo[] categories +function C_SpellDiminish.GetAllSpellDiminishCategories(ruleset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellDiminish.GetSpellDiminishCategoryInfo) +---@param category Enum.SpellDiminishCategory +---@return SpellDiminishCategoryInfo? categoryInfo +function C_SpellDiminish.GetSpellDiminishCategoryInfo(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellDiminish.IsSystemSupported) +---@return boolean isSystemSupported +function C_SpellDiminish.IsSystemSupported() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpellDiminish.ShouldTrackSpellDiminishCategory) +---@param category Enum.SpellDiminishCategory +---@param ruleset Enum.SpellDiminishRuleset +---@return boolean isTracked +function C_SpellDiminish.ShouldTrackSpellDiminishCategory(category, ruleset) end + +---@class SpellDiminishCategoryInfo +---@field category Enum.SpellDiminishCategory +---@field name string +---@field icon fileID? + +---@class SpellDiminishTrackerInfo +---@field category Enum.SpellDiminishCategory +---@field startTime number +---@field duration number +---@field showCountdown boolean +---@field isImmune boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua new file mode 100644 index 0000000..ff539ef --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua @@ -0,0 +1,424 @@ +---@meta _ +C_Spell = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.CancelSpellByID) +---@param spellID number +function C_Spell.CancelSpellByID(spellID) end + +---Returns true if the spell exists, regardless of whether the player has learned it +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.DoesSpellExist) +---@param spellIdentifier SpellIdentifier +---@return boolean spellExists +function C_Spell.DoesSpellExist(spellIdentifier) end + +---Used in conjunction with SpellRangeCheckUpdate to inform the UI when a spell goes in or out of range with the current target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.EnableSpellRangeCheck) +---@param spellIdentifier SpellIdentifier +---@param enable boolean +function C_Spell.EnableSpellRangeCheck(spellIdentifier, enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetAuraStatChanges) +---@param spellID number +---@return number healthChange +---@return PowerTypeChange[] powerTypeChanges +function C_Spell.GetAuraStatChanges(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetBaseSpell) +---@param spellIdentifier SpellIdentifier +---@param spec? number Default = 0 +---@return number baseSpellID +function C_Spell.GetBaseSpell(spellIdentifier, spec) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetDeadlyDebuffInfo) +---@param spellIdentifier SpellIdentifier +---@return DeadlyDebuffInfo deadlyDebuffInfo +function C_Spell.GetDeadlyDebuffInfo(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetItemModifiedAppearancesApplied) +---@param spellID number +---@return number[] itemModifiedAppearanceIDs +function C_Spell.GetItemModifiedAppearancesApplied(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetMawPowerBorderAtlasBySpellID) +---@param spellID SpellIdentifier +---@return textureAtlas rarityBorderAtlas +function C_Spell.GetMawPowerBorderAtlasBySpellID(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetMawPowerLinkBySpellID) +---@param spellID SpellIdentifier +---@return string link +function C_Spell.GetMawPowerLinkBySpellID(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetOverrideSpell) +---@param spellIdentifier SpellIdentifier +---@param spec? number Default = 0 +---@param onlyKnown? boolean Default = true +---@param ignoreOverrideSpellID? number Default = 0 +---@return number overrideSpellID +function C_Spell.GetOverrideSpell(spellIdentifier, spec, onlyKnown, ignoreOverrideSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSchoolString) +---@param schoolMask number +---@return string result +function C_Spell.GetSchoolString(schoolMask) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellAutoCast) +---@param spellIdentifier SpellIdentifier +---@return boolean autoCastAllowed +---@return boolean autoCastEnabled +function C_Spell.GetSpellAutoCast(spellIdentifier) end + +---Returns number of times a spell can be cast, typically based on availability of things like required reagent items; Returns 0 if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellCastCount) +---@param spellIdentifier SpellIdentifier +---@return number castCount +function C_Spell.GetSpellCastCount(spellIdentifier) end + +---Returns a duration object describing the active recharge time for a spell. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellChargeDuration) +---@param spellIdentifier SpellIdentifier +---@return LuaDurationObject duration +function C_Spell.GetSpellChargeDuration(spellIdentifier) end + +---Returns a table of info about the charges of a charge-accumulating spell; May return nil if spell is not found or is not charge-based +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellCharges) +---@param spellIdentifier SpellIdentifier +---@return SpellChargeInfo chargeInfo +function C_Spell.GetSpellCharges(spellIdentifier) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellCooldown) +---@param spellIdentifier SpellIdentifier +---@return SpellCooldownInfo spellCooldownInfo +function C_Spell.GetSpellCooldown(spellIdentifier) end + +---Returns a duration object describing the active cooldown duration for a spell. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellCooldownDuration) +---@param spellIdentifier SpellIdentifier +---@param ignoreGCD? boolean Default = false +---@return LuaDurationObject duration +function C_Spell.GetSpellCooldownDuration(spellIdentifier, ignoreGCD) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellDescription) +---@param spellIdentifier SpellIdentifier +---@return string description +function C_Spell.GetSpellDescription(spellIdentifier) end + +---Depending on the spell, return a string that is either the use count or number of charges. If value is beyond the display count parameter, returns the replacementString (defaults to '*'). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellDisplayCount) +---@param spellIdentifier SpellIdentifier +---@param maxDisplayCount? number Default = 9999 +---@param replacementString? string Default = * +---@return string displayCount +function C_Spell.GetSpellDisplayCount(spellIdentifier, maxDisplayCount, replacementString) end + +---Meant primarily for getting a spell id from a spell name or link; Returns nothing if spell does not exist +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellIDForSpellIdentifier) +---@param spellIdentifier SpellIdentifier +---@return number spellID +function C_Spell.GetSpellIDForSpellIdentifier(spellIdentifier) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellInfo) +---@param spellIdentifier SpellIdentifier +---@return SpellInfo spellInfo +function C_Spell.GetSpellInfo(spellIdentifier) end + +---Returns the level the spell is learned at; May return a different value if the player is currently Level Linked with another player +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellLevelLearned) +---@param spellIdentifier SpellIdentifier +---@return number levelLearned +function C_Spell.GetSpellLevelLearned(spellIdentifier) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellLink) +---@param spellIdentifier SpellIdentifier +---@param glyphID? number +---@return string spellLink +function C_Spell.GetSpellLink(spellIdentifier, glyphID) end + +---Returns a duration object describing the active loss of control cooldown duration for a spell. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellLossOfControlCooldownDuration) +---@param spellIdentifier SpellIdentifier +---@return LuaDurationObject duration +function C_Spell.GetSpellLossOfControlCooldownDuration(spellIdentifier) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellLossOfControlCooldownInfo) +---@param spellIdentifier SpellIdentifier +---@return SpellLossOfControlInfo lossOfControlInfo +function C_Spell.GetSpellLossOfControlCooldownInfo(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellMaxCumulativeAuraApplications) +---@param spellID SpellIdentifier +---@return number cumulativeAura +function C_Spell.GetSpellMaxCumulativeAuraApplications(spellID) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellName) +---@param spellIdentifier SpellIdentifier +---@return string name +function C_Spell.GetSpellName(spellIdentifier) end + +---Returns a table containing one or more SpellPowerCostInfos, one for each power type this spell costs; May return nil if spell is not found or has no resource costs +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellPowerCost) +---@param spellIdentifier SpellIdentifier +---@return SpellPowerCostInfo[] powerCosts +function C_Spell.GetSpellPowerCost(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellQueueWindow) +---@return number result +function C_Spell.GetSpellQueueWindow() end + +---Returns the rank of a spell that corresponds to an ability within a ranked SkillLine (ex: a crafting Recipe); Returns nil if spell is not found, or isn't part of a ranked SkillLine +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellSkillLineAbilityRank) +---@param spellIdentifier SpellIdentifier +---@return number rank +function C_Spell.GetSpellSkillLineAbilityRank(spellIdentifier) end + +---Returns nil if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellSubtext) +---@param spellIdentifier SpellIdentifier +---@return string subtext +function C_Spell.GetSpellSubtext(spellIdentifier) end + +---Returns nothing if spell is not found +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellTexture) +---@param spellIdentifier SpellIdentifier +---@return fileID iconID +---@return fileID originalIconID +function C_Spell.GetSpellTexture(spellIdentifier) end + +---Returns nil if spell is not associated with a trade skill +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellTradeSkillLink) +---@param spellIdentifier SpellIdentifier +---@return string spellLink +function C_Spell.GetSpellTradeSkillLink(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.GetVisibilityInfo) +---@param spellID number +---@param visibilityType Enum.SpellAuraVisibilityType +---@return boolean hasCustom +---@return boolean alwaysShowMine +---@return boolean showForMySpec +function C_Spell.GetVisibilityInfo(spellID, visibilityType) end + +---Returns true if the spell is the player's melee Auto Attack spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsAutoAttackSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isAutoAttack +function C_Spell.IsAutoAttackSpell(spellIdentifier) end + +---Returns true if the spell is an auto repeat player spell +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsAutoRepeatSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isAutoRepeat +function C_Spell.IsAutoRepeatSpell(spellIdentifier) end + +---Returns true if the spell comes from a Class Talent +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsClassTalentSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isAutoRepeat +function C_Spell.IsClassTalentSpell(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsConsumableSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean consumable +function C_Spell.IsConsumableSpell(spellIdentifier) end + +---Returns true if the spell is currently being cast or is queued to be cast +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsCurrentSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isCurrentSpell +function C_Spell.IsCurrentSpell(spellIdentifier) end + +---Returns true if an aura is considered an external defensive. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsExternalDefensive) +---@param spellID number +---@return boolean isExternalDefensive +function C_Spell.IsExternalDefensive(spellID) end + +---Returns true if the spell is an 'empower' type spell that is cast by pressing and holding, with the on-release cast typically being affected by time held +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsPressHoldReleaseSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isPressHoldRelease +function C_Spell.IsPressHoldReleaseSpell(spellIdentifier) end + +---Returns true if an aura is considered high priority and should be ordered ahead of other auras in the UI. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsPriorityAura) +---@param spellID number +---@return boolean isHighPriority +function C_Spell.IsPriorityAura(spellID) end + +---Returns true if the spell comes from a PvP Talent +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsPvPTalentSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isAutoRepeat +function C_Spell.IsPvPTalentSpell(spellIdentifier) end + +---Returns true if the spell is the player's ranged Auto Attack spell (ex: Shoot, Auto Shot, etc) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsRangedAutoAttackSpell) +---@param spellIdentifier SpellIdentifier +---@return boolean isRangedAutoAttack +function C_Spell.IsRangedAutoAttackSpell(spellIdentifier) end + +---Returns true if an aura only applies effects to the player, and no other units. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSelfBuff) +---@param spellID number +---@return boolean hasSelfEffectsOnly +function C_Spell.IsSelfBuff(spellID) end + +---Returns true if the spell causes a crowd control effect when cast on a valid target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellCrowdControl) +---@param spellIdentifier SpellIdentifier +---@return boolean isCrowdControl +function C_Spell.IsSpellCrowdControl(spellIdentifier) end + +---Returns true if data for the spell has already been loaded and cached this session +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellDataCached) +---@param spellIdentifier SpellIdentifier +---@return boolean isCached +function C_Spell.IsSpellDataCached(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellDisabled) +---@param spellIdentifier SpellIdentifier +---@return boolean disabled +function C_Spell.IsSpellDisabled(spellIdentifier) end + +---Returns true if the spell can be cast on hostile targets +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellHarmful) +---@param spellIdentifier SpellIdentifier +---@return boolean isHarmful +function C_Spell.IsSpellHarmful(spellIdentifier) end + +---Returns true if the spell can be cast on the player or other friendly targets +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellHelpful) +---@param spellIdentifier SpellIdentifier +---@return boolean isHelpful +function C_Spell.IsSpellHelpful(spellIdentifier) end + +---Returns true if the spell is considered important. For example a spell that's lethal if not interrupted would be considered important. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellImportant) +---@param spellIdentifier SpellIdentifier +---@return boolean isImportant +function C_Spell.IsSpellImportant(spellIdentifier) end + +---Returns true if the current target is within range of the spell; False if out of range; Nil if range check was invalid +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellInRange) +---@param spellIdentifier SpellIdentifier +---@param targetUnit? UnitToken +---@return boolean? inRange +function C_Spell.IsSpellInRange(spellIdentifier, targetUnit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellPassive) +---@param spellIdentifier SpellIdentifier +---@return boolean isPassive +function C_Spell.IsSpellPassive(spellIdentifier) end + +---Returns whether the spell is currently castable; Typically based on things like learned status, required resources, etc +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.IsSpellUsable) +---@param spellIdentifier SpellIdentifier +---@return boolean isUsable +---@return boolean insufficientPower +function C_Spell.IsSpellUsable(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.PickupSpell) +---@param spellIdentifier SpellIdentifier +function C_Spell.PickupSpell(spellIdentifier) end + +---Requests data for the spell be loaded; Listen for SPELL_DATA_LOAD_RESULT to be notified when load is finished +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.RequestLoadSpellData) +---@param spellIdentifier SpellIdentifier +function C_Spell.RequestLoadSpellData(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.SetSpellAutoCastEnabled) +---@param spellIdentifier SpellIdentifier +---@param enabled boolean +function C_Spell.SetSpellAutoCastEnabled(spellIdentifier, enabled) end + +---Returns true if the spell has a min and/or max range greater than 0 +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.SpellHasRange) +---@param spellIdentifier SpellIdentifier +---@return boolean hasRange +function C_Spell.SpellHasRange(spellIdentifier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.TargetSpellIsEnchanting) +---@return boolean isEnchanting +function C_Spell.TargetSpellIsEnchanting() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.TargetSpellJumpsUpgradeTrack) +---@return boolean jumpsUpgradeTrack +function C_Spell.TargetSpellJumpsUpgradeTrack() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.TargetSpellReplacesBonusTree) +---@return boolean result +function C_Spell.TargetSpellReplacesBonusTree() end + +---Toggles whether spell's autoCast is enabled +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Spell.ToggleSpellAutoCast) +---@param spellIdentifier SpellIdentifier +function C_Spell.ToggleSpellAutoCast(spellIdentifier) end + +---@class DeadlyDebuffInfo +---@field criticalTimeRemainingMs number? +---@field criticalStacks number? +---@field priority number +---@field warningText string +---@field soundKitID number? + +---@class PowerTypeChange +---@field powerType Enum.PowerType +---@field amount number + +---@class SpellInfo +---@field name string +---@field iconID fileID +---@field originalIconID fileID +---@field castTime number +---@field minRange number +---@field maxRange number +---@field spellID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua new file mode 100644 index 0000000..5683716 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua @@ -0,0 +1,35 @@ +---@meta _ +---@class SpellChargeInfo +---@field currentCharges number +---@field maxCharges number +---@field cooldownStartTime number +---@field cooldownDuration number +---@field chargeModRate number +---@field isActive boolean + +---@class SpellCooldownInfo +---@field startTime number +---@field duration number +---@field isEnabled boolean +---@field isActive boolean +---@field modRate number +---@field activeCategory number? +---@field timeUntilEndOfStartRecovery number? +---@field isOnGCD boolean? + +---@class SpellLossOfControlInfo +---@field startTime number +---@field duration number +---@field modRate number +---@field isActive boolean +---@field shouldReplaceNormalCooldown boolean + +---@class SpellPowerCostInfo +---@field type Enum.PowerType +---@field name string +---@field cost number +---@field minCost number +---@field costPercent number +---@field costPerSec number +---@field requiredAuraID number +---@field hasRequiredAura boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua new file mode 100644 index 0000000..58408e2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua @@ -0,0 +1,37 @@ +---@meta _ +C_SplashScreen = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SplashScreen.AcknowledgeSplash) +function C_SplashScreen.AcknowledgeSplash() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SplashScreen.CanViewSplashScreen) +---@return boolean canView +function C_SplashScreen.CanViewSplashScreen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SplashScreen.RequestLatestSplashScreen) +---@param fromGameMenu boolean +function C_SplashScreen.RequestLatestSplashScreen(fromGameMenu) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SplashScreen.SendSplashScreenActionLaunchedTelem) +function C_SplashScreen.SendSplashScreenActionLaunchedTelem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SplashScreen.SendSplashScreenCloseTelem) +function C_SplashScreen.SendSplashScreenCloseTelem() end + +---@class SplashScreenInfo +---@field textureKit textureKit +---@field minDisplayCharLevel number +---@field minQuestDisplayLevel number +---@field soundKitID number +---@field allianceQuestID number? +---@field hordeQuestID number? +---@field header string +---@field topLeftFeatureTitle string +---@field topLeftFeatureDesc string +---@field bottomLeftFeatureTitle string +---@field bottomLeftFeatureDesc string +---@field rightFeatureTitle string +---@field rightFeatureDesc string +---@field shouldShowQuest boolean +---@field screenType Enum.SplashScreenType +---@field gameMenuRequest boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua new file mode 100644 index 0000000..ae96f82 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua @@ -0,0 +1,85 @@ +---@meta _ +C_StableInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.ClosePetStables) +function C_StableInfo.ClosePetStables() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetActivePetList) +---@return PetInfo[] activePets +function C_StableInfo.GetActivePetList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetAvailablePetSpecInfos) +---@return PetSpecInfo[] petSpecInfos +function C_StableInfo.GetAvailablePetSpecInfos() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetNumActivePets) +---@return number numActivePets +function C_StableInfo.GetNumActivePets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetNumStablePets) +---@return number numStablePets +function C_StableInfo.GetNumStablePets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetStablePetFoodTypes) +---@param index number +---@return string[] foodTypes +function C_StableInfo.GetStablePetFoodTypes(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetStablePetInfo) +---@param index number +---@return PetInfo? petInfo +function C_StableInfo.GetStablePetInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.GetStabledPetList) +---@return PetInfo[] stabledPets +function C_StableInfo.GetStabledPetList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.IsAtStableMaster) +---@return boolean isAtStableMaster +function C_StableInfo.IsAtStableMaster() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.IsBonusPetSlotAvailable) +---@return boolean isAvailable +function C_StableInfo.IsBonusPetSlotAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.IsPetFavorite) +---@param slot number +---@return boolean isFavorite +function C_StableInfo.IsPetFavorite(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.PickupStablePet) +---@param index number +function C_StableInfo.PickupStablePet(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.SetPetFavorite) +---@param slot number +---@param isFavorite boolean +function C_StableInfo.SetPetFavorite(slot, isFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StableInfo.SetPetSlot) +---@param index number +---@param slot number +function C_StableInfo.SetPetSlot(index, slot) end + +---@class PetInfo +---@field slotID number +---@field icon fileID +---@field name string +---@field level number +---@field familyName string +---@field specialization string +---@field type string +---@field petAbilities number[] +---@field specAbilities number[] +---@field displayID number +---@field isFavorite boolean +---@field isExotic boolean +---@field uiModelSceneID number? Default = 718 +---@field petNumber number +---@field creatureID number +---@field specID number + +---@class PetSpecInfo +---@field specID number +---@field specIndex number +---@field specializationName string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua new file mode 100644 index 0000000..7826706 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua @@ -0,0 +1,16 @@ +---@meta _ +C_StorePublic = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StorePublic.DoesGroupHavePurchaseableProducts) +---@param groupID number +---@return boolean hasPurchaseableProducts +function C_StorePublic.DoesGroupHavePurchaseableProducts(groupID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StorePublic.EventStoreUISetShown) +---@param newShown boolean +---@param contextKey? string +function C_StorePublic.EventStoreUISetShown(newShown, contextKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StorePublic.IsEnabled) +---@return boolean enabled +function C_StorePublic.IsEnabled() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua new file mode 100644 index 0000000..6213b91 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua @@ -0,0 +1,16 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvailableBandwidth) +---@return number result +function GetAvailableBandwidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBackgroundLoadingStatus) +---@return number result +function GetBackgroundLoadingStatus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDownloadedPercentage) +---@return number result +function GetDownloadedPercentage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFileStreamingStatus) +---@return number result +function GetFileStreamingStatus() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua new file mode 100644 index 0000000..c7b1506 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua @@ -0,0 +1,105 @@ +---@meta _ +C_StringUtil = {} + +---Creates a numeric formatter that converts numbers to abbreviated strings, eg. 123456 -> '123k'. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.CreateAbbreviatedNumberFormatter) +---@return AbbreviatedNumberFormatter formatter +function C_StringUtil.CreateAbbreviatedNumberFormatter() end + +---Creates a numeric formatter that converts numbers to strings with flexible rulesets. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.CreateNumericRuleFormatter) +---@return NumericRuleFormatter formatter +function C_StringUtil.CreateNumericRuleFormatter() end + +---Creates a numeric formatter that converts numbers measuring durations in seconds to strings, eg. 93 -> '1m 33s'. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.CreateSecondsFormatter) +---@return SecondsFormatter formatter +function C_StringUtil.CreateSecondsFormatter() end + +---Returns a string with Lua format string tokens ('%') escaped. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.EscapeLuaFormatString) +---@param text string +---@return stringView escapedText +function C_StringUtil.EscapeLuaFormatString(text) end + +---Returns a string with all Lua pattern characters escaped. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.EscapeLuaPatterns) +---@param text stringView +---@return string escapedText +function C_StringUtil.EscapeLuaPatterns(text) end + +---Returns a string with all quoted code sequences ('|' characters) escaped. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.EscapeQuotedCodes) +---@param text string +---@return stringView escaped +function C_StringUtil.EscapeQuotedCodes(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.FloorToNearestString) +---@param number number +---@return string text +function C_StringUtil.FloorToNearestString(number) end + +---Returns a string with all contiguous occurrences of ASCII space characters truncated. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.RemoveContiguousSpaces) +---@param text stringView +---@param maxAllowedSpaces number +---@return string trimmedText +function C_StringUtil.RemoveContiguousSpaces(text, maxAllowedSpaces) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.RoundToNearestString) +---@param number number +---@return string text +function C_StringUtil.RoundToNearestString(number) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.StripHyperlinks) +---@param text string +---@param maintainColor? boolean Default = false +---@param maintainBrackets? boolean Default = false +---@param stripNewlines? boolean Default = false +---@param maintainAtlases? boolean Default = false +---@param maintainTextures? boolean Default = false +---@return stringView stripped +function C_StringUtil.StripHyperlinks(text, maintainColor, maintainBrackets, stripNewlines, maintainAtlases, maintainTextures) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.StripTextureMarkupForLooseFiles) +---@param text string +---@return stringView stripped +function C_StringUtil.StripTextureMarkupForLooseFiles(text) end + +---Returns a string with all bytes in the 'characters' set removed from the start and end. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.trim) +---@param str stringView +---@param characters? stringView Default = \r\n\t +---@return stringView trimmed +function C_StringUtil.trim(str, characters) end + +---Formats the given number to a string as an integer (rounding down). If the integer is zero, returns an empty string. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.TruncateWhenZero) +---@param number number +---@return string text +function C_StringUtil.TruncateWhenZero(number) end + +---Returns a string with 'prefix' and 'suffix' joined to 'infix' iif 'infix' is not an empty string. Else, an empty string is returned. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.WrapString) +---@param infix stringView +---@param prefix? stringView +---@param suffix? stringView +---@return string text +function C_StringUtil.WrapString(infix, prefix, suffix) end + +---@class StripHyperlinkOptions +---@field maintainColor boolean? Default = false +---@field maintainBrackets boolean? Default = false +---@field stripNewlines boolean? Default = false +---@field maintainAtlases boolean? Default = false +---@field maintainTextures boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua new file mode 100644 index 0000000..4f5892c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua @@ -0,0 +1,28 @@ +---@meta _ +C_SummonInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.CancelSummon) +function C_SummonInfo.CancelSummon() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.ConfirmSummon) +function C_SummonInfo.ConfirmSummon() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.GetSummonConfirmAreaName) +---@return string areaName +function C_SummonInfo.GetSummonConfirmAreaName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.GetSummonConfirmSummoner) +---@return string? summoner +function C_SummonInfo.GetSummonConfirmSummoner() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.GetSummonConfirmTimeLeft) +---@return number timeLeft +function C_SummonInfo.GetSummonConfirmTimeLeft() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.GetSummonReason) +---@return number summonReason +function C_SummonInfo.GetSummonReason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SummonInfo.IsSummonSkippingStartExperience) +---@return boolean isSummonSkippingStartExperience +function C_SummonInfo.IsSummonSkippingStartExperience() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua new file mode 100644 index 0000000..6997aba --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua @@ -0,0 +1,91 @@ +---@meta _ +C_SuperTrack = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.ClearAllSuperTracked) +function C_SuperTrack.ClearAllSuperTracked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.ClearSuperTrackedContent) +function C_SuperTrack.ClearSuperTrackedContent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.ClearSuperTrackedMapPin) +function C_SuperTrack.ClearSuperTrackedMapPin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetHighestPrioritySuperTrackingType) +---@return Enum.SuperTrackingType? type +function C_SuperTrack.GetHighestPrioritySuperTrackingType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetNextWaypointForMap) +---@param uiMapID number +---@return number x +---@return number y +---@return string waypointDescription +function C_SuperTrack.GetNextWaypointForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetSuperTrackedContent) +---@return Enum.ContentTrackingType trackableType +---@return number trackableID +function C_SuperTrack.GetSuperTrackedContent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetSuperTrackedItemName) +---@return string name +---@return string description +function C_SuperTrack.GetSuperTrackedItemName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetSuperTrackedMapPin) +---@return Enum.SuperTrackingMapPinType type +---@return number typeID +function C_SuperTrack.GetSuperTrackedMapPin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetSuperTrackedQuestID) +---@return number? questID +function C_SuperTrack.GetSuperTrackedQuestID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.GetSuperTrackedVignette) +---@return WOWGUID? vignetteGUID +function C_SuperTrack.GetSuperTrackedVignette() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.IsSuperTrackingAnything) +---@return boolean isSuperTracking +function C_SuperTrack.IsSuperTrackingAnything() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.IsSuperTrackingContent) +---@return boolean isSuperTracking +function C_SuperTrack.IsSuperTrackingContent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.IsSuperTrackingCorpse) +---@return boolean isSuperTracking +function C_SuperTrack.IsSuperTrackingCorpse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.IsSuperTrackingMapPin) +---@return boolean isSuperTracking +function C_SuperTrack.IsSuperTrackingMapPin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.IsSuperTrackingQuest) +---@return boolean isSuperTracking +function C_SuperTrack.IsSuperTrackingQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.IsSuperTrackingUserWaypoint) +---@return boolean isSuperTracking +function C_SuperTrack.IsSuperTrackingUserWaypoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.SetSuperTrackedContent) +---@param trackableType Enum.ContentTrackingType +---@param trackableID number +function C_SuperTrack.SetSuperTrackedContent(trackableType, trackableID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.SetSuperTrackedMapPin) +---@param type Enum.SuperTrackingMapPinType +---@param typeID number +function C_SuperTrack.SetSuperTrackedMapPin(type, typeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.SetSuperTrackedQuestID) +---@param questID number +function C_SuperTrack.SetSuperTrackedQuestID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.SetSuperTrackedUserWaypoint) +---@param superTracked boolean +function C_SuperTrack.SetSuperTrackedUserWaypoint(superTracked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SuperTrack.SetSuperTrackedVignette) +---@param vignetteGUID WOWGUID +function C_SuperTrack.SetSuperTrackedVignette(vignetteGUID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua new file mode 100644 index 0000000..a03c4f4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_System = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_System.GetFrameStack) +---@return ScriptRegion[] objects +function C_System.GetFrameStack() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua new file mode 100644 index 0000000..1b89def --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua @@ -0,0 +1,30 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGameTime) +---@return number hour +---@return number minute +function GetGameTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLocalGameTime) +---@return number hour +---@return number minute +function GetLocalGameTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetServerTime) +---@return number time +function GetServerTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSessionTime) +---@return number time +function GetSessionTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTickTime) +---@return number time +function GetTickTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTime) +---@return number time +function GetTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsUsingFixedTimeStep) +---@return boolean isUsingFixedTimeStep +function IsUsingFixedTimeStep() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua new file mode 100644 index 0000000..90e3729 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua @@ -0,0 +1,89 @@ +---@meta _ +C_TTSSettings = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetChannelEnabled) +---@param channelInfo ChatChannelInfo +---@return boolean enabled +function C_TTSSettings.GetChannelEnabled(channelInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetCharacterSettingsSaved) +---@return boolean settingsBeenSaved +function C_TTSSettings.GetCharacterSettingsSaved() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetChatTypeEnabled) +---@param chatName string +---@return boolean enabled +function C_TTSSettings.GetChatTypeEnabled(chatName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetSetting) +---@param setting Enum.TtsBoolSetting +---@return boolean enabled +function C_TTSSettings.GetSetting(setting) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetSpeechRate) +---@return number rate +function C_TTSSettings.GetSpeechRate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetSpeechVolume) +---@return number volume +function C_TTSSettings.GetSpeechVolume() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetVoiceOptionID) +---@param voiceType Enum.TtsVoiceType +---@return number voiceID +function C_TTSSettings.GetVoiceOptionID(voiceType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.GetVoiceOptionName) +---@param voiceType Enum.TtsVoiceType +---@return string voiceName +function C_TTSSettings.GetVoiceOptionName(voiceType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.MarkCharacterSettingsSaved) +function C_TTSSettings.MarkCharacterSettingsSaved() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetChannelEnabled) +---@param channelInfo ChatChannelInfo +---@param newVal? boolean Default = false +function C_TTSSettings.SetChannelEnabled(channelInfo, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetChannelKeyEnabled) +---@param channelKey string +---@param newVal? boolean Default = false +function C_TTSSettings.SetChannelKeyEnabled(channelKey, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetChatTypeEnabled) +---@param chatName string +---@param newVal? boolean Default = false +function C_TTSSettings.SetChatTypeEnabled(chatName, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetDefaultSettings) +function C_TTSSettings.SetDefaultSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetSetting) +---@param setting Enum.TtsBoolSetting +---@param newVal? boolean Default = false +function C_TTSSettings.SetSetting(setting, newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetSpeechRate) +---@param newVal number +function C_TTSSettings.SetSpeechRate(newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetSpeechVolume) +---@param newVal number +function C_TTSSettings.SetSpeechVolume(newVal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetVoiceOption) +---@param voiceType Enum.TtsVoiceType +---@param voiceID number +function C_TTSSettings.SetVoiceOption(voiceType, voiceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.SetVoiceOptionName) +---@param voiceType Enum.TtsVoiceType +---@param voiceName string +function C_TTSSettings.SetVoiceOptionName(voiceType, voiceName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TTSSettings.ShouldOverrideMessage) +---@param language number +---@param messageText string +---@return boolean overrideMessage +function C_TTSSettings.ShouldOverrideMessage(language, messageText) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua new file mode 100644 index 0000000..1549349 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua @@ -0,0 +1,88 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AssistUnit) +---@param name? string Default = +---@param exactMatch? boolean Default = false +function AssistUnit(name, exactMatch) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AttackTarget) +function AttackTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearFocus) +function ClearFocus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearTarget) +---@return boolean willMakeChange +function ClearTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FocusUnit) +---@param name? string Default = +function FocusUnit(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsTargetLoose) +---@return boolean isTargetLoose +function IsTargetLoose() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetDirectionEnemy) +---@param facing number +---@param coneAngle? number +function TargetDirectionEnemy(facing, coneAngle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetDirectionFinished) +function TargetDirectionFinished() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetDirectionFriend) +---@param facing number +---@param coneAngle? number +function TargetDirectionFriend(facing, coneAngle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetLastEnemy) +function TargetLastEnemy() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetLastFriend) +function TargetLastFriend() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetLastTarget) +function TargetLastTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearest) +---@param reverse? boolean Default = false +function TargetNearest(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearestEnemy) +---@param reverse? boolean Default = false +function TargetNearestEnemy(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearestEnemyPlayer) +---@param reverse? boolean Default = false +function TargetNearestEnemyPlayer(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearestFriend) +---@param reverse? boolean Default = false +function TargetNearestFriend(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearestFriendPlayer) +---@param reverse? boolean Default = false +function TargetNearestFriendPlayer(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearestPartyMember) +---@param reverse? boolean Default = false +function TargetNearestPartyMember(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetNearestRaidMember) +---@param reverse? boolean Default = false +function TargetNearestRaidMember(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetPriorityHighlightEnd) +function TargetPriorityHighlightEnd() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetPriorityHighlightStart) +---@param useStartDelay? boolean Default = false +function TargetPriorityHighlightStart(useStartDelay) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetToggle) +function TargetToggle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetUnit) +---@param name? string Default = +---@param exactMatch? boolean Default = false +function TargetUnit(name, exactMatch) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua new file mode 100644 index 0000000..57bf28b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +C_TaxiMap = {} + +---Returns information on taxi nodes at the current flight master. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaxiMap.GetAllTaxiNodes) +---@param uiMapID number +---@return TaxiNodeInfo[] taxiNodes +function C_TaxiMap.GetAllTaxiNodes(uiMapID) end + +---Returns information on taxi nodes for a given map, without considering the current flight master. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaxiMap.GetTaxiNodesForMap) +---@param uiMapID number +---@return MapTaxiNodeInfo[] mapTaxiNodes +function C_TaxiMap.GetTaxiNodesForMap(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TaxiMap.ShouldMapShowTaxiNodes) +---@param uiMapID number +---@return boolean shouldShowNodes +function C_TaxiMap.ShouldMapShowTaxiNodes(uiMapID) end + +---@class MapTaxiNodeInfo +---@field nodeID number +---@field position vector2 +---@field name string +---@field atlasName string +---@field faction Enum.FlightPathFaction +---@field textureKit textureKit +---@field isUndiscovered boolean + +---@class TaxiNodeInfo +---@field nodeID number +---@field position vector2 +---@field name string +---@field state Enum.FlightPathState +---@field slotIndex number +---@field textureKit textureKit +---@field useSpecialIcon boolean +---@field specialIconCostString string? +---@field isMapLayerTransition boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua new file mode 100644 index 0000000..4193239 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua @@ -0,0 +1,75 @@ +---@meta _ +C_Texture = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.ClearTitleIconTexture) +---@param texture SimpleTexture +function C_Texture.ClearTitleIconTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetAtlasElementID) +---@param atlas textureAtlas +---@return number elementID +function C_Texture.GetAtlasElementID(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetAtlasElements) +---@return textureAtlas[] atlases +function C_Texture.GetAtlasElements() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetAtlasExists) +---@param atlas textureAtlas +---@return boolean atlasExists +function C_Texture.GetAtlasExists(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetAtlasID) +---@param atlas textureAtlas +---@return number atlasID +function C_Texture.GetAtlasID(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetAtlasInfo) +---@param atlas textureAtlas +---@return AtlasInfo info +function C_Texture.GetAtlasInfo(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetFilenameFromFileDataID) +---@param fileDataID number +---@return string filename +function C_Texture.GetFilenameFromFileDataID(fileDataID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.GetTitleIconTexture) +---@param titleID string +---@param version Enum.TitleIconVersion +---@param callback GetTitleIconTextureCallback +function C_Texture.GetTitleIconTexture(titleID, version, callback) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.IsTitleIconTextureReady) +---@param titleID string +---@param version Enum.TitleIconVersion +---@return boolean ready +function C_Texture.IsTitleIconTextureReady(titleID, version) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.SetTitleIconTexture) +---@param texture SimpleTexture +---@param titleID string +---@param version Enum.TitleIconVersion +function C_Texture.SetTitleIconTexture(texture, titleID, version) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Texture.SetURLTexture) +---@param texture SimpleTexture +---@param url string +function C_Texture.SetURLTexture(texture, url) end + +---@class AtlasInfo +---@field elementName string +---@field width number +---@field height number +---@field rawSize vector2 +---@field leftTexCoord number +---@field rightTexCoord number +---@field topTexCoord number +---@field bottomTexCoord number +---@field tilesHorizontally boolean +---@field tilesVertically boolean +---@field file fileID? +---@field filename string? +---@field sliceData UITextureSliceData? + +---@alias GetTitleIconTextureCallback FunctionContainer|fun(success: boolean, texture: fileID) diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua new file mode 100644 index 0000000..9d3ec56 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua @@ -0,0 +1,11 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetThreatStatusColor) +---@param gameErrorIndex number +---@return number colorR +---@return number colorG +---@return number colorB +function GetThreatStatusColor(gameErrorIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsThreatWarningEnabled) +---@return boolean result +function IsThreatWarningEnabled() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua new file mode 100644 index 0000000..7fb202d --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua @@ -0,0 +1,8 @@ +---@meta _ +---@class CalendarTime +---@field monthDay number +---@field month number +---@field weekday number +---@field year number +---@field hour number +---@field minute number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua new file mode 100644 index 0000000..8a9579f --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_TimerunningUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TimerunningUI.GetActiveTimerunningSeasonID) +---@return number activeTimerunningSeasonID +function C_TimerunningUI.GetActiveTimerunningSeasonID() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua new file mode 100644 index 0000000..8c08a89 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua @@ -0,0 +1,23 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentTitle) +---@return number result +function GetCurrentTitle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumTitles) +---@return number result +function GetNumTitles() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTitleName) +---@param titleMaskID number +---@return string titleString +---@return boolean playerTitle +function GetTitleName(titleMaskID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsTitleKnown) +---@param titleMaskID number +---@return boolean result +function IsTitleKnown(titleMaskID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCurrentTitle) +---@param titleMaskID number +function SetCurrentTitle(titleMaskID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua new file mode 100644 index 0000000..e2dc234 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua @@ -0,0 +1,26 @@ +---@meta _ +C_TooltipComparison = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipComparison.CompareItem) +---@param comparisonItem TooltipComparisonItem +---@param tooltip Tooltip +---@param anchorFrame? SimpleFrame +function C_TooltipComparison.CompareItem(comparisonItem, tooltip, anchorFrame) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipComparison.GetItemComparisonDelta) +---@param comparisonItem TooltipComparisonItem +---@param equippedItem TooltipComparisonItem +---@param pairedItem? TooltipComparisonItem +---@param addPairedStats? boolean +---@return string[] lines +function C_TooltipComparison.GetItemComparisonDelta(comparisonItem, equippedItem, pairedItem, addPairedStats) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipComparison.GetItemComparisonInfo) +---@param comparisonItem TooltipComparisonItem +---@return TooltipItemComparisonInfo info +function C_TooltipComparison.GetItemComparisonInfo(comparisonItem) end + +---@class TooltipItemComparisonInfo +---@field method Enum.TooltipComparisonMethod? Default = Single +---@field item TooltipComparisonItem +---@field additionalItems TooltipComparisonItem[] diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua new file mode 100644 index 0000000..7234648 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua @@ -0,0 +1,484 @@ +---@meta _ +C_TooltipInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetAchievementByID) +---@param achievementID number +---@return TooltipData data +function C_TooltipInfo.GetAchievementByID(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetAction) +---@param actionID number +---@return TooltipData data +function C_TooltipInfo.GetAction(actionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetArtifactItem) +---@return TooltipData data +function C_TooltipInfo.GetArtifactItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetArtifactPowerByID) +---@param powerID number +---@return TooltipData data +function C_TooltipInfo.GetArtifactPowerByID(powerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetAzeriteEssence) +---@param essenceID number +---@param rank? number +---@return TooltipData data +function C_TooltipInfo.GetAzeriteEssence(essenceID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetAzeriteEssenceSlot) +---@param slot Enum.AzeriteEssenceSlot +---@return TooltipData data +function C_TooltipInfo.GetAzeriteEssenceSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetAzeritePower) +---@param itemID number +---@param itemLevel number +---@param powerID number +---@param owningItemLink? string +---@return TooltipData data +function C_TooltipInfo.GetAzeritePower(itemID, itemLevel, powerID, owningItemLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetBackpackToken) +---@param index number +---@return TooltipData data +function C_TooltipInfo.GetBackpackToken(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetBagItem) +---@param bagIndex Enum.BagIndex +---@param slotIndex number +---@return TooltipData data +function C_TooltipInfo.GetBagItem(bagIndex, slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetBagItemChild) +---@param bagIndex Enum.BagIndex +---@param slotIndex number +---@param equipSlotIndex number +---@return TooltipData data +function C_TooltipInfo.GetBagItemChild(bagIndex, slotIndex, equipSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetBuybackItem) +---@param index number +---@return TooltipData data +function C_TooltipInfo.GetBuybackItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetCompanionPet) +---@param petGUID WOWGUID +---@return TooltipData data +function C_TooltipInfo.GetCompanionPet(petGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetConduit) +---@param conduitID number +---@param conduitRank number +---@return TooltipData data +function C_TooltipInfo.GetConduit(conduitID, conduitRank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetCurrencyByID) +---@param currencyID number +---@param amount? number +---@return TooltipData data +function C_TooltipInfo.GetCurrencyByID(currencyID, amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetCurrencyToken) +---@param tokenIndex number +---@return TooltipData data +function C_TooltipInfo.GetCurrencyToken(tokenIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetEnhancedConduit) +---@param conduitID number +---@param rank number +---@return TooltipData data +function C_TooltipInfo.GetEnhancedConduit(conduitID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetEquipmentSet) +---@param setID number +---@return TooltipData data +function C_TooltipInfo.GetEquipmentSet(setID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetExistingSocketGem) +---@param index number +---@param toDestroy? boolean +---@return TooltipData data +function C_TooltipInfo.GetExistingSocketGem(index, toDestroy) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetGuildBankItem) +---@param tab number +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetGuildBankItem(tab, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetHeirloomByItemID) +---@param itemID number +---@return TooltipData data +function C_TooltipInfo.GetHeirloomByItemID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetHyperlink) +---@param hyperlink string +---@param optionalArg1? number +---@param optionalArg2? number +---@param hideVendorPrice? boolean +---@return TooltipData data +function C_TooltipInfo.GetHyperlink(hyperlink, optionalArg1, optionalArg2, hideVendorPrice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetInboxItem) +---@param messageIndex number +---@param attachmentIndex? number +---@return TooltipData data +function C_TooltipInfo.GetInboxItem(messageIndex, attachmentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetInstanceLockEncountersComplete) +---@param index number +---@return TooltipData data +function C_TooltipInfo.GetInstanceLockEncountersComplete(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetInventoryItem) +---@param unit UnitToken +---@param slot number +---@param hideUselessStats? boolean +---@return TooltipData data +function C_TooltipInfo.GetInventoryItem(unit, slot, hideUselessStats) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetInventoryItemByID) +---@param itemID number +---@return TooltipData data +function C_TooltipInfo.GetInventoryItemByID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetItemByGUID) +---@param guid WOWGUID +---@return TooltipData data +function C_TooltipInfo.GetItemByGUID(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetItemByID) +---@param itemID number +---@param quality? number +---@param itemContext? number +---@param treasureContextLevel? number +---@return TooltipData data +function C_TooltipInfo.GetItemByID(itemID, quality, itemContext, treasureContextLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetItemByItemModifiedAppearanceID) +---@param itemModifiedAppearanceID number +---@return TooltipData data +function C_TooltipInfo.GetItemByItemModifiedAppearanceID(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetItemInteractionItem) +---@return TooltipData data +function C_TooltipInfo.GetItemInteractionItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetItemKey) +---@param itemID number +---@param itemLevel number +---@param itemSuffix number +---@param requiredLevel? number +---@return TooltipData data +function C_TooltipInfo.GetItemKey(itemID, itemLevel, itemSuffix, requiredLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetLFGDungeonReward) +---@param dungeonID number +---@param lootIndex number +---@return TooltipData data +function C_TooltipInfo.GetLFGDungeonReward(dungeonID, lootIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetLFGDungeonShortageReward) +---@param dungeonID number +---@param shortageSeverity number +---@param lootIndex number +---@return TooltipData data +function C_TooltipInfo.GetLFGDungeonShortageReward(dungeonID, shortageSeverity, lootIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetLootCurrency) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetLootCurrency(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetLootItem) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetLootItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetLootRollItem) +---@param id number +---@return TooltipData data +function C_TooltipInfo.GetLootRollItem(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetMerchantCostItem) +---@param slot number +---@param costIndex number +---@return TooltipData data +function C_TooltipInfo.GetMerchantCostItem(slot, costIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetMerchantItem) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetMerchantItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetMinimapMouseover) +---@return TooltipData data +function C_TooltipInfo.GetMinimapMouseover() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetMountBySpellID) +---@param spellID SpellIdentifier +---@param checkIndoors? boolean +---@return TooltipData data +function C_TooltipInfo.GetMountBySpellID(spellID, checkIndoors) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetOutfit) +---@param outfitID number +---@return TooltipData data +function C_TooltipInfo.GetOutfit(outfitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetOwnedItemByID) +---@param itemID number +---@return TooltipData data +function C_TooltipInfo.GetOwnedItemByID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetPetAction) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetPetAction(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetPossession) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetPossession(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetPvpBrawl) +---@param isSpecial? boolean +---@return TooltipData data +function C_TooltipInfo.GetPvpBrawl(isSpecial) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetPvpTalent) +---@param talentID number +---@param isInspect? boolean +---@param groupIndex? number +---@param talentIndex? number +---@return TooltipData data +function C_TooltipInfo.GetPvpTalent(talentID, isInspect, groupIndex, talentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetQuestCurrency) +---@param type string +---@param currencyIndex number +---@return TooltipData data +function C_TooltipInfo.GetQuestCurrency(type, currencyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetQuestItem) +---@param type string +---@param itemIndex number +---@param allowCollectionText? boolean +---@return TooltipData data +function C_TooltipInfo.GetQuestItem(type, itemIndex, allowCollectionText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetQuestLogCurrency) +---@param type string +---@param currencyIndex number +---@param questID? number +---@return TooltipData data +function C_TooltipInfo.GetQuestLogCurrency(type, currencyIndex, questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetQuestLogItem) +---@param type string +---@param itemIndex number +---@param questID? number +---@param allowCollectionText? boolean +---@return TooltipData data +function C_TooltipInfo.GetQuestLogItem(type, itemIndex, questID, allowCollectionText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetQuestLogSpecialItem) +---@param questIndex number +---@return TooltipData data +function C_TooltipInfo.GetQuestLogSpecialItem(questIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetQuestPartyProgress) +---@param questID number +---@param omitTitle? boolean +---@param ignoreActivePlayer? boolean +---@return TooltipData data +function C_TooltipInfo.GetQuestPartyProgress(questID, omitTitle, ignoreActivePlayer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetRecipeRankInfo) +---@param recipeID number +---@param rank number +---@return TooltipData data +function C_TooltipInfo.GetRecipeRankInfo(recipeID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetRecipeReagentItem) +---@param recipeSpellID number +---@param dataSlotIndex number +---@return TooltipData data +function C_TooltipInfo.GetRecipeReagentItem(recipeSpellID, dataSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetRecipeResultItem) +---@param recipeID number +---@param reagentInfos? CraftingReagentInfo[] +---@param recraftItemGUID? WOWGUID +---@param recipeLevel? number +---@param overrideQualityID? number +---@return TooltipData data +function C_TooltipInfo.GetRecipeResultItem(recipeID, reagentInfos, recraftItemGUID, recipeLevel, overrideQualityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetRecipeResultItemForOrder) +---@param recipeID number +---@param reagentInfos? CraftingReagentInfo[] +---@param orderID? BigUInteger +---@param recipeLevel? number +---@param overrideQualityID? number +---@return TooltipData data +function C_TooltipInfo.GetRecipeResultItemForOrder(recipeID, reagentInfos, orderID, recipeLevel, overrideQualityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetRuneforgeResultItem) +---@param itemGUID WOWGUID +---@param itemLevel number +---@param powerID? number +---@param modifiers? number[] +---@return TooltipData data +function C_TooltipInfo.GetRuneforgeResultItem(itemGUID, itemLevel, powerID, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSendMailItem) +---@param attachmentIndex? number +---@return TooltipData data +function C_TooltipInfo.GetSendMailItem(attachmentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetShapeshift) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetShapeshift(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSlottedKeystone) +---@return TooltipData data +function C_TooltipInfo.GetSlottedKeystone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSocketGem) +---@param index number +---@return TooltipData data +function C_TooltipInfo.GetSocketGem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSocketedItem) +---@return TooltipData data +function C_TooltipInfo.GetSocketedItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSocketedRelic) +---@param slotIndex number +---@return TooltipData data +function C_TooltipInfo.GetSocketedRelic(slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSpellBookItem) +---@param spellBookItemSlotIndex number +---@param spellBookItemSpellBank Enum.SpellBookSpellBank +---@return TooltipData data +function C_TooltipInfo.GetSpellBookItem(spellBookItemSlotIndex, spellBookItemSpellBank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetSpellByID) +---@param spellID SpellIdentifier +---@param isPet? boolean +---@param showSubtext? boolean +---@param dontOverride? boolean +---@param difficultyID? number +---@param isLink? boolean +---@return TooltipData data +function C_TooltipInfo.GetSpellByID(spellID, isPet, showSubtext, dontOverride, difficultyID, isLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetTalent) +---@param talentID number +---@param isInspect? boolean +---@param groupIndex? number +---@return TooltipData data +function C_TooltipInfo.GetTalent(talentID, isInspect, groupIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetTotem) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetTotem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetToyByItemID) +---@param itemID number +---@return TooltipData data +function C_TooltipInfo.GetToyByItemID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetTradePlayerItem) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetTradePlayerItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetTradeTargetItem) +---@param slot number +---@return TooltipData data +function C_TooltipInfo.GetTradeTargetItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetTrainerService) +---@param serviceIndex number +---@return TooltipData data +function C_TooltipInfo.GetTrainerService(serviceIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetTraitEntry) +---@param entryID number +---@param rank? number +---@return TooltipData data +function C_TooltipInfo.GetTraitEntry(entryID, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnit) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param hideStatus? boolean +---@return TooltipData data +function C_TooltipInfo.GetUnit(unit, hideStatus) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnitAura) +---@param unitToken UnitTokenRestrictedForAddOns +---@param index number +---@param filter? AuraFilters +---@return TooltipData data +function C_TooltipInfo.GetUnitAura(unitToken, index, filter) end + +---Obtains aura info like other functions with the caveat that the filters will always at least include the typically mutually exclusive HELPFUL|HARMFUL regardless of what the argument value is set to +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnitAuraByAuraInstanceID) +---@param unitToken UnitTokenRestrictedForAddOns +---@param auraInstanceID number +---@param filter? AuraFilters +---@return TooltipData data +function C_TooltipInfo.GetUnitAuraByAuraInstanceID(unitToken, auraInstanceID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnitBuff) +---@param unitToken UnitTokenRestrictedForAddOns +---@param index number +---@param filter? AuraFilters +---@return TooltipData data +function C_TooltipInfo.GetUnitBuff(unitToken, index, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnitBuffByAuraInstanceID) +---@param unitToken UnitTokenRestrictedForAddOns +---@param auraInstanceID number +---@param filter? AuraFilters +---@return TooltipData data +function C_TooltipInfo.GetUnitBuffByAuraInstanceID(unitToken, auraInstanceID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnitDebuff) +---@param unitToken UnitTokenRestrictedForAddOns +---@param index number +---@param filter? AuraFilters +---@return TooltipData data +function C_TooltipInfo.GetUnitDebuff(unitToken, index, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUnitDebuffByAuraInstanceID) +---@param unitToken UnitTokenRestrictedForAddOns +---@param auraInstanceID number +---@param filter? AuraFilters +---@return TooltipData data +function C_TooltipInfo.GetUnitDebuffByAuraInstanceID(unitToken, auraInstanceID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetUpgradeItem) +---@return TooltipData data +function C_TooltipInfo.GetUpgradeItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetWeeklyReward) +---@param itemDBID WeeklyRewardItemDBID +---@return TooltipData data +function C_TooltipInfo.GetWeeklyReward(itemDBID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetWorldCursor) +---@return TooltipData data +function C_TooltipInfo.GetWorldCursor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TooltipInfo.GetWorldLootObject) +---@param unitTokenString string +---@return TooltipData data +function C_TooltipInfo.GetWorldLootObject(unitTokenString) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua new file mode 100644 index 0000000..f7de78b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +---@class TooltipComparisonLine +---@field text string +---@field color colorRGB + +---@class TooltipDataArg +---@field field string +---@field stringVal string? +---@field intVal number? +---@field floatVal number? +---@field boolVal boolean? +---@field colorVal colorRGB? +---@field guidVal WOWGUID? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua new file mode 100644 index 0000000..dc97d79 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua @@ -0,0 +1,47 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_DestroyTotem) +---@param slot number +function DestroyTotem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumTotemSlots) +---@return number numSlots +function GetNumTotemSlots() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTotemCannotDismiss) +---@param slot number +---@return boolean? cannotDismiss +function GetTotemCannotDismiss(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTotemDuration) +---@param slot number +---@return LuaDurationObject duration +function GetTotemDuration(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTotemInfo) +---@param slot number +---@return boolean haveTotem +---@return string totemName +---@return number startTime +---@return number duration +---@return fileID icon +---@return number modRate +---@return number spellID +function GetTotemInfo(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTotemTimeLeft) +---@param slot number +---@return number? timeLeft +function GetTotemTimeLeft(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TargetTotem) +---@param slot number +function TargetTotem(slot) end + +---@class TotemInfoScript +---@field haveTotem boolean +---@field totemName string +---@field startTime number +---@field duration number +---@field icon fileID +---@field modRate number +---@field spellID number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua new file mode 100644 index 0000000..8815020 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua @@ -0,0 +1,23 @@ +---@meta _ +C_ToyBoxInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBoxInfo.ClearFanfare) +---@param itemID number +function C_ToyBoxInfo.ClearFanfare(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBoxInfo.IsToySourceValid) +---@param source number +---@return boolean isToySourceValid +function C_ToyBoxInfo.IsToySourceValid(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBoxInfo.IsUsingDefaultFilters) +---@return boolean isUsingDefaultFilters +function C_ToyBoxInfo.IsUsingDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBoxInfo.NeedsFanfare) +---@param itemID number +---@return boolean needsFanfare +function C_ToyBoxInfo.NeedsFanfare(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBoxInfo.SetDefaultFilters) +function C_ToyBoxInfo.SetDefaultFilters() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua new file mode 100644 index 0000000..c96cac3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua @@ -0,0 +1,21 @@ +---@meta _ +C_TradeInfo = {} + +---Adds any cursor-held money to the current trade offer. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeInfo.AddTradeMoney) +function C_TradeInfo.AddTradeMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeInfo.PickupTradeMoney) +---@param amount WOWMONEY +function C_TradeInfo.PickupTradeMoney(amount) end + +---Sets the amount of money in the current trade offer. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeInfo.SetTradeMoney) +---@param amount WOWMONEY +function C_TradeInfo.SetTradeMoney(amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeInfo.ShouldShowTradeOfferWarning) +---@return boolean shouldShow +function C_TradeInfo.ShouldShowTradeOfferWarning() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua new file mode 100644 index 0000000..82ed6ae --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua @@ -0,0 +1,470 @@ +---@meta _ +C_TradeSkillUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CanStoreEnchantInItem) +---@param itemGUID WOWGUID +---@return boolean canStore +function C_TradeSkillUI.CanStoreEnchantInItem(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CancelProfessionRespec) +function C_TradeSkillUI.CancelProfessionRespec() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CheckRespecNPC) +---@return boolean canInteract +function C_TradeSkillUI.CheckRespecNPC() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CloseTradeSkill) +function C_TradeSkillUI.CloseTradeSkill() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.ConfirmProfessionRespec) +function C_TradeSkillUI.ConfirmProfessionRespec() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CraftEnchant) +---@param recipeSpellID number +---@param numCasts? number Default = 1 +---@param craftingReagents? CraftingReagentInfo[] +---@param itemTarget? ItemLocation +---@param applyConcentration? boolean +function C_TradeSkillUI.CraftEnchant(recipeSpellID, numCasts, craftingReagents, itemTarget, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CraftRecipe) +---@param recipeSpellID number +---@param numCasts? number Default = 1 +---@param craftingReagents? CraftingReagentInfo[] +---@param recipeLevel? number +---@param orderID? BigUInteger +---@param applyConcentration? boolean +function C_TradeSkillUI.CraftRecipe(recipeSpellID, numCasts, craftingReagents, recipeLevel, orderID, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CraftSalvage) +---@param recipeSpellID number +---@param numCasts? number Default = 1 +---@param itemTarget ItemLocation +---@param craftingReagents? CraftingReagentInfo[] +---@param applyConcentration? boolean +function C_TradeSkillUI.CraftSalvage(recipeSpellID, numCasts, itemTarget, craftingReagents, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.DoesRecraftingRecipeAcceptItem) +---@param itemLocation ItemLocation +---@param recipeID number +---@return boolean result +function C_TradeSkillUI.DoesRecraftingRecipeAcceptItem(itemLocation, recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetAllProfessionTradeSkillLines) +---@return number[] skillLineID +function C_TradeSkillUI.GetAllProfessionTradeSkillLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetBaseProfessionInfo) +---@return ProfessionInfo info +function C_TradeSkillUI.GetBaseProfessionInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetChildProfessionInfo) +---@return ProfessionInfo info +function C_TradeSkillUI.GetChildProfessionInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetChildProfessionInfos) +---@return ProfessionInfo[] infos +function C_TradeSkillUI.GetChildProfessionInfos() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetConcentrationCurrencyID) +---@param skillLineID number +---@return number currencyType +function C_TradeSkillUI.GetConcentrationCurrencyID(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCraftableCount) +---@param recipeSpellID number +---@param recipeLevel? number +---@return number numAvailable +function C_TradeSkillUI.GetCraftableCount(recipeSpellID, recipeLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCraftingOperationInfo) +---@param recipeID number +---@param craftingReagents CraftingReagentInfo[] +---@param allocationItemGUID? WOWGUID +---@param applyConcentration boolean +---@return CraftingOperationInfo? info +function C_TradeSkillUI.GetCraftingOperationInfo(recipeID, craftingReagents, allocationItemGUID, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCraftingOperationInfoForOrder) +---@param recipeID number +---@param craftingReagents CraftingReagentInfo[] +---@param orderID BigUInteger +---@param applyConcentration boolean +---@return CraftingOperationInfo? info +function C_TradeSkillUI.GetCraftingOperationInfoForOrder(recipeID, craftingReagents, orderID, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCraftingReagentBonusText) +---@param recipeSpellID number +---@param craftingReagentIndex number +---@param craftingReagents CraftingReagentInfo[] +---@param allocationItemGUID? WOWGUID +---@return string[] bonusText +function C_TradeSkillUI.GetCraftingReagentBonusText(recipeSpellID, craftingReagentIndex, craftingReagents, allocationItemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCraftingTargetItems) +---@param itemIDs number[] +---@return CraftingTargetItem[] items +function C_TradeSkillUI.GetCraftingTargetItems(itemIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetDependentReagents) +---@param reagent CraftingReagent +---@return CraftingReagent[] reagents +function C_TradeSkillUI.GetDependentReagents(reagent) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetEnchantItems) +---@param recipeID number +---@param craftingReagents? CraftingReagentInfo[] +---@return WOWGUID[] items +function C_TradeSkillUI.GetEnchantItems(recipeID, craftingReagents) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetFactionSpecificOutputItem) +---@param recipeSpellID number +---@return number? itemID +function C_TradeSkillUI.GetFactionSpecificOutputItem(recipeSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetGatheringOperationInfo) +---@param recipeID number +---@return GatheringOperationInfo? info +function C_TradeSkillUI.GetGatheringOperationInfo(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetHideUnownedFlags) +---@param recipeID number +---@return boolean cannotModifyHideUnowned +---@return boolean alwaysShowUnowned +function C_TradeSkillUI.GetHideUnownedFlags(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetItemCraftedQualityByItemInfo) +---@param itemInfo ItemInfo +---@return number? quality +function C_TradeSkillUI.GetItemCraftedQualityByItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetItemCraftedQualityInfo) +---@param itemInfo ItemInfo +---@return CraftingQualityInfo? info +function C_TradeSkillUI.GetItemCraftedQualityInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetItemReagentQualityByItemInfo) +---@param itemInfo ItemInfo +---@return number? quality +function C_TradeSkillUI.GetItemReagentQualityByItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetItemReagentQualityInfo) +---@param itemInfo ItemInfo +---@return CraftingQualityInfo? info +function C_TradeSkillUI.GetItemReagentQualityInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetItemSlotModifications) +---@param itemGUID WOWGUID +---@return CraftingItemSlotModification[] slotMods +function C_TradeSkillUI.GetItemSlotModifications(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetItemSlotModificationsForOrder) +---@param orderID BigUInteger +---@return CraftingItemSlotModification[] slotMods +function C_TradeSkillUI.GetItemSlotModificationsForOrder(orderID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetOriginalCraftRecipeID) +---@param itemGUID WOWGUID +---@return number? recipeID +---@return number? skillLineAbilityID +function C_TradeSkillUI.GetOriginalCraftRecipeID(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionByInventorySlot) +---@param slot number +---@return Enum.Profession? profession +function C_TradeSkillUI.GetProfessionByInventorySlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionChildSkillLineID) +---@return number skillLineID +function C_TradeSkillUI.GetProfessionChildSkillLineID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionForCursorItem) +---@return Enum.Profession? profession +function C_TradeSkillUI.GetProfessionForCursorItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionInfoByRecipeID) +---@param recipeID number +---@return ProfessionInfo info +function C_TradeSkillUI.GetProfessionInfoByRecipeID(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionInfoBySkillLineID) +---@param skillLineID number +---@return ProfessionInfo info +function C_TradeSkillUI.GetProfessionInfoBySkillLineID(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionInventorySlots) +---@return InventorySlots[] invSlots +function C_TradeSkillUI.GetProfessionInventorySlots() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionNameForSkillLineAbility) +---@param skillLineAbilityID number +---@return string professionNmae +function C_TradeSkillUI.GetProfessionNameForSkillLineAbility(skillLineAbilityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionSkillLineID) +---@param profession Enum.Profession +---@return number skillLineID +function C_TradeSkillUI.GetProfessionSkillLineID(profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionSlots) +---@param profession Enum.Profession +---@return number[] slots +function C_TradeSkillUI.GetProfessionSlots(profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetProfessionSpells) +---@param professionID number +---@param skillLineID? number +---@return number[] knownSpells +function C_TradeSkillUI.GetProfessionSpells(professionID, skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetQualitiesForRecipe) +---@param recipeID number +---@return number[]? qualityIDs +function C_TradeSkillUI.GetQualitiesForRecipe(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetReagentDifficultyText) +---@param craftingReagentIndex number +---@param craftingReagents CraftingReagentInfo[] +---@return string bonusText +function C_TradeSkillUI.GetReagentDifficultyText(craftingReagentIndex, craftingReagents) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetReagentSlotStatus) +---@param mcrSlotID number +---@param recipeSpellID number +---@param skillLineAbilityID number +---@return boolean locked +---@return string lockedReason +function C_TradeSkillUI.GetReagentSlotStatus(mcrSlotID, recipeSpellID, skillLineAbilityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeDescription) +---@param recipeID number +---@param craftingReagents CraftingReagentInfo[] +---@param allocationItemGUID? WOWGUID +---@return string description +function C_TradeSkillUI.GetRecipeDescription(recipeID, craftingReagents, allocationItemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeInfo) +---@param recipeSpellID number +---@param recipeLevel? number +---@return TradeSkillRecipeInfo? recipeInfo +function C_TradeSkillUI.GetRecipeInfo(recipeSpellID, recipeLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeInfoForSkillLineAbility) +---@param skillLineAbilityID number +---@param recipeLevel? number +---@return TradeSkillRecipeInfo? recipeInfo +function C_TradeSkillUI.GetRecipeInfoForSkillLineAbility(skillLineAbilityID, recipeLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeItemQualityInfo) +---@param recipeID number +---@param quality number +---@return CraftingQualityInfo? info +function C_TradeSkillUI.GetRecipeItemQualityInfo(recipeID, quality) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeOutputItemData) +---@param recipeSpellID number +---@param reagents? CraftingReagentInfo[] +---@param allocationItemGUID? WOWGUID +---@param overrideQualityID? number +---@param recraftOrderID? BigUInteger +---@return CraftingRecipeOutputInfo outputInfo +function C_TradeSkillUI.GetRecipeOutputItemData(recipeSpellID, reagents, allocationItemGUID, overrideQualityID, recraftOrderID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeQualityItemIDs) +---@param recipeSpellID number +---@return number[]? qualityItemIDs +function C_TradeSkillUI.GetRecipeQualityItemIDs(recipeSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeQualityReagentLink) +---@param recipeID number +---@param dataSlotIndex number +---@param qualityIndex number +---@return string link +function C_TradeSkillUI.GetRecipeQualityReagentLink(recipeID, dataSlotIndex, qualityIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeRequirements) +---@param recipeID number +---@return CraftingRecipeRequirement[] requirements +function C_TradeSkillUI.GetRecipeRequirements(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeSchematic) +---@param recipeSpellID number +---@param isRecraft boolean +---@param recipeLevel? number +---@return CraftingRecipeSchematic schematic +function C_TradeSkillUI.GetRecipeSchematic(recipeSpellID, isRecraft, recipeLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipesTracked) +---@param isRecraft boolean +---@return number[] recipeIDs +function C_TradeSkillUI.GetRecipesTracked(isRecraft) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecraftItems) +---@param recipeID? number +---@return WOWGUID[] items +function C_TradeSkillUI.GetRecraftItems(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecraftRemovalWarnings) +---@param itemGUID WOWGUID +---@param replacedReagents CraftingReagent[] +---@return string[] warnings +function C_TradeSkillUI.GetRecraftRemovalWarnings(itemGUID, replacedReagents) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRemainingRecasts) +---@return number remaining +function C_TradeSkillUI.GetRemainingRecasts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetSalvagableItemIDs) +---@param recipeID number +---@return number[] itemIDs +function C_TradeSkillUI.GetSalvagableItemIDs(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetShowLearned) +---@return boolean flag +function C_TradeSkillUI.GetShowLearned() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetShowUnlearned) +---@return boolean flag +function C_TradeSkillUI.GetShowUnlearned() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetSkillLineForGear) +---@param itemInfo ItemInfo +---@return number? skillLineID +function C_TradeSkillUI.GetSkillLineForGear(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetSourceTypeFilter) +---@return number sourceTypeFilter +function C_TradeSkillUI.GetSourceTypeFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetTradeSkillDisplayName) +---@param skillLineID number +---@return string professionDisplayName +function C_TradeSkillUI.GetTradeSkillDisplayName(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.HasFavoriteOrderRecipes) +---@return boolean hasFavorites +function C_TradeSkillUI.HasFavoriteOrderRecipes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsEnchantTargetValid) +---@param recipeID number +---@param itemGUID WOWGUID +---@param craftingReagents? CraftingReagentInfo[] +---@return boolean valid +function C_TradeSkillUI.IsEnchantTargetValid(recipeID, itemGUID, craftingReagents) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsGuildTradeSkillsEnabled) +---@return boolean enabled +function C_TradeSkillUI.IsGuildTradeSkillsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsNPCCrafting) +---@return boolean result +function C_TradeSkillUI.IsNPCCrafting() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsNearProfessionSpellFocus) +---@param profession Enum.Profession +---@return boolean nearFocus +function C_TradeSkillUI.IsNearProfessionSpellFocus(profession) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsOriginalCraftRecipeLearned) +---@param itemGUID WOWGUID +---@return boolean learned +function C_TradeSkillUI.IsOriginalCraftRecipeLearned(itemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeFirstCraft) +---@param recipeID number +---@return boolean result +function C_TradeSkillUI.IsRecipeFirstCraft(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeInBaseSkillLine) +---@param recipeID number +---@return boolean result +function C_TradeSkillUI.IsRecipeInBaseSkillLine(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeInSkillLine) +---@param recipeID number +---@param skillLineID number +---@return boolean result +function C_TradeSkillUI.IsRecipeInSkillLine(recipeID, skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeProfessionLearned) +---@param recipeID number +---@return boolean recipeProfessionLearned +function C_TradeSkillUI.IsRecipeProfessionLearned(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeTracked) +---@param recipeID number +---@param isRecraft boolean +---@return boolean tracked +function C_TradeSkillUI.IsRecipeTracked(recipeID, isRecraft) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecraftItemEquipped) +---@param recraftItemGUID WOWGUID +---@return boolean isEquipped +function C_TradeSkillUI.IsRecraftItemEquipped(recraftItemGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecraftReagentValid) +---@param itemGUID WOWGUID +---@param reagent CraftingReagent +---@return boolean valid +function C_TradeSkillUI.IsRecraftReagentValid(itemGUID, reagent) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRuneforging) +---@return boolean result +function C_TradeSkillUI.IsRuneforging() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.OpenRecipe) +---@param recipeID number +function C_TradeSkillUI.OpenRecipe(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.OpenTradeSkill) +---@param skillLineID number +---@return boolean opened +function C_TradeSkillUI.OpenTradeSkill(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.RecraftLimitCategoryValid) +---@param reagent CraftingReagent +---@return boolean recraftValid +function C_TradeSkillUI.RecraftLimitCategoryValid(reagent) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.RecraftRecipe) +---@param itemGUID WOWGUID +---@param craftingReagents? CraftingReagentInfo[] +---@param removedModifications? CraftingItemSlotModification[] +---@param applyConcentration? boolean +---@return boolean result +function C_TradeSkillUI.RecraftRecipe(itemGUID, craftingReagents, removedModifications, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.RecraftRecipeForOrder) +---@param orderID BigUInteger +---@param itemGUID WOWGUID +---@param craftingReagents? CraftingReagentInfo[] +---@param removedModifications? CraftingItemSlotModification[] +---@param applyConcentration? boolean +---@return boolean result +function C_TradeSkillUI.RecraftRecipeForOrder(orderID, itemGUID, craftingReagents, removedModifications, applyConcentration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetOnlyShowAvailableForOrders) +---@param flag boolean +function C_TradeSkillUI.SetOnlyShowAvailableForOrders(flag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetProfessionChildSkillLineID) +---@param skillLineID number +function C_TradeSkillUI.SetProfessionChildSkillLineID(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetRecipeTracked) +---@param recipeID number +---@param tracked boolean +---@param isRecraft boolean +function C_TradeSkillUI.SetRecipeTracked(recipeID, tracked, isRecraft) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetShowLearned) +---@param flag boolean +function C_TradeSkillUI.SetShowLearned(flag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetShowUnlearned) +---@param flag boolean +function C_TradeSkillUI.SetShowUnlearned(flag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetSourceTypeFilter) +---@param sourceTypeFilter number +function C_TradeSkillUI.SetSourceTypeFilter(sourceTypeFilter) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua new file mode 100644 index 0000000..0c2f564 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua @@ -0,0 +1,214 @@ +---@meta _ +---@class CraftingCurrencyResultData +---@field currencyID number? Default = 0 +---@field quantity number? Default = 0 +---@field operationID number? Default = 0 +---@field firstCraftReward boolean? Default = false +---@field showCurrencyText boolean? Default = true + +---@class CraftingItemResultData +---@field resourcesReturned CraftingResourceReturnInfo[]? +---@field craftingQuality number? +---@field qualityProgress number? Default = 0 +---@field itemID number? Default = 0 +---@field itemGUID WOWGUID +---@field quantity number? Default = 0 +---@field hyperlink string +---@field isCrit boolean? Default = false +---@field critBonusSkill number? Default = 0 +---@field recraftable boolean? Default = false +---@field bonusCraft boolean? Default = false +---@field multicraft number? Default = 0 +---@field operationID number? Default = 0 +---@field firstCraftReward boolean? Default = false +---@field isEnchant boolean? Default = false +---@field hasIngenuityProc boolean? Default = false +---@field concentrationCurrencyID number? Default = 0 +---@field concentrationSpent number? Default = 0 +---@field ingenuityRefund number? Default = 0 + +---@class CraftingItemSlotModification +---@field dataSlotIndex number +---@field reagent CraftingReagent + +---@class CraftingOperationBonusStatInfo +---@field bonusStatName string +---@field bonusStatValue number +---@field ratingDescription string +---@field ratingPct number +---@field bonusRatingPct number + +---@class CraftingOperationInfo +---@field recipeID number +---@field baseDifficulty number +---@field bonusDifficulty number +---@field baseSkill number +---@field bonusSkill number +---@field isQualityCraft boolean +---@field quality number +---@field craftingQuality number +---@field craftingQualityID number +---@field craftingDataID number +---@field lowerSkillThreshold number +---@field upperSkillTreshold number +---@field guaranteedCraftingQualityID number +---@field bonusStats CraftingOperationBonusStatInfo[] +---@field concentrationCurrencyID number +---@field concentrationCost number +---@field ingenuityRefund number + +---@class CraftingQualityInfo +---@field quality number +---@field icon textureAtlas +---@field iconSmall textureAtlas +---@field iconInventory textureAtlas +---@field iconMixed textureAtlas +---@field iconAppear textureAtlas +---@field iconDissolve textureAtlas +---@field barFill textureAtlas +---@field barBackground textureAtlas +---@field barBackgroundCap textureAtlas +---@field barHighlight textureAtlas +---@field iconChat textureAtlas + +---@class CraftingReagent +---@field itemID number? +---@field currencyID number? + +---@class CraftingReagentInfo +---@field reagent CraftingReagent +---@field dataSlotIndex number +---@field quantity number + +---@class CraftingReagentSlotInfo +---@field mcrSlotID number +---@field requiredSkillRank number +---@field slotText string? + +---@class CraftingReagentSlotSchematic +---@field reagents CraftingReagent[] +---@field reagentType Enum.CraftingReagentType +---@field variableQuantities CraftingVariableQuantities[] +---@field quantityRequired number +---@field slotInfo CraftingReagentSlotInfo? +---@field dataSlotType Enum.TradeskillSlotDataType? Default = Reagent +---@field dataSlotIndex number +---@field slotIndex number +---@field orderSource Enum.CraftingOrderReagentSource? +---@field required boolean +---@field hiddenInCraftingForm boolean + +---@class CraftingRecipeOutputInfo +---@field icon number +---@field hyperlink string? +---@field itemID number? + +---@class CraftingRecipeRequirement +---@field name string +---@field met boolean +---@field type Enum.RecipeRequirementType + +---@class CraftingRecipeSchematic +---@field recipeID number +---@field icon number +---@field quantityMin number +---@field quantityMax number +---@field name string +---@field recipeType Enum.TradeskillRecipeType? Default = Item +---@field productQuality number? +---@field outputItemID number? +---@field reagentSlotSchematics CraftingReagentSlotSchematic[] +---@field isRecraft boolean +---@field hasCraftingOperationInfo boolean + +---@class CraftingRecipeSkillLineInfo +---@field professionSkillLineID number +---@field expansionSkillLineID number + +---@class CraftingResourceReturnInfo +---@field reagent CraftingReagent +---@field quantity number + +---@class CraftingTargetItem +---@field itemID number +---@field itemGUID WOWGUID +---@field hyperlink string? +---@field quantity number + +---@class CraftingVariableQuantities +---@field reagent CraftingReagent +---@field quantity number + +---@class GatheringOperationBonusStatInfo +---@field bonusStatName string +---@field bonusStatValue number +---@field ratingDescription string +---@field ratingPct number +---@field bonusRatingPct number + +---@class GatheringOperationInfo +---@field spellID number +---@field maxDifficulty number +---@field baseSkill number +---@field bonusSkill number +---@field bonusStats GatheringOperationBonusStatInfo[] + +---@class ProfessionInfo +---@field profession Enum.Profession? +---@field professionID number +---@field sourceCounter number +---@field professionName string +---@field expansionName string +---@field skillLevel number +---@field maxSkillLevel number +---@field skillModifier number +---@field isPrimaryProfession boolean +---@field parentProfessionID number? +---@field parentProfessionName string? + +---@class RegularReagentInfo +---@field reagent CraftingReagent +---@field quantity number + +---@class TradeSkillRecipeInfo +---@field categoryID number +---@field name string +---@field relativeDifficulty Enum.TradeskillRelativeDifficulty? +---@field maxTrivialLevel number +---@field itemLevel number +---@field alternateVerb string? +---@field numSkillUps number +---@field canSkillUp boolean +---@field firstCraft boolean +---@field sourceType number? +---@field learned boolean +---@field disabled boolean +---@field favorite boolean +---@field supportsQualities boolean +---@field craftable boolean? Default = true +---@field disabledReason string? +---@field recipeID number +---@field skillLineAbilityID number +---@field previousRecipeID number? +---@field nextRecipeID number? +---@field icon number? +---@field hyperlink string? +---@field currentRecipeExperience number? +---@field nextLevelRecipeExperience number? +---@field unlockedRecipeLevel number? +---@field earnedExperience number? +---@field supportsCraftingStats boolean? Default = false +---@field hasSingleItemOutput boolean? Default = false +---@field qualityItemIDs number[]? +---@field qualityIlvlBonuses number[]? +---@field alwaysUsesLowestQuality boolean? Default = false +---@field maxQuality number? +---@field qualityIDs number[]? +---@field canCreateMultiple boolean? Default = true +---@field abilityVerb string? +---@field abilityAllVerb string? +---@field isRecraft boolean? Default = false +---@field isDummyRecipe boolean? Default = false +---@field isGatheringRecipe boolean? Default = false +---@field isEnchantingRecipe boolean? Default = false +---@field isSalvageRecipe boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua new file mode 100644 index 0000000..a68fbf0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua @@ -0,0 +1,67 @@ +---@meta _ +C_Transmog = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.CanHaveSecondaryAppearanceForSlotID) +---@param slotID number +---@return boolean canHaveSecondaryAppearance +function C_Transmog.CanHaveSecondaryAppearanceForSlotID(slotID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.ExtractTransmogIDList) +---@param input string +---@return number[] transmogIDList +function C_Transmog.ExtractTransmogIDList(input) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.GetAllSetAppearancesByID) +---@param setID number +---@return TransmogSetItemInfo[]? setItems +function C_Transmog.GetAllSetAppearancesByID(setID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.GetItemIDForSource) +---@param itemModifiedAppearanceID number +---@return number? itemID +function C_Transmog.GetItemIDForSource(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.GetSlotForInventoryType) +---@param inventoryType number +---@return number slot +function C_Transmog.GetSlotForInventoryType(inventoryType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.GetSlotVisualInfo) +---@param transmogLocation TransmogLocation +---@return TransmogSlotVisualInfo slotVisualInfo +function C_Transmog.GetSlotVisualInfo(transmogLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Transmog.IsAtTransmogNPC) +---@return boolean isAtNPC +function C_Transmog.IsAtTransmogNPC() end + +---@class TransmogApplyWarningInfo +---@field itemLink string +---@field text string + +---@class TransmogSetItemInfo +---@field itemID number +---@field itemModifiedAppearanceID number +---@field invSlot number +---@field invType string + +---@class TransmogSlotInfo +---@field isTransmogrified boolean +---@field hasPending boolean +---@field isPendingCollected boolean +---@field canTransmogrify boolean +---@field cannotTransmogrifyReason number +---@field hasUndo boolean +---@field isHideVisual boolean +---@field texture fileID? + +---@class TransmogSlotVisualInfo +---@field baseSourceID number +---@field baseVisualID number +---@field appliedSourceID number +---@field appliedVisualID number +---@field pendingSourceID number +---@field pendingVisualID number +---@field hasUndo boolean +---@field isHideVisual boolean +---@field itemSubclass number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua new file mode 100644 index 0000000..77172df --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua @@ -0,0 +1,478 @@ +---@meta _ +C_TransmogCollection = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.AccountCanCollectSource) +---@param sourceID number +---@return boolean hasItemData +---@return boolean canCollect +function C_TransmogCollection.AccountCanCollectSource(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.AreAllCollectionTypeFiltersChecked) +---@return boolean areAllCollectionTypeFiltersChecked +function C_TransmogCollection.AreAllCollectionTypeFiltersChecked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.AreAllSourceTypeFiltersChecked) +---@return boolean areAllSourceTypeFiltersChecked +function C_TransmogCollection.AreAllSourceTypeFiltersChecked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.CanAppearanceHaveIllusion) +---@param appearanceID number +---@return boolean canHaveIllusion +function C_TransmogCollection.CanAppearanceHaveIllusion(appearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.ClearNewAppearance) +---@param visualID number +function C_TransmogCollection.ClearNewAppearance(visualID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.ClearSearch) +---@param searchType Enum.TransmogSearchType +---@return boolean completed +function C_TransmogCollection.ClearSearch(searchType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.DeleteCustomSet) +---@param customSetID number +function C_TransmogCollection.DeleteCustomSet(customSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.EndSearch) +function C_TransmogCollection.EndSearch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAllAppearanceSources) +---@param itemAppearanceID number +---@return number[] itemModifiedAppearanceIDs +function C_TransmogCollection.GetAllAppearanceSources(itemAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAllFactionsShown) +---@return boolean shown +function C_TransmogCollection.GetAllFactionsShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAllRacesShown) +---@return boolean shown +function C_TransmogCollection.GetAllRacesShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAppearanceCameraID) +---@param itemAppearanceID number +---@param variation? Enum.TransmogCameraVariation +---@return number cameraID +function C_TransmogCollection.GetAppearanceCameraID(itemAppearanceID, variation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAppearanceCameraIDBySource) +---@param itemModifiedAppearanceID number +---@param variation? Enum.TransmogCameraVariation +---@return number cameraID +function C_TransmogCollection.GetAppearanceCameraIDBySource(itemModifiedAppearanceID, variation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAppearanceInfoBySource) +---@param itemModifiedAppearanceID number +---@return TransmogAppearanceInfoBySourceData info +function C_TransmogCollection.GetAppearanceInfoBySource(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAppearanceSourceDrops) +---@param itemModifiedAppearanceID number +---@return TransmogAppearanceJournalEncounterInfo[] encounterInfo +function C_TransmogCollection.GetAppearanceSourceDrops(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAppearanceSourceInfo) +---@param itemModifiedAppearanceID number +---@return TransmogAppearanceSourceInfoData info +function C_TransmogCollection.GetAppearanceSourceInfo(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetAppearanceSources) +---@param appearanceID number +---@param categoryType? Enum.TransmogCollectionType +---@param transmogLocation? TransmogLocation +---@return AppearanceSourceInfo[] sources +function C_TransmogCollection.GetAppearanceSources(appearanceID, categoryType, transmogLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetArtifactAppearanceStrings) +---@param appearanceID number +---@return string name +---@return string hyperlink +function C_TransmogCollection.GetArtifactAppearanceStrings(appearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCategoryAppearances) +---@param category Enum.TransmogCollectionType +---@param transmogLocation? TransmogLocation +---@return TransmogCategoryAppearanceInfo[] appearances +function C_TransmogCollection.GetCategoryAppearances(category, transmogLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCategoryCollectedCount) +---@param category Enum.TransmogCollectionType +---@return number count +function C_TransmogCollection.GetCategoryCollectedCount(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCategoryForItem) +---@param itemModifiedAppearanceID number +---@return Enum.TransmogCollectionType collectionCategory +function C_TransmogCollection.GetCategoryForItem(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCategoryInfo) +---@param category Enum.TransmogCollectionType +---@return string name +---@return boolean? isWeapon Default = false +---@return boolean? canHaveIllusions Default = false +---@return boolean? canMainHand Default = false +---@return boolean? canOffHand Default = false +---@return boolean? canRanged Default = false +function C_TransmogCollection.GetCategoryInfo(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCategoryTotal) +---@param category Enum.TransmogCollectionType +---@return number total +function C_TransmogCollection.GetCategoryTotal(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetClassFilter) +---@return number classID +function C_TransmogCollection.GetClassFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCollectedShown) +---@return boolean shown +function C_TransmogCollection.GetCollectedShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCustomSetHyperlinkFromItemTransmogInfoList) +---@param itemTransmogInfoList ItemTransmogInfo[] +---@return string hyperlink +function C_TransmogCollection.GetCustomSetHyperlinkFromItemTransmogInfoList(itemTransmogInfoList) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCustomSetInfo) +---@param customSetID number +---@return string name +---@return fileID icon +function C_TransmogCollection.GetCustomSetInfo(customSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCustomSetItemTransmogInfoList) +---@param customSetID number +---@return ItemTransmogInfo[] list +function C_TransmogCollection.GetCustomSetItemTransmogInfoList(customSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetCustomSets) +---@return number[] customSetID +function C_TransmogCollection.GetCustomSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetFallbackWeaponAppearance) +---@return number? appearanceID +function C_TransmogCollection.GetFallbackWeaponAppearance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetFilteredCategoryCollectedCount) +---@param category Enum.TransmogCollectionType +---@return number count +function C_TransmogCollection.GetFilteredCategoryCollectedCount(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetFilteredCategoryTotal) +---@param category Enum.TransmogCollectionType +---@return number total +function C_TransmogCollection.GetFilteredCategoryTotal(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetIllusionInfo) +---@param illusionID number +---@return TransmogIllusionInfo info +function C_TransmogCollection.GetIllusionInfo(illusionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetIllusionStrings) +---@param illusionID number +---@return string name +---@return string hyperlink +---@return string? sourceText +function C_TransmogCollection.GetIllusionStrings(illusionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetIllusions) +---@param category? Enum.TransmogCollectionType +---@return TransmogIllusionInfo[] illusions +function C_TransmogCollection.GetIllusions(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetInspectItemTransmogInfoList) +---@return ItemTransmogInfo[] list +function C_TransmogCollection.GetInspectItemTransmogInfoList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetIsAppearanceFavorite) +---@param itemAppearanceID number +---@return boolean isFavorite +function C_TransmogCollection.GetIsAppearanceFavorite(itemAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetItemInfo) +---@param itemInfo ItemInfo +---@return number itemAppearanceID +---@return number itemModifiedAppearanceID +function C_TransmogCollection.GetItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetItemTransmogInfoListFromCustomSetHyperlink) +---@param hyperlink string +---@return ItemTransmogInfo[] list +function C_TransmogCollection.GetItemTransmogInfoListFromCustomSetHyperlink(hyperlink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetLatestAppearance) +---@return number visualID +---@return Enum.TransmogCollectionType category +function C_TransmogCollection.GetLatestAppearance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetNumMaxCustomSets) +---@return number maxCustomSets +function C_TransmogCollection.GetNumMaxCustomSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetNumTransmogSources) +---@return number count +function C_TransmogCollection.GetNumTransmogSources() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetPairedArtifactAppearance) +---@param itemModifiedAppearanceID number +---@return number pairedItemModifiedAppearanceID +function C_TransmogCollection.GetPairedArtifactAppearance(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetSourceIcon) +---@param itemModifiedAppearanceID number +---@return fileID icon +function C_TransmogCollection.GetSourceIcon(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetSourceInfo) +---@param sourceID number +---@return AppearanceSourceInfo sourceInfo +function C_TransmogCollection.GetSourceInfo(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetSourceItemID) +---@param itemModifiedAppearanceID number +---@return number itemID +function C_TransmogCollection.GetSourceItemID(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetSourceRequiredHoliday) +---@param itemModifiedAppearanceID number +---@return string holidayName +function C_TransmogCollection.GetSourceRequiredHoliday(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetUncollectedShown) +---@return boolean shown +function C_TransmogCollection.GetUncollectedShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.GetValidAppearanceSourcesForClass) +---@param appearanceID number +---@param classID number +---@param categoryType? Enum.TransmogCollectionType +---@param transmogLocation? TransmogLocation +---@return AppearanceSourceInfo[] sources +function C_TransmogCollection.GetValidAppearanceSourcesForClass(appearanceID, classID, categoryType, transmogLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.HasFavorites) +---@return boolean hasFavorites +function C_TransmogCollection.HasFavorites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsAppearanceHiddenVisual) +---@param appearanceID number +---@return boolean isHiddenVisual +function C_TransmogCollection.IsAppearanceHiddenVisual(appearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsCategoryValidForItem) +---@param category Enum.TransmogCollectionType +---@param itemInfo ItemInfo +---@return boolean isValid +function C_TransmogCollection.IsCategoryValidForItem(category, itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsNewAppearance) +---@param visualID number +---@return boolean isNew +function C_TransmogCollection.IsNewAppearance(visualID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsSearchDBLoading) +---@return boolean isLoading +function C_TransmogCollection.IsSearchDBLoading() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsSearchInProgress) +---@param searchType Enum.TransmogSearchType +---@return boolean inProgress +function C_TransmogCollection.IsSearchInProgress(searchType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsSourceTypeFilterChecked) +---@param index number +---@return boolean checked +function C_TransmogCollection.IsSourceTypeFilterChecked(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsSpellItemEnchantmentHiddenVisual) +---@param spellItemEnchantmentID number +---@return boolean isHiddenVisual +function C_TransmogCollection.IsSpellItemEnchantmentHiddenVisual(spellItemEnchantmentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsUsingDefaultFilters) +---@return boolean isUsingDefaultFilters +function C_TransmogCollection.IsUsingDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsValidCustomSetName) +---@param name string +---@return boolean isApproved +function C_TransmogCollection.IsValidCustomSetName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.IsValidTransmogSource) +---@param source Enum.TransmogSource +---@return boolean valid +function C_TransmogCollection.IsValidTransmogSource(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.ModifyCustomSet) +---@param customSetID number +---@param itemTransmogInfoList ItemTransmogInfo[] +function C_TransmogCollection.ModifyCustomSet(customSetID, itemTransmogInfoList) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.NewCustomSet) +---@param name string +---@param icon fileID +---@param itemTransmogInfoList ItemTransmogInfo[] +---@return number? customSetID +function C_TransmogCollection.NewCustomSet(name, icon, itemTransmogInfoList) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.PlayerCanCollectSource) +---@param sourceID number +---@return boolean hasItemData +---@return boolean canCollect +function C_TransmogCollection.PlayerCanCollectSource(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.PlayerHasTransmog) +---@param itemID number +---@param itemAppearanceModID? number Default = 0 +---@return boolean hasTransmog +function C_TransmogCollection.PlayerHasTransmog(itemID, itemAppearanceModID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.PlayerHasTransmogByItemInfo) +---@param itemInfo ItemInfo +---@return boolean hasTransmog +function C_TransmogCollection.PlayerHasTransmogByItemInfo(itemInfo) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.PlayerHasTransmogItemModifiedAppearance) +---@param itemModifiedAppearanceID number +---@return boolean hasTransmog +function C_TransmogCollection.PlayerHasTransmogItemModifiedAppearance(itemModifiedAppearanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.PlayerKnowsSource) +---@param sourceID number +---@return boolean isKnown +function C_TransmogCollection.PlayerKnowsSource(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.RenameCustomSet) +---@param customSetID number +---@param name string +function C_TransmogCollection.RenameCustomSet(customSetID, name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SearchProgress) +---@param searchType Enum.TransmogSearchType +---@return number progress +function C_TransmogCollection.SearchProgress(searchType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SearchSize) +---@param searchType Enum.TransmogSearchType +---@return number size +function C_TransmogCollection.SearchSize(searchType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetAllCollectionTypeFilters) +---@param checked boolean +function C_TransmogCollection.SetAllCollectionTypeFilters(checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetAllFactionsShown) +---@param shown boolean +function C_TransmogCollection.SetAllFactionsShown(shown) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetAllRacesShown) +---@param shown boolean +function C_TransmogCollection.SetAllRacesShown(shown) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetAllSourceTypeFilters) +---@param checked boolean +function C_TransmogCollection.SetAllSourceTypeFilters(checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetClassFilter) +---@param classID number +function C_TransmogCollection.SetClassFilter(classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetCollectedShown) +---@param shown boolean +function C_TransmogCollection.SetCollectedShown(shown) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetDefaultFilters) +function C_TransmogCollection.SetDefaultFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetIsAppearanceFavorite) +---@param itemAppearanceID number +---@param isFavorite boolean +function C_TransmogCollection.SetIsAppearanceFavorite(itemAppearanceID, isFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetSearch) +---@param searchType Enum.TransmogSearchType +---@param searchText string +---@return boolean completed +function C_TransmogCollection.SetSearch(searchType, searchText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetSearchAndFilterCategory) +---@param category Enum.TransmogCollectionType +function C_TransmogCollection.SetSearchAndFilterCategory(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetSourceTypeFilter) +---@param index number +---@param checked boolean +function C_TransmogCollection.SetSourceTypeFilter(index, checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.SetUncollectedShown) +---@param shown boolean +function C_TransmogCollection.SetUncollectedShown(shown) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogCollection.UpdateUsableAppearances) +function C_TransmogCollection.UpdateUsableAppearances() end + +---@class TransmogAppearanceInfoBySourceData +---@field appearanceID number +---@field appearanceIsCollected boolean +---@field sourceIsCollected boolean +---@field sourceIsCollectedPermanent boolean +---@field sourceIsCollectedConditional boolean +---@field meetsTransmogPlayerCondition boolean +---@field appearanceHasAnyNonLevelRequirements boolean +---@field appearanceMeetsNonLevelRequirements boolean +---@field appearanceIsUsable boolean +---@field appearanceNumSources number +---@field sourceIsKnown boolean +---@field canDisplayOnPlayer boolean +---@field isAnySourceValidForPlayer boolean + +---@class TransmogAppearanceJournalEncounterInfo +---@field instance string +---@field instanceType number +---@field tiers string[] +---@field encounter string +---@field difficulties string[] + +---@class TransmogAppearanceSourceInfoData +---@field category Enum.TransmogCollectionType +---@field itemAppearanceID number +---@field canHaveIllusion boolean +---@field icon fileID +---@field isCollected boolean +---@field itemLink string +---@field transmoglink string +---@field sourceType number? +---@field itemSubclass number +---@field ignoreModelAttachmentChecksForIllusion boolean + +---@class TransmogCategoryAppearanceInfo +---@field visualID number +---@field isCollected boolean +---@field isFavorite boolean +---@field isHideVisual boolean +---@field canDisplayOnPlayer boolean +---@field uiOrder number +---@field exclusions number +---@field isUsable boolean +---@field hasRequiredHoliday boolean +---@field hasActiveRequiredHoliday boolean +---@field alwaysShowItem boolean? + +---@class TransmogCategoryInfo +---@field name string +---@field isWeapon boolean? Default = false +---@field canHaveIllusions boolean? Default = false +---@field canMainHand boolean? Default = false +---@field canOffHand boolean? Default = false +---@field canRanged boolean? Default = false + +---@class TransmogCustomSetInfo +---@field name string +---@field icon fileID + +---@class TransmogIllusionInfo +---@field visualID number +---@field sourceID number +---@field icon fileID +---@field isCollected boolean +---@field isUsable boolean +---@field isHideVisual boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua new file mode 100644 index 0000000..912167e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua @@ -0,0 +1,386 @@ +---@meta _ +C_TransmogOutfitInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.AddNewOutfit) +---@param name string +---@param icon fileID +function C_TransmogOutfitInfo.AddNewOutfit(name, icon) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ChangeDisplayedOutfit) +---@param outfitID number +---@param trigger Enum.TransmogSituationTrigger +---@param toggleLock boolean +---@param allowRemoveOutfit boolean +function C_TransmogOutfitInfo.ChangeDisplayedOutfit(outfitID, trigger, toggleLock, allowRemoveOutfit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ChangeToOutfit) +---@param playerFacingOutfitIndex number +---@param allowRemoveOutfit boolean +function C_TransmogOutfitInfo.ChangeToOutfit(playerFacingOutfitIndex, allowRemoveOutfit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ChangeViewedOutfit) +---@param outfitID number +function C_TransmogOutfitInfo.ChangeViewedOutfit(outfitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ClearAllPendingSituations) +function C_TransmogOutfitInfo.ClearAllPendingSituations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ClearAllPendingTransmogs) +function C_TransmogOutfitInfo.ClearAllPendingTransmogs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ClearDisplayedOutfit) +---@param trigger Enum.TransmogSituationTrigger +---@param toggleLock boolean +function C_TransmogOutfitInfo.ClearDisplayedOutfit(trigger, toggleLock) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ClearOutfit) +function C_TransmogOutfitInfo.ClearOutfit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.CommitAndApplyAllPending) +---@param useAvailableDiscount boolean +function C_TransmogOutfitInfo.CommitAndApplyAllPending(useAvailableDiscount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.CommitOutfitInfo) +---@param outfitID number +---@param name string +---@param icon fileID +function C_TransmogOutfitInfo.CommitOutfitInfo(outfitID, name, icon) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.CommitPendingSituations) +function C_TransmogOutfitInfo.CommitPendingSituations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetActiveOutfitID) +---@return number outfitID +function C_TransmogOutfitInfo.GetActiveOutfitID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetAllSlotLocationInfo) +---@return TransmogOutfitSlotInfo[] appearanceSlotInfo +---@return TransmogOutfitSlotInfo[] illusionSlotInfo +function C_TransmogOutfitInfo.GetAllSlotLocationInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetAllTransmogOutfitOptionSheatheCategoryInfo) +---@param imaID number +---@return TransmogOutfitOptionSheatheCategoryInfo[] categoryInfo +function C_TransmogOutfitInfo.GetAllTransmogOutfitOptionSheatheCategoryInfo(imaID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetCollectionInfoForSlotAndOption) +---@param slot Enum.TransmogOutfitSlot +---@param weaponOption Enum.TransmogOutfitSlotOption +---@param collectionType Enum.TransmogCollectionType +---@return TransmogOutfitWeaponCollectionInfo collectionInfo +function C_TransmogOutfitInfo.GetCollectionInfoForSlotAndOption(slot, weaponOption, collectionType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetCurrentlyViewedOutfitID) +---@return number outfitID +function C_TransmogOutfitInfo.GetCurrentlyViewedOutfitID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetEquippedSlotOptionFromTransmogSlot) +---@param slot Enum.TransmogOutfitSlot +---@return Enum.TransmogOutfitSlotOption weaponOption +function C_TransmogOutfitInfo.GetEquippedSlotOptionFromTransmogSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetIllusionDefaultIMAIDForCollectionType) +---@param collectionType Enum.TransmogCollectionType +---@return number imaID +function C_TransmogOutfitInfo.GetIllusionDefaultIMAIDForCollectionType(collectionType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetItemModifiedAppearanceEffectiveCategory) +---@param imaID number +---@return Enum.TransmogCollectionType categoryID +function C_TransmogOutfitInfo.GetItemModifiedAppearanceEffectiveCategory(imaID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetLinkedSlotInfo) +---@param slot Enum.TransmogOutfitSlot +---@return TransmogOutfitLinkedSlotInfo linkedSlotInfo +function C_TransmogOutfitInfo.GetLinkedSlotInfo(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetMaxNumberOfTotalOutfitsForSource) +---@param source Enum.TransmogOutfitEntrySource +---@return number maxOutfitCount +function C_TransmogOutfitInfo.GetMaxNumberOfTotalOutfitsForSource(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetMaxNumberOfUsableOutfits) +---@return number maxOutfitCount +function C_TransmogOutfitInfo.GetMaxNumberOfUsableOutfits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetNextOutfitCost) +---@return BigUInteger outfitCost +function C_TransmogOutfitInfo.GetNextOutfitCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetNumberOfOutfitsUnlockedForSource) +---@param source Enum.TransmogOutfitEntrySource +---@return number unlockedOutfitCount +function C_TransmogOutfitInfo.GetNumberOfOutfitsUnlockedForSource(source) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetOutfitInfo) +---@param outfitID number +---@return TransmogOutfitEntryInfo outfitInfo +function C_TransmogOutfitInfo.GetOutfitInfo(outfitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetOutfitInfoByName) +---@param name string +---@return TransmogOutfitEntryInfo outfitInfo +function C_TransmogOutfitInfo.GetOutfitInfoByName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetOutfitInfoByPlayerFacingIndex) +---@param playerFacingOutfitIndex number +---@return TransmogOutfitEntryInfo outfitInfo +function C_TransmogOutfitInfo.GetOutfitInfoByPlayerFacingIndex(playerFacingOutfitIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetOutfitSituation) +---@param option TransmogSituationOption +---@return boolean value +function C_TransmogOutfitInfo.GetOutfitSituation(option) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetOutfitSituationsEnabled) +---@return boolean enabled +function C_TransmogOutfitInfo.GetOutfitSituationsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetOutfitsInfo) +---@return TransmogOutfitEntryInfo[] outfitsInfo +function C_TransmogOutfitInfo.GetOutfitsInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetPendingTransmogCost) +---@return BigUInteger cost +---@return number modifierFlags +function C_TransmogOutfitInfo.GetPendingTransmogCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetSecondarySlotState) +---@param slot Enum.TransmogOutfitSlot +---@return boolean state +function C_TransmogOutfitInfo.GetSecondarySlotState(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetSetSourcesForSlot) +---@param transmogSetID number +---@param slot Enum.TransmogOutfitSlot +---@return AppearanceSourceInfo[] sources +function C_TransmogOutfitInfo.GetSetSourcesForSlot(transmogSetID, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetSlotGroupInfo) +---@return TransmogOutfitSlotGroup[] slotGroups +function C_TransmogOutfitInfo.GetSlotGroupInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetSourceIDsForSlot) +---@param transmogSetID number +---@param slot Enum.TransmogOutfitSlot +---@return number[] sources +function C_TransmogOutfitInfo.GetSourceIDsForSlot(transmogSetID, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetTransmogOutfitSlotForInventoryType) +---@param inventoryType number +---@return Enum.TransmogOutfitSlot slot +function C_TransmogOutfitInfo.GetTransmogOutfitSlotForInventoryType(inventoryType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetTransmogOutfitSlotFromInventorySlot) +---@param inventorySlot InventorySlots +---@return Enum.TransmogOutfitSlot slot +function C_TransmogOutfitInfo.GetTransmogOutfitSlotFromInventorySlot(inventorySlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetUISituationCategoriesAndOptions) +---@return TransmogSituationCategory[] categoryData +function C_TransmogOutfitInfo.GetUISituationCategoriesAndOptions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetUnassignedAtlasForSlot) +---@param slot Enum.TransmogOutfitSlot +---@return textureAtlas atlas +function C_TransmogOutfitInfo.GetUnassignedAtlasForSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetUnassignedDisplayAtlasForSlot) +---@param slot Enum.TransmogOutfitSlot +---@return textureAtlas atlas +function C_TransmogOutfitInfo.GetUnassignedDisplayAtlasForSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetViewedOutfitSlotInfo) +---@param slot Enum.TransmogOutfitSlot +---@param type Enum.TransmogType +---@param option Enum.TransmogOutfitSlotOption +---@return ViewedTransmogOutfitSlotInfo slotInfo +function C_TransmogOutfitInfo.GetViewedOutfitSlotInfo(slot, type, option) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.GetWeaponOptionsForSlot) +---@param slot Enum.TransmogOutfitSlot +---@return TransmogOutfitWeaponOptionInfo[] weaponOptions +---@return TransmogOutfitWeaponOptionInfo[]? artifactOptions +function C_TransmogOutfitInfo.GetWeaponOptionsForSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.HasPendingOutfitSituations) +---@return boolean hasPending +function C_TransmogOutfitInfo.HasPendingOutfitSituations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.HasPendingOutfitTransmogs) +---@return boolean hasPending +function C_TransmogOutfitInfo.HasPendingOutfitTransmogs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.InTransmogEvent) +---@return boolean inTransmogEvent +function C_TransmogOutfitInfo.InTransmogEvent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.IsEquippedGearOutfitDisplayed) +---@return boolean isDisplayed +function C_TransmogOutfitInfo.IsEquippedGearOutfitDisplayed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.IsEquippedGearOutfitLocked) +---@return boolean isLocked +function C_TransmogOutfitInfo.IsEquippedGearOutfitLocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.IsLockedOutfit) +---@param outfitID number +---@return boolean isLocked +function C_TransmogOutfitInfo.IsLockedOutfit(outfitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.IsSlotWeaponSlot) +---@param slot Enum.TransmogOutfitSlot +---@return boolean isWeaponSlot +function C_TransmogOutfitInfo.IsSlotWeaponSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.IsUsableDiscountAvailable) +---@return boolean isAvailable +function C_TransmogOutfitInfo.IsUsableDiscountAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.IsValidTransmogOutfitName) +---@param name string +---@return boolean isApproved +function C_TransmogOutfitInfo.IsValidTransmogOutfitName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.PickupOutfit) +---@param outfitID number +function C_TransmogOutfitInfo.PickupOutfit(outfitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.ResetOutfitSituations) +function C_TransmogOutfitInfo.ResetOutfitSituations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.RevertPendingTransmog) +---@param slot Enum.TransmogOutfitSlot +---@param type Enum.TransmogType +---@param option Enum.TransmogOutfitSlotOption +function C_TransmogOutfitInfo.RevertPendingTransmog(slot, type, option) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetOutfitSituationsEnabled) +---@param enabled boolean +function C_TransmogOutfitInfo.SetOutfitSituationsEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetOutfitToCustomSet) +---@param transmogCustomSetID number +function C_TransmogOutfitInfo.SetOutfitToCustomSet(transmogCustomSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetOutfitToOutfit) +---@param outfitID number +function C_TransmogOutfitInfo.SetOutfitToOutfit(outfitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetOutfitToSet) +---@param transmogSetID number +function C_TransmogOutfitInfo.SetOutfitToSet(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetPendingTransmog) +---@param slot Enum.TransmogOutfitSlot +---@param type Enum.TransmogType +---@param option Enum.TransmogOutfitSlotOption +---@param transmogID number +---@param displayType Enum.TransmogOutfitDisplayType +function C_TransmogOutfitInfo.SetPendingTransmog(slot, type, option, transmogID, displayType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetPendingTransmogSheatheCategory) +---@param slot Enum.TransmogOutfitSlot +---@param option Enum.TransmogOutfitSlotOption +---@param category Enum.TransmogOutfitSlotOptionSheatheCategory +function C_TransmogOutfitInfo.SetPendingTransmogSheatheCategory(slot, option, category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetSecondarySlotState) +---@param slot Enum.TransmogOutfitSlot +---@param state boolean +function C_TransmogOutfitInfo.SetSecondarySlotState(slot, state) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SetViewedWeaponOptionForSlot) +---@param slot Enum.TransmogOutfitSlot +---@param weaponOption Enum.TransmogOutfitSlotOption +function C_TransmogOutfitInfo.SetViewedWeaponOptionForSlot(slot, weaponOption) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.SlotHasSecondary) +---@param slot Enum.TransmogOutfitSlot +---@return boolean hasSecondary +function C_TransmogOutfitInfo.SlotHasSecondary(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.TransmogEventActive) +---@return boolean transmogEventActive +function C_TransmogOutfitInfo.TransmogEventActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogOutfitInfo.UpdatePendingSituation) +---@param option TransmogSituationOption +---@param value boolean +function C_TransmogOutfitInfo.UpdatePendingSituation(option, value) end + +---@class TransmogOutfitEntryInfo +---@field outfitID number +---@field name string +---@field situationCategories string[] +---@field icon fileID +---@field isEventOutfit boolean +---@field isDisabled boolean +---@field playerFacingOutfitIndex number + +---@class TransmogOutfitLinkedSlotInfo +---@field primarySlotInfo TransmogOutfitSlotInfo +---@field secondarySlotInfo TransmogOutfitSlotInfo + +---@class TransmogOutfitOptionSheatheCategoryInfo +---@field sheatheCategory Enum.TransmogOutfitSlotOptionSheatheCategory +---@field categoryName string + +---@class TransmogOutfitSlotGroup +---@field position Enum.TransmogOutfitSlotPosition +---@field appearanceSlotInfo TransmogOutfitSlotInfo[] +---@field illusionSlotInfo TransmogOutfitSlotInfo[] + +---@class TransmogOutfitSlotInfo +---@field slot Enum.TransmogOutfitSlot +---@field type Enum.TransmogType +---@field collectionType Enum.TransmogCollectionType +---@field slotName string +---@field isSecondary boolean + +---@class TransmogOutfitWeaponCollectionInfo +---@field name string +---@field isWeapon boolean +---@field canHaveIllusions boolean + +---@class TransmogOutfitWeaponOptionInfo +---@field weaponOption Enum.TransmogOutfitSlotOption +---@field name string +---@field enabled boolean + +---@class TransmogSituationCategory +---@field triggerID number +---@field name string +---@field description string +---@field isRadioButton boolean +---@field groupData TransmogSituationGroup[] + +---@class TransmogSituationGroup +---@field groupID number +---@field secondaryID number +---@field optionData TransmogSituationOptionData[] + +---@class TransmogSituationOption +---@field situationID number +---@field specID number +---@field loadoutID number +---@field equipmentSetID number + +---@class TransmogSituationOptionData +---@field name string +---@field value boolean +---@field option TransmogSituationOption + +---@class ViewedTransmogOutfitSlotInfo +---@field transmogID number +---@field displayType Enum.TransmogOutfitDisplayType +---@field isTransmogrified boolean +---@field hasPending boolean +---@field isPendingCollected boolean +---@field canTransmogrify boolean +---@field warning Enum.TransmogOutfitSlotWarning +---@field warningText string +---@field error Enum.TransmogOutfitSlotError +---@field errorText string +---@field texture fileID? +---@field sheatheCategory Enum.TransmogOutfitSlotOptionSheatheCategory diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua new file mode 100644 index 0000000..03515a6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua @@ -0,0 +1,215 @@ +---@meta _ +C_TransmogSets = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.ClearLatestSource) +function C_TransmogSets.ClearLatestSource() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.ClearNewSource) +---@param sourceID number +function C_TransmogSets.ClearNewSource(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.ClearSetNewSourcesForSlot) +---@param transmogSetID number +---@param slot number +function C_TransmogSets.ClearSetNewSourcesForSlot(transmogSetID, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetAllSets) +---@return TransmogSetInfo[] sets +function C_TransmogSets.GetAllSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetAllSourceIDs) +---@param transmogSetID number +---@return number[] sources +function C_TransmogSets.GetAllSourceIDs(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetAvailableSets) +---@return TransmogSetInfo[] sets +function C_TransmogSets.GetAvailableSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetBaseSetID) +---@param transmogSetID number +---@return number baseTransmogSetID +function C_TransmogSets.GetBaseSetID(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetBaseSets) +---@return TransmogSetInfo[] sets +function C_TransmogSets.GetBaseSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetBaseSetsFilter) +---@param index number +---@return boolean isChecked +function C_TransmogSets.GetBaseSetsFilter(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetCameraIDs) +---@return number? detailsCameraID +---@return number? vendorCameraID +function C_TransmogSets.GetCameraIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetFilteredBaseSetsCounts) +---@return number numCollected +---@return number numTotal +function C_TransmogSets.GetFilteredBaseSetsCounts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetFullBaseSetsCounts) +---@return number numCollected +---@return number numTotal +function C_TransmogSets.GetFullBaseSetsCounts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetIsFavorite) +---@param transmogSetID number +---@return boolean isFavorite +---@return boolean isGroupFavorite +function C_TransmogSets.GetIsFavorite(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetLatestSource) +---@return number sourceID +function C_TransmogSets.GetLatestSource() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSetInfo) +---@param transmogSetID number +---@return TransmogSetInfo set +function C_TransmogSets.GetSetInfo(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSetNewSources) +---@param transmogSetID number +---@return number[] sourceIDs +function C_TransmogSets.GetSetNewSources(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSetPrimaryAppearances) +---@param transmogSetID number +---@return TransmogSetPrimaryAppearanceInfo[] apppearances +function C_TransmogSets.GetSetPrimaryAppearances(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSetsContainingSourceID) +---@param sourceID number +---@return number[] setIDs +function C_TransmogSets.GetSetsContainingSourceID(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSetsFilter) +---@param index number +---@return boolean isChecked +function C_TransmogSets.GetSetsFilter(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSourceIDsForSlot) +---@param transmogSetID number +---@param slot number +---@return number[] sources +function C_TransmogSets.GetSourceIDsForSlot(transmogSetID, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetSourcesForSlot) +---@param transmogSetID number +---@param slot number +---@return AppearanceSourceInfo[] sources +function C_TransmogSets.GetSourcesForSlot(transmogSetID, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetTransmogSetsClassFilter) +---@return number classID +function C_TransmogSets.GetTransmogSetsClassFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetUsableSets) +---@return TransmogSetInfo[] sets +function C_TransmogSets.GetUsableSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetValidBaseSetsCountsForCharacter) +---@return number numCollected +---@return number numTotal +function C_TransmogSets.GetValidBaseSetsCountsForCharacter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetValidClassForSet) +---@param transmogSetID number +---@return number? classID +function C_TransmogSets.GetValidClassForSet(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.GetVariantSets) +---@param transmogSetID number +---@return TransmogSetInfo[] sets +function C_TransmogSets.GetVariantSets(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.HasAvailableSets) +---@return boolean hasAvailableSets +function C_TransmogSets.HasAvailableSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.HasUsableSets) +---@return boolean hasUsableSets +function C_TransmogSets.HasUsableSets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.IsBaseSetCollected) +---@param transmogSetID number +---@return boolean isCollected +function C_TransmogSets.IsBaseSetCollected(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.IsNewSource) +---@param sourceID number +---@return boolean isNew +function C_TransmogSets.IsNewSource(sourceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.IsSetVisible) +---@param transmogSetID number +---@return boolean isVisible +function C_TransmogSets.IsSetVisible(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.IsUsingDefaultBaseSetsFilters) +---@return boolean isUsingDefaultBaseSetsFilters +function C_TransmogSets.IsUsingDefaultBaseSetsFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.IsUsingDefaultSetsFilters) +---@return boolean isUsingDefaultSetsFilters +function C_TransmogSets.IsUsingDefaultSetsFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetBaseSetsFilter) +---@param index number +---@param isChecked boolean +function C_TransmogSets.SetBaseSetsFilter(index, isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetDefaultBaseSetsFilters) +function C_TransmogSets.SetDefaultBaseSetsFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetDefaultSetsFilters) +function C_TransmogSets.SetDefaultSetsFilters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetHasNewSources) +---@param transmogSetID number +---@return boolean hasNewSources +function C_TransmogSets.SetHasNewSources(transmogSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetHasNewSourcesForSlot) +---@param transmogSetID number +---@param slot number +---@return boolean hasNewSources +function C_TransmogSets.SetHasNewSourcesForSlot(transmogSetID, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetIsFavorite) +---@param transmogSetID number +---@param isFavorite boolean +function C_TransmogSets.SetIsFavorite(transmogSetID, isFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetSetsFilter) +---@param index number +---@param isChecked boolean +function C_TransmogSets.SetSetsFilter(index, isChecked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TransmogSets.SetTransmogSetsClassFilter) +---@param classID number +function C_TransmogSets.SetTransmogSetsClassFilter(classID) end + +---@class TransmogSetInfo +---@field setID number +---@field name string +---@field baseSetID number? +---@field description string? +---@field label string? +---@field expansionID number +---@field patchID number +---@field uiOrder number +---@field classMask number +---@field hiddenUntilCollected boolean +---@field requiredFaction string? +---@field collected boolean +---@field favorite boolean +---@field limitedTimeSet boolean +---@field validForCharacter boolean +---@field grantAsPrecedingVariant boolean + +---@class TransmogSetPrimaryAppearanceInfo +---@field appearanceID number +---@field collected boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua new file mode 100644 index 0000000..34bf735 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua @@ -0,0 +1,11 @@ +---@meta _ +C_Tutorial = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Tutorial.AbandonTutorialArea) +function C_Tutorial.AbandonTutorialArea() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Tutorial.GetCombatEventInfo) +function C_Tutorial.GetCombatEventInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Tutorial.ReturnToTutorialArea) +function C_Tutorial.ReturnToTutorialArea() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua new file mode 100644 index 0000000..a32b27a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +---@class UIButtonInfo +---@field normal textureAtlas +---@field pressed textureAtlas +---@field highlight textureAtlas +---@field icon textureAtlas +---@field useNormalAsHiglight boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua new file mode 100644 index 0000000..fa504bb --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_UIColor = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIColor.GetColors) +---@return DBColorExport[] colors +function C_UIColor.GetColors() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua new file mode 100644 index 0000000..c6bd0f2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua @@ -0,0 +1,4 @@ +---@meta _ +---@class DBColorExport +---@field baseTag string +---@field color colorRGBA diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua new file mode 100644 index 0000000..bdde195 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +C_EventToastManager = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventToastManager.GetLevelUpDisplayToastsFromLevel) +---@param level number +---@return EventToastInfo[] toastInfo +function C_EventToastManager.GetLevelUpDisplayToastsFromLevel(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventToastManager.GetNextToastToDisplay) +---@return EventToastInfo toastInfo +function C_EventToastManager.GetNextToastToDisplay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_EventToastManager.RemoveCurrentToast) +function C_EventToastManager.RemoveCurrentToast() end + +---@class EventToastInfo +---@field eventToastID number +---@field title string +---@field subtitle string +---@field instructionText string +---@field iconFileID fileID +---@field subIcon textureAtlas? +---@field link string +---@field qualityString string? +---@field quality number? +---@field eventType Enum.EventToastEventType +---@field displayType Enum.EventToastDisplayType +---@field uiTextureKit textureKit +---@field sortOrder number +---@field time number? +---@field uiWidgetSetID number? +---@field extraUiWidgetSetID number? +---@field titleTooltip string? +---@field subtitleTooltip string? +---@field titleTooltipUiWidgetSetID number? +---@field subtitleTooltipUiWidgetSetID number? +---@field hideDefaultAtlas boolean? +---@field showSoundKitID number? +---@field hideSoundKitID number? +---@field colorTint colorRGB? +---@field flags number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua new file mode 100644 index 0000000..3c61ad2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +C_FrameManager = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FrameManager.GetFrameVisibilityState) +---@param frameType Enum.UIFrameType +---@return boolean shouldShow +function C_FrameManager.GetFrameVisibilityState(frameType) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua new file mode 100644 index 0000000..fe61fb8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua @@ -0,0 +1,17 @@ +---@meta _ +C_GenericWidgetDisplay = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GenericWidgetDisplay.Acknowledge) +function C_GenericWidgetDisplay.Acknowledge() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_GenericWidgetDisplay.Close) +function C_GenericWidgetDisplay.Close() end + +---@class GenericWidgetDisplayFrameInfo +---@field uiWidgetSetID number? +---@field uiTextureKit textureKit? +---@field title string? +---@field frameWidth number +---@field frameHeight number +---@field extraButtonText string? +---@field closeButtonText string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua new file mode 100644 index 0000000..a978694 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua @@ -0,0 +1,23 @@ +---@meta _ +C_Macro = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Macro.GetMacroName) +---@param macroId number +---@return string? name +function C_Macro.GetMacroName(macroId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Macro.GetSelectedMacroIcon) +---@param macroId number +---@return fileID textureNum +function C_Macro.GetSelectedMacroIcon(macroId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Macro.RunMacroText) +---@param text string +---@param button string +function C_Macro.RunMacroText(text, button) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Macro.SetMacroExecuteLineCallback) +---@param cb MacroExecuteLineCallback +function C_Macro.SetMacroExecuteLineCallback(cb) end + +---@alias MacroExecuteLineCallback FunctionContainer|fun(macroLine: string) diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua new file mode 100644 index 0000000..460d613 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua @@ -0,0 +1,43 @@ +---@meta _ +C_UI = {} + +---True if any display attached has a notch. This does not mean the current view intersects the notch. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.DoesAnyDisplayHaveNotch) +---@return boolean notchPresent +function C_UI.DoesAnyDisplayHaveNotch() end + +---Region of screen left of screen notch. Zeros if no notch. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.GetTopLeftNotchSafeRegion) +---@return number left +---@return number right +---@return number top +---@return number bottom +function C_UI.GetTopLeftNotchSafeRegion() end + +---Region of screen right of screen notch. Zeros if no notch. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.GetTopRightNotchSafeRegion) +---@return number left +---@return number right +---@return number top +---@return number bottom +function C_UI.GetTopRightNotchSafeRegion() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.GetUIParent) +---@return SimpleFrame uiParent +function C_UI.GetUIParent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.GetWorldFrame) +---@return SimpleFrame worldFrame +function C_UI.GetWorldFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.Reload) +function C_UI.Reload() end + +---UIParent will shift down to avoid notch if true. This does not mean there is a notch. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UI.ShouldUIParentAvoidNotch) +---@return boolean willAvoidNotch +function C_UI.ShouldUIParentAvoidNotch() end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua new file mode 100644 index 0000000..1ccda8a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +---@class UIMapPinInfo +---@field button UIButtonInfo +---@field buttonSelected UIButtonInfo +---@field underlay textureAtlas +---@field outerGlow textureAtlas diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua new file mode 100644 index 0000000..97997fc --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua @@ -0,0 +1,90 @@ +---@meta _ +C_ModelInfo = {} + +---This function does nothing in public clients +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.AddActiveModelScene) +---@param modelSceneFrame ModelSceneFrame +---@param modelSceneID number +function C_ModelInfo.AddActiveModelScene(modelSceneFrame, modelSceneID) end + +---This function does nothing in public clients +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.AddActiveModelSceneActor) +---@param modelSceneFrameActor ModelSceneFrameActor +---@param modelSceneActorID number +function C_ModelInfo.AddActiveModelSceneActor(modelSceneFrameActor, modelSceneActorID) end + +---This function does nothing in public clients +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.ClearActiveModelScene) +---@param modelSceneFrame ModelSceneFrame +function C_ModelInfo.ClearActiveModelScene(modelSceneFrame) end + +---This function does nothing in public clients +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.ClearActiveModelSceneActor) +---@param modelSceneFrameActor ModelSceneFrameActor +function C_ModelInfo.ClearActiveModelSceneActor(modelSceneFrameActor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.GetModelSceneActorDisplayInfoByID) +---@param modelActorDisplayID number +---@return UIModelSceneActorDisplayInfo actorDisplayInfo +function C_ModelInfo.GetModelSceneActorDisplayInfoByID(modelActorDisplayID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.GetModelSceneActorInfoByID) +---@param modelActorID number +---@return UIModelSceneActorInfo actorInfo +function C_ModelInfo.GetModelSceneActorInfoByID(modelActorID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.GetModelSceneCameraInfoByID) +---@param modelSceneCameraID number +---@return UIModelSceneCameraInfo modelSceneCameraInfo +function C_ModelInfo.GetModelSceneCameraInfoByID(modelSceneCameraID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModelInfo.GetModelSceneInfoByID) +---@param modelSceneID number +---@return Enum.ModelSceneType modelSceneType +---@return number[] modelCameraIDs +---@return number[] modelActorsIDs +---@return number flags +function C_ModelInfo.GetModelSceneInfoByID(modelSceneID) end + +---@class UIModelSceneActorDisplayInfo +---@field animation number +---@field animationVariation number +---@field animSpeed number +---@field animationKitID number? +---@field spellVisualKitID number? +---@field alpha number +---@field scale number + +---@class UIModelSceneActorInfo +---@field modelActorID number +---@field scriptTag string +---@field position vector3 +---@field yaw number +---@field pitch number +---@field roll number +---@field normalizeScaleAggressiveness number? +---@field useCenterForOriginX boolean +---@field useCenterForOriginY boolean +---@field useCenterForOriginZ boolean +---@field modelActorDisplayID number? + +---@class UIModelSceneCameraInfo +---@field modelSceneCameraID number +---@field scriptTag string +---@field cameraType string +---@field target vector3 +---@field yaw number +---@field pitch number +---@field roll number +---@field zoomDistance number +---@field minZoomDistance number +---@field maxZoomDistance number +---@field zoomedTargetOffset vector3 +---@field zoomedYawOffset number +---@field zoomedPitchOffset number +---@field zoomedRollOffset number +---@field flags Enum.ModelSceneSetting diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua new file mode 100644 index 0000000..1569d6b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua @@ -0,0 +1,15 @@ +---@meta _ +C_ModifiedInstance = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ModifiedInstance.GetModifiedInstanceInfoFromMapID) +---@param mapID number +---@return ModifiedInstanceInfo info +function C_ModifiedInstance.GetModifiedInstanceInfoFromMapID(mapID) end + +---@class ModifiedInstanceInfo +---@field lfrItemLevel number? +---@field normalItemLevel number? +---@field heroicItemLevel number? +---@field mythicItemLevel number? +---@field uiTextureKit textureKit +---@field description string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua new file mode 100644 index 0000000..8e952dd --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +---@class AnchorBinding +---@field point FramePoint +---@field relativeTo ScriptRegion +---@field relativePoint FramePoint +---@field offsetX uiUnit +---@field offsetY uiUnit + +---@class uiBoundsRect +---@field left uiUnit +---@field bottom uiUnit +---@field width uiUnit +---@field height uiUnit diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua new file mode 100644 index 0000000..ae71937 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +C_SystemVisibilityManager = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SystemVisibilityManager.IsSystemVisible) +---@param system Enum.UISystemType +---@return boolean visible +function C_SystemVisibilityManager.IsSystemVisible(system) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua new file mode 100644 index 0000000..86c5f12 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua @@ -0,0 +1,7 @@ +---@meta _ +---@class UITextureSliceData +---@field marginLeft number +---@field marginTop number +---@field marginRight number +---@field marginBottom number +---@field sliceMode Enum.UITextureSliceMode diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua new file mode 100644 index 0000000..527b4f7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua @@ -0,0 +1,25 @@ +---@meta _ +---@diagnostic disable: duplicate-doc-alias +C_Timer = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Timer.After) +---@param seconds number +---@param callback TimerCallback +function C_Timer.After(seconds, callback) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Timer.NewTicker) +---@param seconds number +---@param callback TickerCallback +---@param iterations? number +---@return FunctionContainer cbObject +function C_Timer.NewTicker(seconds, callback, iterations) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Timer.NewTimer) +---@param seconds number +---@param callback TickerCallback +---@return FunctionContainer cbObject +function C_Timer.NewTimer(seconds, callback) end + +---@alias TickerCallback FunctionContainer|fun(cb: FunctionContainer) + +---@alias TimerCallback FunctionContainer|fun(cb: FunctionContainer) diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua new file mode 100644 index 0000000..b15ba76 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua @@ -0,0 +1,981 @@ +---@meta _ +C_UIWidgetManager = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetAllWidgetsBySetID) +---@param setID number +---@return UIWidgetInfo[] widgets +function C_UIWidgetManager.GetAllWidgetsBySetID(setID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetBelowMinimapWidgetSetID) +---@return number setID +function C_UIWidgetManager.GetBelowMinimapWidgetSetID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo) +---@param widgetID number +---@return BulletTextListWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetButtonHeaderWidgetVisualizationInfo) +---@param widgetID number +---@return ButtonHeaderWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetButtonHeaderWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo) +---@param widgetID number +---@return CaptureBarWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetCaptureZoneVisualizationInfo) +---@param widgetID number +---@return CaptureZoneVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetCaptureZoneVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo) +---@param widgetID number +---@return DiscreteProgressStepsVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo) +---@param widgetID number +---@return DoubleIconAndTextWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo) +---@param widgetID number +---@return DoubleStateIconRowVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo) +---@param widgetID number +---@return DoubleStatusBarWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo) +---@param widgetID number +---@return FillUpFramesWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo) +---@param widgetID number +---@return HorizontalCurrenciesWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo) +---@param widgetID number +---@return IconAndTextWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo) +---@param widgetID number +---@return IconTextAndBackgroundWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo) +---@param widgetID number +---@return IconTextAndCurrenciesWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetItemDisplayVisualizationInfo) +---@param widgetID number +---@return ItemDisplayVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetItemDisplayVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetMapPinAnimationWidgetVisualizationInfo) +---@param widgetID number +---@return MapPinAnimationWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetMapPinAnimationWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetObjectiveTrackerWidgetSetID) +---@return number setID +function C_UIWidgetManager.GetObjectiveTrackerWidgetSetID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetPowerBarWidgetSetID) +---@return number setID +function C_UIWidgetManager.GetPowerBarWidgetSetID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetPreyHuntProgressWidgetVisualizationInfo) +---@param widgetID number +---@return PreyHuntProgressWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetPreyHuntProgressWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo) +---@param widgetID number +---@return ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetScenarioHeaderDelvesWidgetVisualizationInfo) +---@param widgetID number +---@return ScenarioHeaderDelvesWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetScenarioHeaderDelvesWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo) +---@param widgetID number +---@return ScenarioHeaderTimerWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetSpacerVisualizationInfo) +---@param widgetID number +---@return SpacerVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetSpacerVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetSpellDisplayVisualizationInfo) +---@param widgetID number +---@return SpellDisplayVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetSpellDisplayVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo) +---@param widgetID number +---@return StackedResourceTrackerWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo) +---@param widgetID number +---@return StatusBarWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTextColumnRowVisualizationInfo) +---@param widgetID number +---@return TextColumnRowVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTextColumnRowVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo) +---@param widgetID number +---@return TextWithStateWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo) +---@param widgetID number +---@return TextWithSubtextWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo) +---@param widgetID number +---@return TextureAndTextRowVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTextureAndTextVisualizationInfo) +---@param widgetID number +---@return TextureAndTextVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTextureAndTextVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo) +---@param widgetID number +---@return TextureWithAnimationVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTopCenterWidgetSetID) +---@return number setID +function C_UIWidgetManager.GetTopCenterWidgetSetID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetTugOfWarWidgetVisualizationInfo) +---@param widgetID number +---@return TugOfWarWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetTugOfWarWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo) +---@param widgetID number +---@return UnitPowerBarWidgetVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetWidgetSetInfo) +---@param widgetSetID number +---@return UIWidgetSetInfo widgetSetInfo +function C_UIWidgetManager.GetWidgetSetInfo(widgetSetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.GetZoneControlVisualizationInfo) +---@param widgetID number +---@return ZoneControlVisualizationInfo? widgetInfo +function C_UIWidgetManager.GetZoneControlVisualizationInfo(widgetID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.RegisterUnitForWidgetUpdates) +---@param unitToken string +---@param isGuid? boolean Default = false +function C_UIWidgetManager.RegisterUnitForWidgetUpdates(unitToken, isGuid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.SetProcessingUnit) +---@param unit? UnitToken +function C_UIWidgetManager.SetProcessingUnit(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.SetProcessingUnitGuid) +---@param unit? WOWGUID +function C_UIWidgetManager.SetProcessingUnitGuid(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UIWidgetManager.UnregisterUnitForWidgetUpdates) +---@param unitToken string +---@param isGuid? boolean Default = false +function C_UIWidgetManager.UnregisterUnitForWidgetUpdates(unitToken, isGuid) end + +---@class BulletTextListWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field enabledState Enum.WidgetEnabledState +---@field lines string[] +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ButtonHeaderWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field headerText string +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field buttons UIWidgetSpellButtonInfo[] +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class CaptureBarWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field barValue number +---@field barMinValue number +---@field barMaxValue number +---@field neutralZoneSize number +---@field neutralZoneCenter number +---@field tooltip string +---@field glowAnimType Enum.WidgetGlowAnimType +---@field fillDirectionType Enum.CaptureBarWidgetFillDirectionType +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class CaptureZoneVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field mode Enum.ZoneControlMode +---@field leadingEdgeType Enum.ZoneControlLeadingEdgeType +---@field dangerFlashType Enum.ZoneControlDangerFlashType +---@field zoneInfo ZoneEntry +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class DiscreteProgressStepsVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field tooltip string +---@field progressMin number +---@field progressMax number +---@field progressVal number +---@field numSteps number +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class DoubleIconAndTextWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field label string +---@field leftText string +---@field leftTooltip string +---@field rightText string +---@field rightTooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class DoubleStateIconRowVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field leftIcons UIWidgetStateIconInfo[] +---@field rightIcons UIWidgetStateIconInfo[] +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class DoubleStatusBarWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field leftBarMin number +---@field leftBarMax number +---@field leftBarValue number +---@field leftBarTooltip string +---@field rightBarMin number +---@field rightBarMax number +---@field rightBarValue number +---@field rightBarTooltip string +---@field barValueTextType Enum.StatusBarValueTextType +---@field text string +---@field leftBarTooltipLoc Enum.UIWidgetTooltipLocation +---@field rightBarTooltipLoc Enum.UIWidgetTooltipLocation +---@field fillMotionType Enum.UIWidgetMotionType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class FillUpFramesWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field fillMin number +---@field fillMax number +---@field fillValue number +---@field numTotalFrames number +---@field numFullFrames number +---@field pulseFillingFrame boolean +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class HorizontalCurrenciesWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field currencies UIWidgetCurrencyInfo[] +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class IconAndTextWidgetVisualizationInfo +---@field state Enum.IconAndTextWidgetState +---@field text string +---@field tooltip string +---@field dynamicTooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field shiftTextType Enum.IconAndTextShiftTextType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class IconTextAndBackgroundWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field text string +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class IconTextAndCurrenciesWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field enabledState Enum.WidgetEnabledState +---@field descriptionShownState Enum.WidgetShownState +---@field descriptionEnabledState Enum.WidgetEnabledState +---@field text string +---@field description string +---@field currencies UIWidgetCurrencyInfo[] +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ItemDisplayVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field itemInfo UIWidgetItemInfo +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class MapPinAnimationWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field animType Enum.MapPinAnimationType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class PreyHuntProgressWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field progressState Enum.PreyHuntProgressState +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field currencies UIWidgetCurrencyInfo[] +---@field headerText string +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ScenarioHeaderDelvesWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field headerText string +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field tierText string +---@field tierTooltipSpellID number? +---@field currencies UIWidgetCurrencyInfo[] +---@field spells UIWidgetSpellInfo[] +---@field rewardInfo UIWidgetRewardInfo +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ScenarioHeaderTimerWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field timerMin number +---@field timerMax number +---@field timerValue number +---@field headerText string +---@field timerTooltip string +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class SpacerVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field widgetWidth number +---@field widgetHeight number +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class SpellDisplayVisualizationInfo +---@field spellInfo UIWidgetSpellInfo +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class StackedResourceTrackerWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field resources UIWidgetCurrencyInfo[] +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class StatusBarWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field barMin number +---@field barMax number +---@field barValue number +---@field text string +---@field tooltip string +---@field barValueTextType Enum.StatusBarValueTextType +---@field overrideBarText string +---@field overrideBarTextShownType Enum.StatusBarOverrideBarTextShownType +---@field colorTint Enum.StatusBarColorTintValue +---@field partitionValues number[] +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field fillMotionType Enum.UIWidgetMotionType +---@field barTextEnabledState Enum.WidgetEnabledState +---@field barTextFontType Enum.UIWidgetFontType +---@field barTextSizeType Enum.UIWidgetTextSizeType +---@field textEnabledState Enum.WidgetEnabledState +---@field textFontType Enum.UIWidgetFontType +---@field textSizeType Enum.UIWidgetTextSizeType +---@field glowAnimType Enum.WidgetGlowAnimType +---@field showGlowState Enum.WidgetShowGlowState +---@field fillMinOpacity Enum.WidgetOpacityType +---@field fillMaxOpacity Enum.WidgetOpacityType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class TextColumnRowEntryInfo +---@field text string +---@field enabledState Enum.WidgetEnabledState +---@field hAlign Enum.WidgetTextHorizontalAlignmentType +---@field columnWidth number + +---@class TextColumnRowVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field entries TextColumnRowEntryInfo[] +---@field textSizeType Enum.UIWidgetTextSizeType +---@field fontType Enum.UIWidgetFontType +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field bottomPadding number +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class TextWithStateWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field enabledState Enum.WidgetEnabledState +---@field text string +---@field tooltip string +---@field textSizeType Enum.UIWidgetTextSizeType +---@field fontType Enum.UIWidgetFontType +---@field bottomPadding number +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field hAlign Enum.WidgetTextHorizontalAlignmentType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class TextWithSubtextWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field enabledState Enum.WidgetEnabledState +---@field text string +---@field widgetWidth number +---@field tooltip string +---@field textSizeType Enum.UIWidgetTextSizeType +---@field fontType Enum.UIWidgetFontType +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field hAlign Enum.WidgetTextHorizontalAlignmentType +---@field subText string +---@field subTextSizeType Enum.UIWidgetTextSizeType +---@field subTextFontType Enum.UIWidgetFontType +---@field subTextHAlign Enum.WidgetTextHorizontalAlignmentType +---@field subTextEnabledState Enum.WidgetEnabledState +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number +---@field spacing number + +---@class TextureAndTextEntryInfo +---@field text string +---@field tooltip string + +---@class TextureAndTextRowVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field entries TextureAndTextEntryInfo[] +---@field textSizeType Enum.UIWidgetTextureAndTextSizeType +---@field groupAlignment Enum.UIWidgetHorizontalDirection +---@field fixedWidth number? +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class TextureAndTextVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field text string +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field textSizeType Enum.UIWidgetTextureAndTextSizeType +---@field textFormatType Enum.UIWidgetTextFormatType +---@field updateAnimType Enum.UIWidgetUpdateAnimType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class TextureWithAnimationVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class TugOfWarWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field minValue number +---@field maxValue number +---@field currentValue number +---@field neutralZoneCenter number +---@field neutralZoneSize number +---@field leftIconInfo UIWidgetIconInfo +---@field rightIconInfo UIWidgetIconInfo +---@field glowAnimType Enum.WidgetGlowAnimType +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field neutralFillStyle Enum.TugOfWarStyleValue +---@field markerArrowShownState Enum.TugOfWarMarkerArrowShownState +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class UIWidgetCurrencyInfo +---@field iconFileID fileID +---@field leadingText string +---@field text string +---@field tooltip string +---@field isCurrencyMaxed boolean +---@field textFontType Enum.UIWidgetFontType +---@field textSizeType Enum.UIWidgetTextSizeType +---@field textEnabledState Enum.WidgetEnabledState +---@field iconSizeType Enum.WidgetIconSizeType +---@field updateAnimType Enum.UIWidgetUpdateAnimType + +---@class UIWidgetIconInfo +---@field sourceType Enum.WidgetIconSourceType +---@field sourceID number +---@field sizeType Enum.WidgetIconSizeType +---@field tooltip string +---@field tooltipLoc Enum.UIWidgetTooltipLocation + +---@class UIWidgetInfo +---@field widgetID number +---@field widgetSetID number +---@field widgetType Enum.UIWidgetVisualizationType +---@field unitToken string? + +---@class UIWidgetItemInfo +---@field itemID number +---@field stackCount number? +---@field overrideItemName string? +---@field infoText string? +---@field overrideTooltip string? +---@field textDisplayStyle Enum.ItemDisplayTextDisplayStyle +---@field tooltipEnabled boolean +---@field iconSizeType Enum.WidgetIconSizeType +---@field infoTextEnabledState Enum.WidgetEnabledState +---@field showAsEarned boolean +---@field itemNameTextFontType Enum.UIWidgetFontType +---@field itemNameTextSizeType Enum.UIWidgetTextSizeType +---@field infoTextFontType Enum.UIWidgetFontType +---@field infoTextSizeType Enum.UIWidgetTextSizeType +---@field itemNameCustomColor Enum.WidgetEnabledState +---@field itemNameCustomColorOverrideState Enum.UIWidgetOverrideState + +---@class UIWidgetRewardInfo +---@field shownState Enum.UIWidgetRewardShownState +---@field earnedTooltip string +---@field unearnedTooltip string + +---@class UIWidgetSetInfo +---@field layoutDirection Enum.UIWidgetSetLayoutDirection +---@field verticalPadding number + +---@class UIWidgetSpellButtonInfo +---@field spellID number +---@field tooltip string +---@field icon Enum.UIWidgetButtonIconType +---@field enabledState Enum.UIWidgetButtonEnabledState +---@field cooldownType Enum.UIWidgetSpellButtonCooldownType + +---@class UIWidgetSpellInfo +---@field spellID number +---@field shownState Enum.WidgetShownState +---@field enabledState Enum.WidgetEnabledState +---@field tooltip string +---@field text string +---@field stackDisplay number +---@field iconSizeType Enum.WidgetIconSizeType +---@field iconDisplayType Enum.SpellDisplayIconDisplayType +---@field textShownState Enum.SpellDisplayTextShownStateType +---@field borderColor Enum.SpellDisplayBorderColor +---@field textFontType Enum.UIWidgetFontType +---@field textSizeType Enum.UIWidgetTextSizeType +---@field hAlignType Enum.WidgetTextHorizontalAlignmentType +---@field tint Enum.SpellDisplayTint +---@field showGlowState Enum.WidgetShowGlowState +---@field showAsEarned boolean + +---@class UIWidgetStateIconInfo +---@field iconState Enum.IconState +---@field state1Tooltip string +---@field state2Tooltip string + +---@class UIWidgetTextTooltipPair +---@field text string +---@field tooltip string + +---@class UnitPowerBarWidgetVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field barMin number +---@field barMax number +---@field barValue number +---@field tooltip string +---@field barValueTextType Enum.StatusBarValueTextType +---@field overrideBarText string +---@field overrideBarTextShownType Enum.StatusBarOverrideBarTextShownType +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field fillMotionType Enum.UIWidgetMotionType +---@field flashBlendModeType Enum.UIWidgetBlendModeType +---@field sparkBlendModeType Enum.UIWidgetBlendModeType +---@field flashMomentType Enum.WidgetUnitPowerBarFlashMomentType +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ZoneControlVisualizationInfo +---@field shownState Enum.WidgetShownState +---@field mode Enum.ZoneControlMode +---@field leadingEdgeType Enum.ZoneControlLeadingEdgeType +---@field dangerFlashType Enum.ZoneControlDangerFlashType +---@field zoneEntries ZoneEntry[] +---@field tooltipLoc Enum.UIWidgetTooltipLocation +---@field widgetSizeSetting number +---@field textureKit textureKit +---@field frameTextureKit textureKit +---@field hasTimer boolean +---@field orderIndex number +---@field widgetTag string +---@field inAnimType Enum.WidgetAnimationType +---@field outAnimType Enum.WidgetAnimationType +---@field widgetScale Enum.UIWidgetScale +---@field layoutDirection Enum.UIWidgetLayoutDirection +---@field modelSceneLayer Enum.UIWidgetModelSceneLayer +---@field scriptedAnimationEffectID number + +---@class ZoneEntry +---@field state Enum.ZoneControlState +---@field activeState Enum.ZoneControlActiveState +---@field fillType Enum.ZoneControlFillType +---@field min number +---@field max number +---@field current number +---@field capturePoint number +---@field tooltip string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/URLDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/URLDocumentation.lua new file mode 100644 index 0000000..ab2ac55 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/URLDocumentation.lua @@ -0,0 +1,9 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_LaunchURL) +---@param url string +function LaunchURL(url) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LoadURLIndex) +---@param index number +---@param param? number +function LoadURLIndex(index, param) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua new file mode 100644 index 0000000..ef075ea --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua @@ -0,0 +1,202 @@ +---@meta _ +C_UnitAuras = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.AddBlockedAura) +---@param unit UnitTokenRestrictedForAddOns +---@param auraInstanceID number +function C_UnitAuras.AddBlockedAura(unit, auraInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.AddPrivateAuraAnchor) +---@param args AddPrivateAuraAnchorArgs +---@return number? anchorID +function C_UnitAuras.AddPrivateAuraAnchor(args) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.AddPrivateAuraAppliedSound) +---@param sound UnitPrivateAuraAppliedSoundInfo +---@return number? privateAuraSoundID +function C_UnitAuras.AddPrivateAuraAppliedSound(sound) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.AuraIsBigDefensive) +---@param spellID SpellIdentifier +---@return boolean isBigDefensive +function C_UnitAuras.AuraIsBigDefensive(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.AuraIsPrivate) +---@param spellID SpellIdentifier +---@return boolean isPrivate +function C_UnitAuras.AuraIsPrivate(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.ClearBlockedAuras) +---@param unit UnitTokenRestrictedForAddOns +function C_UnitAuras.ClearBlockedAuras(unit) end + +---Returns true if an aura instance will expire after a certain amount of time. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.DoesAuraHaveExpirationTime) +---@param auraInstanceUnit UnitToken +---@param auraInstanceID number +---@return boolean hasExpirationTime +function C_UnitAuras.DoesAuraHaveExpirationTime(auraInstanceUnit, auraInstanceID) end + +---Formats a string for displaying the number of applications an aura has present. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraApplicationDisplayCount) +---@param auraInstanceUnit UnitToken +---@param auraInstanceID number +---@param minDisplayCount? number Default = 2 +---@param maxDisplayCount? number +---@return string count +function C_UnitAuras.GetAuraApplicationDisplayCount(auraInstanceUnit, auraInstanceID, minDisplayCount, maxDisplayCount) end + +---Returns the base duration of the given spell (or aura). Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraBaseDuration) +---@param auraInstanceUnit UnitToken +---@param auraInstanceID number +---@param spellID? SpellIdentifier +---@return number? newDuration +function C_UnitAuras.GetAuraBaseDuration(auraInstanceUnit, auraInstanceID, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraDataByAuraInstanceID) +---@param unit UnitTokenRestrictedForAddOns +---@param auraInstanceID number +---@return AuraData? aura +function C_UnitAuras.GetAuraDataByAuraInstanceID(unit, auraInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraDataByIndex) +---@param unit UnitTokenRestrictedForAddOns +---@param index number +---@param filter? AuraFilters +---@return AuraData? aura +function C_UnitAuras.GetAuraDataByIndex(unit, index, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraDataBySlot) +---@param unit UnitTokenRestrictedForAddOns +---@param slot number +---@return AuraData? aura +function C_UnitAuras.GetAuraDataBySlot(unit, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraDataBySpellName) +---@param unit UnitTokenRestrictedForAddOns +---@param spellName string +---@param filter? AuraFilters +---@return AuraData? aura +function C_UnitAuras.GetAuraDataBySpellName(unit, spellName, filter) end + +---Queries the dispel type associated with an aura instance and remaps it to a color via a curve, with the dispel type ID used as the 'x' value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraDispelTypeColor) +---@param auraInstanceUnit UnitToken +---@param auraInstanceID number +---@param curve LuaColorCurveObject +---@return colorRGBA dispelTypeColor +function C_UnitAuras.GetAuraDispelTypeColor(auraInstanceUnit, auraInstanceID, curve) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraDuration) +---@param auraInstanceUnit UnitToken +---@param auraInstanceID number +---@return LuaDurationObject duration +function C_UnitAuras.GetAuraDuration(auraInstanceUnit, auraInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetAuraSlots) +---@param unit UnitTokenRestrictedForAddOns +---@param filter? AuraFilters +---@param maxSlots? number +---@param continuationToken? number +---@return number? outContinuationToken +---@return number ... slots +function C_UnitAuras.GetAuraSlots(unit, filter, maxSlots, continuationToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetBuffDataByIndex) +---@param unit UnitTokenRestrictedForAddOns +---@param index number +---@param filter? AuraFilters +---@return AuraData? aura +function C_UnitAuras.GetBuffDataByIndex(unit, index, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetCooldownAuraBySpellID) +---@param spellID SpellIdentifier +---@return number? cooldownSpellID +function C_UnitAuras.GetCooldownAuraBySpellID(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetDebuffDataByIndex) +---@param unit UnitTokenRestrictedForAddOns +---@param index number +---@param filter? AuraFilters +---@return AuraData? aura +function C_UnitAuras.GetDebuffDataByIndex(unit, index, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetPlayerAuraBySpellID) +---@param spellID SpellIdentifier +---@return AuraData? aura +function C_UnitAuras.GetPlayerAuraBySpellID(spellID) end + +---Returns the client-predicted new duration of this aura if it were cast again right now. Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetRefreshExtendedDuration) +---@param auraInstanceUnit UnitToken +---@param auraInstanceID number +---@param spellID? SpellIdentifier +---@return number? newDuration +function C_UnitAuras.GetRefreshExtendedDuration(auraInstanceUnit, auraInstanceID, spellID) end + +---Returns the first instance of an aura on a unit matching a given spell ID. Returns nil if no such aura is found. Additionally can return nil if querying a unit that is not visible (eg. party members on other maps). +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetUnitAuraBySpellID) +---@param unit UnitTokenRestrictedForAddOns +---@param spellID SpellIdentifier +---@return AuraData? aura +function C_UnitAuras.GetUnitAuraBySpellID(unit, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetUnitAuraInstanceIDs) +---@param unit UnitTokenRestrictedForAddOns +---@param filter AuraFilters +---@param maxCount? number +---@param sortRule? Enum.UnitAuraSortRule Default = Unsorted +---@param sortDirection? Enum.UnitAuraSortDirection Default = Normal +---@return number[] auraInstanceIDs +function C_UnitAuras.GetUnitAuraInstanceIDs(unit, filter, maxCount, sortRule, sortDirection) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.GetUnitAuras) +---@param unit UnitTokenRestrictedForAddOns +---@param filter AuraFilters +---@param maxCount? number +---@param sortRule? Enum.UnitAuraSortRule Default = Unsorted +---@param sortDirection? Enum.UnitAuraSortDirection Default = Normal +---@return AuraData[] auras +function C_UnitAuras.GetUnitAuras(unit, filter, maxCount, sortRule, sortDirection) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.IsAuraFilteredOutByInstanceID) +---@param unit UnitTokenRestrictedForAddOns +---@param auraInstanceID number +---@param filter AuraFilters +---@return boolean isFiltered +function C_UnitAuras.IsAuraFilteredOutByInstanceID(unit, auraInstanceID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.RemovePrivateAuraAnchor) +---@param anchorID number +function C_UnitAuras.RemovePrivateAuraAnchor(anchorID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.RemovePrivateAuraAppliedSound) +---@param privateAuraSoundID number +function C_UnitAuras.RemovePrivateAuraAppliedSound(privateAuraSoundID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.ResetAuraDataProvider) +function C_UnitAuras.ResetAuraDataProvider() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.SetPrivateWarningTextAnchor) +---@param parent SimpleFrame +---@param anchor? AnchorBinding +function C_UnitAuras.SetPrivateWarningTextAnchor(parent, anchor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.SwitchAuraDataProvider) +function C_UnitAuras.SwitchAuraDataProvider() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.TriggerPrivateAuraShowDispelType) +---@param show boolean +function C_UnitAuras.TriggerPrivateAuraShowDispelType(show) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UnitAuras.WantsAlteredForm) +---@param unit UnitToken +---@return boolean wantsAlteredForm +function C_UnitAuras.WantsAlteredForm(unit) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua new file mode 100644 index 0000000..3cabe8c --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua @@ -0,0 +1,41 @@ +---@meta _ +---@class AddPrivateAuraAnchorArgs +---@field unitToken string +---@field auraIndex number +---@field parent SimpleFrame +---@field showCountdownFrame boolean +---@field showCountdownNumbers boolean +---@field isContainer boolean +---@field iconInfo PrivateAuraIconInfo? +---@field durationAnchor AnchorBinding? + +---@class PrivateAuraIconInfo +---@field iconAnchor AnchorBinding +---@field iconWidth uiUnit +---@field iconHeight uiUnit +---@field borderScale uiUnit? + +---@class UnitAuraUpdateInfo +---@field isFullUpdate boolean? Default = false +---@field removedAuraInstanceIDs number[]? +---@field addedAuras AuraData[]? +---@field updatedAuraInstanceIDs number[]? + +---@class UnitPrivateAuraAnchorInfo +---@field anchorID number +---@field unitToken string +---@field auraIndex number +---@field showCountdownFrame boolean +---@field showCountdownNumbers boolean +---@field iconWidth uiUnit? +---@field iconHeight uiUnit? +---@field borderScale uiUnit? +---@field isContainer boolean? +---@field parent SimpleFrame + +---@class UnitPrivateAuraAppliedSoundInfo +---@field unitToken string +---@field spellID number +---@field soundFileName string? +---@field soundFileID number? +---@field outputChannel string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua new file mode 100644 index 0000000..0fd40ff --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua @@ -0,0 +1,1292 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEjectPassengerFromSeat) +---@param virtualSeatIndex number +---@return boolean result +function CanEjectPassengerFromSeat(virtualSeatIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanSwitchVehicleSeat) +---@return boolean result +function CanSwitchVehicleSeat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClosestGameObjectPosition) +---@param gameObjectID number +---@return number xPos +---@return number yPos +---@return number distance +function ClosestGameObjectPosition(gameObjectID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClosestUnitPosition) +---@param creatureID number +---@return number xPos +---@return number yPos +---@return number distance +function ClosestUnitPosition(creatureID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateUnitHealPredictionCalculator) +---@return UnitHealPredictionCalculator healPredictionCalculator +function CreateUnitHealPredictionCalculator() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EjectPassengerFromSeat) +---@param virtualSeatIndex number +function EjectPassengerFromSeat(virtualSeatIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetComboPoints) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param target UnitTokenPvPRestrictedForAddOns +---@return number result +function GetComboPoints(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNegativeCorruptionEffectInfo) +---@return CorruptionEffectInfo[] corruptionEffects +function GetNegativeCorruptionEffectInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitChargedPowerPoints) +---@param unit UnitToken +---@return number[] pointIndices +function GetUnitChargedPowerPoints(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitEmpowerHoldAtMaxTime) +---@param unit UnitToken +---@return number holdAtMaxTime +function GetUnitEmpowerHoldAtMaxTime(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitEmpowerMinHoldTime) +---@param unit UnitToken +---@return number minHoldTime +function GetUnitEmpowerMinHoldTime(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitEmpowerStageDuration) +---@param unit UnitToken +---@param index number +---@return number duration +function GetUnitEmpowerStageDuration(unit, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitHealthModifier) +---@param unit UnitToken +---@return number result +function GetUnitHealthModifier(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitMaxHealthModifier) +---@param unit UnitToken +---@return number result +function GetUnitMaxHealthModifier(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerBarInfo) +---@param unitToken UnitToken +---@return UnitPowerBarInfo info +function GetUnitPowerBarInfo(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerBarInfoByID) +---@param barID number +---@return UnitPowerBarInfo info +function GetUnitPowerBarInfoByID(barID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerBarStrings) +---@param unitToken UnitToken +---@return string? name +---@return string? tooltip +---@return string? cost +function GetUnitPowerBarStrings(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerBarStringsByID) +---@param barID number +---@return string? name +---@return string? tooltip +---@return string? cost +function GetUnitPowerBarStringsByID(barID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerBarTextureInfo) +---@param unitToken UnitToken +---@param textureIndex number +---@param timerIndex? number +---@return fileID texture +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function GetUnitPowerBarTextureInfo(unitToken, textureIndex, timerIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerBarTextureInfoByID) +---@param barID number +---@param textureIndex number +---@return fileID texture +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function GetUnitPowerBarTextureInfoByID(barID, textureIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitPowerModifier) +---@param unit UnitToken +---@return number result +function GetUnitPowerModifier(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitSpeed) +---@param unit UnitToken +---@return number currentSpeed +---@return number runSpeed +---@return number flightSpeed +---@return number swimSpeed +function GetUnitSpeed(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetUnitTotalModifiedMaxHealthPercent) +---@param unit UnitToken +---@return number result +function GetUnitTotalModifiedMaxHealthPercent(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetVehicleUIIndicator) +---@param vehicleIndicatorID number +---@return fileID backgroundTextureID +---@return number numSeatIndicators +function GetVehicleUIIndicator(vehicleIndicatorID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetVehicleUIIndicatorSeat) +---@param vehicleIndicatorID number +---@param indicatorSeatIndex number +---@return number virtualSeatIndex +---@return number xPos +---@return number yPos +function GetVehicleUIIndicatorSeat(vehicleIndicatorID, indicatorSeatIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsFalling) +---@param unit? UnitToken +---@return boolean result +function IsFalling(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsFlying) +---@param unit? UnitToken +---@return boolean result +function IsFlying(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPlayerInGuildFromGUID) +---@param playerGUID WOWGUID +---@return boolean IsInGuild +function IsPlayerInGuildFromGUID(playerGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsSubmerged) +---@param unit? UnitToken +---@return boolean result +function IsSubmerged(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsSwimming) +---@param unit? UnitToken +---@return boolean result +function IsSwimming(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsUnitModelReadyForUI) +---@param unitToken UnitToken +---@return boolean isReady +function IsUnitModelReadyForUI(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerIsPVPInactive) +---@param unit UnitToken +---@return boolean result +function PlayerIsPVPInactive(unit) end + +---If the unit is currently casting a spell, returns whether spell's target unit is the player. Returns false if the unit is not casting a spell or the spell has no target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerIsSpellTarget) +---@param unit UnitToken +---@return boolean result +function PlayerIsSpellTarget(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerVehicleHasComboPoints) +---@return boolean vehicleHasComboPoints +function PlayerVehicleHasComboPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ReportPlayerIsPVPAFK) +---@param unit UnitToken +function ReportPlayerIsPVPAFK(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResistancePercent) +---@param resistance number +---@param casterLevel number +---@return number result +function ResistancePercent(resistance, casterLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPortraitTexture) +---@param textureObject SimpleTexture +---@param unitToken UnitToken +---@param disableMasking? boolean Default = false +function SetPortraitTexture(textureObject, unitToken, disableMasking) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPortraitTextureFromCreatureDisplayID) +---@param textureObject SimpleTexture +---@param creatureDisplayID number +function SetPortraitTextureFromCreatureDisplayID(textureObject, creatureDisplayID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetUnitCursorTexture) +---@param textureObject SimpleTexture +---@param unit UnitToken +---@param style? Enum.CursorStyle +---@param includeLowPriority? boolean +---@return boolean hasCursor +function SetUnitCursorTexture(textureObject, unit, style, includeLowPriority) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitAffectingCombat) +---@param unit UnitToken +---@return boolean result +function UnitAffectingCombat(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitAlliedRaceInfo) +---@param unit UnitToken +---@return boolean isAlliedRace +---@return boolean hasHeritageArmorUnlocked +function UnitAlliedRaceInfo(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitArmor) +---@param unit UnitToken +---@return number base +---@return number effective +---@return number real +---@return number bonus +function UnitArmor(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitAttackPower) +---@param unit UnitToken +---@return number attackPower +---@return number posBuff +---@return number negBuff +function UnitAttackPower(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitAttackSpeed) +---@param unit UnitToken +---@return number attackSpeed +---@return number? offhandAttackSpeed +function UnitAttackSpeed(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitBattlePetLevel) +---@param unit UnitToken +---@return number? result +function UnitBattlePetLevel(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitBattlePetSpeciesID) +---@param unit UnitToken +---@return number? result +function UnitBattlePetSpeciesID(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitBattlePetType) +---@param unit UnitToken +---@return number? result +function UnitBattlePetType(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCanAssist) +---@param unit UnitToken +---@param target UnitToken +---@return boolean result +function UnitCanAssist(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCanAttack) +---@param unit UnitToken +---@param target UnitToken +---@return boolean result +function UnitCanAttack(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCanCooperate) +---@param unit UnitToken +---@param target UnitToken +---@return boolean result +function UnitCanCooperate(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCanPetBattle) +---@param unit UnitToken +---@param target UnitToken +---@return boolean result +function UnitCanPetBattle(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCastingDuration) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return LuaDurationObject duration +function UnitCastingDuration(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCastingInfo) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return string name +---@return string displayName +---@return fileID textureID +---@return number startTimeMs +---@return number endTimeMs +---@return boolean isTradeskill +---@return WOWGUID castID +---@return boolean? notInterruptible +---@return number castingSpellID +---@return number? castBarID +---@return number delayTimeMs +function UnitCastingInfo(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitChannelDuration) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return LuaDurationObject duration +function UnitChannelDuration(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitChannelInfo) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return string name +---@return string displayName +---@return fileID textureID +---@return number startTimeMs +---@return number endTimeMs +---@return boolean isTradeskill +---@return boolean? notInterruptible +---@return number spellID +---@return boolean isEmpowered +---@return number numEmpowerStages +---@return number? castBarID +function UnitChannelInfo(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitChromieTimeID) +---@param unit UnitToken +---@return number ID +function UnitChromieTimeID(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitClass) +---@param unit UnitToken +---@return string className +---@return string classFilename +---@return number classID +function UnitClass(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitClassBase) +---@param unit UnitToken +---@return string classFilename +---@return number classID +function UnitClassBase(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitClassFromGUID) +---@param unitGUID WOWGUID +---@return string className +---@return string classFilename +---@return number classID +function UnitClassFromGUID(unitGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitClassification) +---@param unit UnitToken +---@return string result +function UnitClassification(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitControllingVehicle) +---@param unit UnitToken +---@return boolean result +function UnitControllingVehicle(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCreatureFamily) +---@param unit UnitToken +---@return string name +---@return number id +function UnitCreatureFamily(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCreatureID) +---@param unit UnitToken +---@return number? creatureID +function UnitCreatureID(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitCreatureType) +---@param unit UnitToken +---@return string name +---@return number id +function UnitCreatureType(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitDamage) +---@param unit UnitToken +---@return number minDamage +---@return number maxDamage +---@return number offhandMinDamage +---@return number offhandMaxDamage +---@return number posBuff +---@return number negBuff +---@return number percent +function UnitDamage(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitDetailedThreatSituation) +---@param unit UnitToken +---@param mobGUID UnitToken +---@return boolean isTanking +---@return number status +---@return number scaledPercentage +---@return number rawPercentage +---@return number rawThreat +function UnitDetailedThreatSituation(unit, mobGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitDistanceSquared) +---@param unit UnitToken +---@return number distance +---@return boolean checkedDistance +function UnitDistanceSquared(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitEffectiveLevel) +---@param name string +---@return number result +function UnitEffectiveLevel(name) end + +---Returns a duration object that includes the duration of an empowered cast channel. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitEmpoweredChannelDuration) +---@param unit UnitToken +---@param includeHoldAtMaxTime? boolean Default = true +---@return LuaDurationObject duration +function UnitEmpoweredChannelDuration(unit, includeHoldAtMaxTime) end + +---Returns a vector of duration objects that measure the time spans for each individual stage in an empowered channel, with hold-at-max time included as the last element. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitEmpoweredStageDurations) +---@param unit UnitToken +---@return LuaDurationObject[] duration +function UnitEmpoweredStageDurations(unit) end + +---Returns a vector of percentages that describe how much of the total duration of an empowered channel is occupied by a stage. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitEmpoweredStagePercentages) +---@param unit UnitToken +---@param includeHoldAtMaxTime? boolean Default = true +---@return number[] percentages +function UnitEmpoweredStagePercentages(unit, includeHoldAtMaxTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitExists) +---@param unit? UnitToken +---@return boolean result +function UnitExists(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitFactionGroup) +---@param unitName string +---@param checkDisplayRace? boolean Default = false +---@return string factionGroupTag +---@return string localized +function UnitFactionGroup(unitName, checkDisplayRace) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitFullName) +---@param unit UnitToken +---@return string unitName +---@return string unitServer +function UnitFullName(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGUID) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return WOWGUID? result +function UnitGUID(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGetDetailedHealPrediction) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param healerUnit? UnitTokenPvPRestrictedForAddOns +---@param healPredictionCalculator UnitHealPredictionCalculator +function UnitGetDetailedHealPrediction(unit, healerUnit, healPredictionCalculator) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGetIncomingHeals) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param healerGUID? UnitTokenPvPRestrictedForAddOns +---@return number? result +function UnitGetIncomingHeals(unit, healerGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGetTotalAbsorbs) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return number result +function UnitGetTotalAbsorbs(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGetTotalHealAbsorbs) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return number result +function UnitGetTotalHealAbsorbs(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGroupRolesAssigned) +---@param unit? UnitToken +---@return string result +function UnitGroupRolesAssigned(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGroupRolesAssignedEnum) +---@param unit? UnitToken +---@return number result +function UnitGroupRolesAssignedEnum(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHPPerStamina) +---@param unit UnitToken +---@return number result +function UnitHPPerStamina(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasPowerType) +---@param unitToken UnitTokenPvPRestrictedForAddOns +---@param powerType Enum.PowerType +---@return boolean hasPower +function UnitHasPowerType(unitToken, powerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasRelicSlot) +---@param unit UnitToken +---@return boolean result +function UnitHasRelicSlot(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasVehiclePlayerFrameUI) +---@param unit? UnitToken +---@return boolean result +function UnitHasVehiclePlayerFrameUI(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasVehicleUI) +---@param unit? UnitToken +---@return boolean result +function UnitHasVehicleUI(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealthMax) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return number result +function UnitHealthMax(unit) end + +---Result of UnitHealthMax() - UnitHealth() +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealthMissing) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param usePredicted? boolean Default = true +---@return number result +function UnitHealthMissing(unit, usePredicted) end + +---Returns percent of health remaining - can be scaled via a curve for display purposes +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealthPercent) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param usePredicted? boolean Default = true +---@param curve? LuaCurveObjectBase +---@return LuaCurveEvaluatedResult result +function UnitHealthPercent(unit, usePredicted, curve) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealth) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param usePredicted? boolean Default = true +---@return number result +function UnitHealth(unit, usePredicted) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHonor) +---@param unit UnitToken +---@return number result +function UnitHonor(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHonorLevel) +---@param unit UnitToken +---@return number result +function UnitHonorLevel(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHonorMax) +---@param unit UnitToken +---@return number result +function UnitHonorMax(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInAnyGroup) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitInAnyGroup(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInBattleground) +---@param unit? UnitToken +---@param partyIndex? number +---@return number? result +function UnitInBattleground(unit, partyIndex) end + +---Checks whether this unit cannot see your party chat because it is in an instance group +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInOtherParty) +---@param unit UnitToken +---@return boolean inOtherParty +function UnitInOtherParty(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInParty) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitInParty(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInPartyIsAI) +---@param unit? UnitToken +---@return boolean result +function UnitInPartyIsAI(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInPartyShard) +---@param unit UnitToken +---@return boolean inPartyShard +function UnitInPartyShard(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInRaid) +---@param unit? UnitToken +---@param partyIndex? number +---@return number? result +function UnitInRaid(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInRange) +---@param unit UnitToken +---@return boolean inRange +---@return boolean checkedRange +function UnitInRange(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInSubgroup) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitInSubgroup(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInVehicle) +---@param unit UnitToken +---@return boolean result +function UnitInVehicle(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInVehicleControlSeat) +---@param unit? UnitToken +---@return boolean result +function UnitInVehicleControlSeat(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitInVehicleHidesPetFrame) +---@param unit? UnitToken +---@return boolean result +function UnitInVehicleHidesPetFrame(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsAFK) +---@param unit UnitToken +---@return boolean result +function UnitIsAFK(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsBattlePet) +---@param unit UnitToken +---@return boolean? result +function UnitIsBattlePet(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsBattlePetCompanion) +---@param unit UnitToken +---@return boolean result +function UnitIsBattlePetCompanion(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsBossMob) +---@param unit UnitToken +---@return boolean result +function UnitIsBossMob(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsCharmed) +---@param unit? UnitToken +---@return boolean result +function UnitIsCharmed(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsConnected) +---@param unit UnitToken +---@return boolean isConnected +function UnitIsConnected(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsControlling) +---@param unit UnitToken +---@return boolean result +function UnitIsControlling(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsCorpse) +---@param unit? UnitToken +---@return boolean result +function UnitIsCorpse(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsDND) +---@param unit UnitToken +---@return boolean result +function UnitIsDND(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsDead) +---@param unit UnitToken +---@return boolean result +function UnitIsDead(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsDeadOrGhost) +---@param unit UnitToken +---@return boolean result +function UnitIsDeadOrGhost(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsEnemy) +---@param unit UnitToken +---@param target UnitToken +---@return boolean result +function UnitIsEnemy(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsFeignDeath) +---@param unit UnitToken +---@return boolean result +function UnitIsFeignDeath(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsFriend) +---@param unit UnitToken +---@param target UnitToken +---@return boolean result +function UnitIsFriend(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsGameObject) +---@param unit? UnitToken +---@return boolean result +function UnitIsGameObject(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsGhost) +---@param unit UnitToken +---@return boolean result +function UnitIsGhost(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsGroupAssistant) +---@param unit UnitToken +---@return boolean isAssistant +function UnitIsGroupAssistant(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsGroupLeader) +---@param unit UnitToken +---@param partyCategory? number +---@return boolean isLeader +function UnitIsGroupLeader(unit, partyCategory) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsHumanPlayer) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitIsHumanPlayer(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsInMyGuild) +---@param unit string +---@return boolean result +function UnitIsInMyGuild(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsInteractable) +---@param unit? UnitToken +---@return boolean result +function UnitIsInteractable(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsLieutenant) +---@param unit UnitToken +---@return boolean result +function UnitIsLieutenant(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsMercenary) +---@param name string +---@return boolean result +function UnitIsMercenary(name) end + +---Returns whether the unit is considered a minion of a player, such as a pet, totem, or guardian. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsMinion) +---@param unit UnitToken +---@return boolean result +function UnitIsMinion(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsNPCAsPlayer) +---@param unit? UnitToken +---@return boolean result +function UnitIsNPCAsPlayer(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsOtherPlayersBattlePet) +---@param unit? UnitToken +---@return boolean result +function UnitIsOtherPlayersBattlePet(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsOtherPlayersPet) +---@param unit? UnitToken +---@return boolean result +function UnitIsOtherPlayersPet(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsOwnerOrControllerOfUnit) +---@param controllingUnit UnitToken +---@param controlledUnit UnitToken +---@return boolean unitIsOwnerOrControllerOfUnit +function UnitIsOwnerOrControllerOfUnit(controllingUnit, controlledUnit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsPVP) +---@param unit UnitToken +---@return boolean result +function UnitIsPVP(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsPVPFreeForAll) +---@param unit UnitToken +---@return boolean result +function UnitIsPVPFreeForAll(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsPVPSanctuary) +---@param unit? UnitToken +---@return boolean result +function UnitIsPVPSanctuary(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsPlayer) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitIsPlayer(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsPossessed) +---@param unit? UnitToken +---@return boolean result +function UnitIsPossessed(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsQuestBoss) +---@param unit UnitToken +---@return boolean result +function UnitIsQuestBoss(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsRaidOfficer) +---@param unit? UnitToken +---@return boolean result +function UnitIsRaidOfficer(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsSameServer) +---@param unitName string +---@return boolean result +function UnitIsSameServer(unitName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsTapDenied) +---@param unit UnitToken +---@return boolean result +function UnitIsTapDenied(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsTrivial) +---@param unit UnitToken +---@return boolean result +function UnitIsTrivial(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsUnconscious) +---@param unit UnitToken +---@return boolean result +function UnitIsUnconscious(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsUnit) +---@param unit1 UnitToken +---@param unit2 UnitToken +---@return boolean result +function UnitIsUnit(unit1, unit2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsVisible) +---@param unit? UnitToken +---@return boolean result +function UnitIsVisible(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitIsWildBattlePet) +---@param unit UnitToken +---@return boolean result +function UnitIsWildBattlePet(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitLeadsAnyGroup) +---@param unit UnitToken +---@return boolean isLeader +function UnitLeadsAnyGroup(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitLevel) +---@param name string +---@return number result +function UnitLevel(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitName) +---@param unit UnitToken +---@return string unitName +---@return string unitServer +function UnitName(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitNameFromGUID) +---@param unitGUID WOWGUID +---@return string unitName +---@return string unitServer +function UnitNameFromGUID(unitGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitNameUnmodified) +---@param unit UnitToken +---@return string unitName +---@return string unitServer +function UnitNameUnmodified(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitNameplateShowsWidgetsOnly) +---@param unit UnitToken +---@return boolean nameplateShowsWidgetsOnly +function UnitNameplateShowsWidgetsOnly(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitNumPowerBarTimers) +---@param unit UnitToken +---@return number result +function UnitNumPowerBarTimers(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitOnTaxi) +---@param unit UnitToken +---@return boolean result +function UnitOnTaxi(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitOwnerGUID) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return WOWGUID ownerGUID +function UnitOwnerGUID(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPVPName) +---@param unit UnitToken +---@return string result +function UnitPVPName(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPartialPower) +---@param unitToken UnitTokenPvPRestrictedForAddOns +---@param powerType? Enum.PowerType +---@param unmodified? boolean Default = false +---@return number partialPower +function UnitPartialPower(unitToken, powerType, unmodified) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPercentHealthFromGUID) +---@param unitGUID WOWGUID +---@return number? percentHealth +function UnitPercentHealthFromGUID(unitGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPhaseReason) +---@param unit UnitToken +---@return Enum.PhaseReason? reason +function UnitPhaseReason(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPlayerControlled) +---@param unit? UnitToken +---@return boolean result +function UnitPlayerControlled(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPlayerOrPetInParty) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitPlayerOrPetInParty(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPlayerOrPetInRaid) +---@param unit? UnitToken +---@param partyIndex? number +---@return boolean result +function UnitPlayerOrPetInRaid(unit, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPosition) +---@param unit UnitToken +---@return number positionX +---@return number positionY +---@return number positionZ +---@return number mapID +function UnitPosition(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPower) +---@param unitToken UnitTokenPvPRestrictedForAddOns +---@param powerType? Enum.PowerType +---@param unmodified? boolean Default = false +---@return number power +function UnitPower(unitToken, powerType, unmodified) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerBarID) +---@param unitToken UnitToken +---@return number barID +function UnitPowerBarID(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerBarTimerInfo) +---@param unit UnitToken +---@param index? number Default = 0 +---@return number duration +---@return number expiration +---@return number barID +---@return number auraID +function UnitPowerBarTimerInfo(unit, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerDisplayMod) +---@param powerType Enum.PowerType +---@return number displayMod +function UnitPowerDisplayMod(powerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerMax) +---@param unitToken UnitTokenPvPRestrictedForAddOns +---@param powerType? Enum.PowerType +---@param unmodified? boolean Default = false +---@return number maxPower +function UnitPowerMax(unitToken, powerType, unmodified) end + +---Result of UnitPowerMax() - UnitPower() +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerMissing) +---@param unitToken UnitTokenPvPRestrictedForAddOns +---@param powerType? Enum.PowerType +---@param unmodified? boolean Default = false +---@return number result +function UnitPowerMissing(unitToken, powerType, unmodified) end + +---Queries the percent of power remaining, optionally evaluating it against a supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerPercent) +---@param unitToken UnitTokenPvPRestrictedForAddOns +---@param powerType? Enum.PowerType +---@param unmodified? boolean Default = false +---@param curve? LuaCurveObjectBase +---@return LuaCurveEvaluatedResult result +function UnitPowerPercent(unitToken, powerType, unmodified, curve) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPowerType) +---@param unit UnitTokenPvPRestrictedForAddOns +---@param index? number Default = 0 +---@return Enum.PowerType powerType +---@return string powerTypeToken +---@return number rgbX +---@return number rgbY +---@return number rgbZ +function UnitPowerType(unit, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPvpClassification) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return Enum.PvPUnitClassification? classification +function UnitPvpClassification(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitQuestTrivialLevelRange) +---@param unit UnitToken +---@return number levelRange +function UnitQuestTrivialLevelRange(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitQuestTrivialLevelRangeScaling) +---@param unit UnitToken +---@return number levelRange +function UnitQuestTrivialLevelRangeScaling(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitRace) +---@param name string +---@return string localizedRaceName +---@return string englishRaceName +---@return number raceID +function UnitRace(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitRangedAttackPower) +---@param unit UnitToken +---@return number attackPower +---@return number posBuff +---@return number negBuff +function UnitRangedAttackPower(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitRangedDamage) +---@param unit UnitToken +---@return number speed +---@return number minDamage +---@return number maxDamage +---@return number posBuff +---@return number negBuff +---@return number percent +function UnitRangedDamage(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitReaction) +---@param unit UnitToken +---@param target UnitToken +---@return number? result +function UnitReaction(unit, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitRealmRelationship) +---@param unit UnitToken +---@return number? realmRelationship +function UnitRealmRelationship(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSelectionColor) +---@param unit UnitToken +---@param useExtendedColors? boolean Default = false +---@return number resultR +---@return number resultG +---@return number resultB +---@return number resultA +function UnitSelectionColor(unit, useExtendedColors) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSelectionType) +---@param unit UnitToken +---@param useExtendedColors? boolean Default = false +---@return number result +function UnitSelectionType(unit, useExtendedColors) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSex) +---@param unit UnitToken +---@return number? sex +function UnitSex(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSexBase) +---@param unit UnitToken +---@return Enum.UnitSex? sex +function UnitSexBase(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitShouldDisplayName) +---@param unit UnitToken +---@return boolean result +function UnitShouldDisplayName(unit) end + +---If the unit is currently casting a spell, returns whether the target's name should be displayed. Returns false if the unit is not casting a spell or the spell has no target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitShouldDisplaySpellTargetName) +---@param unit UnitToken +---@return boolean result +function UnitShouldDisplaySpellTargetName(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSpellHaste) +---@param unit UnitToken +---@return number result +function UnitSpellHaste(unit) end + +---If the unit is currently casting a spell, returns the class of the spell's target unit. Returns nil if the unit is not casting a spell or the spell has no target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSpellTargetClass) +---@param unit UnitToken +---@return string classFilename +function UnitSpellTargetClass(unit) end + +---If the unit is currently casting a spell, returns the name of the spell's target unit. Returns nil if the unit is not casting a spell or the spell has no target. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSpellTargetName) +---@param unit UnitToken +---@return string targetName +function UnitSpellTargetName(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitStagger) +---@param unit UnitTokenPvPRestrictedForAddOns +---@return number result +function UnitStagger(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitStat) +---@param unit UnitToken +---@param index number +---@return number currentStat +---@return number effectiveStat +---@return number statPositiveBuff +---@return number statNegativeBuff +function UnitStat(unit, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSwitchToVehicleSeat) +---@param unit UnitToken +---@param virtualSeatIndex number +function UnitSwitchToVehicleSeat(unit, virtualSeatIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitTargetsVehicleInRaidUI) +---@param unit? UnitToken +---@return boolean result +function UnitTargetsVehicleInRaidUI(unit) end + +---Returns a threat state (0-3; representing none, yellow, orange, red) that indicates how far the provided unit is above the secondmost threat on the provided mob. If the unit is not first on threat, will always return red. Can return nil if the provided mob does not exist. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitThreatLeadSituation) +---@param unit UnitToken +---@param mobGUID UnitToken +---@return number? result +function UnitThreatLeadSituation(unit, mobGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitThreatPercentageOfLead) +---@param unit UnitToken +---@param mobGUID UnitToken +---@return number? result +function UnitThreatPercentageOfLead(unit, mobGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitThreatSituation) +---@param unit UnitToken +---@param mobGUID? UnitToken +---@return number? result +function UnitThreatSituation(unit, mobGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitTokenFromGUID) +---@param unitGUID WOWGUID +---@return string? unitToken +function UnitTokenFromGUID(unitGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitTreatAsPlayerForDisplay) +---@param unit UnitToken +---@return boolean treatAsPlayer +function UnitTreatAsPlayerForDisplay(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitTrialBankedLevels) +---@param unit UnitToken +---@return number bankedLevels +---@return number xpIntoCurrentLevel +---@return number xpForNextLevel +function UnitTrialBankedLevels(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitTrialXP) +---@param unit UnitToken +---@return number result +function UnitTrialXP(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitUsingVehicle) +---@param unit UnitToken +---@return boolean result +function UnitUsingVehicle(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitVehicleSeatCount) +---@param unit UnitToken +---@return number result +function UnitVehicleSeatCount(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitVehicleSeatInfo) +---@param unit UnitToken +---@param virtualSeatIndex number +---@return string controlType +---@return string occupantName +---@return string serverName +---@return boolean ejectable +---@return boolean canSwitchSeats +function UnitVehicleSeatInfo(unit, virtualSeatIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitVehicleSkin) +---@param unit? UnitToken +---@return fileID result +function UnitVehicleSkin(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitWeaponAttackPower) +---@param unit UnitToken +---@return number mainHandWeaponAttackPower +---@return number offHandWeaponAttackPower +---@return number rangedWeaponAttackPower +function UnitWeaponAttackPower(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitWidgetSet) +---@param unit UnitToken +---@return number uiWidgetSet +function UnitWidgetSet(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitXP) +---@param unit UnitToken +---@return number result +function UnitXP(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitXPMax) +---@param unit UnitToken +---@return number result +function UnitXPMax(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_WorldLootObjectExists) +---@param unit? UnitToken +---@return boolean result +function WorldLootObjectExists(unit) end + +---@class CorruptionEffectInfo +---@field name string +---@field description string +---@field minCorruption number + +---@class UnitCastingInfoResult +---@field name string +---@field displayName string +---@field textureID fileID +---@field startTimeMs number +---@field endTimeMs number +---@field isTradeskill boolean +---@field castID WOWGUID +---@field notInterruptible boolean? +---@field castingSpellID number +---@field castBarID number? +---@field delayTimeMs number + +---@class UnitChannelInfoResult +---@field name string +---@field displayName string +---@field textureID fileID +---@field startTimeMs number +---@field endTimeMs number +---@field isTradeskill boolean +---@field notInterruptible boolean? +---@field spellID number +---@field isEmpowered boolean +---@field numEmpowerStages number +---@field castBarID number? + +---@class UnitCreatureFamilyResult +---@field name string +---@field id number + +---@class UnitCreatureTypeResult +---@field name string +---@field id number + +---@class UnitPowerBarInfo +---@field ID number +---@field barType number +---@field minPower number +---@field startInset number +---@field endInset number +---@field smooth boolean +---@field hideFromOthers boolean +---@field showOnRaid boolean +---@field opaqueSpark boolean +---@field opaqueFlash boolean +---@field anchorTop boolean +---@field forcePercentage boolean +---@field sparkUnderFrame boolean +---@field flashAtMinPower boolean +---@field fractionalCounter boolean +---@field animateNumbers boolean +---@field attachTooltipToBar boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua new file mode 100644 index 0000000..bb3be19 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua @@ -0,0 +1,22 @@ +---@meta _ +---@class UnitDamageAbsorbInfo +---@field amount number +---@field clamped boolean + +---@class UnitHealAbsorbInfo +---@field amount number +---@field clamped boolean + +---@class UnitHealPredictionValues +---@field health number? Default = 0 +---@field healthMax number? Default = 0 +---@field totalIncomingHeals number? Default = 0 +---@field totalIncomingHealsFromHealer number? Default = 0 +---@field totalDamageAbsorbs number? Default = 0 +---@field totalHealAbsorbs number? Default = 0 + +---@class UnitIncomingHealInfo +---@field amount number +---@field amountFromHealer number +---@field amountFromOthers number +---@field clamped boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua new file mode 100644 index 0000000..e8cbeb1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua @@ -0,0 +1,33 @@ +---@meta _ +---If true, UnitGetAvailableRoles results should be treated as suggested role, not hard limits on what role the current player can display as. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_AreClassRolesSoftSuggestions) +---@return boolean result +function AreClassRolesSoftSuggestions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanShowSetRoleButton) +---@return boolean result +function CanShowSetRoleButton() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InitiateRolePoll) +---@return boolean result +function InitiateRolePoll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitGetAvailableRoles) +---@param unit UnitToken +---@return boolean tank +---@return boolean healer +---@return boolean dps +function UnitGetAvailableRoles(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSetRole) +---@param unit UnitToken +---@param roleStr? string +---@return boolean result +function UnitSetRole(unit, roleStr) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitSetRoleEnum) +---@param unit UnitToken +---@param role? Enum.LFGRole +---@return boolean result +function UnitSetRoleEnum(unit, role) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua new file mode 100644 index 0000000..1641f43 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua @@ -0,0 +1,13 @@ +---@meta _ +C_UserFeedback = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UserFeedback.SubmitBug) +---@param bugInfo string +---@param suppressNotification? boolean Default = false +---@return boolean success +function C_UserFeedback.SubmitBug(bugInfo, suppressNotification) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_UserFeedback.SubmitSuggestion) +---@param suggestion string +---@return boolean success +function C_UserFeedback.SubmitSuggestion(suggestion) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua new file mode 100644 index 0000000..7883917 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua @@ -0,0 +1,35 @@ +---@meta _ +C_VideoOptions = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VideoOptions.GetCurrentGameWindowSize) +---@return vector2 size +function C_VideoOptions.GetCurrentGameWindowSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VideoOptions.GetDefaultGameWindowSize) +---@param monitor number +---@return vector2 size +function C_VideoOptions.GetDefaultGameWindowSize(monitor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VideoOptions.GetGameWindowSizes) +---@param monitor number +---@param fullscreen boolean +---@return vector2[] sizes +function C_VideoOptions.GetGameWindowSizes(monitor, fullscreen) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VideoOptions.GetGxAdapterInfo) +---@return GxAdapterInfoDetails[] adapters +function C_VideoOptions.GetGxAdapterInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VideoOptions.IsSpellVisualDensitySystemSupported) +---@return boolean isSupported +function C_VideoOptions.IsSpellVisualDensitySystemSupported() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VideoOptions.SetGameWindowSize) +---@param x number +---@param y number +function C_VideoOptions.SetGameWindowSize(x, y) end + +---@class GxAdapterInfoDetails +---@field name string +---@field isLowPower boolean +---@field isExternal boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua new file mode 100644 index 0000000..24506f2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua @@ -0,0 +1,55 @@ +---@meta _ +C_VignetteInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VignetteInfo.FindBestUniqueVignette) +---@param vignetteGUIDs WOWGUID[] +---@return number? bestUniqueVignetteIndex +function C_VignetteInfo.FindBestUniqueVignette(vignetteGUIDs) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VignetteInfo.GetHealthPercent) +---@param vignetteGUID WOWGUID +---@return number? healthPct +function C_VignetteInfo.GetHealthPercent(vignetteGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VignetteInfo.GetRecommendedGroupSize) +---@param vignetteGUID WOWGUID +---@return number minGroupSize +---@return number maxGroupSize +function C_VignetteInfo.GetRecommendedGroupSize(vignetteGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VignetteInfo.GetVignetteInfo) +---@param vignetteGUID WOWGUID +---@return VignetteInfo? vignetteInfo +function C_VignetteInfo.GetVignetteInfo(vignetteGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VignetteInfo.GetVignettePosition) +---@param vignetteGUID WOWGUID +---@param uiMapID number +---@return vector2 vignettePosition +---@return number? vignetteFacing +function C_VignetteInfo.GetVignettePosition(vignetteGUID, uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VignetteInfo.GetVignettes) +---@return WOWGUID[] vignetteGUIDs +function C_VignetteInfo.GetVignettes() end + +---@class VignetteInfo +---@field vignetteGUID WOWGUID +---@field objectGUID WOWGUID +---@field name string +---@field isDead boolean +---@field onWorldMap boolean +---@field zoneInfiniteAOI boolean +---@field onMinimap boolean +---@field isUnique boolean +---@field inFogOfWar boolean +---@field atlasName textureAtlas +---@field hasTooltip boolean +---@field vignetteID number +---@field type Enum.VignetteType +---@field rewardQuestID number +---@field tooltipWidgetSet number? +---@field iconWidgetSet number? +---@field addPaddingAboveTooltipWidgets boolean? +---@field mapPin UIMapPinInfo? +---@field objectiveType Enum.VignetteObjectiveType? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua new file mode 100644 index 0000000..7d6e677 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua @@ -0,0 +1,394 @@ +---@meta _ +C_VoiceChat = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.ActivateChannel) +---@param channelID number +function C_VoiceChat.ActivateChannel(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.ActivateChannelTranscription) +---@param channelID number +function C_VoiceChat.ActivateChannelTranscription(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.BeginLocalCapture) +---@param listenToLocalUser boolean +function C_VoiceChat.BeginLocalCapture(listenToLocalUser) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.CanAccessSettings) +---@return boolean canAccess +function C_VoiceChat.CanAccessSettings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.CanPlayerUseVoiceChat) +---@return boolean canUseVoiceChat +function C_VoiceChat.CanPlayerUseVoiceChat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.CreateChannel) +---@param channelDisplayName string +---@return Enum.VoiceChatStatusCode status +function C_VoiceChat.CreateChannel(channelDisplayName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.DeactivateChannel) +---@param channelID number +function C_VoiceChat.DeactivateChannel(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.DeactivateChannelTranscription) +---@param channelID number +function C_VoiceChat.DeactivateChannelTranscription(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.EndLocalCapture) +function C_VoiceChat.EndLocalCapture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetActiveChannelID) +---@return number? channelID +function C_VoiceChat.GetActiveChannelID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetActiveChannelType) +---@return Enum.ChatChannelType? channelType +function C_VoiceChat.GetActiveChannelType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetAvailableInputDevices) +---@return VoiceAudioDevice[]? inputDevices +function C_VoiceChat.GetAvailableInputDevices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetAvailableOutputDevices) +---@return VoiceAudioDevice[]? outputDevices +function C_VoiceChat.GetAvailableOutputDevices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetChannel) +---@param channelID number +---@return VoiceChatChannel channel +function C_VoiceChat.GetChannel(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetChannelForChannelType) +---@param channelType Enum.ChatChannelType +---@return VoiceChatChannel channel +function C_VoiceChat.GetChannelForChannelType(channelType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetChannelForCommunityStream) +---@param clubId ClubId +---@param streamId ClubStreamId +---@return VoiceChatChannel channel +function C_VoiceChat.GetChannelForCommunityStream(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetCommunicationMode) +---@return Enum.CommunicationMode? communicationMode +function C_VoiceChat.GetCommunicationMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode) +---@return Enum.VoiceChatStatusCode? statusCode +function C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetInputVolume) +---@return number? volume +function C_VoiceChat.GetInputVolume() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetJoinClubVoiceChannelError) +---@param clubId ClubId +---@return Enum.VoiceChannelErrorReason? errorReason +function C_VoiceChat.GetJoinClubVoiceChannelError(clubId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo) +---@return VoiceChatMember? memberInfo +function C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetLocalPlayerMemberID) +---@param channelID number +---@return number? memberID +function C_VoiceChat.GetLocalPlayerMemberID(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetMasterVolumeScale) +---@return number scale +function C_VoiceChat.GetMasterVolumeScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetMemberGUID) +---@param memberID number +---@param channelID number +---@return WOWGUID memberGUID +function C_VoiceChat.GetMemberGUID(memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetMemberID) +---@param channelID number +---@param memberGUID WOWGUID +---@return number? memberID +function C_VoiceChat.GetMemberID(channelID, memberGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetMemberInfo) +---@param memberID number +---@param channelID number +---@return VoiceChatMember? memberInfo +function C_VoiceChat.GetMemberInfo(memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetMemberName) +---@param memberID number +---@param channelID number +---@return string? memberName +function C_VoiceChat.GetMemberName(memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetMemberVolume) +---@param playerLocation PlayerLocation +---@return number? volume +function C_VoiceChat.GetMemberVolume(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetOutputVolume) +---@return number? volume +function C_VoiceChat.GetOutputVolume() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetPTTButtonPressedState) +---@return boolean? isPressed +function C_VoiceChat.GetPTTButtonPressedState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetProcesses) +---@return VoiceChatProcess[] processes +function C_VoiceChat.GetProcesses() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetPushToTalkBinding) +---@return string[]? keys +function C_VoiceChat.GetPushToTalkBinding() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetRemoteTtsVoices) +---@return VoiceTtsVoiceType[] ttsVoices +function C_VoiceChat.GetRemoteTtsVoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetTtsVoices) +---@return VoiceTtsVoiceType[] ttsVoices +function C_VoiceChat.GetTtsVoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.GetVADSensitivity) +---@return number? sensitivity +function C_VoiceChat.GetVADSensitivity() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsChannelJoinPending) +---@param channelType Enum.ChatChannelType +---@param clubId? ClubId +---@param streamId? ClubStreamId +---@return boolean isPending +function C_VoiceChat.IsChannelJoinPending(channelType, clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsDeafened) +---@return boolean? isDeafened +function C_VoiceChat.IsDeafened() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsEnabled) +---@return boolean isEnabled +function C_VoiceChat.IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsLoggedIn) +---@return boolean isLoggedIn +function C_VoiceChat.IsLoggedIn() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsMemberLocalPlayer) +---@param memberID number +---@param channelID number +---@return boolean isLocalPlayer +function C_VoiceChat.IsMemberLocalPlayer(memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsMemberMuted) +---@param playerLocation PlayerLocation +---@return boolean? mutedForMe +function C_VoiceChat.IsMemberMuted(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsMemberMutedForAll) +---@param memberID number +---@param channelID number +---@return boolean? mutedForAll +function C_VoiceChat.IsMemberMutedForAll(memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsMemberSilenced) +---@param memberID number +---@param channelID number +---@return boolean? silenced +function C_VoiceChat.IsMemberSilenced(memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsMuted) +---@return boolean? isMuted +function C_VoiceChat.IsMuted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsParentalDisabled) +---@return boolean isParentalDisabled +function C_VoiceChat.IsParentalDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsParentalMuted) +---@return boolean isParentalMuted +function C_VoiceChat.IsParentalMuted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsPlayerUsingVoice) +---@param playerLocation PlayerLocation +---@return boolean isUsingVoice +function C_VoiceChat.IsPlayerUsingVoice(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsSilenced) +---@return boolean? isSilenced +function C_VoiceChat.IsSilenced() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsSpeakForMeActive) +---@return boolean isActive +function C_VoiceChat.IsSpeakForMeActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsSpeakForMeAllowed) +---@return boolean isAllowed +function C_VoiceChat.IsSpeakForMeAllowed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsTranscribing) +---@return boolean isTranscribing +function C_VoiceChat.IsTranscribing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsTranscriptionAllowed) +---@return boolean isAllowed +function C_VoiceChat.IsTranscriptionAllowed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.IsVoiceChatConnected) +---@return boolean connected +function C_VoiceChat.IsVoiceChatConnected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.LeaveChannel) +---@param channelID number +function C_VoiceChat.LeaveChannel(channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.Login) +---@return Enum.VoiceChatStatusCode status +function C_VoiceChat.Login() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.Logout) +---@return Enum.VoiceChatStatusCode status +function C_VoiceChat.Logout() end + +---Once the UI has enumerated all channels, use this to reset the channel discovery state, it will be updated again if appropriate +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.MarkChannelsDiscovered) +function C_VoiceChat.MarkChannelsDiscovered() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel) +---@param clubId ClubId +---@param streamId ClubStreamId +function C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel(clubId, streamId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.RequestJoinChannelByChannelType) +---@param channelType Enum.ChatChannelType +---@param autoActivate? boolean +function C_VoiceChat.RequestJoinChannelByChannelType(channelType, autoActivate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetCommunicationMode) +---@param communicationMode Enum.CommunicationMode +function C_VoiceChat.SetCommunicationMode(communicationMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetDeafened) +---@param isDeafened boolean +function C_VoiceChat.SetDeafened(isDeafened) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetInputDevice) +---@param deviceID string +function C_VoiceChat.SetInputDevice(deviceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetInputVolume) +---@param volume number +function C_VoiceChat.SetInputVolume(volume) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetMasterVolumeScale) +---@param scale number +function C_VoiceChat.SetMasterVolumeScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetMemberMuted) +---@param playerLocation PlayerLocation +---@param muted boolean +function C_VoiceChat.SetMemberMuted(playerLocation, muted) end + +---Adjusts member volume across all channels +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetMemberVolume) +---@param playerLocation PlayerLocation +---@param volume number +function C_VoiceChat.SetMemberVolume(playerLocation, volume) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetMuted) +---@param isMuted boolean +function C_VoiceChat.SetMuted(isMuted) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetOutputDevice) +---@param deviceID string +function C_VoiceChat.SetOutputDevice(deviceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetOutputVolume) +---@param volume number +function C_VoiceChat.SetOutputVolume(volume) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetPortraitTexture) +---@param textureObject SimpleTexture +---@param memberID number +---@param channelID number +function C_VoiceChat.SetPortraitTexture(textureObject, memberID, channelID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetPushToTalkBinding) +---@param keys string[] +function C_VoiceChat.SetPushToTalkBinding(keys) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SetVADSensitivity) +---@param sensitivity number +function C_VoiceChat.SetVADSensitivity(sensitivity) end + +---Use this while loading to determine if the UI should attempt to rediscover the previously joined/active voice channels +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.ShouldDiscoverChannels) +---@return boolean shouldDiscoverChannels +function C_VoiceChat.ShouldDiscoverChannels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SpeakRemoteTextSample) +---@param text string +function C_VoiceChat.SpeakRemoteTextSample(text) end + +---SpeakText also supports XML TTS tags on Windows including bookmarks - see SAPI XML TTS Tutorial in Microsoft's online documentation for more information. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.SpeakText) +---@param voiceID number +---@param text string +---@param rate number +---@param volume number +---@param overlap? boolean Default = false +function C_VoiceChat.SpeakText(voiceID, text, rate, volume, overlap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.StopSpeakingText) +function C_VoiceChat.StopSpeakingText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.ToggleDeafened) +function C_VoiceChat.ToggleDeafened() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.ToggleMemberMuted) +---@param playerLocation PlayerLocation +function C_VoiceChat.ToggleMemberMuted(playerLocation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_VoiceChat.ToggleMuted) +function C_VoiceChat.ToggleMuted() end + +---@class VoiceAudioDevice +---@field deviceID string +---@field displayName string +---@field isActive boolean +---@field isSystemDefault boolean +---@field isCommsDefault boolean + +---@class VoiceChatChannel +---@field name string +---@field channelID number +---@field channelType Enum.ChatChannelType +---@field clubId ClubId +---@field streamId ClubStreamId +---@field volume number +---@field isActive boolean +---@field isMuted boolean +---@field isTransmitting boolean +---@field isTranscribing boolean +---@field members VoiceChatMember[] + +---@class VoiceChatMember +---@field energy number +---@field memberID number +---@field isActive boolean +---@field isSpeaking boolean +---@field isMutedForAll boolean +---@field isSilenced boolean + +---@class VoiceChatProcess +---@field name string +---@field channels VoiceChatChannel[] + +---@class VoiceTtsVoiceType +---@field voiceID number +---@field name string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua new file mode 100644 index 0000000..4aae56a --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua @@ -0,0 +1,71 @@ +---@meta _ +C_CampaignInfo = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetAvailableCampaigns) +---@return number[] campaignIDs +function C_CampaignInfo.GetAvailableCampaigns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetCampaignChapterInfo) +---@param campaignChapterID number +---@return CampaignChapterInfo? campaignChapterInfo +function C_CampaignInfo.GetCampaignChapterInfo(campaignChapterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetCampaignID) +---@param questID number +---@return number campaignID +function C_CampaignInfo.GetCampaignID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetCampaignInfo) +---@param campaignID number +---@return CampaignInfo? campaignInfo +function C_CampaignInfo.GetCampaignInfo(campaignID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetChapterIDs) +---@param campaignID number +---@return number[]? chapterIDs +function C_CampaignInfo.GetChapterIDs(campaignID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetCurrentChapterID) +---@param campaignID number +---@return number? currentChapterID +function C_CampaignInfo.GetCurrentChapterID(campaignID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetFailureReason) +---@param campaignID number +---@return CampaignFailureReason? failureReason +function C_CampaignInfo.GetFailureReason(campaignID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.GetState) +---@param campaignID number +---@return Enum.CampaignState state +function C_CampaignInfo.GetState(campaignID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.IsCampaignQuest) +---@param questID number +---@return boolean isCampaignQuest +function C_CampaignInfo.IsCampaignQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CampaignInfo.SortAsNormalQuest) +---@param campaignID number +---@return boolean sortAsNormalQuest +function C_CampaignInfo.SortAsNormalQuest(campaignID) end + +---@class CampaignChapterInfo +---@field name string +---@field description string +---@field rewardQuestID number + +---@class CampaignFailureReason +---@field text string +---@field questID number? +---@field mapID number? + +---@class CampaignInfo +---@field name string +---@field description string +---@field uiTextureKit textureKit +---@field isWarCampaign boolean +---@field usesNormalQuestIcons boolean +---@field isContainerCampaign boolean +---@field sortAsNormalQuest boolean +---@field hideFutureChapters boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua new file mode 100644 index 0000000..f63800e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua @@ -0,0 +1,46 @@ +---@meta _ +C_WarbandScene = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WarbandScene.GetRandomEntryID) +---@return number warbandSceneID +function C_WarbandScene.GetRandomEntryID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WarbandScene.GetWarbandSceneEntry) +---@param warbandSceneID number +---@return WarbandSceneEntry warbandSceneEntry +function C_WarbandScene.GetWarbandSceneEntry(warbandSceneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WarbandScene.HasWarbandScene) +---@param warbandSceneID number +---@return boolean owned +function C_WarbandScene.HasWarbandScene(warbandSceneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WarbandScene.IsFavorite) +---@param warbandSceneID number +---@return boolean favorite +function C_WarbandScene.IsFavorite(warbandSceneID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WarbandScene.SearchWarbandSceneEntries) +---@param searchParams WarbandSceneSearchInfo +---@return number[] matchingEntryIDs +function C_WarbandScene.SearchWarbandSceneEntries(searchParams) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WarbandScene.SetFavorite) +---@param warbandSceneID number +---@param favorite boolean +function C_WarbandScene.SetFavorite(warbandSceneID, favorite) end + +---@class WarbandSceneEntry +---@field warbandSceneID number? Default = 0 +---@field name string +---@field description string +---@field source string +---@field quality number +---@field textureKit textureKit +---@field isFavorite boolean? Default = false +---@field hasFanfare boolean? Default = false +---@field sourceType number? Default = 0 + +---@class WarbandSceneSearchInfo +---@field ownedOnly boolean? Default = false +---@field favoritesOnly boolean? Default = false diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua new file mode 100644 index 0000000..366e903 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua @@ -0,0 +1,140 @@ +---@meta _ +C_WeeklyRewards = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.AreRewardsForCurrentRewardPeriod) +---@return boolean isCurrentPeriod +function C_WeeklyRewards.AreRewardsForCurrentRewardPeriod() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.CanClaimRewards) +---@return boolean canClaimRewards +function C_WeeklyRewards.CanClaimRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.ClaimReward) +---@param id number +function C_WeeklyRewards.ClaimReward(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.CloseInteraction) +function C_WeeklyRewards.CloseInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetActivities) +---@param type? Enum.WeeklyRewardChestThresholdType +---@return WeeklyRewardActivityInfo[] activities +function C_WeeklyRewards.GetActivities(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetActivityEncounterInfo) +---@param type Enum.WeeklyRewardChestThresholdType +---@param index number +---@return WeeklyRewardActivityEncounterInfo[] info +function C_WeeklyRewards.GetActivityEncounterInfo(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetConquestWeeklyProgress) +---@return ConquestWeeklyProgress weeklyProgress +function C_WeeklyRewards.GetConquestWeeklyProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetDifficultyIDForActivityTier) +---@param activityTierID number +---@return number difficultyID +function C_WeeklyRewards.GetDifficultyIDForActivityTier(activityTierID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetExampleRewardItemHyperlinks) +---@param id number +---@return string hyperlink +---@return string upgradeHyperlink +function C_WeeklyRewards.GetExampleRewardItemHyperlinks(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetItemHyperlink) +---@param itemDBID WeeklyRewardItemDBID +---@return string hyperlink +function C_WeeklyRewards.GetItemHyperlink(itemDBID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetNextActivitiesIncrease) +---@param activityTierID number +---@param level number +---@return boolean hasSeasonData +---@return number? nextActivityTierID +---@return number? nextLevel +---@return number? itemLevel +function C_WeeklyRewards.GetNextActivitiesIncrease(activityTierID, level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetNextMythicPlusIncrease) +---@param mythicPlusLevel number +---@return boolean hasSeasonData +---@return number? nextMythicPlusLevel +---@return number? itemLevel +function C_WeeklyRewards.GetNextMythicPlusIncrease(mythicPlusLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetNumCompletedDungeonRuns) +---@return number numHeroic +---@return number numMythic +---@return number numMythicPlus +function C_WeeklyRewards.GetNumCompletedDungeonRuns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.GetSortedProgressForActivity) +---@param type Enum.WeeklyRewardChestThresholdType +---@param combineSharedDifficulty boolean +---@return WeeklyRewardActivityTierProgress[] progress +function C_WeeklyRewards.GetSortedProgressForActivity(type, combineSharedDifficulty) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.HasAvailableRewards) +---@return boolean hasAvailableRewards +function C_WeeklyRewards.HasAvailableRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.HasGeneratedRewards) +---@return boolean hasGeneratedRewards +function C_WeeklyRewards.HasGeneratedRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.HasInteraction) +---@return boolean isInteracting +function C_WeeklyRewards.HasInteraction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.IsWeeklyChestRetired) +---@return boolean isRetired +function C_WeeklyRewards.IsWeeklyChestRetired() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.OnUIInteract) +function C_WeeklyRewards.OnUIInteract() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.ShouldShowFinalRetirementMessage) +---@return boolean showRetirementMessage +function C_WeeklyRewards.ShouldShowFinalRetirementMessage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WeeklyRewards.ShouldShowRetirementMessage) +---@return boolean showRetirementMessage +function C_WeeklyRewards.ShouldShowRetirementMessage() end + +---@class ConquestWeeklyProgress +---@field progress number +---@field maxProgress number +---@field displayType Enum.ConquestProgressBarDisplayType +---@field unlocksCompleted number +---@field maxUnlocks number +---@field sampleItemHyperlink string + +---@class WeeklyRewardActivityEncounterInfo +---@field encounterID number +---@field bestDifficulty number +---@field uiOrder number +---@field instanceID number + +---@class WeeklyRewardActivityInfo +---@field type Enum.WeeklyRewardChestThresholdType +---@field index number +---@field threshold number +---@field progress number +---@field id number +---@field activityTierID number +---@field level number +---@field claimID number? +---@field raidString string? +---@field rewards WeeklyRewardActivityRewardInfo[] + +---@class WeeklyRewardActivityRewardInfo +---@field type Enum.CachedRewardType +---@field id number +---@field quantity number +---@field itemDBID WeeklyRewardItemDBID? + +---@class WeeklyRewardActivityTierProgress +---@field activityTierID number +---@field difficulty number +---@field numPoints number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua new file mode 100644 index 0000000..35d70b8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua @@ -0,0 +1,48 @@ +---@meta _ +C_WorldLootObject = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.DoesSlotMatchInventoryType) +---@param slot number +---@param inventoryType Enum.InventoryType +---@return boolean matches +function C_WorldLootObject.DoesSlotMatchInventoryType(slot, inventoryType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.GetWorldLootObjectDistanceSquared) +---@param unitToken UnitToken +---@return number? distanceSquared +function C_WorldLootObject.GetWorldLootObjectDistanceSquared(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.GetWorldLootObjectInfo) +---@param unitToken UnitToken +---@return WorldLootObjectInfo info +function C_WorldLootObject.GetWorldLootObjectInfo(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.GetWorldLootObjectInfoByGUID) +---@param objectGUID WOWGUID +---@return WorldLootObjectInfo info +function C_WorldLootObject.GetWorldLootObjectInfoByGUID(objectGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.IsWorldLootObject) +---@param unitToken UnitToken +---@return boolean isWorldLootObject +function C_WorldLootObject.IsWorldLootObject(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.IsWorldLootObjectByGUID) +---@param guid WOWGUID +---@return boolean isWorldLootObject +function C_WorldLootObject.IsWorldLootObjectByGUID(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.IsWorldLootObjectInRange) +---@param unitToken UnitToken +---@return boolean isWorldLootObjectInRange +function C_WorldLootObject.IsWorldLootObjectInRange(unitToken) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldLootObject.OnWorldLootObjectClick) +---@param unitToken UnitToken +---@param isLeftClick boolean +function C_WorldLootObject.OnWorldLootObjectClick(unitToken, isLeftClick) end + +---@class WorldLootObjectInfo +---@field inventoryType Enum.InventoryType +---@field atMaxQuality boolean +---@field isUpgrade boolean diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua new file mode 100644 index 0000000..1770002 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua @@ -0,0 +1,12 @@ +---@meta _ +C_WorldSafeLocsUIInternal = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WorldSafeLocsUIInternal.GetWorldSafeLocs) +---@return WorldSafeLocInfo[] worldSafeLocs +function C_WorldSafeLocsUIInternal.GetWorldSafeLocs() end + +---@class WorldSafeLocInfo +---@field name string +---@field continent number +---@field loc vector3 +---@field facing number diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua new file mode 100644 index 0000000..ae6b03e --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua @@ -0,0 +1,9 @@ +---@meta _ +C_WowSurvey = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowSurvey.OpenSurvey) +function C_WowSurvey.OpenSurvey() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowSurvey.TriggerSurveyServe) +---@param deliveryMoment Enum.SurveyDeliveryMoment +function C_WowSurvey.TriggerSurveyServe(deliveryMoment) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua new file mode 100644 index 0000000..37264e5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua @@ -0,0 +1,6 @@ +---@meta _ +C_WowTokenUI = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenUI.StartTokenSell) +---@param tokenGUID WOWGUID +function C_WowTokenUI.StartTokenSell(tokenGUID) end diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua new file mode 100644 index 0000000..66ddb96 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua @@ -0,0 +1,29 @@ +---@meta _ +C_XMLUtil = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_XMLUtil.GetTemplateInfo) +---@param name string +---@return XMLTemplateInfo info +function C_XMLUtil.GetTemplateInfo(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_XMLUtil.GetTemplates) +---@return XMLTemplateListInfo[] templates +function C_XMLUtil.GetTemplates() end + +---@class XMLTemplateInfo +---@field type string +---@field width number +---@field height number +---@field keyValues XMLTemplateKeyValue[] +---@field inherits string? +---@field sourceLocation string + +---@class XMLTemplateKeyValue +---@field key string +---@field keyType string +---@field type string +---@field value string + +---@class XMLTemplateListInfo +---@field name string +---@field type string diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua new file mode 100644 index 0000000..d4a45b2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua @@ -0,0 +1,18 @@ +---@meta _ +C_ZoneAbility = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ZoneAbility.GetActiveAbilities) +---@return ZoneAbilityInfo[] zoneAbilities +function C_ZoneAbility.GetActiveAbilities() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ZoneAbility.GetZoneAbilityIcon) +---@param zoneAbilitySpellID number +---@return number? zoneAbilityIconID +function C_ZoneAbility.GetZoneAbilityIcon(zoneAbilitySpellID) end + +---@class ZoneAbilityInfo +---@field zoneAbilityID number +---@field uiPriority number +---@field spellID number +---@field textureKit textureKit +---@field tutorialText string? diff --git a/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua new file mode 100644 index 0000000..d63e46b --- /dev/null +++ b/docs/annotations/Annotations/Core/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua @@ -0,0 +1,21 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAreaText) +---@return string text +function GetAreaText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMinimapZoneText) +---@return string text +function GetMinimapZoneText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRealZoneText) +---@param mapID? number +---@return string text +function GetRealZoneText(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSubZoneText) +---@return string text +function GetSubZoneText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetZoneText) +---@return string text +function GetZoneText() end diff --git a/docs/annotations/Annotations/Core/Data/CVar.lua b/docs/annotations/Annotations/Core/Data/CVar.lua new file mode 100644 index 0000000..86a956c --- /dev/null +++ b/docs/annotations/Annotations/Core/Data/CVar.lua @@ -0,0 +1,1626 @@ +---@meta _ +---@alias CVar string +---|"AIBrain" +---|"AIController" +---|"AIControllerEventLog" +---|"AIEventLog" +---|"ActionButtonUseKeyDown" +---|"ActionButtonUseKeyHeldSpell" +---|"ActionCombatCameraEnable" +---|"AdvFlyingDynamicFOVEnabled" +---|"AllowSoftwareRenderer" +---|"AllowSoftwareRendererDX12" +---|"AllowSpectateMode" +---|"AllowWinRT" +---|"AreaTriggerEventLog" +---|"AreaTriggers" +---|"AsyncAssistActions" +---|"AuraDebugger" +---|"AuraEventLog" +---|"AutoPushSpellToActionBar" +---|"BeckonTriggerEventlog" +---|"BehaviorTree" +---|"Brightness" +---|"CAADebuffSelfAlert" +---|"CAAEnabled" +---|"CAAInterruptCast" +---|"CAAInterruptCastSuccess" +---|"CAAPartyHealthFrequency" +---|"CAAPartyHealthPercent" +---|"CAAPartyHealthVoice" +---|"CAAPartyHealthVolume" +---|"CAAPlayerCastFormat" +---|"CAAPlayerCastMinTime" +---|"CAAPlayerCastMode" +---|"CAAPlayerCastThrottle" +---|"CAAPlayerCastVoice" +---|"CAAPlayerCastVolume" +---|"CAAPlayerHealthFormat" +---|"CAAPlayerHealthPercent" +---|"CAAPlayerHealthThrottle" +---|"CAAPlayerHealthVoice" +---|"CAAPlayerHealthVolume" +---|"CAAResource1Formats" +---|"CAAResource1Percents" +---|"CAAResource1Throttle" +---|"CAAResource1Voice" +---|"CAAResource1Volume" +---|"CAAResource2Formats" +---|"CAAResource2Percents" +---|"CAAResource2Throttle" +---|"CAAResource2Voice" +---|"CAAResource2Volume" +---|"CAASayCombatEnd" +---|"CAASayCombatStart" +---|"CAASayIfTargeted" +---|"CAASayTargetName" +---|"CAASayYourDebuffs" +---|"CAASayYourDebuffsFormat" +---|"CAASayYourDebuffsMinDuration" +---|"CAASayYourDebuffsVoice" +---|"CAASayYourDebuffsVolume" +---|"CAASpeed" +---|"CAATargetCastFormat" +---|"CAATargetCastMinTime" +---|"CAATargetCastMode" +---|"CAATargetCastThrottle" +---|"CAATargetCastVoice" +---|"CAATargetCastVolume" +---|"CAATargetDeathBehavior" +---|"CAATargetHealthFormat" +---|"CAATargetHealthPercent" +---|"CAATargetHealthThrottle" +---|"CAATargetHealthVoice" +---|"CAATargetHealthVolume" +---|"CAAVoice" +---|"CAAVolume" +---|"CMAA2ExtraSharpness" +---|"CMAA2HalfFloat" +---|"CMAA2Quality" +---|"CameraFollowGamepadAdjustDelay" +---|"CameraFollowGamepadAdjustEaseIn" +---|"CameraFollowOnStick" +---|"CameraFollowPitchDeadZone" +---|"CameraFollowPitchSpeed" +---|"CameraFollowPitchStrength" +---|"CameraFollowSnapCharacterAngle" +---|"CameraFollowTargetCombat" +---|"CameraFollowYawSpeed" +---|"CameraKeepCharacterCentered" +---|"CameraReduceUnexpectedMovement" +---|"ChatAmbienceVolume" +---|"ChatMusicVolume" +---|"ChatSoundVolume" +---|"ChromaEffectsEnable" +---|"ChromaEffectsFactionColor" +---|"ClientCastDebug" +---|"ClientCastLimitDebug" +---|"ClientMessageEventLog" +---|"ClientSettings_AFTERMATH_BY_API_MASK" +---|"ClientSettings_AFTERMATH_BY_GPU_CATEGORY" +---|"ClientSettings_ASYNC_COMPUTE_BY_API_MASK" +---|"ClientSettings_ASYNC_COMPUTE_BY_GPU_CATEGORY" +---|"ClientSettings_CMAA2" +---|"ClientSettings_CMD_LIST_MT_BY_API_MASK" +---|"ClientSettings_CMD_LIST_MT_BY_GPU_CATEGORY" +---|"ClientSettings_COPY_QUEUE_BY_API_MASK" +---|"ClientSettings_COPY_QUEUE_BY_GPU_CATEGORY" +---|"ClientSettings_CTexAsyncCreate" +---|"ClientSettings_ClusteredShading" +---|"ClientSettings_FSR" +---|"ClientSettings_HIGH_MEM_FEATURES_BY_API_MASK" +---|"ClientSettings_HIGH_MEM_FEATURES_BY_GPU_CATEGORY" +---|"ClientSettings_LowLatency" +---|"ClientSettings_LowVramActions" +---|"ClientSettings_MSAA" +---|"ClientSettings_MemoryAllocationTraces" +---|"ClientSettings_NeedsGxRestart" +---|"ClientSettings_OPT_FEATURES_BY_API_MASK" +---|"ClientSettings_OPT_FEATURES_BY_GPU_CATEGORY" +---|"ClientSettings_RAY_TRACING_BY_API_MASK" +---|"ClientSettings_RAY_TRACING_BY_GPU_CATEGORY" +---|"ClientSettings_RTShadows" +---|"ClientSettings_SHADER_MT_BY_API_MASK" +---|"ClientSettings_SHADER_MT_BY_GPU_CATEGORY" +---|"ClientSettings_SM6_BY_API_MASK" +---|"ClientSettings_SM6_BY_GPU_CATEGORY" +---|"ClientSettings_SpellClutter" +---|"ClientSettings_VolumeFog" +---|"ClientSettings_WORK_OPTIMS_BY_API_MASK" +---|"ClientSettings_WORK_OPTIMS_BY_GPU_CATEGORY" +---|"ClipCursor" +---|"Collision" +---|"ConsoleKey" +---|"ContentTuning" +---|"Contrast" +---|"CursorCenteredYPos" +---|"CursorFreelookCentering" +---|"CursorFreelookStartDelta" +---|"CursorStickyCentering" +---|"CustomDesignEventLog" +---|"CustomWindowEventLog" +---|"DamageCalculator" +---|"DebugTorsoTwist" +---|"DeprecatedWarningThrottle" +---|"DepthBasedOpacity" +---|"DisableAdvancedFlyingFullScreenEffects" +---|"DisableAdvancedFlyingVelocityVFX" +---|"DriveDynamicFOVEnabled" +---|"DriveSwapReverseTurnDirection" +---|"DriverVersionCheck" +---|"DynamicRenderScale" +---|"DynamicRenderScaleMin" +---|"EJDungeonDifficulty" +---|"EJLootClass" +---|"EJLootSpec" +---|"EJRaidDifficulty" +---|"EJSelectedTier" +---|"EmitterCombatRange" +---|"EmpowerMinHoldStagePercent" +---|"EmpowerTapControlsReleaseThreshold" +---|"EnableBlinkApplicationIcon" +---|"ErrorFilter" +---|"ErrorLevelMax" +---|"ErrorLevelMin" +---|"Errors" +---|"ExclusiveWindowMode" +---|"FootstepSounds" +---|"ForceGenerateSlug" +---|"ForceResolutionDefaultToMaxSize" +---|"FrameBufferCacheForceNoHeaps" +---|"GameDataVisualizer" +---|"GamePadAnalogMovement" +---|"GamePadCameraLookMaxPitch" +---|"GamePadCameraLookMaxYaw" +---|"GamePadCameraPitchSpeed" +---|"GamePadCameraYawSpeed" +---|"GamePadCursorAutoDisableJump" +---|"GamePadCursorAutoDisableSticks" +---|"GamePadCursorAutoEnable" +---|"GamePadCursorCenteredEmulation" +---|"GamePadCursorCentering" +---|"GamePadCursorForTargeting" +---|"GamePadCursorLeftClick" +---|"GamePadCursorOnLogin" +---|"GamePadCursorPushCamera" +---|"GamePadCursorRightClick" +---|"GamePadCursorSpeedAccel" +---|"GamePadCursorSpeedMax" +---|"GamePadCursorSpeedStart" +---|"GamePadEmulateAlt" +---|"GamePadEmulateCtrl" +---|"GamePadEmulateShift" +---|"GamePadEmulateTapWindowMs" +---|"GamePadEnable" +---|"GamePadFaceMovementMaxAngle" +---|"GamePadFaceMovementMaxAngleCombat" +---|"GamePadFactionColor" +---|"GamePadOverlapMouseMs" +---|"GamePadRunThreshold" +---|"GamePadSingleActiveID" +---|"GamePadStickAxisButtons" +---|"GamePadTankTurnSpeed" +---|"GamePadTouchCursorEnable" +---|"GamePadTurnWithCamera" +---|"GamePadVibrationStrength" +---|"GameplayContext" +---|"Gamma" +---|"GxAFRDevicesCount" +---|"GxAdapter" +---|"GxAllowCachelessShaderMode" +---|"GxApi" +---|"GxCompatAllowSM6" +---|"GxCompatAsyncComputeQueue" +---|"GxCompatAsyncShaderCompilation" +---|"GxCompatCommandListMultiThreading" +---|"GxCompatCopyQueue" +---|"GxCompatOptionalGpuFeatures" +---|"GxCompatWorkSubmitOptimizations" +---|"GxFullscreenResolution" +---|"GxMaxFrameLatency" +---|"GxMaximize" +---|"GxMonitor" +---|"GxNewResolution" +---|"GxPrismEnabled" +---|"GxSlowShaderWarnThreshold" +---|"GxWindowedResolution" +---|"HardwareCursor" +---|"HealHandler" +---|"HotfixEventLog" +---|"ImpactModelCollisionMelee" +---|"ImpactModelCollisionMissile" +---|"ImpactModelCollisionRanged" +---|"InvalidateDeactivatedHandles" +---|"KioskCanSessionExpire" +---|"KioskCharacterTemplateSet" +---|"KioskLobbyKickSeconds" +---|"LowLatencyMinInterval" +---|"LowLatencyMode" +---|"M2ForceAdditiveParticleSort" +---|"M2UseInstancing" +---|"M2UseThreads" +---|"MSAAAlphaTest" +---|"MSAAQuality" +---|"MaxCharacterComponentLoadStartsPerFrame" +---|"MaxObservedPetBattles" +---|"MouseHiddenInRelativeMode" +---|"MoveHistoryEventLog" +---|"NonEmitterCombatRange" +---|"NotchedDisplayMode" +---|"ObjectSelectionCircle" +---|"Outline" +---|"OutlineEngineMode" +---|"POIShiftComplete" +---|"Pathing" +---|"PhaseHistory" +---|"PlayerSpawnTracking" +---|"PraiseTheSun" +---|"PreemptiveCastEnable" +---|"PreventOsIdleSleep" +---|"ProcDebugEventLog" +---|"PushToTalkSound" +---|"QuestEventLog" +---|"RAIDDepthBasedOpacity" +---|"RAIDOutlineEngineMode" +---|"RAIDParticulatesEnabled" +---|"RAIDSSAO" +---|"RAIDTerrainLodDiv" +---|"RAIDVolumeFog" +---|"RAIDVolumeFogLevel" +---|"RAIDWaterDetail" +---|"RAIDclusteredShading" +---|"RAIDcomponentTextureLevel" +---|"RAIDdoodadLodScale" +---|"RAIDentityLodDist" +---|"RAIDentityShadowFadeScale" +---|"RAIDfarclip" +---|"RAIDgraphicsQuality" +---|"RAIDgroundEffectDensity" +---|"RAIDgroundEffectDist" +---|"RAIDgroundEffectFade" +---|"RAIDhorizonClip" +---|"RAIDhorizonStart" +---|"RAIDlodObjectCullDist" +---|"RAIDlodObjectCullSize" +---|"RAIDlodObjectFadeScale" +---|"RAIDlodObjectMinSize" +---|"RAIDparticleDensity" +---|"RAIDparticleMTDensity" +---|"RAIDprojectedTextures" +---|"RAIDreflectionMode" +---|"RAIDrefraction" +---|"RAIDrippleDetail" +---|"RAIDsettingsEnabled" +---|"RAIDshadowBlendCascades" +---|"RAIDshadowMode" +---|"RAIDshadowNumCascades" +---|"RAIDshadowRt" +---|"RAIDshadowSoft" +---|"RAIDshadowTextureSize" +---|"RAIDspellClutter" +---|"RAIDsunShafts" +---|"RAIDterrainLodDist" +---|"RAIDterrainMipLevel" +---|"RAIDweatherDensity" +---|"RAIDwmoLodDist" +---|"RAIDworldBaseMip" +---|"RenderFormat" +---|"RenderScale" +---|"RenderScaleDowngradeBackgroundMinSize" +---|"RenderScaleDowngradeForegroundMinSize" +---|"ReplaceMyPlayerPortrait" +---|"ReplaceOtherPlayerPortraits" +---|"ResampleAlwaysSharpen" +---|"ResampleQuality" +---|"ResampleSharpness" +---|"ResizeConstraints" +---|"SSAO" +---|"SSAOType" +---|"ServerMessageEventLog" +---|"ShakeStrengthCamera" +---|"ShakeStrengthUI" +---|"ShowQuestUnitCircles" +---|"SkyCloudLOD" +---|"SlugOpticalWeight" +---|"SlugSupersampling" +---|"SoftTargetEnemy" +---|"SoftTargetEnemyArc" +---|"SoftTargetEnemyRange" +---|"SoftTargetForce" +---|"SoftTargetFriend" +---|"SoftTargetFriendArc" +---|"SoftTargetFriendRange" +---|"SoftTargetIconEnemy" +---|"SoftTargetIconFriend" +---|"SoftTargetIconGameObject" +---|"SoftTargetIconInteract" +---|"SoftTargetInteract" +---|"SoftTargetInteractArc" +---|"SoftTargetInteractRange" +---|"SoftTargetInteractRangeIsHard" +---|"SoftTargetLowPriorityIcons" +---|"SoftTargetMatchLocked" +---|"SoftTargetNameplateEnemy" +---|"SoftTargetNameplateFriend" +---|"SoftTargetNameplateInteract" +---|"SoftTargetNameplateSize" +---|"SoftTargetTooltipDurationMs" +---|"SoftTargetTooltipEnemy" +---|"SoftTargetTooltipFriend" +---|"SoftTargetTooltipInteract" +---|"SoftTargetTooltipLocked" +---|"SoftTargetWithLocked" +---|"SoftTargetWorldtextFarDist" +---|"SoftTargetWorldtextNearDist" +---|"SoftTargetWorldtextNearScale" +---|"SoftTargetWorldtextSize" +---|"SoundPerf_VariationCap" +---|"Sound_AllyPlayerHighpassDSPCutoff" +---|"Sound_AlternateListener" +---|"Sound_AmbienceHighpassDSPCutoff" +---|"Sound_AmbienceVolume" +---|"Sound_DSPBufferSize" +---|"Sound_DialogVolume" +---|"Sound_EnableAllSound" +---|"Sound_EnableAmbience" +---|"Sound_EnableArmorFoleySoundForOthers" +---|"Sound_EnableArmorFoleySoundForSelf" +---|"Sound_EnableDSPEffects" +---|"Sound_EnableDialog" +---|"Sound_EnableEmoteSounds" +---|"Sound_EnableEncounterWarningsSounds" +---|"Sound_EnableErrorSpeech" +---|"Sound_EnableGameplaySFX" +---|"Sound_EnableMixMode2" +---|"Sound_EnableMusic" +---|"Sound_EnablePetBattleMusic" +---|"Sound_EnablePetSounds" +---|"Sound_EnablePingSounds" +---|"Sound_EnablePositionalLowPassFilter" +---|"Sound_EnableReverb" +---|"Sound_EnableSFX" +---|"Sound_EnableSoundWhenGameIsInBG" +---|"Sound_EncounterWarningsVolume" +---|"Sound_EnemyPlayerHighpassDSPCutoff" +---|"Sound_GameplaySFX" +---|"Sound_ListenerAtCharacter" +---|"Sound_MasterVolume" +---|"Sound_MaxCacheSizeInBytes" +---|"Sound_MaxCacheableSizeInBytes" +---|"Sound_MusicVolume" +---|"Sound_NPCHighpassDSPCutoff" +---|"Sound_NumChannels" +---|"Sound_OutputDriverIndex" +---|"Sound_OutputDriverName" +---|"Sound_OutputSampleRate" +---|"Sound_PingVolume" +---|"Sound_SFXVolume" +---|"Sound_VoiceChatInputDriverIndex" +---|"Sound_VoiceChatInputDriverName" +---|"Sound_VoiceChatOutputDriverIndex" +---|"Sound_VoiceChatOutputDriverName" +---|"Sound_ZoneMusicNoDelay" +---|"SpawnRegion" +---|"SpellCooldownDebugger" +---|"SpellEventLog" +---|"SpellOverrides" +---|"SpellQueueWindow" +---|"SpellScriptEventLog" +---|"SpellTargeting" +---|"SpellVisuals" +---|"SplineOpt" +---|"SuppressCpuMicrocodeChecks" +---|"TTSUseCharacterSettings" +---|"TargetAutoEnemy" +---|"TargetAutoFriend" +---|"TargetAutoLock" +---|"TargetEnemyAttacker" +---|"TargetNearestUseNew" +---|"TargetPriorityCombatLock" +---|"TargetPriorityCombatLockContextualRelaxation" +---|"TargetPriorityCombatLockHighlight" +---|"TargetPriorityPvp" +---|"TerrainLodDiv" +---|"ThreadPoolLimitHP" +---|"ThreadPoolLimitLP" +---|"ThreadPoolLimitMP" +---|"TurnSpeed" +---|"UberTooltips" +---|"UnitEnterCombatLog" +---|"UnitNameEnemyGuardianName" +---|"UnitNameEnemyMinionName" +---|"UnitNameEnemyPetName" +---|"UnitNameEnemyPlayerName" +---|"UnitNameEnemyTotemName" +---|"UnitNameFocused" +---|"UnitNameForceHideMinus" +---|"UnitNameFriendlyGuardianName" +---|"UnitNameFriendlyMinionName" +---|"UnitNameFriendlyPetName" +---|"UnitNameFriendlyPlayerName" +---|"UnitNameFriendlySpecialNPCName" +---|"UnitNameFriendlyTotemName" +---|"UnitNameGuildTitle" +---|"UnitNameHostleNPC" +---|"UnitNameInteractiveNPC" +---|"UnitNameNPC" +---|"UnitNameNonCombatCreatureName" +---|"UnitNameOwn" +---|"UnitNamePlayerGuild" +---|"UnitNamePlayerPVPTitle" +---|"UnitVisibility" +---|"UseKeyHeldSpellErrorPollTime" +---|"UseSlug" +---|"VerboseSpellScriptEventLog" +---|"VoiceChatMasterVolumeScale" +---|"VoiceCommunicationMode" +---|"VoiceEnableWhenGameIsInBG" +---|"VoiceInputDevice" +---|"VoiceInputVolume" +---|"VoiceOutputDevice" +---|"VoiceOutputVolume" +---|"VoicePushToTalkKeybind" +---|"VoiceSelfDeafened" +---|"VoiceSelfMuted" +---|"VoiceVADSensitivity" +---|"WalkableSurfacesValidationLog" +---|"WorldActionsLog" +---|"WorldTextCritScreenY_v2" +---|"WorldTextGravity_v2" +---|"WorldTextMinAlpha_v2" +---|"WorldTextMinSize" +---|"WorldTextNonRandomZ_v2" +---|"WorldTextRampDuration_v2" +---|"WorldTextRampPowCrit_v2" +---|"WorldTextRampPow_v2" +---|"WorldTextRandomXY_v2" +---|"WorldTextRandomZMax_v2" +---|"WorldTextRandomZMin_v2" +---|"WorldTextScale_v2" +---|"WorldTextScreenY_v2" +---|"WorldTextStartPosRandomness_v2" +---|"accountNeedsTurnStrafeDialog" +---|"acknowledgedArrowCallouts" +---|"actionedAdventureJournalEntries" +---|"addFriendInfoShown" +---|"addonChallengeModeRestrictionsForced" +---|"addonChatRestrictionsForced" +---|"addonCombatRestrictionsForced" +---|"addonEncounterRestrictionsForced" +---|"addonLoadDebugging" +---|"addonMapRestrictionsForced" +---|"addonPerformanceMsgError" +---|"addonPerformanceMsgOverall" +---|"addonPerformanceMsgWarning" +---|"addonPvPMatchRestrictionsForced" +---|"advFlyKeyboardMaxPitchFactor" +---|"advFlyKeyboardMaxTurnFactor" +---|"advFlyKeyboardMinPitchFactor" +---|"advFlyKeyboardMinTurnFactor" +---|"advFlyPitchControl" +---|"advFlyPitchControlCameraChase" +---|"advFlyPitchControlGroundDebounce" +---|"advancedCombatLogging" +---|"agentUID" +---|"allowCompareWithToggle" +---|"allowDevPublicKey" +---|"alwaysCompareItems" +---|"alwaysShowRuneIcons" +---|"animFrameSkipLOD" +---|"arachnophobiaMode" +---|"assaoAdaptiveQualityLimit" +---|"assaoBlurPassCount" +---|"assaoDetailShadowStrength" +---|"assaoFadeOutFrom" +---|"assaoFadeOutTo" +---|"assaoHorizonAngleThresh" +---|"assaoNormals" +---|"assaoRadius" +---|"assaoShadowClamp" +---|"assaoShadowMult" +---|"assaoShadowPower" +---|"assaoSharpness" +---|"assaoTemporalSSAngleOffset" +---|"assaoTemporalSSRadiusOffset" +---|"assistAttack" +---|"assistedCombatHighlight" +---|"assistedCombatHighlightRPE" +---|"assistedCombatIconUpdateRate" +---|"asyncHandlerTimeout" +---|"asyncThreadSleep" +---|"auctionDisplayOnCharacter" +---|"auctionHouseDurationDropdown" +---|"auctionSortByBuyoutPrice" +---|"auctionSortByUnitPrice" +---|"audioLocale" +---|"autoAcceptQuickJoinRequests" +---|"autoClearAFK" +---|"autoCompleteResortNamesOnRecency" +---|"autoCompleteUseContext" +---|"autoCompleteWhenEditingFromCenter" +---|"autoDismount" +---|"autoDismountFlying" +---|"autoFilledMultiCastSlots" +---|"autoInteract" +---|"autoLootDefault" +---|"autoLootRate" +---|"autoQuestPopUps" +---|"autoQuestProgress" +---|"autoQuestWatch" +---|"autoSelfCast" +---|"autoStand" +---|"autoUnshift" +---|"autojoinBGVoice" +---|"autojoinPartyVoice" +---|"bankAutoDepositReagents" +---|"bankConfirmTabCleanUp" +---|"blockChannelInvites" +---|"blockTrades" +---|"bodyQuota" +---|"breakUpLargeNumbers" +---|"buffDurations" +---|"cacaoBilateralSimilarityDistanceSigma" +---|"calendarShowBattlegrounds" +---|"calendarShowDarkmoon" +---|"calendarShowHolidays" +---|"calendarShowLockouts" +---|"calendarShowResets" +---|"calendarShowWeeklyHolidays" +---|"cameraBobbing" +---|"cameraBobbingSmoothSpeed" +---|"cameraCustomViewSmoothing" +---|"cameraDistanceMaxZoomFactor" +---|"cameraDistanceRateMult" +---|"cameraDive" +---|"cameraFoVSmoothSpeed" +---|"cameraFov" +---|"cameraGroundSmoothSpeed" +---|"cameraHeightIgnoreStandState" +---|"cameraIndirectOffset" +---|"cameraIndirectVisibility" +---|"cameraPitchMoveSpeed" +---|"cameraPitchSmoothMax" +---|"cameraPitchSmoothMin" +---|"cameraPitchSmoothSpeed" +---|"cameraPivot" +---|"cameraPivotDXMax" +---|"cameraPivotDYMin" +---|"cameraSavedDistance" +---|"cameraSavedPetBattleDistance" +---|"cameraSavedPitch" +---|"cameraSavedVehicleDistance" +---|"cameraSmooth" +---|"cameraSmoothAlwaysFearDelay" +---|"cameraSmoothAlwaysFearFactor" +---|"cameraSmoothAlwaysIdleDelay" +---|"cameraSmoothAlwaysIdleFactor" +---|"cameraSmoothAlwaysMoveDelay" +---|"cameraSmoothAlwaysMoveFactor" +---|"cameraSmoothAlwaysStopDelay" +---|"cameraSmoothAlwaysStopFactor" +---|"cameraSmoothAlwaysStrafeDelay" +---|"cameraSmoothAlwaysStrafeFactor" +---|"cameraSmoothAlwaysTrackDelay" +---|"cameraSmoothAlwaysTrackFactor" +---|"cameraSmoothAlwaysTurnDelay" +---|"cameraSmoothAlwaysTurnFactor" +---|"cameraSmoothNeverFearDelay" +---|"cameraSmoothNeverFearFactor" +---|"cameraSmoothNeverIdleDelay" +---|"cameraSmoothNeverIdleFactor" +---|"cameraSmoothNeverMoveDelay" +---|"cameraSmoothNeverMoveFactor" +---|"cameraSmoothNeverStopDelay" +---|"cameraSmoothNeverStopFactor" +---|"cameraSmoothNeverStrafeDelay" +---|"cameraSmoothNeverStrafeFactor" +---|"cameraSmoothNeverTrackDelay" +---|"cameraSmoothNeverTrackFactor" +---|"cameraSmoothNeverTurnDelay" +---|"cameraSmoothNeverTurnFactor" +---|"cameraSmoothPitch" +---|"cameraSmoothSmartFearDelay" +---|"cameraSmoothSmartFearFactor" +---|"cameraSmoothSmartIdleDelay" +---|"cameraSmoothSmartIdleFactor" +---|"cameraSmoothSmartMoveDelay" +---|"cameraSmoothSmartMoveFactor" +---|"cameraSmoothSmartStopDelay" +---|"cameraSmoothSmartStopFactor" +---|"cameraSmoothSmartStrafeDelay" +---|"cameraSmoothSmartStrafeFactor" +---|"cameraSmoothSmartTrackDelay" +---|"cameraSmoothSmartTrackFactor" +---|"cameraSmoothSmartTurnDelay" +---|"cameraSmoothSmartTurnFactor" +---|"cameraSmoothSmarterFearDelay" +---|"cameraSmoothSmarterFearFactor" +---|"cameraSmoothSmarterIdleDelay" +---|"cameraSmoothSmarterIdleFactor" +---|"cameraSmoothSmarterMoveDelay" +---|"cameraSmoothSmarterMoveFactor" +---|"cameraSmoothSmarterStopDelay" +---|"cameraSmoothSmarterStopFactor" +---|"cameraSmoothSmarterStrafeDelay" +---|"cameraSmoothSmarterStrafeFactor" +---|"cameraSmoothSmarterTrackDelay" +---|"cameraSmoothSmarterTrackFactor" +---|"cameraSmoothSmarterTurnDelay" +---|"cameraSmoothSmarterTurnFactor" +---|"cameraSmoothSplineFearDelay" +---|"cameraSmoothSplineFearFactor" +---|"cameraSmoothSplineIdleDelay" +---|"cameraSmoothSplineIdleFactor" +---|"cameraSmoothSplineMoveDelay" +---|"cameraSmoothSplineMoveFactor" +---|"cameraSmoothSplineStopDelay" +---|"cameraSmoothSplineStopFactor" +---|"cameraSmoothSplineStrafeDelay" +---|"cameraSmoothSplineStrafeFactor" +---|"cameraSmoothSplineTrackDelay" +---|"cameraSmoothSplineTrackFactor" +---|"cameraSmoothSplineTurnDelay" +---|"cameraSmoothSplineTurnFactor" +---|"cameraSmoothStyle" +---|"cameraSmoothTimeMax" +---|"cameraSmoothTimeMin" +---|"cameraSmoothTrackingStyle" +---|"cameraSmoothViewDataAlwaysDistanceDelay" +---|"cameraSmoothViewDataAlwaysDistanceFactor" +---|"cameraSmoothViewDataAlwaysPitchDelay" +---|"cameraSmoothViewDataAlwaysPitchFactor" +---|"cameraSmoothViewDataAlwaysYawDelay" +---|"cameraSmoothViewDataAlwaysYawFactor" +---|"cameraSmoothViewDataNeverDistanceDelay" +---|"cameraSmoothViewDataNeverDistanceFactor" +---|"cameraSmoothViewDataNeverPitchDelay" +---|"cameraSmoothViewDataNeverPitchFactor" +---|"cameraSmoothViewDataNeverYawDelay" +---|"cameraSmoothViewDataNeverYawFactor" +---|"cameraSmoothViewDataSmartDistanceDelay" +---|"cameraSmoothViewDataSmartDistanceFactor" +---|"cameraSmoothViewDataSmartPitchDelay" +---|"cameraSmoothViewDataSmartPitchFactor" +---|"cameraSmoothViewDataSmartYawDelay" +---|"cameraSmoothViewDataSmartYawFactor" +---|"cameraSmoothViewDataSmarterDistanceDelay" +---|"cameraSmoothViewDataSmarterDistanceFactor" +---|"cameraSmoothViewDataSmarterPitchDelay" +---|"cameraSmoothViewDataSmarterPitchFactor" +---|"cameraSmoothViewDataSmarterYawDelay" +---|"cameraSmoothViewDataSmarterYawFactor" +---|"cameraSmoothViewDataSplineDistanceDelay" +---|"cameraSmoothViewDataSplineDistanceFactor" +---|"cameraSmoothViewDataSplinePitchDelay" +---|"cameraSmoothViewDataSplinePitchFactor" +---|"cameraSmoothViewDataSplineYawDelay" +---|"cameraSmoothViewDataSplineYawFactor" +---|"cameraSmoothYaw" +---|"cameraSubmergePitch" +---|"cameraSurfacePitch" +---|"cameraTargetSmoothSpeed" +---|"cameraTerrainTilt" +---|"cameraTerrainTiltAlwaysFallAbsorb" +---|"cameraTerrainTiltAlwaysFallDelay" +---|"cameraTerrainTiltAlwaysFallFactor" +---|"cameraTerrainTiltAlwaysFearAbsorb" +---|"cameraTerrainTiltAlwaysFearDelay" +---|"cameraTerrainTiltAlwaysFearFactor" +---|"cameraTerrainTiltAlwaysIdleAbsorb" +---|"cameraTerrainTiltAlwaysIdleDelay" +---|"cameraTerrainTiltAlwaysIdleFactor" +---|"cameraTerrainTiltAlwaysJumpAbsorb" +---|"cameraTerrainTiltAlwaysJumpDelay" +---|"cameraTerrainTiltAlwaysJumpFactor" +---|"cameraTerrainTiltAlwaysMoveAbsorb" +---|"cameraTerrainTiltAlwaysMoveDelay" +---|"cameraTerrainTiltAlwaysMoveFactor" +---|"cameraTerrainTiltAlwaysStrafeAbsorb" +---|"cameraTerrainTiltAlwaysStrafeDelay" +---|"cameraTerrainTiltAlwaysStrafeFactor" +---|"cameraTerrainTiltAlwaysSwimAbsorb" +---|"cameraTerrainTiltAlwaysSwimDelay" +---|"cameraTerrainTiltAlwaysSwimFactor" +---|"cameraTerrainTiltAlwaysTaxiAbsorb" +---|"cameraTerrainTiltAlwaysTaxiDelay" +---|"cameraTerrainTiltAlwaysTaxiFactor" +---|"cameraTerrainTiltAlwaysTrackAbsorb" +---|"cameraTerrainTiltAlwaysTrackDelay" +---|"cameraTerrainTiltAlwaysTrackFactor" +---|"cameraTerrainTiltAlwaysTurnAbsorb" +---|"cameraTerrainTiltAlwaysTurnDelay" +---|"cameraTerrainTiltAlwaysTurnFactor" +---|"cameraTerrainTiltNeverFallAbsorb" +---|"cameraTerrainTiltNeverFallDelay" +---|"cameraTerrainTiltNeverFallFactor" +---|"cameraTerrainTiltNeverFearAbsorb" +---|"cameraTerrainTiltNeverFearDelay" +---|"cameraTerrainTiltNeverFearFactor" +---|"cameraTerrainTiltNeverIdleAbsorb" +---|"cameraTerrainTiltNeverIdleDelay" +---|"cameraTerrainTiltNeverIdleFactor" +---|"cameraTerrainTiltNeverJumpAbsorb" +---|"cameraTerrainTiltNeverJumpDelay" +---|"cameraTerrainTiltNeverJumpFactor" +---|"cameraTerrainTiltNeverMoveAbsorb" +---|"cameraTerrainTiltNeverMoveDelay" +---|"cameraTerrainTiltNeverMoveFactor" +---|"cameraTerrainTiltNeverStrafeAbsorb" +---|"cameraTerrainTiltNeverStrafeDelay" +---|"cameraTerrainTiltNeverStrafeFactor" +---|"cameraTerrainTiltNeverSwimAbsorb" +---|"cameraTerrainTiltNeverSwimDelay" +---|"cameraTerrainTiltNeverSwimFactor" +---|"cameraTerrainTiltNeverTaxiAbsorb" +---|"cameraTerrainTiltNeverTaxiDelay" +---|"cameraTerrainTiltNeverTaxiFactor" +---|"cameraTerrainTiltNeverTrackAbsorb" +---|"cameraTerrainTiltNeverTrackDelay" +---|"cameraTerrainTiltNeverTrackFactor" +---|"cameraTerrainTiltNeverTurnAbsorb" +---|"cameraTerrainTiltNeverTurnDelay" +---|"cameraTerrainTiltNeverTurnFactor" +---|"cameraTerrainTiltSmartFallAbsorb" +---|"cameraTerrainTiltSmartFallDelay" +---|"cameraTerrainTiltSmartFallFactor" +---|"cameraTerrainTiltSmartFearAbsorb" +---|"cameraTerrainTiltSmartFearDelay" +---|"cameraTerrainTiltSmartFearFactor" +---|"cameraTerrainTiltSmartIdleAbsorb" +---|"cameraTerrainTiltSmartIdleDelay" +---|"cameraTerrainTiltSmartIdleFactor" +---|"cameraTerrainTiltSmartJumpAbsorb" +---|"cameraTerrainTiltSmartJumpDelay" +---|"cameraTerrainTiltSmartJumpFactor" +---|"cameraTerrainTiltSmartMoveAbsorb" +---|"cameraTerrainTiltSmartMoveDelay" +---|"cameraTerrainTiltSmartMoveFactor" +---|"cameraTerrainTiltSmartStrafeAbsorb" +---|"cameraTerrainTiltSmartStrafeDelay" +---|"cameraTerrainTiltSmartStrafeFactor" +---|"cameraTerrainTiltSmartSwimAbsorb" +---|"cameraTerrainTiltSmartSwimDelay" +---|"cameraTerrainTiltSmartSwimFactor" +---|"cameraTerrainTiltSmartTaxiAbsorb" +---|"cameraTerrainTiltSmartTaxiDelay" +---|"cameraTerrainTiltSmartTaxiFactor" +---|"cameraTerrainTiltSmartTrackAbsorb" +---|"cameraTerrainTiltSmartTrackDelay" +---|"cameraTerrainTiltSmartTrackFactor" +---|"cameraTerrainTiltSmartTurnAbsorb" +---|"cameraTerrainTiltSmartTurnDelay" +---|"cameraTerrainTiltSmartTurnFactor" +---|"cameraTerrainTiltSmarterFallAbsorb" +---|"cameraTerrainTiltSmarterFallDelay" +---|"cameraTerrainTiltSmarterFallFactor" +---|"cameraTerrainTiltSmarterFearAbsorb" +---|"cameraTerrainTiltSmarterFearDelay" +---|"cameraTerrainTiltSmarterFearFactor" +---|"cameraTerrainTiltSmarterIdleAbsorb" +---|"cameraTerrainTiltSmarterIdleDelay" +---|"cameraTerrainTiltSmarterIdleFactor" +---|"cameraTerrainTiltSmarterJumpAbsorb" +---|"cameraTerrainTiltSmarterJumpDelay" +---|"cameraTerrainTiltSmarterJumpFactor" +---|"cameraTerrainTiltSmarterMoveAbsorb" +---|"cameraTerrainTiltSmarterMoveDelay" +---|"cameraTerrainTiltSmarterMoveFactor" +---|"cameraTerrainTiltSmarterStrafeAbsorb" +---|"cameraTerrainTiltSmarterStrafeDelay" +---|"cameraTerrainTiltSmarterStrafeFactor" +---|"cameraTerrainTiltSmarterSwimAbsorb" +---|"cameraTerrainTiltSmarterSwimDelay" +---|"cameraTerrainTiltSmarterSwimFactor" +---|"cameraTerrainTiltSmarterTaxiAbsorb" +---|"cameraTerrainTiltSmarterTaxiDelay" +---|"cameraTerrainTiltSmarterTaxiFactor" +---|"cameraTerrainTiltSmarterTrackAbsorb" +---|"cameraTerrainTiltSmarterTrackDelay" +---|"cameraTerrainTiltSmarterTrackFactor" +---|"cameraTerrainTiltSmarterTurnAbsorb" +---|"cameraTerrainTiltSmarterTurnDelay" +---|"cameraTerrainTiltSmarterTurnFactor" +---|"cameraTerrainTiltSplineFallAbsorb" +---|"cameraTerrainTiltSplineFallDelay" +---|"cameraTerrainTiltSplineFallFactor" +---|"cameraTerrainTiltSplineFearAbsorb" +---|"cameraTerrainTiltSplineFearDelay" +---|"cameraTerrainTiltSplineFearFactor" +---|"cameraTerrainTiltSplineIdleAbsorb" +---|"cameraTerrainTiltSplineIdleDelay" +---|"cameraTerrainTiltSplineIdleFactor" +---|"cameraTerrainTiltSplineJumpAbsorb" +---|"cameraTerrainTiltSplineJumpDelay" +---|"cameraTerrainTiltSplineJumpFactor" +---|"cameraTerrainTiltSplineMoveAbsorb" +---|"cameraTerrainTiltSplineMoveDelay" +---|"cameraTerrainTiltSplineMoveFactor" +---|"cameraTerrainTiltSplineStrafeAbsorb" +---|"cameraTerrainTiltSplineStrafeDelay" +---|"cameraTerrainTiltSplineStrafeFactor" +---|"cameraTerrainTiltSplineSwimAbsorb" +---|"cameraTerrainTiltSplineSwimDelay" +---|"cameraTerrainTiltSplineSwimFactor" +---|"cameraTerrainTiltSplineTaxiAbsorb" +---|"cameraTerrainTiltSplineTaxiDelay" +---|"cameraTerrainTiltSplineTaxiFactor" +---|"cameraTerrainTiltSplineTrackAbsorb" +---|"cameraTerrainTiltSplineTrackDelay" +---|"cameraTerrainTiltSplineTrackFactor" +---|"cameraTerrainTiltSplineTurnAbsorb" +---|"cameraTerrainTiltSplineTurnDelay" +---|"cameraTerrainTiltSplineTurnFactor" +---|"cameraTerrainTiltTimeMax" +---|"cameraTerrainTiltTimeMin" +---|"cameraView" +---|"cameraViewBlendStyle" +---|"cameraWaterCollision" +---|"cameraYawMoveSpeed" +---|"cameraYawSmoothMax" +---|"cameraYawSmoothMin" +---|"cameraYawSmoothSpeed" +---|"cameraZSmooth" +---|"cameraZoomSpeed" +---|"casContainerSizeLimit" +---|"characterNeedsTurnStrafeDialog" +---|"characterSocialRestrictionSettingsApplied" +---|"chatBubbles" +---|"chatBubblesParty" +---|"chatBubblesRaid" +---|"chatClassColorOverride" +---|"chatMouseScroll" +---|"chatStyle" +---|"checkAddonVersion" +---|"cloakFixEnabled" +---|"closedExtraAbiltyTutorials" +---|"closedInfoFrames" +---|"closedInfoFramesAccountWide" +---|"closedRemixArtifactTutorialFrames" +---|"clubFinderCacheExpiry" +---|"clubFinderCachePendingExpiry" +---|"clubFinderPlayerLanguageSettings" +---|"clubFinderPlayerSettings" +---|"clusteredShading" +---|"collapseExpandBuffs" +---|"collapsedCurrencyCategoryDefaults" +---|"collapsedReputationHeaderDefaults" +---|"colorChatNamesByClass" +---|"colorblindMode" +---|"colorblindSimulator" +---|"colorblindWeaknessFactor" +---|"combatLogRetentionTime" +---|"combatLogUniqueFilename" +---|"combatWarningsEnabled" +---|"combinedBags" +---|"comboPointLocation" +---|"commentatorLossOfControlIconUnitFrame" +---|"commentatorLossOfControlTextNameplate" +---|"commentatorLossOfControlTextUnitFrame" +---|"communitiesShowOffline" +---|"componentCompress" +---|"componentEmissive" +---|"componentSpecular" +---|"componentTexCacheSize" +---|"componentTexLoadLimit" +---|"componentTextureLevel" +---|"componentThread" +---|"consoleShowDebugMessages" +---|"consoleShowSpamMessages" +---|"contentTrackingFilter" +---|"cooldownViewerEnabled" +---|"cooldownViewerShowUnlearned" +---|"countdownForCooldowns" +---|"covenantMissionTutorial" +---|"craftingOrdersOnlyPreferredArmorCollectable" +---|"currencyCategoriesCollapsed" +---|"currentGameMode" +---|"cursorSizePreferred" +---|"daltonize" +---|"damageMeterEnabled" +---|"damageMeterResetOnNewInstance" +---|"dangerousShipyardMissionWarningAlreadyShown" +---|"debugGameEvents" +---|"deselectOnClick" +---|"digSites" +---|"disableAELooting" +---|"disableAutoRealmSelect" +---|"disableServerNagle" +---|"disableSuggestedLevelActivityFilter" +---|"disableUILoadErrorDialog" +---|"disableUserAddonsByDefault" +---|"displaySpellActivationOverlays" +---|"displayWorldPVPObjectives" +---|"dnMTUpdate" +---|"doNotFlashLowHealthWarning" +---|"doNotShowTWFraudWarning" +---|"dontShowEquipmentSetsOnItems" +---|"doodadLodScale" +---|"dragonRidingRacesFilter" +---|"dragonRidingRacesFilterWQ" +---|"dynamicLod" +---|"emphasizeMySpellEffects" +---|"empowerTapControls" +---|"enableAssetTracking" +---|"enableBGDL" +---|"enableConnectToPhotoSharing" +---|"enableFloatingCombatText" +---|"enableMouseSpeed" +---|"enableMouseoverCast" +---|"enableMovePad" +---|"enableMultiActionBars" +---|"enablePVPNotifyAFK" +---|"enablePetBattleFloatingCombatText_v2" +---|"enablePings" +---|"enableQuestCacheLogging" +---|"enableRuneSpentAnim" +---|"enableSourceLocationLookup" +---|"enableWowMouse" +---|"encounterTimelineEnabled" +---|"encounterTimelineHideForOtherRoles" +---|"encounterTimelineHideLongCountdowns" +---|"encounterTimelineHideQueuedCountdowns" +---|"encounterTimelineHighlightDuration" +---|"encounterTimelineIconographyEnabled" +---|"encounterTimelineShowSequenceCount" +---|"encounterWarningsDefaultMessageDuration" +---|"encounterWarningsEnabled" +---|"encounterWarningsHideIfNotTargetingPlayer" +---|"encounterWarningsLevel" +---|"endeavorInitiativesLastPointsMap" +---|"engineSurvey" +---|"engineSurveyPatch" +---|"entityLodDist" +---|"entityLodOffset" +---|"entityShadowFadeScale" +---|"equipmentManager" +---|"eventReminders" +---|"eventSchedulerLastUpdate" +---|"excludedCensorSources" +---|"expandBagBar" +---|"expandUpgradePanel" +---|"expandWarbandCharacterList" +---|"externalDefensivesEnabled" +---|"farclip" +---|"ffxAntiAliasingMode" +---|"ffxDeath" +---|"ffxGlow" +---|"ffxLingeringVenari" +---|"ffxNether" +---|"ffxVenari" +---|"findYourselfAnywhere" +---|"findYourselfAnywhereOnlyInCombat" +---|"findYourselfInBG" +---|"findYourselfInBGOnlyInCombat" +---|"findYourselfInRaid" +---|"findYourselfInRaidOnlyInCombat" +---|"findYourselfMode" +---|"findYourselfModeCircle" +---|"findYourselfModeIcon" +---|"findYourselfModeOutline" +---|"flaggedTutorials" +---|"flashErrorMessageRepeats" +---|"flightAngleLookAhead" +---|"floatingCombatTextAuraFade_v2" +---|"floatingCombatTextAuras_v2" +---|"floatingCombatTextCombatDamageAllAutos_v2" +---|"floatingCombatTextCombatDamageDirectionalOffset_v2" +---|"floatingCombatTextCombatDamageDirectionalScale_v2" +---|"floatingCombatTextCombatDamage_v2" +---|"floatingCombatTextCombatHealingAbsorbSelf_v2" +---|"floatingCombatTextCombatHealingAbsorbTarget_v2" +---|"floatingCombatTextCombatHealing_v2" +---|"floatingCombatTextCombatLogPeriodicSpells_v2" +---|"floatingCombatTextCombatState_v2" +---|"floatingCombatTextComboPoints_v2" +---|"floatingCombatTextDamageReduction_v2" +---|"floatingCombatTextDodgeParryMiss_v2" +---|"floatingCombatTextEnergyGains_v2" +---|"floatingCombatTextFloatMode_v2" +---|"floatingCombatTextFriendlyHealers_v2" +---|"floatingCombatTextHonorGains_v2" +---|"floatingCombatTextLowManaHealth_v2" +---|"floatingCombatTextPeriodicEnergyGains_v2" +---|"floatingCombatTextPetMeleeDamage_v2" +---|"floatingCombatTextPetSpellDamage_v2" +---|"floatingCombatTextReactives_v2" +---|"floatingCombatTextRepChanges_v2" +---|"forceClusteredShading" +---|"forceEnglishNames" +---|"forceLODCheck" +---|"frameScriptFunctionInheritanceWarningMode" +---|"friendInvitesCollapsed" +---|"frontendMatchingModes_WowLabs" +---|"fstack_enabled" +---|"fstack_preferParentKeys" +---|"fstack_showRaisedFrameLevels" +---|"fstack_showanchors" +---|"fstack_showhidden" +---|"fstack_showhighlight" +---|"fstack_showregions" +---|"gameTip" +---|"garrisonCompleteTalent" +---|"garrisonCompleteTalentType" +---|"graphicsComputeEffects" +---|"graphicsDepthEffects" +---|"graphicsEnvironmentDetail" +---|"graphicsGroundClutter" +---|"graphicsLiquidDetail" +---|"graphicsOutlineMode" +---|"graphicsParticleDensity" +---|"graphicsProjectedTextures" +---|"graphicsQuality" +---|"graphicsSSAO" +---|"graphicsShadowQuality" +---|"graphicsSpellDensity" +---|"graphicsTextureResolution" +---|"graphicsViewDistance" +---|"groundEffectDensity" +---|"groundEffectDist" +---|"groundEffectFade" +---|"guildMemberNotify" +---|"guildNewsFilter" +---|"guildRewardsCategory" +---|"guildRewardsUsable" +---|"guildShowOffline" +---|"gxMTAlphaM2" +---|"gxMTAlphaPass" +---|"gxMTBeginDraw" +---|"gxMTDecals" +---|"gxMTDisable" +---|"gxMTLightShafts" +---|"gxMTMisc" +---|"gxMTOpaqueM2" +---|"gxMTOpaqueM2NoReflect" +---|"gxMTOpaqueWMO" +---|"gxMTOutlines" +---|"gxMTPrepass" +---|"gxMTRefraction" +---|"gxMTShadow" +---|"gxMTTerrain" +---|"gxMTTriggerOnBeginDrawComplete" +---|"gxMTVolFog" +---|"hardTrackedQuests" +---|"hardTrackedWorldQuests" +---|"hardcoreDeathAlertType" +---|"hardcoreDeathChatType" +---|"heirloomCollectedFilters" +---|"heirloomSourceFilters" +---|"hideFastLoginLoadingScreen" +---|"hideRewardedEvents" +---|"highestUnlockedTieredEntranceTier" +---|"horizonClip" +---|"horizonStart" +---|"hotReloadModels" +---|"houseExterior_Hide_Decor" +---|"housingDecorFreePlaceEnabled" +---|"housingDecorGridSnapEnabled" +---|"housingDecorGridVisible" +---|"housingExpertGizmos_Scale_FrameOffset" +---|"housingExpertGizmos_Scale_Snap" +---|"housingExpertGizmos_SnapOnHold" +---|"housingLayout_Camera_DefaultDistance" +---|"housingLayout_Camera_DragFriction" +---|"housingLayout_Camera_DragMomentum" +---|"housingLayout_Camera_MaxDistance" +---|"housingLayout_Camera_MaxDistanceIncr" +---|"housingLayout_Camera_MinDistance" +---|"housingLayout_Camera_Smoothness" +---|"housingLayout_Camera_Speed" +---|"housingStoragePanelCollapsed" +---|"housingStoragePanelHeight" +---|"housingStoragePanelWidth" +---|"housingTutorialsEnabled" +---|"hwDetect" +---|"imageSharingPublishCooldown" +---|"incompleteQuestPriorityThresholdDelta" +---|"initialRealmListTimeout" +---|"interactKeyWarningTutorial" +---|"interactOnLeftClick" +---|"interactQuestItems" +---|"lastAddonVersion" +---|"lastCharacterGuid" +---|"lastCharacterIndex" +---|"lastGarrisonMissionTutorial" +---|"lastLaunchedExternalEventURL" +---|"lastLockedDelvesCompanionAbilities" +---|"lastLockedTieredEntranceCompanionAbilities" +---|"lastRenownForCovenant1" +---|"lastRenownForCovenant2" +---|"lastRenownForCovenant3" +---|"lastRenownForCovenant4" +---|"lastRenownForDelvesSeason" +---|"lastSelectedClubId" +---|"lastSelectedTieredEntranceTier" +---|"lastTalkedToGM" +---|"lastTransmogCustomSetIDNoSpec" +---|"lastTransmogCustomSetIDSpec1" +---|"lastTransmogCustomSetIDSpec2" +---|"lastTransmogCustomSetIDSpec3" +---|"lastTransmogCustomSetIDSpec4" +---|"lastTransmogOutfitIDNoSpec" +---|"last_matchmaking_party_size" +---|"latestSplashScreen" +---|"latestTransmogSetSource" +---|"launchAgent" +---|"lfdCollapsedHeaders" +---|"lfdSelectedDungeons" +---|"lfgListAdvancedFilterMinRating" +---|"lfgListAdvancedFilterRemovedActivities" +---|"lfgListAdvancedFilters" +---|"lfgListAdvancedFiltersVersion" +---|"lfgListSearchLanguages" +---|"lfgSelectedRoles" +---|"loadDeprecationFallbacks" +---|"locale" +---|"locateViewerMaxJobs" +---|"lockActionBars" +---|"lodObjectCullDist" +---|"lodObjectCullSize" +---|"lodObjectFadeScale" +---|"lodObjectMinSize" +---|"lodObjectSizeScale" +---|"lootUnderMouse" +---|"lossOfControl" +---|"lossOfControlDisarm" +---|"lossOfControlFull" +---|"lossOfControlInterrupt" +---|"lossOfControlRoot" +---|"lossOfControlSilence" +---|"luaErrorExceptions" +---|"majorFactionRenownMap" +---|"mapFade" +---|"maxFPS" +---|"maxFPSBk" +---|"maxFPSLoading" +---|"maxLevelSpecsUsed" +---|"maxLightCount" +---|"maxLightDist" +---|"miniCommunitiesFrame" +---|"miniDressUpFrame" +---|"miniWorldMap" +---|"minimapInsideZoom" +---|"minimapPortalMax" +---|"minimapShapeshiftTracking" +---|"minimapTrackedInfov4" +---|"minimapTrackingClosestOnly" +---|"minimapTrackingShowAll" +---|"minimapZoom" +---|"missingTransmogSourceInItemTooltips" +---|"motionSicknessFocalCircle" +---|"motionSicknessLandscapeDarkening" +---|"mountJournalGeneralFilters" +---|"mountJournalShowPlayer" +---|"mountJournalSourcesFilter" +---|"mountJournalTypeFilter" +---|"mouseAcceleration" +---|"mouseInvertPitch" +---|"mouseInvertYaw" +---|"mouseSpeed" +---|"movePadInPressAndHoldMode" +---|"movePadLocked" +---|"movieSubtitle" +---|"movieSubtitleBackground" +---|"movieSubtitleBackgroundAlpha" +---|"nameplateAuraScale" +---|"nameplateDebuffPadding" +---|"nameplateGameObjectMaxDistance" +---|"nameplateMaxAlpha" +---|"nameplateMaxAlphaDistance" +---|"nameplateMaxDistance" +---|"nameplateMaxScale" +---|"nameplateMaxScaleDistance" +---|"nameplateMinAlpha" +---|"nameplateMinAlphaDistance" +---|"nameplateMinScale" +---|"nameplateMinScaleDistance" +---|"nameplateOccludedAlphaMult" +---|"nameplateOtherAtBase" +---|"nameplateOverlapH" +---|"nameplateOverlapV" +---|"nameplatePlayerMaxDistance" +---|"nameplateSelectedAlpha" +---|"nameplateSelectedScale" +---|"nameplateShowAll" +---|"nameplateShowCastBars" +---|"nameplateShowClassColor" +---|"nameplateShowDebuffsOnFriendly" +---|"nameplateShowEnemies" +---|"nameplateShowEnemyGuardians" +---|"nameplateShowEnemyMinions" +---|"nameplateShowEnemyMinus" +---|"nameplateShowEnemyPets" +---|"nameplateShowEnemyTotems" +---|"nameplateShowFriendlyClassColor" +---|"nameplateShowFriendlyNpcs" +---|"nameplateShowFriendlyPlayerGuardians" +---|"nameplateShowFriendlyPlayerMinions" +---|"nameplateShowFriendlyPlayerPets" +---|"nameplateShowFriendlyPlayerTotems" +---|"nameplateShowFriendlyPlayers" +---|"nameplateShowOffscreen" +---|"nameplateShowOnlyNameForFriendlyPlayerUnits" +---|"nameplateShowSelf" +---|"nameplateSimplifiedScale" +---|"nameplateSize" +---|"nameplateStyle" +---|"nameplateTargetBehindMaxDistance" +---|"nameplateTargetRadialPosition" +---|"nameplateUseClassColorForFriendlyPlayerUnitNames" +---|"nearclip" +---|"newDelvesSeason" +---|"newMythicPlusSeason" +---|"newPvpSeason" +---|"noBuffDebuffFilterOnTarget" +---|"notifiedOfNewMail" +---|"numCurrencyCategories" +---|"numReputationHeaders" +---|"occludedSilhouettePlayer" +---|"occlusionMaxJobs" +---|"optOutIngameSurveys" +---|"orderHallMissionTutorial" +---|"otherRolesAzeriteEssencesHidden" +---|"outdoorMinAltitudeDistance" +---|"outlineMouseOverFadeDuration" +---|"outlineSelectionFadeDuration" +---|"outlineSoftInteractFadeDuration" +---|"overrideArchive" +---|"overrideScreenFlash" +---|"particleDensity" +---|"particleMTDensity" +---|"particulatesEnabled" +---|"partyBackgroundOpacity" +---|"partyInvitesCollapsed_Glue" +---|"pathSmoothing" +---|"pendingInviteInfoShown" +---|"perksActivitiesCurrentMonth" +---|"perksActivitiesLastPoints" +---|"perksActivitiesPendingCompletion" +---|"persistMoveLogOnTransfer" +---|"petJournalFilterVersion" +---|"petJournalFilters" +---|"petJournalSort" +---|"petJournalSourceFilters" +---|"petJournalTab" +---|"petJournalTypeFilters" +---|"petStableShowExoticOnly" +---|"petStableSort" +---|"physicsLevel" +---|"pingCategoryTutorialShown" +---|"pingMode" +---|"playIntroMovie" +---|"playerColorOverrides" +---|"plunderstormRealm" +---|"portal" +---|"preloadLoadingDistObject" +---|"preloadLoadingDistTerrain" +---|"preloadPlayerModels" +---|"preloadStreamingDistObject" +---|"preloadStreamingDistTerrain" +---|"primaryProfessionsFilter" +---|"profanityFilter" +---|"professionAccessorySlotsExampleShown" +---|"professionToolSlotsExampleShown" +---|"professionsAllocateBestQualityReagents" +---|"professionsAllocateBestQualityReagentsCustomer" +---|"professionsFlyoutHideUnowned" +---|"professionsOrderDurationDropdown" +---|"professionsOrderRecipientDropdown" +---|"projectedTextures" +---|"pvpFramesDisplayClassColor" +---|"pvpFramesDisplayOnlyHealerPowerBars" +---|"pvpFramesDisplayPowerBars" +---|"pvpFramesHealthText" +---|"pvpOptionDisplayPets" +---|"pvpSelectedRoles" +---|"questLogOpen" +---|"questPOI" +---|"questPOILocalStory" +---|"questPOIWQ" +---|"questTextContrast" +---|"raidFramesCenterBigDefensive" +---|"raidFramesDispelIndicatorOverlay" +---|"raidFramesDispelIndicatorType" +---|"raidFramesDisplayAggroHighlight" +---|"raidFramesDisplayClassColor" +---|"raidFramesDisplayDebuffs" +---|"raidFramesDisplayIncomingHeals" +---|"raidFramesDisplayLargerRoleSpecificDebuffs" +---|"raidFramesDisplayOnlyDispellableDebuffs" +---|"raidFramesDisplayOnlyHealerPowerBars" +---|"raidFramesDisplayPowerBars" +---|"raidFramesHealthBarColor" +---|"raidFramesHealthBarColorBG" +---|"raidFramesHealthText" +---|"raidFramesHeight" +---|"raidFramesPosition" +---|"raidFramesWidth" +---|"raidGraphicsComputeEffects" +---|"raidGraphicsDepthEffects" +---|"raidGraphicsEnvironmentDetail" +---|"raidGraphicsGroundClutter" +---|"raidGraphicsLiquidDetail" +---|"raidGraphicsOutlineMode" +---|"raidGraphicsParticleDensity" +---|"raidGraphicsProjectedTextures" +---|"raidGraphicsSSAO" +---|"raidGraphicsShadowQuality" +---|"raidGraphicsSpellDensity" +---|"raidGraphicsTextureResolution" +---|"raidGraphicsViewDistance" +---|"raidOptionDisplayMainTankAndAssist" +---|"raidOptionDisplayPets" +---|"raidOptionIsShown" +---|"raidOptionKeepGroupsTogether" +---|"raidOptionLocked" +---|"raidOptionShowBorders" +---|"raidOptionSortMode" +---|"rawMouseEnable" +---|"reflectionDownscale" +---|"reflectionMode" +---|"refraction" +---|"reloadUIOnAspectChange" +---|"remoteTextToSpeech" +---|"remoteTextToSpeechVoice" +---|"reputationsCollapsed" +---|"restrictCalendarInvites" +---|"rippleDetail" +---|"rotateMinimap" +---|"runeFadeTime" +---|"runeSpentFadeTime" +---|"runeSpentFlashTime" +---|"sceneOcclusionEnable" +---|"screenEdgeFlash" +---|"screenshotFormat" +---|"screenshotQuality" +---|"screenshotSizeOverride" +---|"scriptErrors" +---|"scriptProfile" +---|"scriptWarnings" +---|"scrollToLogQuest" +---|"secondaryProfessionsFilter" +---|"secureAbilityToggle" +---|"seenAlliedRaceUnlocks" +---|"seenAsiaCharacterUpgradePopup" +---|"seenCharacterUpgradePopup" +---|"seenConfigurationWarnings" +---|"seenExpansionTrialPopup" +---|"seenLevelSquishPopup" +---|"seenPurchasableClassCapstone" +---|"seenRegionalChatDisabled" +---|"seenTimerunningFirstLoginPopup" +---|"serverAlert" +---|"serviceTypeFilter" +---|"shadowBlendCascades" +---|"shadowMode" +---|"shadowNumCascades" +---|"shadowRt" +---|"shadowSoft" +---|"shadowTextureSize" +---|"shipyardMissionTutorialAreaBuff" +---|"shipyardMissionTutorialBlockade" +---|"shipyardMissionTutorialFirst" +---|"showAllItemsInTransmog" +---|"showArenaEnemyCastbar" +---|"showArenaEnemyFrames" +---|"showArenaEnemyPets" +---|"showBattlefieldMinimap" +---|"showBuilderFeedback" +---|"showCastableBuffs" +---|"showCreateCharacterRealmConfirmDialog" +---|"showCustomSetDetails" +---|"showDelveEntrancesOnMap" +---|"showDispelDebuffs" +---|"showDungeonEntrancesOnMap" +---|"showErrors" +---|"showHonorAsExperience" +---|"showInGameNavigation" +---|"showLoadingScreenTips" +---|"showNPETutorials" +---|"showOutfitDetails" +---|"showPartyPets" +---|"showPhotosensitivityWarning" +---|"showPingsInChat" +---|"showQuestObjectivesInLog" +---|"showSpectatorTeamCircles" +---|"showSpenderFeedback" +---|"showTamers" +---|"showTamersWQ" +---|"showTargetCastbar" +---|"showTargetOfTarget" +---|"showTempMaxHealthLoss" +---|"showTimestamps" +---|"showToastBroadcast" +---|"showToastClubInvitation" +---|"showToastConversation" +---|"showToastFriendRequest" +---|"showToastOffline" +---|"showToastOnline" +---|"showToastWindow" +---|"showTokenFrame" +---|"showTutorials" +---|"showVKeyCastbar" +---|"showVKeyCastbarOnlyOnTarget" +---|"showVKeyCastbarSpellName" +---|"showfootprintparticles" +---|"simd" +---|"skipStartGear" +---|"smoothUnitPhasing" +---|"smoothUnitPhasingActorPurgatoryTimeMs" +---|"smoothUnitPhasingAliveTimeoutMs" +---|"smoothUnitPhasingDestroyedPurgatoryTimeMs" +---|"smoothUnitPhasingDistThreshold" +---|"smoothUnitPhasingEnableAlive" +---|"smoothUnitPhasingUnseenPurgatoryTimeMs" +---|"smoothUnitPhasingVehicleExtraTimeoutMs" +---|"softTargetInteractionTutorialTotalInteractions" +---|"softTargettingInteractKeySound" +---|"sortCharListByLastActive" +---|"sortDiskReads" +---|"soulbindsActivatedTutorial" +---|"soulbindsLandingPageTutorial" +---|"soulbindsViewedTutorial" +---|"specular" +---|"speechToText" +---|"spellActivationOverlayOpacity" +---|"spellBookHidePassives" +---|"spellBookMinimize" +---|"spellClutter" +---|"spellDiminishPVPEnemiesEnabled" +---|"spellDiminishPVPOnlyTriggerableByMe" +---|"spellVisualDensityFilterSetting" +---|"ssaoMagicNormals" +---|"ssaoMagicThresholdHigh" +---|"ssaoMagicThresholdLow" +---|"statusText" +---|"statusTextDisplay" +---|"stopAutoAttackOnTargetChange" +---|"streamStatusMessage" +---|"streamingCameraLookAheadTime" +---|"streamingCameraMaxRadius" +---|"streamingCameraRadius" +---|"sunShafts" +---|"superTrackerDist" +---|"synchronizeBindings" +---|"synchronizeChatFrames" +---|"synchronizeConfig" +---|"taintLog" +---|"talentPointsSpent" +---|"targetFPS" +---|"telemetryWowPackage" +---|"telemetryWowlabsPackage" +---|"teleportMaxNoLoadDist" +---|"terrainLodDist" +---|"terrainMipLevel" +---|"test_cameraDynamicPitch" +---|"test_cameraDynamicPitchBaseFovPad" +---|"test_cameraDynamicPitchBaseFovPadDownScale" +---|"test_cameraDynamicPitchBaseFovPadFlying" +---|"test_cameraDynamicPitchSmartPivotCutoffDist" +---|"test_cameraHeadMovementDeadZone" +---|"test_cameraHeadMovementFirstPersonDampRate" +---|"test_cameraHeadMovementMovingDampRate" +---|"test_cameraHeadMovementMovingStrength" +---|"test_cameraHeadMovementRangeScale" +---|"test_cameraHeadMovementStandingDampRate" +---|"test_cameraHeadMovementStandingStrength" +---|"test_cameraHeadMovementStrength" +---|"test_cameraOverShoulder" +---|"test_cameraTargetFocusEnemyEnable" +---|"test_cameraTargetFocusEnemyStrengthPitch" +---|"test_cameraTargetFocusEnemyStrengthYaw" +---|"test_cameraTargetFocusInteractEnable" +---|"test_cameraTargetFocusInteractStrengthPitch" +---|"test_cameraTargetFocusInteractStrengthYaw" +---|"textLocale" +---|"textToSpeech" +---|"textureErrorColors" +---|"textureFilteringMode" +---|"threatPlaySounds" +---|"threatShowNumeric" +---|"threatWarning" +---|"threatWorldText" +---|"timeMgrAlarmEnabled" +---|"timeMgrAlarmMessage" +---|"timeMgrAlarmTime" +---|"timeMgrUseLocalTime" +---|"timeMgrUseMilitaryTime" +---|"titleBarShortName" +---|"titleBarShowAccountName" +---|"titleBarShowBuildInfo" +---|"titleBarShowCharacterName" +---|"titleBarShowConfigName" +---|"titleBarShowGxInfo" +---|"titleBarShowPID" +---|"titleBarShowRealmName" +---|"toastDuration" +---|"toyBoxCollectedFilters" +---|"toyBoxExpansionFilters" +---|"toyBoxSourceFilters" +---|"trackedAchievements" +---|"trackedInitiativeTasks" +---|"trackedPerksActivities" +---|"trackedProfessionRecipes" +---|"trackedProfessionRecraftRecipes" +---|"trackedQuests" +---|"trackedWorldQuests" +---|"transmogCurrentSpecOnly" +---|"transmogDebug" +---|"transmogHideIgnoredSlots" +---|"transmogPreviewedWeaponToggle" +---|"transmogShowID" +---|"transmogrifySetsFilters" +---|"transmogrifyShowCollected" +---|"transmogrifyShowUncollected" +---|"transmogrifySourceFilters" +---|"uiScale" +---|"uiScaleMultiplier" +---|"unitClutter" +---|"unitClutterInstancesOnly" +---|"unitClutterPlayerThreshold" +---|"unitFacingPlayerDeadZoneDeg" +---|"unitsLookAtPlayers" +---|"unlockedMajorFactions" +---|"useCommentatorSelectionCircles" +---|"useHighResTextures" +---|"useIPv6" +---|"useMaxFPS" +---|"useMaxFPSBk" +---|"useShadowMapping" +---|"useTargetFPS" +---|"useUiScale" +---|"userFontScale" +---|"validateFrameXML" +---|"videoOptionsVersion" +---|"videoOptionsVersionDefault" +---|"violenceLevel" +---|"volumeFog" +---|"volumeFogDisableLightScattering" +---|"volumeFogDisableNoise" +---|"volumeFogDisableShadows" +---|"volumeFogInterior" +---|"volumeFogLevel" +---|"volumeFogUse16BitTexture" +---|"vrsParticles" +---|"vrsValar" +---|"vrsValarAlwaysOn" +---|"vrsValarEnvLuma" +---|"vrsValarGPUMode" +---|"vrsValarLPUseCornerSampling" +---|"vrsValarUseAsyncCompute" +---|"vrsValarUseMotionVectors" +---|"vrsValarUseWeberFechner" +---|"vrsValarWeberFechnerConstant" +---|"vrsWorldGeo" +---|"vsync" +---|"wardrobeSetsFilters" +---|"wardrobeShowAllFactions" +---|"wardrobeShowAllRaces" +---|"wardrobeShowCollected" +---|"wardrobeShowUncollected" +---|"wardrobeSourceFilters" +---|"waterDetail" +---|"weatherDensity" +---|"webChallengeURLTimeout" +---|"whisperMode" +---|"wholeChatWindowClickable" +---|"wmoDoodadDist" +---|"wmoLodDist" +---|"wmoLodDistScale" +---|"wmoPortalFadeScale" +---|"wmoPortalInteriorFade" +---|"worldBaseMip" +---|"worldIntersectMaxJobs" +---|"worldLoadSort" +---|"worldPreloadHighResTextures" +---|"worldPreloadNonCritical" +---|"worldPreloadNonCriticalTimeout" +---|"worldPreloadSort" +---|"worldQuestFilterAnima" +---|"worldQuestFilterArtifactPower" +---|"worldQuestFilterEquipment" +---|"worldQuestFilterGold" +---|"worldQuestFilterProfessionMaterials" +---|"worldQuestFilterReputation" +---|"worldQuestFilterResources" +---|"worldViewCullMaxJobs" +---|"xpBarText" diff --git a/docs/annotations/Annotations/Core/Data/Classic.lua b/docs/annotations/Annotations/Core/Data/Classic.lua new file mode 100644 index 0000000..1a94915 --- /dev/null +++ b/docs/annotations/Annotations/Core/Data/Classic.lua @@ -0,0 +1,9 @@ +---@meta +--- cata, vanilla +---@param spell number|string +---@return number start +---@return number duration +---@return number enabled +---@return number modRate +---@overload fun(index: number, bookType: string) +function GetSpellCooldown(spell) end diff --git a/docs/annotations/Annotations/Core/Data/Enum.lua b/docs/annotations/Annotations/Core/Data/Enum.lua new file mode 100644 index 0000000..ef88c54 --- /dev/null +++ b/docs/annotations/Annotations/Core/Data/Enum.lua @@ -0,0 +1,10962 @@ +---@meta _ +Enum = {} + +---@enum Enum.AbbreviationDataError +Enum.AbbreviationDataError = { + InvalidBreakpoint = 0x1, + InvalidSignificandDivisor = 0x2, + InvalidFractionDivisor = 0x4, + NotMultipleOfTen = 0x8, +} + +---@enum Enum.AccountCurrencyTransferResult +Enum.AccountCurrencyTransferResult = { + Success = 0, + InvalidCharacter = 1, + CharacterLoggedIn = 2, + InsufficientCurrency = 3, + MaxQuantity = 4, + InvalidCurrency = 5, + NoValidSourceCharacter = 6, + ServerError = 7, + CannotUseCurrency = 8, + TransactionInProgress = 9, + CurrencyTransferDisabled = 10, +} + +---@enum Enum.AccountData +Enum.AccountData = { + Config = 0, + Config2 = 1, + Bindings = 2, + Bindings2 = 3, + Macros = 4, + Macros2 = 5, + UILayout = 6, + ChatSettings = 7, + TtsSettings = 8, + TtsSettings2 = 9, + FlaggedIDs = 10, + FlaggedIDs2 = 11, + ClickBindings = 12, + UIEditModeAccount = 13, + UIEditModeChar = 14, + FrontendChatSettings = 15, + CharacterListOrder = 16, + CooldownManager = 17, + CooldownManager2 = 18, + Shop2PendingOrders = 19, +} + +---@enum Enum.AccountDataUpdateStatus +Enum.AccountDataUpdateStatus = { + Success = 0, + Failed = 1, + Corrupt = 2, + Toobig = 3, +} + +---@enum Enum.AccountExportResult +Enum.AccountExportResult = { + Success = 0, + UnknownError = 1, + Cancelled = 2, + ShuttingDown = 3, + TimedOut = 4, + NoAccountFound = 5, + RequestedInvalidCharacter = 6, + RpcError = 7, + FileInvalid = 8, + FileWriteFailed = 9, + Unavailable = 10, + AlreadyInProgress = 11, + FailedToLockAccount = 12, + FailedToGenerateFile = 13, +} + +---@enum Enum.AccountSequenceCacheType +Enum.AccountSequenceCacheType = { + Invalid = 0, + Local = 1, + HouseDecor = 2, +} + +---@enum Enum.AccountStateFlags +Enum.AccountStateFlags = { + None = 0x0, + LoadFailed = 0x1, + InPetCombat = 0x2, + AccountUpgradeComplete = 0x4, + TokenEligCheckComplete = 0x8, +} + +---@enum Enum.AccountStateLoadedFlags +Enum.AccountStateLoadedFlags = { + LoadedNone = "0x0000000000000000", + AchievementsLoaded = "0x0000000000000001", + CriteriaLoaded = "0x0000000000000002", + MountsLoaded = "0x0000000000000004", + PetjournalInitialized = "0x0000000000000008", + CurrencyCapsLoaded = "0x0000000000000010", + QuestLogLoaded = "0x0000000000000020", + CharactersLoaded = "0x0000000000000040", + PurchasesLoaded = "0x0000000000000080", + BpayDistributionObjectsLoaded = "0x0000000000000100", + ArchivedPurchasesLoaded = "0x0000000000000200", + SettingsLoaded = "0x0000000000000400", + BpayAddLicenseObjectsLoaded = "0x0000000000000800", + ItemCollectionsLoaded = "0x0000000000001000", + AuctionableTokensLoaded = "0x0000000000002000", + ConsumableTokensLoaded = "0x0000000000004000", + PerksPastRewardsLoaded = "0x0000000000008000", + VasTransactionsLoaded = "0x0000000000010000", + BpayProductitemObjectsLoaded = "0x0000000000020000", + TrialBoostHistoryLoaded = "0x0000000000040000", + QuestCriteriaLoaded = "0x0000000000080000", + BattleNetAccountLoaded = "0x0000000000100000", + AccountCurrenciesLoaded = "0x0000000000200000", + RafBalanceLoaded = "0x0000000000400000", + RafRewardsLoaded = "0x0000000000800000", + DynamicCriteriaLoaded = "0x0000000001000000", + RafActivityLoaded = "0x0000000002000000", + RevokedRafRewardsLoaded = "0x0000000004000000", + AccountNotificationsLoaded = "0x0000000008000000", + PerksPendingPurchaseLoaded = "0x0000000010000000", + AccountWowlabsLoaded = "0x0000000020000000", + PerksHeldItemLoaded = "0x0000000040000000", + PerksPendingRewardsLoaded = "0x0000000080000000", + BitVectorsLoaded = "0x0000000100000000", + AccountFactionsLoaded = "0x0000000200000000", + AccountItemsLoaded = "0x0000000400000000", + CombinedQuestLogLoaded = "0x0000000800000000", + DataElementsLoaded = "0x0000001000000000", + WarbandsLoaded = "0x0000002000000000", + BanktabSettingsLoaded = "0x0000004000000000", + AccountMappingLoaded = "0x0000008000000000", + CharacterItemsLoaded = "0x0000010000000000", + CurrencyTransferLogLoaded = "0x0000020000000000", + LgVendorPurchaseLoaded = "0x0000040000000000", + HousingDataLoaded = "0x0000080000000000", + WarbandScenesLoaded = "0x0000100000000000", + EventRecordsLoaded = "0x0000200000000000", + TransmogOutfitsLoaded = "0x0000400000000000", +} + +---@enum Enum.AccountStoreCategoryType +Enum.AccountStoreCategoryType = { + Creature = 1, + TransmogSet = 2, + Mount = 3, + Icon = 4, +} + +---@enum Enum.AccountStoreFrontFlag +Enum.AccountStoreFrontFlag = { + Enabled = 1, + PurchaseEnabled = 2, + RefundEnabled = 4, +} + +---@enum Enum.AccountStoreItemFlag +Enum.AccountStoreItemFlag = { + DisplayDefaultArmor = 0x1, + NotInGameReward = 0x2, + DisplayAsNew = 0x4, + DisplayOnly = 0x8, +} + +---@enum Enum.AccountStoreItemMode +Enum.AccountStoreItemMode = { + Normal = 1, + Hidden = 2, + Locked = 3, +} + +---@enum Enum.AccountStoreItemRewardType +Enum.AccountStoreItemRewardType = { + Transmog = 1, + Mount = 2, + Pet = 3, + Toy = 5, + Illusion = 7, + TransmogSet = 8, + Tender = 9, + Misc = 10, + WarbandScene = 11, +} + +---@enum Enum.AccountStoreItemStatus +Enum.AccountStoreItemStatus = { + Unowned = 1, + Refundable = 2, + Owned = 3, +} + +---@enum Enum.AccountStoreSettlementAction +Enum.AccountStoreSettlementAction = { + NotSet = 0, + Give = 1, + Remove = 2, +} + +---@enum Enum.AccountStoreState +Enum.AccountStoreState = { + Available = 0, + Unknown = 1, + Unavailable = 2, +} + +---@enum Enum.AccountStoreTransactionResult +Enum.AccountStoreTransactionResult = { + Success = 0, + Incomplete = 1, + UnknownError = 2, + TransactionInProgress = 3, + InsufficientFunds = 4, + ItemUnknown = 5, + ItemAlreadyOwned = 6, + ItemNotOwned = 7, + InvalidCurrencyType = 8, + OwnedButRefundTimeExpired = 9, + NotSupported = 10, + Unavailable = 11, + ProxyError = 12, +} + +---@enum Enum.AccountStoreTransactionType +Enum.AccountStoreTransactionType = { + Undefined = 0, + Purchase = 1, + Refund = 2, + DebugResetHistory = 3, + DebugRemoveItem = 4, +} + +---@enum Enum.AccountTransType +Enum.AccountTransType = { + ProxyForwarder = 0, + Purchase = 1, + Distribution = 2, + Battlepet = 3, + Achievements = 4, + Criteria = 5, + Mounts = 6, + Characters = 7, + Purchases = 8, + ArchivedPurchases = 9, + Distributions = 10, + CurrencyCaps = 11, + QuestLog = 12, + CriteriaNotif = 13, + Settings = 14, + FixedLicense = 15, + AddLicense = 16, + ItemCollections = 17, + AuctionableToken = 18, + ConsumableToken = 19, + VasTransaction = 20, + Productitem = 21, + TrialBoostHistory = 22, + TrialBoostHistories = 23, + QuestCriteria = 24, + BattlenetAccount = 25, + AccountCurrencies = 26, + RafRecruiterAcceptances = 27, + RafFriendMonth = 28, + RafReward = 29, + DynamicCriteria = 30, + RafActivity = 31, + CreateOrderInfo = 32, + ProxyHonorInitialConversion = 33, + ProxyCreateAccountHonor = 34, + ProxyValidateAccountHonor = 35, + ProxyGmSetHonor = 36, + ProxyGenerateBpayID = 37, + AccountNotifications = 38, + PerkItemHold = 39, + PerkPendingRewards = 40, + PerkPastRewards = 41, + PerkTransaction = 42, + OutstandingRpc = 43, + LoadWowlabs = 44, + UpgradeAccount = 45, + GetOrderStatusByPurchaseID = 46, + Items = 47, + BankTab = 48, + Factions = 49, + BitVectors = 50, + CombinedQuestLog = 51, + PlayerDataElements = 52, + CharacterDataMerge = 53, + AccountStore = 54, + WarbandGroups = 55, + Mapping = 56, + CharacterItems = 57, + CurrencyTransferLog = 58, + LgVendorPurchase = 59, + SaveWarbandGroups = 60, + Profile = 61, + WarbandSceneCollection = 62, + EventRecords = 63, + HousingItem = 64, + TransmogOutfitCollection = 65, + HouseInitiativeFavor = 66, +} + +---@enum Enum.ActionBarOrientation +Enum.ActionBarOrientation = { + Horizontal = 0, + Vertical = 1, +} + +---@enum Enum.ActionBarVisibleSetting +Enum.ActionBarVisibleSetting = { + Always = 0, + InCombat = 1, + OutOfCombat = 2, + Hidden = 3, +} + +---@enum Enum.AddOnEnableState +Enum.AddOnEnableState = { + None = 0, + Some = 1, + All = 2, +} + +---@enum Enum.AddOnPerformanceMessageType +Enum.AddOnPerformanceMessageType = { + SpecificAddOnChatWarning = 0, + SpecificAddOnErrorDialog = 1, + OverallAddOnErrorDialog = 2, +} + +---@enum Enum.AddOnProfilerMetric +Enum.AddOnProfilerMetric = { + SessionAverageTime = 0, + RecentAverageTime = 1, + EncounterAverageTime = 2, + LastTime = 3, + PeakTime = 4, + CountTimeOver1Ms = 5, + CountTimeOver5Ms = 6, + CountTimeOver10Ms = 7, + CountTimeOver50Ms = 8, + CountTimeOver100Ms = 9, + CountTimeOver500Ms = 10, + CountTimeOver1000Ms = 11, +} + +---@enum Enum.AddOnRestrictionState +Enum.AddOnRestrictionState = { + Inactive = 0, + Activating = 1, + Active = 2, +} + +---@enum Enum.AddOnRestrictionType +Enum.AddOnRestrictionType = { + Combat = 0, + Encounter = 1, + ChallengeMode = 2, + PvPMatch = 3, + Map = 4, + Chat = 5, +} + +---@enum Enum.AddOnSecurityStatus +Enum.AddOnSecurityStatus = { + Secure = 0, + Insecure = 1, + Banned = 2, + NotAvailable = 3, +} + +---@enum Enum.AddSoulbindConduitReason +Enum.AddSoulbindConduitReason = { + None = 0, + Cheat = 1, + SpellEffect = 2, + Upgrade = 3, +} + +---@enum Enum.AnimaDiversionNodeState +Enum.AnimaDiversionNodeState = { + Unavailable = 0, + Available = 1, + SelectedTemporary = 2, + SelectedPermanent = 3, + Cooldown = 4, +} + +---@enum Enum.ArrowCalloutDirection +Enum.ArrowCalloutDirection = { + Up = 0, + Down = 1, + Left = 2, + Right = 3, +} + +---@enum Enum.ArrowCalloutType +Enum.ArrowCalloutType = { + None = 0, + Generic = 1, + WorldLootObject = 2, + Tutorial = 3, + WidgetContainerNoBorder = 4, +} + +---@enum Enum.AssertDomain +Enum.AssertDomain = { + Art = 0x1, + Design = 0x2, + Engineering = 0x4, + Sound = 0x8, + Tools = 0x10, + Performance = 0x20, + LiveOperations = 0x40, +} + +---@enum Enum.AssistActionType +Enum.AssistActionType = { + None = 0, + LoungingPlayer = 1, + GraveMarker = 2, + PlacedVo = 3, + PlayerGuardian = 4, + PlayerSlayer = 5, + CapturedBuff = 6, +} + +---@enum Enum.AuctionHouseCommoditySortOrder +Enum.AuctionHouseCommoditySortOrder = { + UnitPrice = 0, + Quantity = 1, +} + +---@enum Enum.AuctionHouseError +Enum.AuctionHouseError = { + NotEnoughMoney = 0, + HigherBid = 1, + BidIncrement = 2, + BidOwn = 3, + ItemNotFound = 4, + RestrictedAccountTrial = 5, + HasRestriction = 6, + IsBusy = 7, + Unavailable = 8, + ItemHasQuote = 9, + DatabaseError = 10, + MinBid = 11, + NotEnoughItems = 12, + RepairItem = 13, + UsedCharges = 14, + QuestItem = 15, + BoundItem = 16, + ConjuredItem = 17, + LimitedDurationItem = 18, + IsBag = 19, + EquippedBag = 20, + WrappedItem = 21, + LootItem = 22, + DoubleBid = 23, + FavoritesMaxed = 24, + ItemNotAvailable = 25, + ItemBoundToAccountUntilEquip = 26, +} + +---@enum Enum.AuctionHouseExtraColumn +Enum.AuctionHouseExtraColumn = { + None = 0, + Ilvl = 1, + Slots = 2, + Level = 3, + Skill = 4, +} + +---@enum Enum.AuctionHouseFilter +Enum.AuctionHouseFilter = { + None = 0, + UncollectedOnly = 1, + UsableOnly = 2, + CurrentExpansionOnly = 3, + UpgradesOnly = 4, + ExactMatch = 5, + PoorQuality = 6, + CommonQuality = 7, + UncommonQuality = 8, + RareQuality = 9, + EpicQuality = 10, + LegendaryQuality = 11, + ArtifactQuality = 12, + LegendaryCraftedItemOnly = 13, +} + +---@enum Enum.AuctionHouseFilterCategory +Enum.AuctionHouseFilterCategory = { + Uncategorized = 0, + Equipment = 1, + Rarity = 2, +} + +---@enum Enum.AuctionHouseItemSortOrder +Enum.AuctionHouseItemSortOrder = { + Bid = 0, + Buyout = 1, +} + +---@enum Enum.AuctionHouseNotification +Enum.AuctionHouseNotification = { + BidPlaced = 0, + AuctionRemoved = 1, + AuctionWon = 2, + AuctionOutbid = 3, + AuctionSold = 4, + AuctionExpired = 5, +} + +---@enum Enum.AuctionHouseSortOrder +Enum.AuctionHouseSortOrder = { + Price = 0, + Name = 1, + Level = 2, + Bid = 3, + Buyout = 4, + TimeRemaining = 5, +} + +---@enum Enum.AuctionHouseTimeLeftBand +Enum.AuctionHouseTimeLeftBand = { + Short = 0, + Medium = 1, + Long = 2, + VeryLong = 3, +} + +---@enum Enum.AuctionStatus +Enum.AuctionStatus = { + Active = 0, + Sold = 1, +} + +---@enum Enum.AuraFrameIconDirection +Enum.AuraFrameIconDirection = { + Down = 0, + Left = 0, + Right = 1, + Up = 1, +} + +---@enum Enum.AuraFrameIconWrap +Enum.AuraFrameIconWrap = { + Down = 0, + Left = 0, + Right = 1, + Up = 1, +} + +---@enum Enum.AuraFrameOrientation +Enum.AuraFrameOrientation = { + Horizontal = 0, + Vertical = 1, +} + +---@enum Enum.AuraFrameVisibleSetting +Enum.AuraFrameVisibleSetting = { + Always = 0, + InCombat = 1, + Hidden = 2, +} + +---@enum Enum.AutoCompleteEntryFlag +Enum.AutoCompleteEntryFlag = { + InGroup = 0x1, + InGuild = 0x2, + Friend = 0x4, + Bnet = 0x8, + InteractedWith = 0x10, + Online = 0x20, + InAOI = 0x40, + AccountCharacter = 0x80, + RecentPlayer = 0x100, +} + +---@enum Enum.AutoCompletePriority +Enum.AutoCompletePriority = { + Other = 0, + Interacted = 1, + InGroup = 2, + Guild = 3, + Friend = 4, + AccountCharacter = 5, + AccountCharacterSameRealm = 6, +} + +---@enum Enum.AvgItemLevelCategories +Enum.AvgItemLevelCategories = { + Base = 0, + EquippedBase = 1, + EquippedEffective = 2, + PvP = 3, + PvPWeighted = 4, + EquippedEffectiveWeighted = 5, +} + +---@enum Enum.AzeriteEssenceSlot +Enum.AzeriteEssenceSlot = { + MainSlot = 0, + PassiveOneSlot = 1, + PassiveTwoSlot = 2, + PassiveThreeSlot = 3, +} + +---@enum Enum.AzeritePowerLevel +Enum.AzeritePowerLevel = { + Base = 0, + Upgraded = 1, + Downgraded = 2, +} + +---@enum Enum.BagFlag +Enum.BagFlag = { + DontFindStack = 0x1, + AlreadyOwner = 0x2, + AlreadyBound = 0x4, + Swap = 0x8, + BagIsEmpty = 0x10, + LookInInventory = 0x20, + IgnoreBoundItemCheck = 0x40, + StackOnly = 0x80, + RecurseQuivers = 0x100, + IgnoreBankcheck = 0x200, + AllowBagsInNonBagSlots = 0x400, + PreferQuivers = 0x800, + SwapBags = 0x1000, + IgnoreExisting = 0x2000, + AllowPartialStack = 0x4000, + LookInCharacterBankOnly = 0x8000, + AllowBuyback = 0x10000, + IgnorePetBankcheck = 0x20000, + PreferPriorityBags = 0x40000, + PreferNeutralPriorityBags = 0x80000, + AsymmetricSwap = 0x100000, + PreferReagentBags = 0x200000, + IgnoreSoulbound = 0x400000, + IgnoreReagentBags = 0x800000, + LookInAccountBankOnly = 0x1000000, + HasRefund = 0x2000000, + SkipValidCountCheck = 0x4000000, + AllowSoulboundItemInAccountBank = 0x8000000, +} + +---@enum Enum.BagIndex +Enum.BagIndex = { + Accountbanktab = -3, + Characterbanktab = -2, + Keyring = -1, + Backpack = 0, + Bag_1 = 1, + Bag_2 = 2, + Bag_3 = 3, + Bag_4 = 4, + ReagentBag = 5, + CharacterBankTab_1 = 6, + CharacterBankTab_2 = 7, + CharacterBankTab_3 = 8, + CharacterBankTab_4 = 9, + CharacterBankTab_5 = 10, + CharacterBankTab_6 = 11, + AccountBankTab_1 = 12, + AccountBankTab_2 = 13, + AccountBankTab_3 = 14, + AccountBankTab_4 = 15, + AccountBankTab_5 = 16, +} + +---@enum Enum.BagSlotFlags +Enum.BagSlotFlags = { + DisableAutoSort = 0x1, + ClassEquipment = 0x2, + ClassConsumables = 0x4, + ClassProfessionGoods = 0x8, + ClassJunk = 0x10, + ClassQuestItems = 0x20, + ExcludeJunkSell = 0x40, + ClassReagents = 0x80, + ExpansionCurrent = 0x100, + ExpansionLegacy = 0x200, +} + +---@enum Enum.BagsDirection +Enum.BagsDirection = { + Left = 0, + Up = 0, + Down = 1, + Right = 1, +} + +---@enum Enum.BagsOrientation +Enum.BagsOrientation = { + Horizontal = 0, + Vertical = 1, +} + +---@enum Enum.BalanceType +Enum.BalanceType = { + None = -1, + Eclipse = 0, +} + +---@enum Enum.BankLockedReason +Enum.BankLockedReason = { + None = 0, + NoAccountInventoryLock = 1, + BankDisabled = 2, + BankConversionFailed = 3, +} + +---@enum Enum.BankType +Enum.BankType = { + Character = 0, + Guild = 1, + Account = 2, +} + +---@enum Enum.Base64Variant +Enum.Base64Variant = { + Standard = 0, + StandardUrlSafe = 1, +} + +---@enum Enum.BattlePetAbilityFlag +Enum.BattlePetAbilityFlag = { + DisplayAsHostileDebuff = 0x1, + HideStrongWeakHints = 0x2, + Passive = 0x4, + ServerOnlyAura = 0x8, + ShowCast = 0x10, + StartOnCooldown = 0x20, +} + +---@enum Enum.BattlePetAbilitySlot +Enum.BattlePetAbilitySlot = { + A = 0, + B = 1, + C = 2, +} + +---@enum Enum.BattlePetAbilityTargets +Enum.BattlePetAbilityTargets = { + EnemyFrontPet = 0, + FriendlyFrontPet = 1, + Weather = 2, + EnemyPad = 3, + FriendlyPad = 4, + EnemyBackPet_1 = 5, + EnemyBackPet_2 = 6, + FriendlyBackPet_1 = 7, + FriendlyBackPet_2 = 8, + Caster = 9, + Owner = 10, + Specific = 11, + ProcTarget = 12, +} + +---@enum Enum.BattlePetAbilityTurnFlag +Enum.BattlePetAbilityTurnFlag = { + CanProcFromProc = 0x1, + TriggerBySelf = 0x2, + TriggerByFriend = 0x4, + TriggerByEnemy = 0x8, + TriggerByWeather = 0x10, + TriggerByAuraCaster = 0x20, +} + +---@enum Enum.BattlePetAbilityTurnType +Enum.BattlePetAbilityTurnType = { + Normal = 0, + TriggeredEffect = 1, +} + +---@enum Enum.BattlePetAbilityType +Enum.BattlePetAbilityType = { + Ability = 0, + Aura = 1, +} + +---@enum Enum.BattlePetAction +Enum.BattlePetAction = { + None = 0, + Ability = 1, + SwitchPet = 2, + Trap = 3, + Skip = 4, +} + +---@enum Enum.BattlePetBreedQuality +Enum.BattlePetBreedQuality = { + Poor = 0, + Common = 1, + Uncommon = 2, + Rare = 3, + Epic = 4, + Legendary = 5, +} + +---@enum Enum.BattlePetEffectFlags +Enum.BattlePetEffectFlags = { + EnableAbilityPicker = 1, + LuaNeedsAllPets = 2, +} + +---@enum Enum.BattlePetEffectParamType +Enum.BattlePetEffectParamType = { + Int = 0, + Ability = 1, +} + +---@enum Enum.BattlePetEvent +Enum.BattlePetEvent = { + OnAuraApplied = 0, + OnDamageTaken = 1, + OnDamageDealt = 2, + OnHealTaken = 3, + OnHealDealt = 4, + OnAuraRemoved = 5, + OnRoundStart = 6, + OnRoundEnd = 7, + OnTurn = 8, + OnAbility = 9, + OnSwapIn = 10, + OnSwapOut = 11, + PostAuraTicks = 12, +} + +---@enum Enum.BattlePetNpcEmote +Enum.BattlePetNpcEmote = { + BattleUnused = 0, + BattleStart = 1, + BattleWin = 2, + BattleLose = 3, + PetSwap = 4, + PetKill = 5, + PetDie = 6, + PetAbility = 7, +} + +---@enum Enum.BattlePetNpcTeamFlag +Enum.BattlePetNpcTeamFlag = { + MatchPlayerHighPetLevel = 1, + NoPlayerXP = 2, +} + +---@enum Enum.BattlePetOwner +Enum.BattlePetOwner = { + Weather = 0, + Ally = 1, + Enemy = 2, +} + +---@enum Enum.BattlePetSources +Enum.BattlePetSources = { + Drop = 0, + Quest = 1, + Vendor = 2, + Profession = 3, + WildPet = 4, + Achievement = 5, + WorldEvent = 6, + Promotion = 7, + Tcg = 8, + PetStore = 9, + Discovery = 10, + TradingPost = 11, +} + +---@enum Enum.BattlePetSpeciesFlags +Enum.BattlePetSpeciesFlags = { + NoRename = 0x1, + WellKnown = 0x2, + NotAcccountwide = 0x4, + Capturable = 0x8, + NotTradable = 0x10, + HideFromJournal = 0x20, + LegacyAccountUnique = 0x40, + CantBattle = 0x80, + HordeOnly = 0x100, + AllianceOnly = 0x200, + Boss = 0x400, + RandomDisplay = 0x800, + NoLicenseRequired = 0x1000, + AddsAllowedWithBoss = 0x2000, + HideUntilLearned = 0x4000, + MatchPlayerHighPetLevel = 0x8000, + NoWildPetAddsAllowed = 0x10000, +} + +---@enum Enum.BattlePetStateFlag +Enum.BattlePetStateFlag = { + None = 0x0, + SwapOutLock = 0x1, + TurnLock = 0x2, + SpeedBonus = 0x4, + Client = 0x8, + MaxHealthBonus = 0x10, + Stamina = 0x20, + QualityDoesNotEffect = 0x40, + DynamicScaling = 0x80, + Power = 0x100, + SpeedMult = 0x200, + SwapInLock = 0x400, + ServerOnly = 0x800, +} + +---@enum Enum.BattlePetTypes +Enum.BattlePetTypes = { + Humanoid = 0, + Dragonkin = 1, + Flying = 2, + Undead = 3, + Critter = 4, + Magic = 5, + Elemental = 6, + Beast = 7, + Aquatic = 8, + Mechanical = 9, +} + +---@enum Enum.BattlePetVisualFlag +Enum.BattlePetVisualFlag = { + Test1 = 1, + Test2 = 2, + Test3 = 4, +} + +---@enum Enum.BattlePetVisualRange +Enum.BattlePetVisualRange = { + Melee = 0, + Ranged = 1, + InPlace = 2, + PointBlank = 3, + BehindMelee = 4, + BehindRanged = 5, +} + +---@enum Enum.BattlepayLicenseSynthesisFlags +Enum.BattlepayLicenseSynthesisFlags = { + ForceToGameAccount = 1, +} + +---@enum Enum.BattlepayProductChoiceType +Enum.BattlepayProductChoiceType = { + ChoiceNone = 0, + ChoiceOne = 1, + SpecAndFaction = 2, + VasCharacter = 3, + VasCharacterAndName = 4, +} + +---@enum Enum.BattlepayShopEntryBannerType +Enum.BattlepayShopEntryBannerType = { + Featured = 0, + Discount = 1, + New = 2, +} + +---@enum Enum.BattlepayShopEntryFlags +Enum.BattlepayShopEntryFlags = { + None = 0, +} + +---@enum Enum.BattlepetDbFlags +Enum.BattlepetDbFlags = { + None = 0x0, + Favorite = 0x1, + Converted = 0x2, + Revoked = 0x4, + LockedForConvert = 0x8, + LockMask = 0xC, + Ability0Selection = 0x10, + Ability1Selection = 0x20, + Ability2Selection = 0x40, + FanfareNeeded = 0x80, + DisplayOverridden = 0x100, + AcquiredViaLicense = 0x200, + TradingPost = 0x400, +} + +---@enum Enum.BattlepetDeletedReason +Enum.BattlepetDeletedReason = { + Unknown = 0, + PlayerReleased = 1, + PlayerCaged = 2, + Gm = 3, + CageError = 4, + DelJournal = 5, + TradingPost = 6, + AccountStore = 7, +} + +---@enum Enum.BattlepetSlotLockCheat +Enum.BattlepetSlotLockCheat = { + Cheat_2_Locked = -3, + Cheat_1_Locked = -2, + Cheat_0_Locked = -1, + CheatOff = 0, + UnlockAll = 1, +} + +---@enum Enum.BindingContext +Enum.BindingContext = { + None = 0, + HousingEditor = 1, + HousingEditorBasicDecorMode = 2, + HousingEditorExpertDecorMode = 3, + HousingEditorCustomizeMode = 4, + HousingEditorCleanupMode = 5, + HousingEditorLayoutMode = 6, + HousingEditorBasicAndExpertDecorMode = 7, + HousingEditorExteriorCustomizationMode = 8, + ReservedFutureFeatureBinding01 = 9, +} + +---@enum Enum.BindingSet +Enum.BindingSet = { + Default = 0, + Account = 1, + Character = 2, + Current = 3, +} + +---@enum Enum.BnetAccountFlag +Enum.BnetAccountFlag = { + None = 0x0, + BattlePetTrainer = 0x1, + RafVeteranNotified = 0x2, + TwitterLinked = 0x4, + TwitterHasTempSecret = 0x8, + Employee = 0x10, + EmployeeFlagIsManual = 0x20, + AccountQuestBitFixUp = 0x40, + AchievementsToBi = 0x80, + InvalidTransmogsFixUp = 0x100, + InvalidTransmogsFixUp2 = 0x200, + GdprErased = 0x400, + DarkRealmLightCopy = 0x800, + QuestLogFlagsFixUp = 0x1000, + WasSecured = 0x2000, + LockedForExport = 0x4000, + CanBuyAhGameTimeTokens = 0x8000, + PetAchievementFixUp = 0x10000, + IsLegacy = 0x20000, + CataLegendaryMountChecked = 0x40000, + CataLegendaryMountObtained = 0x80000, +} + +---@enum Enum.BonusStatIndex +Enum.BonusStatIndex = { + Mana = 0, + Health = 1, + Endurance = 2, + Agility = 3, + Strength = 4, + Intellect = 5, + Spirit = 6, + Stamina = 7, + Energy = 8, + Rage = 9, + Focus = 10, + WeaponSkillRatingObsolete = 11, + DefenseSkillRating = 12, + DodgeRating = 13, + ParryRating = 14, + BlockRating = 15, + HitMeleeRating = 16, + HitRangedRating = 17, + HitSpellRating = 18, + CritMeleeRating = 19, + CritRangedRating = 20, + CritSpellRating = 21, + Corruption = 22, + CorruptionResistance = 23, + ModifiedCraftingStat_1 = 24, + ModifiedCraftingStat_2 = 25, + CritTakenRangedRatingObsolete = 26, + CritTakenSpellRatingObsolete = 27, + HasteMeleeRatingObsolete = 28, + HasteRangedRatingObsolete = 29, + HasteSpellRatingObsolete = 30, + HitRating = 31, + CritRating = 32, + HitTakenRatingObsolete = 33, + CritTakenRatingObsolete = 34, + ResilienceRating = 35, + HasteRating = 36, + ExpertiseRating = 37, + AttackPower = 38, + RangedAttackPower = 39, + Versatility = 40, + SpellHealingDone = 41, + SpellDamageDone = 42, + ManaRegenerationObsolete = 43, + Unused = 44, + SpellPower = 45, + HealthRegen = 46, + SpellPenetration = 47, + BlockValueObsolete = 48, + MasteryRating = 49, + ExtraArmor = 50, + FireResistance = 51, + FrostResistance = 52, + HolyResistance = 53, + ShadowResistance = 54, + NatureResistance = 55, + ArcaneResistance = 56, + PvPPower = 57, + CombatRatingUnused_0 = 58, + CombatRatingUnused_2 = 59, + CombatRatingUnused_3 = 60, + CombatRatingSpeed = 61, + CombatRatingLifesteal = 62, + CombatRatingAvoidance = 63, + CombatRatingSturdiness = 64, + CombatRatingUnused_7 = 65, + CombatRatingUnused_27 = 66, + CombatRatingUnused_9 = 67, + CombatRatingUnused_10 = 68, + CombatRatingUnused_11 = 69, + CombatRatingUnused_12 = 70, + AgilityOrStrengthOrIntellect = 71, + AgilityOrStrength = 72, + AgilityOrIntellect = 73, + StrengthOrIntellect = 74, + ProfessionInspiration = 75, + ProfessionResourcefulness = 76, + ProfessionFinesse = 77, + ProfessionDeftness = 78, + ProfessionPerception = 79, + ProfessionCraftingSpeed = 80, + ProfessionMulticraft = 81, + ProfessionIngenuity = 82, +} + +---@enum Enum.BrawlType +Enum.BrawlType = { + None = 0, + Battleground = 1, + Arena = 2, + LFG = 3, + SoloShuffle = 4, + SoloRbg = 5, +} + +---@enum Enum.BulkPurchaseResult +Enum.BulkPurchaseResult = { + ResultOk = 0, + ResultInProgress = 1, + ResultPartialSuccess = 2, + ResultFailed = 3, + ResultTooManyProducts = 4, + ResultSystemDisabled = 5, + ResultInsufficientFunds = 6, + ResultPurchaseTimeout = 7, +} + +---@enum Enum.BulkPurchaseStatus +Enum.BulkPurchaseStatus = { + PlacingOrders = 0, + PurchasesPending = 1, + FetchEntitlements = 2, + Done = 3, + Failed = 4, +} + +---@enum Enum.BulkRefundResult +Enum.BulkRefundResult = { + ResultOk = 0, + ResultFailed = 1, + ResultInvalidRequest = 2, + ResultRefundWindowExpired = 3, + ResultSystemDisabled = 4, + ResultTimeout = 5, +} + +---@enum Enum.CDMLayoutMode +Enum.CDMLayoutMode = { + AllowCreate = true, + AccessOnly = false, +} + +---@enum Enum.CachedRewardType +Enum.CachedRewardType = { + None = 0, + Item = 1, + Currency = 2, + Quest = 3, +} + +---@enum Enum.CalendarCommandType +Enum.CalendarCommandType = { + Create = 0, + Invite = 1, + Rsvp = 2, + RemoveInvite = 3, + RemoveEvent = 4, + Status = 5, + ModeratorStatus = 6, + GetCalendar = 7, + GetEvent = 8, + UpdateEvent = 9, + Complain = 10, + Notes = 11, +} + +---@enum Enum.CalendarErrorType +Enum.CalendarErrorType = { + Success = 0, + CommunityEventsExceeded = 1, + EventsExceeded = 2, + SelfInvitesExceeded = 3, + OtherInvitesExceeded = 4, + NoPermission = 5, + EventInvalid = 6, + NotInvited = 7, + UnknownError = 8, + NotInGuild = 9, + NotInCommunity = 10, + TargetAlreadyInvited = 11, + NameNotFound = 12, + WrongFaction = 13, + Ignored = 14, + InvitesExceeded = 15, + InvalidMaxSize = 16, + InvalidDate = 17, + InvalidTime = 18, + NoInvites = 19, + NeedsTitle = 20, + EventPassed = 21, + EventLocked = 22, + DeleteCreatorFailed = 23, + DataAlreadySet = 24, + CalendarDisabled = 25, + RestrictedAccount = 26, + ArenaEventsExceeded = 27, + RestrictedLevel = 28, + Squelched = 29, + NoInvite = 30, + ComplaintDisabled = 31, + ComplaintSelf = 32, + ComplaintSameGuild = 33, + ComplaintGm = 34, + ComplaintLimit = 35, + ComplaintNotFound = 36, + EventWrongServer = 37, + NoCommunityInvites = 38, + InvalidSignup = 39, + NoModerator = 40, + ModeratorRestricted = 41, + InvalidNotes = 42, + InvalidTitle = 43, + InvalidDescription = 44, + InvalidClub = 45, + CreatorNotFound = 46, + EventThrottled = 47, + InviteThrottled = 48, + Internal = 49, + ComplaintAdded = 50, +} + +---@enum Enum.CalendarEventBits +Enum.CalendarEventBits = { + Player = 0x1, + GuildDeprecated = 0x2, + System = 0x4, + Holiday = 0x8, + Locked = 0x10, + AutoApprove = 0x20, + CommunityAnnouncement = 0x40, + RaidLockout = 0x80, + ArenaDeprecated = 0x100, + RaidResetDeprecated = 0x200, + CommunitySignup = 0x400, + GuildSignup = 0x800, + CommunityWide = 0xC40, + PlayerCreated = 0xD43, + CantComplain = 0xECC, +} + +---@enum Enum.CalendarEventRepeatOptions +Enum.CalendarEventRepeatOptions = { + Never = 0, + Weekly = 1, + Biweekly = 2, + Monthly = 3, +} + +---@enum Enum.CalendarEventType +Enum.CalendarEventType = { + Raid = 0, + Dungeon = 1, + PvP = 2, + Meeting = 3, + Other = 4, + HeroicDeprecated = 5, +} + +---@enum Enum.CalendarFilterFlags +Enum.CalendarFilterFlags = { + WeeklyHoliday = 0x1, + Darkmoon = 0x2, + Battleground = 0x4, + RaidLockout = 0x8, + RaidReset = 0x10, +} + +---@enum Enum.CalendarGetEventType +Enum.CalendarGetEventType = { + Get = 0, + Add = 1, + Copy = 2, +} + +---@enum Enum.CalendarHolidayFilterType +Enum.CalendarHolidayFilterType = { + Weekly = 0, + Darkmoon = 1, + Battleground = 2, +} + +---@enum Enum.CalendarInviteBits +Enum.CalendarInviteBits = { + None = 0x0, + PendingInvite = 0x1, + Moderator = 0x2, + Creator = 0x4, + Signup = 0x8, +} + +---@enum Enum.CalendarInviteSortType +Enum.CalendarInviteSortType = { + Name = 0, + Level = 1, + Class = 2, + Status = 3, + Party = 4, + Notes = 5, +} + +---@enum Enum.CalendarInviteType +Enum.CalendarInviteType = { + Normal = 0, + Signup = 1, +} + +---@enum Enum.CalendarModeratorStatus +Enum.CalendarModeratorStatus = { + None = 0, + Moderator = 1, + Creator = 2, +} + +---@enum Enum.CalendarStatus +Enum.CalendarStatus = { + Invited = 0, + Available = 1, + Declined = 2, + Confirmed = 3, + Out = 4, + Standby = 5, + Signedup = 6, + NotSignedup = 7, + Tentative = 8, +} + +---@enum Enum.CalendarTexturesType +Enum.CalendarTexturesType = { + Dungeons = 0, + Raid = 1, +} + +---@enum Enum.CalendarType +Enum.CalendarType = { + Player = 0, + Community = 1, + RaidLockout = 2, + RaidResetDeprecated = 3, + Holiday = 4, + HolidayWeekly = 5, + HolidayDarkmoon = 6, + HolidayBattleground = 7, +} + +---@enum Enum.CalendarWebActionType +Enum.CalendarWebActionType = { + Accept = 0, + Decline = 1, + Remove = 2, + ReportSpam = 3, + Signup = 4, + Tentative = 5, + TentativeSignup = 6, +} + +---@enum Enum.CallingStates +Enum.CallingStates = { + QuestOffer = 0, + QuestActive = 1, + QuestCompleted = 2, +} + +---@enum Enum.CameraModeAspectRatio +Enum.CameraModeAspectRatio = { + Default = 0, + LegacyLetterbox = 1, + HighDefinition_16_X_9 = 2, + Cinemascope_2_Dot_4_X_1 = 3, +} + +---@enum Enum.CampaignState +Enum.CampaignState = { + Invalid = 0, + Complete = 1, + InProgress = 2, + Stalled = 3, +} + +---@enum Enum.CanRedeemTokenForBalanceResult +Enum.CanRedeemTokenForBalanceResult = { + Ok = 0, + FailureCap = 1, +} + +---@enum Enum.CaptureBarWidgetFillDirectionType +Enum.CaptureBarWidgetFillDirectionType = { + RightToLeft = 0, + LeftToRight = 1, +} + +---@enum Enum.Causeofdeath +Enum.Causeofdeath = { + None = 0, + PlayerPvP = 1, + PlayerDuel = 2, + Creature = 3, + Falling = 4, + Drowning = 5, + Fatigue = 6, + Slime = 7, + Lava = 8, + Fire = 9, +} + +---@enum Enum.CauseofdeathFlags +Enum.CauseofdeathFlags = { + NoneNeeded = 0, + PlayerNameNeeded = 1, + CreatureNameNeeded = 2, + ZoneNameNeeded = 4, +} + +---@enum Enum.ChallengeModeHistoryFlags +Enum.ChallengeModeHistoryFlags = { + None = 0, + ConfirmedLeaver = 1, +} + +---@enum Enum.ChallengeModeHistoryResult +Enum.ChallengeModeHistoryResult = { + Successful = 0, + Leaver = 1, +} + +---@enum Enum.ChallengeModeHistoryStatus +Enum.ChallengeModeHistoryStatus = { + Normal = 0, + Leaver = 1, +} + +---@enum Enum.ChannelPlayerFlags +Enum.ChannelPlayerFlags = { + ChannelPlayerNone = 0x0, + ChannelPlayerOwner = 0x1, + ChannelPlayerModerator = 0x2, + ChannelPlayerTextAllow = 0x4, + ChannelPlayerHidden = 0x8, +} + +---@enum Enum.CharCustomizationType +Enum.CharCustomizationType = { + Skin = 0, + Face = 1, + Hair = 2, + HairColor = 3, + FacialHair = 4, + CustomOptionTattoo = 5, + CustomOptionHorn = 6, + CustomOptionFacewear = 7, + CustomOptionTattooColor = 8, +} + +---@enum Enum.CharacterServiceInfoFlag +Enum.CharacterServiceInfoFlag = { + RestrictToRecommendedSpecs = 1, + AllowMaxLevelBoost = 2, +} + +---@enum Enum.ChatChannelRuleset +Enum.ChatChannelRuleset = { + None = 0, + Mentor = 1, + Disabled = 2, + ChromieTimeCataclysm = 3, + ChromieTimeBuringCrusade = 4, + ChromieTimeWrath = 5, + ChromieTimeMists = 6, + ChromieTimeWoD = 7, + ChromieTimeLegion = 8, +} + +---@enum Enum.ChatChannelType +Enum.ChatChannelType = { + None = 0, + Custom = 1, + PrivateParty = 2, + PublicParty = 3, + Communities = 4, +} + +---@enum Enum.ChatMessagingLockdownRestriction +Enum.ChatMessagingLockdownRestriction = { + DropIncomingAddonMessages = 1, + DropOutgoingAddonMessages = 2, +} + +---@enum Enum.ChatToxityFilterOptOut +Enum.ChatToxityFilterOptOut = { + FilterAll = 0, + ExcludeFilterFriend = 1, + ExcludeFilterGuild = 2, + ExcludeFilterAll = 4294967295, +} + +---@enum Enum.ChatWhisperTargetStatus +Enum.ChatWhisperTargetStatus = { + CanWhisper = 0, + CanWhisperGuild = 1, + Offline = 2, + WrongFaction = 3, +} + +---@enum Enum.ChrCustomizationCategoryFlag +Enum.ChrCustomizationCategoryFlag = { + UndressModel = 1, + Subcategory = 2, +} + +---@enum Enum.ChrCustomizationOptionType +Enum.ChrCustomizationOptionType = { + Dropdown = 0, + Checkbox = 1, + Slider = 2, +} + +---@enum Enum.ChrModelFeatureFlags +Enum.ChrModelFeatureFlags = { + None = 0x0, + Summons = 0x1, + Forms = 0x2, + Identity = 0x4, + Deprecated0 = 0x8, + Mounts = 0x10, + HunterPets = 0x20, + Players = 0x40, +} + +---@enum Enum.ChrRacesAllianceType +Enum.ChrRacesAllianceType = { + Alliance = 0, + Horde = 1, + NeutralOrNpc = 2, +} + +---@enum Enum.CinematicType +Enum.CinematicType = { + GlueMovie = 0, + GameMovie = 1, + GameClientScene = 2, + GameCinematicSequence = 3, +} + +---@enum Enum.ClickBindingInteraction +Enum.ClickBindingInteraction = { + Target = 1, + OpenContextMenu = 2, +} + +---@enum Enum.ClickBindingType +Enum.ClickBindingType = { + None = 0, + Spell = 1, + Macro = 2, + Interaction = 3, + PetAction = 4, +} + +---@enum Enum.ClientDebugAISpellReadyStatus +Enum.ClientDebugAISpellReadyStatus = { + Ready = 0, + Cooldown = 1, + InitialDelay = 2, + Enabled = 3, + Paused = 4, + Charmed = 5, + Stunned = 6, + Silenced = 7, + Pacified = 8, + NoActions = 9, + Fleeing = 10, + Confused = 11, + Tokenless = 12, + EquippedItems = 13, + ReadyToCast = 14, + PowerCost = 15, + ShapeShiftRules = 16, + StealthRules = 17, + Peaceful = 18, + CasterAuraStateRestrictions = 19, + ExcludeCasterAuraStateRestrictions = 20, + CasterAuraSpellRestrictions = 21, + ExcludeCasterSpell = 22, + DungeonEncounter = 23, + FactionReaction = 24, + DungeonEncounterID = 25, + CheckArea = 26, + CombatCondition = 27, + HasTargets = 28, + CasterAuraEffectRestrictions = 29, + ExcludeCasterAuraEffect = 30, + GeneralAuraRestrictions = 31, +} + +---@enum Enum.ClientPlatformType +Enum.ClientPlatformType = { + Windows = 0, + Macintosh = 1, +} + +---@enum Enum.ClientSceneType +Enum.ClientSceneType = { + DefaultSceneType = 0, + MinigameSceneType = 1, +} + +---@enum Enum.ClientSettingsConfigFlag +Enum.ClientSettingsConfigFlag = { + ClientSettingsConfigDebug = 0x1, + ClientSettingsConfigInternal = 0x2, + ClientSettingsConfigPerf = 0x4, + ClientSettingsConfigGm = 0x8, + ClientSettingsConfigTest = 0x10, + ClientSettingsConfigTestRetail = 0x20, + ClientSettingsConfigBeta = 0x40, + ClientSettingsConfigBetaRetail = 0x80, + ClientSettingsConfigRetail = 0x100, +} + +---@enum Enum.ClubActionType +Enum.ClubActionType = { + ErrorClubActionSubscribe = 0, + ErrorClubActionCreate = 1, + ErrorClubActionEdit = 2, + ErrorClubActionDestroy = 3, + ErrorClubActionLeave = 4, + ErrorClubActionCreateTicket = 5, + ErrorClubActionDestroyTicket = 6, + ErrorClubActionRedeemTicket = 7, + ErrorClubActionGetTicket = 8, + ErrorClubActionGetTickets = 9, + ErrorClubActionGetBans = 10, + ErrorClubActionGetInvitations = 11, + ErrorClubActionRevokeInvitation = 12, + ErrorClubActionAcceptInvitation = 13, + ErrorClubActionDeclineInvitation = 14, + ErrorClubActionCreateStream = 15, + ErrorClubActionEditStream = 16, + ErrorClubActionDestroyStream = 17, + ErrorClubActionInviteMember = 18, + ErrorClubActionEditMember = 19, + ErrorClubActionEditMemberNote = 20, + ErrorClubActionKickMember = 21, + ErrorClubActionAddBan = 22, + ErrorClubActionRemoveBan = 23, + ErrorClubActionCreateMessage = 24, + ErrorClubActionEditMessage = 25, + ErrorClubActionDestroyMessage = 26, +} + +---@enum Enum.ClubErrorType +Enum.ClubErrorType = { + ErrorCommunitiesNone = 0, + ErrorCommunitiesUnknown = 1, + ErrorCommunitiesNeutralFaction = 2, + ErrorCommunitiesUnknownRealm = 3, + ErrorCommunitiesBadTarget = 4, + ErrorCommunitiesWrongFaction = 5, + ErrorCommunitiesRestricted = 6, + ErrorCommunitiesIgnored = 7, + ErrorCommunitiesGuild = 8, + ErrorCommunitiesWrongRegion = 9, + ErrorCommunitiesUnknownTicket = 10, + ErrorCommunitiesMissingShortName = 11, + ErrorCommunitiesProfanity = 12, + ErrorCommunitiesTrial = 13, + ErrorCommunitiesVeteranTrial = 14, + ErrorCommunitiesChatMute = 15, + ErrorClubFull = 16, + ErrorClubNoClub = 17, + ErrorClubNotMember = 18, + ErrorClubAlreadyMember = 19, + ErrorClubNoSuchMember = 20, + ErrorClubNoSuchInvitation = 21, + ErrorClubInvitationAlreadyExists = 22, + ErrorClubInvalidRoleID = 23, + ErrorClubInsufficientPrivileges = 24, + ErrorClubTooManyClubsJoined = 25, + ErrorClubVoiceFull = 26, + ErrorClubStreamNoStream = 27, + ErrorClubStreamInvalidName = 28, + ErrorClubStreamCountAtMin = 29, + ErrorClubStreamCountAtMax = 30, + ErrorClubMemberHasRequiredRole = 31, + ErrorClubSentInvitationCountAtMax = 32, + ErrorClubReceivedInvitationCountAtMax = 33, + ErrorClubTargetIsBanned = 34, + ErrorClubBanAlreadyExists = 35, + ErrorClubBanCountAtMax = 36, + ErrorClubTicketCountAtMax = 37, + ErrorClubTicketNoSuchTicket = 38, + ErrorClubTicketHasConsumedAllowedRedeemCount = 39, + ErrorClubDoesntAllowCrossFaction = 40, + ErrorClubEditHasCrossFactionMembers = 41, +} + +---@enum Enum.ClubFieldType +Enum.ClubFieldType = { + ClubName = 0, + ClubShortName = 1, + ClubDescription = 2, + ClubBroadcast = 3, + ClubStreamName = 4, + ClubStreamSubject = 5, + NumTypes = 6, +} + +---@enum Enum.ClubFinderApplicationUpdateType +Enum.ClubFinderApplicationUpdateType = { + None = 0, + AcceptInvite = 1, + DeclineInvite = 2, + Cancel = 3, +} + +---@enum Enum.ClubFinderClubPostingStatusFlags +Enum.ClubFinderClubPostingStatusFlags = { + None = 0, + NeedsCacheUpdate = 1, + ForceDescriptionChange = 2, + ForceNameChange = 3, + UnderReview = 4, + Banned = 5, + FakePost = 6, + PendingDelete = 7, + PostDelisted = 8, +} + +---@enum Enum.ClubFinderDisableReason +Enum.ClubFinderDisableReason = { + Muted = 0, + Silenced = 1, + VeteranTrial = 2, +} + +---@enum Enum.ClubFinderPostingReportType +Enum.ClubFinderPostingReportType = { + PostersName = 0, + ClubName = 1, + PostingDescription = 2, + ApplicantsName = 3, + JoinNote = 4, +} + +---@enum Enum.ClubFinderRequestType +Enum.ClubFinderRequestType = { + None = 0, + Guild = 1, + Community = 2, + All = 3, +} + +---@enum Enum.ClubFinderSettingFlags +Enum.ClubFinderSettingFlags = { + None = 0, + Dungeons = 1, + Raids = 2, + PvP = 3, + RP = 4, + Social = 5, + Small = 6, + Medium = 7, + Large = 8, + Tank = 9, + Healer = 10, + Damage = 11, + EnableListing = 12, + MaxLevelOnly = 13, + AutoAccept = 14, + FactionHorde = 15, + FactionAlliance = 16, + FactionNeutral = 17, + SortRelevance = 18, + SortMemberCount = 19, + SortNewest = 20, + LanguageReserved1 = 21, + LanguageReserved2 = 22, + LanguageReserved3 = 23, + LanguageReserved4 = 24, + LanguageReserved5 = 25, +} + +---@enum Enum.ClubInvitationCandidateStatus +Enum.ClubInvitationCandidateStatus = { + Available = 0, + InvitePending = 1, + AlreadyMember = 2, +} + +---@enum Enum.ClubMemberPresence +Enum.ClubMemberPresence = { + Unknown = 0, + Online = 1, + OnlineMobile = 2, + Offline = 3, + Away = 4, + Busy = 5, +} + +---@enum Enum.ClubRemovedReason +Enum.ClubRemovedReason = { + None = 0, + Banned = 1, + Removed = 2, + ClubDestroyed = 3, +} + +---@enum Enum.ClubRestrictionReason +Enum.ClubRestrictionReason = { + None = 0, + Unavailable = 1, +} + +---@enum Enum.ClubRoleIdentifier +Enum.ClubRoleIdentifier = { + Owner = 1, + Leader = 2, + Moderator = 3, + Member = 4, +} + +---@enum Enum.ClubStreamNotificationFilter +Enum.ClubStreamNotificationFilter = { + None = 0, + Mention = 1, + All = 2, +} + +---@enum Enum.ClubStreamType +Enum.ClubStreamType = { + General = 0, + Guild = 1, + Officer = 2, + Other = 3, +} + +---@enum Enum.ClubType +Enum.ClubType = { + BattleNet = 0, + Character = 1, + Guild = 2, + Other = 3, +} + +---@enum Enum.ColorOverride +Enum.ColorOverride = { + ItemQualityPoor = 0, + ItemQualityCommon = 1, + ItemQualityUncommon = 2, + ItemQualityRare = 3, + ItemQualityEpic = 4, + ItemQualityLegendary = 5, + ItemQualityArtifact = 6, + ItemQualityAccount = 7, +} + +---@enum Enum.CombatAudioAlertCastState +Enum.CombatAudioAlertCastState = { + Off = 0, + OnCastStart = 1, + OnCastEnd = 2, +} + +---@enum Enum.CombatAudioAlertCategory +Enum.CombatAudioAlertCategory = { + General = 0, + PlayerHealth = 1, + TargetHealth = 2, + PlayerCast = 3, + TargetCast = 4, + PlayerResource1 = 5, + PlayerResource2 = 6, + PartyHealth = 7, + PlayerDebuffs = 8, +} + +---@enum Enum.CombatAudioAlertDebuffSelfAlertValues +Enum.CombatAudioAlertDebuffSelfAlertValues = { + Off = 0, + DispelType = 1, +} + +---@enum Enum.CombatAudioAlertPartyPercentValues +Enum.CombatAudioAlertPartyPercentValues = { + Off = 0, + Under100Percent = 1, + Under90Percent = 2, + Under80Percent = 3, + Under70Percent = 4, + Under60Percent = 5, + Under50Percent = 6, + Under40Percent = 7, + Under30Percent = 8, + Under20Percent = 9, + Under10Percent = 10, +} + +---@enum Enum.CombatAudioAlertPercentValues +Enum.CombatAudioAlertPercentValues = { + Off = 0, + Every10Percent = 1, + Every20Percent = 2, + Every30Percent = 3, + Every40Percent = 4, + Every50Percent = 5, +} + +---@enum Enum.CombatAudioAlertPlayerCastFormatValues +Enum.CombatAudioAlertPlayerCastFormatValues = { + CastingSpellname = 0, + CastSpellname = 1, + Casting = 2, + Cast = 3, + Spellname = 4, +} + +---@enum Enum.CombatAudioAlertPlayerDebuffFormatValues +Enum.CombatAudioAlertPlayerDebuffFormatValues = { + Full = 0, + NoSpellname = 1, +} + +---@enum Enum.CombatAudioAlertPlayerHealthFormatValues +Enum.CombatAudioAlertPlayerHealthFormatValues = { + HealthFull = 0, + HealthNoPercent = 1, + HealthNoPercentDiv10 = 2, + NoHealthFull = 3, + NoHealthNoPercent = 4, + NoHealthNoPercentDiv10 = 5, +} + +---@enum Enum.CombatAudioAlertPlayerResourceFormatValues +Enum.CombatAudioAlertPlayerResourceFormatValues = { + ResourceFull = 0, + ResourceNoPercent = 1, + ResourceNoPercentDiv10 = 2, + NoResourceFull = 3, + NoResourceNoPercent = 4, + NoResourceNoPercentDiv10 = 5, +} + +---@enum Enum.CombatAudioAlertSayIfTargetedType +Enum.CombatAudioAlertSayIfTargetedType = { + None = 0, + Aggro = 1, + Targeted = 2, + TargetedBy = 3, +} + +---@enum Enum.CombatAudioAlertSpecSetting +Enum.CombatAudioAlertSpecSetting = { + Resource1Percent = 0, + Resource1Format = 1, + Resource1Voice = 2, + Resource1Volume = 3, + Resource2Percent = 4, + Resource2Format = 5, + Resource2Voice = 6, + Resource2Volume = 7, + SayIfTargeted = 8, +} + +---@enum Enum.CombatAudioAlertTargetCastFormatValues +Enum.CombatAudioAlertTargetCastFormatValues = { + TargetCastingSpellname = 0, + TargetCastSpellname = 1, + CastingSpellname = 2, + CastSpellname = 3, + Casting = 4, + Cast = 5, + Spellname = 6, +} + +---@enum Enum.CombatAudioAlertTargetDeathBehavior +Enum.CombatAudioAlertTargetDeathBehavior = { + Default = 0, + SayTargetDead = 1, +} + +---@enum Enum.CombatAudioAlertTargetHealthFormatValues +Enum.CombatAudioAlertTargetHealthFormatValues = { + NoHealthFull = 0, + NoHealthNoPercent = 1, + NoHealthNoPercentDiv10 = 2, + HealthFull = 3, + HealthNoPercent = 4, + HealthNoPercentDiv10 = 5, + TargetFull = 6, + TargetNoPercent = 7, + TargetNoPercentDiv10 = 8, +} + +---@enum Enum.CombatAudioAlertThrottle +Enum.CombatAudioAlertThrottle = { + Sample = 0, + PlayerHealth = 1, + TargetHealth = 2, + PlayerCast = 3, + TargetCast = 4, + PlayerResource1 = 5, + PlayerResource2 = 6, + PlayerHealthSamePercent = 7, + TargetHealthSamePercent = 8, + PlayerResource1SamePercent = 9, + PlayerResource2SamePercent = 10, +} + +---@enum Enum.CombatAudioAlertType +Enum.CombatAudioAlertType = { + Health = 0, + Cast = 1, +} + +---@enum Enum.CombatAudioAlertUnit +Enum.CombatAudioAlertUnit = { + Player = 0, + Target = 1, +} + +---@enum Enum.CombatLogMessageOrder +Enum.CombatLogMessageOrder = { + Newest = 0, + Oldest = 1, +} + +---@enum Enum.CombatLogObject +Enum.CombatLogObject = { + Empty = 0x0, + AffiliationMine = 0x1, + AffiliationParty = 0x2, + AffiliationRaid = 0x4, + AffiliationOutsider = 0x8, + ReactionFriendly = 0x10, + ReactionNeutral = 0x20, + ReactionHostile = 0x40, + ControlPlayer = 0x100, + ControlNpc = 0x200, + TypePlayer = 0x400, + TypeNpc = 0x800, + TypePet = 0x1000, + TypeGuardian = 0x2000, + TypeObject = 0x4000, + Target = 0x10000, + Focus = 0x20000, + Maintank = 0x40000, + Mainassist = 0x80000, + None = 0x80000000, +} + +---@enum Enum.CombatLogObjectTarget +Enum.CombatLogObjectTarget = { + Raidtarget1 = 0x1, + Raidtarget2 = 0x2, + Raidtarget3 = 0x4, + Raidtarget4 = 0x8, + Raidtarget5 = 0x10, + Raidtarget6 = 0x20, + Raidtarget7 = 0x40, + Raidtarget8 = 0x80, + RaidNone = 0x80000000, +} + +---@enum Enum.CombinedQuestLogStatus +Enum.CombinedQuestLogStatus = { + Available = 0, + Complete = 1, + CompleteDaily = 2, + CompleteWeekly = 3, + CompleteMonthly = 4, + CompleteYearly = 5, + CompleteGameReset = 6, + Reset = 7, +} + +---@enum Enum.CombinedQuestStatus +Enum.CombinedQuestStatus = { + Invalid = 0, + Completed = 1, + NotCompleted = 2, +} + +---@enum Enum.CommunicationMode +Enum.CommunicationMode = { + PushToTalk = 0, + OpenMic = 1, +} + +---@enum Enum.CompanionConfigSlotTypes +Enum.CompanionConfigSlotTypes = { + Role = 0, + Utility = 1, + Combat = 2, +} + +---@enum Enum.CompanionRoleType +Enum.CompanionRoleType = { + Dps = 0, + Heal = 1, + Tank = 2, +} + +---@enum Enum.CompressionLevel +Enum.CompressionLevel = { + Default = 0, + OptimizeForSpeed = 1, + OptimizeForSize = 2, +} + +---@enum Enum.CompressionMethod +Enum.CompressionMethod = { + Deflate = 0, + Zlib = 1, + Gzip = 2, +} + +---@enum Enum.ConfirmationPromptUIType +Enum.ConfirmationPromptUIType = { + StaticText = 0, + BonusRoll = 1, + SimpleWarning = 2, + StaticTextAlert = 3, + SimpleWarningAlert = 4, +} + +---@enum Enum.ConquestProgressBarDisplayType +Enum.ConquestProgressBarDisplayType = { + FirstChest = 0, + AdditionalChest = 1, + Seasonal = 2, +} + +---@enum Enum.ConsoleCategory +Enum.ConsoleCategory = { + Debug = 0, + Graphics = 1, + Console = 2, + Combat = 3, + Game = 4, + Default = 5, + Net = 6, + Sound = 7, + Gm = 8, + Reveal = 9, + None = 10, +} + +---@enum Enum.ConsoleColorType +Enum.ConsoleColorType = { + DefaultColor = 0, + InputColor = 1, + EchoColor = 2, + ErrorColor = 3, + WarningColor = 4, + GlobalColor = 5, + AdminColor = 6, + HighlightColor = 7, + BackgroundColor = 8, + ClickbufferColor = 9, + PrivateColor = 10, + DefaultGreen = 11, +} + +---@enum Enum.ConsoleCommandType +Enum.ConsoleCommandType = { + Cvar = 0, + Command = 1, + Macro = 2, + Script = 3, +} + +---@enum Enum.ContentTrackingError +Enum.ContentTrackingError = { + Untrackable = 0, + MaxTracked = 1, + AlreadyTracked = 2, +} + +---@enum Enum.ContentTrackingResult +Enum.ContentTrackingResult = { + Success = 0, + DataPending = 1, + Failure = 2, +} + +---@enum Enum.ContentTrackingStopType +Enum.ContentTrackingStopType = { + Invalidated = 0, + Collected = 1, + Manual = 2, +} + +---@enum Enum.ContentTrackingTargetType +Enum.ContentTrackingTargetType = { + JournalEncounter = 0, + Vendor = 1, + Achievement = 2, + Profession = 3, + Quest = 4, +} + +---@enum Enum.ContentTrackingType +Enum.ContentTrackingType = { + Appearance = 0, + Mount = 1, + Achievement = 2, + Decor = 3, +} + +---@enum Enum.ContributionAppearanceFlags +Enum.ContributionAppearanceFlags = { + TooltipUseTimeRemaining = 0, +} + +---@enum Enum.ContributionResult +Enum.ContributionResult = { + Success = 0, + MustBeNearNpc = 1, + IncorrectState = 2, + InvalidID = 3, + QuestDataMissing = 4, + FailedConditionCheck = 5, + UnableToCompleteTurnIn = 6, + InternalError = 7, +} + +---@enum Enum.ContributionState +Enum.ContributionState = { + None = 0, + Building = 1, + Active = 2, + UnderAttack = 3, + Destroyed = 4, +} + +---@enum Enum.CooldownLayoutAction +Enum.CooldownLayoutAction = { + ChangeOrder = 0, + ChangeCategory = 1, + AddLayout = 2, + AddAlert = 3, +} + +---@enum Enum.CooldownLayoutStatus +Enum.CooldownLayoutStatus = { + Success = 0, + InvalidLayoutName = 1, + TooManyLayouts = 2, + AttemptToModifyDefaultLayoutWouldCreateTooManyLayouts = 3, + TooManyAlerts = 4, + InvalidOrderChange = 5, + NoValidAlerts = 6, +} + +---@enum Enum.CooldownLayoutType +Enum.CooldownLayoutType = { + Character = 1, + Account = 2, +} + +---@enum Enum.CooldownSetLinkedSpellFlags +Enum.CooldownSetLinkedSpellFlags = { + UseAsTooltip = 1, +} + +---@enum Enum.CooldownSetSpellFlags +Enum.CooldownSetSpellFlags = { + HideAura = 1, + HideByDefault = 2, +} + +---@enum Enum.CooldownViewerAddAlertStatus +Enum.CooldownViewerAddAlertStatus = { + Success = 0, + InvalidAlertType = 1, + InvalidEventType = 2, + DuplicateAlert = 3, +} + +---@enum Enum.CooldownViewerAlertEventType +Enum.CooldownViewerAlertEventType = { + Available = 1, + PandemicTime = 2, + OnCooldown = 3, + ChargeGained = 4, + OnAuraApplied = 5, + OnAuraRemoved = 6, +} + +---@enum Enum.CooldownViewerAlertType +Enum.CooldownViewerAlertType = { + Sound = 1, + Visual = 2, +} + +---@enum Enum.CooldownViewerBarContent +Enum.CooldownViewerBarContent = { + IconAndName = 0, + IconOnly = 1, + NameOnly = 2, +} + +---@enum Enum.CooldownViewerCategory +Enum.CooldownViewerCategory = { + HiddenAura = -2, + HiddenSpell = -1, + Essential = 0, + Utility = 1, + TrackedBuff = 2, + TrackedBar = 3, +} + +---@enum Enum.CooldownViewerIconDirection +Enum.CooldownViewerIconDirection = { + Left = 0, + Right = 1, +} + +---@enum Enum.CooldownViewerOrientation +Enum.CooldownViewerOrientation = { + Horizontal = 0, + Vertical = 1, +} + +---@enum Enum.CooldownViewerVisibleSetting +Enum.CooldownViewerVisibleSetting = { + Always = 0, + InCombat = 1, + Hidden = 2, +} + +---@enum Enum.CornerstonePurchaseMode +Enum.CornerstonePurchaseMode = { + Basic = 0, + Import = 1, + Move = 2, +} + +---@enum Enum.CovenantAbilityType +Enum.CovenantAbilityType = { + Class = 0, + Signature = 1, + Soulbind = 2, +} + +---@enum Enum.CovenantSkill +Enum.CovenantSkill = { + Kyrian = 2730, + Venthyr = 2731, + NightFae = 2732, + Necrolord = 2733, +} + +---@enum Enum.CovenantType +Enum.CovenantType = { + None = 0, + Kyrian = 1, + Venthyr = 2, + NightFae = 3, + Necrolord = 4, +} + +---@enum Enum.CraftingOrderCustomerCategoryType +Enum.CraftingOrderCustomerCategoryType = { + Primary = 0, + Secondary = 1, + Tertiary = 2, +} + +---@enum Enum.CraftingOrderDuration +Enum.CraftingOrderDuration = { + Short = 0, + Medium = 1, + Long = 2, +} + +---@enum Enum.CraftingOrderFlags +Enum.CraftingOrderFlags = { + None = 0x0, + IsRecraft = 0x1, + HasNoneReagents = 0x2, + HasSomeReagents = 0x4, + HasAllReagents = 0x8, + IsFulfillable = 0x10, +} + +---@enum Enum.CraftingOrderItemFlags +Enum.CraftingOrderItemFlags = { + None = 0, + NpcProvided = 1, + HasEnchantmentData = 2, +} + +---@enum Enum.CraftingOrderItemType +Enum.CraftingOrderItemType = { + Item = 0, + Recraft = 1, + CraftedResult = 2, + RemoveReagent = 3, + Deprecated = 4, + Currency = 5, +} + +---@enum Enum.CraftingOrderReagentSource +Enum.CraftingOrderReagentSource = { + Any = 0, + Customer = 1, + Crafter = 2, + None = 3, +} + +---@enum Enum.CraftingOrderReagentsType +Enum.CraftingOrderReagentsType = { + All = 0, + Some = 1, + None = 2, +} + +---@enum Enum.CraftingOrderResult +Enum.CraftingOrderResult = { + Ok = 0, + Aborted = 1, + AlreadyClaimed = 2, + AlreadyCrafted = 3, + CannotBeOrdered = 4, + CannotCancel = 5, + CannotClaim = 6, + CannotClaimOwnOrder = 7, + CannotCraft = 8, + CannotCreate = 9, + CannotFulfill = 10, + CannotRecraft = 11, + CannotReject = 12, + CannotRelease = 13, + CrafterIsIgnored = 14, + DatabaseError = 15, + Expired = 16, + Locked = 17, + InvalidDuration = 18, + InvalidMinQuality = 19, + InvalidNotes = 20, + InvalidReagent = 21, + InvalidRealm = 22, + InvalidRecipe = 23, + InvalidRecraftItem = 24, + InvalidSort = 25, + InvalidTarget = 26, + InvalidType = 27, + MaxOrdersReached = 28, + MissingCraftingTable = 29, + MissingCurrency = 30, + MissingItem = 31, + MissingNpc = 32, + MissingOrder = 33, + MissingRecraftItem = 34, + NoAccountItems = 35, + NotClaimed = 36, + NotCrafted = 37, + NotInGuild = 38, + NotYetImplemented = 39, + OutOfPublicOrderCapacity = 40, + ServerIsNotAvailable = 41, + ThrottleViolation = 42, + TargetCannotCraft = 43, + TargetLocked = 44, + Timeout = 45, + TooManyCurrencies = 46, + TooManyItems = 47, + WrongVersion = 48, +} + +---@enum Enum.CraftingOrderSortType +Enum.CraftingOrderSortType = { + ItemName = 0, + AveTip = 1, + MaxTip = 2, + Quantity = 3, + Reagents = 4, + Tip = 5, + TimeRemaining = 6, + Status = 7, +} + +---@enum Enum.CraftingOrderState +Enum.CraftingOrderState = { + None = 0, + Creating = 1, + Created = 2, + Claiming = 3, + Claimed = 4, + Rejecting = 5, + Rejected = 6, + Releasing = 7, + Crafting = 8, + Recrafting = 9, + Fulfilling = 10, + Fulfilled = 11, + Canceling = 12, + Canceled = 13, + Expiring = 14, + Expired = 15, +} + +---@enum Enum.CraftingOrderType +Enum.CraftingOrderType = { + Public = 0, + Guild = 1, + Personal = 2, + Npc = 3, +} + +---@enum Enum.CraftingReagentItemFlag +Enum.CraftingReagentItemFlag = { + TooltipShowsAsStatModifications = 1, +} + +---@enum Enum.CraftingReagentType +Enum.CraftingReagentType = { + Modifying = 0, + Basic = 1, + Finishing = 2, + Automatic = 3, +} + +---@enum Enum.CreateAllAccountData +Enum.CreateAllAccountData = { + None = "0x0000000000000000", + AchievementsDone = "0x0000000000000001", + CriteriaDone = "0x0000000000000002", + MountsDone = "0x0000000000000004", + BattlepetsDone = "0x0000000000000008", + CurrencycapsDone = "0x0000000000000010", + QuestLogDone = "0x0000000000000020", + CharactersDone = "0x0000000000000040", + PurchasesDone = "0x0000000000000080", + BpayDistributionObjectsDone = "0x0000000000000100", + ArchivedPurchasesDone = "0x0000000000000200", + SettingsDone = "0x0000000000000400", + BpayAddLicenseObjectsDone = "0x0000000000000800", + ItemCollectionItemsDone = "0x0000000000001000", + AuctionableTokensDone = "0x0000000000002000", + ConsumableTokensDone = "0x0000000000004000", + PerkPastRewardsDone = "0x0000000000008000", + VasTransactionsDone = "0x0000000000010000", + BpayProductitemObjectsDone = "0x0000000000020000", + TrialBoostHistoryDone = "0x0000000000040000", + QuestCriteriaDone = "0x0000000000080000", + Object = "0x0000000000100000", + AccountCurrenciesDone = "0x0000000000200000", + RafBalanceDone = "0x0000000000400000", + RafRewardsDone = "0x0000000000800000", + AccountDynamicCriteriaDone = "0x0000000001000000", + RafActivitiesDone = "0x0000000002000000", + RevokedRafRewardsDone = "0x0000000004000000", + AccountNotificationsDone = "0x0000000008000000", + PerkPendingPurchasesDone = "0x0000000010000000", + WowlabsDataDone = "0x0000000020000000", + PerkHeldItemsDone = "0x0000000040000000", + PerkPendingRewardsDone = "0x0000000080000000", + BitVectorsDone = "0x0000000100000000", + AccountFactionsDone = "0x0000000200000000", + AccountItemsDone = "0x0000000400000000", + CombinedQuestLogEntriesDone = "0x0000000800000000", + DataElementsDone = "0x0000001000000000", + WarbandGroupsDone = "0x0000002000000000", + BanktabSettingsDone = "0x0000004000000000", + AccountMappingDone = "0x0000008000000000", + CharacterItemsDone = "0x0000010000000000", + CurrencyTransferLogDone = "0x0000020000000000", + LgVendorPurchaseDone = "0x0000040000000000", + AccountStateHousingData = "0x0000080000000000", + WarbandScenesLoadedDone = "0x0000100000000000", + EventRecordsDone = "0x0000200000000000", + TransmogOutfitsLoadedDone = "0x0000400000000000", +} + +---@enum Enum.CreateNeighborhoodErrorType +Enum.CreateNeighborhoodErrorType = { + None = 0, + Profanity = 1, + UndersizedGuild = 2, + OversizedGuild = 3, +} + +---@enum Enum.CurioRarity +Enum.CurioRarity = { + Common = 1, + Uncommon = 2, + Rare = 3, + Epic = 4, +} + +---@enum Enum.CurioType +Enum.CurioType = { + Combat = 0, + Utility = 1, +} + +---@enum Enum.CurrencyDestroyReason +Enum.CurrencyDestroyReason = { + Cheat = 0, + Spell = 1, + VersionUpdate = 2, + QuestTurnin = 3, + Vendor = 4, + Trade = 5, + Capped = 6, + Garrison = 7, + DroppedToCorpse = 8, + BonusRoll = 9, + FactionConversion = 10, + FulfillCraftingOrder = 11, + Script = 12, + ConcentrationCast = 13, + AccountTransfer = 14, + HonorLoss = 15, + CraftingOrderReagent = 16, +} + +---@enum Enum.CurrencyFilterType +Enum.CurrencyFilterType = { + None = 0, + DiscoveredOnly = 1, + DiscoveredAndAllAccountTransferable = 2, +} + +---@enum Enum.CurrencyFlags +Enum.CurrencyFlags = { + CurrencyTradable = 0x1, + CurrencyAppearsInLootWindow = 0x2, + CurrencyComputedWeeklyMaximum = 0x4, + Currency_100_Scaler = 0x8, + CurrencyNoLowLevelDrop = 0x10, + CurrencyIgnoreMaxQtyOnLoad = 0x20, + CurrencyLogOnWorldChange = 0x40, + CurrencyTrackQuantity = 0x80, + CurrencyResetTrackedQuantity = 0x100, + CurrencyUpdateVersionIgnoreMax = 0x200, + CurrencySuppressChatMessageOnVersionChange = 0x400, + CurrencySingleDropInLoot = 0x800, + CurrencyHasWeeklyCatchup = 0x1000, + CurrencyDoNotCompressChat = 0x2000, + CurrencyDoNotLogAcquisitionToBi = 0x4000, + CurrencyNoRaidDrop = 0x8000, + CurrencyNotPersistent = 0x10000, + CurrencyDeprecated = 0x20000, + CurrencyDynamicMaximum = 0x40000, + CurrencySuppressChatMessages = 0x80000, + CurrencyDoNotToast = 0x100000, + CurrencyDestroyExtraOnLoot = 0x200000, + CurrencyDontShowTotalInTooltip = 0x400000, + CurrencyDontCoalesceInLootWindow = 0x800000, + CurrencyAccountWide = 0x1000000, + CurrencyAllowOverflowMailer = 0x2000000, + CurrencyHideAsReward = 0x4000000, + CurrencyHasWarmodeBonus = 0x8000000, + CurrencyIsAllianceOnly = 0x10000000, + CurrencyIsHordeOnly = 0x20000000, + CurrencyLimitWarmodeBonusOncePerTooltip = 0x40000000, + CurrencyUsesLedgerBalance = 0x80000000, +} + +---@enum Enum.CurrencyFlagsB +Enum.CurrencyFlagsB = { + CurrencyBUseTotalEarnedForEarned = 0x1, + CurrencyBShowQuestXPGainInTooltip = 0x2, + CurrencyBNoNotificationMailOnOfflineProgress = 0x4, + CurrencyBBattlenetVirtualCurrency = 0x8, + FutureCurrencyFlag = 0x10, + CurrencyBDontDisplayIfZero = 0x20, + CurrencyBScaleMaxQuantityBySeasonWeeks = 0x40, + CurrencyBScaleMaxQuantityByWeeksSinceStart = 0x80, + CurrencyBForceMaxQuantityOnConversion = 0x100, + CurrencyBUnearnableBeforeMaxQuantityStart = 0x200, + CurrencyBAllowReductionByResourcefulness = 0x400, + CurrencyBNoBonusXP = 0x800, +} + +---@enum Enum.CurrencyGainFlags +Enum.CurrencyGainFlags = { + None = 0x0, + BonusAward = 0x1, + DroppedFromDeath = 0x2, + FromAccountServer = 0x4, + Autotracking = 0x8, +} + +---@enum Enum.CurrencySource +Enum.CurrencySource = { + ConvertOldItem = 0, + ConvertOldPvPCurrency = 1, + ItemRefund = 2, + QuestReward = 3, + Cheat = 4, + Vendor = 5, + PvPKillCredit = 6, + PvPMetaCredit = 7, + PvPScriptedAward = 8, + Loot = 9, + UpdatingVersion = 10, + LFGReward = 11, + Trade = 12, + Spell = 13, + ItemDeletion = 14, + RatedBattleground = 15, + RandomBattleground = 16, + Arena = 17, + ExceededMaxQty = 18, + PvPCompletionBonus = 19, + Script = 20, + GuildBankWithdrawal = 21, + Pushloot = 22, + GarrisonBuilding = 23, + PvPDrop = 24, + GarrisonFollowerActivation = 25, + GarrisonBuildingRefund = 26, + GarrisonMissionReward = 27, + GarrisonResourceOverTime = 28, + CurrencyWalletClaim = 29, + GarrisonTalent = 30, + GarrisonWorldQuestBonus = 31, + PvPHonorReward = 32, + BonusRoll = 33, + AzeriteRespec = 34, + WorldQuestReward = 35, + WorldQuestRewardIgnoreCapsDeprecated = 36, + FactionConversion = 37, + DailyQuestReward = 38, + DailyQuestWarModeReward = 39, + WeeklyQuestReward = 40, + WeeklyQuestWarModeReward = 41, + AccountCopy = 42, + WeeklyRewardChest = 43, + GarrisonTalentTreeReset = 44, + DailyReset = 45, + AddConduitToCollection = 46, + Barbershop = 47, + ConvertItemsToCurrencyValue = 48, + PvPTeamContribution = 49, + Transmogrify = 50, + AuctionDeposit = 51, + PlayerTrait = 52, + PhBuffer_53 = 53, + PhBuffer_54 = 54, + RenownRepGain = 55, + CraftingOrder = 56, + CatalystBalancing = 57, + CatalystCraft = 58, + ProfessionInitialAward = 59, + PlayerTraitRefund = 60, + AccountHwmUpdate = 61, + ConvertItemsToCurrencyAndReputation = 62, + PhBuffer_63 = 63, + SpellSkipLinkedCurrency = 64, + AccountTransfer = 65, + RenownRepGainInitialVisibility = 66, + InitiativeReward = 67, +} + +---@enum Enum.CurrencyTokenCategoryFlags +Enum.CurrencyTokenCategoryFlags = { + FlagSortLast = 0x1, + FlagPlayerItemAssignment = 0x2, + Hidden = 0x4, + Virtual = 0x8, + StartsCollapsed = 0x10, +} + +---@enum Enum.CursorStyle +Enum.CursorStyle = { + Mouse = 0, + Crosshair = 1, +} + +---@enum Enum.Cursormode +Enum.Cursormode = { + NoCursor = 0, + PointCursor = 1, + CastCursor = 2, + BuyCursor = 3, + AttackCursor = 4, + InteractCursor = 5, + SpeakCursor = 6, + InspectCursor = 7, + PickupCursor = 8, + TaxiCursor = 9, + TrainerCursor = 10, + MineCursor = 11, + SkinCursor = 12, + GatherCursor = 13, + LockCursor = 14, + MailCursor = 15, + LootAllCursor = 16, + RepairCursor = 17, + RepairnpcCursor = 18, + ItemCursor = 19, + SkinHordeCursor = 20, + SkinAllianceCursor = 21, + InnkeeperCursor = 22, + CampaignQuestCursor = 23, + CampaignQuestTurninCursor = 24, + QuestCursor = 25, + QuestRepeatableCursor = 26, + QuestTurninCursor = 27, + QuestLegendaryCursor = 28, + QuestLegendaryTurninCursor = 29, + QuestImportantCursor = 30, + QuestImportantTurninCursor = 31, + QuestMetaCursor = 32, + QuestMetaTurninCursor = 33, + QuestRecurringCursor = 34, + QuestRecurringTurninCursor = 35, + VehicleCursor = 36, + MapPinCursor = 37, + PingCursor = 38, + EnchantCursor = 39, + StablemasterCursor = 40, + PaletteCursor = 41, + BroomCursor = 42, + HoldingHandCursor = 43, + GrabbingHandCursor = 44, + UIMoveCursor = 45, + UIResizeCursor = 46, + PointErrorCursor = 47, + CastErrorCursor = 48, + BuyErrorCursor = 49, + AttackErrorCursor = 50, + InteractErrorCursor = 51, + SpeakErrorCursor = 52, + InspectErrorCursor = 53, + PickupErrorCursor = 54, + TaxiErrorCursor = 55, + TrainerErrorCursor = 56, + MineErrorCursor = 57, + SkinErrorCursor = 58, + GatherErrorCursor = 59, + LockErrorCursor = 60, + MailErrorCursor = 61, + LootAllErrorCursor = 62, + RepairErrorCursor = 63, + RepairnpcErrorCursor = 64, + ItemErrorCursor = 65, + SkinHordeErrorCursor = 66, + SkinAllianceErrorCursor = 67, + InnkeeperErrorCursor = 68, + CampaignQuestErrorCursor = 69, + CampaignQuestTurninErrorCursor = 70, + QuestErrorCursor = 71, + QuestRepeatableErrorCursor = 72, + QuestTurninErrorCursor = 73, + QuestLegendaryErrorCursor = 74, + QuestLegendaryTurninErrorCursor = 75, + QuestImportantErrorCursor = 76, + QuestImportantTurninErrorCursor = 77, + QuestMetaErrorCursor = 78, + QuestMetaTurninErrorCursor = 79, + QuestRecurringErrorCursor = 80, + QuestRecurringTurninErrorCursor = 81, + VehicleErrorCursor = 82, + MapPinErrorCursor = 83, + PingErrorCursor = 84, + EnchantErrorCursor = 85, + StablemasterErrorCursor = 86, + PaletteErrorCursor = 87, + BroomErrorCursor = 88, + HoldingHandErrorCursor = 89, + GrabbingHandErrorCursor = 90, + CustomCursor = 91, +} + +---@enum Enum.CustomBindingType +Enum.CustomBindingType = { + VoicePushToTalk = 0, +} + +---@enum Enum.DamageMeterCombineSessionType +Enum.DamageMeterCombineSessionType = { + None = 0, + ChallengeMode = 1, + Arena = 2, +} + +---@enum Enum.DamageMeterNumbers +Enum.DamageMeterNumbers = { + Minimal = 0, + Compact = 1, + Complete = 2, +} + +---@enum Enum.DamageMeterOverrideType +Enum.DamageMeterOverrideType = { + Ignore = 0, + AllowFriendlyFire = 1, + RedirectSourceToOwner = 2, + RedirectSourceToAuraCaster = 3, + IgnoreForAbsorbSpell = 4, +} + +---@enum Enum.DamageMeterSessionType +Enum.DamageMeterSessionType = { + Overall = 0, + Current = 1, + Expired = 2, +} + +---@enum Enum.DamageMeterSourceDisplayType +Enum.DamageMeterSourceDisplayType = { + None = 0, + Ally = 1, + Enemy = 2, +} + +---@enum Enum.DamageMeterSpellDetailsDisplayType +Enum.DamageMeterSpellDetailsDisplayType = { + SpellCasted = 0, + UnitSpecificSpellCasted = 1, + SpellAffected = 2, + Deaths = 3, + EnemyDamageTaken = 4, +} + +---@enum Enum.DamageMeterStorageType +Enum.DamageMeterStorageType = { + Damage = 0, + HealingAndAbsorbs = 1, + Absorbs = 2, + Interrupts = 3, + Dispels = 4, + DamageTaken = 5, + AvoidableDamageTaken = 6, + Deaths = 7, + EnemyDamageTaken = 8, +} + +---@enum Enum.DamageMeterStyle +Enum.DamageMeterStyle = { + Default = 0, + Thin = 1, + Bordered = 2, + FullBackground = 3, +} + +---@enum Enum.DamageMeterType +Enum.DamageMeterType = { + DamageDone = 0, + Dps = 1, + HealingDone = 2, + Hps = 3, + Absorbs = 4, + Interrupts = 5, + Dispels = 6, + DamageTaken = 7, + AvoidableDamageTaken = 8, + Deaths = 9, + EnemyDamageTaken = 10, +} + +---@enum Enum.DamageMeterVisibility +Enum.DamageMeterVisibility = { + Always = 0, + InCombat = 1, + Hidden = 2, +} + +---@enum Enum.Damageclass +Enum.Damageclass = { + MaskNone = 0x0, + Physical = 0x0, + AllPhysical = 0x1, + Holy = 0x1, + MaskPhysical = 0x1, + Fire = 0x2, + FirstResist = 0x2, + MaskHoly = 0x2, + MaskHolystrike = 0x3, + Nature = 0x3, + Frost = 0x4, + MaskFire = 0x4, + MaskFlamestrike = 0x5, + Shadow = 0x5, + Arcane = 0x6, + LastResist = 0x6, + MaskHolyfire = 0x6, + MaskNature = 0x8, + MaskStormstrike = 0x9, + MaskHolystorm = 0xA, + MaskFirestorm = 0xC, + MaskFrost = 0x10, + MaskFroststrike = 0x11, + MaskHolyfrost = 0x12, + MaskFrostfire = 0x14, + MaskFroststorm = 0x18, + MaskElemental = 0x1C, + MaskShadow = 0x20, + MaskShadowstrike = 0x21, + MaskTwilight = 0x22, + MaskShadowflame = 0x24, + MaskShadowstorm = 0x28, + MaskShadowfrost = 0x30, + MaskChromatic = 0x3E, + MaskArcane = 0x40, + MaskSpellstrike = 0x41, + MaskDivine = 0x42, + MaskSpellfire = 0x44, + MaskSpellstorm = 0x48, + MaskSpellfrost = 0x50, + MaskSpellshadow = 0x60, + MaskCosmic = 0x6A, + MaskChaos = 0x7C, + AllMagical = 0x7E, + MaskMagical = 0x7E, + All = 0x7F, +} + +---@enum Enum.DamageclassType +Enum.DamageclassType = { + Physical = 0, + Magical = 1, +} + +---@enum Enum.DisableAccountProfilesFlags +Enum.DisableAccountProfilesFlags = { + None = 0x0, + Document = 0x1, + SharedCollections = 0x2, + MountsCollections = 0x4, + PetsCollections = 0x8, + ItemsCollections = 0x10, + DecorsCollections = 0x20, +} + +---@enum Enum.DungeonEncounterFlags +Enum.DungeonEncounterFlags = { + StickyNews = 0x1, + GuildNews = 0x2, + RaidLockPlayers = 0x4, + AutoEnd = 0x8, + Cosmetic = 0x10, + Unused = 0x20, + HideUntilCompleted = 0x40, + NoAutoStart = 0x80, + IgnoreSpawnLimit = 0x100, + DisableEncounterEvents = 0x200, +} + +---@enum Enum.DungeonEncounterTriggerType +Enum.DungeonEncounterTriggerType = { + Invalid = 0, + OnStart = 1, + OnComplete = 2, + OnEnd = 3, + PreviouslyCompleted = 4, +} + +---@enum Enum.DungeonEncounterXCreatureFlags +Enum.DungeonEncounterXCreatureFlags = { + BossCreature = 1, + DropLootImmediately = 2, + DoNotDespawnOnSuccess = 4, +} + +---@enum Enum.DurationTimeModifier +Enum.DurationTimeModifier = { + RealTime = 0, + BaseTime = 1, +} + +---@enum Enum.EditModeAccountSetting +Enum.EditModeAccountSetting = { + ShowGrid = 0, + GridSpacing = 1, + SettingsExpanded = 2, + ShowTargetAndFocus = 3, + ShowStanceBar = 4, + ShowPetActionBar = 5, + ShowPossessActionBar = 6, + ShowCastBar = 7, + ShowEncounterBar = 8, + ShowExtraAbilities = 9, + ShowBuffsAndDebuffs = 10, + DeprecatedShowDebuffFrame = 11, + ShowPartyFrames = 12, + ShowRaidFrames = 13, + ShowTalkingHeadFrame = 14, + ShowVehicleLeaveButton = 15, + ShowBossFrames = 16, + ShowArenaFrames = 17, + ShowLootFrame = 18, + ShowHudTooltip = 19, + ShowStatusTrackingBar2 = 20, + ShowDurabilityFrame = 21, + EnableSnap = 22, + EnableAdvancedOptions = 23, + ShowPetFrame = 24, + ShowTimerBars = 25, + ShowVehicleSeatIndicator = 26, + ShowArchaeologyBar = 27, + ShowCooldownViewer = 28, + ShowPersonalResourceDisplay = 29, + ShowEncounterEvents = 30, + ShowDamageMeter = 31, + ShowExternalDefensives = 32, + ShowTotemActionBar = 33, +} + +---@enum Enum.EditModeActionBarSetting +Enum.EditModeActionBarSetting = { + Orientation = 0, + NumRows = 1, + NumIcons = 2, + IconSize = 3, + IconPadding = 4, + VisibleSetting = 5, + HideBarArt = 6, + DeprecatedSnapToSide = 7, + HideBarScrolling = 8, + AlwaysShowButtons = 9, +} + +---@enum Enum.EditModeActionBarSystemIndices +Enum.EditModeActionBarSystemIndices = { + MainBar = 1, + Bar2 = 2, + Bar3 = 3, + RightBar1 = 4, + RightBar2 = 5, + ExtraBar1 = 6, + ExtraBar2 = 7, + ExtraBar3 = 8, + StanceBar = 11, + PetActionBar = 12, + PossessActionBar = 13, +} + +---@enum Enum.EditModeArchaeologyBarSetting +Enum.EditModeArchaeologyBarSetting = { + Size = 0, +} + +---@enum Enum.EditModeAuraFrameSetting +Enum.EditModeAuraFrameSetting = { + Orientation = 0, + IconWrap = 1, + IconDirection = 2, + IconLimitBuffFrame = 3, + IconLimitDebuffFrame = 4, + IconSize = 5, + IconPadding = 6, + DeprecatedShowFull = 7, + VisibleSetting = 8, + Opacity = 9, + ShowDispelType = 10, +} + +---@enum Enum.EditModeAuraFrameSystemIndices +Enum.EditModeAuraFrameSystemIndices = { + BuffFrame = 1, + DebuffFrame = 2, + ExternalDefensivesFrame = 3, +} + +---@enum Enum.EditModeBagsSetting +Enum.EditModeBagsSetting = { + Orientation = 0, + Direction = 1, + Size = 2, + BagSlotPadding = 3, +} + +---@enum Enum.EditModeCastBarSetting +Enum.EditModeCastBarSetting = { + BarSize = 0, + LockToPlayerFrame = 1, + ShowCastTime = 2, +} + +---@enum Enum.EditModeChatFrameDisplayOnlySetting +Enum.EditModeChatFrameDisplayOnlySetting = { + Width = 4, + Height = 5, +} + +---@enum Enum.EditModeChatFrameSetting +Enum.EditModeChatFrameSetting = { + WidthHundreds = 0, + WidthTensAndOnes = 1, + HeightHundreds = 2, + HeightTensAndOnes = 3, +} + +---@enum Enum.EditModeCooldownViewerSetting +Enum.EditModeCooldownViewerSetting = { + Orientation = 0, + IconLimit = 1, + IconDirection = 2, + IconSize = 3, + IconPadding = 4, + Opacity = 5, + VisibleSetting = 6, + BarContent = 7, + HideWhenInactive = 8, + ShowTimer = 9, + ShowTooltips = 10, + BarWidthScale = 11, +} + +---@enum Enum.EditModeCooldownViewerSystemIndices +Enum.EditModeCooldownViewerSystemIndices = { + Essential = 1, + Utility = 2, + BuffIcon = 3, + BuffBar = 4, +} + +---@enum Enum.EditModeDamageMeterSetting +Enum.EditModeDamageMeterSetting = { + Visibility = 0, + Style = 1, + Numbers = 2, + FrameWidth = 3, + FrameHeight = 4, + Padding = 5, + Transparency = 6, + ObsoleteReuse1 = 7, + ShowSpecIcon = 8, + ShowClassColor = 9, + BarHeight = 10, + TextSize = 11, + BackgroundTransparency = 12, +} + +---@enum Enum.EditModeDurabilityFrameSetting +Enum.EditModeDurabilityFrameSetting = { + Size = 0, +} + +---@enum Enum.EditModeEncounterEventsSetting +Enum.EditModeEncounterEventsSetting = { + Orientation = 0, + IconDirection = 1, + ShowSpellName = 2, + IconSize = 3, + OverallSize = 4, + BackgroundTransparency = 5, + Transparency = 6, + Visibility = 7, + TooltipAnchor = 8, + ShowTimer = 9, + ViewType = 10, + FlipHorizontally = 11, + BarWidth = 12, + Padding = 13, +} + +---@enum Enum.EditModeEncounterEventsSystemIndices +Enum.EditModeEncounterEventsSystemIndices = { + Timeline = 1, + CriticalWarnings = 2, + MediumWarnings = 3, + NormalWarnings = 4, +} + +---@enum Enum.EditModeLayoutType +Enum.EditModeLayoutType = { + Preset = 0, + Account = 1, + Character = 2, + Override = 3, +} + +---@enum Enum.EditModeMicroMenuSetting +Enum.EditModeMicroMenuSetting = { + Orientation = 0, + Order = 1, + Size = 2, + EyeSize = 3, +} + +---@enum Enum.EditModeMinimapSetting +Enum.EditModeMinimapSetting = { + HeaderUnderneath = 0, + RotateMinimap = 1, + Size = 2, +} + +---@enum Enum.EditModeObjectiveTrackerSetting +Enum.EditModeObjectiveTrackerSetting = { + Height = 0, + Opacity = 1, + TextSize = 2, +} + +---@enum Enum.EditModePersonalResourceDisplaySetting +Enum.EditModePersonalResourceDisplaySetting = { + HideHealthAndPower = 0, + OnlyShowInCombat = 1, +} + +---@enum Enum.EditModePresetLayouts +Enum.EditModePresetLayouts = { + Modern = 0, + Classic = 1, +} + +---@enum Enum.EditModeSettingDisplayType +Enum.EditModeSettingDisplayType = { + Dropdown = 0, + Checkbox = 1, + Slider = 2, +} + +---@enum Enum.EditModeStatusTrackingBarSetting +Enum.EditModeStatusTrackingBarSetting = { + Height = 0, + Width = 1, + TextSize = 2, + Size = 3, +} + +---@enum Enum.EditModeStatusTrackingBarSystemIndices +Enum.EditModeStatusTrackingBarSystemIndices = { + StatusTrackingBar1 = 1, + StatusTrackingBar2 = 2, +} + +---@enum Enum.EditModeSystem +Enum.EditModeSystem = { + ActionBar = 0, + CastBar = 1, + Minimap = 2, + UnitFrame = 3, + EncounterBar = 4, + ExtraAbilities = 5, + AuraFrame = 6, + TalkingHeadFrame = 7, + ChatFrame = 8, + VehicleLeaveButton = 9, + LootFrame = 10, + HudTooltip = 11, + ObjectiveTracker = 12, + MicroMenu = 13, + Bags = 14, + StatusTrackingBar = 15, + DurabilityFrame = 16, + TimerBars = 17, + VehicleSeatIndicator = 18, + ArchaeologyBar = 19, + CooldownViewer = 20, + PersonalResourceDisplay = 21, + EncounterEvents = 22, + DamageMeter = 23, + TotemActionBar = 24, +} + +---@enum Enum.EditModeTimerBarsSetting +Enum.EditModeTimerBarsSetting = { + Size = 0, +} + +---@enum Enum.EditModeUnitFrameSetting +Enum.EditModeUnitFrameSetting = { + HidePortrait = 0, + CastBarUnderneath = 1, + BuffsOnTop = 2, + UseLargerFrame = 3, + UseRaidStylePartyFrames = 4, + ShowPartyFrameBackground = 5, + UseHorizontalGroups = 6, + CastBarOnSide = 7, + ShowCastTime = 8, + ViewRaidSize = 9, + FrameWidth = 10, + FrameHeight = 11, + DisplayBorder = 12, + RaidGroupDisplayType = 13, + SortPlayersBy = 14, + RowSize = 15, + FrameSize = 16, + ViewArenaSize = 17, + AuraOrganizationType = 18, + IconSize = 19, + Opacity = 20, + BigDefensiveIconSize = 21, +} + +---@enum Enum.EditModeUnitFrameSystemIndices +Enum.EditModeUnitFrameSystemIndices = { + Player = 1, + Target = 2, + Focus = 3, + Party = 4, + Raid = 5, + Boss = 6, + Arena = 7, + Pet = 8, +} + +---@enum Enum.EditModeVehicleSeatIndicatorSetting +Enum.EditModeVehicleSeatIndicatorSetting = { + Size = 0, +} + +---@enum Enum.EncounterEventCastState +Enum.EncounterEventCastState = { + Casting = 1, + NotCasting = 2, + Expired = 3, +} + +---@enum Enum.EncounterEventFlags +Enum.EncounterEventFlags = { + Disabled = 1, + IgnoreCastConsume = 2, +} + +---@enum Enum.EncounterEventIconmask +Enum.EncounterEventIconmask = { + DeadlyEffect = 0x1, + EnrageEffect = 0x2, + BleedEffect = 0x4, + MagicEffect = 0x8, + DiseaseEffect = 0x10, + CurseEffect = 0x20, + PoisonEffect = 0x40, + TankRole = 0x80, + HealerRole = 0x100, + DpsRole = 0x200, +} + +---@enum Enum.EncounterEventSeverity +Enum.EncounterEventSeverity = { + Low = 0, + Medium = 1, + High = 2, +} + +---@enum Enum.EncounterEventSoundTrigger +Enum.EncounterEventSoundTrigger = { + OnTextWarningShown = 0, + OnTimelineEventFinished = 1, + OnTimelineEventHighlight = 2, +} + +---@enum Enum.EncounterEventsIconDirection +Enum.EncounterEventsIconDirection = { + Left = 0, + Top = 0, + Bottom = 1, + Right = 1, +} + +---@enum Enum.EncounterEventsOrientation +Enum.EncounterEventsOrientation = { + Horizontal = 0, + Vertical = 1, +} + +---@enum Enum.EncounterEventsTooltipAnchor +Enum.EncounterEventsTooltipAnchor = { + Hidden = 0, + Default = 1, + Cursor = 2, +} + +---@enum Enum.EncounterEventsViewType +Enum.EncounterEventsViewType = { + Timeline = 0, + Bars = 1, +} + +---@enum Enum.EncounterEventsVisibility +Enum.EncounterEventsVisibility = { + Always = 0, + InEncounter = 1, + DeprecatedHidden = 2, +} + +---@enum Enum.EncounterLootDropRollState +Enum.EncounterLootDropRollState = { + NeedMainSpec = 0, + NeedOffSpec = 1, + Transmog = 2, + Greed = 3, + NoRoll = 4, + Pass = 5, +} + +---@enum Enum.EncounterTimelineEventSortDirection +Enum.EncounterTimelineEventSortDirection = { + Descending = 0, + Ascending = 1, +} + +---@enum Enum.EncounterTimelineEventSource +Enum.EncounterTimelineEventSource = { + Encounter = 0, + Script = 1, + EditMode = 2, +} + +---@enum Enum.EncounterTimelineEventState +Enum.EncounterTimelineEventState = { + Active = 0, + Paused = 1, + Finished = 2, + Canceled = 3, +} + +---@enum Enum.EncounterTimelineIconSet +Enum.EncounterTimelineIconSet = { + TankAlert = 1, + HealerAlert = 2, + DamageAlert = 3, + Deadly = 4, + Dispel = 5, + Enrage = 6, +} + +---@enum Enum.EncounterTimelineTrack +Enum.EncounterTimelineTrack = { + Queued = 0, + Short = 1, + Medium = 2, + Long = 3, + Indeterminate = 4, +} + +---@enum Enum.EncounterTimelineTrackType +Enum.EncounterTimelineTrackType = { + Hidden = 0, + Sorted = 1, + Linear = 2, +} + +---@enum Enum.EncounterTimelineViewType +Enum.EncounterTimelineViewType = { + None = 0, + Timeline = 1, + Bars = 2, +} + +---@enum Enum.EndOfMatchType +Enum.EndOfMatchType = { + None = 0, + Plunderstorm = 1, +} + +---@enum Enum.EnvironmentalDamageFlags +Enum.EnvironmentalDamageFlags = { + OneTime = 1, + DmgIsPct = 2, +} + +---@enum Enum.Environmentaldamagetype +Enum.Environmentaldamagetype = { + Fatigue = 0, + Drowning = 1, + Falling = 2, + Lava = 3, + Slime = 4, + Fire = 5, +} + +---@enum Enum.ErrorDomain +Enum.ErrorDomain = { + Assert = 0, + AssertData = 1, + Frame = 2, +} + +---@enum Enum.EventRealmQueues +Enum.EventRealmQueues = { + None = 0x0, + PlunderstormSolo = 0x1, + PlunderstormDuo = 0x2, + PlunderstormTrio = 0x4, + PlunderstormTraining = 0x8, +} + +---@enum Enum.EventToastDisplayType +Enum.EventToastDisplayType = { + NormalSingleLine = 0, + NormalBlockText = 1, + NormalTitleAndSubTitle = 2, + NormalTextWithIcon = 3, + LargeTextWithIcon = 4, + NormalTextWithIconAndRarity = 5, + Scenario = 6, + ChallengeMode = 7, + ScenarioClickExpand = 8, + WeeklyRewardUnlock = 9, + WeeklyRewardUpgrade = 10, + FlightpointDiscovered = 11, + CapstoneUnlocked = 12, + SingleLineWithIcon = 13, + Scoreboard = 14, + HouseUpgradeAvailable = 15, +} + +---@enum Enum.EventToastEventType +Enum.EventToastEventType = { + LevelUp = 0, + LevelUpSpell = 1, + LevelUpDungeon = 2, + LevelUpRaid = 3, + LevelUpPvP = 4, + PetBattleNewAbility = 5, + PetBattleFinalRound = 6, + PetBattleCapture = 7, + BattlePetLevelChanged = 8, + BattlePetLevelUpAbility = 9, + QuestBossEmote = 10, + MythicPlusWeeklyRecord = 11, + QuestTurnedIn = 12, + WorldStateChange = 13, + Scenario = 14, + LevelUpOther = 15, + PlayerAuraAdded = 16, + PlayerAuraRemoved = 17, + SpellScript = 18, + CriteriaUpdated = 19, + PvPTierUpdate = 20, + SpellLearned = 21, + TreasureItem = 22, + WeeklyRewardUnlock = 23, + WeeklyRewardUpgrade = 24, + FlightpointDiscovered = 25, + HouseUpgradeAvailable = 26, +} + +---@enum Enum.EventToastFlags +Enum.EventToastFlags = { + DisableRightClickDismiss = 1, +} + +---@enum Enum.ExcludedCensorSources +Enum.ExcludedCensorSources = { + None = 0x0, + Friends = 0x1, + Guild = 0x2, + Reserve1 = 0x4, + Reserve2 = 0x8, + Reserve3 = 0x10, + Reserve4 = 0x20, + Reserve5 = 0x40, + Reserve6 = 0x80, + All = 0xFF, +} + +---@enum Enum.ExpansionLevel +Enum.ExpansionLevel = { + None = 0, + BurningCrusade = 1, + Northrend = 2, + Cataclysm = 3, + MistsOfPandaria = 4, + Draenor = 5, + Legion = 6, + BattleForAzeroth = 7, + Shadowlands = 8, + Dragonflight = 9, + WarWithin = 10, + Midnight = 11, + LastTitan = 12, +} + +---@enum Enum.FlightPathFaction +Enum.FlightPathFaction = { + Neutral = 0, + Horde = 1, + Alliance = 2, +} + +---@enum Enum.FlightPathState +Enum.FlightPathState = { + Current = 0, + Reachable = 1, + Unreachable = 2, +} + +---@enum Enum.FollowerAbilityCastResult +Enum.FollowerAbilityCastResult = { + Success = 0, + Failure = 1, + NoPendingCast = 2, + InvalidTarget = 3, + InvalidFollowerSpell = 4, + RerollNotAllowed = 5, + SingleMissionDuration = 6, + MustTargetFollower = 7, + MustTargetTrait = 8, + InvalidFollowerType = 9, + MustBeUnique = 10, + CannotTargetLimitedUseFollower = 11, + MustTargetLimitedUseFollower = 12, + AlreadyAtMaxDurability = 13, + CannotTargetNonAutoMissionFollower = 14, +} + +---@enum Enum.FontStringScaleAnimationMode +Enum.FontStringScaleAnimationMode = { + FontSize = 0, + Vertex = 1, +} + +---@enum Enum.FragmentID +Enum.FragmentID = { + MirrorState = 0, + EntityPosition = 1, + CgObject = 2, + JamDispatcher = 3, + HeartbeatData = 4, + FTransportLink = 5, + ClientObservablesData = 6, + TimerQueues = 7, + TransferSuspensionData = 8, + DeferredMessages = 9, + FPersistableJamServers = 10, + FPlayerJamServers = 11, + FLootObjectList = 12, + FPlayerOwnershipLink = 13, + FUnitAreaTriggerLink = 14, + Actor = 15, + FPhaseShiftData = 16, + FVendor = 17, + MirroredObjectC = 18, + FMeshObjectData = 19, + FHousingDecor = 20, + FHousingRoom = 21, + FHousingRoomComponentMesh = 22, + FHousingPlayerHouse = 23, + FHousingHouseDecorSet = 24, + FHousingHouseRoomSet = 25, + FHousingDecorProxy = 26, + FJamHousingCornerstone = 27, + FHousingDecorActor = 28, + FHousingPlotAreaTrigger = 29, + FNeighborhoodMirrorData = 30, + FMirroredPositionData = 31, + FPlayerHouseInfo = 32, + FHousingStorageMirrorData = 33, + FHousingFixture = 34, + FHousingHouseFixtureSet = 35, + Timer = 36, + FPlayerInitiativeInfo = 37, + FNeighborhoodStateData = 38, + FUnitAIGroupLink = 39, + FPathingDynamicLinks = 40, + TagItem = 200, + TagContainer = 201, + TagAzeriteEmpoweredItem = 202, + TagAzeriteItem = 203, + TagUnit = 204, + TagPlayer = 205, + TagGameObject = 206, + TagDynamicObject = 207, + TagCorpse = 208, + TagAreaTrigger = 209, + TagSceneObject = 210, + TagConversation = 211, + TagAIGroup = 212, + TagScenario = 213, + TagLootObject = 214, + TagActivePlayer = 215, + TagActiveClientS = 216, + TagActiveObjectC = 217, + TagVisibleObjectC = 218, + TagUnitVehicle = 219, + TagHousingRoom = 220, + TagMeshObject = 221, + TagHousingSubdivisionObject = 222, + TagHousingPoolObject = 223, + TagHouseExteriorPiece = 224, + TagHouseExteriorRoot = 225, + TagHousingDecorProxyGameObject = 226, + TestFragment_1 = 250, + TestFragment_2 = 251, + TestFragment_3 = 252, + TestFragment_4 = 253, + TestFragment_5 = 254, + ReservedArchetypeSeparator = 255, +} + +---@enum Enum.FrameTutorialAccount +Enum.FrameTutorialAccount = { + HudRevampBagChanges = 1, + PerksProgramActivitiesIntro = 2, + EditModeManager = 3, + TransmogSetsTab = 4, + MountCollectionDragonriding = 5, + LFGList = 6, + HeirloomJournalLevel = 7, + TimerunnersAdvantage = 8, + AccountWideReputation = 9, + TransferableCurrencies = 10, + BindToAccountUntilEquip = 11, + CompletedQuestsFilter = 12, + CompletedQuestsFilterSeen = 13, + ConcentrationCurrency = 14, + MapLegendOpened = 15, + NpcCraftingOrders = 16, + NpcCraftingOrderCreateButton = 17, + NpcCraftingOrderTabNew = 18, + LocalStoriesFilterSeen = 19, + EventSchedulerTabSeen = 20, + AssistedCombatRotationDragSpell = 21, + AssistedCombatRotationActionButton = 22, + HousingDecorCleanup = 23, + HousingDecorPlace = 24, + HousingDecorClippingGrid = 25, + HousingDecorCustomization = 26, + HousingDecorLayout = 27, + HousingHouseFinderMap = 28, + HousingHouseFinderVisitHouse = 29, + HousingItemAcquisition = 30, + HousingNewPip = 31, + PerksProgramActivitiesOpen = 32, + EnconterJournalTutorialsTabSeen = 33, + HousingMarketTab = 34, + HousingTeleportButton = 35, + RPETalentStarterBuild = 36, + HousingInvalidCollision = 37, + HousingModesUnlocked = 38, + HousingExpertMode = 39, + HousingCleanupMode = 40, + TransmogOutfits = 41, + TransmogSets = 42, + TransmogCustomSets = 43, + TransmogSituations = 44, + TransmogWeaponOptions = 45, + TransmogTrialOfStyle = 46, + TransmogCustomSetsMigration = 47, + HousingEndeavorsTabSeen = 48, +} + +---@enum Enum.GameMode +Enum.GameMode = { + Standard = 1, + Plunderstorm = 2, + WoWHack = 3, +} + +---@enum Enum.GamePadPowerLevel +Enum.GamePadPowerLevel = { + Critical = 0, + Low = 1, + Medium = 2, + High = 3, + Wired = 4, + Unknown = 5, +} + +---@enum Enum.GameRule +Enum.GameRule = { + NoDebuffLimit = 1, + CharNameReservationEnabled = 2, + MaxCharReservationsPerRealm = 3, + MaxAccountCharReservationsPerContentset = 4, + EtaRealmLaunchTime = 5, + TrivialGroupXPPercent = 7, + CharReservationsPerRealmReopenThreshold = 8, + DisablePct = 9, + HardcoreRuleset = 10, + ReplaceAbsentGmSeconds = 11, + ReplaceGmRankLastOnlineSeconds = 12, + GameMode = 13, + CharacterlessLogin = 14, + VanillaNpcKnockback = 16, + Runecarving = 17, + TalentRespecCostMin = 18, + TalentRespecCostMax = 19, + TalentRespecCostStep = 20, + VanillaRageGenerationModifier = 21, + SelfFoundAllowed = 22, + DisableHonorDecay = 23, + MaxLootDropLevel = 25, + MicrobarScale = 26, + MaxUnitNameDistance = 27, + MaxNameplateDistance = 28, + UserAddonsDisabled = 29, + UserScriptsDisabled = 30, + NonPlayerNameplateScale = 31, + ForcedPartyFrameScale = 32, + CustomActionbarOverlayHeightOffset = 33, + ForcedChatLanguage = 34, + LandingPageFactionID = 35, + CollectionsPanelDisabled = 36, + CharacterPanelDisabled = 37, + SpellbookPanelDisabled = 38, + TalentsPanelDisabled = 39, + AchievementsPanelDisabled = 40, + CommunitiesPanelDisabled = 41, + EncounterJournalDisabled = 42, + FinderPanelDisabled = 43, + StoreDisabled = 44, + HelpPanelDisabled = 45, + GuildsDisabled = 46, + QuestLogMicrobuttonDisabled = 47, + MapPlunderstormCircle = 48, + AfterDeathSpectatingUI = 49, + FrontEndChat = 50, + UniversalNameplateOcclusion = 51, + FastAreaTriggerTick = 52, + AllPlayersAreFastMovers = 53, + IgnoreChrclassDisabledFlag = 54, + CharacterCreateUseFixedBackgroundModel = 55, + ForceAlteredFormsOn = 56, + PlayerNameplateDifficultyIcon = 57, + PlayerNameplateAlternateHealthColor = 58, + AlwaysAllowAlliedRaces = 59, + ActionbarIconIntroDisabled = 60, + ReleaseSpiritGhostDisabled = 61, + DeleteItemConfirmationDisabled = 62, + ChatLinkLevelToastsDisabled = 63, + BagsUIDisabled = 64, + PetBattlesDisabled = 65, + PerksProgramActivityTrackingDisabled = 66, + MaximizeWorldMapDisabled = 67, + WorldMapTrackingOptionsDisabled = 68, + WorldMapTrackingPinDisabled = 69, + WorldMapHelpPlateDisabled = 70, + QuestLogPanelDisabled = 71, + QuestLogSuperTrackingDisabled = 72, + TutorialFrameDisabled = 73, + IngameMailNotificationDisabled = 74, + IngameCalendarDisabled = 75, + IngameTrackingDisabled = 76, + IngameWhoListDisabled = 77, + RaceAlteredFormsDisabled = 78, + IngameFriendsListDisabled = 79, + MacrosDisabled = 80, + CompactRaidFrameManagerDisabled = 81, + EditModeDisabled = 82, + InstanceDifficultyBannerDisabled = 83, + FullCharacterCreateDisabled = 84, + TargetFrameBuffsDisabled = 85, + UnitFramePvPContextualDisabled = 86, + ActionCombatTargetLockEnabled = 87, + BlockWhileSheathedAllowed = 88, + VanillaAccountMailInstant = 91, + ClearMailOnRealmTransfer = 92, + PremadeGroupFinderStyle = 93, + PlunderstormAreaSelection = 94, + GroupFinderCapabilities = 98, + WorldMapLegendDisabled = 99, + WorldMapFrameStrata = 100, + MerchantFilterDisabled = 101, + HousingDashboardDisabled = 102, + AutoAttacksDisabled = 103, + ObjectiveTrackerDisabled = 104, + PlayerCastBarDisabled = 105, + TargetCastBarDisabled = 106, + NameplateCastBarDisabled = 107, + SummoningStones = 108, + TransmogEnabled = 109, + DisableRealmSelection = 113, + DisableCampsites = 114, + UseSimpleCharacterSelectList = 115, + HideFaction = 116, + DisableVas = 119, + PersonalResourceDisplayDisabled = 129, + TargetFrameDisabled = 130, + PlayerFrameDisabled = 131, + MailGameRule = 132, + ForcedMultiActionBarSetting = 133, + HideAllMultiActionBars = 135, + TimerunningAllowed = 137, + MaxCharactersPerContentSet = 139, + MinUndeleteLevelRequired = 140, + DoesNotCountTowardAccountCharacterMax = 142, + WorldMapDisabled = 145, + MinimapDisabled = 146, + RepairArmorDisabled = 147, + EjSuggestedContentDisabled = 148, + EjDungeonsDisabled = 149, + EjRaidsDisabled = 150, + EjItemSetsDisabled = 151, + GdapiCharacterProfileDisabled = 153, + HousingEnabled = 154, + RestrictedAchievementCategoryID = 155, + EjJourneysDisabled = 156, + LootMethodStyle = 157, + ExperienceBarDisabled = 159, + HideUnavailableTransmogSlots = 160, + HideTransmogZeroCost = 161, + DisableQuickJoin = 162, + DisableRaidGroups = 163, + UseGameTableVariation = 164, + ActionButtonTypeOverlayStrategy = 165, + RecommendLeastPopulatedRealm = 169, + BagSpaceOverride = 172, + UnflaggedPlayersCanAttackPvPFlaggedPlayers = 173, + PvPInitialRatingOverride = 190, +} + +---@enum Enum.GameRuleFlags +Enum.GameRuleFlags = { + None = 0, + AllowClient = 1, + RequiresDefault = 2, +} + +---@enum Enum.GameRuleType +Enum.GameRuleType = { + Int = 0, + Float = 1, + Bool = 2, +} + +---@enum Enum.GarrAutoBoardIndex +Enum.GarrAutoBoardIndex = { + None = -1, + AllyLeftBack = 0, + AllyRightBack = 1, + AllyLeftFront = 2, + AllyCenterFront = 3, + AllyRightFront = 4, + EnemyLeftFront = 5, + EnemyCenterLeftFront = 6, + EnemyCenterRightFront = 7, + EnemyRightFront = 8, + EnemyLeftBack = 9, + EnemyCenterLeftBack = 10, + EnemyCenterRightBack = 11, + EnemyRightBack = 12, +} + +---@enum Enum.GarrAutoCombatSpellTutorialFlag +Enum.GarrAutoCombatSpellTutorialFlag = { + None = 0, + Single = 1, + Column = 2, + Row = 3, + All = 4, +} + +---@enum Enum.GarrAutoCombatTutorial +Enum.GarrAutoCombatTutorial = { + SelectMission = 0x1, + PlaceCompanion = 0x2, + HealCompanion = 0x4, + LevelHeal = 0x8, + BeneficialEffect = 0x10, + AttackSingle = 0x20, + AttackColumn = 0x40, + AttackRow = 0x80, + AttackAll = 0x100, + TroopTutorial = 0x200, + EnvironmentalEffect = 0x400, +} + +---@enum Enum.GarrAutoCombatantRole +Enum.GarrAutoCombatantRole = { + None = 0, + Melee = 1, + RangedPhysical = 2, + RangedMagic = 3, + HealSupport = 4, + Tank = 5, +} + +---@enum Enum.GarrAutoEventFlags +Enum.GarrAutoEventFlags = { + None = 0, + AutoAttack = 1, + Passive = 2, + Environment = 4, +} + +---@enum Enum.GarrAutoMissionEventType +Enum.GarrAutoMissionEventType = { + MeleeDamage = 0, + RangeDamage = 1, + SpellMeleeDamage = 2, + SpellRangeDamage = 3, + Heal = 4, + PeriodicDamage = 5, + PeriodicHeal = 6, + ApplyAura = 7, + RemoveAura = 8, + Died = 9, +} + +---@enum Enum.GarrAutoPreviewTargetType +Enum.GarrAutoPreviewTargetType = { + None = 0x0, + Damage = 0x1, + Heal = 0x2, + Buff = 0x4, + Debuff = 0x8, +} + +---@enum Enum.GarrFollowerMissionCompleteState +Enum.GarrFollowerMissionCompleteState = { + Alive = 0, + KilledByMissionFailure = 1, + SavedByPreventDeath = 2, + OutOfDurability = 3, +} + +---@enum Enum.GarrFollowerQuality +Enum.GarrFollowerQuality = { + None = 0, + Common = 1, + Uncommon = 2, + Rare = 3, + Epic = 4, + Legendary = 5, + Title = 6, +} + +---@enum Enum.GarrTalentCostType +Enum.GarrTalentCostType = { + Initial = 0, + Respec = 1, + MakePermanent = 2, + TreeReset = 3, +} + +---@enum Enum.GarrTalentFeatureSubtype +Enum.GarrTalentFeatureSubtype = { + Generic = 0, + Bastion = 1, + Revendreth = 2, + Ardenweald = 3, + Maldraxxus = 4, +} + +---@enum Enum.GarrTalentFeatureType +Enum.GarrTalentFeatureType = { + Generic = 0, + AnimaDiversion = 1, + TravelPortals = 2, + Adventures = 3, + ReservoirUpgrades = 4, + SanctumUnique = 5, + SoulBinds = 6, + AnimaDiversionMap = 7, + Cyphers = 8, +} + +---@enum Enum.GarrTalentResearchCostSource +Enum.GarrTalentResearchCostSource = { + Talent = 0, + Tree = 1, +} + +---@enum Enum.GarrTalentSocketType +Enum.GarrTalentSocketType = { + None = 0, + Spell = 1, + Conduit = 2, +} + +---@enum Enum.GarrTalentTreeType +Enum.GarrTalentTreeType = { + Tiers = 0, + Classic = 1, +} + +---@enum Enum.GarrTalentType +Enum.GarrTalentType = { + Standard = 0, + Minor = 1, + Major = 2, + Socket = 3, +} + +---@enum Enum.GarrTalentUI +Enum.GarrTalentUI = { + Generic = 0, + CovenantSanctum = 1, + SoulBinds = 2, + AnimaDiversionMap = 3, +} + +---@enum Enum.GarrisonFollowerType +Enum.GarrisonFollowerType = { + FollowerType_6_0_GarrisonFollower = 1, + FollowerType_6_0_Boat = 2, + FollowerType_7_0_GarrisonFollower = 4, + FollowerType_8_0_GarrisonFollower = 22, + FollowerType_9_0_GarrisonFollower = 123, +} + +---@enum Enum.GarrisonTalentAvailability +Enum.GarrisonTalentAvailability = { + Available = 0, + Unavailable = 1, + UnavailableAnotherIsResearching = 2, + UnavailableNotEnoughResources = 3, + UnavailableNotEnoughGold = 4, + UnavailableTierUnavailable = 5, + UnavailablePlayerCondition = 6, + UnavailableAlreadyHave = 7, + UnavailableRequiresPrerequisiteTalent = 8, +} + +---@enum Enum.GarrisonType +Enum.GarrisonType = { + Type_6_0_Garrison = 2, + Type_7_0_Garrison = 3, + Type_8_0_Garrison = 9, + Type_9_0_Garrison = 111, +} + +---@enum Enum.GossipNpcOption +Enum.GossipNpcOption = { + None = 0, + Vendor = 1, + Taxinode = 2, + Trainer = 3, + SpiritHealer = 4, + Binder = 5, + Banker = 6, + PetitionVendor = 7, + GuildTabardVendor = 8, + Battlemaster = 9, + Auctioneer = 10, + TalentMaster = 11, + Stablemaster = 12, + PetSpecializationMaster = 13, + GuildBanker = 14, + Spellclick = 15, + DisableXPGain = 16, + EnableXPGain = 17, + Mailbox = 18, + WorldPvPQueue = 19, + LFGDungeon = 20, + ArtifactRespec = 21, + CemeterySelect = 22, + SpecializationMaster = 23, + GlyphMaster = 24, + QueueScenario = 25, + GarrisonArchitect = 26, + GarrisonMissionNpc = 27, + ShipmentCrafter = 28, + GarrisonTradeskillNpc = 29, + GarrisonRecruitment = 30, + AdventureMap = 31, + GarrisonTalent = 32, + ContributionCollector = 33, + Transmogrify = 34, + AzeriteRespec = 35, + IslandsMissionNpc = 36, + UIItemInteraction = 37, + WorldMap = 38, + Soulbind = 39, + ChromieTimeNpc = 40, + CovenantPreviewNpc = 41, + RuneforgeLegendaryCrafting = 42, + NewPlayerGuide = 43, + RuneforgeLegendaryUpgrade = 44, + CovenantRenownNpc = 45, + BlackMarketAuctionHouse = 46, + PerksProgramVendor = 47, + ProfessionsCraftingOrder = 48, + ProfessionsOpen = 49, + ProfessionsCustomerOrder = 50, + TraitSystem = 51, + BarbersChoice = 52, + MajorFactionRenown = 53, + PersonalTabardVendor = 54, + ForgeMaster = 55, + CharacterBanker = 56, + AccountBanker = 57, + ProfessionRespec = 58, + RenameNeighborhood = 59, + HousingCreateGuildNeighborhood = 60, + HousingGetNeighborhoodCharter = 61, + GuildRename = 62, + HousingOpenCharterConfirmation = 63, + ItemUpgrade = 64, + HouseFinder = 65, + TieredEntrance = 66, +} + +---@enum Enum.GossipNpcOptionDisplayFlags +Enum.GossipNpcOptionDisplayFlags = { + ForceInteractionOnSingleChoice = 1, +} + +---@enum Enum.GossipOptionRecFlags +Enum.GossipOptionRecFlags = { + QuestLabelPrepend = 1, + HideOptionIDFromClient = 2, + PlayMovieLabelPrepend = 4, +} + +---@enum Enum.GossipOptionRewardType +Enum.GossipOptionRewardType = { + Item = 0, + Currency = 1, +} + +---@enum Enum.GossipOptionStatus +Enum.GossipOptionStatus = { + Available = 0, + Unavailable = 1, + Locked = 2, + AlreadyComplete = 3, +} + +---@enum Enum.GossipOptionUIWidgetSetTypes +Enum.GossipOptionUIWidgetSetTypes = { + Modifiers = 0, + Background = 1, +} + +---@enum Enum.GraphicsValidationResult +Enum.GraphicsValidationResult = { + Supported = 0, + Illegal = 1, + Unsupported = 2, + Graphics = 3, + DualCore = 4, + QuadCore = 5, + CpuMem_2 = 6, + CpuMem_4 = 7, + CpuMem_8 = 8, + Needs_5_0 = 9, + Needs_6_0 = 10, + NeedsRt = 11, + NeedsDx12 = 12, + NeedsDx12Vrs2 = 13, + NeedsAppleGpu = 14, + NeedsAmdGpu = 15, + NeedsIntelGpu = 16, + NeedsNvidiaGpu = 17, + NeedsQualcommGpu = 18, + NeedsMacOs_10_13 = 19, + NeedsMacOs_10_14 = 20, + NeedsMacOs_10_15 = 21, + NeedsMacOs_11_0 = 22, + NeedsMacOs_12_0 = 23, + NeedsMacOs_13_0 = 24, + NeedsWindows_10 = 25, + NeedsWindows_11 = 26, + MacOsUnsupported = 27, + WindowsUnsupported = 28, + LegacyUnsupported = 29, + Dx11Unsupported = 30, + Dx12Win7Unsupported = 31, + RemoteDesktopUnsupported = 32, + WineUnsupported = 33, + NvapiWineUnsupported = 34, + AppleGpuUnsupported = 35, + AmdGpuUnsupported = 36, + IntelGpuUnsupported = 37, + NvidiaGpuUnsupported = 38, + QualcommGpuUnsupported = 39, + GpuDriver = 40, + CompatMode = 41, + Unknown = 42, +} + +---@enum Enum.GuildErrorType +Enum.GuildErrorType = { + Success = 0, + UnknownError = 1, + AlreadyInGuild = 2, + TargetAlreadyInGuild = 3, + InvitedToGuild = 4, + TargetInvitedToGuild = 5, + NameInvalid = 6, + NameAlreadyExists = 7, + NoPermisson = 8, + NotInGuild = 9, + TargetNotInGuild = 10, + PlayerNotFound = 11, + WrongFaction = 12, + TargetTooHigh = 13, + TargetTooLow = 14, + TooManyRanks = 15, + TooFewRanks = 16, + RanksLocked = 17, + RankInUse = 18, + Ignored = 19, + Busy = 20, + TargetLevelTooLow = 21, + TargetLevelTooHigh = 22, + TooManyMembers = 23, + InvalidBankTab = 24, + WithdrawLimit = 25, + NotEnoughMoney = 26, + TeamNotFound = 27, + BankTabFull = 28, + BadItem = 29, + TeamsLocked = 30, + TooMuchMoney = 31, + WrongBankTab = 32, + TooManyCreate = 33, + RankRequiresAuthenticator = 34, + BankTabLocked = 35, + TrialAccount = 36, + VeteranAccount = 37, + UndeletableDueToLevel = 38, + LockedForMove = 39, + GuildRepTooLow = 40, + CantInviteSelf = 41, + HasRestriction = 42, + BankNotFound = 43, + NewLeaderWrongFaction = 44, + GuildBankNotAvailable = 45, + NewLeaderWrongRealm = 46, + DeleteNoAppropriateLeader = 47, + RealmMismatch = 48, + InCooldown = 49, + ReservationExpired = 50, + HousingEvictError = 51, + Throttled = 52, +} + +---@enum Enum.HolidayCalendarFlags +Enum.HolidayCalendarFlags = { + Alliance = 1, + Horde = 2, +} + +---@enum Enum.HolidayFlags +Enum.HolidayFlags = { + IsRegionwide = 0x1, + DontShowInCalendar = 0x2, + DontDisplayEnd = 0x4, + DontDisplayBanner = 0x8, + NotAvailableClientSide = 0x10, + DurationUseMinutes = 0x20, + BeginEventOnlyOnStageChange = 0x40, +} + +---@enum Enum.HouseEditingContext +Enum.HouseEditingContext = { + None = 0, + Decor = 1, + Room = 2, + Fixture = 3, +} + +---@enum Enum.HouseEditorMode +Enum.HouseEditorMode = { + None = 0, + BasicDecor = 1, + ExpertDecor = 2, + Layout = 3, + Customize = 4, + Cleanup = 5, + ExteriorCustomization = 6, +} + +---@enum Enum.HouseExteriorWMODataFlags +Enum.HouseExteriorWMODataFlags = { + None = 0x0, + UnlockedByDefault = 0x1, + AllowedInHordeNeighborhoods = 0x2, + AllowedInAllianceNeighborhoods = 0x4, + HiddenUnlessOwned = 0x8, +} + +---@enum Enum.HouseFinderSuggestionReason +Enum.HouseFinderSuggestionReason = { + None = 0x0, + Owner = 0x1, + CharterInvite = 0x2, + Guild = 0x4, + BNetFriends = 0x8, + PartySync = 0x10, + Random = 0x20, + HomeOwner = 0x40, +} + +---@enum Enum.HouseLevelRewardType +Enum.HouseLevelRewardType = { + Value = 0, + Object = 1, +} + +---@enum Enum.HouseLevelRewardValueType +Enum.HouseLevelRewardValueType = { + ExteriorDecor = 0, + InteriorDecor = 1, + Rooms = 2, + Fixtures = 3, +} + +---@enum Enum.HouseOwnerError +Enum.HouseOwnerError = { + None = 0, + Faction = 1, + Guild = 2, + GenericPermission = 3, +} + +---@enum Enum.HouseSettingFlags +Enum.HouseSettingFlags = { + None = 0x0, + HouseAccessAnyone = 0x1, + HouseAccessNeighbors = 0x2, + HouseAccessGuild = 0x4, + HouseAccessFriends = 0x8, + HouseAccessParty = 0x10, + PlotAccessAnyone = 0x20, + PlotAccessNeighbors = 0x40, + PlotAccessGuild = 0x80, + PlotAccessFriends = 0x100, + PlotAccessParty = 0x200, +} + +---@enum Enum.HouseVisitType +Enum.HouseVisitType = { + Unknown = 0, + Friend = 1, + Guild = 2, + Party = 3, +} + +---@enum Enum.HousingBasicModeTargetType +Enum.HousingBasicModeTargetType = { + None = 0, + Decor = 1, + House = 2, +} + +---@enum Enum.HousingCatalogEntryModelScenePresets +Enum.HousingCatalogEntryModelScenePresets = { + DecorDefault = 1317, + DecorFlat = 1318, + DecorTiny = 1333, + DecorSmall = 1334, + DecorMedium = 1335, + DecorLarge = 1336, + DecorHuge = 1337, + DecorCeiling = 1338, + DecorWall = 1339, + DecorHorizontalSurface = 1452, +} + +---@enum Enum.HousingCatalogEntrySize +Enum.HousingCatalogEntrySize = { + None = 0, + Tiny = 65, + Small = 66, + Medium = 67, + Large = 68, + Huge = 69, +} + +---@enum Enum.HousingCatalogEntryType +Enum.HousingCatalogEntryType = { + Invalid = 0, + Decor = 1, + Room = 2, +} + +---@enum Enum.HousingCatalogSortType +Enum.HousingCatalogSortType = { + DateAdded = 0, + Alphabetical = 1, +} + +---@enum Enum.HousingCleanupModeTargetType +Enum.HousingCleanupModeTargetType = { + None = 0, + Decor = 1, + HouseExterior = 2, +} + +---@enum Enum.HousingCustomizeModeTargetType +Enum.HousingCustomizeModeTargetType = { + None = 0, + Decor = 1, + RoomComponent = 2, + ExteriorHouse = 3, +} + +---@enum Enum.HousingDecorActionFlags +Enum.HousingDecorActionFlags = { + None = 0x0, + Add = 0x1, + Remove = 0x2, + DragMove = 0x4, + PrecisionMove = 0x8, + ClickTarget = 0x10, + HoverTarget = 0x20, + TargetRoomComponents = 0x40, + TargetHouseExterior = 0x80, + MaintainLastTarget = 0x100, + IncludeTargetChildren = 0x200, + UsePlacedDecorList = 0x400, + PreviewDecor = 0x800, +} + +---@enum Enum.HousingDecorModelType +Enum.HousingDecorModelType = { + None = 0, + M2 = 1, + WMO = 2, +} + +---@enum Enum.HousingDecorPlacementRestriction +Enum.HousingDecorPlacementRestriction = { + TooFarAway = 0x1, + OutsideRoomBounds = 0x2, + OutsidePlotBounds = 0x4, + ChildOutsideBounds = 0x8, + InvalidTarget = 0x10, + InvalidCollision = 0x20, + InvalidLightOverlap = 0x40, +} + +---@enum Enum.HousingDecorTheme +Enum.HousingDecorTheme = { + None = 0, + Folk = 1, + Rugged = 2, + Generic = 3, + NightElf = 4, + BloodElf = 5, +} + +---@enum Enum.HousingDecorType +Enum.HousingDecorType = { + None = 0, + Floor = 1, + Wall = 2, + Ceiling = 3, + Flooring = 4, +} + +---@enum Enum.HousingExpertModeTargetType +Enum.HousingExpertModeTargetType = { + None = 0, + Decor = 1, + House = 2, +} + +---@enum Enum.HousingExpertSubmodeRestriction +Enum.HousingExpertSubmodeRestriction = { + None = 0, + NotInExpertMode = 1, + NoHouseExteriorScale = 2, + NoWMOScale = 3, +} + +---@enum Enum.HousingFavorUpdateSource +Enum.HousingFavorUpdateSource = { + Unknown = 0, + DecorCollection = 1, + DeferredRewards = 2, + RetroactiveDecor = 3, + NewHouseDecorFavor = 4, + InitiativeTask = 5, + InitiativeChest = 6, + Quest = 7, +} + +---@enum Enum.HousingFavorUpdateType +Enum.HousingFavorUpdateType = { + Add = 0, + InitiativeAdd = 1, + Set = 2, +} + +---@enum Enum.HousingFixtureDecorAction +Enum.HousingFixtureDecorAction = { + Store = 0, + Detach = 1, +} + +---@enum Enum.HousingFixtureFlags +Enum.HousingFixtureFlags = { + None = 0, + IsDefaultFixture = 1, + UnlockedByDefault = 2, +} + +---@enum Enum.HousingFixtureSize +Enum.HousingFixtureSize = { + None = 0, + Any = 1, + Small = 2, + Medium = 3, + Large = 4, +} + +---@enum Enum.HousingFixtureType +Enum.HousingFixtureType = { + None = 0, + Base = 9, + Roof = 10, + Door = 11, + Window = 12, + RoofDetail = 13, + RoofWindow = 14, + Tower = 15, + Chimney = 16, +} + +---@enum Enum.HousingIncrementType +Enum.HousingIncrementType = { + Left = 0x1, + Right = 0x2, + Forward = 0x4, + Back = 0x8, + Up = 0x10, + Down = 0x20, + RotateLeft = 0x40, + RotateRight = 0x80, + ScaleUp = 0x100, + ScaleDown = 0x200, +} + +---@enum Enum.HousingItemToastType +Enum.HousingItemToastType = { + Room = 0, + Fixture = 1, + Customization = 2, + Decor = 3, + HouseType = 4, +} + +---@enum Enum.HousingLayoutCameraDirection +Enum.HousingLayoutCameraDirection = { + None = 0x0, + Up = 0x1, + Down = 0x2, + Left = 0x4, + Right = 0x8, +} + +---@enum Enum.HousingLayoutPinType +Enum.HousingLayoutPinType = { + Door = 0, + Room = 1, +} + +---@enum Enum.HousingLayoutRestriction +Enum.HousingLayoutRestriction = { + None = 0, + RoomNotFound = 1, + NotInsideHouse = 2, + NotHouseOwner = 3, + IsBaseRoom = 4, + RoomNotLeaf = 5, + StairwellConnection = 6, + LastRoom = 7, + UnreachableRoom = 8, + SingleDoor = 9, +} + +---@enum Enum.HousingLayoutStairDirection +Enum.HousingLayoutStairDirection = { + Up = 0, + Down = 1, +} + +---@enum Enum.HousingPlotOwnerType +Enum.HousingPlotOwnerType = { + None = 0, + Stranger = 1, + Friend = 2, + Self = 3, +} + +---@enum Enum.HousingPrecisionSubmode +Enum.HousingPrecisionSubmode = { + Translate = 0, + Rotate = 1, + Scale = 2, +} + +---@enum Enum.HousingResult +Enum.HousingResult = { + Success = 0, + ActionLockedByCombat = 1, + BoundsFailureChildren = 2, + BoundsFailurePlot = 3, + BoundsFailureRoom = 4, + BoundToStartingArea = 5, + CannotAfford = 6, + CharterComplete = 7, + CollisionInvalid = 8, + DbError = 9, + DecorCannotBeRedeemed = 10, + DecorItemNotDestroyable = 11, + DecorNotFound = 12, + DecorNotFoundInStorage = 13, + DuplicateCharterSignature = 14, + FilterRejected = 15, + FixtureCantDeleteDoor = 16, + FixtureHookEmpty = 17, + FixtureHookOccupied = 18, + FixtureHouseTypeMismatch = 19, + FixtureNotFound = 20, + FixtureSizeMismatch = 21, + FixtureTypeMismatch = 22, + GenericFailure = 23, + GuildMoreAccountsNeeded = 24, + GuildMoreActivePlayersNeeded = 25, + GuildNotLoaded = 26, + HouseEditLockFailed = 27, + HouseExteriorAlreadyThatSize = 28, + HouseExteriorAlreadyThatType = 29, + HouseExteriorRootNotFound = 30, + HouseExteriorTypeNeighborhoodMismatch = 31, + HouseExteriorTypeNotFound = 32, + HouseExteriorTypeSizeMismatch = 33, + HouseExteriorSizeNotAvailable = 34, + HookNotChildOfFixture = 35, + HouseNotFound = 36, + IncorrectFaction = 37, + InvalidDecorItem = 38, + InvalidDistance = 39, + InvalidGuild = 40, + InvalidHouse = 41, + InvalidInstance = 42, + InvalidInteraction = 43, + InvalidLightOverlap = 44, + InvalidMap = 45, + InvalidNeighborhoodName = 46, + InvalidRoomLayout = 47, + LockedByOtherPlayer = 48, + LockOperationFailed = 49, + MaxDecorReached = 50, + MaxPreviewDecorReached = 51, + MissingCoreFixture = 52, + MissingDye = 53, + MissingExpansionAccess = 54, + MissingFactionMap = 55, + MissingPrivateNeighborhoodInvite = 56, + MoreHouseSlotsNeeded = 57, + MoreSignaturesNeeded = 58, + NeighborhoodNotFound = 59, + NoNeighborhoodOwnershipRequests = 60, + NotInDecorEditMode = 61, + NotInFixtureEditMode = 62, + NotInLayoutEditMode = 63, + NotInsideHouse = 64, + NotOnOwnedPlot = 65, + OperationAborted = 66, + OwnerNotInGuild = 67, + PermissionDenied = 68, + PlacementTargetInvalid = 69, + PlayerNotFound = 70, + PlayerNotInInstance = 71, + PlotNotFound = 72, + PlotNotVacant = 73, + PlotReservationCooldown = 74, + PlotReserved = 75, + RoomNotFound = 76, + RoomUpdateFailed = 77, + RpcFailure = 78, + ServiceNotAvailable = 79, + StaticDataNotFound = 80, + TimeoutLimit = 81, + TimerunningNotAllowed = 82, + TokenRequired = 83, + TooManyRequests = 84, + TransactionFailure = 85, + UncollectedExteriorFixture = 86, + UncollectedHouseType = 87, + UncollectedRoom = 88, + UncollectedRoomMaterial = 89, + UncollectedRoomTheme = 90, + UnlockOperationFailed = 91, +} + +---@enum Enum.HousingRoomComponentCeilingType +Enum.HousingRoomComponentCeilingType = { + Flat = 0, + Vaulted = 1, +} + +---@enum Enum.HousingRoomComponentDoorType +Enum.HousingRoomComponentDoorType = { + None = 0, + Doorway = 1, + Threshold = 2, +} + +---@enum Enum.HousingRoomComponentFlags +Enum.HousingRoomComponentFlags = { + None = 0, + HiddenInLayoutMode = 1, +} + +---@enum Enum.HousingRoomComponentFloorType +Enum.HousingRoomComponentFloorType = { + Floor = 0, +} + +---@enum Enum.HousingRoomComponentOptionFlags +Enum.HousingRoomComponentOptionFlags = { + None = 0, + IsDefault = 1, +} + +---@enum Enum.HousingRoomComponentOptionType +Enum.HousingRoomComponentOptionType = { + Cosmetic = 0, + DoorwayWall = 1, + Doorway = 2, +} + +---@enum Enum.HousingRoomComponentStairType +Enum.HousingRoomComponentStairType = { + None = 0, + StartToEnd = 1, + StartToMiddle = 2, + MiddleToMiddle = 3, + MiddleToEnd = 4, +} + +---@enum Enum.HousingRoomComponentTextureFlags +Enum.HousingRoomComponentTextureFlags = { + None = 0, + UnlockedByDefault = 1, +} + +---@enum Enum.HousingRoomComponentType +Enum.HousingRoomComponentType = { + None = 0, + Wall = 1, + Floor = 2, + Ceiling = 3, + Stairs = 4, + Pillar = 5, + DoorwayWall = 6, + Doorway = 7, +} + +---@enum Enum.HousingRoomFlags +Enum.HousingRoomFlags = { + None = 0x0, + BaseRoom = 0x1, + HasStairs = 0x2, + UnlockedByDefault = 0x4, + HasCustomGeometry = 0x8, +} + +---@enum Enum.HousingTeleportReason +Enum.HousingTeleportReason = { + None = 0, + Cheat = 1, + UnspecifiedSpellcast = 2, + Booted = 3, + Homestone = 4, + Visit = 5, + Friend = 6, + GuildMember = 7, + PartyMember = 8, + ExitingHouse = 9, + Portal = 10, + Tutorial = 11, +} + +---@enum Enum.HousingThemeFlags +Enum.HousingThemeFlags = { + None = 0, + UnlockedByDefault = 1, + ShowInStyleSelector = 2, +} + +---@enum Enum.HousingThrottleType +Enum.HousingThrottleType = { + General = 0, + Decoration = 1, +} + +---@enum Enum.IconAndTextShiftTextType +Enum.IconAndTextShiftTextType = { + None = 0, + ShiftText = 1, +} + +---@enum Enum.IconAndTextWidgetState +Enum.IconAndTextWidgetState = { + Hidden = 0, + Shown = 1, + ShownWithDynamicIconFlashing = 2, + ShownWithDynamicIconNotFlashing = 3, +} + +---@enum Enum.IconState +Enum.IconState = { + Hidden = 0, + ShowState1 = 1, + ShowState2 = 2, +} + +---@enum Enum.ImageSharingResult +Enum.ImageSharingResult = { + Failure = 0, + Success = 1, + NotConfigured = 2, + RetrievedExisting = 3, + PlatformApiError = 4, + MissingFieldApiError = 5, + AccountDataRequestFailure = 6, + GetAccountDataRequestFailure = 7, + SetAccountDataRequestFailure = 8, + RefreshTokenExpired = 9, + FailedToCreateHeader = 10, + EncryptionFailure = 11, + InvalidOAuthExpiration = 12, + InvalidRefreshExpiration = 13, + EncryptionSecretNotSet = 14, +} + +---@enum Enum.InitiativeMilestoneFlags +Enum.InitiativeMilestoneFlags = { + FinalMilestone = 1, +} + +---@enum Enum.InitiativeRewardFlags +Enum.InitiativeRewardFlags = { + PermanentWorldState = 1, +} + +---@enum Enum.InputContext +Enum.InputContext = { + None = 0, + Keyboard = 1, + Mouse = 2, + GamePad = 3, +} + +---@enum Enum.InvalidPlotScreenshotReason +Enum.InvalidPlotScreenshotReason = { + None = 0, + OutOfBounds = 1, + Facing = 2, + NoNeighborhoodFound = 3, + NoActivePlayer = 4, +} + +---@enum Enum.InventoryType +Enum.InventoryType = { + IndexNonEquipType = 0, + IndexHeadType = 1, + IndexNeckType = 2, + IndexShoulderType = 3, + IndexBodyType = 4, + IndexChestType = 5, + IndexWaistType = 6, + IndexLegsType = 7, + IndexFeetType = 8, + IndexWristType = 9, + IndexHandType = 10, + IndexFingerType = 11, + IndexTrinketType = 12, + IndexWeaponType = 13, + IndexShieldType = 14, + IndexRangedType = 15, + IndexCloakType = 16, + Index2HweaponType = 17, + IndexBagType = 18, + IndexTabardType = 19, + IndexRobeType = 20, + IndexWeaponmainhandType = 21, + IndexWeaponoffhandType = 22, + IndexHoldableType = 23, + IndexAmmoType = 24, + IndexThrownType = 25, + IndexRangedrightType = 26, + IndexQuiverType = 27, + IndexRelicType = 28, + IndexProfessionToolType = 29, + IndexProfessionGearType = 30, + IndexEquipablespellOffensiveType = 31, + IndexEquipablespellUtilityType = 32, + IndexEquipablespellDefensiveType = 33, + IndexEquipablespellWeaponType = 34, +} + +---@enum Enum.ItemArmorSubclass +Enum.ItemArmorSubclass = { + Generic = 0, + Cloth = 1, + Leather = 2, + Mail = 3, + Plate = 4, + Cosmetic = 5, + Shield = 6, + Libram = 7, + Idol = 8, + Totem = 9, + Sigil = 10, + Relic = 11, +} + +---@enum Enum.ItemBind +Enum.ItemBind = { + None = 0, + OnAcquire = 1, + OnEquip = 2, + OnUse = 3, + Quest = 4, + Unused1 = 5, + Unused2 = 6, + ToWoWAccount = 7, + ToBnetAccount = 8, + ToBnetAccountUntilEquipped = 9, +} + +---@enum Enum.ItemClass +Enum.ItemClass = { + Consumable = 0, + Container = 1, + Weapon = 2, + Gem = 3, + Armor = 4, + Reagent = 5, + Projectile = 6, + Tradegoods = 7, + ItemEnhancement = 8, + Recipe = 9, + CurrencyTokenObsolete = 10, + Quiver = 11, + Questitem = 12, + Key = 13, + PermanentObsolete = 14, + Miscellaneous = 15, + Glyph = 16, + Battlepet = 17, + WoWToken = 18, + Profession = 19, + Housing = 20, +} + +---@enum Enum.ItemCollectionType +Enum.ItemCollectionType = { + None = 0, + Toy = 1, + Heirloom = 2, + Transmog = 3, + TransmogSetFavorite = 4, + RuneforgeLegendaryAbility = 5, + TransmogIllusion = 6, + WarbandScene = 7, + Room = 8, + ExteriorFixture = 9, + RoomTheme = 10, + RoomMaterial = 11, + TransmogOutfit = 12, + HouseType = 13, +} + +---@enum Enum.ItemCommodityStatus +Enum.ItemCommodityStatus = { + Unknown = 0, + Item = 1, + Commodity = 2, +} + +---@enum Enum.ItemConsumableSubclass +Enum.ItemConsumableSubclass = { + Generic = 0, + Potion = 1, + Elixir = 2, + Flasksphials = 3, + Scroll = 4, + Fooddrink = 5, + Itemenhancement = 6, + Bandage = 7, + Other = 8, + VantusRune = 9, + UtilityCurio = 10, + CombatCurio = 11, + Relic = 12, +} + +---@enum Enum.ItemCreationContext +Enum.ItemCreationContext = { + None = 0, + DungeonNormal = 1, + DungeonHeroic = 2, + RaidNormal = 3, + RaidFinder = 4, + RaidHeroic = 5, + RaidMythic = 6, + PvPUnranked_1 = 7, + PvPRanked_1 = 8, + ScenarioNormal = 9, + ScenarioHeroic = 10, + QuestReward = 11, + Store = 12, + TradeSkill = 13, + Vendor = 14, + BlackMarket = 15, + ChallengeMode_1 = 16, + DungeonLevelUp_1 = 17, + DungeonLevelUp_2 = 18, + DungeonLevelUp_3 = 19, + DungeonLevelUp_4 = 20, + ForceNone = 21, + TimewalkerLevelUp = 22, + DungeonMythic = 23, + PvPHonorReward = 24, + WorldQuest_1 = 25, + WorldQuest_2 = 26, + WorldQuest_3 = 27, + WorldQuest_4 = 28, + WorldQuest_5 = 29, + WorldQuest_6 = 30, + MissionReward_1 = 31, + MissionReward_2 = 32, + ChallengeMode_2 = 33, + ChallengeMode_3 = 34, + ChallengeModeJackpot = 35, + WorldQuest_7 = 36, + WorldQuest_8 = 37, + PvPRanked_2 = 38, + PvPRanked_3 = 39, + PvPRanked_4 = 40, + PvPUnranked_2 = 41, + WorldQuest_9 = 42, + WorldQuest_10 = 43, + PvPRanked_5 = 44, + PvPRanked_6 = 45, + PvPRanked_7 = 46, + PvPUnranked_3 = 47, + PvPUnranked_4 = 48, + PvPUnranked_5 = 49, + PvPUnranked_6 = 50, + PvPUnranked_7 = 51, + PvPRanked_8 = 52, + WorldQuest_11 = 53, + WorldQuest_12 = 54, + WorldQuest_13 = 55, + PvPRankedJackpot = 56, + TournamentRealm_1 = 57, + Relinquished = 58, + LegendaryForge = 59, + QuestBonusLoot = 60, + CharacterBoost_1 = 61, + CharacterBoost_2 = 62, + LegendaryCrafting_1 = 63, + LegendaryCrafting_2 = 64, + LegendaryCrafting_3 = 65, + LegendaryCrafting_4 = 66, + LegendaryCrafting_5 = 67, + LegendaryCrafting_6 = 68, + LegendaryCrafting_7 = 69, + LegendaryCrafting_8 = 70, + LegendaryCrafting_9 = 71, + WeeklyRewardsAdditional = 72, + WeeklyRewardsConcession = 73, + WorldQuestJackpot = 74, + NewCharacter = 75, + WarMode = 76, + PvPBrawl_1 = 77, + PvPBrawl_2 = 78, + Torghast = 79, + CorpseRecovery = 80, + WorldBoss = 81, + RaidNormalExtended = 82, + RaidFinderExtended = 83, + RaidHeroicExtended = 84, + RaidMythicExtended = 85, + CharacterBoost_3 = 86, + ChallengeMode_4 = 87, + PvPRanked_9 = 88, + RaidNormalExtended_2 = 89, + RaidFinderExtended_2 = 90, + RaidHeroicExtended_2 = 91, + RaidMythicExtended_2 = 92, + RaidNormalExtended_3 = 93, + RaidFinderExtended_3 = 94, + RaidHeroicExtended_3 = 95, + RaidMythicExtended_3 = 96, + TemplateCharacter_1 = 97, + TemplateCharacter_2 = 98, + TemplateCharacter_3 = 99, + TemplateCharacter_4 = 100, + DungeonNormalJackpot = 101, + DungeonHeroicJackpot = 102, + DungeonMythicJackpot = 103, + Delves_1 = 104, + Timerunning = 105, + Delves_2 = 106, + Delves_3 = 107, + DelvesJackpot = 108, + DelvesKey_1 = 109, + DelvesKey_2 = 110, + DelvesKey_3 = 111, + DelvesKey_4 = 112, + DelvesKey_5 = 113, + DelvesKey_6 = 114, + DelvesKey_7 = 115, + DelvesKey_8 = 116, + DelvesBounty_1 = 117, + DelvesBounty_2 = 118, + DelvesBounty_3 = 119, + DelvesBounty_4 = 120, + DelvesBounty_5 = 121, + DelvesBounty_6 = 122, + DelvesBounty_7 = 123, + DelvesBounty_8 = 124, + DelvesLevelUp_1 = 125, + DelvesLevelUp_2 = 126, + DelvesLevelUp_3 = 127, + DelvesLevelUp_4 = 128, + DelvesBonus_1 = 129, + DelvesBonus_2 = 130, + DelvesBonus_3 = 131, + DelvesBonus_4 = 132, + DelvesBonus_5 = 133, + DelvesBonus_6 = 134, + DelvesBonus_7 = 135, + DelvesBonus_8 = 136, + DelvesBonus_9 = 137, + DelvesBonus_10 = 138, + DungeonBonus_1 = 139, + DungeonBonus_2 = 140, + DungeonBonus_3 = 141, + DungeonBonus_4 = 142, + DungeonBonus_5 = 143, + DungeonBonus_6 = 144, + DungeonBonus_7 = 145, + DungeonBonus_8 = 146, + DungeonBonus_9 = 147, + DungeonBonus_10 = 148, + RaidBonus_1 = 149, + RaidBonus_2 = 150, + RaidBonus_3 = 151, + RaidBonus_4 = 152, + RaidBonus_5 = 153, + RaidBonus_6 = 154, + RaidBonus_7 = 155, + RaidBonus_8 = 156, + RaidBonus_9 = 157, + RaidBonus_10 = 158, + DungeonHardMode_1 = 159, + DungeonHardMode_2 = 160, + DungeonHardMode_3 = 161, + TournamentRealm_2 = 162, + TournamentRealm_3 = 163, + TournamentRealm_4 = 164, + Warbound_1 = 165, + Warbound_2 = 166, + Warbound_3 = 167, + Warbound_4 = 168, + Warbound_5 = 169, + Warbound_6 = 170, + Warbound_7 = 171, + Warbound_8 = 172, + Warbound_9 = 173, + Warbound_10 = 174, + Warbound_11 = 175, + Warbound_12 = 176, + Warbound_13 = 177, + Warbound_14 = 178, + Warbound_15 = 179, + Warbound_16 = 180, + Warbound_17 = 181, + Warbound_18 = 182, + Warbound_19 = 183, + Warbound_20 = 184, + Endeavors = 185, + TimewalkerMaxLevel = 186, +} + +---@enum Enum.ItemDisplayTextDisplayStyle +Enum.ItemDisplayTextDisplayStyle = { + WorldQuestReward = 0, + ItemNameAndInfoText = 1, + ItemNameOnlyCentered = 2, + PlayerChoiceReward = 3, +} + +---@enum Enum.ItemDisplayTooltipEnabledType +Enum.ItemDisplayTooltipEnabledType = { + Enabled = 0, + Disabled = 1, +} + +---@enum Enum.ItemGemColor +Enum.ItemGemColor = { + Meta = 0x1, + Red = 0x2, + Yellow = 0x4, + Blue = 0x8, + Hydraulic = 0x10, + Cogwheel = 0x20, + Iron = 0x40, + Blood = 0x80, + Shadow = 0x100, + Fel = 0x200, + Arcane = 0x400, + Frost = 0x800, + Fire = 0x1000, + Water = 0x2000, + Life = 0x4000, + Wind = 0x8000, + Holy = 0x10000, + PunchcardRed = 0x20000, + PunchcardYellow = 0x40000, + PunchcardBlue = 0x80000, + DominationBlood = 0x100000, + DominationFrost = 0x200000, + DominationUnholy = 0x400000, + Cypher = 0x800000, + Tinker = 0x1000000, + Primordial = 0x2000000, + Fragrance = 0x4000000, + SingingThunder = 0x8000000, + SingingSea = 0x10000000, + SingingWind = 0x20000000, + Fiber = 0x40000000, +} + +---@enum Enum.ItemGemSubclass +Enum.ItemGemSubclass = { + Intellect = 0, + Agility = 1, + Strength = 2, + Stamina = 3, + Spirit = 4, + Criticalstrike = 5, + Mastery = 6, + Haste = 7, + Versatility = 8, + Other = 9, + Multiplestats = 10, + Artifactrelic = 11, +} + +---@enum Enum.ItemHousingSubclass +Enum.ItemHousingSubclass = { + Decor = 0, + Dye = 1, + Room = 2, + RoomCustomization = 3, + ExteriorCustomization = 4, + ServiceItem = 5, +} + +---@enum Enum.ItemMiscellaneousSubclass +Enum.ItemMiscellaneousSubclass = { + Junk = 0, + Reagent = 1, + CompanionPet = 2, + Holiday = 3, + Other = 4, + Mount = 5, + MountEquipment = 6, +} + +---@enum Enum.ItemModification +Enum.ItemModification = { + TransmogrifyItemModifiedAppearanceIDSpecAll = 0, + TransmogrifyItemModifiedAppearanceIDSpec_0 = 1, + IncrementLevelObsolete = 2, + BattlePetSpecies = 3, + BattlePetBreed = 4, + BattlePetLevel = 5, + BattlePetCreaturedisplayid = 6, + TransmogrifyOverrideEnchantVisualIDSpecAll = 7, + ArtifactAppearanceID = 8, + TimewalkerLevel = 9, + TransmogrifyOverrideEnchantVisualIDSpec_0 = 10, + TransmogrifyItemModifiedAppearanceIDSpec_1 = 11, + TransmogrifyOverrideEnchantVisualIDSpec_1 = 12, + TransmogrifyItemModifiedAppearanceIDSpec_2 = 13, + TransmogrifyOverrideEnchantVisualIDSpec_2 = 14, + TransmogrifyItemModifiedAppearanceIDSpec_3 = 15, + TransmogrifyOverrideEnchantVisualIDSpec_3 = 16, + KeystoneMapChallengeModeID = 17, + KeystonePowerLevel = 18, + KeystoneAffix0 = 19, + KeystoneAffix01 = 20, + KeystoneAffix02 = 21, + KeystoneAffix03 = 22, + LegionArtifactKnowledgeObsolete = 23, + ArtifactTier = 24, + TransmogrifyItemModifiedAppearanceIDSpec_4 = 25, + PvPRating = 26, + TransmogrifyOverrideEnchantVisualIDSpec_4 = 27, + ContentTuningID = 28, + ChangeModifiedCraftingStat_1 = 29, + ChangeModifiedCraftingStat_2 = 30, + TransmogrifySecondaryItemModifiedAppearanceIDSpecAll = 31, + TransmogrifySecondaryItemModifiedAppearanceIDSpec_0 = 32, + TransmogrifySecondaryItemModifiedAppearanceIDSpec_1 = 33, + TransmogrifySecondaryItemModifiedAppearanceIDSpec_2 = 34, + TransmogrifySecondaryItemModifiedAppearanceIDSpec_3 = 35, + TransmogrifySecondaryItemModifiedAppearanceIDSpec_4 = 36, + SoulbindConduitRank = 37, + CraftingQualityID = 38, + CraftingSkillLineAbilityID = 39, + CraftingDataID = 40, + CraftingSkillReagents = 41, + CraftingSkillWatermark = 42, + CraftingReagentSlot_0 = 43, + CraftingReagentSlot_1 = 44, + CraftingReagentSlot_2 = 45, + CraftingReagentSlot_3 = 46, + CraftingReagentSlot_4 = 47, + CraftingReagentSlot_5 = 48, + CraftingReagentSlot_6 = 49, + CraftingReagentSlot_7 = 50, + CraftingReagentSlot_8 = 51, + CraftingReagentSlot_9 = 52, + CraftingReagentSlot_10 = 53, + CraftingReagentSlot_11 = 54, + CraftingReagentSlot_12 = 55, + CraftingReagentSlot_13 = 56, + CraftingReagentSlot_14 = 57, + Reforge = 58, + DbidHigh = 59, + DbidLow = 60, + CurrencyWalletID = 61, + CurrencyWalletQuantity = 62, + CurrencyWalletVersion = 63, +} + +---@enum Enum.ItemProfessionSubclass +Enum.ItemProfessionSubclass = { + Blacksmithing = 0, + Leatherworking = 1, + Alchemy = 2, + Herbalism = 3, + Cooking = 4, + Mining = 5, + Tailoring = 6, + Engineering = 7, + Enchanting = 8, + Fishing = 9, + Skinning = 10, + Jewelcrafting = 11, + Inscription = 12, + Archaeology = 13, +} + +---@enum Enum.ItemQuality +Enum.ItemQuality = { + Poor = 0, + Common = 1, + Uncommon = 2, + Rare = 3, + Epic = 4, + Legendary = 5, + Artifact = 6, + Heirloom = 7, + WoWToken = 8, +} + +---@enum Enum.ItemReagentSubclass +Enum.ItemReagentSubclass = { + Reagent = 0, + Keystone = 1, + ContextToken = 2, +} + +---@enum Enum.ItemRecipeSubclass +Enum.ItemRecipeSubclass = { + Book = 0, + Leatherworking = 1, + Tailoring = 2, + Engineering = 3, + Blacksmithing = 4, + Cooking = 5, + Alchemy = 6, + FirstAid = 7, + Enchanting = 8, + Fishing = 9, + Jewelcrafting = 10, + Inscription = 11, +} + +---@enum Enum.ItemRecraftFlags +Enum.ItemRecraftFlags = { + Invalid = 1, +} + +---@enum Enum.ItemRedundancySlot +Enum.ItemRedundancySlot = { + Head = 0, + Neck = 1, + Shoulder = 2, + Chest = 3, + Waist = 4, + Legs = 5, + Feet = 6, + Wrist = 7, + Hand = 8, + Finger = 9, + Trinket = 10, + Cloak = 11, + Twohand = 12, + MainhandWeapon = 13, + OnehandWeapon = 14, + OnehandWeaponSecond = 15, + Offhand = 16, +} + +---@enum Enum.ItemSlotFilterType +Enum.ItemSlotFilterType = { + Head = 0, + Neck = 1, + Shoulder = 2, + Cloak = 3, + Chest = 4, + Wrist = 5, + Hand = 6, + Waist = 7, + Legs = 8, + Feet = 9, + MainHand = 10, + OffHand = 11, + Finger = 12, + Trinket = 13, + Other = 14, + NoFilter = 15, +} + +---@enum Enum.ItemSocketInfoUIType +Enum.ItemSocketInfoUIType = { + Default = 0, +} + +---@enum Enum.ItemSocketType +Enum.ItemSocketType = { + None = 0, + Meta = 1, + Red = 2, + Yellow = 3, + Blue = 4, + Hydraulic = 5, + Cogwheel = 6, + Prismatic = 7, + Iron = 8, + Blood = 9, + Shadow = 10, + Fel = 11, + Arcane = 12, + Frost = 13, + Fire = 14, + Water = 15, + Life = 16, + Wind = 17, + Holy = 18, + PunchcardRed = 19, + PunchcardYellow = 20, + PunchcardBlue = 21, + Domination = 22, + Cypher = 23, + Tinker = 24, + Primordial = 25, + Fragrance = 26, + SingingThunder = 27, + SingingSea = 28, + SingingWind = 29, + Fiber = 30, +} + +---@enum Enum.ItemSoundType +Enum.ItemSoundType = { + Pickup = 0, + Drop = 1, + Use = 2, + Close = 3, +} + +---@enum Enum.ItemSubclassDisplay +Enum.ItemSubclassDisplay = { + HideSubclassInTooltips = 1, + HideSubclassInAuction = 2, + ShowItemCount = 4, +} + +---@enum Enum.ItemSubclassFlag +Enum.ItemSubclassFlag = { + WeaponsubclassCanparry = 0x1, + WeaponsubclassSetfingerseq = 0x2, + WeaponsubclassIsunarmed = 0x4, + WeaponsubclassIsrifle = 0x8, + WeaponsubclassIsthrown = 0x10, + WeaponsubclassRighthandRanged = 0x20, + ItemsubclassQuivernotrequired = 0x40, + WeaponsubclassRanged = 0x80, + WeaponsubclassDeprecatedReuseMe = 0x100, + ItemsubclassUsesInvtype = 0x200, + ArmorsubclassLfgscalingarmor = 0x400, +} + +---@enum Enum.ItemTryOnReason +Enum.ItemTryOnReason = { + Success = 0, + WrongRace = 1, + NotEquippable = 2, + DataPending = 3, +} + +---@enum Enum.ItemWeaponSubclass +Enum.ItemWeaponSubclass = { + Axe1H = 0, + Axe2H = 1, + Bows = 2, + Guns = 3, + Mace1H = 4, + Mace2H = 5, + Polearm = 6, + Sword1H = 7, + Sword2H = 8, + Warglaive = 9, + Staff = 10, + Bearclaw = 11, + Catclaw = 12, + Unarmed = 13, + Generic = 14, + Dagger = 15, + Thrown = 16, + Obsolete3 = 17, + Crossbow = 18, + Wand = 19, + Fishingpole = 20, +} + +---@enum Enum.Itemclassfilterflags +Enum.Itemclassfilterflags = { + Consumable = 0x1, + Container = 0x2, + Weapon = 0x4, + Gem = 0x8, + Armor = 0x10, + Reagent = 0x20, + Projectile = 0x40, + Tradegoods = 0x80, + ItemEnhancement = 0x100, + Recipe = 0x200, + CurrencyTokenObsolete = 0x400, + Quiver = 0x800, + Questitemclassfilterflags = 0x1000, + Key = 0x2000, + PermanentObsolete = 0x4000, + Miscellaneous = 0x8000, + Glyph = 0x10000, + Battlepet = 0x20000, +} + +---@enum Enum.Itemsetflags +Enum.Itemsetflags = { + Legacy = 1, + UseItemHistorySetSlots = 2, + RequiresPvPTalentsActive = 4, +} + +---@enum Enum.JailersTowerType +Enum.JailersTowerType = { + TwistingCorridors = 0, + SkoldusHalls = 1, + FractureChambers = 2, + Soulforges = 3, + Coldheart = 4, + Mortregar = 5, + UpperReaches = 6, + ArkobanHall = 7, + TormentChamberJaina = 8, + TormentChamberThrall = 9, + TormentChamberAnduin = 10, + AdamantVaults = 11, + ForgottenCatacombs = 12, + Ossuary = 13, + BossRush = 14, +} + +---@enum Enum.JournalEncounterFlags +Enum.JournalEncounterFlags = { + Obsolete = 0x1, + LimitDifficulties = 0x2, + AllianceOnly = 0x4, + HordeOnly = 0x8, + NoMap = 0x10, + InternalOnly = 0x20, + DoNotDisplayEncounter = 0x40, +} + +---@enum Enum.JournalEncounterIconFlags +Enum.JournalEncounterIconFlags = { + Tank = 0x1, + Dps = 0x2, + Healer = 0x4, + Heroic = 0x8, + Deadly = 0x10, + Important = 0x20, + Interruptible = 0x40, + Magic = 0x80, + Curse = 0x100, + Poison = 0x200, + Disease = 0x400, + Enrage = 0x800, + Mythic = 0x1000, + Bleed = 0x2000, +} + +---@enum Enum.JournalEncounterItemFlags +Enum.JournalEncounterItemFlags = { + Obsolete = 0x1, + LimitDifficulties = 0x2, + DisplayAsPerPlayerLoot = 0x4, + DisplayAsVeryRare = 0x8, + DisplayAsExtremelyRare = 0x10, +} + +---@enum Enum.JournalEncounterLocFlags +Enum.JournalEncounterLocFlags = { + Primary = 1, +} + +---@enum Enum.JournalEncounterSecTypes +Enum.JournalEncounterSecTypes = { + Generic = 0, + Creature = 1, + Ability = 2, + Overview = 3, +} + +---@enum Enum.JournalEncounterSectionFlags +Enum.JournalEncounterSectionFlags = { + StartExpanded = 1, + LimitDifficulties = 2, +} + +---@enum Enum.JournalInstanceFlags +Enum.JournalInstanceFlags = { + Timewalker = 1, + HideUserSelectableDifficulty = 2, + DoNotDisplayInstance = 4, +} + +---@enum Enum.JournalLinkTypes +Enum.JournalLinkTypes = { + Instance = 0, + Encounter = 1, + Section = 2, + Tier = 3, +} + +---@enum Enum.LFGEntryGeneralPlaystyle +Enum.LFGEntryGeneralPlaystyle = { + None = 0, + Learning = 1, + FunRelaxed = 2, + FunSerious = 3, + Expert = 4, +} + +---@enum Enum.LFGEntryPlaystyle +Enum.LFGEntryPlaystyle = { + None = 0, + Standard = 1, + Casual = 2, + Hardcore = 3, +} + +---@enum Enum.LFGListDisplayType +Enum.LFGListDisplayType = { + RoleCount = 0, + RoleEnumerate = 1, + ClassEnumerate = 2, + HideAll = 3, + PlayerCount = 4, + Comment = 5, +} + +---@enum Enum.LFGListFilter +Enum.LFGListFilter = { + Recommended = 0x1, + NotRecommended = 0x2, + PvE = 0x4, + PvP = 0x8, + Timerunning = 0x10, + CurrentExpansion = 0x20, + CurrentSeason = 0x40, + NotCurrentSeason = 0x80, +} + +---@enum Enum.LFGRole +Enum.LFGRole = { + Tank = 0, + Healer = 1, + Damage = 2, +} + +---@enum Enum.LFGSlotInvalidReason +Enum.LFGSlotInvalidReason = { + None = 0, + ExpansionTooLow = 1, + LevelTooLow = 2, + LevelTooHigh = 3, + GearTooLow = 4, + GearTooHigh = 5, + RaidLocked = 6, + LevelTargetTooLow = 7, + LevelTargetTooHigh = 8, + AreaNotExplored = 9, + WrongFaction = 10, + NoValidRoles = 11, + EngagedInPvP = 12, + NoSpec = 13, + CannotRunAnyChildDungeon = 14, + Restricted = 15, + ChromieTime = 16, + Npe = 17, + Timerunning = 18, + PlayerConditionFailed = 19, +} + +---@enum Enum.LanguageFlag +Enum.LanguageFlag = { + IsExotic = 1, + HiddenFromPlayer = 2, + HideLanguageNameInChat = 4, +} + +---@enum Enum.LeavePartyConfirmReason +Enum.LeavePartyConfirmReason = { + QuestSync = 0, + RestrictedChallengeMode = 1, +} + +---@enum Enum.LgVendorPurchaseSettlementState +Enum.LgVendorPurchaseSettlementState = { + Settled = 0, + NotSettled = 1, +} + +---@enum Enum.LgVendorPurchaseSqlResults +Enum.LgVendorPurchaseSqlResults = { + Failed = 0, + Success = 100, + InsufficientFunds = 101, + AlreadyOwned = 102, + InsufficientSpent = 103, + NotOwned = 104, + RefundExpired = 105, + NoRecord = 106, + InvalidState = 107, +} + +---@enum Enum.LgVendorPurchaseState +Enum.LgVendorPurchaseState = { + NotOwned = 0, + Owned = 1, +} + +---@enum Enum.LimitedInputType +Enum.LimitedInputType = { + MouseMove = 0, + MouseDown = 1, + MouseUp = 2, + MouseWheel = 3, +} + +---@enum Enum.LinkedCurrencyFlags +Enum.LinkedCurrencyFlags = { + IgnoreAdd = 0x1, + IgnoreSubtract = 0x2, + SuppressChatLog = 0x4, + AddIgnoresMax = 0x8, +} + +---@enum Enum.LoadConfigResult +Enum.LoadConfigResult = { + Error = 0, + NoChangesNecessary = 1, + LoadInProgress = 2, + Ready = 3, +} + +---@enum Enum.LogPriority +Enum.LogPriority = { + Fatal = 1, + Error = 2, + Warning = 3, + Normal = 10, + Debug = 30, + Spam = 40, +} + +---@enum Enum.LogicLogicop +Enum.LogicLogicop = { + None = 0, + And = 1, + Or = 2, + Xor = 3, +} + +---@enum Enum.LogicMathop +Enum.LogicMathop = { + None = 0, + Plus = 1, + Minus = 2, + Times = 3, + Div = 4, + Mod = 5, +} + +---@enum Enum.LogicRelop +Enum.LogicRelop = { + None = 0, + Equal = 1, + Notequal = 2, + Lt = 3, + Lteq = 4, + Gt = 5, + Gteq = 6, +} + +---@enum Enum.LootMethod +Enum.LootMethod = { + Freeforall = 0, + Roundrobin = 1, + Masterlooter = 2, + Group = 3, + Needbeforegreed = 4, + Personal = 5, +} + +---@enum Enum.LootMethodStyles +Enum.LootMethodStyles = { + Mainline = 0, + Vanilla = 1, +} + +---@enum Enum.LootSlotType +Enum.LootSlotType = { + None = 0, + Item = 1, + Money = 2, + Currency = 3, +} + +---@enum Enum.LuaCurveType +Enum.LuaCurveType = { + Linear = 0, + Step = 1, + Cosine = 2, + Cubic = 3, +} + +---@enum Enum.MajorFactionFeatureAbility +Enum.MajorFactionFeatureAbility = { + Generic = 0, + Fishing = 1, + Hunts = 2, +} + +---@enum Enum.MajorFactionType +Enum.MajorFactionType = { + None = 0, + DragonscaleExpedition = 1, + MaruukCentaur = 2, + IskaaraTuskarr = 3, + ValdrakkenAccord = 4, +} + +---@enum Enum.ManipulatorEventType +Enum.ManipulatorEventType = { + Start = 0, + Move = 1, + Complete = 2, + Delete = 3, +} + +---@enum Enum.MapCanvasPosition +Enum.MapCanvasPosition = { + None = 0, + BottomLeft = 1, + BottomRight = 2, + TopLeft = 3, + TopRight = 4, +} + +---@enum Enum.MapIconUIWidgetSetType +Enum.MapIconUIWidgetSetType = { + Tooltip = 0, + BehindIcon = 1, + AdventureMapDetails = 2, +} + +---@enum Enum.MapOverlayDisplayLocation +Enum.MapOverlayDisplayLocation = { + Default = 0, + BottomLeft = 1, + TopLeft = 2, + BottomRight = 3, + TopRight = 4, + Hidden = 5, +} + +---@enum Enum.MapPinAnimationType +Enum.MapPinAnimationType = { + None = 0, + Pulse = 1, +} + +---@enum Enum.MapobjEventTypes +Enum.MapobjEventTypes = { + PlayAnim = 0, + SetAnimSpeed = 1, +} + +---@enum Enum.MatchDetailType +Enum.MatchDetailType = { + Placement = 0, + Kills = 1, + PlunderAcquired = 2, +} + +---@enum Enum.MicroMenuOrder +Enum.MicroMenuOrder = { + Default = 0, + Reverse = 1, +} + +---@enum Enum.MicroMenuOrientation +Enum.MicroMenuOrientation = { + Horizontal = 0, + Vertical = 1, +} + +---@enum Enum.MinimapTrackingFilter +Enum.MinimapTrackingFilter = { + Unfiltered = 0x0, + Auctioneer = 0x1, + Banker = 0x2, + Battlemaster = 0x4, + TaxiNode = 0x8, + VenderFood = 0x10, + Innkeeper = 0x20, + Mailbox = 0x40, + TrainerProfession = 0x80, + VendorReagent = 0x100, + Repair = 0x200, + TrivialQuests = 0x400, + Stablemaster = 0x800, + Transmogrifier = 0x1000, + POI = 0x2000, + Target = 0x4000, + Focus = 0x8000, + QuestPOIs = 0x10000, + Digsites = 0x20000, + Barber = 0x40000, + ItemUpgrade = 0x80000, + VendorPoison = 0x100000, + AccountCompletedQuests = 0x200000, + AccountBanker = 0x400000, +} + +---@enum Enum.ModelBlendOperation +Enum.ModelBlendOperation = { + None = 0, + Anim = 1, +} + +---@enum Enum.ModelLightType +Enum.ModelLightType = { + Directional = 0, + Point = 1, +} + +---@enum Enum.ModelSceneSetting +Enum.ModelSceneSetting = { + AlignLightToOrbitDelta = 1, +} + +---@enum Enum.ModelSceneType +Enum.ModelSceneType = { + MountJournal = 0, + PetJournalCard = 1, + ShopCard = 2, + EncounterJournal = 3, + PetJournalLoadout = 4, + ArtifactTier2 = 5, + ArtifactTier2ForgingScene = 6, + ArtifactTier2SlamEffect = 7, + CommentatorVictoryFanfare = 8, + ArtifactRelicTalentEffect = 9, + PvPWarModeOrb = 10, + PvPWarModeFire = 11, + PartyPose = 12, + AzeriteItemLevelUpToast = 13, + AzeritePowers = 14, + AzeriteRewardGlow = 15, + HeartOfAzeroth = 16, + WorldMapThreat = 17, + Soulbinds = 18, + JailersTowerAnimaGlow = 19, +} + +---@enum Enum.ModelSoundOverrideType +Enum.ModelSoundOverrideType = { + UseParent = 0, + UseOverride = 1, + Mute = 2, +} + +---@enum Enum.ModelSoundTagType +Enum.ModelSoundTagType = { + Oneshot = 1, + Looping = 2, +} + +---@enum Enum.MountType +Enum.MountType = { + Ground = 0, + Flying = 1, + Aquatic = 2, + Dragonriding = 3, + RideAlong = 4, +} + +---@enum Enum.MountTypeFlag +Enum.MountTypeFlag = { + IsFlyingMount = 0x1, + IsAquaticMount = 0x2, + IsDragonRidingMount = 0x4, + IsRideAlongMount = 0x8, +} + +---@enum Enum.NamePlateCastBarDisplay +Enum.NamePlateCastBarDisplay = { + None = 0, + SpellName = 1, + SpellIcon = 2, + SpellTarget = 3, + HighlightImportantCasts = 4, + HighlightWhenCastTarget = 5, +} + +---@enum Enum.NamePlateEnemyNpcAuraDisplay +Enum.NamePlateEnemyNpcAuraDisplay = { + None = 0, + Buffs = 1, + Debuffs = 2, + CrowdControl = 3, +} + +---@enum Enum.NamePlateEnemyPlayerAuraDisplay +Enum.NamePlateEnemyPlayerAuraDisplay = { + None = 0, + Buffs = 1, + Debuffs = 2, + LossOfControl = 3, +} + +---@enum Enum.NamePlateFriendlyPlayerAuraDisplay +Enum.NamePlateFriendlyPlayerAuraDisplay = { + None = 0, + Buffs = 1, + Debuffs = 2, + LossOfControl = 3, +} + +---@enum Enum.NamePlateInfoDisplay +Enum.NamePlateInfoDisplay = { + None = 0, + CurrentHealthPercent = 1, + CurrentHealthValue = 2, + RarityIcon = 3, +} + +---@enum Enum.NamePlateSimplifiedType +Enum.NamePlateSimplifiedType = { + None = 0, + Minion = 1, + MinusMob = 2, + FriendlyPlayer = 3, + FriendlyNpc = 4, +} + +---@enum Enum.NamePlateSize +Enum.NamePlateSize = { + Small = 1, + Medium = 2, + Large = 3, + ExtraLarge = 4, + Huge = 5, +} + +---@enum Enum.NamePlateStackType +Enum.NamePlateStackType = { + None = 0, + Enemy = 1, + Friendly = 2, +} + +---@enum Enum.NamePlateStyle +Enum.NamePlateStyle = { + Modern = 0, + Thin = 1, + Block = 2, + HealthFocus = 3, + CastFocus = 4, + Legacy = 5, +} + +---@enum Enum.NamePlateThreatDisplay +Enum.NamePlateThreatDisplay = { + None = 0, + Progressive = 1, + Flash = 2, + HealthBarColor = 3, +} + +---@enum Enum.NamePlateType +Enum.NamePlateType = { + Friendly = 0, + Enemy = 1, +} + +---@enum Enum.NavigationState +Enum.NavigationState = { + Invalid = 0, + Occluded = 1, + InRange = 2, + Disabled = 3, +} + +---@enum Enum.NeighborhoodFlags +Enum.NeighborhoodFlags = { + None = 0, + PoolParent = 1, + OpenToPublic = 2, +} + +---@enum Enum.NeighborhoodInitiativeChestResult +Enum.NeighborhoodInitiativeChestResult = { + NiSuccess = 0, + NiUnspecifiedFailure = 1, + NiNoHouseFound = 2, + NiNoRewards = 3, + NiThrottled = 4, + NiServiceDisabled = 5, +} + +---@enum Enum.NeighborhoodInitiativeFlags +Enum.NeighborhoodInitiativeFlags = { + Disabled = 1, + NoAbandon = 2, + NoRepeat = 4, +} + +---@enum Enum.NeighborhoodInitiativeNeighborhoodTypes +Enum.NeighborhoodInitiativeNeighborhoodTypes = { + NiNeighborhoodTypeSingleton = 0, + NiNeighborhoodTypePool = 1, +} + +---@enum Enum.NeighborhoodInitiativeTaskType +Enum.NeighborhoodInitiativeTaskType = { + Single = 0, + RepeatableFinite = 1, + RepeatableInfinite = 2, +} + +---@enum Enum.NeighborhoodInitiativeUpdateStatus +Enum.NeighborhoodInitiativeUpdateStatus = { + Started = 0, + MilestoneCompleted = 1, + Completed = 2, + Failed = 3, +} + +---@enum Enum.NeighborhoodInitiativesCompletionStates +Enum.NeighborhoodInitiativesCompletionStates = { + NiCompletionStateNotCompleted = 0, + NiCompletionStatePlayerCompleted = 1, + NiCompletionStateSystemAbandoned = 2, +} + +---@enum Enum.NeighborhoodInviteResult +Enum.NeighborhoodInviteResult = { + Success = 0, + DbError = 1, + RpcFailure = 2, + GenericFailure = 3, + Permission = 4, + Faction = 5, + PendingInvitation = 6, + InviteLimit = 7, + NotEnoughPlots = 8, + NotFound = 9, + TooManyRequests = 10, + AlreadyInNeighborhood = 11, +} + +---@enum Enum.NeighborhoodMapFlags +Enum.NeighborhoodMapFlags = { + None = 0, + AlliancePurchasable = 1, + HordePurchasable = 2, + CanSystemGenerate = 4, +} + +---@enum Enum.NeighborhoodOwnerType +Enum.NeighborhoodOwnerType = { + None = 0, + Guild = 1, + Charter = 2, +} + +---@enum Enum.NeighborhoodType +Enum.NeighborhoodType = { + Open = 0, + Private = 1, + Public = 2, +} + +---@enum Enum.NewCharGear +Enum.NewCharGear = { + Start = 0, + Preview = 1, +} + +---@enum Enum.NodeOpFailureReason +Enum.NodeOpFailureReason = { + None = 0, + MissingEdgeConnection = 1, + RequiredForEdge = 2, + MissingRequiredEdge = 3, + HasMutuallyExclusiveEdge = 4, + NotEnoughSourcedCurrencySpent = 5, + NotEnoughCurrencySpent = 6, + NotEnoughGoldSpent = 7, + MissingAchievement = 8, + MissingQuest = 9, + WrongSpec = 10, + WrongSelection = 11, + MaxRank = 12, + DataError = 13, + NotEnoughSourcedCurrency = 14, + NotEnoughCurrency = 15, + NotEnoughGold = 16, + SameSelection = 17, + NodeNotFound = 18, + EntryNotFound = 19, + RequiredForCondition = 20, + WrongTreeID = 21, + LevelTooLow = 22, + TreeFlaggedNoRefund = 23, + NodeNeverPurchasable = 24, + AccountDataNoMatch = 25, + NotEnoughRanksInEntry = 26, +} + +---@enum Enum.NpcCraftingOrderSetFlags +Enum.NpcCraftingOrderSetFlags = { + AllowMultiple = 1, + AllowDuplicate = 2, +} + +---@enum Enum.NumericRuleFormatRounding +Enum.NumericRuleFormatRounding = { + Nearest = 0, + Up = 1, + Down = 2, +} + +---@enum Enum.PartyPlaylistEntry +Enum.PartyPlaylistEntry = { + SoloGameMode = 0, + DuoGameMode = 1, + TrioGameMode = 2, + TrainingGameMode = 3, +} + +---@enum Enum.PartyPoseFlags +Enum.PartyPoseFlags = { + HideLeaveInstanceButton = 1, +} + +---@enum Enum.PartyRequestJoinRelation +Enum.PartyRequestJoinRelation = { + None = 0, + Friend = 1, + Guild = 2, + Club = 3, + RecentAllies = 4, +} + +---@enum Enum.PerksVendorCategoryType +Enum.PerksVendorCategoryType = { + Transmog = 1, + Mount = 2, + Pet = 3, + Toy = 5, + Illusion = 7, + Transmogset = 8, + WarbandScene = 9, + Stipend = 20, + Activity = 21, + GmAdjustment = 22, + Achievement = 23, + RefundUnused = 24, +} + +---@enum Enum.PermanentChatChannelType +Enum.PermanentChatChannelType = { + None = 0, + Zone = 1, + Communities = 2, + Custom = 3, +} + +---@enum Enum.PetActionFeedback +Enum.PetActionFeedback = { + Success = 0, + Dead = 1, + InvalidTarget = 2, + FriendlyTarget = 3, + NoPath = 4, +} + +---@enum Enum.PetActionbuttonType +Enum.PetActionbuttonType = { + None = 0, + Spell = 1, + Slot1Obsolete = 2, + Slot2Obsolete = 3, + Slot3Obsolete = 4, + Slot4Obsolete = 5, + Mode = 6, + Orders = 7, + Slot1 = 8, + Slot2 = 9, + Slot3 = 10, + Slot4 = 11, + Slot5 = 12, + Slot6 = 13, + Slot7 = 14, + Slot8 = 15, + Slot9 = 16, + Slot10 = 17, + Max = 18, + VehicleAction = 19, +} + +---@enum Enum.PetBattleQueueStatus +Enum.PetBattleQueueStatus = { + None = 0, + Queued = 1, + QueuedUpdate = 2, + AlreadyQueued = 3, + JoinFailed = 4, + JoinFailedSlots = 5, + JoinFailedJournalLock = 6, + JoinFailedNeutral = 7, + MatchAccepted = 8, + MatchDeclined = 9, + MatchOpponentDeclined = 10, + ProposalTimedOut = 11, + Removed = 12, + RequeuedAfterInternalError = 13, + RequeuedAfterOpponentRemoved = 14, + Matchmaking = 15, + LostConnection = 16, + Shutdown = 17, + Suspended = 18, + Unsuspended = 19, + InBattle = 20, + NoBattlingHere = 21, +} + +---@enum Enum.PetJournalError +Enum.PetJournalError = { + None = 0, + PetIsDead = 1, + JournalIsLocked = 2, + InvalidFaction = 3, + NoFavoritesToSummon = 4, + NoValidRandomSummon = 5, +} + +---@enum Enum.PetMode +Enum.PetMode = { + Passive = 0, + Defensive = 1, + Aggressive = 2, + Assist = 3, +} + +---@enum Enum.PetOrders +Enum.PetOrders = { + Wait = 0, + Follow = 1, + Attack = 2, + Dismiss = 3, + MoveTo = 4, +} + +---@enum Enum.PetOverride +Enum.PetOverride = { + None = 0, + AICombatControl = 1, + AICombatPassive = 2, + OwnerMounted = 4, +} + +---@enum Enum.PetbattleAuraStateFlags +Enum.PetbattleAuraStateFlags = { + None = 0x0, + Infinite = 0x1, + Canceled = 0x2, + InitDisabled = 0x4, + CountdownFirstRound = 0x8, + JustApplied = 0x10, + RemoveEventHandled = 0x20, +} + +---@enum Enum.PetbattleCheatFlags +Enum.PetbattleCheatFlags = { + None = 0, + AutoPlay = 1, +} + +---@enum Enum.PetbattleEffectFlags +Enum.PetbattleEffectFlags = { + None = 0x0, + InvalidTarget = 0x1, + Miss = 0x2, + Crit = 0x4, + Blocked = 0x8, + Dodge = 0x10, + Heal = 0x20, + Unkillable = 0x40, + Reflect = 0x80, + Absorb = 0x100, + Immune = 0x200, + Strong = 0x400, + Weak = 0x800, + SuccessChain = 0x1000, + AuraReapply = 0x2000, +} + +---@enum Enum.PetbattleEffectType +Enum.PetbattleEffectType = { + SetHealth = 0, + AuraApply = 1, + AuraCancel = 2, + AuraChange = 3, + PetSwap = 4, + StatusChange = 5, + SetState = 6, + SetMaxHealth = 7, + SetSpeed = 8, + SetPower = 9, + TriggerAbility = 10, + AbilityChange = 11, + NpcEmote = 12, + AuraProcessingBegin = 13, + AuraProcessingEnd = 14, + ReplacePet = 15, + OverrideAbility = 16, + WorldStateUpdate = 17, +} + +---@enum Enum.PetbattleEnviros +Enum.PetbattleEnviros = { + Pad0 = 0, + Pad1 = 1, + Weather = 2, +} + +---@enum Enum.PetbattleInputMoveMsgDebugFlag +Enum.PetbattleInputMoveMsgDebugFlag = { + None = 0, + DontValidate = 1, + EnemyCast = 2, +} + +---@enum Enum.PetbattleMoveType +Enum.PetbattleMoveType = { + Quit = 0, + Ability = 1, + Swap = 2, + Trap = 3, + FinalRoundOk = 4, + Pass = 5, +} + +---@enum Enum.PetbattlePboid +Enum.PetbattlePboid = { + P0Pet_0 = 0, + P0Pet_1 = 1, + P0Pet_2 = 2, + P1Pet_0 = 3, + P1Pet_1 = 4, + P1Pet_2 = 5, + EnvPad_0 = 6, + EnvPad_1 = 7, + EnvWeather = 8, +} + +---@enum Enum.PetbattlePetStatus +Enum.PetbattlePetStatus = { + FlagNone = 0x0, + FlagTrapped = 0x1, + Stunned = 0x2, + SwapOutLocked = 0x4, + SwapInLocked = 0x8, +} + +---@enum Enum.PetbattlePlayer +Enum.PetbattlePlayer = { + Player_0 = 0, + Player_1 = 1, +} + +---@enum Enum.PetbattlePlayerInputFlags +Enum.PetbattlePlayerInputFlags = { + None = 0x0, + TurnInProgress = 0x1, + AbilityLocked = 0x2, + SwapLocked = 0x4, + WaitingForPet = 0x8, +} + +---@enum Enum.PetbattleResult +Enum.PetbattleResult = { + FailUnknown = 0, + FailNotHere = 1, + FailNotHereOnTransport = 2, + FailNotHereUnevenGround = 3, + FailNotHereObstructed = 4, + FailNotWhileInCombat = 5, + FailNotWhileDead = 6, + FailNotWhileFlying = 7, + FailTargetInvalid = 8, + FailTargetOutOfRange = 9, + FailTargetNotCapturable = 10, + FailNotATrainer = 11, + FailDeclined = 12, + FailInBattle = 13, + FailInvalidLoadout = 14, + FailInvalidLoadoutAllDead = 15, + FailInvalidLoadoutNoneSlotted = 16, + FailNoJournalLock = 17, + FailWildPetTapped = 18, + FailRestrictedAccount = 19, + FailOpponentNotAvailable = 20, + FailLogout = 21, + FailDisconnect = 22, + Success = 23, +} + +---@enum Enum.PetbattleSlot +Enum.PetbattleSlot = { + Slot_0 = 0, + Slot_1 = 1, + Slot_2 = 2, +} + +---@enum Enum.PetbattleSlotAbility +Enum.PetbattleSlotAbility = { + Ability_0 = 0, + Ability_1 = 1, + Ability_2 = 2, +} + +---@enum Enum.PetbattleSlotResult +Enum.PetbattleSlotResult = { + Success = 0, + SlotLocked = 1, + SlotEmpty = 2, + NoTracker = 3, + NoSpeciesRec = 4, + CantBattle = 5, + Revoked = 6, + Dead = 7, + NoPet = 8, +} + +---@enum Enum.PetbattleState +Enum.PetbattleState = { + Created = 0, + WaitingPreBattle = 1, + RoundInProgress = 2, + WaitingForFrontPets = 3, + CreatedFailed = 4, + FinalRound = 5, + Finished = 6, +} + +---@enum Enum.PetbattleTrapstatus +Enum.PetbattleTrapstatus = { + Invalid = 0, + CanTrap = 1, + CantTrapNewbie = 2, + CantTrapPetDead = 3, + CantTrapPetHealth = 4, + CantTrapNoRoomInJournal = 5, + CantTrapPetNotCapturable = 6, + CantTrapTrainerBattle = 7, + CantTrapTwice = 8, +} + +---@enum Enum.PetbattleType +Enum.PetbattleType = { + PvE = 0, + PvP = 1, + Lfpb = 2, + Npc = 3, +} + +---@enum Enum.Pettameresult +Enum.Pettameresult = { + Ok = 0, + Invalidcreature = 1, + Toomany = 2, + Creaturealreadyowned = 3, + Nottameable = 4, + Anothersummonactive = 5, + Unitscanttame = 6, + Nopetavailable = 7, + Internalerror = 8, + Toohighlevel = 9, + Dead = 10, + Notdead = 11, + Cantcontrolexotic = 12, + Invalidslot = 13, + EliteToohighlevel = 14, + Numresults = 15, +} + +---@enum Enum.PhaseReason +Enum.PhaseReason = { + Phasing = 0, + Sharding = 1, + WarMode = 2, + ChromieTime = 3, + TimerunningHwt = 4, +} + +---@enum Enum.PhotoSharingStatus +Enum.PhotoSharingStatus = { + Disabled = 0, + NotConfigured = 1, + Configured = 2, + Expired = 3, + ParentalControl = 4, + TrialOrVeteran = 5, + AADCRestricted = 6, + Error = 7, + FailedToClear = 8, +} + +---@enum Enum.PhotoSharingUploadStatus +Enum.PhotoSharingUploadStatus = { + Disabled = 0, + Failed = 1, + Success = 2, + Locked = 3, + ListPagesApiCallFailed = 4, + ListPagesBadRequest = 5, + ListPagesUnauthorized = 6, + ListPagesForbidden = 7, + ListPagesNotFound = 8, + ListPagesTooManyRequests = 9, + ListPagesGenericFailure = 10, + ListPagesEmptyBoardID = 11, + ListPagesInvalidBookmark = 12, + CreatePageApiCallFailed = 13, + CreatePageBadRequest = 14, + CreatePageUnauthorized = 15, + CreatePageForbidden = 16, + CreatePageNotFound = 17, + CreatePageTooManyRequests = 18, + CreatePageGenericFailure = 19, + CreatePageNoBoardIDFound = 20, + CreatePostApiCallFailed = 21, + CreatePostBadRequest = 22, + CreatePostUnauthorized = 23, + CreatePostForbidden = 24, + CreatePostNotFound = 25, + CreatePostTooManyRequests = 26, + CreatePostGenericFailure = 27, + CreatePostNoIDFound = 28, + CreatePostThrottled = 29, +} + +---@enum Enum.PingMode +Enum.PingMode = { + KeyDown = 0, + ClickDrag = 1, +} + +---@enum Enum.PingResult +Enum.PingResult = { + Success = 0, + FailedGeneric = 1, + FailedSpamming = 2, + FailedDisabledByLeader = 3, + FailedDisabledBySettings = 4, + FailedOutOfPingArea = 5, + FailedSquelched = 6, + FailedUnspecified = 7, +} + +---@enum Enum.PingSubjectType +Enum.PingSubjectType = { + Attack = 0, + Warning = 1, + Assist = 2, + OnMyWay = 3, + AlertThreat = 4, + AlertNotThreat = 5, +} + +---@enum Enum.PingTextureType +Enum.PingTextureType = { + Center = 0, + Expand = 1, + Rotation = 2, +} + +---@enum Enum.PingTypeFlags +Enum.PingTypeFlags = { + DefaultPing = 1, +} + +---@enum Enum.PlayerChoiceRarity +Enum.PlayerChoiceRarity = { + Common = 0, + Uncommon = 1, + Rare = 2, + Epic = 3, +} + +---@enum Enum.PlayerClubRequestStatus +Enum.PlayerClubRequestStatus = { + None = 0, + Pending = 1, + AutoApproved = 2, + Declined = 3, + Approved = 4, + Joined = 5, + JoinedAnother = 6, + Canceled = 7, +} + +---@enum Enum.PlayerCompanionInfoFlags +Enum.PlayerCompanionInfoFlags = { + IgnoreSeasonInScenarios = 1, +} + +---@enum Enum.PlayerCurrencyFlags +Enum.PlayerCurrencyFlags = { + Incremented = 1, + Loading = 2, +} + +---@enum Enum.PlayerCurrencyFlagsDbFlags +Enum.PlayerCurrencyFlagsDbFlags = { + IgnoreMaxQtyOnload = 0x1, + Reuse1 = 0x2, + InBackpack = 0x4, + UnusedInUI = 0x8, + Reuse2 = 0x10, +} + +---@enum Enum.PlayerDataElementType +Enum.PlayerDataElementType = { + Int = 0, + Float = 1, +} + +---@enum Enum.PlayerInteractionType +Enum.PlayerInteractionType = { + None = 0, + TradePartner = 1, + Item = 2, + Gossip = 3, + QuestGiver = 4, + Merchant = 5, + TaxiNode = 6, + Trainer = 7, + Banker = 8, + AlliedRaceDetailsGiver = 9, + GuildBanker = 10, + Registrar = 11, + Vendor = 12, + PetitionVendor = 13, + GuildTabardVendor = 14, + TalentMaster = 15, + SpecializationMaster = 16, + MailInfo = 17, + SpiritHealer = 18, + AreaSpiritHealer = 19, + Binder = 20, + Auctioneer = 21, + StableMaster = 22, + BattleMaster = 23, + Transmogrifier = 24, + LFGDungeon = 25, + VoidStorageBanker = 26, + BlackMarketAuctioneer = 27, + AdventureMap = 28, + WorldMap = 29, + GarrArchitect = 30, + GarrTradeskill = 31, + GarrMission = 32, + ShipmentCrafter = 33, + GarrRecruitment = 34, + GarrTalent = 35, + Trophy = 36, + PlayerChoice = 37, + ArtifactForge = 38, + ObliterumForge = 39, + ScrappingMachine = 40, + ContributionCollector = 41, + AzeriteRespec = 42, + IslandQueue = 43, + ItemInteraction = 44, + ChromieTime = 45, + CovenantPreview = 46, + AnimaDiversion = 47, + LegendaryCrafting = 48, + WeeklyRewards = 49, + Soulbind = 50, + CovenantSanctum = 51, + NewPlayerGuide = 52, + ItemUpgrade = 53, + AdventureJournal = 54, + Renown = 55, + AzeriteForge = 56, + PerksProgramVendor = 57, + ProfessionsCraftingOrder = 58, + Professions = 59, + ProfessionsCustomerOrder = 60, + TraitSystem = 61, + BarbersChoice = 62, + JailersTowerBuffs = 63, + MajorFactionRenown = 64, + PersonalTabardVendor = 65, + ForgeMaster = 66, + CharacterBanker = 67, + AccountBanker = 68, + ProfessionRespec = 69, + CornerstoneInteraction = 70, + RenameNeighborhood = 71, + HousingBulletinBoard = 72, + HousingPedestal = 73, + CreateGuildNeighborhood = 74, + NeighborhoodCharter = 75, + GuildRename = 76, + OpenNeighborhoodCharterConfirmation = 77, + OpenHouseFinder = 78, + TieredEntrance = 79, +} + +---@enum Enum.PlayerMentorshipApplicationResult +Enum.PlayerMentorshipApplicationResult = { + Success = 0, + AlreadyMentor = 1, + Ineligible = 2, +} + +---@enum Enum.PlayerMentorshipStatus +Enum.PlayerMentorshipStatus = { + None = 0, + Newcomer = 1, + Mentor = 2, +} + +---@enum Enum.PlunderstormQueueState +Enum.PlunderstormQueueState = { + None = 0, + Queued = 1, + Proposed = 2, + Suspended = 3, +} + +---@enum Enum.PowerType +Enum.PowerType = { + Mana = 0, + Rage = 1, + Focus = 2, + Energy = 3, + ComboPoints = 4, + Runes = 5, + RunicPower = 6, + SoulShards = 7, + LunarPower = 8, + HolyPower = 9, + Alternate = 10, + Maelstrom = 11, + Chi = 12, + Insanity = 13, + BurningEmbers = 14, + DemonicFury = 15, + ArcaneCharges = 16, + Fury = 17, + Pain = 18, + Essence = 19, + RuneBlood = 20, + RuneFrost = 21, + RuneUnholy = 22, + AlternateQuest = 23, + AlternateEncounter = 24, + AlternateMount = 25, + Balance = 26, + Happiness = 27, + ShadowOrbs = 28, + RuneChromatic = 29, +} + +---@enum Enum.PowerTypeSign +Enum.PowerTypeSign = { + None = -1, + Positive = 0, + Negative = 1, +} + +---@enum Enum.PowerTypeSlot +Enum.PowerTypeSlot = { + Slot_0 = 0, + Slot_1 = 1, + Slot_2 = 2, + Slot_3 = 3, + Slot_4 = 4, + Slot_5 = 5, + Slot_6 = 6, + Slot_7 = 7, + Slot_8 = 8, + Slot_9 = 9, +} + +---@enum Enum.PremadeGroupFinderStyle +Enum.PremadeGroupFinderStyle = { + Disabled = 0, + Mainline = 1, + Vanilla = 2, +} + +---@enum Enum.PreyHuntProgressState +Enum.PreyHuntProgressState = { + Cold = 0, + Warm = 1, + Hot = 2, + Final = 3, +} + +---@enum Enum.ProceduralSpawnInteractionMode +Enum.ProceduralSpawnInteractionMode = { + None = 0, + Paint = 1, + Manipulate = 2, +} + +---@enum Enum.ProceduralSpawnVolumeChunkFlags +Enum.ProceduralSpawnVolumeChunkFlags = { + None = 0, + AllSubChunksSet = 1, +} + +---@enum Enum.ProfTraitPerkNodeFlags +Enum.ProfTraitPerkNodeFlags = { + UnlocksSubpath = 1, + IsMajorBonus = 2, +} + +---@enum Enum.Profession +Enum.Profession = { + FirstAid = 0, + Blacksmithing = 1, + Leatherworking = 2, + Alchemy = 3, + Herbalism = 4, + Cooking = 5, + Mining = 6, + Tailoring = 7, + Engineering = 8, + Enchanting = 9, + Fishing = 10, + Skinning = 11, + Jewelcrafting = 12, + Inscription = 13, + Archaeology = 14, +} + +---@enum Enum.ProfessionActionType +Enum.ProfessionActionType = { + Craft = 0, + Gather = 1, +} + +---@enum Enum.ProfessionEffect +Enum.ProfessionEffect = { + Skill = 0, + StatInspiration = 1, + StatResourcefulness = 2, + StatFinesse = 3, + StatDeftness = 4, + StatPerception = 5, + StatCraftingSpeed = 6, + StatMulticraft = 7, + UnlockReagentSlot = 8, + ModInspiration = 9, + ModResourcefulness = 10, + ModFinesse = 11, + ModDeftness = 12, + ModPerception = 13, + ModCraftingSpeed = 14, + ModMulticraft = 15, + ModUnused_1 = 16, + ModUnused_2 = 17, + ModCraftExtraQuantity = 18, + ModGatherExtraQuantity = 19, + ModCraftCritSize = 20, + ModCraftReductionQuantity = 21, + DecreaseDifficulty = 22, + IncreaseDifficulty = 23, + ModSkillGain = 24, + AccumulateRanksByLabel = 25, + StatIngenuity = 26, + ModConcentration = 27, + Tokenizer = 28, + ModIngenuity = 29, + ConcentrationRefund = 30, +} + +---@enum Enum.ProfessionRating +Enum.ProfessionRating = { + Inspiration = 0, + Resourcefulness = 1, + Finesse = 2, + Deftness = 3, + Perception = 4, + CraftingSpeed = 5, + Multicraft = 6, + Ingenuity = 7, + Unused_2 = 8, +} + +---@enum Enum.ProfessionRatingType +Enum.ProfessionRatingType = { + Craft = 0, + Gather = 1, +} + +---@enum Enum.ProfessionsSpecPathState +Enum.ProfessionsSpecPathState = { + Locked = 0, + Progressing = 1, + Completed = 2, +} + +---@enum Enum.ProfessionsSpecPerkState +Enum.ProfessionsSpecPerkState = { + Unearned = 0, + Pending = 1, + Earned = 2, +} + +---@enum Enum.ProfessionsSpecTabState +Enum.ProfessionsSpecTabState = { + Locked = 0, + Unlocked = 1, + Unlockable = 2, +} + +---@enum Enum.PurchaseHouseDisabledReason +Enum.PurchaseHouseDisabledReason = { + None = 0, + WrongFaction = 1, + WrongGuild = 2, + NotInvited = 3, + NoExpansion = 4, + Reserved = 5, + GuildLockout = 6, + CharterLockout = 7, + MaxHouses = 8, + NoGameTimeRemaining = 9, +} + +---@enum Enum.PurchaseResult +Enum.PurchaseResult = { + Ok = 0, + ErrorRiskDenied = 1, + ErrorOrderFailed = 2, + ErrorClientTimeout = 3, + ErrorClientDeclined = 4, + ErrorFailedToCreatePurchaseRecord = 5, + ErrorFailedToGetPurchaseID = 6, + ErrorFailedToSaveMopAndRiskStatus = 7, + ErrorFailedToSaveMopAndRiskResponse = 8, + ErrorClientGone = 9, + ErrorFailedToSavePlaceOrderStatus = 10, + ErrorBattlepayTimeoutMopAndRisk = 11, + ErrorCurrencyInvalidInRegion = 12, + ErrorBattlepayTemporarilyUnavailable = 13, + ErrorBattlepayDisabled = 14, + ErrorServerRestarted = 15, + ErrorInvalidProduct = 16, + ErrorInvalidRegionGroupMask = 17, + ErrorProductInvalidInRegion = 18, + ErrorDistributionObjectNotFound = 19, + ErrorDistributionObjectAlreadyAssigned = 20, + ErrorRiskResponseMissingScore = 21, + ErrorMopAndRiskAmqpRpcFailed = 22, + ErrorMopAndRiskRpcErrorFromBattlepay = 23, + ErrorMopAndRiskUnexpectedResponseFromBattlepay = 24, + ErrorMopAndRiskNoValidPaymentMethods = 25, + ErrorOrderCanceledPriceChange = 26, + ErrorBuyingProductNotAllowedInGlueScreen = 27, + ErrorMopAndRiskNotEnoughBalance = 28, + ErrorPlaceOrderNotEnoughBalance = 29, + ErrorProgrammerManualFail = 30, + ErrorThrottledByUserServer = 31, + ErrorBuyingProductNotAllowedInWorld = 32, + ErrorBlockedByParentalControls = 33, + ErrorNoStorePurchaseFlagIsSet = 34, + ErrorDistributionObjectInvalidChoice = 35, + ErrorInvalidCreditCardExpiryDate = 36, + ErrorAuthorizingPayment = 37, + ErrorPaymentProviderDeniedPayment = 38, + ErrorOverSpendingLimit = 39, + ErrorClientTimeoutChallenge = 40, + ErrorClientDeclinedChallenge = 41, + ErrorDistributionObjectInvalidTarget = 42, + ErrorFixedLicenseProductAlreadyExists = 43, + ErrorDistributionObjectTrialBlocked = 44, + ErrorDistributionObjectExpansionBlocked = 45, + ErrorOwnsConsumableToken = 46, + ErrorTooManyTokens = 47, + ErrorCommerceServerDisabled = 48, + ErrorFailedToWriteVasPurchaseID = 49, + ErrorFailedToWriteVasLicenseID = 50, + ErrorCharacterUpgradeOperationInProgress = 51, + ErrorInvalidPlatform = 52, + ErrorInvalidDeviceID = 53, + ErrorFailedToSaveValidatePurchaseStatus = 54, + ErrorFailedToSaveValidatePurchaseResponse = 55, + ErrorBattlepayTimeoutValidatePurchase = 56, + ErrorProductNotPurchasable = 57, + ErrorFailedToSaveClientCheckoutStatus = 58, + ErrorFailedOldPurchaseFlow = 59, + ErrorClientCheckoutTimeout = 60, + ErrorFailedToSaveValidationHashStatus = 61, + ErrorBattlepayTimeoutValidationHash = 62, + ErrorClientCheckoutCanceledOrFailed = 63, + ErrorCouldNotGetValidationHash = 64, + ErrorDistributionObjectWrongGameAccount = 65, + ErrorClientRestricted = 66, + ErrorFailedToSaveRedeemTokenStatus = 67, + ErrorInvalidPurchaseID = 68, + ErrorTokenRedemptionOrderFailed = 69, + ErrorVasTransactionCreateFailed = 70, + ErrorInManualReview = 71, +} + +---@enum Enum.PvPFaction +Enum.PvPFaction = { + Horde = 0, + Alliance = 1, +} + +---@enum Enum.PvPMatchState +Enum.PvPMatchState = { + Inactive = 0, + Waiting = 1, + StartUp = 2, + Engaged = 3, + PostRound = 4, + Complete = 5, +} + +---@enum Enum.PvPMatchmakingType +Enum.PvPMatchmakingType = { + Battleground = 0, + Arena = 1, +} + +---@enum Enum.PvPRanks +Enum.PvPRanks = { + RankNone = 0, + RankPariah = 1, + RankOutlaw = 2, + RankExiled = 3, + RankDishonored = 4, + Rank_1 = 5, + Rank_2 = 6, + Rank_3 = 7, + Rank_4 = 8, + Rank_5 = 9, + Rank_6 = 10, + Rank_7 = 11, + Rank_8 = 12, + Rank_9 = 13, + Rank_10 = 14, + Rank_11 = 15, + Rank_12 = 16, + Rank_13 = 17, + Rank_14 = 18, +} + +---@enum Enum.PvPUnitClassification +Enum.PvPUnitClassification = { + FlagCarrierHorde = 0, + FlagCarrierAlliance = 1, + FlagCarrierNeutral = 2, + CartRunnerHorde = 3, + CartRunnerAlliance = 4, + AssassinHorde = 5, + AssassinAlliance = 6, + OrbCarrierBlue = 7, + OrbCarrierGreen = 8, + OrbCarrierOrange = 9, + OrbCarrierPurple = 10, +} + +---@enum Enum.QuestClassification +Enum.QuestClassification = { + Important = 0, + Legendary = 1, + Campaign = 2, + Calling = 3, + Meta = 4, + Recurring = 5, + Questline = 6, + Normal = 7, + BonusObjective = 8, + Threat = 9, + WorldQuest = 10, +} + +---@enum Enum.QuestCompleteSpellType +Enum.QuestCompleteSpellType = { + LegacyBehavior = 0, + Follower = 1, + Tradeskill = 2, + Ability = 3, + Aura = 4, + Spell = 5, + Unlock = 6, + Companion = 7, + QuestlineUnlock = 8, + QuestlineReward = 9, + QuestlineUnlockPart = 10, + PossibleReward = 11, +} + +---@enum Enum.QuestFrequency +Enum.QuestFrequency = { + Default = 0, + Daily = 1, + Weekly = 2, + ResetByScheduler = 3, +} + +---@enum Enum.QuestLineFloorLocation +Enum.QuestLineFloorLocation = { + Above = 0, + Below = 1, + Same = 2, +} + +---@enum Enum.QuestRepeatability +Enum.QuestRepeatability = { + None = 0, + Daily = 1, + Weekly = 2, + Turnin = 3, + World = 4, +} + +---@enum Enum.QuestRewardContextFlags +Enum.QuestRewardContextFlags = { + None = 0, + FirstCompletionBonus = 1, + RepeatCompletionBonus = 2, +} + +---@enum Enum.QuestSessionCommand +Enum.QuestSessionCommand = { + None = 0, + Start = 1, + Stop = 2, + SessionActiveNoCommand = 3, +} + +---@enum Enum.QuestSessionResult +Enum.QuestSessionResult = { + Ok = 0, + NotInParty = 1, + InvalidOwner = 2, + AlreadyActive = 3, + NotActive = 4, + InRaid = 5, + OwnerRefused = 6, + Timeout = 7, + Disabled = 8, + Started = 9, + Stopped = 10, + Joined = 11, + Left = 12, + OwnerLeft = 13, + ReadyCheckFailed = 14, + PartyDestroyed = 15, + MemberTimeout = 16, + AlreadyMember = 17, + NotOwner = 18, + AlreadyOwner = 19, + AlreadyJoined = 20, + NotMember = 21, + Busy = 22, + JoinRejected = 23, + Logout = 24, + Empty = 25, + QuestNotCompleted = 26, + Resync = 27, + Restricted = 28, + InPetBattle = 29, + InvalidPublicParty = 30, + Unknown = 31, + InCombat = 32, + MemberInCombat = 33, + RestrictedCrossFaction = 34, +} + +---@enum Enum.QuestTag +Enum.QuestTag = { + Group = 1, + PvP = 41, + Raid = 62, + Dungeon = 81, + Legendary = 83, + Heroic = 85, + Raid10 = 88, + Raid25 = 89, + Scenario = 98, + Account = 102, + CombatAlly = 266, + Delve = 288, +} + +---@enum Enum.QuestTagType +Enum.QuestTagType = { + Tag = 0, + Profession = 1, + Normal = 2, + PvP = 3, + PetBattle = 4, + Bounty = 5, + Dungeon = 6, + Invasion = 7, + Raid = 8, + Contribution = 9, + RatedReward = 10, + InvasionWrapper = 11, + FactionAssault = 12, + Islands = 13, + Threat = 14, + CovenantCalling = 15, + DragonRiderRacing = 16, + Capstone = 17, + WorldBoss = 18, + Prey = 19, +} + +---@enum Enum.QuestTreasurePickerType +Enum.QuestTreasurePickerType = { + Visible = 0, + Hidden = 1, + Select = 2, +} + +---@enum Enum.QuestWatchType +Enum.QuestWatchType = { + Automatic = 0, + Manual = 1, +} + +---@enum Enum.RafLinkType +Enum.RafLinkType = { + None = 0, + Recruit = 1, + Friend = 2, + Both = 3, +} + +---@enum Enum.RafRecruitActivityState +Enum.RafRecruitActivityState = { + Incomplete = 0, + Complete = 1, + RewardClaimed = 2, +} + +---@enum Enum.RafRecruitSubStatus +Enum.RafRecruitSubStatus = { + Trial = 0, + Active = 1, + Inactive = 2, +} + +---@enum Enum.RafRewardType +Enum.RafRewardType = { + Pet = 0, + Mount = 1, + Appearance = 2, + Title = 3, + GameTime = 4, + AppearanceSet = 5, + Illusion = 6, + Invalid = 7, +} + +---@enum Enum.RaidAuraOrganizationType +Enum.RaidAuraOrganizationType = { + Legacy = 0, + BuffsTopDebuffsBottom = 1, + BuffsRightDebuffsLeft = 2, +} + +---@enum Enum.RaidDispelDisplayType +Enum.RaidDispelDisplayType = { + Disabled = 0, + DispellableByMe = 1, + DisplayAll = 2, +} + +---@enum Enum.RaidGroupDisplayType +Enum.RaidGroupDisplayType = { + SeparateGroupsVertical = 0, + SeparateGroupsHorizontal = 1, + CombineGroupsVertical = 2, + CombineGroupsHorizontal = 3, +} + +---@enum Enum.RcoCloseReason +Enum.RcoCloseReason = { + Fulfill = 0, + Expire = 1, + Cancel = 2, + Reject = 3, + GmCancel = 4, + CrafterFulfill = 5, + Invalid = 6, +} + +---@enum Enum.RecentAllyPinResult +Enum.RecentAllyPinResult = { + Success = 0, + ServerError = 1, +} + +---@enum Enum.RecipeRequirementType +Enum.RecipeRequirementType = { + SpellFocus = 0, + Totem = 1, + Area = 2, +} + +---@enum Enum.RecruitAFriendRewardsVersion +Enum.RecruitAFriendRewardsVersion = { + InvalidVersion = 0, + UnusedVersionOne = 1, + VersionTwo = 2, + VersionThree = 3, +} + +---@enum Enum.RegisterAddonMessagePrefixResult +Enum.RegisterAddonMessagePrefixResult = { + Success = 0, + DuplicatePrefix = 1, + InvalidPrefix = 2, + MaxPrefixes = 3, +} + +---@enum Enum.RelativeContentDifficulty +Enum.RelativeContentDifficulty = { + Trivial = 0, + Easy = 1, + Fair = 2, + Difficult = 3, + Impossible = 4, +} + +---@enum Enum.ReleaseType +Enum.ReleaseType = { + Original = 1, + Classic = 2, +} + +---@enum Enum.RenownRewardDisplayType +Enum.RenownRewardDisplayType = { + None = 0, + Item = 1, + Spell = 2, + Mount = 3, + Transmog = 4, + TransmogSet = 5, + TransmogIllusion = 6, + Title = 7, + GarrFollower = 8, + Currency = 9, +} + +---@enum Enum.RenownRewardsFlags +Enum.RenownRewardsFlags = { + Milestone = 0x1, + Capstone = 0x2, + Hidden = 0x4, + AccountUnlock = 0x8, +} + +---@enum Enum.ReportEvidenceType +Enum.ReportEvidenceType = { + Invalid = 0, + HouseScreenshot = 1, + HouseLayoutJson = 2, +} + +---@enum Enum.ReportMajorCategory +Enum.ReportMajorCategory = { + InappropriateCommunication = 0, + GameplaySabotage = 1, + Cheating = 2, + InappropriateName = 3, + InappropriateDecor = 4, +} + +---@enum Enum.ReportMinorCategory +Enum.ReportMinorCategory = { + TextChat = 0x1, + Boosting = 0x2, + Spam = 0x4, + Afk = 0x8, + IntentionallyFeeding = 0x10, + BlockingProgress = 0x20, + Hacking = 0x40, + Botting = 0x80, + Advertisement = 0x100, + BTag = 0x200, + GroupName = 0x400, + CharacterName = 0x800, + GuildName = 0x1000, + Description = 0x2000, + Name = 0x4000, + HarmfulToMinors = 0x8000, + Disruption = 0x10000, + TerroristAndViolentExtremistContent = 0x20000, + ChildSexualExploitationAndAbuse = 0x40000, + NeighborhoodName = 0x80000, +} + +---@enum Enum.ReportSubComplaintTypes +Enum.ReportSubComplaintTypes = { + Inappropriate = 0, + Advertising = 1, +} + +---@enum Enum.ReportThrottleType +Enum.ReportThrottleType = { + Invalid = 0, + General = 1, + Expensive = 2, +} + +---@enum Enum.ReportType +Enum.ReportType = { + Chat = 0, + InWorld = 1, + ClubFinderPosting = 2, + ClubFinderApplicant = 3, + GroupFinderPosting = 4, + GroupFinderApplicant = 5, + ClubMember = 6, + GroupMember = 7, + Friend = 8, + Pet = 9, + BattlePet = 10, + Calendar = 11, + Mail = 12, + PvP = 13, + PvPScoreboard = 14, + PvPGroupMember = 15, + CraftingOrder = 16, + RecentAlly = 17, + HousingDecor = 18, + Neighborhood = 19, + NeighborhoodRoster = 20, +} + +---@enum Enum.ReputationSortType +Enum.ReputationSortType = { + None = 0, + Account = 1, + Character = 2, +} + +---@enum Enum.ReservationFlags +Enum.ReservationFlags = { + None = 0, + Relinquish = 1, + Canceled = 2, + Plotless = 4, +} + +---@enum Enum.ResidentType +Enum.ResidentType = { + Resident = 0, + Manager = 1, + Owner = 2, +} + +---@enum Enum.RestrictPingsTo +Enum.RestrictPingsTo = { + None = 0, + Lead = 1, + Assist = 2, + TankHealer = 3, +} + +---@enum Enum.RetroactiveDecorRewardFlags +Enum.RetroactiveDecorRewardFlags = { + None = 0, + AllCriteriaRequired = 1, +} + +---@enum Enum.RolodexContextIDType +Enum.RolodexContextIDType = { + None = 0, + ItemID = 1, + AreaID = 2, + MapID = 3, +} + +---@enum Enum.RolodexContextLevelType +Enum.RolodexContextLevelType = { + None = 0, + Difficulty = 1, + KeystoneLevel = 2, + DelveTier = 3, +} + +---@enum Enum.RolodexType +Enum.RolodexType = { + None = 0, + PartyMember = 1, + RaidMember = 2, + Trade = 3, + Whisper = 4, + PublicOrderFilledByOther = 5, + PublicOrderFilledByYou = 6, + PersonalOrderFilledByOther = 7, + PersonalOrderFilledByYou = 8, + GuildOrderFilledByOther = 9, + GuildOrderFilledByYou = 10, + CreatureKill = 11, + CompleteDungeon = 12, + KillRaidBoss = 13, + KillLfrBoss = 14, + CompleteDelve = 15, + CompleteArena = 16, + CompleteBg = 17, + Duel = 18, + PetBattle = 19, + PvPKill = 20, +} + +---@enum Enum.RolodexTypeFlags +Enum.RolodexTypeFlags = { + None = 0, + HiddenFromHistory = 1, +} + +---@enum Enum.RoomConnectionType +Enum.RoomConnectionType = { + None = 0, + All = 1, +} + +---@enum Enum.RuneforgePowerFilter +Enum.RuneforgePowerFilter = { + All = 0, + Relevant = 1, + Available = 2, + Unavailable = 3, +} + +---@enum Enum.RuneforgePowerState +Enum.RuneforgePowerState = { + Available = 0, + Unavailable = 1, + Invalid = 2, +} + +---@enum Enum.ScreenLocationType +Enum.ScreenLocationType = { + Center = 0, + Left = 1, + Right = 2, + Top = 3, + Bottom = 4, + TopLeft = 5, + TopRight = 6, + LeftOutside = 7, + RightOutside = 8, + LeftRight = 9, + TopBottom = 10, + LeftRightOutside = 11, +} + +---@enum Enum.ScreenshotSource +Enum.ScreenshotSource = { + Automatic = 0, + PlayerReport = 1, + Cheat = 2, +} + +---@enum Enum.ScriptedAnimationBehavior +Enum.ScriptedAnimationBehavior = { + None = 0, + TargetShake = 1, + TargetKnockBack = 2, + SourceRecoil = 3, + SourceCollideWithTarget = 4, + UIParentShake = 5, +} + +---@enum Enum.ScriptedAnimationFlags +Enum.ScriptedAnimationFlags = { + UseTargetAsSource = 1, +} + +---@enum Enum.ScriptedAnimationTrajectory +Enum.ScriptedAnimationTrajectory = { + AtSource = 0, + AtTarget = 1, + Straight = 2, + CurveLeft = 3, + CurveRight = 4, + CurveRandom = 5, + HalfwayBetween = 6, +} + +---@enum Enum.ScrubStringFlags +Enum.ScrubStringFlags = { + None = 0, + TruncateNewLines = 1, + AllowBarCodes = 2, + StripControlCodes = 4, +} + +---@enum Enum.SeasonID +Enum.SeasonID = { + NoSeason = 0, + SeasonOfMastery = 1, + SeasonOfDiscovery = 2, + Hardcore = 3, + Fresh = 11, + FreshHardcore = 12, +} + +---@enum Enum.SecondsFormatterAbbrevation +Enum.SecondsFormatterAbbrevation = { + None = 0, + Truncate = 1, + OneLetter = 2, +} + +---@enum Enum.SecondsFormatterInterval +Enum.SecondsFormatterInterval = { + Seconds = 0, + Minutes = 1, + Hours = 2, + Days = 3, +} + +---@enum Enum.SecondsFormatterIntervalWhitespace +Enum.SecondsFormatterIntervalWhitespace = { + Preserve = 0, + Strip = 1, + StripIgnoreLocale = 2, +} + +---@enum Enum.SecrecyLevel +Enum.SecrecyLevel = { + NeverSecret = 0, + AlwaysSecret = 1, + ContextuallySecret = 2, +} + +---@enum Enum.SecretAspect +Enum.SecretAspect = { + Attributes = 0x1, + Hierarchy = 0x1, + ObjectDebug = 0x1, + ObjectName = 0x1, + ObjectSecrets = 0x1, + ObjectSecurity = 0x1, + ObjectType = 0x1, + ID = 0x2, + Toplevel = 0x4, + Text = 0x8, + SecureText = 0x10, + Shown = 0x20, + Scale = 0x40, + Alpha = 0x80, + FrameLevel = 0x100, + ScrollRange = 0x200, + Cursor = 0x400, + VertexColor = 0x800, + Desaturation = 0x1000, + TexCoords = 0x2000, + BarValue = 0x4000, + Cooldown = 0x8000, + Rotation = 0x10000, + MinimumWidth = 0x20000, + Padding = 0x40000, + CooldownStyle = 0x80000, + TooltipTexture = 0x100000, +} + +---@enum Enum.SelfResurrectOptionType +Enum.SelfResurrectOptionType = { + Spell = 0, + Item = 1, +} + +---@enum Enum.SendAddonMessageResult +Enum.SendAddonMessageResult = { + Success = 0, + InvalidPrefix = 1, + InvalidMessage = 2, + AddonMessageThrottle = 3, + InvalidChatType = 4, + NotInGroup = 5, + TargetRequired = 6, + InvalidChannel = 7, + ChannelThrottle = 8, + GeneralError = 9, + NotInGuild = 10, + AddOnMessageLockdown = 11, + TargetOffline = 12, +} + +---@enum Enum.SendReportResult +Enum.SendReportResult = { + Success = 0, + GeneralError = 1, + TooManyReports = 2, + RequiresChatLine = 3, + RequiresChatLineOrVoice = 4, + RequiresScreenshot = 5, +} + +---@enum Enum.SharedStringFlag +Enum.SharedStringFlag = { + InternalOnly = 1, +} + +---@enum Enum.ShutdownSessionReason +Enum.ShutdownSessionReason = { + SessionEnded = 0, + RestartSessionCommand = 1, + ForceLogoutCommand = 2, + RealmSelectCommand = 3, + AccountLoginCommand = 4, + LuaScript = 5, + Error = 6, +} + +---@enum Enum.Si3UISoundSubType +Enum.Si3UISoundSubType = { + Default = 0, + Cinematic = 1, + RacialCinematic = 2, + Script = 3, + ScriptAmbience = 4, + ScriptDialog = 5, + ScriptMaster = 6, + ScriptMusic = 7, + ScriptTalkingHead = 8, + VocalError = 9, +} + +---@enum Enum.Siflag +Enum.Siflag = { + None = 0x0, + Disablepositionallpf = 0x1, + UseModCastSpeed = 0x2, + AutocreatedByBroadcastText = 0x4, + Playsequential = 0x8, + Affectedbyaltitude = 0x10, + Noduplicates = 0x20, + Ignoresuppressors = 0x40, + CasterOwnsTargetSound = 0x80, + Dontplayindoors = 0x100, + Looping = 0x200, + Dontplayunderwater = 0x400, + Affectedbysanity = 0x800, + Dontstopondeath = 0x1000, + Playonlyforowner = 0x2000, + Ignorevopriority = 0x4000, + Onlyplayindoors = 0x8000, + Onlyplayunderwater = 0x10000, +} + +---@enum Enum.SimpleOrderStatus +Enum.SimpleOrderStatus = { + Invalid = 0, + Creating = 1, + InProgress = 2, + Success = 3, + Failed = 4, +} + +---@enum Enum.SkinningState +Enum.SkinningState = { + None = 0, + Reserved = 1, + Skinning = 2, + Looting = 3, + Skinned = 4, +} + +---@enum Enum.SleevesGeoRange +Enum.SleevesGeoRange = { + None = 0, + Default = 1, + Flared = 2, + Puffy = 3, + PandaCollar = 4, +} + +---@enum Enum.SlotRegion +Enum.SlotRegion = { + Invalid = 0, + PlayerEquip = 1, + PlayerBags = 2, + PlayerInv = 3, + CharacterBank = 4, + AccountBank = 5, +} + +---@enum Enum.SlotRegionMask +Enum.SlotRegionMask = { + Invalid = 0x1, + PlayerEquip = 0x2, + PlayerBags = 0x4, + PlayerInv = 0x8, + CharacterBank = 0x10, + AccountBank = 0x40, +} + +---@enum Enum.SocialWhoOrigin +Enum.SocialWhoOrigin = { + Unknown = 0, + Social = 1, + Chat = 2, + Item = 3, +} + +---@enum Enum.SoftTargetEnableFlags +Enum.SoftTargetEnableFlags = { + None = 0, + Gamepad = 1, + Kbm = 2, + Any = 3, +} + +---@enum Enum.SortPlayersBy +Enum.SortPlayersBy = { + Role = 0, + Group = 1, + Alphabetical = 2, +} + +---@enum Enum.SoulbindConduitFlags +Enum.SoulbindConduitFlags = { + VisibleToGetallsoulbindconduitScript = 1, +} + +---@enum Enum.SoulbindConduitInstallResult +Enum.SoulbindConduitInstallResult = { + Success = 0, + InvalidItem = 1, + InvalidConduit = 2, + InvalidTalent = 3, + DuplicateConduit = 4, + ForgeNotInProximity = 5, + SocketNotEmpty = 6, +} + +---@enum Enum.SoulbindConduitTransactionType +Enum.SoulbindConduitTransactionType = { + Install = 0, + Uninstall = 1, +} + +---@enum Enum.SoulbindConduitType +Enum.SoulbindConduitType = { + Finesse = 0, + Potency = 1, + Endurance = 2, + Flex = 3, +} + +---@enum Enum.SoulbindNodeState +Enum.SoulbindNodeState = { + Unavailable = 0, + Unselected = 1, + Selectable = 2, + Selected = 3, +} + +---@enum Enum.SoundBusFlag +Enum.SoundBusFlag = { + Disablepositionallpf = 1, +} + +---@enum Enum.SpecializationSystem +Enum.SpecializationSystem = { + TalentTab = 0, + ChrSpecialization = 1, +} + +---@enum Enum.SpellAuraVisibilityType +Enum.SpellAuraVisibilityType = { + RaidInCombat = 0, + RaidOutOfCombat = 1, + EnemyTarget = 2, +} + +---@enum Enum.SpellBookItemType +Enum.SpellBookItemType = { + None = 0, + Spell = 1, + FutureSpell = 2, + PetAction = 3, + Flyout = 4, +} + +---@enum Enum.SpellBookSkillLineIndex +Enum.SpellBookSkillLineIndex = { + General = 1, + Class = 2, + MainSpec = 3, + OffSpecStart = 4, +} + +---@enum Enum.SpellBookSpellBank +Enum.SpellBookSpellBank = { + Player = 0, + Pet = 1, +} + +---@enum Enum.SpellDiminishCategory +Enum.SpellDiminishCategory = { + Root = 0, + Taunt = 1, + Stun = 2, + AoEKnockback = 3, + Incapacitate = 4, + Disorient = 5, + Silence = 6, + Disarm = 7, +} + +---@enum Enum.SpellDiminishRuleset +Enum.SpellDiminishRuleset = { + None = 0, + PvE = 1, + PvP = 2, +} + +---@enum Enum.SpellDisplayBorderColor +Enum.SpellDisplayBorderColor = { + None = 0, + Black = 1, + White = 2, + Red = 3, + Yellow = 4, + Orange = 5, + Purple = 6, + Green = 7, + Blue = 8, +} + +---@enum Enum.SpellDisplayIconDisplayType +Enum.SpellDisplayIconDisplayType = { + Buff = 0, + Debuff = 1, + Circular = 2, + NoBorder = 3, +} + +---@enum Enum.SpellDisplayTextShownStateType +Enum.SpellDisplayTextShownStateType = { + Shown = 0, + Hidden = 1, +} + +---@enum Enum.SpellDisplayTint +Enum.SpellDisplayTint = { + None = 0, + Red = 1, +} + +---@enum Enum.SplashScreenType +Enum.SplashScreenType = { + WhatsNew = 0, + SeasonRollOver = 1, +} + +---@enum Enum.StableResult +Enum.StableResult = { + MaxSlots = 0, + InsufficientFunds = 1, + NotStableMaster = 2, + InvalidSlot = 3, + NoPet = 4, + AlreadyStabled = 5, + AlreadySummoned = 6, + NotFound = 7, + StableSuccess = 8, + UnstableSuccess = 9, + ReviveSuccess = 10, + CantControlExotic = 11, + InternalError = 12, + CheckForLuaHack = 13, + BuySlotSuccess = 14, + FavoriteToggle = 15, + PetRenamed = 16, +} + +---@enum Enum.StartTimerType +Enum.StartTimerType = { + PvPBeginTimer = 0, + ChallengeModeCountdown = 1, + PlayerCountdown = 2, + PlunderstormCountdown = 3, +} + +---@enum Enum.StatusBarColorTintValue +Enum.StatusBarColorTintValue = { + None = 0, + Black = 1, + White = 2, + Red = 3, + Yellow = 4, + Orange = 5, + Purple = 6, + Green = 7, + Blue = 8, +} + +---@enum Enum.StatusBarFillStyle +Enum.StatusBarFillStyle = { + Standard = 0, + StandardNoRangeFill = 1, + Center = 2, + Reverse = 3, +} + +---@enum Enum.StatusBarInterpolation +Enum.StatusBarInterpolation = { + Immediate = 0, + ExponentialEaseOut = 1, +} + +---@enum Enum.StatusBarOverrideBarTextShownType +Enum.StatusBarOverrideBarTextShownType = { + Never = 0, + Always = 1, + OnlyOnMouseover = 2, + OnlyNotOnMouseover = 3, +} + +---@enum Enum.StatusBarTimerDirection +Enum.StatusBarTimerDirection = { + ElapsedTime = 0, + RemainingTime = 1, +} + +---@enum Enum.StatusBarValueTextType +Enum.StatusBarValueTextType = { + Hidden = 0, + Percentage = 1, + Value = 2, + Time = 3, + TimeShowOneLevelOnly = 4, + ValueOverMax = 5, + ValueOverMaxNormalized = 6, +} + +---@enum Enum.SubcontainerType +Enum.SubcontainerType = { + Bag = 0, + Equipped = 1, + Bankgeneric = 2, + Bankbag = 3, + Mail = 4, + Auction = 5, + Keyring = 6, + GuildBank0 = 7, + GuildBank1 = 8, + GuildBank2 = 9, + GuildBank3 = 10, + GuildBank4 = 11, + GuildBank5 = 12, + GuildOverflow = 13, + Equipablespells = 14, + CurrencytokenOboslete = 15, + GuildBank6 = 16, + GuildBank7 = 17, + GuildBank8 = 18, + GuildBank9 = 19, + GuildBank10 = 20, + GuildBank11 = 21, + Reagentbank = 22, + Childequipmentstorage = 23, + Quarantine = 24, + CreatedImmediately = 25, + BuybackSlots = 26, + CachedReward = 27, + EquippedBags = 28, + EquippedProfession1 = 29, + EquippedProfession2 = 30, + EquippedCooking = 31, + EquippedFishing = 32, + EquippedReagentbag = 33, + CraftingOrder = 34, + CraftingOrderReagents = 35, + AccountBankTabs = 36, + CurrencyTransfer = 37, + CharacterBankTabs = 38, + HousingDecorConversion = 39, +} + +---@enum Enum.SubscriptionInterstitialResponseType +Enum.SubscriptionInterstitialResponseType = { + Clicked = 0, + Closed = 1, + WebRedirect = 2, +} + +---@enum Enum.SubscriptionInterstitialType +Enum.SubscriptionInterstitialType = { + Standard = 0, + LeftNpeArea = 1, + MaxLevel = 2, +} + +---@enum Enum.SummonReason +Enum.SummonReason = { + Spell = 0, + Scenario = 1, +} + +---@enum Enum.SummonStatus +Enum.SummonStatus = { + None = 0, + Pending = 1, + Accepted = 2, + Declined = 3, +} + +---@enum Enum.SuperTrackingMapPinType +Enum.SuperTrackingMapPinType = { + AreaPOI = 0, + QuestOffer = 1, + TaxiNode = 2, + DigSite = 3, + HousingPlot = 4, +} + +---@enum Enum.SuperTrackingType +Enum.SuperTrackingType = { + Quest = 0, + UserWaypoint = 1, + Corpse = 2, + Scenario = 3, + Content = 4, + PartyMember = 5, + MapPin = 6, + Vignette = 7, +} + +---@enum Enum.SurveyDeliveryFlags +Enum.SurveyDeliveryFlags = { + None = 0, + EncounterSucccessOnly = 1, +} + +---@enum Enum.SurveyDeliveryMoment +Enum.SurveyDeliveryMoment = { + Login = 0, + ProfessionTable = 1, + QuestTurnIn = 2, + ChestLooted = 3, + MythicPlusCompleted = 4, + EncounterEnd = 5, +} + +---@enum Enum.TableSecurityOption +Enum.TableSecurityOption = { + DisallowTaintedAccess = 0, + DisallowSecretKeys = 1, + SecretWrapContents = 2, +} + +---@enum Enum.TieredEntranceRewardType +Enum.TieredEntranceRewardType = { + Item = 0, + Currency = 1, +} + +---@enum Enum.TieredEntranceType +Enum.TieredEntranceType = { + Invalid = 0, + Delve = 1, + Sites = 2, + Reserved = 3, +} + +---@enum Enum.TimeEventFlag +Enum.TimeEventFlag = { + GlueScreenShortcut = 1, + WeeklyReset = 2, + GlobalLaunch = 4, +} + +---@enum Enum.TitleIconVersion +Enum.TitleIconVersion = { + Small = 0, + Medium = 1, + Large = 2, +} + +---@enum Enum.TooltipComparisonMethod +Enum.TooltipComparisonMethod = { + Single = 0, + WithBothHands = 1, + WithBagMainHandItem = 2, + WithBagOffHandItem = 3, +} + +---@enum Enum.TooltipDataItemBinding +Enum.TooltipDataItemBinding = { + Quest = 0, + Account = 1, + BnetAccount = 2, + Soulbound = 3, + BindToAccount = 4, + BindToBnetAccount = 5, + BindOnPickup = 6, + BindOnEquip = 7, + BindOnUse = 8, + AccountUntilEquipped = 9, + BindToAccountUntilEquipped = 10, +} + +---@enum Enum.TooltipDataLineType +Enum.TooltipDataLineType = { + None = 0, + Blank = 1, + UnitName = 2, + GemSocket = 3, + AzeriteEssenceSlot = 4, + AzeriteEssencePower = 5, + LearnableSpell = 6, + UnitThreat = 7, + QuestObjective = 8, + AzeriteItemPowerDescription = 9, + RuneforgeLegendaryPowerDescription = 10, + SellPrice = 11, + ProfessionCraftingQuality = 12, + SpellName = 13, + CurrencyTotal = 14, + ItemEnchantmentPermanent = 15, + UnitOwner = 16, + QuestTitle = 17, + QuestPlayer = 18, + NestedBlock = 19, + ItemBinding = 20, + EquipSlot = 21, + ItemName = 22, + Separator = 23, + ToyName = 24, + ToyText = 25, + ToyEffect = 26, + ToyDuration = 27, + ToyDescription = 28, + ToySource = 29, + GemSocketEnchantment = 30, + ItemLevel = 31, + ItemUpgradeLevel = 32, + SpellPassive = 33, + SpellDescription = 34, + ItemQuality = 35, + TradeTimeRemaining = 36, + FlavorText = 37, + ItemSpellTriggerLearn = 38, + LearnTransmogSet = 39, + LearnTransmogIllusion = 40, + ErrorLine = 41, + DisabledLine = 42, + UsageRequirement = 43, +} + +---@enum Enum.TooltipDataType +Enum.TooltipDataType = { + Item = 0, + Spell = 1, + Unit = 2, + Corpse = 3, + Object = 4, + Currency = 5, + BattlePet = 6, + UnitAura = 7, + AzeriteEssence = 8, + CompanionPet = 9, + Mount = 10, + PetAction = 11, + Achievement = 12, + EnhancedConduit = 13, + EquipmentSet = 14, + InstanceLock = 15, + PvPBrawl = 16, + RecipeRankInfo = 17, + Totem = 18, + Toy = 19, + CorruptionCleanser = 20, + MinimapMouseover = 21, + Flyout = 22, + Quest = 23, + QuestPartyProgress = 24, + Macro = 25, + Debug = 26, + Outfit = 27, +} + +---@enum Enum.TooltipDataUsageRequirementType +Enum.TooltipDataUsageRequirementType = { + RaceClass = 0, + Faction = 1, + Skill = 2, + PvPMedal = 3, + Reputation = 4, + Level = 5, + Guild = 6, + Achievement = 7, + PvPRank = 8, + EquippedItem = 9, + ShapeshiftForm = 10, + ArenaRating = 11, + EarnCurrency = 12, + Specialization = 13, + NotAlreadyKnown = 14, + NotInArena = 15, + NotInRatedBg = 16, +} + +---@enum Enum.TooltipSide +Enum.TooltipSide = { + Left = 0, + Right = 1, + Top = 2, + Bottom = 3, +} + +---@enum Enum.TooltipTextureAnchor +Enum.TooltipTextureAnchor = { + LeftTop = 0, + LeftCenter = 1, + LeftBottom = 2, + RightTop = 3, + RightCenter = 4, + RightBottom = 5, + All = 6, +} + +---@enum Enum.TooltipTextureRelativeRegion +Enum.TooltipTextureRelativeRegion = { + LeftLine = 0, + RightLine = 1, +} + +---@enum Enum.TrackedSpellCategory +Enum.TrackedSpellCategory = { + None = 0, + Offensive = 1, + Defensive = 2, + Debuff = 3, + RacialAbility = 4, +} + +---@enum Enum.TradeskillOrderDuration +Enum.TradeskillOrderDuration = { + Short = 1, + Medium = 2, + Long = 3, +} + +---@enum Enum.TradeskillOrderRecipient +Enum.TradeskillOrderRecipient = { + Public = 1, + Guild = 2, + Private = 3, +} + +---@enum Enum.TradeskillOrderStatus +Enum.TradeskillOrderStatus = { + Unclaimed = 1, + Started = 2, + Completed = 3, + Expired = 4, +} + +---@enum Enum.TradeskillRecipeType +Enum.TradeskillRecipeType = { + Item = 1, + Salvage = 2, + Enchant = 3, + Gathering = 4, +} + +---@enum Enum.TradeskillRelativeDifficulty +Enum.TradeskillRelativeDifficulty = { + Optimal = 0, + Medium = 1, + Easy = 2, + Trivial = 3, +} + +---@enum Enum.TradeskillSlotDataType +Enum.TradeskillSlotDataType = { + Reagent = 1, + ModifiedReagent = 2, + Currency = 3, +} + +---@enum Enum.TraitCombatConfigFlags +Enum.TraitCombatConfigFlags = { + ActiveForSpec = 1, + StarterBuild = 2, + SharedActionBars = 4, +} + +---@enum Enum.TraitCondFlag +Enum.TraitCondFlag = { + IsGate = 1, + IsAlwaysMet = 2, + IsSufficient = 4, +} + +---@enum Enum.TraitConditionType +Enum.TraitConditionType = { + Available = 0, + Visible = 1, + Granted = 2, + Increased = 3, + DisplayError = 4, + RanksAllowed = 5, +} + +---@enum Enum.TraitConfigDbState +Enum.TraitConfigDbState = { + Ready = 0, + Created = 1, + Removed = 2, + Deleted = 3, +} + +---@enum Enum.TraitConfigType +Enum.TraitConfigType = { + Invalid = 0, + Combat = 1, + Profession = 2, + Generic = 3, +} + +---@enum Enum.TraitCurrencyFlag +Enum.TraitCurrencyFlag = { + ShowQuantityAsSpent = 0x1, + TraitSourcedShowMax = 0x2, + UseClassIcon = 0x4, + UseSpecIcon = 0x8, +} + +---@enum Enum.TraitCurrencyType +Enum.TraitCurrencyType = { + Gold = 0, + CurrencyTypesBased = 1, + TraitSourced = 2, + TraitSourcedPlayerDataElement = 3, +} + +---@enum Enum.TraitDefinitionSubType +Enum.TraitDefinitionSubType = { + DragonflightRed = 0, + DragonflightBlue = 1, + DragonflightGreen = 2, + DragonflightBronze = 3, + DragonflightBlack = 4, +} + +---@enum Enum.TraitEdgeType +Enum.TraitEdgeType = { + VisualOnly = 0, + DeprecatedRankConnection = 1, + SufficientForAvailability = 2, + RequiredForAvailability = 3, + MutuallyExclusive = 4, + DeprecatedSelectionOption = 5, +} + +---@enum Enum.TraitEdgeVisualStyle +Enum.TraitEdgeVisualStyle = { + None = 0, + Straight = 1, +} + +---@enum Enum.TraitNodeEntryType +Enum.TraitNodeEntryType = { + SpendHex = 0, + SpendSquare = 1, + SpendCircle = 2, + SpendSmallCircle = 3, + DeprecatedSelect = 4, + DragAndDrop = 5, + SpendDiamond = 6, + ProfPath = 7, + ProfPerk = 8, + ProfPathUnlock = 9, + RedButton = 10, + ArmorSet = 11, + SpendInfinite = 12, + SpendCapstoneCircle = 13, + SpendCapstoneSquare = 14, +} + +---@enum Enum.TraitNodeFlag +Enum.TraitNodeFlag = { + ShowMultipleIcons = 0x1, + NeverPurchasable = 0x2, + TestPositionLocked = 0x4, + TestGridPositioned = 0x8, + ActiveAtFirstRank = 0x10, + ShowExpandedSelection = 0x20, + HideMaxRank = 0x40, + HighestChosenRank = 0x80, + ShowTierTrack = 0x100, +} + +---@enum Enum.TraitNodeGroupFlag +Enum.TraitNodeGroupFlag = { + AvailableByDefault = 1, +} + +---@enum Enum.TraitNodeType +Enum.TraitNodeType = { + Single = 0, + Tiered = 1, + Selection = 2, + SubTreeSelection = 3, +} + +---@enum Enum.TraitPointsOperationType +Enum.TraitPointsOperationType = { + None = -1, + Set = 0, + Multiply = 1, +} + +---@enum Enum.TraitSystemFlag +Enum.TraitSystemFlag = { + AllowMultipleLoadoutsPerTree = 0x1, + ShowSpendConfirmation = 0x2, + AllowEditInCombat = 0x4, + AllowEditInChallengeMode = 0x8, +} + +---@enum Enum.TraitSystemVariationType +Enum.TraitSystemVariationType = { + None = 0, + Spec = 1, +} + +---@enum Enum.TraitTreeFlag +Enum.TraitTreeFlag = { + CannotRefund = 1, + HideSingleRankNumbers = 2, +} + +---@enum Enum.TransformManipulatorAxis +Enum.TransformManipulatorAxis = { + X = 1, + Y = 2, + Z = 4, +} + +---@enum Enum.TransformManipulatorControlState +Enum.TransformManipulatorControlState = { + Default = 0, + Hidden = 1, + Dimmed = 2, + ExternallyHighlighted = 3, + Hovered = 4, + Selected = 5, + Moving = 6, +} + +---@enum Enum.TransformManipulatorDirection +Enum.TransformManipulatorDirection = { + Positive = 0, + Negative = 1, +} + +---@enum Enum.TransformManipulatorEvent +Enum.TransformManipulatorEvent = { + Start = 0, + Change = 1, + Complete = 2, + Cancel = 3, + Hover = 4, + MouseDown = 5, + MouseUp = 6, +} + +---@enum Enum.TransformManipulatorMode +Enum.TransformManipulatorMode = { + Translate = 0, + Rotate = 1, + Scale = 2, +} + +---@enum Enum.TransmogCameraVariation +Enum.TransmogCameraVariation = { + None = 0, + CloakBackpack = 1, + RightShoulder = 1, +} + +---@enum Enum.TransmogCollectionType +Enum.TransmogCollectionType = { + None = 0, + Head = 1, + Shoulder = 2, + Back = 3, + Chest = 4, + Shirt = 5, + Tabard = 6, + Wrist = 7, + Hands = 8, + Waist = 9, + Legs = 10, + Feet = 11, + Wand = 12, + OneHAxe = 13, + OneHSword = 14, + OneHMace = 15, + Dagger = 16, + Fist = 17, + Shield = 18, + Holdable = 19, + TwoHAxe = 20, + TwoHSword = 21, + TwoHMace = 22, + Staff = 23, + Polearm = 24, + Bow = 25, + Gun = 26, + Crossbow = 27, + Warglaives = 28, + Paired = 29, +} + +---@enum Enum.TransmogIllusionFlags +Enum.TransmogIllusionFlags = { + HideUntilCollected = 1, + PlayerConditionGrantsOnLogin = 2, + AllowedRangedShieldsHoldables = 4, +} + +---@enum Enum.TransmogModification +Enum.TransmogModification = { + Main = 0, + Secondary = 1, +} + +---@enum Enum.TransmogOutfitCostModifiersApplied +Enum.TransmogOutfitCostModifiersApplied = { + DebugOnlyFreeDiscountApplied = 0x1, + VoidRacialDiscountApplied = 0x2, + OutfitCostModifierApplied = 0x4, + AuraDiscountApplied = 0x8, +} + +---@enum Enum.TransmogOutfitDataFlags +Enum.TransmogOutfitDataFlags = { + IsCachedLocally = 1, +} + +---@enum Enum.TransmogOutfitDisplayType +Enum.TransmogOutfitDisplayType = { + Unassigned = 0, + Assigned = 1, + Equipped = 2, + Hidden = 3, + Disabled = 4, +} + +---@enum Enum.TransmogOutfitEntryFlags +Enum.TransmogOutfitEntryFlags = { + AutomaticallyAwardedOnLogin = 0x1, + UseOverrideName = 0x2, + OnlyAvailableDuringEvent = 0x4, + SortedToTopOfList = 0x8, + UseOverrideCostModifier = 0x10, + IsDefaultEquipped = 0x20, +} + +---@enum Enum.TransmogOutfitEntrySource +Enum.TransmogOutfitEntrySource = { + StampedSource = 0, + AutomaticallyAwarded = 1, + PlayerPurchased = 2, +} + +---@enum Enum.TransmogOutfitEquipAction +Enum.TransmogOutfitEquipAction = { + Equip = 0, + EquipAndLock = 1, + Remove = 2, + RemoveAndLock = 3, + Unlock = 4, + Lock = 5, +} + +---@enum Enum.TransmogOutfitSetType +Enum.TransmogOutfitSetType = { + Equipped = 0, + Outfit = 1, + CustomSet = 2, +} + +---@enum Enum.TransmogOutfitSlot +Enum.TransmogOutfitSlot = { + Head = 0, + ShoulderRight = 1, + ShoulderLeft = 2, + Back = 3, + Chest = 4, + Tabard = 5, + Body = 6, + Wrist = 7, + Hand = 8, + Waist = 9, + Legs = 10, + Feet = 11, + WeaponMainHand = 12, + WeaponOffHand = 13, + WeaponRanged = 14, +} + +---@enum Enum.TransmogOutfitSlotError +Enum.TransmogOutfitSlotError = { + Ok = 0, + NoItem = 1, + NotSoulbound = 2, + Legendary = 3, + InvalidItemType = 4, + InvalidDestination = 5, + Mismatch = 6, + SameItem = 7, + InvalidSource = 8, + InvalidSourceQuality = 9, + CannotUseItem = 10, + InvalidSlotForRace = 11, + NoIllusion = 12, + InvalidSlotForForm = 13, + IncompatibleWithMainHand = 14, +} + +---@enum Enum.TransmogOutfitSlotFlags +Enum.TransmogOutfitSlotFlags = { + CannotBeHidden = 1, + CanHaveIllusions = 2, + IsSecondarySlot = 4, +} + +---@enum Enum.TransmogOutfitSlotOption +Enum.TransmogOutfitSlotOption = { + None = 0, + OneHandedWeapon = 1, + TwoHandedWeapon = 2, + RangedWeapon = 3, + OffHand = 4, + Shield = 5, + DeprecatedReuseMe = 6, + FuryTwoHandedWeapon = 7, + ArtifactSpecOne = 8, + ArtifactSpecTwo = 9, + ArtifactSpecThree = 10, + ArtifactSpecFour = 11, +} + +---@enum Enum.TransmogOutfitSlotOptionFlags +Enum.TransmogOutfitSlotOptionFlags = { + IllusionNotAllowed = 1, + DynamicOptionName = 2, + DisablesOffhandSlot = 4, +} + +---@enum Enum.TransmogOutfitSlotOptionSheatheCategory +Enum.TransmogOutfitSlotOptionSheatheCategory = { + Default = 0, + Back = 1, + Side = 2, + Hide = 3, +} + +---@enum Enum.TransmogOutfitSlotPosition +Enum.TransmogOutfitSlotPosition = { + Left = 0, + Right = 1, + Bottom = 2, +} + +---@enum Enum.TransmogOutfitSlotSaveFlags +Enum.TransmogOutfitSlotSaveFlags = { + AppearanceIsNotValid = 1, +} + +---@enum Enum.TransmogOutfitSlotWarning +Enum.TransmogOutfitSlotWarning = { + Ok = 0, + InvalidEquippedDestinationItem = 1, + WrongWeaponCategoryEquipped = 2, + PendingWeaponChanges = 3, + WeaponDoesNotSupportIllusions = 4, + NothingEquipped = 5, +} + +---@enum Enum.TransmogOutfitTransactionFlags +Enum.TransmogOutfitTransactionFlags = { + UpdateMetadata = 0x1, + UpdateOutfitInfo = 0x2, + CreateOutfitInfo = 0x4, + CreateAndUpdateOutfitInfoMask = 0x6, + UpdateSlots = 0x8, + UpdateSituations = 0x10, + UpdateSituationsMask = 0x12, + AddNewOutfitMask = 0x14, + FullOutfitUpdateMask = 0x1B, + AddOutfitAndUpdateSlots = 0x1C, +} + +---@enum Enum.TransmogOutfitTransactionType +Enum.TransmogOutfitTransactionType = { + UpdateMetadata = 0, + UpdateOutfitInfo = 1, + CreateOutfitInfo = 2, + UpdateSlots = 3, + UpdateSituations = 4, +} + +---@enum Enum.TransmogPendingType +Enum.TransmogPendingType = { + Apply = 0, + Revert = 1, + ToggleOn = 2, + ToggleOff = 3, +} + +---@enum Enum.TransmogSearchType +Enum.TransmogSearchType = { + Items = 1, + BaseSets = 2, + UsableSets = 3, +} + +---@enum Enum.TransmogSituation +Enum.TransmogSituation = { + AllSpecs = 0, + Spec = 1, + AllLocations = 2, + LocationRested = 3, + LocationHouse = 4, + LocationCharacterSelect = 5, + LocationWorld = 6, + LocationDelves = 7, + LocationDungeons = 8, + LocationRaids = 9, + LocationArenas = 10, + LocationBattlegrounds = 11, + AllMovement = 12, + MovementUnmounted = 13, + MovementSwimming = 14, + MovementGroundMount = 15, + MovementFlyingMount = 16, + AllEquipmentSets = 17, + EquipmentSets = 18, + AllRacialForms = 19, + FormNative = 20, + FormNonNative = 21, + AllWeather = 22, + WeatherClear = 23, + WeatherRain = 24, + WeatherSnow = 25, + WeatherSand = 26, + AllTime = 27, + TimeMorning = 28, + TimeDay = 29, + TimeEvening = 30, + TimeNight = 31, +} + +---@enum Enum.TransmogSituationFlags +Enum.TransmogSituationFlags = { + IsPlayerFacing = 0x1, + SpecUseTalentLoadout = 0x2, + AllSituation = 0x4, + DefaultsToOn = 0x8, + DynamicallyNamed = 0x10, + NoneSituation = 0x20, + DisabledSituation = 0x40, +} + +---@enum Enum.TransmogSituationGroupFlags +Enum.TransmogSituationGroupFlags = { + DynamicallyCreatesGroups = 1, +} + +---@enum Enum.TransmogSituationTrigger +Enum.TransmogSituationTrigger = { + None = 0, + Manual = 1, + TransmogUpdate = 2, + Location = 3, + Movement = 4, + Specialization = 5, + EquipmentSet = 6, + Forms = 7, + EventOutfit = 8, + Weather = 9, + TimeOfDay = 10, +} + +---@enum Enum.TransmogSituationTriggerFlags +Enum.TransmogSituationTriggerFlags = { + CanLockOutfit = 0x1, + CanChangeLockedOutfit = 0x2, + IsPlayerFacing = 0x4, + SituationsAreExclusive = 0x8, + DisabledTrigger = 0x10, +} + +---@enum Enum.TransmogSituationTriggerType +Enum.TransmogSituationTriggerType = { + None = 0, + Manual = 1, + Automatic = 2, + TransmogUpdate = 3, +} + +---@enum Enum.TransmogSlot +Enum.TransmogSlot = { + Head = 0, + Shoulder = 1, + Back = 2, + Chest = 3, + Body = 4, + Tabard = 5, + Wrist = 6, + Hand = 7, + Waist = 8, + Legs = 9, + Feet = 10, + Mainhand = 11, + Offhand = 12, +} + +---@enum Enum.TransmogSource +Enum.TransmogSource = { + None = 0, + JournalEncounter = 1, + Quest = 2, + Vendor = 3, + WorldDrop = 4, + HiddenUntilCollected = 5, + CantCollect = 6, + Achievement = 7, + Profession = 8, + NotValidForTransmog = 9, + TradingPost = 10, +} + +---@enum Enum.TransmogTimeOfDayCategory +Enum.TransmogTimeOfDayCategory = { + Morning = 0, + Midday = 1, + Evening = 2, + Night = 3, +} + +---@enum Enum.TransmogType +Enum.TransmogType = { + Appearance = 0, + Illusion = 1, +} + +---@enum Enum.TransmogUseErrorType +Enum.TransmogUseErrorType = { + None = 0, + PlayerCondition = 1, + Skill = 2, + Ability = 3, + Reputation = 4, + Holiday = 5, + HotRecheckFailed = 6, + Class = 7, + Race = 8, + Faction = 9, + ItemProficiency = 10, +} + +---@enum Enum.TtsBoolSetting +Enum.TtsBoolSetting = { + PlaySoundSeparatingChatLineBreaks = 0, + AddCharacterNameToSpeech = 1, + PlayActivitySoundWhenNotFocused = 2, + AlternateSystemVoice = 3, + NarrateMyMessages = 4, +} + +---@enum Enum.TtsVoiceType +Enum.TtsVoiceType = { + Standard = 0, + Alternate = 1, +} + +---@enum Enum.TugOfWarMarkerArrowShownState +Enum.TugOfWarMarkerArrowShownState = { + Never = 0, + Always = 1, + FlashOnMove = 2, +} + +---@enum Enum.TugOfWarStyleValue +Enum.TugOfWarStyleValue = { + DefaultYellow = 0, + ArchaeologyBrown = 1, +} + +---@enum Enum.TurnStrafeStyle +Enum.TurnStrafeStyle = { + Modern = 0, + Legacy = 1, + Custom = 2, +} + +---@enum Enum.UIActionType +Enum.UIActionType = { + DefaultAction = 0, + UpdateMapSystem = 1, +} + +---@enum Enum.UICovenantDisplayInfoFlags +Enum.UICovenantDisplayInfoFlags = { + DisplayCovenantAsJourney = 1, + UseJourneyRewardTrack = 2, + UseJourneyUnlockToastText = 3, +} + +---@enum Enum.UICursorType +Enum.UICursorType = { + Default = 0, + Item = 1, + Money = 2, + Spell = 3, + PetAction = 4, + Merchant = 5, + ActionBar = 6, + Macro = 7, + AmmoObsolete = 8, + Pet = 9, + GuildBank = 10, + GuildBankMoney = 11, + EquipmentSet = 12, + Currency = 13, + Flyout = 14, + VoidItem = 15, + BattlePet = 16, + Mount = 17, + Toy = 18, + ConduitCollectionItem = 19, + PerksProgramVendorItem = 20, + Outfit = 21, +} + +---@enum Enum.UIFrameType +Enum.UIFrameType = { + JailersTowerBuffs = 0, + InterruptTutorial = 1, +} + +---@enum Enum.UIItemInteractionFlags +Enum.UIItemInteractionFlags = { + DisplayWithInset = 0x1, + ConfirmationHasDelay = 0x2, + ConversionMode = 0x4, + ClickShowsFlyout = 0x8, + AddCurrency = 0x10, + UsesCharges = 0x20, +} + +---@enum Enum.UIItemInteractionType +Enum.UIItemInteractionType = { + None = 0, + CastSpell = 1, + CleanseCorruption = 2, + RunecarverScrapping = 3, + ItemConversion = 4, +} + +---@enum Enum.UIMapFlag +Enum.UIMapFlag = { + NoHighlight = 0x1, + ShowOverlays = 0x2, + ShowTaxiNodes = 0x4, + GarrisonMap = 0x8, + FallbackToParentMap = 0x10, + NoHighlightTexture = 0x20, + ShowTaskObjectives = 0x40, + NoWorldPositions = 0x80, + HideArchaeologyDigs = 0x100, + DoNotTranslateBranches = 0x200, + HideIcons = 0x400, + HideVignettes = 0x800, + ForceAllOverlayExplored = 0x1000, + FlightMapShowZoomOut = 0x2000, + FlightMapAutoZoom = 0x4000, + ForceOnNavbar = 0x8000, + AlwaysAllowUserWaypoints = 0x10000, + AlwaysAllowTaxiPathing = 0x20000, + ForceAllowMapLinks = 0x40000, + DoNotShowOnNavbar = 0x80000, + IsCityMap = 0x100000, + IgnoreInTranslationsToParent = 0x200000, +} + +---@enum Enum.UIMapGroupFlag +Enum.UIMapGroupFlag = { + ShowIconsAcrossFloors = 1, +} + +---@enum Enum.UIMapSystem +Enum.UIMapSystem = { + World = 0, + Taxi = 1, + Adventure = 2, + Minimap = 3, +} + +---@enum Enum.UIMapType +Enum.UIMapType = { + Cosmic = 0, + World = 1, + Continent = 2, + Zone = 3, + Dungeon = 4, + Micro = 5, + Orphan = 6, +} + +---@enum Enum.UIModelSceneActorFlag +Enum.UIModelSceneActorFlag = { + Deprecated1 = 0x1, + UseCenterForOriginX = 0x2, + UseCenterForOriginY = 0x4, + UseCenterForOriginZ = 0x8, +} + +---@enum Enum.UIModelSceneContext +Enum.UIModelSceneContext = { + None = -1, + PerksProgram = 0, +} + +---@enum Enum.UIModelSceneFlags +Enum.UIModelSceneFlags = { + SheatheWeapon = 0x1, + HideWeapon = 0x2, + Autodress = 0x4, + NoCameraSpin = 0x8, +} + +---@enum Enum.UISystemType +Enum.UISystemType = { + InGameNavigation = 0, +} + +---@enum Enum.UITextureSliceMode +Enum.UITextureSliceMode = { + Stretched = 0, + Tiled = 1, +} + +---@enum Enum.UIWidgetBlendModeType +Enum.UIWidgetBlendModeType = { + Opaque = 0, + Additive = 1, +} + +---@enum Enum.UIWidgetButtonEnabledState +Enum.UIWidgetButtonEnabledState = { + Disabled = 0, + Enabled = 1, +} + +---@enum Enum.UIWidgetButtonIconType +Enum.UIWidgetButtonIconType = { + Exit = 0, + Speak = 1, + Undo = 2, + Checkmark = 3, + RedX = 4, +} + +---@enum Enum.UIWidgetFlag +Enum.UIWidgetFlag = { + UniversalWidget = 1, +} + +---@enum Enum.UIWidgetFontType +Enum.UIWidgetFontType = { + Normal = 0, + Shadow = 1, + Outline = 2, +} + +---@enum Enum.UIWidgetHorizontalDirection +Enum.UIWidgetHorizontalDirection = { + LeftToRight = 0, + RightToLeft = 1, +} + +---@enum Enum.UIWidgetLayoutDirection +Enum.UIWidgetLayoutDirection = { + Default = 0, + Vertical = 1, + Horizontal = 2, + Overlap = 3, + HorizontalForceNewRow = 4, +} + +---@enum Enum.UIWidgetModelSceneLayer +Enum.UIWidgetModelSceneLayer = { + None = 0, + Front = 1, + Back = 2, +} + +---@enum Enum.UIWidgetMotionType +Enum.UIWidgetMotionType = { + Instant = 0, + Smooth = 1, +} + +---@enum Enum.UIWidgetOverrideState +Enum.UIWidgetOverrideState = { + Inactive = 0, + Active = 1, +} + +---@enum Enum.UIWidgetRewardShownState +Enum.UIWidgetRewardShownState = { + Hidden = 0, + ShownEarned = 1, + ShownUnearned = 2, +} + +---@enum Enum.UIWidgetScale +Enum.UIWidgetScale = { + OneHundred = 0, + Ninty = 1, + Eighty = 2, + Seventy = 3, + Sixty = 4, + Fifty = 5, + OneHundredTen = 6, + OneHundredTwenty = 7, + OneHundredThirty = 8, + OneHundredForty = 9, + OneHundredFifty = 10, + OneHundredSixty = 11, + OneHundredSeventy = 12, + OneHundredEighty = 13, + OneHundredNinety = 14, + TwoHundred = 15, +} + +---@enum Enum.UIWidgetSetLayoutDirection +Enum.UIWidgetSetLayoutDirection = { + Vertical = 0, + Horizontal = 1, + Overlap = 2, +} + +---@enum Enum.UIWidgetSpellButtonCooldownType +Enum.UIWidgetSpellButtonCooldownType = { + HideCooldown = 0, + ShowCooldown = 1, + ShowCooldownAndDisableOnCooldown = 2, +} + +---@enum Enum.UIWidgetTextFormatType +Enum.UIWidgetTextFormatType = { + None = 0, + TimeOneLevel = 1, + TimeTwoLevel = 2, + LeadingZeroesWithSixDigits = 3, +} + +---@enum Enum.UIWidgetTextSizeType +Enum.UIWidgetTextSizeType = { + Small12Pt = 0, + Medium16Pt = 1, + Large24Pt = 2, + Huge27Pt = 3, + Standard14Pt = 4, + Small10Pt = 5, + Small11Pt = 6, + Medium18Pt = 7, + Large20Pt = 8, +} + +---@enum Enum.UIWidgetTextureAndTextSizeType +Enum.UIWidgetTextureAndTextSizeType = { + Small = 0, + Medium = 1, + Large = 2, + Huge = 3, + Standard = 4, + Medium2 = 5, +} + +---@enum Enum.UIWidgetTooltipLocation +Enum.UIWidgetTooltipLocation = { + Default = 0, + BottomLeft = 1, + Left = 2, + TopLeft = 3, + Top = 4, + TopRight = 5, + Right = 6, + BottomRight = 7, + Bottom = 8, +} + +---@enum Enum.UIWidgetUpdateAnimType +Enum.UIWidgetUpdateAnimType = { + None = 0, + Flash = 1, + FlashAndAnimateNumber = 2, +} + +---@enum Enum.UIWidgetVisualizationType +Enum.UIWidgetVisualizationType = { + IconAndText = 0, + CaptureBar = 1, + StatusBar = 2, + DoubleStatusBar = 3, + IconTextAndBackground = 4, + DoubleIconAndText = 5, + StackedResourceTracker = 6, + IconTextAndCurrencies = 7, + TextWithState = 8, + HorizontalCurrencies = 9, + BulletTextList = 10, + ScenarioHeaderCurrenciesAndBackground = 11, + TextureAndText = 12, + SpellDisplay = 13, + DoubleStateIconRow = 14, + TextureAndTextRow = 15, + ZoneControl = 16, + CaptureZone = 17, + TextureWithAnimation = 18, + DiscreteProgressSteps = 19, + ScenarioHeaderTimer = 20, + TextColumnRow = 21, + Spacer = 22, + UnitPowerBar = 23, + FillUpFrames = 24, + TextWithSubtext = 25, + MapPinAnimation = 26, + ItemDisplay = 27, + TugOfWar = 28, + ScenarioHeaderDelves = 29, + ButtonHeader = 30, + PreyHuntProgress = 31, +} + +---@enum Enum.UnitAuraSortDirection +Enum.UnitAuraSortDirection = { + Normal = 0, + Reverse = 1, +} + +---@enum Enum.UnitAuraSortRule +Enum.UnitAuraSortRule = { + Unsorted = 0, + Default = 1, + BigDefensive = 2, + Expiration = 3, + ExpirationOnly = 4, + Name = 5, + NameOnly = 6, +} + +---@enum Enum.UnitDamageAbsorbClampMode +Enum.UnitDamageAbsorbClampMode = { + MissingHealth = 0, + MissingHealthWithoutIncomingHeals = 1, + MaximumHealth = 2, +} + +---@enum Enum.UnitHealAbsorbClampMode +Enum.UnitHealAbsorbClampMode = { + CurrentHealth = 0, + MaximumHealth = 1, +} + +---@enum Enum.UnitHealAbsorbMode +Enum.UnitHealAbsorbMode = { + ReducedByIncomingHeals = 0, + Total = 1, +} + +---@enum Enum.UnitIncomingHealClampMode +Enum.UnitIncomingHealClampMode = { + MissingHealth = 0, + MaximumHealth = 1, +} + +---@enum Enum.UnitMaximumHealthMode +Enum.UnitMaximumHealthMode = { + Default = 0, + WithAbsorbs = 1, +} + +---@enum Enum.UnitMirrorPetFlags +Enum.UnitMirrorPetFlags = { + Renameable = 0x1, + Dismissable = 0x2, + RecentlyTamed = 0x4, + Stampede = 0x8, + ExtraPet = 0x10, +} + +---@enum Enum.UnitSex +Enum.UnitSex = { + Male = 0, + Female = 1, + None = 2, + Both = 3, + Neutral = 4, +} + +---@enum Enum.UnitTokenType +Enum.UnitTokenType = { + None = 0, + Player = 1, + Pet = 2, + Vehicle = 3, + Mouseover = 4, + Target = 5, + TargetTarget = 6, + SoftEnemy = 7, + SoftFriend = 8, + SoftInteract = 9, + Focus = 10, + FocusTarget = 11, + AnyTarget = 12, + AnyInteract = 13, + AnyLeftInteract = 14, + AnyEnemy = 15, + AnyFriend = 16, + Npc = 17, + QuestNpc = 18, + Raid1 = 19, + Raid2 = 20, + Raid3 = 21, + Raid4 = 22, + Raid5 = 23, + Raid6 = 24, + Raid7 = 25, + Raid8 = 26, + Raid9 = 27, + Raid10 = 28, + Raid11 = 29, + Raid12 = 30, + Raid13 = 31, + Raid14 = 32, + Raid15 = 33, + Raid16 = 34, + Raid17 = 35, + Raid18 = 36, + Raid19 = 37, + Raid20 = 38, + Raid21 = 39, + Raid22 = 40, + Raid23 = 41, + Raid24 = 42, + Raid25 = 43, + Raid26 = 44, + Raid27 = 45, + Raid28 = 46, + Raid29 = 47, + Raid30 = 48, + Raid31 = 49, + Raid32 = 50, + Raid33 = 51, + Raid34 = 52, + Raid35 = 53, + Raid36 = 54, + Raid37 = 55, + Raid38 = 56, + Raid39 = 57, + Raid40 = 58, + RaidPet1 = 59, + RaidPet2 = 60, + RaidPet3 = 61, + RaidPet4 = 62, + RaidPet5 = 63, + RaidPet6 = 64, + RaidPet7 = 65, + RaidPet8 = 66, + RaidPet9 = 67, + RaidPet10 = 68, + RaidPet11 = 69, + RaidPet12 = 70, + RaidPet13 = 71, + RaidPet14 = 72, + RaidPet15 = 73, + RaidPet16 = 74, + RaidPet17 = 75, + RaidPet18 = 76, + RaidPet19 = 77, + RaidPet20 = 78, + RaidPet21 = 79, + RaidPet22 = 80, + RaidPet23 = 81, + RaidPet24 = 82, + RaidPet25 = 83, + RaidPet26 = 84, + RaidPet27 = 85, + RaidPet28 = 86, + RaidPet29 = 87, + RaidPet30 = 88, + RaidPet31 = 89, + RaidPet32 = 90, + RaidPet33 = 91, + RaidPet34 = 92, + RaidPet35 = 93, + RaidPet36 = 94, + RaidPet37 = 95, + RaidPet38 = 96, + RaidPet39 = 97, + RaidPet40 = 98, + Party1 = 99, + Party2 = 100, + Party3 = 101, + Party4 = 102, + PartyPet1 = 103, + PartyPet2 = 104, + PartyPet3 = 105, + PartyPet4 = 106, + NamePlate1 = 107, + NamePlate2 = 108, + NamePlate3 = 109, + NamePlate4 = 110, + NamePlate5 = 111, + NamePlate6 = 112, + NamePlate7 = 113, + NamePlate8 = 114, + NamePlate9 = 115, + NamePlate10 = 116, + NamePlate11 = 117, + NamePlate12 = 118, + NamePlate13 = 119, + NamePlate14 = 120, + NamePlate15 = 121, + NamePlate16 = 122, + NamePlate17 = 123, + NamePlate18 = 124, + NamePlate19 = 125, + NamePlate20 = 126, + NamePlate21 = 127, + NamePlate22 = 128, + NamePlate23 = 129, + NamePlate24 = 130, + NamePlate25 = 131, + NamePlate26 = 132, + NamePlate27 = 133, + NamePlate28 = 134, + NamePlate29 = 135, + NamePlate30 = 136, + NamePlate31 = 137, + NamePlate32 = 138, + NamePlate33 = 139, + NamePlate34 = 140, + NamePlate35 = 141, + NamePlate36 = 142, + NamePlate37 = 143, + NamePlate38 = 144, + NamePlate39 = 145, + NamePlate40 = 146, + NamePlate41 = 147, + NamePlate42 = 148, + NamePlate43 = 149, + NamePlate44 = 150, + NamePlate45 = 151, + NamePlate46 = 152, + NamePlate47 = 153, + NamePlate48 = 154, + NamePlate49 = 155, + NamePlate50 = 156, + NamePlate51 = 157, + NamePlate52 = 158, + NamePlate53 = 159, + NamePlate54 = 160, + NamePlate55 = 161, + NamePlate56 = 162, + NamePlate57 = 163, + NamePlate58 = 164, + NamePlate59 = 165, + NamePlate60 = 166, + NamePlate61 = 167, + NamePlate62 = 168, + NamePlate63 = 169, + NamePlate64 = 170, + NamePlate65 = 171, + NamePlate66 = 172, + NamePlate67 = 173, + NamePlate68 = 174, + NamePlate69 = 175, + NamePlate70 = 176, + NamePlate71 = 177, + NamePlate72 = 178, + NamePlate73 = 179, + NamePlate74 = 180, + NamePlate75 = 181, + NamePlate76 = 182, + NamePlate77 = 183, + NamePlate78 = 184, + NamePlate79 = 185, + NamePlate80 = 186, + NamePlate81 = 187, + NamePlate82 = 188, + NamePlate83 = 189, + NamePlate84 = 190, + NamePlate85 = 191, + NamePlate86 = 192, + NamePlate87 = 193, + NamePlate88 = 194, + NamePlate89 = 195, + NamePlate90 = 196, + NamePlate91 = 197, + NamePlate92 = 198, + NamePlate93 = 199, + NamePlate94 = 200, + NamePlate95 = 201, + NamePlate96 = 202, + NamePlate97 = 203, + NamePlate98 = 204, + NamePlate99 = 205, + NamePlate100 = 206, + NamePlate101 = 207, + NamePlate102 = 208, + NamePlate103 = 209, + NamePlate104 = 210, + NamePlate105 = 211, + NamePlate106 = 212, + NamePlate107 = 213, + NamePlate108 = 214, + NamePlate109 = 215, + NamePlate110 = 216, + NamePlate111 = 217, + NamePlate112 = 218, + NamePlate113 = 219, + NamePlate114 = 220, + NamePlate115 = 221, + NamePlate116 = 222, + NamePlate117 = 223, + NamePlate118 = 224, + NamePlate119 = 225, + NamePlate120 = 226, + NamePlate121 = 227, + NamePlate122 = 228, + NamePlate123 = 229, + NamePlate124 = 230, + NamePlate125 = 231, + NamePlate126 = 232, + NamePlate127 = 233, + NamePlate128 = 234, + NamePlate129 = 235, + NamePlate130 = 236, + NamePlate131 = 237, + NamePlate132 = 238, + NamePlate133 = 239, + NamePlate134 = 240, + NamePlate135 = 241, + NamePlate136 = 242, + NamePlate137 = 243, + NamePlate138 = 244, + NamePlate139 = 245, + NamePlate140 = 246, + NamePlate141 = 247, + NamePlate142 = 248, + NamePlate143 = 249, + NamePlate144 = 250, + NamePlate145 = 251, + NamePlate146 = 252, + NamePlate147 = 253, + NamePlate148 = 254, + NamePlate149 = 255, + NamePlate150 = 256, + Boss1 = 257, + Boss2 = 258, + Boss3 = 259, + Boss4 = 260, + Boss5 = 261, + Arena1 = 262, + Arena2 = 263, + Arena3 = 264, + Arena4 = 265, + Arena5 = 266, + ArenaPet1 = 267, + ArenaPet2 = 268, + ArenaPet3 = 269, + ArenaPet4 = 270, + ArenaPet5 = 271, + SpectatedA1 = 272, + SpectatedA2 = 273, + SpectatedA3 = 274, + SpectatedA4 = 275, + SpectatedA5 = 276, + SpectatedA6 = 277, + SpectatedA7 = 278, + SpectatedA8 = 279, + SpectatedA9 = 280, + SpectatedA10 = 281, + SpectatedA11 = 282, + SpectatedA12 = 283, + SpectatedA13 = 284, + SpectatedA14 = 285, + SpectatedA15 = 286, + SpectatedB1 = 287, + SpectatedB2 = 288, + SpectatedB3 = 289, + SpectatedB4 = 290, + SpectatedB5 = 291, + SpectatedB6 = 292, + SpectatedB7 = 293, + SpectatedB8 = 294, + SpectatedB9 = 295, + SpectatedB10 = 296, + SpectatedB11 = 297, + SpectatedB12 = 298, + SpectatedB13 = 299, + SpectatedB14 = 300, + SpectatedB15 = 301, + SpectatedPetA1 = 302, + SpectatedPetA2 = 303, + SpectatedPetA3 = 304, + SpectatedPetA4 = 305, + SpectatedPetA5 = 306, + SpectatedPetA6 = 307, + SpectatedPetA7 = 308, + SpectatedPetA8 = 309, + SpectatedPetA9 = 310, + SpectatedPetA10 = 311, + SpectatedPetA11 = 312, + SpectatedPetA12 = 313, + SpectatedPetA13 = 314, + SpectatedPetA14 = 315, + SpectatedPetA15 = 316, + SpectatedPetB1 = 317, + SpectatedPetB2 = 318, + SpectatedPetB3 = 319, + SpectatedPetB4 = 320, + SpectatedPetB5 = 321, + SpectatedPetB6 = 322, + SpectatedPetB7 = 323, + SpectatedPetB8 = 324, + SpectatedPetB9 = 325, + SpectatedPetB10 = 326, + SpectatedPetB11 = 327, + SpectatedPetB12 = 328, + SpectatedPetB13 = 329, + SpectatedPetB14 = 330, + SpectatedPetB15 = 331, + Commentator1 = 332, + Commentator2 = 333, + Commentator3 = 334, + Commentator4 = 335, + Commentator5 = 336, + Commentator6 = 337, + Commentator7 = 338, + Commentator8 = 339, + Commentator9 = 340, + Commentator10 = 341, + Commentator11 = 342, + Commentator12 = 343, + Commentator13 = 344, + Commentator14 = 345, + Commentator15 = 346, + Commentator16 = 347, + Commentator17 = 348, + Commentator18 = 349, + Commentator19 = 350, + Commentator20 = 351, + Commentator21 = 352, + Commentator22 = 353, + Commentator23 = 354, + Commentator24 = 355, + Commentator25 = 356, + Commentator26 = 357, + Commentator27 = 358, + Commentator28 = 359, + Commentator29 = 360, + Commentator30 = 361, +} + +---@enum Enum.ValidateNameResult +Enum.ValidateNameResult = { + Success = 0, + Failure = 1, + NoName = 2, + TooShort = 3, + TooLong = 4, + InvalidCharacter = 5, + MixedLanguages = 6, + Profane = 7, + Reserved = 8, + InvalidApostrophe = 9, + MultipleApostrophes = 10, + ThreeConsecutive = 11, + InvalidSpace = 12, + ConsecutiveSpaces = 13, + RussianConsecutiveSilentCharacters = 14, + RussianSilentCharacterAtBeginningOrEnd = 15, + DeclensionDoesntMatchBaseName = 16, + SpacesDisallowed = 17, +} + +---@enum Enum.VasPurchaseProgress +Enum.VasPurchaseProgress = { + Invalid = 0, + PrePurchase = 1, + PaymentPending = 2, + ApplyingLicense = 3, + WaitingOnQueue = 4, + Ready = 5, + ProcessingFactionChange = 6, + Complete = 7, +} + +---@enum Enum.ViewArenaSize +Enum.ViewArenaSize = { + Two = 0, + Three = 1, +} + +---@enum Enum.ViewRaidSize +Enum.ViewRaidSize = { + Ten = 0, + TwentyFive = 1, + Forty = 2, +} + +---@enum Enum.VignetteObjectiveType +Enum.VignetteObjectiveType = { + None = 0, + Defeat = 1, + DefeatShowRemainingHealth = 2, +} + +---@enum Enum.VignetteType +Enum.VignetteType = { + Normal = 0, + PvPBounty = 1, + Torghast = 2, + Treasure = 3, + FyrakkFlight = 4, +} + +---@enum Enum.Vocalerrorsounds +Enum.Vocalerrorsounds = { + Inventoryfull = 0, + Outofammo = 1, + NoequipLevel = 2, + NoequipEver = 3, + BoundNodrop = 4, + Itemcooling = 5, + Cantdrinkmore = 6, + Canteatmore = 7, + Cantinvite = 8, + Inviteebusy = 9, + Targettoofar = 10, + Invalidtarget = 11, + Spellcooling = 12, + CantlearnLevel = 13, + Locked = 14, + Nomana = 15, + Notwhiledead = 16, + Cantloot = 17, + Cantcreate = 18, + Declinegroup = 19, + Alreadyingroup = 20, + Alreadyinguild = 21, + Cantaffordbankslot = 22, + Toomanybankslots = 23, + CanteatMoving = 24, + Notabag = 25, + Cantputbag = 26, + Wrongslot = 27, + Ammoonlyinbag = 28, + Bagfull = 29, + Itemmaxcount = 30, + CantlootDidntkill = 31, + CantlootWrongfacing = 32, + CantlootLocked = 33, + CantlootNotstandingObsolete = 34, + CantlootToofar = 35, + Cantattackrongdirection = 36, + CantattackNotstandingObsolete = 37, + CantattackNotarget = 38, + Notenoughgold = 39, + Notenoughmoney = 40, + Cantequip2HSkill = 41, + Cantequip2Hequipped = 42, + Cantequip2HNoskill = 43, + Notequippable = 44, + Genericnotarget = 45, + CantcastOutofrange = 46, + Potioncooling = 47, + Proficiencyneeded = 48, + Mustequippitem = 49, + Abilitycooling = 50, + Cantuseitem = 51, + Chestinuse = 52, + FoodcoolingObsolete = 53, + CanttaxiNomoney = 54, + Cantuselocked = 55, + Noequipslotavailable = 56, + Cantusetoofar = 57, + Cantswap = 58, + CanttradeSoulbound = 59, + Cantflyhere = 60, + Itemlocked = 61, + Guildpermissions = 62, + Norage = 63, + Noenergy = 64, + Noessence = 65, + Invaliditemtarget = 66, + ExhaustedObsolete = 67, +} + +---@enum Enum.VoiceChannelErrorReason +Enum.VoiceChannelErrorReason = { + Unknown = 0, + IsBattleNetChannel = 1, +} + +---@enum Enum.VoiceChatStatusCode +Enum.VoiceChatStatusCode = { + Success = 0, + OperationPending = 1, + TooManyRequests = 2, + LoginProhibited = 3, + ClientNotInitialized = 4, + ClientNotLoggedIn = 5, + ClientAlreadyLoggedIn = 6, + ChannelNameTooShort = 7, + ChannelNameTooLong = 8, + ChannelAlreadyExists = 9, + AlreadyInChannel = 10, + TargetNotFound = 11, + Failure = 12, + ServiceLost = 13, + UnableToLaunchProxy = 14, + ProxyConnectionTimeOut = 15, + ProxyConnectionUnableToConnect = 16, + ProxyConnectionUnexpectedDisconnect = 17, + Disabled = 18, + UnsupportedChatChannelType = 19, + InvalidCommunityStream = 20, + PlayerSilenced = 21, + PlayerVoiceChatParentalDisabled = 22, + InvalidInputDevice = 23, + InvalidOutputDevice = 24, +} + +---@enum Enum.VoiceTtsStatusCode +Enum.VoiceTtsStatusCode = { + Success = 0, + InvalidEngineType = 1, + EngineAllocationFailed = 2, + NotSupported = 3, + MaxCharactersExceeded = 4, + UtteranceBelowMinimumDuration = 5, + InputTextEnqueued = 6, + SdkNotInitialized = 7, + DestinationQueueFull = 8, + EnqueueNotNecessary = 9, + UtteranceNotFound = 10, + ManagerNotFound = 11, + InvalidArgument = 12, + InternalError = 13, +} + +---@enum Enum.WarbandSceneFlags +Enum.WarbandSceneFlags = { + DoNotInclude = 0x1, + HiddenUntilCollected = 0x2, + CannotBeSaved = 0x4, + AwardedAutomatically = 0x8, + IsDefault = 0x10, +} + +---@enum Enum.WeaponSlot +Enum.WeaponSlot = { + MainHand = 0, + OffHand = 1, +} + +---@enum Enum.WeeklyRewardChestActivityType +Enum.WeeklyRewardChestActivityType = { + Scenario = 0, + LFGDungeons = 1, + World = 2, +} + +---@enum Enum.WeeklyRewardChestClaimRewardResult +Enum.WeeklyRewardChestClaimRewardResult = { + Success = 0, + InvalidThreshold = 1, + PlayerNotFound = 2, + InvalidSlot = 3, + TooManyItems = 4, + DbError = 5, + LockFailure = 6, + CountExceeded = 7, +} + +---@enum Enum.WeeklyRewardChestThresholdType +Enum.WeeklyRewardChestThresholdType = { + None = 0, + Activities = 1, + RankedPvP = 2, + Raid = 3, + AlsoReceive = 4, + Concession = 5, + World = 6, +} + +---@enum Enum.WeeklyRewardProgressResult +Enum.WeeklyRewardProgressResult = { + Success = 0, + NoSeason = 1, + TimedOut = 2, + DbError = 3, + NoPlayer = 4, +} + +---@enum Enum.WidgetAnimationType +Enum.WidgetAnimationType = { + None = 0, + Fade = 1, +} + +---@enum Enum.WidgetCurrencyClass +Enum.WidgetCurrencyClass = { + Currency = 0, + Item = 1, +} + +---@enum Enum.WidgetEnabledState +Enum.WidgetEnabledState = { + Disabled = 0, + Yellow = 1, + Red = 2, + White = 3, + Green = 4, + Artifact = 5, + Black = 6, + BrightBlue = 7, +} + +---@enum Enum.WidgetGlowAnimType +Enum.WidgetGlowAnimType = { + None = 0, + Pulse = 1, +} + +---@enum Enum.WidgetIconSizeType +Enum.WidgetIconSizeType = { + Small = 0, + Medium = 1, + Large = 2, + Standard = 3, +} + +---@enum Enum.WidgetIconSourceType +Enum.WidgetIconSourceType = { + Spell = 0, + Item = 1, +} + +---@enum Enum.WidgetOpacityType +Enum.WidgetOpacityType = { + OneHundred = 0, + Ninety = 1, + Eighty = 2, + Seventy = 3, + Sixty = 4, + Fifty = 5, + Forty = 6, + Thirty = 7, + Twenty = 8, + Ten = 9, + Zero = 10, +} + +---@enum Enum.WidgetShowGlowState +Enum.WidgetShowGlowState = { + HideGlow = 0, + ShowGlow = 1, +} + +---@enum Enum.WidgetShownState +Enum.WidgetShownState = { + Hidden = 0, + Shown = 1, +} + +---@enum Enum.WidgetTextHorizontalAlignmentType +Enum.WidgetTextHorizontalAlignmentType = { + Left = 0, + Center = 1, + Right = 2, +} + +---@enum Enum.WidgetUnitPowerBarFlashMomentType +Enum.WidgetUnitPowerBarFlashMomentType = { + FlashWhenMax = 0, + FlashWhenMin = 1, + NeverFlash = 2, +} + +---@enum Enum.WoWEntitlementType +Enum.WoWEntitlementType = { + Item = 0, + Mount = 1, + Battlepet = 2, + Toy = 3, + Appearance = 4, + AppearanceSet = 5, + GameTime = 6, + Title = 7, + Illusion = 8, + Invalid = 9, +} + +---@enum Enum.WoWLabsAreaType +Enum.WoWLabsAreaType = { + PlunderstormDropSparse = 0, + PlunderstormDropMedium = 1, + PlunderstormDropDense = 2, +} + +---@enum Enum.WorldCursorAnchorType +Enum.WorldCursorAnchorType = { + None = 0, + Default = 1, + Cursor = 2, + Nameplate = 3, +} + +---@enum Enum.WorldElapsedTimerTypes +Enum.WorldElapsedTimerTypes = { + None = 0, + ChallengeMode = 1, + ProvingGround = 2, +} + +---@enum Enum.WorldQuestQuality +Enum.WorldQuestQuality = { + Common = 0, + Rare = 1, + Epic = 2, +} + +---@enum Enum.ZoneControlActiveState +Enum.ZoneControlActiveState = { + Inactive = 0, + Active = 1, +} + +---@enum Enum.ZoneControlDangerFlashType +Enum.ZoneControlDangerFlashType = { + ShowOnGoodStates = 0, + ShowOnBadStates = 1, + ShowOnBoth = 2, + ShowOnNeither = 3, +} + +---@enum Enum.ZoneControlFillType +Enum.ZoneControlFillType = { + SingleFillClockwise = 0, + SingleFillCounterClockwise = 1, + DoubleFillClockwise = 2, + DoubleFillCounterClockwise = 3, +} + +---@enum Enum.ZoneControlLeadingEdgeType +Enum.ZoneControlLeadingEdgeType = { + NoLeadingEdge = 0, + UseLeadingEdge = 1, +} + +---@enum Enum.ZoneControlMode +Enum.ZoneControlMode = { + BothStatesAreGood = 0, + State1IsGood = 1, + State2IsGood = 2, + NeitherStateIsGood = 3, +} + +---@enum Enum.ZoneControlState +Enum.ZoneControlState = { + State1 = 0, + State2 = 1, +} + +Constants = { + AccountStoreConsts = { + KegLegRenownCurrencyID = 2814, + PlunderstormPlunderCurrencyID = 3139, + PlunderstormStoreFrontID = 1, + WowhackStoreFrontID = 3, + }, + AuctionConstants = { + DEFAULT_AUCTION_PRICE_MULTIPLIER = 1.5, + }, + CAAConstants = { + CAADebuffSelfAlertDefault = 0, + CAAEnabledDefault = false, + CAAFrequencyDefault = 0, + CAAFrequencyMax = 10, + CAAFrequencyMin = -10, + CAAInterruptCastDefault = 0, + CAAInterruptCastSuccessDefault = 0, + CAAMinCastTimeDefault = 1.5, + CAAMinCastTimeMax = 5, + CAAMinCastTimeMin = 0, + CAAMinCastTimeStep = 0.5, + CAAPartyHealthPercentDefault = 0, + CAAPlayerCastFormatDefault = 4, + CAAPlayerCastModeDefault = 0, + CAAPlayerHealthFormatDefault = 1, + CAAPlayerHealthPercentDefault = 0, + CAAPlayerResourceFormatDefault = 1, + CAAPlayerResourcePercentDefault = 0, + CAASamePercentThrottleTime = 10, + CAASampleTextThrottleTime = 1, + CAASayCombatEndDefault = true, + CAASayCombatStartDefault = true, + CAASayIfTargetedDefault = 1, + CAASayYourDebuffsDefault = true, + CAASayYourDebuffsFormatDefault = 0, + CAASayYourDebuffsMinDurationDefault = 1.5, + CAASayYourDebuffsMinDurationMax = 5, + CAASayYourDebuffsMinDurationMin = 0, + CAASayYourDebuffsMinDurationStep = 0.5, + CAATargetCastFormatDefault = 0, + CAATargetCastModeDefault = 0, + CAATargetDeathBehaviorDefault = 0, + CAATargetHealthFormatDefault = 3, + CAATargetHealthPercentDefault = 2, + CAATargetNameDefault = true, + CAAThrottleDefault = 0, + CAAThrottleMax = 5, + CAAThrottleMin = 0, + CAAThrottleStep = 0.5, + CAAVoiceDefault = 0, + }, + CalendarGetEventTypeConstants = { + DEFAULT_CALENDAR_GET_EVENT_TYPE = 0, + }, + Callings = { + MaxCallings = 3, + }, + CatalogShopVirtualCurrencyConstants = { + HEARTHSTEEL_VC_CURRENCY_CODE = "XVV", + TRADERS_TENDER_VC_CURRENCY_CODE = "XWP", + }, + CharCustomizationConstants = { + CHAR_CUSTOMIZE_CUSTOM_DISPLAY_OPTION_FIRST = 5, + CHAR_CUSTOMIZE_CUSTOM_DISPLAY_OPTION_LAST = 8, + NAME_RESERVATION_DAYS = 30, + NUM_CUSTOM_DISPLAY = 4, + }, + ChatFrameConstants = { + MaxCharacterNameBytes = 305, + MaxChatChannels = 20, + MaxChatWindows = 10, + }, + CombatLogMessageLimits = { + CombatLogDefaultMessageLimit = 300, + CombatLogMaximumMessageLimit = 1000, + }, + CombatLogObjectMasks = { + COMBATLOG_OBJECT_AFFILIATION_MASK = 15, + COMBATLOG_OBJECT_CONTROL_MASK = 768, + COMBATLOG_OBJECT_REACTION_MASK = 240, + COMBATLOG_OBJECT_SPECIAL_MASK = -65536, + COMBATLOG_OBJECT_TYPE_MASK = 64512, + }, + CombatLogObjectTargetMasks = { + COMBATLOG_OBJECT_RAID_MASK = -1, + COMBATLOG_OBJECT_RAID_TARGET_MASK = 255, + }, + ContentTrackingConsts = { + MaxTrackedAchievements = 10, + MaxTrackedCollectableSources = 15, + }, + CooldownFrameDefaults = { + COOLDOWN_DEFAULT_BLING_DURATION_MS = 1000, + COOLDOWN_DEFAULT_COUNTDOWN_ABBREV_THRESHOLD_MS = 120000, + COOLDOWN_DEFAULT_COUNTDOWN_MILLISECOND_THRESHOLD_MS = 0, + COOLDOWN_DEFAULT_COUNTDOWN_MINIMUM_DURATION_MS = 2000, + COOLDOWN_DEFAULT_USE_AURA_DISPLAY_TIME = false, + }, + CooldownViewerUIConstants = { + COOLDOWN_VIEWER_CATEGORY_SET_SIZE = 16, + COOLDOWN_VIEWER_LINKED_SPELLS_SIZE = 4, + }, + CraftingOrderConsts = { + MAX_CRAFTING_ORDER_FAVORITE_RECIPES = 100, + NPC_CRAFTING_ORDER_NUM_SUPPORTED_REWARDS = 2, + }, + CurrencyConsts = { + ACCOUNT_WIDE_HONOR_CURRENCY_ID = 1585, + ACCOUNT_WIDE_HONOR_LEVEL_CURRENCY_ID = 1586, + ARTIFACT_KNOWLEDGE_CURRENCY_ID = 1171, + CLASSIC_ARENA_POINTS_CURRENCY_ID = 1900, + CLASSIC_CONQUEST_CURRENCY_ID = 390, + CLASSIC_HONOR_CURRENCY_ID = 1901, + CONQUEST_ARENA_AND_BG_META_CURRENCY_ID = 483, + CONQUEST_ARENA_META_CURRENCY_ID = 483, + CONQUEST_ASHRAN_META_CURRENCY_ID = 692, + CONQUEST_BG_META_CURRENCY_ID = 484, + CONQUEST_CURRENCY_ID = 1602, + CONQUEST_POINTS_CURRENCY_ID = 390, + CONQUEST_RATED_BG_META_CURRENCY_ID = 484, + CURRENCY_ID_PERKS_PROGRAM_DISPLAY_INFO = 2032, + CURRENCY_ID_RENOWN = 1822, + CURRENCY_ID_RENOWN_KYRIAN = 1829, + CURRENCY_ID_RENOWN_NECROLORD = 1832, + CURRENCY_ID_RENOWN_NIGHT_FAE = 1831, + CURRENCY_ID_RENOWN_VENTHYR = 1830, + CURRENCY_ID_RESERVOIR_ANIMA = 1813, + CURRENCY_ID_WILLING_SOUL = 1810, + CURRENCY_WALLET_TYPE_WOWMONEY = 0, + DRAGON_ISLES_SUPPLIES_CURRENCY_ID = 2003, + ECHOES_OF_NYALOTHA_CURRENCY_ID = 1803, + HONOR_CURRENCY_ID = 1792, + HONOR_PER_CURRENCY = 10, + MAX_CURRENCY_QUANTITY = 100000000, + PLAYER_CURRENCY_CLIENT_FLAGS = 12, + PVP_CURRENCY_CONQUEST_ALLIANCE_INV_ICON = 463448, + PVP_CURRENCY_CONQUEST_HORDE_INV_ICON = 463449, + PVP_CURRENCY_HONOR_ALLIANCE_INV_ICON = 463450, + PVP_CURRENCY_HONOR_HORDE_INV_ICON = 463451, + QUESTIONMARK_INV_ICON = 134400, + WAR_RESOURCES_CURRENCY_ID = 1560, + }, + DelvesConsts = { + DELVES_COMPANION_INFO_SELECTION_CHARACTER_DATA_ELEMENT_ID = 13, + DELVES_COMPANION_TOOLTIP_WIDGET_SET_ID = 1331, + DELVES_MIN_PLAYER_LEVEL_CONTENT_TUNING_ID = 2677, + DELVES_NORMAL_KEY_CURRENCY_ID = 3028, + }, + EditModeConsts = { + EditModeDefaultGridSpacing = 100, + EditModeMaxGridSpacing = 300, + EditModeMaxLayoutsPerType = 5, + EditModeMinGridSpacing = 20, + }, + EditModeLayoutConsts = { + EditModeDefaultLayout = 0, + }, + EncodingLimits = { + EncodingDecompressSizeLimit = 104857600, + EncodingStackSizeLimit = 100, + }, + EncounterTimelineEventConstants = { + ENCOUNTER_TIMELINE_INVALID_EVENT = 0, + ENCOUNTER_TIMELINE_RESERVED_EVENT_COUNT = 40, + }, + EncounterTimelineIconMasks = { + EncounterTimelineNoIcons = 0, + EncounterTimelineDeadlyIcons = 1, + EncounterTimelineEnrageIcons = 2, + EncounterTimelineDispelIcons = 124, + EncounterTimelineOtherIcons = 127, + EncounterTimelineTankAlertIcons = 128, + EncounterTimelineHealerAlertIcons = 256, + EncounterTimelineDamageAlertIcons = 512, + EncounterTimelineRoleIcons = 896, + EncounterTimelineAllIcons = 1023, + }, + EventScheduler = { + SCHEDULED_EVENT_FUTURE_LIMIT = 12, + SCHEDULED_EVENT_PAST_LIMIT_SECONDS = 3600, + SCHEDULED_EVENT_REMINDER_DEAD_SECONDS = 10, + SCHEDULED_EVENT_REMINDER_WARNING_SECONDS = 300, + }, + HousingCatalogConsts = { + HOUSING_CATALOG_ALL_CATEGORY_ID = 18, + HOUSING_CATALOG_DECOR_MODELSCENEID_DEFAULT = 1317, + HOUSING_CATALOG_FEATURED_CATEGORY_ID = 17, + }, + ITEM_WEAPON_SUBCLASSConstants = { + ITEM_WEAPON_SUBCLASS_IS2HWEAPON_MASK = 1049954, + ITEM_WEAPON_SUBCLASS_ISMAINHANDWEAPON_NONRANGED_MASK = 1091571, + ITEM_WEAPON_SUBCLASS_ISRANGEDWEAPON_MASK = 851980, + ITEM_WEAPON_SUBCLASS_ISTWOHANDEDRANGEDWEAPON_MASK = 262156, + ITEM_WEAPON_SUBCLASS_MASK = 2097151, + ITEM_WEAPON_SUBCLASS_NONE = -1, + ITEM_WEAPON_SUBCLASS_USES2HANDS_MASK = 1312110, + }, + ITEM_WEAPON_SUBCLASSConstants_PostMists = { + ITEM_WEAPON_SUBCLASS_ISTITANSGRIPWEAPON_MASK = 1378, + }, + InventoryConstants = { + MAX_TRANSACTION_BANK_TABS = 6, + NumAccountBankSlots = 5, + NumBagSlots = 4, + NumCharacterBankSlots = 6, + NumReagentBagSlots = 1, + }, + ItemConsts = { + CURRENT_ARTIFACT_POWERS_VERSION = 1, + CURRENT_ITEM_SAVE_VERSION = 2, + DEFAULT_ARTIFACT_POWERS_VERSION = 1, + DEFAULT_ITEM_SAVE_VERSION = 2, + DEFAULT_RETENTION = 7, + INVALID_BANK_TAB_SLOT = 255, + MAX_LOOT_OBJECT_ITEMS = 31, + NUM_ITEM_ENCHANTMENT_SOCKETS = 3, + }, + ItemConsts_Mainline = { + HWM_SQUISH_ERA_PLAYER_DATA_ACCOUNT_ELEMENT_ID = 212, + }, + LFGConstsExposed = { + GROUP_FINDER_MAX_ACTIVITY_CAPACITY = 16, + }, + LFG_ROLEConstants = { + LFG_ROLE_ANY = 3, + LFG_ROLE_NO_ROLE = -1, + }, + LevelConstsExposed = { + MIN_ACHIEVEMENT_LEVEL = 10, + MIN_RES_SICKNESS_LEVEL = 10, + }, + LootConsts = { + MasterLootQualityThreshold = 5, + }, + MajorFactionsConsts = { + PLUNDERSTORM_MAJOR_FACTION_ID = 2593, + WORLD_STATE_RAPID_RENOWN_CAP_10_0 = 20851, + WORLD_STATE_RENOWN_CAP_10_0 = 19735, + }, + MoneyFormattingConstants = { + GOLD_REWARD_THRESHOLD_TO_HIDE_COPPER = 10, + }, + MountDynamicFlightConsts = { + TRAIT_SYSTEM_ID = 1, + TREE_ID = 672, + }, + PartyCountdownConstants = { + MaxCountdownSeconds = 3600, + }, + PetConsts = { + MAX_SUMMONABLE_PETS = 25, + PETNUMBER_INVALIDPET = 0, + PETNUMBER_INVALIDSLOT = -1, + PETNUMBER_PENDINGPET = -1, + }, + PetConsts_PostCata = { + DEATHKNIGHT_PET_CREATURE_ID = 26125, + EXTRA_PET_STABLE_SLOT = 5, + MAX_NUM_PET_SLOTS = 205, + MAX_STABLE_SLOTS = 200, + MAX_SUMMONABLE_HUNTER_PETS = 5, + NUM_PET_SLOTS_DEATHKNIGHT = 25, + NUM_PET_SLOTS_HUNTER = 205, + NUM_PET_SLOTS_MAGE = 1, + NUM_PET_SLOTS_THAT_NEED_LEARNED_SPELL = 5, + NUM_PET_SLOTS_WARLOCK = 25, + PET_MAX_LEVEL_DIFFERENCE = 0, + STABLED_PETS_FIRST_SLOT_INDEX = 5, + }, + ProfessionConsts = { + CLASSIC_PROFESSION_PARENT_TIER_INDEX = 4, + CRAFTING_ORDER_CLAIM_DURATION = 1800, + CRAFTING_ORDER_CURRENCY_WALLET_ITEM_ID = 262724, + CRAFTING_ORDER_ITEM_RETENTION = 30, + MAX_CRAFTING_REAGENT_SLOTS = 12, + NUM_PRIMARY_PROFESSIONS = 2, + PUBLIC_CRAFTING_ORDER_STALE_THRESHOLD = 14400, + RUNEFORGING_ROOT_CATEGORY_ID = 210, + RUNEFORGING_SKILL_LINE_ID = 960, + }, + PvpInfoConsts = { + MAX_PVP_LOCK_LIST_MAP = 2, + MaxPlayersPerInstance = 80, + }, + QuestWatchConsts = { + MAX_QUEST_WATCHES = 25, + MAX_WORLD_QUEST_WATCHES_AUTOMATIC = 1, + MAX_WORLD_QUEST_WATCHES_MANUAL = 5, + }, + RecentAlliesConsts = { + PIN_EXPIRATION_WARNING_DAYS = 5, + }, + SpellBookSpellIDs = { + SPELL_ID_DISMISS_PET = 2641, + }, + SpellCooldownConsts = { + GLOBAL_RECOVERY_CATEGORY = 133, + }, + TTSConstants = { + TTSRateDefault = 0, + TTSRateMax = 10, + TTSRateMin = -10, + TTSVolumeDefault = 100, + TTSVolumeMax = 100, + TTSVolumeMin = 0, + }, + TalentConsts = { + NumTalentColumns = 3, + }, + TalentTierConstants = { + MAX_TALENT_TIERS = 7, + }, + TieredEntranceConsts = { + TIERED_ENTRANCE_TIER_SCORE_VALUE_MAP_ID = 3, + TIERED_ENTRANCE_TIER_SCORE_VALUE_PLAYER_CONDITION_ID = 6, + TIERED_ENTRANCE_TIER_SCORE_VALUE_TIER_LEVEL = 1, + }, + TimerunningConsts = { + TIMERUNNING_ITEM_CTR = 2905, + TIMERUNNING_LEGION_ARTIFACT_CTR = 4579, + TIMERUNNING_SEASON_LEGION = 2, + TIMERUNNING_SEASON_NONE = 0, + TIMERUNNING_SEASON_PANDARIA = 1, + }, + TraitConsts = { + COMMIT_COMBAT_TRAIT_CONFIG_CHANGES_SPELL_ID = 384255, + INSPECT_TRAIT_CONFIG_ID = -1, + MAX_COMBAT_TRAIT_CONFIGS = 40, + STARTER_BUILD_TRAIT_CONFIG_ID = -2, + VIEW_TRAIT_CONFIG_ID = -3, + }, + Transmog = { + MainHandTransmogIsIndividualWeapon = -1, + MainHandTransmogIsPairedWeapon = 0, + NoTransmogID = 0, + }, + TransmogOutfitDataConsts = { + EQUIP_TRANSMOG_OUTFIT_MANUAL_SPELL_ID = 1247613, + TRANSMOG_OUTFIT_SLOT_NONE = -1, + }, + UICharacterClasses = { + Warrior = 1, + Paladin = 2, + Hunter = 3, + Rogue = 4, + Priest = 5, + DeathKnight = 6, + Shaman = 7, + Mage = 8, + Warlock = 9, + Monk = 10, + Druid = 11, + DemonHunter = 12, + Evoker = 13, + }, + UnitEventConstants = { + MAX_UNIT_TOKENS_IN_EVENT = 4, + }, + UnitPowerSpellIDs = { + COLLAPSING_STAR_PASSIVE_SPELL_ID = 1221167, + COLLAPSING_STAR_SPELL_ID = 1221150, + DARK_HEART_SPELL_ID = 1225789, + SILENCE_THE_WHISPERS_SPELL_ID = 1227702, + VOID_METAMORPHOSIS_SPELL_ID = 1217607, + }, + WeeklyRewardsConsts = { + ABORT_ITEM_RETENTION_DAYS = 15, + WEEKLY_REWARD_ITEM_RETENTION_DAYS = 15, + }, +} diff --git a/docs/annotations/Annotations/Core/Data/Event.lua b/docs/annotations/Annotations/Core/Data/Event.lua new file mode 100644 index 0000000..e2f1305 --- /dev/null +++ b/docs/annotations/Annotations/Core/Data/Event.lua @@ -0,0 +1,1741 @@ +---@meta _ +---@alias FrameEvent string +---|"ACCOUNT_CHARACTER_CURRENCY_DATA_RECEIVED" +---|"ACCOUNT_CVARS_LOADED" +---|"ACCOUNT_MONEY" +---|"ACCOUNT_STORE_CURRENCY_AVAILABLE_UPDATED" # `currencyID` +---|"ACCOUNT_STORE_FRONT_UPDATED" # `storeFrontID` +---|"ACCOUNT_STORE_ITEM_INFO_UPDATED" # `itemID` +---|"ACCOUNT_STORE_TRANSACTION_ERROR" # `result` +---|"ACHIEVEMENT_EARNED" # `achievementID, alreadyEarned` +---|"ACHIEVEMENT_PLAYER_NAME" # `achievementID` +---|"ACHIEVEMENT_SEARCH_UPDATED" +---|"ACTIONBAR_HIDEGRID" +---|"ACTIONBAR_PAGE_CHANGED" +---|"ACTIONBAR_SHOWGRID" +---|"ACTIONBAR_SHOW_BOTTOMLEFT" +---|"ACTIONBAR_SLOT_CHANGED" # `slot` +---|"ACTIONBAR_UPDATE_COOLDOWN" +---|"ACTIONBAR_UPDATE_STATE" +---|"ACTIONBAR_UPDATE_USABLE" +---|"ACTION_RANGE_CHECK_UPDATE" # `slot, isInRange, checksRange` +---|"ACTION_USABLE_CHANGED" # `changes` +---|"ACTION_WILL_BIND_ITEM" +---|"ACTIVATE_GLYPH" # `spellID` +---|"ACTIVE_COMBAT_CONFIG_CHANGED" # `configID` +---|"ACTIVE_DELVE_DATA_UPDATE" +---|"ACTIVE_GAME_MODE_UPDATED" # `gameMode` +---|"ACTIVE_PLAYER_SPECIALIZATION_CHANGED" +---|"ACTIVE_TALENT_GROUP_CHANGED" # `curr, prev` +---|"ADAPTER_LIST_CHANGED" +---|"ADDONS_UNLOADING" # `closingClient` +---|"ADDON_ACTION_BLOCKED" # `isTainted, function` +---|"ADDON_ACTION_FORBIDDEN" # `isTainted, function` +---|"ADDON_LOADED" # `addOnName, containsBindings` +---|"ADDON_RESTRICTION_STATE_CHANGED" # `type, state` +---|"ADD_NEIGHBORHOOD_CHARTER_SIGNATURE" # `signature` +---|"ADVENTURE_MAP_CLOSE" +---|"ADVENTURE_MAP_OPEN" # `followerTypeID` +---|"ADVENTURE_MAP_QUEST_UPDATE" # `questID` +---|"ADVENTURE_MAP_UPDATE_INSETS" +---|"ADVENTURE_MAP_UPDATE_POIS" +---|"AJ_DUNGEON_ACTION" # `lfgDungeonID` +---|"AJ_OPEN" +---|"AJ_OPEN_COLLECTIONS_ACTION" +---|"AJ_PVE_LFG_ACTION" +---|"AJ_PVP_ACTION" # `battleMasterListID` +---|"AJ_PVP_LFG_ACTION" +---|"AJ_PVP_RBG_ACTION" +---|"AJ_PVP_SKIRMISH_ACTION" +---|"AJ_PVP_SPECIAL_BG_ACTION" +---|"AJ_PVP_TRAINING_GROUNDS_ACTION" +---|"AJ_QUEST_LOG_OPEN" # `questID, uiMapID` +---|"AJ_RAID_ACTION" # `lfgDungeonID` +---|"AJ_REFRESH_DISPLAY" # `newAdventureNotice` +---|"AJ_REWARD_DATA_RECEIVED" +---|"ALERT_REGIONAL_CHAT_DISABLED" +---|"ALLIED_RACE_CLOSE" +---|"ALLIED_RACE_OPEN" # `raceID` +---|"ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED" +---|"ANIMA_DIVERSION_CLOSE" +---|"ANIMA_DIVERSION_OPEN" # `info` +---|"ANIMA_DIVERSION_TALENT_UPDATED" +---|"ARCHAEOLOGY_CLOSED" +---|"ARCHAEOLOGY_FIND_COMPLETE" # `numFindsCompleted, totalFinds, researchBranchID` +---|"ARCHAEOLOGY_SURVEY_CAST" # `numFindsCompleted, totalFinds, researchBranchID, successfulFind` +---|"ARCHAEOLOGY_TOGGLE" +---|"AREA_POIS_UPDATED" +---|"AREA_SPIRIT_HEALER_IN_RANGE" +---|"AREA_SPIRIT_HEALER_OUT_OF_RANGE" +---|"ARENA_COOLDOWNS_UPDATE" +---|"ARENA_CROWD_CONTROL_SPELL_UPDATE" # `unitTarget, spellID` +---|"ARENA_OPPONENT_UPDATE" # `unitToken, updateReason` +---|"ARENA_PREP_OPPONENT_SPECIALIZATIONS" +---|"ARENA_SEASON_WORLD_STATE" +---|"ARTIFACT_CLOSE" +---|"ARTIFACT_DIGSITE_COMPLETE" # `researchBranchID` +---|"ARTIFACT_ENDGAME_REFUND" # `numRefundedPowers, refundedTier, bagOrSlotIndex, slotIndex` +---|"ARTIFACT_RELIC_FORGE_CLOSE" +---|"ARTIFACT_RELIC_FORGE_PREVIEW_RELIC_CHANGED" +---|"ARTIFACT_RELIC_FORGE_UPDATE" +---|"ARTIFACT_RELIC_INFO_RECEIVED" +---|"ARTIFACT_RESPEC_PROMPT" +---|"ARTIFACT_TIER_CHANGED" # `newTier, bagOrSlotIndex, slotIndex` +---|"ARTIFACT_UPDATE" # `newItem` +---|"ARTIFACT_XP_UPDATE" +---|"ASSISTED_COMBAT_ACTION_SPELL_CAST" +---|"AUCTION_CANCELED" # `auctionID` +---|"AUCTION_HOUSE_AUCTIONS_EXPIRED" # `auctionID` +---|"AUCTION_HOUSE_AUCTION_CREATED" # `auctionID` +---|"AUCTION_HOUSE_BROWSE_FAILURE" +---|"AUCTION_HOUSE_BROWSE_RESULTS_ADDED" # `addedBrowseResults` +---|"AUCTION_HOUSE_BROWSE_RESULTS_UPDATED" +---|"AUCTION_HOUSE_CLOSED" +---|"AUCTION_HOUSE_DISABLED" +---|"AUCTION_HOUSE_FAVORITES_UPDATED" +---|"AUCTION_HOUSE_ITEM_DELIVERY_DELAY_UPDATE" # `purchasedItemDeliveryDelay, cancelledItemDeliveryDelay` +---|"AUCTION_HOUSE_NEW_BID_RECEIVED" # `auctionID` +---|"AUCTION_HOUSE_NEW_RESULTS_RECEIVED" # `itemKey` +---|"AUCTION_HOUSE_POST_ERROR" +---|"AUCTION_HOUSE_POST_WARNING" +---|"AUCTION_HOUSE_PURCHASE_COMPLETED" # `auctionID` +---|"AUCTION_HOUSE_SCRIPT_DEPRECATED" +---|"AUCTION_HOUSE_SHOW" +---|"AUCTION_HOUSE_SHOW_COMMODITY_WON_NOTIFICATION" # `commodityName, commodityQuantity` +---|"AUCTION_HOUSE_SHOW_ERROR" # `error` +---|"AUCTION_HOUSE_SHOW_FORMATTED_NOTIFICATION" # `notification, text, auctionID` +---|"AUCTION_HOUSE_SHOW_NOTIFICATION" # `notification` +---|"AUCTION_HOUSE_THROTTLED_MESSAGE_DROPPED" +---|"AUCTION_HOUSE_THROTTLED_MESSAGE_QUEUED" +---|"AUCTION_HOUSE_THROTTLED_MESSAGE_RESPONSE_RECEIVED" +---|"AUCTION_HOUSE_THROTTLED_MESSAGE_SENT" +---|"AUCTION_HOUSE_THROTTLED_SYSTEM_READY" +---|"AUCTION_MULTISELL_FAILURE" +---|"AUCTION_MULTISELL_START" # `numRepetitions` +---|"AUCTION_MULTISELL_UPDATE" # `createdCount, totalToCreate` +---|"AURA_DATA_PROVIDER_SWITCH" # `useRealDataProvider` +---|"AUTOFOLLOW_BEGIN" # `name` +---|"AUTOFOLLOW_END" +---|"AVAILABLE_GAME_MODES_UPDATED" +---|"AVATAR_LIST_UPDATED" # `clubType` +---|"AVOIDANCE_UPDATE" +---|"AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED" # `isHeartEquipped` +---|"AZERITE_EMPOWERED_ITEM_LOOTED" # `itemLink` +---|"AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED" # `azeriteEmpoweredItemLocation` +---|"AZERITE_ESSENCE_ACTIVATED" # `slot, essenceID` +---|"AZERITE_ESSENCE_ACTIVATION_FAILED" # `slot, essenceID` +---|"AZERITE_ESSENCE_CHANGED" # `essenceID, newRank` +---|"AZERITE_ESSENCE_FORGE_CLOSE" +---|"AZERITE_ESSENCE_FORGE_OPEN" +---|"AZERITE_ESSENCE_MILESTONE_UNLOCKED" # `milestoneID` +---|"AZERITE_ESSENCE_UPDATE" +---|"AZERITE_ITEM_ENABLED_STATE_CHANGED" # `enabled` +---|"AZERITE_ITEM_EXPERIENCE_CHANGED" # `azeriteItemLocation, oldExperienceAmount, newExperienceAmount` +---|"AZERITE_ITEM_POWER_LEVEL_CHANGED" # `azeriteItemLocation, oldPowerLevel, newPowerLevel, unlockedEmpoweredItemsInfo, azeriteItemID` +---|"BAG_CLOSED" # `bagID` +---|"BAG_CONTAINER_UPDATE" +---|"BAG_NEW_ITEMS_UPDATED" +---|"BAG_OPEN" # `bagID` +---|"BAG_OVERFLOW_WITH_FULL_INVENTORY" +---|"BAG_SLOT_FLAGS_UPDATED" # `slot` +---|"BAG_UPDATE" # `bagID` +---|"BAG_UPDATE_COOLDOWN" +---|"BAG_UPDATE_DELAYED" +---|"BANKFRAME_CLOSED" +---|"BANKFRAME_OPENED" +---|"BANK_BAG_SLOT_FLAGS_UPDATED" # `slot` +---|"BANK_TABS_CHANGED" # `bankType` +---|"BANK_TAB_SETTINGS_UPDATED" # `bankType` +---|"BARBER_SHOP_APPEARANCE_APPLIED" +---|"BARBER_SHOP_CAMERA_VALUES_UPDATED" +---|"BARBER_SHOP_CLOSE" +---|"BARBER_SHOP_COST_UPDATE" +---|"BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE" +---|"BARBER_SHOP_OPEN" +---|"BARBER_SHOP_RESULT" # `success` +---|"BATTLEFIELDS_CLOSED" +---|"BATTLEFIELDS_SHOW" # `isArena, battleMasterListID` +---|"BATTLEFIELD_AUTO_QUEUE" +---|"BATTLEFIELD_AUTO_QUEUE_EJECT" +---|"BATTLEFIELD_QUEUE_TIMEOUT" +---|"BATTLEGROUND_OBJECTIVES_UPDATE" +---|"BATTLEGROUND_POINTS_UPDATE" +---|"BATTLEPET_FORCE_NAME_DECLENSION" # `name, battlePetGUID` +---|"BATTLETAG_INVITE_SHOW" # `name` +---|"BATTLE_PET_CURSOR_CLEAR" +---|"BEHAVIORAL_NOTIFICATION" # `notificationType, dbId` +---|"BIDS_UPDATED" +---|"BID_ADDED" # `bidID` +---|"BINDINGS_LOADED" +---|"BIND_ENCHANT" +---|"BLACK_MARKET_BID_RESULT" # `marketID, resultCode` +---|"BLACK_MARKET_CLOSE" +---|"BLACK_MARKET_ITEM_UPDATE" +---|"BLACK_MARKET_OPEN" +---|"BLACK_MARKET_OUTBID" # `marketID, itemID` +---|"BLACK_MARKET_UNAVAILABLE" +---|"BLACK_MARKET_WON" # `marketID, itemID` +---|"BNET_REQUEST_INVITE_CONFIRMATION" # `gameAccountID, questSessionActive, tank, healer, dps` +---|"BN_BLOCK_FAILED_TOO_MANY" # `blockType` +---|"BN_BLOCK_LIST_UPDATED" +---|"BN_CHAT_MSG_ADDON" # `prefix, text, channel, senderID` +---|"BN_CHAT_WHISPER_UNDELIVERABLE" # `senderID` +---|"BN_CONNECTED" # `suppressNotification` +---|"BN_CUSTOM_MESSAGE_CHANGED" # `id` +---|"BN_CUSTOM_MESSAGE_LOADED" +---|"BN_DISCONNECTED" # `result, suppressNotification` +---|"BN_FRIEND_ACCOUNT_OFFLINE" # `friendId, isCompanionApp` +---|"BN_FRIEND_ACCOUNT_ONLINE" # `friendId, isCompanionApp` +---|"BN_FRIEND_INFO_CHANGED" # `friendIndex` +---|"BN_FRIEND_INVITE_ADDED" # `accountID` +---|"BN_FRIEND_INVITE_LIST_INITIALIZED" # `listSize` +---|"BN_FRIEND_INVITE_REMOVED" +---|"BN_FRIEND_LIST_SIZE_CHANGED" # `accountID` +---|"BN_INFO_CHANGED" +---|"BN_REQUEST_FOF_SUCCEEDED" +---|"BONUS_ROLL_ACTIVATE" +---|"BONUS_ROLL_DEACTIVATE" +---|"BONUS_ROLL_FAILED" +---|"BONUS_ROLL_RESULT" # `typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, currencyID, isSecondaryResult, corrupted` +---|"BONUS_ROLL_STARTED" +---|"BOSS_KILL" # `encounterID, encounterName` +---|"BULK_PURCHASE_RESULT_RECEIVED" # `result, productResults, bestTopUpProductID, totalCost` +---|"BULK_REFUND_RESULT_RECEIVED" # `result` +---|"B_NET_NEIGHBORHOOD_LIST_UPDATED" # `result, neighborhoodInfos` +---|"CALENDAR_ACTION_PENDING" # `pending` +---|"CALENDAR_CLOSE_EVENT" +---|"CALENDAR_EVENT_ALARM" # `title, hour, minute` +---|"CALENDAR_NEW_EVENT" # `isCopy` +---|"CALENDAR_OPEN_EVENT" # `calendarType` +---|"CALENDAR_UPDATE_ERROR" # `errorReason` +---|"CALENDAR_UPDATE_ERROR_WITH_COUNT" # `errorReason, count` +---|"CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME" # `errorReason, playerName` +---|"CALENDAR_UPDATE_EVENT" +---|"CALENDAR_UPDATE_EVENT_LIST" +---|"CALENDAR_UPDATE_GUILD_EVENTS" +---|"CALENDAR_UPDATE_INVITE_LIST" # `hasCompleteList` +---|"CALENDAR_UPDATE_PENDING_INVITES" +---|"CANCEL_ALL_LOOT_ROLLS" +---|"CANCEL_GLYPH_CAST" +---|"CANCEL_LOOT_ROLL" # `rollID` +---|"CANCEL_NEIGHBORHOOD_INVITE_RESPONSE" # `result, playerName` +---|"CANCEL_PLAYER_COUNTDOWN" # `initiatedBy, informChat, initiatedByName` +---|"CANCEL_SUMMON" +---|"CAN_LOCAL_WHISPER_TARGET_RESPONSE" # `whisperTarget, status` +---|"CAN_PLAYER_SPEAK_LANGUAGE_CHANGED" # `languageId, canSpeakLanguage` +---|"CAPTUREFRAMES_FAILED" +---|"CAPTUREFRAMES_SUCCEEDED" +---|"CATALOG_SHOP_ADD_PENDING_PRODUCT" # `productID` +---|"CATALOG_SHOP_DATA_REFRESH" # `shoppingSessionUUIDStr` +---|"CATALOG_SHOP_DISABLED" +---|"CATALOG_SHOP_FETCH_FAILURE" # `shoppingSessionUUIDStr` +---|"CATALOG_SHOP_FETCH_SUCCESS" # `shoppingSessionUUIDStr` +---|"CATALOG_SHOP_OPEN_SIMPLE_CHECKOUT" # `checkoutID` +---|"CATALOG_SHOP_PURCHASE_SUCCESS" # `productID` +---|"CATALOG_SHOP_REBUILD_SCROLL_BOX" +---|"CATALOG_SHOP_REFUNDABLE_DECORS_UPDATED" +---|"CATALOG_SHOP_REMOVE_PENDING_PRODUCT" # `productID` +---|"CATALOG_SHOP_RESULT_ERROR" +---|"CATALOG_SHOP_SPECIFIC_PRODUCT_REFRESH" # `productID` +---|"CATALOG_SHOP_VIRTUAL_CURRENCY_BALANCE_UPDATE" # `currencyCode, balance` +---|"CATALOG_SHOP_VIRTUAL_CURRENCY_BALANCE_UPDATE_FAILURE" # `currencyCode` +---|"CAUTIONARY_CHANNEL_MESSAGE" # `confirmNumber` +---|"CAUTIONARY_CHAT_MESSAGE" # `chatLineID, confirmNumber` +---|"CEMETERY_PREFERENCE_UPDATED" +---|"CHALLENGE_MODE_COMPLETED" +---|"CHALLENGE_MODE_COMPLETED_REWARDS" # `mapID, medal, timeMS, money, rewards` +---|"CHALLENGE_MODE_DEATH_COUNT_UPDATED" +---|"CHALLENGE_MODE_KEYSTONE_RECEPTABLE_OPEN" +---|"CHALLENGE_MODE_KEYSTONE_SLOTTED" # `keystoneID` +---|"CHALLENGE_MODE_LEADERBOARD_RESULT" # `mapID, challengeModeID, page, results` +---|"CHALLENGE_MODE_LEADERS_UPDATE" +---|"CHALLENGE_MODE_LEAVER_TIMER_ENDED" +---|"CHALLENGE_MODE_LEAVER_TIMER_STARTED" +---|"CHALLENGE_MODE_MAPS_UPDATE" +---|"CHALLENGE_MODE_MEMBER_INFO_UPDATED" +---|"CHALLENGE_MODE_NEW_RECORD" # `mapID, timeMS, medal` +---|"CHALLENGE_MODE_RESET" # `mapID` +---|"CHALLENGE_MODE_START" # `mapID` +---|"CHANNEL_COUNT_UPDATE" # `displayIndex, count` +---|"CHANNEL_FLAGS_UPDATED" # `displayIndex` +---|"CHANNEL_INVITE_REQUEST" # `channelID, name` +---|"CHANNEL_LEFT" # `chatChannelID, name` +---|"CHANNEL_PASSWORD_REQUEST" # `channelID` +---|"CHANNEL_ROSTER_UPDATE" # `displayIndex, count` +---|"CHANNEL_UI_UPDATE" +---|"CHARACTER_ITEM_FIXUP_NOTIFICATION" # `fixupVersion` +---|"CHARACTER_POINTS_CHANGED" # `change` +---|"CHARACTER_UPGRADE_SPELL_TIER_SET" # `tierIndex` +---|"CHAT_COMBAT_MSG_ARENA_POINTS_GAIN" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_DISABLED_CHANGED" # `disabled` +---|"CHAT_DISABLED_CHANGE_FAILED" # `disabled` +---|"CHAT_LOGGING_CHANGED" # `whichLog, isEnabled` +---|"CHAT_MSG_ACHIEVEMENT" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_ADDON" # `prefix, text, channel, sender, target, zoneChannelID, localID, name, instanceID` +---|"CHAT_MSG_ADDON_LOGGED" # `prefix, text, channel, sender, target, zoneChannelID, localID, name, instanceID` +---|"CHAT_MSG_AFK" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BG_SYSTEM_ALLIANCE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BG_SYSTEM_HORDE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BG_SYSTEM_NEUTRAL" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_INLINE_TOAST_ALERT" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_INLINE_TOAST_BROADCAST" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_INLINE_TOAST_CONVERSATION" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_WHISPER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_WHISPER_INFORM" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CHANNEL" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CHANNEL_JOIN" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CHANNEL_LEAVE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CHANNEL_LEAVE_PREVENTED" # `channelName` +---|"CHAT_MSG_CHANNEL_LIST" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CHANNEL_NOTICE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CHANNEL_NOTICE_USER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_COMBAT_FACTION_CHANGE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_COMBAT_HONOR_GAIN" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_COMBAT_MISC_INFO" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_COMBAT_XP_GAIN" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_COMMUNITIES_CHANNEL" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_CURRENCY" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_DND" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_EMOTE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_FILTERED" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_GUILD" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_GUILD_ACHIEVEMENT" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_GUILD_ITEM_LOOTED" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_IGNORED" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_INSTANCE_CHAT" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_INSTANCE_CHAT_LEADER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_LOOT" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_MONEY" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_MONSTER_EMOTE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_MONSTER_PARTY" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_MONSTER_SAY" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_MONSTER_WHISPER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_MONSTER_YELL" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_OFFICER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_OPENING" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_PARTY" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_PARTY_LEADER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_PET_BATTLE_COMBAT_LOG" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_PET_BATTLE_INFO" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_PET_INFO" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_PING" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_RAID" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_RAID_BOSS_EMOTE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_RAID_BOSS_WHISPER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_RAID_LEADER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_RAID_WARNING" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_RESTRICTED" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_SAY" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_SKILL" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_SYSTEM" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_TARGETICONS" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_TEXT_EMOTE" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_TRADESKILLS" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_VOICE_TEXT" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_WHISPER" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_WHISPER_INFORM" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_MSG_YELL" # `text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, suppressRaidIcons` +---|"CHAT_REGIONAL_SEND_FAILED" +---|"CHAT_REGIONAL_STATUS_CHANGED" # `isServiceAvailable` +---|"CHAT_SERVER_DISCONNECTED" # `isInitialMessage` +---|"CHAT_SERVER_RECONNECTED" +---|"CHEST_REWARDS_UPDATED_FROM_SERVER" +---|"CINEMATIC_START" # `canBeCancelled, forcedAspectRatio` +---|"CINEMATIC_STOP" +---|"CLASS_TALENTS_SWITCH_TO_LOADOUT_BY_INDEX" # `loadoutIndex` +---|"CLASS_TALENTS_SWITCH_TO_LOADOUT_BY_NAME" # `loadoutName` +---|"CLASS_TALENTS_SWITCH_TO_SPECIALIZATION_BY_INDEX" # `specIndex` +---|"CLASS_TALENTS_SWITCH_TO_SPECIALIZATION_BY_NAME" # `specName` +---|"CLASS_TRIAL_TIMER_START" +---|"CLASS_TRIAL_UPGRADE_COMPLETE" +---|"CLEAR_BOSS_EMOTES" +---|"CLICKBINDINGS_SET_HIGHLIGHTS_SHOWN" # `showHighlights` +---|"CLIENT_SCENE_CLOSED" +---|"CLIENT_SCENE_OPENED" # `sceneType` +---|"CLOSE_CHARTER_CONFIRMATION_UI" +---|"CLOSE_CREATE_CHARTER_NEIGHBORHOOD_UI" +---|"CLOSE_CREATE_GUILD_NEIGHBORHOOD_UI" +---|"CLOSE_INBOX_ITEM" # `mailIndex` +---|"CLOSE_PLOT_CORNERSTONE" +---|"CLOSE_TABARD_FRAME" +---|"CLUB_ADDED" # `clubId` +---|"CLUB_ERROR" # `action, error, clubType` +---|"CLUB_FINDER_APPLICANT_INVITE_RECIEVED" # `clubFinderGUIDs` +---|"CLUB_FINDER_APPLICATIONS_UPDATED" # `type, clubFinderGUIDs` +---|"CLUB_FINDER_CAN_WHISPER_APPLICANT" # `applicant` +---|"CLUB_FINDER_CLUB_LIST_RETURNED" # `type` +---|"CLUB_FINDER_CLUB_REPORTED" # `type, clubFinderGUID` +---|"CLUB_FINDER_COMMUNITY_OFFLINE_JOIN" # `clubId` +---|"CLUB_FINDER_ENABLED_OR_DISABLED" +---|"CLUB_FINDER_GUILD_REALM_NAME_UPDATED" # `clubFinderGUID, realmName` +---|"CLUB_FINDER_LINKED_CLUB_RETURNED" # `clubInfo` +---|"CLUB_FINDER_MEMBERSHIP_LIST_CHANGED" +---|"CLUB_FINDER_PLAYER_PENDING_LIST_RECIEVED" # `type` +---|"CLUB_FINDER_POST_UPDATED" # `clubFinderGUIDs` +---|"CLUB_FINDER_RECRUITMENT_POST_RETURNED" # `type` +---|"CLUB_FINDER_RECRUITS_UPDATED" # `type` +---|"CLUB_FINDER_RECRUIT_LIST_CHANGED" +---|"CLUB_INVITATIONS_RECEIVED_FOR_CLUB" # `clubId` +---|"CLUB_INVITATION_ADDED_FOR_SELF" # `invitation` +---|"CLUB_INVITATION_REMOVED_FOR_SELF" # `invitationId` +---|"CLUB_MEMBERS_UPDATED" # `clubId` +---|"CLUB_MEMBER_ADDED" # `clubId, memberId` +---|"CLUB_MEMBER_PRESENCE_UPDATED" # `clubId, memberId, presence` +---|"CLUB_MEMBER_REMOVED" # `clubId, memberId` +---|"CLUB_MEMBER_ROLE_UPDATED" # `clubId, memberId, roleId` +---|"CLUB_MEMBER_UPDATED" # `clubId, memberId` +---|"CLUB_MESSAGE_ADDED" # `clubId, streamId, messageId` +---|"CLUB_MESSAGE_HISTORY_RECEIVED" # `clubId, streamId, downloadedRange, contiguousRange` +---|"CLUB_MESSAGE_UPDATED" # `clubId, streamId, messageId` +---|"CLUB_REMOVED" # `clubId` +---|"CLUB_REMOVED_MESSAGE" # `clubName, clubRemovedReason` +---|"CLUB_SELF_MEMBER_ROLE_UPDATED" # `clubId, roleId` +---|"CLUB_STREAMS_LOADED" # `clubId` +---|"CLUB_STREAM_ADDED" # `clubId, streamId` +---|"CLUB_STREAM_REMOVED" # `clubId, streamId` +---|"CLUB_STREAM_SUBSCRIBED" # `clubId, streamId` +---|"CLUB_STREAM_UNSUBSCRIBED" # `clubId, streamId` +---|"CLUB_STREAM_UPDATED" # `clubId, streamId` +---|"CLUB_TICKETS_RECEIVED" # `clubId` +---|"CLUB_TICKET_CREATED" # `clubId, ticketInfo` +---|"CLUB_TICKET_RECEIVED" # `ticket` +---|"CLUB_UPDATED" # `clubId` +---|"COLOR_OVERRIDES_RESET" +---|"COLOR_OVERRIDE_UPDATED" # `overrideType` +---|"COMBAT_LOG_APPLY_FILTER_SETTINGS" # `filterSettings` +---|"COMBAT_LOG_ENTRIES_CLEARED" +---|"COMBAT_LOG_EVENT" +---|"COMBAT_LOG_EVENT_INTERNAL_UNFILTERED" +---|"COMBAT_LOG_EVENT_UNFILTERED" +---|"COMBAT_LOG_MESSAGE" # `message, colorR, colorG, colorB, order` +---|"COMBAT_LOG_MESSAGE_LIMIT_CHANGED" # `messageLimit` +---|"COMBAT_LOG_REFILTER_ENTRIES" +---|"COMBAT_RATING_UPDATE" +---|"COMBAT_TEXT_UPDATE" # `combatTextType` +---|"COMBO_TARGET_CHANGED" +---|"COMMENTATOR_COMBAT_EVENT" +---|"COMMENTATOR_ENTER_WORLD" +---|"COMMENTATOR_HISTORY_FLUSHED" +---|"COMMENTATOR_IMMEDIATE_FOV_UPDATE" # `fov` +---|"COMMENTATOR_MAP_UPDATE" +---|"COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE" # `nameToOverride, overrideName` +---|"COMMENTATOR_PLAYER_UPDATE" +---|"COMMENTATOR_RESET_SETTINGS" +---|"COMMENTATOR_TEAMS_SWAPPED" # `swapped` +---|"COMMENTATOR_TEAM_NAME_UPDATE" # `teamName` +---|"COMMODITY_PRICE_UNAVAILABLE" +---|"COMMODITY_PRICE_UPDATED" # `updatedUnitPrice, updatedTotalPrice` +---|"COMMODITY_PURCHASED" # `itemID, quantity` +---|"COMMODITY_PURCHASE_FAILED" +---|"COMMODITY_PURCHASE_SUCCEEDED" +---|"COMMODITY_SEARCH_RESULTS_ADDED" # `itemID` +---|"COMMODITY_SEARCH_RESULTS_RECEIVED" +---|"COMMODITY_SEARCH_RESULTS_UPDATED" # `itemID` +---|"COMPACT_UNIT_FRAME_PROFILES_LOADED" +---|"COMPANION_LEARNED" +---|"COMPANION_UNLEARNED" +---|"COMPANION_UPDATE" # `companionType` +---|"CONFIG_COMMIT_FAILED" # `configID` +---|"CONFIRM_BEFORE_USE" +---|"CONFIRM_BINDER" # `areaName` +---|"CONFIRM_DISENCHANT_ROLL" # `rollID, rollType` +---|"CONFIRM_LOOT_ROLL" # `rollID, rollType, confirmReason` +---|"CONFIRM_PET_UNLEARN" # `cost` +---|"CONFIRM_SUMMON" # `summonReason, skippingStartExperience` +---|"CONFIRM_TALENT_WIPE" # `cost, respecType` +---|"CONFIRM_XP_LOSS" +---|"CONSOLE_CLEAR" +---|"CONSOLE_COLORS_CHANGED" +---|"CONSOLE_FONT_SIZE_CHANGED" +---|"CONSOLE_LOG" # `message` +---|"CONSOLE_MESSAGE" # `message, colorType` +---|"CONTENT_TRACKING_IS_ENABLED_UPDATE" # `isEnabled` +---|"CONTENT_TRACKING_LIST_UPDATE" +---|"CONTENT_TRACKING_UPDATE" # `type, id, isTracked` +---|"CONTRIBUTION_CHANGED" # `state, result, name, contributionID` +---|"CONTRIBUTION_COLLECTOR_PENDING" # `contributionID, isPending, result` +---|"CONTRIBUTION_COLLECTOR_UPDATE" +---|"CONTRIBUTION_COLLECTOR_UPDATE_SINGLE" # `contributionID` +---|"CONVERT_TO_BIND_TO_ACCOUNT_CONFIRM" +---|"CONVERT_TO_RAID_CONFIRMATION" +---|"COOLDOWN_VIEWER_DATA_LOADED" +---|"COOLDOWN_VIEWER_SPELL_OVERRIDE_UPDATED" # `baseSpellID, overrideSpellID` +---|"COOLDOWN_VIEWER_TABLE_HOTFIXED" +---|"CORPSE_IN_INSTANCE" +---|"CORPSE_IN_RANGE" +---|"CORPSE_OUT_OF_RANGE" +---|"COVENANT_CALLINGS_UPDATED" # `callings` +---|"COVENANT_CHOSEN" # `covenantID` +---|"COVENANT_PREVIEW_CLOSE" +---|"COVENANT_PREVIEW_OPEN" # `previewInfo` +---|"COVENANT_RENOWN_CATCH_UP_STATE_UPDATE" +---|"COVENANT_SANCTUM_RENOWN_LEVEL_CHANGED" # `newRenownLevel, oldRenownLevel` +---|"CRAFTINGORDERS_CAN_REQUEST" +---|"CRAFTINGORDERS_CLAIMED_ORDER_ADDED" +---|"CRAFTINGORDERS_CLAIMED_ORDER_REMOVED" +---|"CRAFTINGORDERS_CLAIMED_ORDER_UPDATED" # `orderID` +---|"CRAFTINGORDERS_CLAIM_ORDER_RESPONSE" # `result, orderID` +---|"CRAFTINGORDERS_CRAFT_ORDER_RESPONSE" # `result, orderID` +---|"CRAFTINGORDERS_CUSTOMER_FAVORITES_CHANGED" +---|"CRAFTINGORDERS_CUSTOMER_OPTIONS_PARSED" +---|"CRAFTINGORDERS_DISPLAY_CRAFTER_FULFILLED_MSG" # `orderTypeString, itemNameString, playerNameString, tipAmount, quantityCrafted` +---|"CRAFTINGORDERS_FULFILL_ORDER_RESPONSE" # `result, orderID` +---|"CRAFTINGORDERS_HIDE_CRAFTER" +---|"CRAFTINGORDERS_HIDE_CUSTOMER" +---|"CRAFTINGORDERS_ORDER_CANCEL_RESPONSE" # `result` +---|"CRAFTINGORDERS_ORDER_PLACEMENT_RESPONSE" # `result` +---|"CRAFTINGORDERS_REJECT_ORDER_RESPONSE" # `result, orderID` +---|"CRAFTINGORDERS_RELEASE_ORDER_RESPONSE" # `result, orderID` +---|"CRAFTINGORDERS_SHOW_CRAFTER" +---|"CRAFTINGORDERS_SHOW_CUSTOMER" +---|"CRAFTINGORDERS_UNEXPECTED_ERROR" +---|"CRAFTINGORDERS_UPDATE_CUSTOMER_NAME" # `customerName, orderID` +---|"CRAFTINGORDERS_UPDATE_ORDER_COUNT" # `orderType, numOrders` +---|"CRAFTINGORDERS_UPDATE_PERSONAL_ORDER_COUNTS" +---|"CRAFTINGORDERS_UPDATE_REWARDS" # `npcOrderRewards, orderID` +---|"CRAFTING_DETAILS_UPDATE" +---|"CRAFTING_HOUSE_DISABLED" +---|"CREATE_NEIGHBORHOOD_RESULT" # `result, neighborhoodName` +---|"CRITERIA_COMPLETE" # `criteriaID` +---|"CRITERIA_EARNED" # `achievementID, description, achievementAlreadyEarnedOnAccount` +---|"CRITERIA_UPDATE" +---|"CURRENCY_DISPLAY_UPDATE" # `currencyType, quantity, quantityChange, quantityGainSource, destroyReason` +---|"CURRENCY_TRANSFER_FAILED" # `failureReason` +---|"CURRENCY_TRANSFER_INITIATED" +---|"CURRENCY_TRANSFER_LOG_UPDATE" +---|"CURRENCY_TRANSFER_SUCCESS" +---|"CURRENT_HOUSE_INFO_RECIEVED" # `houseInfo` +---|"CURRENT_HOUSE_INFO_UPDATED" # `houseInfo` +---|"CURRENT_SPELL_CAST_CHANGED" # `cancelledCast` +---|"CURSOR_CHANGED" # `isDefault, newCursorType, oldCursorType, oldCursorVirtualID` +---|"CVAR_UPDATE" # `eventName, value` +---|"DAILY_RESET_INSTANCE_WELCOME" # `mapname, timeLeft` +---|"DAMAGE_METER_COMBAT_SESSION_UPDATED" # `type, sessionID` +---|"DAMAGE_METER_CURRENT_SESSION_UPDATED" +---|"DAMAGE_METER_RESET" +---|"DECLINE_NEIGHBORHOOD_INVITATION_RESPONSE" # `success` +---|"DELETE_ITEM_CONFIRM" # `itemName, qualityID, bonding, questWarn` +---|"DELVES_ACCOUNT_DATA_ELEMENT_CHANGED" +---|"DELVE_ASSIST_ACTION" # `data` +---|"DISABLE_DECLINE_GUILD_INVITE" +---|"DISABLE_LOW_LEVEL_RAID" +---|"DISABLE_TAXI_BENCHMARK" +---|"DISABLE_XP_GAIN" +---|"DISPLAY_EVENT_TOASTS" +---|"DISPLAY_EVENT_TOAST_LINK" # `link` +---|"DISPLAY_SIZE_CHANGED" +---|"DUEL_FINISHED" +---|"DUEL_INBOUNDS" +---|"DUEL_OUTOFBOUNDS" +---|"DUEL_REQUESTED" # `playerName` +---|"DUEL_TO_THE_DEATH_REQUESTED" # `playerName` +---|"DYE_COLOR_CATEGORY_UPDATED" # `dyeColorCategoryID` +---|"DYE_COLOR_UPDATED" # `dyeColorID` +---|"DYNAMIC_GOSSIP_POI_UPDATED" +---|"ECLIPSE_DIRECTION_CHANGE" # `direction` +---|"EDIT_MODE_LAYOUTS_UPDATED" # `layoutInfo, reconcileLayouts` +---|"EJ_DIFFICULTY_UPDATE" # `difficultyID` +---|"EJ_LOOT_DATA_RECIEVED" # `itemID` +---|"ENABLE_DECLINE_GUILD_INVITE" +---|"ENABLE_LOW_LEVEL_RAID" +---|"ENABLE_TAXI_BENCHMARK" +---|"ENABLE_XP_GAIN" +---|"ENCHANT_SPELL_COMPLETED" # `successful, enchantedItem` +---|"ENCHANT_SPELL_SELECTED" +---|"ENCOUNTER_END" # `encounterID, encounterName, difficultyID, groupSize, success` +---|"ENCOUNTER_LOOT_RECEIVED" # `encounterID, itemID, itemLink, quantity, itemName, fileName` +---|"ENCOUNTER_START" # `encounterID, encounterName, difficultyID, groupSize` +---|"ENCOUNTER_STATE_CHANGED" # `isInProgress` +---|"ENCOUNTER_TIMELINE_EVENT_ADDED" # `eventInfo` +---|"ENCOUNTER_TIMELINE_EVENT_BLOCK_STATE_CHANGED" # `eventID` +---|"ENCOUNTER_TIMELINE_EVENT_HIGHLIGHT" # `eventID` +---|"ENCOUNTER_TIMELINE_EVENT_REMOVED" # `eventID` +---|"ENCOUNTER_TIMELINE_EVENT_STATE_CHANGED" # `eventID` +---|"ENCOUNTER_TIMELINE_EVENT_TRACK_CHANGED" # `eventID` +---|"ENCOUNTER_TIMELINE_LAYOUT_UPDATED" +---|"ENCOUNTER_TIMELINE_STATE_UPDATED" +---|"ENCOUNTER_TIMELINE_VIEW_ACTIVATED" # `viewType` +---|"ENCOUNTER_TIMELINE_VIEW_DEACTIVATED" # `viewType` +---|"ENCOUNTER_WARNING" # `encounterWarningInfo` +---|"END_BOUND_TRADEABLE" # `reason` +---|"ENTERED_DIFFERENT_INSTANCE_FROM_PARTY" +---|"ENTITLEMENT_DELIVERED" # `entitlementType, textureID, name, payloadID, showFancyToast` +---|"EQUIPMENT_SETS_CHANGED" +---|"EQUIPMENT_SWAP_FINISHED" # `result, setID` +---|"EQUIPMENT_SWAP_PENDING" +---|"EQUIP_BIND_CONFIRM" # `slot, itemLocation` +---|"EQUIP_BIND_REFUNDABLE_CONFIRM" # `slot, itemLocation` +---|"EQUIP_BIND_TRADEABLE_CONFIRM" # `slot, itemLocation` +---|"EVENT_REALM_QUEUES_UPDATED" # `eventRealmQueues` +---|"EVENT_SCHEDULER_UPDATE" +---|"EXPAND_BAG_BAR_CHANGED" # `expandBagBar` +---|"EXTRA_BROWSE_INFO_RECEIVED" # `itemID` +---|"FACTION_STANDING_CHANGED" # `factionID, updatedStanding` +---|"FIRST_FRAME_RENDERED" +---|"FOG_OF_WAR_UPDATED" +---|"FORBIDDEN_NAME_PLATE_CREATED" # `namePlateFrame` +---|"FORBIDDEN_NAME_PLATE_UNIT_ADDED" # `unitToken` +---|"FORBIDDEN_NAME_PLATE_UNIT_REMOVED" # `unitToken` +---|"FORCE_REFRESH_HOUSE_FINDER" +---|"FRAME_MANAGER_UPDATE_ALL" +---|"FRAME_MANAGER_UPDATE_FRAME" # `type, show` +---|"FRIENDLIST_UPDATE" +---|"GAME_MODE_DISPLAY_INFO_UPDATED" +---|"GAME_MODE_DISPLAY_MODE_TOGGLE_DISABLED" # `gameModeRecordID, disabled` +---|"GAME_PAD_ACTIVE_CHANGED" # `isActive` +---|"GAME_PAD_CONFIGS_CHANGED" +---|"GAME_PAD_CONNECTED" +---|"GAME_PAD_DISCONNECTED" +---|"GAME_PAD_POWER_CHANGED" # `powerLevel` +---|"GARRISON_ARCHITECT_CLOSED" +---|"GARRISON_ARCHITECT_OPENED" # `followerTypeID` +---|"GARRISON_BUILDING_ACTIVATABLE" # `buildingName, garrisonType` +---|"GARRISON_BUILDING_ACTIVATED" # `garrisonPlotInstanceID, garrisonBuildingID` +---|"GARRISON_BUILDING_ERROR" +---|"GARRISON_BUILDING_LIST_UPDATE" # `categoryID` +---|"GARRISON_BUILDING_PLACED" # `garrisonPlotInstanceID, newPlacement` +---|"GARRISON_BUILDING_REMOVED" # `garrPlotInstanceID, garrBuildingID` +---|"GARRISON_BUILDING_UPDATE" # `garrisonBuildingID, garrPlotInstanceID` +---|"GARRISON_FOLLOWER_ADDED" # `followerDbID, followerName, followerClassName, followerLevel, followerQuality, isUpgraded, textureKit, followerTypeID` +---|"GARRISON_FOLLOWER_CATEGORIES_UPDATED" +---|"GARRISON_FOLLOWER_DURABILITY_CHANGED" # `garrFollowerTypeID, followerDbID, followerDurability` +---|"GARRISON_FOLLOWER_HEALED" # `followerID` +---|"GARRISON_FOLLOWER_LIST_UPDATE" # `followerTypeID` +---|"GARRISON_FOLLOWER_REMOVED" # `followerTypeID` +---|"GARRISON_FOLLOWER_UPGRADED" # `followerDbID` +---|"GARRISON_FOLLOWER_XP_CHANGED" # `garrFollowerTypeID, followerDbID, xpChange, oldFollowerXp, oldFollowerLevel, oldFollowerQuality` +---|"GARRISON_HIDE_LANDING_PAGE" +---|"GARRISON_INVASION_AVAILABLE" +---|"GARRISON_INVASION_UNAVAILABLE" +---|"GARRISON_LANDINGPAGE_SHIPMENTS" +---|"GARRISON_MISSION_AREA_BONUS_ADDED" # `garrisonMissonBonusAbilityID` +---|"GARRISON_MISSION_BONUS_ROLL_COMPLETE" # `missionID, success` +---|"GARRISON_MISSION_BONUS_ROLL_LOOT" # `itemID, quantity` +---|"GARRISON_MISSION_COMPLETE_RESPONSE" # `missionID, canComplete, success, bonusRollSuccess, followerDeaths, autoCombatResult` +---|"GARRISON_MISSION_FINISHED" # `followerTypeID, missionID` +---|"GARRISON_MISSION_LIST_UPDATE" # `garrFollowerTypeID` +---|"GARRISON_MISSION_NPC_CLOSED" +---|"GARRISON_MISSION_NPC_OPENED" # `followerTypeID` +---|"GARRISON_MISSION_REWARD_INFO" # `missionID, followerDbID` +---|"GARRISON_MISSION_STARTED" # `garrFollowerTypeID, missionID` +---|"GARRISON_MONUMENT_CLOSE_UI" +---|"GARRISON_MONUMENT_LIST_LOADED" # `success` +---|"GARRISON_MONUMENT_REPLACED" # `success` +---|"GARRISON_MONUMENT_SELECTED_TROPHY_ID_LOADED" # `success` +---|"GARRISON_MONUMENT_SHOW_UI" +---|"GARRISON_RANDOM_MISSION_ADDED" # `followerTypeID, missionID` +---|"GARRISON_RECALL_PORTAL_LAST_USED_TIME" # `success, recallPortalLastUsedTime` +---|"GARRISON_RECALL_PORTAL_USED" # `success` +---|"GARRISON_RECRUITMENT_FOLLOWERS_GENERATED" +---|"GARRISON_RECRUITMENT_NPC_CLOSED" +---|"GARRISON_RECRUITMENT_NPC_OPENED" # `followerTypeID` +---|"GARRISON_RECRUITMENT_READY" +---|"GARRISON_RECRUIT_FOLLOWER_RESULT" +---|"GARRISON_SHIPMENT_RECEIVED" +---|"GARRISON_SHIPYARD_NPC_CLOSED" +---|"GARRISON_SHIPYARD_NPC_OPENED" # `followerTypeID` +---|"GARRISON_SHOW_LANDING_PAGE" +---|"GARRISON_SPEC_GROUPS_CLEARED" # `garrTypeID` +---|"GARRISON_SPEC_GROUP_UPDATED" # `garrTypeID, specID` +---|"GARRISON_TALENT_COMPLETE" # `garrTypeID, doAlert` +---|"GARRISON_TALENT_EVENT_UPDATE" # `eventType, eventID` +---|"GARRISON_TALENT_NPC_CLOSED" +---|"GARRISON_TALENT_NPC_OPENED" # `garrisonTypeID, garrisonTalentTreeID` +---|"GARRISON_TALENT_RESEARCH_STARTED" # `garrTypeID, garrisonTalentTreeID, garrTalentID` +---|"GARRISON_TALENT_UNLOCKS_RESULT" +---|"GARRISON_TALENT_UPDATE" # `garrTypeID` +---|"GARRISON_TRADESKILL_NPC_CLOSED" +---|"GARRISON_UPDATE" +---|"GARRISON_UPGRADEABLE_RESULT" # `garrisonUpgradeable` +---|"GARRISON_USE_PARTY_GARRISON_CHANGED" +---|"GDF_SIM_COMPLETE" +---|"GENERIC_ERROR" # `errorMessage` +---|"GENERIC_WIDGET_DISPLAY_SHOW" # `info` +---|"GET_ITEM_INFO_RECEIVED" # `itemID, success` +---|"GLOBAL_MOUSE_DOWN" # `button` +---|"GLOBAL_MOUSE_UP" # `button` +---|"GLUE_SCREENSHOT_FAILED" +---|"GLUE_SCREENSHOT_STARTED" +---|"GLUE_SCREENSHOT_SUCCEEDED" +---|"GM_PLAYER_INFO" # `name, info` +---|"GOSSIP_CLOSED" # `interactionIsContinuing` +---|"GOSSIP_CONFIRM" # `gossipID, text, cost` +---|"GOSSIP_CONFIRM_CANCEL" +---|"GOSSIP_ENTER_CODE" # `gossipID` +---|"GOSSIP_OPTIONS_REFRESHED" +---|"GOSSIP_SHOW" # `uiTextureKit` +---|"GROUP_FORMED" # `category, partyGUID` +---|"GROUP_INVITE_CONFIRMATION" +---|"GROUP_JOINED" # `category, partyGUID` +---|"GROUP_LEFT" # `category, partyGUID` +---|"GROUP_ROSTER_UPDATE" +---|"GUILDBANKBAGSLOTS_CHANGED" +---|"GUILDBANKFRAME_CLOSED" +---|"GUILDBANKFRAME_OPENED" +---|"GUILDBANKLOG_UPDATE" +---|"GUILDBANK_ITEM_LOCK_CHANGED" +---|"GUILDBANK_TEXT_CHANGED" # `guildBankTab` +---|"GUILDBANK_UPDATE_MONEY" +---|"GUILDBANK_UPDATE_TABS" +---|"GUILDBANK_UPDATE_TEXT" # `guildBankTab` +---|"GUILDBANK_UPDATE_WITHDRAWMONEY" +---|"GUILDTABARD_UPDATE" +---|"GUILD_CHALLENGE_COMPLETED" # `challengeType, currentCount, maxCount, goldAwarded` +---|"GUILD_CHALLENGE_UPDATED" +---|"GUILD_EVENT_LOG_UPDATE" +---|"GUILD_INVITE_CANCEL" +---|"GUILD_INVITE_REQUEST" # `inviter, guildName, guildAchievementPoints, oldGuildName, isNewGuild, tabardInfo` +---|"GUILD_MOTD" # `motdText` +---|"GUILD_NEWS_UPDATE" +---|"GUILD_PARTY_STATE_UPDATED" # `inGuildParty` +---|"GUILD_RANKS_UPDATE" +---|"GUILD_RECIPE_KNOWN_BY_MEMBERS" +---|"GUILD_REGISTRAR_CLOSED" +---|"GUILD_REGISTRAR_SHOW" +---|"GUILD_RENAME_NAME_CHECK" # `desiredName, status, nameErrorToken` +---|"GUILD_RENAME_REFUND_RESULT" # `guildName, status` +---|"GUILD_RENAME_REQUIRED" # `flagSet` +---|"GUILD_RENAME_STATUS_UPDATE" # `status` +---|"GUILD_REWARDS_LIST" +---|"GUILD_REWARDS_LIST_UPDATE" +---|"GUILD_ROSTER_UPDATE" # `canRequestRosterUpdate` +---|"GUILD_TRADESKILL_UPDATE" +---|"GX_RESTARTED" +---|"HANDLE_UI_ACTION" # `actionType` +---|"HARDCORE_DEATHS" # `memberName` +---|"HEARTHSTONE_BOUND" +---|"HEIRLOOMS_UPDATED" # `itemID, updateReason, hideUntilLearned` +---|"HEIRLOOM_UPGRADE_TARGETING_CHANGED" # `pendingHeirloomUpgradeSpellcast` +---|"HIDE_HYPERLINK_TOOLTIP" +---|"HIDE_SUBTITLE" +---|"HONOR_LEVEL_UPDATE" # `isHigherLevel` +---|"HONOR_XP_UPDATE" # `unitTarget` +---|"HOUSE_DECOR_ADDED_TO_CHEST" # `decorGUID, decorID` +---|"HOUSE_EDITOR_AVAILABILITY_CHANGED" +---|"HOUSE_EDITOR_MODE_CHANGED" # `currentEditMode` +---|"HOUSE_EDITOR_MODE_CHANGE_FAILURE" # `result` +---|"HOUSE_EXTERIOR_DECOR_HIDDEN_CHANGED" # `isDecorHidden` +---|"HOUSE_EXTERIOR_POSITION_FAILURE" # `housingResult` +---|"HOUSE_EXTERIOR_POSITION_SUCCESS" +---|"HOUSE_EXTERIOR_TYPE_UNLOCKED" # `fixtureID` +---|"HOUSE_FINDER_NEIGHBORHOOD_DATA_RECIEVED" # `neighborhoodPlots` +---|"HOUSE_INFO_UPDATED" +---|"HOUSE_LEVEL_CHANGED" # `newHouseLevelInfo` +---|"HOUSE_LEVEL_FAVOR_UPDATED" # `houseLevelFavor` +---|"HOUSE_PLOT_ENTERED" +---|"HOUSE_PLOT_EXITED" +---|"HOUSE_RESERVATION_RESPONSE_RECIEVED" # `result` +---|"HOUSING_BASIC_MODE_HOVERED_TARGET_CHANGED" # `hasHoveredTarget, targetType` +---|"HOUSING_BASIC_MODE_PLACEMENT_FLAGS_UPDATED" # `targetType, activeFlags` +---|"HOUSING_BASIC_MODE_SELECTED_TARGET_CHANGED" # `hasSelectedTarget, targetType, isPreview` +---|"HOUSING_CATALOG_CATEGORY_UPDATED" # `categoryID` +---|"HOUSING_CATALOG_SUBCATEGORY_UPDATED" # `subcategoryID` +---|"HOUSING_CLEANUP_MODE_HOVERED_TARGET_CHANGED" # `hasHoveredTarget, targetType` +---|"HOUSING_CLEANUP_MODE_TARGET_SELECTED" +---|"HOUSING_CORE_FIXTURE_CHANGED" # `coreFixtureType` +---|"HOUSING_CUSTOMIZE_MODE_HOVERED_TARGET_CHANGED" # `hasHoveredTarget, targetType` +---|"HOUSING_CUSTOMIZE_MODE_SELECTED_TARGET_CHANGED" # `hasSelectedTarget, targetType` +---|"HOUSING_DECOR_ADD_TO_PREVIEW_LIST" # `previewItemData` +---|"HOUSING_DECOR_CUSTOMIZATION_CHANGED" # `decorGUID` +---|"HOUSING_DECOR_DYE_FAILURE" # `decorGUID, housingResult` +---|"HOUSING_DECOR_FREE_PLACE_STATUS_CHANGED" # `isFreePlaceEnabled` +---|"HOUSING_DECOR_GRID_SNAP_OCCURRED" +---|"HOUSING_DECOR_GRID_SNAP_STATUS_CHANGED" # `isGridSnapEnabled` +---|"HOUSING_DECOR_GRID_VISIBILITY_STATUS_CHANGED" # `isGridVisible` +---|"HOUSING_DECOR_PLACE_FAILURE" # `housingResult` +---|"HOUSING_DECOR_PLACE_SUCCESS" # `decorGUID, size, isNew, isPreview` +---|"HOUSING_DECOR_PRECISION_MANIPULATION_EVENT" # `event` +---|"HOUSING_DECOR_PRECISION_MANIPULATION_STATUS_CHANGED" # `isManipulatingSelection` +---|"HOUSING_DECOR_PRECISION_SUBMODE_CHANGED" # `activeSubmode` +---|"HOUSING_DECOR_PREVIEW_LIST_REMOVE_FROM_WORLD" # `decorGUID` +---|"HOUSING_DECOR_PREVIEW_LIST_UPDATED" +---|"HOUSING_DECOR_PREVIEW_STATE_CHANGED" # `isPreviewState` +---|"HOUSING_DECOR_REMOVED" # `decorGUID` +---|"HOUSING_DECOR_SELECT_RESPONSE" # `result` +---|"HOUSING_EXPERT_MODE_HOVERED_TARGET_CHANGED" # `hasHoveredTarget, targetType` +---|"HOUSING_EXPERT_MODE_PLACEMENT_FLAGS_UPDATED" # `targetType, activeFlags` +---|"HOUSING_EXPERT_MODE_SELECTED_TARGET_CHANGED" # `hasSelectedTarget, targetType` +---|"HOUSING_FIXTURE_HOVER_CHANGED" # `anyHovered` +---|"HOUSING_FIXTURE_POINT_FRAMES_RELEASED" +---|"HOUSING_FIXTURE_POINT_FRAME_ADDED" # `pointFrame` +---|"HOUSING_FIXTURE_POINT_FRAME_RELEASED" # `pointFrame` +---|"HOUSING_FIXTURE_POINT_SELECTION_CHANGED" # `hasSelection` +---|"HOUSING_FIXTURE_UNLOCKED" # `fixtureID` +---|"HOUSING_INSPECT_MODE_DECOR_HOVERED_CHANGED" +---|"HOUSING_INSPECT_MODE_STATE_UPDATED" +---|"HOUSING_LAYOUT_DOOR_SELECTED" # `roomGUID, componentID` +---|"HOUSING_LAYOUT_DOOR_SELECTION_CHANGED" # `hasSelection` +---|"HOUSING_LAYOUT_DRAG_TARGET_CHANGED" # `isDraggingRoom` +---|"HOUSING_LAYOUT_FLOORPLAN_SELECTION_CHANGED" # `hasSelection, roomID` +---|"HOUSING_LAYOUT_NUM_FLOORS_CHANGED" # `prevNumFloors, numFloors` +---|"HOUSING_LAYOUT_PIN_FRAMES_RELEASED" +---|"HOUSING_LAYOUT_PIN_FRAME_ADDED" # `pinFrame` +---|"HOUSING_LAYOUT_PIN_FRAME_RELEASED" # `pinFrame` +---|"HOUSING_LAYOUT_ROOM_COMPONENT_THEME_SET_CHANGED" # `roomGUID, componentID, newThemeSet, result` +---|"HOUSING_LAYOUT_ROOM_MOVED" +---|"HOUSING_LAYOUT_ROOM_MOVE_INVALID" +---|"HOUSING_LAYOUT_ROOM_RECEIVED" # `prevNumFloors, currNumFloors, isUpstairs` +---|"HOUSING_LAYOUT_ROOM_REMOVED" +---|"HOUSING_LAYOUT_ROOM_RETURNED" +---|"HOUSING_LAYOUT_ROOM_SELECTION_CHANGED" # `hasSelection` +---|"HOUSING_LAYOUT_ROOM_SNAPPED" +---|"HOUSING_LAYOUT_VIEWED_FLOOR_CHANGED" # `floor` +---|"HOUSING_MARKET_AVAILABILITY_UPDATED" +---|"HOUSING_NUM_DECOR_PLACED_CHANGED" +---|"HOUSING_REFUND_LIST_UPDATED" +---|"HOUSING_ROOM_COMPONENT_CUSTOMIZATION_CHANGED" # `roomGUID, componentID` +---|"HOUSING_ROOM_COMPONENT_CUSTOMIZATION_CHANGE_FAILED" # `roomGUID, componentID, housingResult` +---|"HOUSING_SERVICES_AVAILABILITY_UPDATED" +---|"HOUSING_SET_EXTERIOR_HOUSE_SIZE_RESPONSE" # `result` +---|"HOUSING_SET_EXTERIOR_HOUSE_TYPE_RESPONSE" # `result` +---|"HOUSING_SET_FIXTURE_RESPONSE" # `result` +---|"HOUSING_STORAGE_ENTRY_UPDATED" # `entryVariantID` +---|"HOUSING_STORAGE_UPDATED" +---|"IGNORELIST_UPDATE" +---|"IMMERSIVE_INTERACTION_BEGIN" +---|"IMMERSIVE_INTERACTION_END" +---|"INCOMING_RESURRECT_CHANGED" # `unitTarget` +---|"INCOMING_SUMMON_CHANGED" # `unitTarget` +---|"INITIAL_CLUBS_LOADED" +---|"INITIAL_HOTFIXES_APPLIED" +---|"INITIATIVE_ACTIVITY_LOG_UPDATED" +---|"INITIATIVE_COMPLETED" # `initiativeTitle` +---|"INITIATIVE_TASKS_TRACKED_LIST_CHANGED" # `initiativeTaskID, added` +---|"INITIATIVE_TASKS_TRACKED_UPDATED" +---|"INITIATIVE_TASK_COMPLETED" # `taskName` +---|"INSPECT_ACHIEVEMENT_READY" # `guid` +---|"INSPECT_HONOR_UPDATE" +---|"INSPECT_READY" # `inspecteeGUID` +---|"INSTANCE_ABANDON_VOTE_FINISHED" # `votePassed` +---|"INSTANCE_ABANDON_VOTE_STARTED" +---|"INSTANCE_ABANDON_VOTE_UPDATED" +---|"INSTANCE_BOOT_START" +---|"INSTANCE_BOOT_STOP" +---|"INSTANCE_ENCOUNTER_ADD_TIMER" # `timeRemaining` +---|"INSTANCE_ENCOUNTER_ENGAGE_UNIT" +---|"INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE" # `objectiveID` +---|"INSTANCE_ENCOUNTER_OBJECTIVE_START" # `objectiveID, objectiveProgress` +---|"INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE" # `objectiveID, objectiveProgress` +---|"INSTANCE_GROUP_SIZE_CHANGED" +---|"INSTANCE_LEAVER_STATUS_CHANGED" # `isLeaver` +---|"INSTANCE_LOCK_START" +---|"INSTANCE_LOCK_STOP" +---|"INSTANCE_LOCK_WARNING" +---|"INSTANCE_RESET_WARNING" # `warningMessage, timeLeft` +---|"INVENTORY_SEARCH_UPDATE" +---|"INVITE_TO_PARTY_CONFIRMATION" # `targetName, willConvertToRaid, questSessionActive` +---|"INVITE_TRAVEL_PASS_CONFIRMATION" # `targetName, targetGUID, willConvertToRaid, questSessionActive` +---|"ISLANDS_QUEUE_CLOSE" +---|"ISLANDS_QUEUE_OPEN" +---|"ISLAND_AZERITE_GAIN" # `amount, gainedByPlayer, factionIndex, gainedBy, gainedFrom` +---|"ISLAND_COMPLETED" # `mapID, winner` +---|"ITEM_CHANGED" # `previousHyperlink, newHyperlink` +---|"ITEM_CONVERSION_DATA_READY" # `itemGUID` +---|"ITEM_COUNT_CHANGED" # `itemID` +---|"ITEM_DATA_LOAD_RESULT" # `itemID, success` +---|"ITEM_INTERACTION_CHARGE_INFO_UPDATED" +---|"ITEM_INTERACTION_ITEM_SELECTION_UPDATED" # `itemLocation` +---|"ITEM_KEY_ITEM_INFO_RECEIVED" # `itemID` +---|"ITEM_LOCKED" # `bagOrSlotIndex, slotIndex` +---|"ITEM_LOCK_CHANGED" # `bagOrSlotIndex, slotIndex` +---|"ITEM_PURCHASED" # `itemID` +---|"ITEM_PUSH" # `bagSlot, iconFileID` +---|"ITEM_RESTORATION_BUTTON_STATUS" +---|"ITEM_SEARCH_RESULTS_ADDED" # `itemKey` +---|"ITEM_SEARCH_RESULTS_UPDATED" # `itemKey, newAuctionID` +---|"ITEM_TEXT_BEGIN" +---|"ITEM_TEXT_CLOSED" +---|"ITEM_TEXT_READY" +---|"ITEM_TEXT_TRANSLATION" # `delay` +---|"ITEM_UNLOCKED" # `bagOrSlotIndex, slotIndex` +---|"ITEM_UPGRADE_FAILED" +---|"ITEM_UPGRADE_MASTER_SET_ITEM" +---|"ITEM_UPGRADE_MASTER_UPDATE" +---|"JAILERS_TOWER_LEVEL_UPDATE" # `level, type` +---|"KNOWN_TITLES_UPDATE" # `unitTarget` +---|"LANGUAGE_LIST_CHANGED" +---|"LEARNED_SPELL_IN_SKILL_LINE" # `spellID, skillLineIndex, isGuildPerkSpell` +---|"LEAVE_PARTY_CONFIRMATION" # `reason` +---|"LEAVING_TUTORIAL_AREA" +---|"LEGACY_LOOT_RULES_CHANGED" # `isLegacyLootModeEnabled` +---|"LET_RECENT_ALLIES_SEE_LOCATION_SETTING_UPDATED" +---|"LFG_BOOT_PROPOSAL_UPDATE" +---|"LFG_COMPLETION_REWARD" +---|"LFG_COOLDOWNS_UPDATED" +---|"LFG_ENABLED_STATE_CHANGED" +---|"LFG_GROUP_DELISTED_LEADERSHIP_CHANGE" # `listingName, automaticDelistTimeRemaining` +---|"LFG_INVALID_ERROR_MESSAGE" # `reason, subReason1, subReason2` +---|"LFG_LIST_ACTIVE_ENTRY_UPDATE" # `created` +---|"LFG_LIST_APPLICANT_LIST_UPDATED" # `newPendingEntry, newPendingEntryWithData` +---|"LFG_LIST_APPLICANT_UPDATED" # `applicantID` +---|"LFG_LIST_APPLICATION_STATUS_UPDATED" # `searchResultID, newStatus, oldStatus, groupName` +---|"LFG_LIST_AVAILABILITY_UPDATE" +---|"LFG_LIST_ENTRY_CREATION_FAILED" +---|"LFG_LIST_ENTRY_EXPIRED_TIMEOUT" +---|"LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS" +---|"LFG_LIST_JOINED_GROUP" # `searchResultID, groupName` +---|"LFG_LIST_SEARCH_FAILED" # `reason` +---|"LFG_LIST_SEARCH_RESULTS_RECEIVED" +---|"LFG_LIST_SEARCH_RESULT_UPDATED" # `searchResultID` +---|"LFG_LIST_UPDATE_SEARCH_RESULTS" +---|"LFG_LOCK_INFO_RECEIVED" +---|"LFG_OFFER_CONTINUE" # `name, lfgDungeonsID, typeID` +---|"LFG_OPEN_FROM_GOSSIP" # `dungeonID` +---|"LFG_PROPOSAL_DONE" +---|"LFG_PROPOSAL_FAILED" +---|"LFG_PROPOSAL_SHOW" +---|"LFG_PROPOSAL_SUCCEEDED" +---|"LFG_PROPOSAL_UPDATE" +---|"LFG_QUEUE_STATUS_UPDATE" +---|"LFG_READY_CHECK_DECLINED" # `name` +---|"LFG_READY_CHECK_HIDE" +---|"LFG_READY_CHECK_PLAYER_IS_READY" # `name` +---|"LFG_READY_CHECK_SHOW" # `isRequeue` +---|"LFG_READY_CHECK_UPDATE" +---|"LFG_ROLE_CHECK_DECLINED" +---|"LFG_ROLE_CHECK_HIDE" +---|"LFG_ROLE_CHECK_ROLE_CHOSEN" # `name, isTank, isHealer, isDamage` +---|"LFG_ROLE_CHECK_SHOW" # `isRequeue` +---|"LFG_ROLE_CHECK_UPDATE" +---|"LFG_ROLE_UPDATE" +---|"LFG_UPDATE" +---|"LFG_UPDATE_RANDOM_INFO" +---|"LIFESTEAL_UPDATE" +---|"LOADING_SCREEN_DISABLED" +---|"LOADING_SCREEN_ENABLED" +---|"LOBBY_MATCHMAKER_QUEUE_ABANDONED" +---|"LOBBY_MATCHMAKER_QUEUE_ERROR" +---|"LOBBY_MATCHMAKER_QUEUE_EXPIRED" +---|"LOBBY_MATCHMAKER_QUEUE_POPPED" +---|"LOBBY_MATCHMAKER_QUEUE_STATUS_UPDATE" +---|"LOCALPLAYER_PET_RENAMED" +---|"LOC_RESULT" # `result` +---|"LOGOUT_CANCEL" +---|"LOOT_BIND_CONFIRM" # `lootSlot` +---|"LOOT_CLOSED" +---|"LOOT_HISTORY_CLEAR_HISTORY" +---|"LOOT_HISTORY_GO_TO_ENCOUNTER" # `encounterID` +---|"LOOT_HISTORY_ONE_HUNDRED_ROLL" # `encounterID, lootListID` +---|"LOOT_HISTORY_UPDATE_DROP" # `encounterID, lootListID` +---|"LOOT_HISTORY_UPDATE_ENCOUNTER" # `encounterID` +---|"LOOT_ITEM_AVAILABLE" # `itemTooltip, lootHandle` +---|"LOOT_ITEM_ROLL_WON" # `itemLink, rollQuantity, rollType, roll, upgraded` +---|"LOOT_JOURNAL_ITEM_UPDATE" +---|"LOOT_OPENED" # `autoLoot, isFromItem` +---|"LOOT_READY" # `autoloot` +---|"LOOT_ROLLS_COMPLETE" # `lootHandle` +---|"LOOT_SLOT_CHANGED" # `lootSlot` +---|"LOOT_SLOT_CLEARED" # `lootSlot` +---|"LORE_TEXT_UPDATED_CAMPAIGN" # `campaignID, textEntries` +---|"LOSS_OF_CONTROL_ADDED" # `unitTarget, effectIndex` +---|"LOSS_OF_CONTROL_COMMENTATOR_ADDED" # `victim, effectIndex` +---|"LOSS_OF_CONTROL_COMMENTATOR_UPDATE" # `victim` +---|"LOSS_OF_CONTROL_UPDATE" # `unitTarget` +---|"LUA_WARNING" # `warningText` +---|"MACRO_ACTION_BLOCKED" # `function` +---|"MACRO_ACTION_FORBIDDEN" # `function` +---|"MAIL_CLOSED" +---|"MAIL_FAILED" # `itemID` +---|"MAIL_INBOX_UPDATE" +---|"MAIL_LOCK_SEND_ITEMS" # `attachSlot, itemLink` +---|"MAIL_SEND_INFO_UPDATE" +---|"MAIL_SEND_SUCCESS" +---|"MAIL_SHOW" +---|"MAIL_SUCCESS" # `itemID` +---|"MAIL_UNLOCK_SEND_ITEMS" +---|"MAIN_SPEC_NEED_ROLL" # `rollID, roll, isWinning` +---|"MAJOR_FACTION_INTERACTION_ENDED" +---|"MAJOR_FACTION_INTERACTION_STARTED" +---|"MAJOR_FACTION_RENOWN_LEVEL_CHANGED" # `majorFactionID, newRenownLevel, oldRenownLevel` +---|"MAJOR_FACTION_UNLOCKED" # `majorFactionID` +---|"MAP_EXPLORATION_UPDATED" +---|"MASTERY_UPDATE" +---|"MAX_EXPANSION_LEVEL_UPDATED" +---|"MAX_SPELL_START_RECOVERY_OFFSET_CHANGED" # `clampedNewQueueWindowMs` +---|"MENTORSHIP_STATUS_CHANGED" +---|"MERCHANT_CLOSED" +---|"MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL" # `itemLink` +---|"MERCHANT_FILTER_ITEM_UPDATE" # `itemID` +---|"MERCHANT_SHOW" +---|"MERCHANT_UPDATE" +---|"MINIMAP_PING" # `unitTarget, y, x` +---|"MINIMAP_UPDATE_TRACKING" +---|"MINIMAP_UPDATE_ZOOM" +---|"MIN_EXPANSION_LEVEL_UPDATED" +---|"MIRROR_TIMER_PAUSE" # `timerName, paused` +---|"MIRROR_TIMER_START" # `timerName, value, maxValue, scale, paused, timerLabel` +---|"MIRROR_TIMER_STOP" # `timerName` +---|"MODIFIER_STATE_CHANGED" # `key, down` +---|"MOUNT_CURSOR_CLEAR" +---|"MOUNT_EQUIPMENT_APPLY_RESULT" # `success` +---|"MOUNT_JOURNAL_SEARCH_UPDATED" +---|"MOUNT_JOURNAL_USABILITY_CHANGED" +---|"MOVE_OUT_RESERVATION_UPDATED" +---|"MUTELIST_UPDATE" +---|"MYTHIC_PLUS_CURRENT_AFFIX_UPDATE" +---|"MYTHIC_PLUS_NEW_WEEKLY_RECORD" # `mapChallengeModeID, completionMilliseconds, level` +---|"NAME_PLATE_CREATED" # `namePlateFrame` +---|"NAME_PLATE_UNIT_ADDED" # `unitToken` +---|"NAME_PLATE_UNIT_BEHIND_CAMERA_CHANGED" # `unitTarget, isBehindCamera` +---|"NAME_PLATE_UNIT_REMOVED" # `unitToken` +---|"NAVIGATION_DESTINATION_REACHED" # `isWaypoint` +---|"NAVIGATION_FRAME_CREATED" # `region` +---|"NAVIGATION_FRAME_DESTROYED" +---|"NEIGHBORHOOD_GUILD_SIZE_VALIDATED" # `approved` +---|"NEIGHBORHOOD_INFO_UPDATED" # `neighborhoodInfo` +---|"NEIGHBORHOOD_INITIATIVE_UPDATED" +---|"NEIGHBORHOOD_INVITE_RESPONSE" # `result` +---|"NEIGHBORHOOD_LIST_UPDATED" # `result, neighborhoodInfos` +---|"NEIGHBORHOOD_MAP_DATA_UPDATED" +---|"NEIGHBORHOOD_NAME_UPDATED" # `neighborhoodGuid, neighborhoodName` +---|"NEIGHBORHOOD_NAME_VALIDATED" # `approved` +---|"NEUTRAL_FACTION_SELECT_RESULT" # `success` +---|"NEWCOMER_GRADUATION" +---|"NEW_HOUSING_ITEM_ACQUIRED" # `itemType, itemName, icon` +---|"NEW_MATCHMAKING_PARTY_INVITE" +---|"NEW_MOUNT_ADDED" # `mountID` +---|"NEW_PET_ADDED" # `battlePetGUID` +---|"NEW_RECIPE_LEARNED" # `recipeID, recipeLevel, baseRecipeID` +---|"NEW_RUNEFORGE_POWER_ADDED" # `powerID` +---|"NEW_TOY_ADDED" # `itemID` +---|"NEW_WARBAND_SCENE_ADDED" # `warbandScenID` +---|"NEW_WMO_CHUNK" +---|"NOTCHED_DISPLAY_MODE_CHANGED" +---|"NOTIFY_CHAT_SUPPRESSED" +---|"NOTIFY_PVP_AFK_RESULT" # `offender, numBlackMarksOnOffender, numPlayersIHaveReported` +---|"NOTIFY_TURN_STRAFE_CHANGE" +---|"NPE_TUTORIAL_UPDATE" +---|"OBJECT_ENTERED_AOI" # `guid` +---|"OBJECT_LEFT_AOI" # `guid` +---|"OBLITERUM_FORGE_PENDING_ITEM_CHANGED" +---|"OPEN_CHARTER_CONFIRMATION_UI" # `neighborhoodName, locationName` +---|"OPEN_CREATE_CHARTER_NEIGHBORHOOD_UI" # `locationName` +---|"OPEN_CREATE_GUILD_NEIGHBORHOOD_UI" # `locationName` +---|"OPEN_MASTER_LOOT_LIST" +---|"OPEN_NEIGHBORHOOD_CHARTER" # `neighborhoodInfo, signatures, requiredSignatures` +---|"OPEN_NEIGHBORHOOD_CHARTER_SIGNATURE_REQUEST" # `neighborhoodInfo` +---|"OPEN_PLOT_CORNERSTONE" +---|"OPEN_RECIPE_RESPONSE" # `recipeID, skillLineID, expansionSkillLineID` +---|"OPEN_SPLASH_SCREEN" # `info` +---|"OPEN_TABARD_FRAME" +---|"OWNED_AUCTIONS_UPDATED" +---|"OWNED_AUCTION_BIDDER_INFO_RECEIVED" # `auctionID, bidderName` +---|"PARTY_ELIGIBILITY_FOR_DELVE_TIERS_CHANGED" # `playerName, maxEligibleLevel` +---|"PARTY_INVITE_CANCEL" +---|"PARTY_INVITE_REQUEST" # `name, isTank, isHealer, isDamage, isNativeRealm, allowMultipleRoles, inviterGUID, questSessionActive` +---|"PARTY_KILL" # `attackerGUID, targetGUID` +---|"PARTY_LEADER_CHANGED" +---|"PARTY_LFG_RESTRICTED" +---|"PARTY_LOOT_METHOD_CHANGED" +---|"PARTY_MEMBER_DISABLE" # `unitTarget` +---|"PARTY_MEMBER_ENABLE" # `unitTarget` +---|"PENDING_AZERITE_ESSENCE_CHANGED" # `essenceID` +---|"PENDING_NEIGHBORHOOD_INVITES_RECIEVED" # `result, pendingInviteList` +---|"PERKS_ACTIVITIES_TRACKED_LIST_CHANGED" # `perksActivityID, added` +---|"PERKS_ACTIVITIES_TRACKED_UPDATED" +---|"PERKS_ACTIVITIES_UPDATED" +---|"PERKS_ACTIVITY_COMPLETED" # `perksActivityID` +---|"PERKS_PROGRAM_ADD_PENDING_SHOP_ITEM" # `vendorItemID` +---|"PERKS_PROGRAM_CLOSE" +---|"PERKS_PROGRAM_CURRENCY_AWARDED" # `value` +---|"PERKS_PROGRAM_CURRENCY_REFRESH" # `oldValue, newValue` +---|"PERKS_PROGRAM_DATA_REFRESH" +---|"PERKS_PROGRAM_DATA_SPECIFIC_ITEM_REFRESH" # `vendorItemID` +---|"PERKS_PROGRAM_DISABLED" +---|"PERKS_PROGRAM_OPEN" +---|"PERKS_PROGRAM_PURCHASE_CART_SUCCESS" # `vendorItemIDs` +---|"PERKS_PROGRAM_PURCHASE_SUCCESS" # `vendorItemID` +---|"PERKS_PROGRAM_REFUND_SUCCESS" # `vendorItemID` +---|"PERKS_PROGRAM_REMOVE_PENDING_SHOP_ITEM" # `vendorItemID` +---|"PERKS_PROGRAM_RESULT_ERROR" +---|"PERKS_PROGRAM_SET_FROZEN_ITEM" # `vendorItemID` +---|"PETITION_CLOSED" +---|"PETITION_SHOW" +---|"PET_ATTACK_START" +---|"PET_ATTACK_STOP" +---|"PET_BAR_HIDEGRID" +---|"PET_BAR_SHOWGRID" +---|"PET_BAR_UPDATE" +---|"PET_BAR_UPDATE_COOLDOWN" +---|"PET_BAR_UPDATE_USABLE" +---|"PET_BATTLE_ABILITY_CHANGED" # `owner, petIndex, abilityID` +---|"PET_BATTLE_ACTION_SELECTED" +---|"PET_BATTLE_AURA_APPLIED" # `owner, petIndex, auraInstanceID` +---|"PET_BATTLE_AURA_CANCELED" # `owner, petIndex, auraInstanceID` +---|"PET_BATTLE_AURA_CHANGED" # `owner, petIndex, auraInstanceID` +---|"PET_BATTLE_CAPTURED" # `owner, petIndex` +---|"PET_BATTLE_CLOSE" +---|"PET_BATTLE_FINAL_ROUND" # `owner` +---|"PET_BATTLE_HEALTH_CHANGED" # `owner, petIndex, healthChange` +---|"PET_BATTLE_LEVEL_CHANGED" # `owner, petIndex, newLevel` +---|"PET_BATTLE_LOOT_RECEIVED" # `typeIdentifier, itemLink, quantity` +---|"PET_BATTLE_MAX_HEALTH_CHANGED" # `owner, petIndex, healthChange` +---|"PET_BATTLE_OPENING_DONE" +---|"PET_BATTLE_OPENING_START" +---|"PET_BATTLE_OVER" +---|"PET_BATTLE_OVERRIDE_ABILITY" # `abilityIndex` +---|"PET_BATTLE_PET_CHANGED" # `owner` +---|"PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE" # `roundNumber` +---|"PET_BATTLE_PET_ROUND_RESULTS" # `roundNumber` +---|"PET_BATTLE_PET_TYPE_CHANGED" # `owner, petIndex, stateValue` +---|"PET_BATTLE_PVP_DUEL_REQUESTED" # `fullName` +---|"PET_BATTLE_PVP_DUEL_REQUEST_CANCEL" +---|"PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED" +---|"PET_BATTLE_QUEUE_PROPOSAL_DECLINED" +---|"PET_BATTLE_QUEUE_PROPOSE_MATCH" +---|"PET_BATTLE_QUEUE_STATUS" +---|"PET_BATTLE_XP_CHANGED" # `owner, petIndex, xpChange` +---|"PET_DISMISS_START" # `delay` +---|"PET_FORCE_NAME_DECLENSION" # `name, petNumber, declinedName1, declinedName2, declinedName3, declinedName4, declinedName5` +---|"PET_INFO_UPDATE" +---|"PET_JOURNAL_AUTO_SLOTTED_PET" # `slotIndex, battlePetGUID` +---|"PET_JOURNAL_CAGE_FAILED" +---|"PET_JOURNAL_LIST_UPDATE" +---|"PET_JOURNAL_NEW_BATTLE_SLOT" +---|"PET_JOURNAL_PETS_HEALED" +---|"PET_JOURNAL_PET_DELETED" # `battlePetGUID` +---|"PET_JOURNAL_PET_RESTORED" # `battlePetGUID` +---|"PET_JOURNAL_PET_REVOKED" # `battlePetGUID` +---|"PET_JOURNAL_TRAP_LEVEL_SET" # `trapLevel` +---|"PET_SPECIALIZATION_CHANGED" +---|"PET_SPELL_POWER_UPDATE" +---|"PET_STABLE_CLOSED" +---|"PET_STABLE_FAVORITES_UPDATED" +---|"PET_STABLE_SHOW" +---|"PET_STABLE_UPDATE" +---|"PET_UI_CLOSE" +---|"PET_UI_UPDATE" +---|"PHOTO_SHARING_AUTHORIZATION_NEEDED" +---|"PHOTO_SHARING_AUTHORIZATION_UPDATED" # `showNotification` +---|"PHOTO_SHARING_PHOTO_UPLOAD_STATUS" # `uploadStatus` +---|"PHOTO_SHARING_SCREENSHOT_READY" +---|"PHOTO_SHARING_THIRD_PARTY_AUTHORIZATION_NEEDED" # `authUrl` +---|"PING_SYSTEM_ERROR" # `error` +---|"PLAYERBANKSLOTS_CHANGED" # `slot` +---|"PLAYER_ACCOUNT_BANK_TAB_SLOTS_CHANGED" # `slot` +---|"PLAYER_ALIVE" +---|"PLAYER_AVG_ITEM_LEVEL_UPDATE" +---|"PLAYER_CAMPING" +---|"PLAYER_CAN_GLIDE_CHANGED" # `canGlide` +---|"PLAYER_CHARACTER_LIST_UPDATED" # `characterInfos, ownerListIndex` +---|"PLAYER_CHOICE_CLOSE" +---|"PLAYER_CHOICE_UPDATE" +---|"PLAYER_CONTROL_GAINED" +---|"PLAYER_CONTROL_LOST" +---|"PLAYER_DAMAGE_DONE_MODS" # `unitTarget` +---|"PLAYER_DEAD" +---|"PLAYER_DIFFICULTY_CHANGED" +---|"PLAYER_ENTERING_BATTLEGROUND" +---|"PLAYER_ENTERING_WORLD" # `isInitialLogin, isReloadingUi` +---|"PLAYER_ENTER_COMBAT" +---|"PLAYER_EQUIPMENT_CHANGED" # `equipmentSlot, hasCurrent` +---|"PLAYER_FARSIGHT_FOCUS_CHANGED" +---|"PLAYER_FLAGS_CHANGED" # `unitTarget` +---|"PLAYER_FOCUS_CHANGED" +---|"PLAYER_GAINS_VEHICLE_DATA" # `unitTarget, vehicleUIIndicatorID` +---|"PLAYER_GUILD_UPDATE" # `unitTarget` +---|"PLAYER_HOUSE_LIST_UPDATED" # `houseInfos` +---|"PLAYER_IMPULSE_APPLIED" +---|"PLAYER_INSIDE_QUEST_BLOB_STATE_CHANGED" # `questID, isInside` +---|"PLAYER_INTERACTION_MANAGER_FRAME_HIDE" # `type` +---|"PLAYER_INTERACTION_MANAGER_FRAME_SHOW" # `type` +---|"PLAYER_IN_COMBAT_CHANGED" # `inCombat` +---|"PLAYER_IS_GLIDING_CHANGED" # `isGliding` +---|"PLAYER_JOINED_PVP_MATCH" +---|"PLAYER_LEARN_PVP_TALENT_FAILED" +---|"PLAYER_LEARN_TALENT_FAILED" +---|"PLAYER_LEAVE_COMBAT" +---|"PLAYER_LEAVING_WORLD" +---|"PLAYER_LEVEL_CHANGED" # `oldLevel, newLevel, real` +---|"PLAYER_LEVEL_UP" # `level, healthDelta, powerDelta, numNewTalents, numNewPvpTalentSlots, strengthDelta, agilityDelta, staminaDelta, intellectDelta` +---|"PLAYER_LOGIN" +---|"PLAYER_LOGOUT" +---|"PLAYER_LOOT_SPEC_UPDATED" +---|"PLAYER_LOSES_VEHICLE_DATA" # `unitTarget` +---|"PLAYER_MAP_CHANGED" # `oldMapID, newMapID` +---|"PLAYER_MAX_LEVEL_UPDATE" # `unitTarget` +---|"PLAYER_MONEY" +---|"PLAYER_MOUNT_DISPLAY_CHANGED" +---|"PLAYER_PVP_KILLS_CHANGED" # `unitTarget` +---|"PLAYER_PVP_RANK_CHANGED" # `unitTarget` +---|"PLAYER_PVP_TALENT_UPDATE" +---|"PLAYER_QUITING" +---|"PLAYER_REGEN_DISABLED" +---|"PLAYER_REGEN_ENABLED" +---|"PLAYER_REPORT_SUBMITTED" # `invitedByGUID` +---|"PLAYER_ROLES_ASSIGNED" +---|"PLAYER_SKINNED" # `hasFreeRepop` +---|"PLAYER_SOFT_ENEMY_CHANGED" +---|"PLAYER_SOFT_FRIEND_CHANGED" +---|"PLAYER_SOFT_INTERACT_CHANGED" # `oldTarget, newTarget` +---|"PLAYER_SOFT_TARGET_INTERACTION" +---|"PLAYER_SPECIALIZATION_CHANGED" # `unitTarget` +---|"PLAYER_STARTED_LOOKING" +---|"PLAYER_STARTED_MOVING" +---|"PLAYER_STARTED_TURNING" +---|"PLAYER_STOPPED_LOOKING" +---|"PLAYER_STOPPED_MOVING" +---|"PLAYER_STOPPED_TURNING" +---|"PLAYER_TALENT_UPDATE" +---|"PLAYER_TARGET_CHANGED" +---|"PLAYER_TARGET_DIED" +---|"PLAYER_TOTEM_UPDATE" # `totemSlot` +---|"PLAYER_TRADE_CURRENCY" +---|"PLAYER_TRADE_MONEY" +---|"PLAYER_TRIAL_XP_UPDATE" # `unitTarget` +---|"PLAYER_UNGHOST" +---|"PLAYER_UPDATE_RESTING" +---|"PLAYER_XP_UPDATE" # `unitTarget` +---|"PLAY_MOVIE" # `movieID` +---|"PORTRAITS_UPDATED" +---|"POST_MATCH_CURRENCY_REWARD_UPDATE" # `reward` +---|"POST_MATCH_ITEM_REWARD_UPDATE" +---|"PROFESSION_EQUIPMENT_CHANGED" # `skillLineID, isTool` +---|"PROFESSION_RESPEC_CONFIRMATION" # `skillName` +---|"PROVING_GROUNDS_SCORE_UPDATE" # `points` +---|"PURCHASE_PLOT_RESULT" # `result` +---|"PVPQUEUE_ANYWHERE_SHOW" +---|"PVPQUEUE_ANYWHERE_UPDATE_AVAILABLE" +---|"PVP_BRAWL_INFO_UPDATED" +---|"PVP_MATCH_ACTIVE" +---|"PVP_MATCH_COMPLETE" # `winner, duration` +---|"PVP_MATCH_INACTIVE" +---|"PVP_MATCH_STATE_CHANGED" +---|"PVP_POWER_UPDATE" +---|"PVP_RATED_STATS_UPDATE" +---|"PVP_REWARDS_UPDATE" +---|"PVP_ROLE_POPUP_HIDE" # `readyCheckInfo` +---|"PVP_ROLE_POPUP_SHOW" # `readyCheckInfo` +---|"PVP_ROLE_UPDATE" +---|"PVP_SPECIAL_EVENT_INFO_UPDATED" +---|"PVP_TIMER_UPDATE" # `unitTarget` +---|"PVP_TYPES_ENABLED" # `wargameBattlegrounds, ratedBattlegrounds, ratedArenas, ratedSoloShuffle, ratedBGBlitz` +---|"PVP_VEHICLE_INFO_UPDATED" +---|"PVP_WORLDSTATE_UPDATE" +---|"QUESTLINE_UPDATE" # `requestRequired` +---|"QUEST_ACCEPTED" # `questId` +---|"QUEST_ACCEPT_CONFIRM" # `name, questTitle, questID` +---|"QUEST_AUTOCOMPLETE" # `questId` +---|"QUEST_BOSS_EMOTE" # `text, playerName, displayTime, enableBossEmoteWarningSound` +---|"QUEST_COMPLETE" +---|"QUEST_CURRENCY_LOOT_RECEIVED" # `questID, currencyId, quantity` +---|"QUEST_DATA_LOAD_RESULT" # `questID, success` +---|"QUEST_DETAIL" # `questStartItemID` +---|"QUEST_FINISHED" +---|"QUEST_GREETING" +---|"QUEST_ITEM_UPDATE" +---|"QUEST_LOG_CRITERIA_UPDATE" # `questID, specificTreeID, description, numFulfilled, numRequired` +---|"QUEST_LOG_UPDATE" +---|"QUEST_LOOT_RECEIVED" # `questID, itemLink, quantity` +---|"QUEST_POI_UPDATE" +---|"QUEST_PROGRESS" +---|"QUEST_REMOVED" # `questID, wasReplayQuest` +---|"QUEST_SESSION_CREATED" +---|"QUEST_SESSION_DESTROYED" +---|"QUEST_SESSION_ENABLED_STATE_CHANGED" # `enabled` +---|"QUEST_SESSION_JOINED" +---|"QUEST_SESSION_LEFT" +---|"QUEST_SESSION_MEMBER_CONFIRM" +---|"QUEST_SESSION_MEMBER_START_RESPONSE" # `guid, response` +---|"QUEST_SESSION_NOTIFICATION" # `result, guid` +---|"QUEST_TURNED_IN" # `questID, xpReward, moneyReward` +---|"QUEST_WATCH_LIST_CHANGED" # `questID, added` +---|"QUEST_WATCH_UPDATE" # `questID` +---|"QUICK_TICKET_SYSTEM_STATUS" +---|"QUICK_TICKET_THROTTLE_CHANGED" +---|"RAF_ENTITLEMENT_DELIVERED" # `entitlementType, textureID, name, payloadID, showFancyToast, rafVersion` +---|"RAF_INFO_UPDATED" # `info` +---|"RAF_RECRUITING_ENABLED_STATUS" # `enabled` +---|"RAF_REWARD_CLAIM_FAILED" +---|"RAF_SYSTEM_ENABLED_STATUS" # `enabled` +---|"RAF_SYSTEM_INFO_UPDATED" # `systemInfo` +---|"RAID_BOSS_EMOTE" # `text, playerName, displayTime, enableBossEmoteWarningSound` +---|"RAID_BOSS_WHISPER" # `text, playerName, displayTime, enableBossEmoteWarningSound` +---|"RAID_INSTANCE_WELCOME" # `mapname, timeLeft, locked, extended` +---|"RAID_ROSTER_UPDATE" +---|"RAID_TARGET_UPDATE" +---|"RAISED_AS_GHOUL" +---|"READY_CHECK" # `initiatorName, readyCheckTimeLeft` +---|"READY_CHECK_CONFIRM" # `unitTarget, isReady` +---|"READY_CHECK_FINISHED" # `preempted` +---|"RECEIVED_ACHIEVEMENT_LIST" +---|"RECEIVED_ACHIEVEMENT_MEMBER_LIST" # `achievementID` +---|"RECEIVED_HOUSE_LEVEL_REWARDS" # `level, rewards` +---|"RECENT_ALLIES_CACHE_UPDATE" +---|"RECENT_ALLIES_DATA_READY" +---|"RECENT_ALLIES_SYSTEM_STATUS_UPDATED" +---|"RECENT_ALLY_DATA_UPDATED" # `characterGUID` +---|"REJECTED_MATCHMAKING_PARTY_INVITE" # `name` +---|"REMIX_ARTIFACT_ITEM_SPECS_LOADED" # `success` +---|"REMIX_ARTIFACT_UPDATE" +---|"REMIX_END_OF_EVENT" +---|"REMOVE_NEIGHBORHOOD_CHARTER_SIGNATURE" # `signature` +---|"REPLACE_ENCHANT" # `existingStr, replacementStr` +---|"REPLACE_TRADESKILL_ENCHANT" # `existing, replacement` +---|"REPLICATE_ITEM_LIST_UPDATE" +---|"REPORT_PLAYER_RESULT" # `result, reportType` +---|"REPORT_SCREENSHOT_READY" +---|"REQUESTED_GUILD_RENAME_RESULT" # `newName, status` +---|"REQUEST_CEMETERY_LIST_RESPONSE" # `isGossipTriggered` +---|"REQUEST_INVITE_CONFIRMATION" # `targetName, partyLevelLink, questSessionActive, tank, healer, dps` +---|"REQUIRED_GUILD_RENAME_RESULT" # `success` +---|"RESEARCH_ARTIFACT_COMPLETE" # `name` +---|"RESEARCH_ARTIFACT_DIG_SITE_UPDATED" +---|"RESEARCH_ARTIFACT_UPDATE" +---|"RESURRECT_REQUEST" # `inviter` +---|"ROLE_CHANGED_INFORM" # `changedName, fromName, oldRole, newRole` +---|"ROLE_POLL_BEGIN" # `fromName` +---|"RUNEFORGE_LEGENDARY_CRAFTING_CLOSED" +---|"RUNEFORGE_LEGENDARY_CRAFTING_OPENED" # `isUpgrade` +---|"RUNEFORGE_POWER_INFO_UPDATED" # `powerID` +---|"RUNE_POWER_UPDATE" # `runeIndex, added` +---|"RUNE_TYPE_UPDATE" # `runeIndex` +---|"SAVED_VARIABLES_TOO_LARGE" # `addOnName` +---|"SCENARIO_BONUS_OBJECTIVE_COMPLETE" # `bonusObjectiveID` +---|"SCENARIO_BONUS_VISIBILITY_UPDATE" +---|"SCENARIO_COMPLETED" # `questID, xp, money` +---|"SCENARIO_CRITERIA_SHOW_STATE_UPDATE" # `show` +---|"SCENARIO_CRITERIA_UPDATE" # `criteriaID` +---|"SCENARIO_POI_UPDATE" +---|"SCENARIO_SPELL_UPDATE" +---|"SCENARIO_UPDATE" # `newStep` +---|"SCRAPPING_MACHINE_ITEM_ADDED" # `index` +---|"SCRAPPING_MACHINE_ITEM_REMOVED" # `index` +---|"SCRAPPING_MACHINE_PENDING_ITEM_CHANGED" +---|"SCRAPPING_MACHINE_SCRAPPING_FINISHED" +---|"SCREENSHOT_FAILED" +---|"SCREENSHOT_STARTED" +---|"SCREENSHOT_SUCCEEDED" +---|"SCRIPTED_ANIMATIONS_UPDATE" +---|"SEARCH_DB_LOADED" +---|"SECURE_TRANSFER_CANCEL" +---|"SECURE_TRANSFER_CONFIRM_HOUSING_PURCHASE" +---|"SECURE_TRANSFER_CONFIRM_SEND_MAIL" +---|"SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT" +---|"SECURE_TRANSFER_HOUSING_CURRENCY_PURCHASE_CONFIRMATION" +---|"SELECTED_LOADOUT_CHANGED" +---|"SELF_RES_SPELL_CHANGED" +---|"SEND_MAIL_COD_CHANGED" +---|"SEND_MAIL_MONEY_CHANGED" +---|"SETTINGS_LOADED" +---|"SETTINGS_PANEL_OPEN" # `openToCategoryID, scrollToElementName` +---|"SET_SEEN_PRODUCTS" # `productIds` +---|"SHIPMENT_CRAFTER_CLOSED" +---|"SHIPMENT_CRAFTER_INFO" # `success, shipmentCount, maxShipments, ownedShipments, plotInstanceID` +---|"SHIPMENT_CRAFTER_OPENED" # `charShipmentContainerID` +---|"SHIPMENT_CRAFTER_REAGENT_UPDATE" +---|"SHIPMENT_UPDATE" # `shipmentStarted, hasAttachedFollower` +---|"SHOW_DELVES_COMPANION_CONFIGURATION_UI" +---|"SHOW_END_OF_MATCH_UI" +---|"SHOW_FACTION_SELECT_UI" +---|"SHOW_HYPERLINK_TOOLTIP" # `hyperlink` +---|"SHOW_JOURNEYS_UI" # `factionID` +---|"SHOW_LFG_EXPAND_SEARCH_PROMPT" +---|"SHOW_LOOT_TOAST" # `typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, toastMethod, lessAwesome, upgraded, corrupted` +---|"SHOW_LOOT_TOAST_LEGENDARY_LOOTED" # `itemLink` +---|"SHOW_LOOT_TOAST_UPGRADE" # `itemLink, quantity, specID, sex, baseQuality, personalLootToast, lessAwesome` +---|"SHOW_NEIGHBORHOOD_OWNERSHIP_TRANSFER_DIALOG" # `neighborhoodName, cosmeticOwnerName` +---|"SHOW_NEW_PRODUCT_NOTIFICATION" +---|"SHOW_PARTY_POSE_UI" # `mapID, won` +---|"SHOW_PLAYER_EVICTED_DIALOG" +---|"SHOW_PVP_FACTION_LOOT_TOAST" # `typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, lessAwesome` +---|"SHOW_RATED_PVP_REWARD_TOAST" # `typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, lessAwesome` +---|"SHOW_STAIR_DIRECTION_CONFIRMATION" +---|"SHOW_SUBSCRIPTION_INTERSTITIAL" # `type` +---|"SHOW_SUBTITLE" # `subtitle, sender` +---|"SIMPLE_BROWSER_POPUP" # `url` +---|"SIMPLE_BROWSER_SOCIAL_CALLBACK_INVOKED" # `url` +---|"SIMPLE_BROWSER_WEB_ERROR" # `errorCode` +---|"SIMPLE_BROWSER_WEB_PROXY_FAILED" +---|"SIMPLE_CHECKOUT_CLOSED" +---|"SKILL_LINES_CHANGED" +---|"SKILL_LINE_SPECS_RANKS_CHANGED" +---|"SKILL_LINE_SPECS_UNLOCKED" # `skillLineID, tradeSkillID` +---|"SOCIAL_QUEUE_CONFIG_UPDATED" +---|"SOCIAL_QUEUE_UPDATE" # `groupGUID, numAddedItems` +---|"SOCKET_INFO_ACCEPT" +---|"SOCKET_INFO_BIND_CONFIRM" +---|"SOCKET_INFO_CLOSE" +---|"SOCKET_INFO_FAILURE" +---|"SOCKET_INFO_REFUNDABLE_CONFIRM" +---|"SOCKET_INFO_SUCCESS" +---|"SOCKET_INFO_UI_EVENT_REGISTRATION_UPDATE" # `uiType` +---|"SOCKET_INFO_UPDATE" +---|"SOULBIND_ACTIVATED" # `soulbindID` +---|"SOULBIND_CONDUIT_COLLECTION_CLEARED" +---|"SOULBIND_CONDUIT_COLLECTION_REMOVED" # `conduitID` +---|"SOULBIND_CONDUIT_COLLECTION_UPDATED" # `collectionData` +---|"SOULBIND_CONDUIT_INSTALLED" # `nodeID, data` +---|"SOULBIND_CONDUIT_UNINSTALLED" # `nodeID, data` +---|"SOULBIND_FORGE_INTERACTION_ENDED" +---|"SOULBIND_FORGE_INTERACTION_STARTED" +---|"SOULBIND_NODE_LEARNED" # `nodeID` +---|"SOULBIND_NODE_UNLEARNED" # `nodeID` +---|"SOULBIND_NODE_UPDATED" # `nodeID` +---|"SOULBIND_PATH_CHANGED" +---|"SOULBIND_PENDING_CONDUIT_CHANGED" # `nodeID, conduitID` +---|"SOUNDKIT_FINISHED" # `soundHandle` +---|"SOUND_DEVICE_UPDATE" +---|"SPECIALIZATION_CHANGE_CAST_FAILED" +---|"SPEC_INVOLUNTARILY_CHANGED" # `isPet` +---|"SPEED_UPDATE" +---|"SPELLS_CHANGED" +---|"SPELL_ACTIVATION_OVERLAY_GLOW_HIDE" # `spellID` +---|"SPELL_ACTIVATION_OVERLAY_GLOW_SHOW" # `spellID` +---|"SPELL_ACTIVATION_OVERLAY_HIDE" # `spellID` +---|"SPELL_ACTIVATION_OVERLAY_SHOW" # `spellID, overlayFileDataID, locationType, scale, r, g, b` +---|"SPELL_CONFIRMATION_PROMPT" # `spellID, effectValue, message, duration, currencyTypesID, currencyCost, currentDifficulty, displayItemID, itemContext, treasureContextLevel` +---|"SPELL_CONFIRMATION_TIMEOUT" # `spellID, effectValue` +---|"SPELL_DATA_LOAD_RESULT" # `spellID, success` +---|"SPELL_FLYOUT_UPDATE" # `flyoutID, spellID, isLearned` +---|"SPELL_POWER_CHANGED" +---|"SPELL_PUSHED_TO_ACTIONBAR" # `spellID, slot, page` +---|"SPELL_PUSHED_TO_FLYOUT_ON_ACTIONBAR" # `spellID, flyoutSlot, flyoutPage` +---|"SPELL_RANGE_CHECK_UPDATE" # `spellIdentifier, isInRange, checksRange` +---|"SPELL_TEXT_UPDATE" # `spellID` +---|"SPELL_UPDATE_CHARGES" +---|"SPELL_UPDATE_COOLDOWN" # `spellID, baseSpellID, category, startRecoveryCategory` +---|"SPELL_UPDATE_ICON" # `spellID` +---|"SPELL_UPDATE_USABLE" +---|"SPELL_UPDATE_USES" # `spellID, baseSpellID` +---|"STARTER_BUILD_ACTIVATION_FAILED" +---|"START_AUTOREPEAT_SPELL" +---|"START_LOOT_ROLL" # `rollID, rollTime, lootHandle` +---|"START_PLAYER_COUNTDOWN" # `initiatedBy, timeRemaining, totalTime, informChat, initiatedByName` +---|"START_TIMER" # `timerType, timeRemaining, totalTime` +---|"STOP_AUTOREPEAT_SPELL" +---|"STOP_MOVIE" +---|"STOP_TIMER_OF_TYPE" # `timerType` +---|"STORE_FRONT_STATE_UPDATED" # `storeFrontID` +---|"STREAMING_ICON" # `streamingStatus` +---|"STREAM_VIEW_MARKER_UPDATED" # `clubId, streamId, lastReadTime` +---|"STURDINESS_UPDATE" +---|"SUPER_TRACKING_CHANGED" +---|"SUPER_TRACKING_PATH_UPDATED" +---|"SURVEY_DELIVERED" +---|"SYSMSG" # `string, r, g, b` +---|"SYSTEM_VISIBILITY_CHANGED" +---|"TABARD_CANSAVE_CHANGED" +---|"TABARD_SAVE_PENDING" +---|"TALENTS_INVOLUNTARILY_RESET" # `isPetTalents` +---|"TALKINGHEAD_CLOSE" +---|"TALKINGHEAD_REQUESTED" +---|"TASK_PROGRESS_UPDATE" +---|"TAXIMAP_CLOSED" +---|"TAXIMAP_OPENED" # `system` +---|"TAXI_NODE_STATUS_CHANGED" +---|"TIME_PLAYED_MSG" # `totalTimePlayed, timePlayedThisLevel` +---|"TOGGLE_CONSOLE" # `showConsole` +---|"TOKEN_AUCTION_SOLD" +---|"TOKEN_BUY_CONFIRM_REQUIRED" +---|"TOKEN_BUY_RESULT" # `result` +---|"TOKEN_CAN_VETERAN_BUY_UPDATE" # `result` +---|"TOKEN_DISTRIBUTIONS_UPDATED" # `result` +---|"TOKEN_MARKET_PRICE_UPDATED" # `result` +---|"TOKEN_REDEEM_BALANCE_UPDATED" +---|"TOKEN_REDEEM_CONFIRM_REQUIRED" # `choiceType` +---|"TOKEN_REDEEM_FRAME_SHOW" +---|"TOKEN_REDEEM_GAME_TIME_UPDATED" +---|"TOKEN_REDEEM_RESULT" # `result, choiceType` +---|"TOKEN_SELL_CONFIRMED" +---|"TOKEN_SELL_CONFIRM_REQUIRED" +---|"TOKEN_SELL_RESULT" # `result` +---|"TOKEN_STATUS_CHANGED" +---|"TOOLTIP_DATA_UPDATE" # `dataInstanceID` +---|"TOOLTIP_SHOW_ITEM_COMPARISON" # `comparisonItem, tooltip, anchorFrame` +---|"TOYS_UPDATED" # `itemID, isNew, hasFanfare` +---|"TRACKABLE_INFO_UPDATE" # `type, id` +---|"TRACKED_ACHIEVEMENT_LIST_CHANGED" # `achievementID, added` +---|"TRACKED_ACHIEVEMENT_UPDATE" # `achievementID, criteriaID, elapsed, duration` +---|"TRACKED_HOUSE_CHANGED" # `trackedHouse` +---|"TRACKED_RECIPE_UPDATE" # `recipeID, tracked` +---|"TRACKING_TARGET_INFO_UPDATE" # `targetType, targetID` +---|"TRADE_ACCEPT_UPDATE" # `playerAccepted, targetAccepted` +---|"TRADE_CLOSED" +---|"TRADE_CURRENCY_CHANGED" +---|"TRADE_MONEY_CHANGED" +---|"TRADE_PLAYER_ITEM_CHANGED" # `tradeSlotIndex` +---|"TRADE_POTENTIAL_BIND_ENCHANT" # `canBecomeBoundForTrade` +---|"TRADE_POTENTIAL_REMOVE_TRANSMOG" # `itemLink, tradeSlotIndex` +---|"TRADE_REPLACE_ENCHANT" # `existing, replacement` +---|"TRADE_REQUEST" # `name` +---|"TRADE_REQUEST_CANCEL" +---|"TRADE_SHOW" +---|"TRADE_SKILL_CLOSE" +---|"TRADE_SKILL_CRAFTING_REAGENT_BONUS_TEXT_UPDATED" # `itemID` +---|"TRADE_SKILL_CRAFT_BEGIN" # `recipeSpellID` +---|"TRADE_SKILL_CURRENCY_REWARD_RESULT" # `data` +---|"TRADE_SKILL_DATA_SOURCE_CHANGED" +---|"TRADE_SKILL_DATA_SOURCE_CHANGING" +---|"TRADE_SKILL_DETAILS_UPDATE" +---|"TRADE_SKILL_FAVORITES_CHANGED" # `isFavorite, recipeSpellID` +---|"TRADE_SKILL_ITEM_CRAFTED_RESULT" # `data` +---|"TRADE_SKILL_ITEM_UPDATE" # `itemGUID` +---|"TRADE_SKILL_LIST_UPDATE" +---|"TRADE_SKILL_NAME_UPDATE" +---|"TRADE_SKILL_SHOW" +---|"TRADE_TARGET_ITEM_CHANGED" # `tradeSlotIndex` +---|"TRADE_UPDATE" +---|"TRADE_UPDATE_WARNINGS" +---|"TRAINER_CLOSED" +---|"TRAINER_DESCRIPTION_UPDATE" +---|"TRAINER_SERVICE_INFO_NAME_UPDATE" +---|"TRAINER_SHOW" +---|"TRAINER_UPDATE" +---|"TRAINING_GROUNDS_ENABLED_STATUS_UPDATED" +---|"TRAIT_COND_INFO_CHANGED" # `condID` +---|"TRAIT_CONFIG_CREATED" # `configInfo` +---|"TRAIT_CONFIG_DELETED" # `configID` +---|"TRAIT_CONFIG_LIST_UPDATED" +---|"TRAIT_CONFIG_UPDATED" # `configID` +---|"TRAIT_NODE_CHANGED" # `nodeID` +---|"TRAIT_NODE_CHANGED_PARTIAL" # `ID, info` +---|"TRAIT_NODE_ENTRY_UPDATED" # `nodeEntryID` +---|"TRAIT_SUB_TREE_CHANGED" # `subTreeID` +---|"TRAIT_SYSTEM_INTERACTION_STARTED" # `treeID` +---|"TRAIT_SYSTEM_NPC_CLOSED" +---|"TRAIT_TREE_CHANGED" # `treeID` +---|"TRAIT_TREE_CURRENCY_INFO_UPDATED" # `treeID` +---|"TRANSMOGRIFY_CLOSE" +---|"TRANSMOGRIFY_ITEM_UPDATE" +---|"TRANSMOGRIFY_OPEN" +---|"TRANSMOGRIFY_SUCCESS" # `transmogLocation` +---|"TRANSMOGRIFY_UPDATE" # `transmogLocation, action` +---|"TRANSMOG_COLLECTION_CAMERA_UPDATE" +---|"TRANSMOG_COLLECTION_ITEM_FAVORITE_UPDATE" # `itemAppearanceID, isFavorite` +---|"TRANSMOG_COLLECTION_ITEM_UPDATE" +---|"TRANSMOG_COLLECTION_SOURCE_ADDED" # `itemModifiedAppearanceID` +---|"TRANSMOG_COLLECTION_SOURCE_REMOVED" # `itemModifiedAppearanceID` +---|"TRANSMOG_COLLECTION_UPDATED" # `collectionIndex, modID, itemAppearanceID, reason` +---|"TRANSMOG_COSMETIC_COLLECTION_SOURCE_ADDED" # `itemModifiedAppearanceID` +---|"TRANSMOG_CUSTOM_SETS_CHANGED" +---|"TRANSMOG_DISPLAYED_OUTFIT_CHANGED" +---|"TRANSMOG_OUTFITS_CHANGED" # `newOutfitID` +---|"TRANSMOG_SEARCH_UPDATED" # `searchType, collectionType` +---|"TRANSMOG_SETS_UPDATE_FAVORITE" +---|"TRANSMOG_SOURCE_COLLECTABILITY_UPDATE" # `itemModifiedAppearanceID, collectable` +---|"TREASURE_PICKER_CACHE_FLUSH" +---|"TRIAL_CAP_REACHED_MONEY" +---|"TRY_PURCHASE_TO_NODE_PARTIAL_SUCCESS" # `nodeFinishedOn` +---|"TUTORIAL_COMBAT_EVENT" +---|"TUTORIAL_HIGHLIGHT_SPELL" # `spellID, tutorialGlobalStringTag` +---|"TUTORIAL_TRIGGER" # `tutorialIndex, forceShow` +---|"TUTORIAL_UNHIGHLIGHT_SPELL" +---|"UI_ERROR_MESSAGE" # `errorType, message` +---|"UI_ERROR_POPUP" # `errorType, message` +---|"UI_INFO_MESSAGE" # `errorType, message` +---|"UI_MODEL_SCENE_INFO_UPDATED" +---|"UI_SCALE_CHANGED" +---|"UNIT_ABSORB_AMOUNT_CHANGED" # `unitTarget` +---|"UNIT_AREA_CHANGED" # `unitTarget` +---|"UNIT_ARENA_COOLDOWNS_UPDATE" # `unitTarget` +---|"UNIT_ATTACK" # `unitTarget` +---|"UNIT_ATTACK_POWER" # `unitTarget` +---|"UNIT_ATTACK_SPEED" # `unitTarget` +---|"UNIT_AURA" # `unitTarget, updateInfo` +---|"UNIT_AURA_BLOCKED" # `unitTarget, auraInstanceID` +---|"UNIT_AURA_BLOCK_LIST_CLEARED" # `unitTarget` +---|"UNIT_CHEAT_TOGGLE_EVENT" +---|"UNIT_CLASSIFICATION_CHANGED" # `unitTarget` +---|"UNIT_COMBAT" # `unitTarget, event, flagText, amount, schoolMask` +---|"UNIT_CONNECTION" # `unitTarget, isConnected` +---|"UNIT_CTR_OPTIONS" # `unitTarget` +---|"UNIT_DAMAGE" # `unitTarget` +---|"UNIT_DEFENSE" # `unitTarget` +---|"UNIT_DIED" # `unitGUID` +---|"UNIT_DISPLAYPOWER" # `unitTarget` +---|"UNIT_DISTANCE_CHECK_UPDATE" # `unitTarget, isInDistance` +---|"UNIT_ENTERED_VEHICLE" # `unitTarget, showVehicleFrame, isControlSeat, vehicleUIIndicatorID, vehicleGUID, mayChooseExit, hasPitch` +---|"UNIT_ENTERING_VEHICLE" # `unitTarget, showVehicleFrame, isControlSeat, vehicleUIIndicatorID, vehicleGUID, mayChooseExit, hasPitch` +---|"UNIT_EXITED_VEHICLE" # `unitTarget` +---|"UNIT_EXITING_VEHICLE" # `unitTarget` +---|"UNIT_FACTION" # `unitTarget` +---|"UNIT_FLAGS" # `unitTarget` +---|"UNIT_FORM_CHANGED" # `unitTarget` +---|"UNIT_GUILD_LEVEL" # `newLevel` +---|"UNIT_HEALTH" # `unitTarget` +---|"UNIT_HEAL_ABSORB_AMOUNT_CHANGED" # `unitTarget` +---|"UNIT_HEAL_PREDICTION" # `unitTarget` +---|"UNIT_INVENTORY_CHANGED" # `unitTarget` +---|"UNIT_IN_RANGE_UPDATE" # `unitTarget, isInRange` +---|"UNIT_LEVEL" # `unitTarget` +---|"UNIT_LOOT" # `unitGUID, hasLoot` +---|"UNIT_MANA" # `unitTarget` +---|"UNIT_MAXHEALTH" # `unitTarget` +---|"UNIT_MAXPOWER" # `unitTarget, powerType` +---|"UNIT_MAX_HEALTH_MODIFIERS_CHANGED" # `unitTarget, percentMaxHealthAdjusted` +---|"UNIT_MODEL_CHANGED" # `unitTarget` +---|"UNIT_NAME_UPDATE" # `unitTarget` +---|"UNIT_OTHER_PARTY_CHANGED" # `unitTarget` +---|"UNIT_PET" # `unitTarget` +---|"UNIT_PET_EXPERIENCE" # `unitTarget` +---|"UNIT_PHASE" # `unitTarget` +---|"UNIT_PORTRAIT_UPDATE" # `unitTarget` +---|"UNIT_POWER_BAR_HIDE" # `unitTarget` +---|"UNIT_POWER_BAR_SHOW" # `unitTarget` +---|"UNIT_POWER_BAR_TIMER_UPDATE" # `unitTarget` +---|"UNIT_POWER_FREQUENT" # `unitTarget, powerType` +---|"UNIT_POWER_POINT_CHARGE" # `unitTarget` +---|"UNIT_POWER_UPDATE" # `unitTarget, powerType` +---|"UNIT_QUEST_LOG_CHANGED" # `unitTarget` +---|"UNIT_RANGEDDAMAGE" # `unitTarget` +---|"UNIT_RANGED_ATTACK_POWER" # `unitTarget` +---|"UNIT_RESISTANCES" # `unitTarget` +---|"UNIT_SPELLCAST_CHANNEL_START" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_CHANNEL_STOP" # `unitTarget, castGUID, spellID, interruptedBy, castBarID` +---|"UNIT_SPELLCAST_CHANNEL_UPDATE" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_DELAYED" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_EMPOWER_START" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_EMPOWER_STOP" # `unitTarget, castGUID, spellID, complete, interruptedBy, castBarID` +---|"UNIT_SPELLCAST_EMPOWER_UPDATE" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_FAILED" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_FAILED_QUIET" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_INTERRUPTED" # `unitTarget, castGUID, spellID, interruptedBy, castBarID` +---|"UNIT_SPELLCAST_INTERRUPTIBLE" # `unitTarget` +---|"UNIT_SPELLCAST_NOT_INTERRUPTIBLE" # `unitTarget` +---|"UNIT_SPELLCAST_RETICLE_CLEAR" # `unitTarget, castGUID, spellID` +---|"UNIT_SPELLCAST_RETICLE_TARGET" # `unitTarget, castGUID, spellID` +---|"UNIT_SPELLCAST_SENT" # `unitTarget, target, castGUID, spellID` +---|"UNIT_SPELLCAST_START" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_STOP" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELLCAST_SUCCEEDED" # `unitTarget, castGUID, spellID, castBarID` +---|"UNIT_SPELL_DIMINISH_CATEGORY_STATE_UPDATED" # `unitTarget, trackerInfo` +---|"UNIT_SPELL_HASTE" # `unitTarget` +---|"UNIT_STATS" # `unitTarget` +---|"UNIT_TARGET" # `unitTarget` +---|"UNIT_TARGETABLE_CHANGED" # `unitTarget` +---|"UNIT_THREAT_LIST_UPDATE" # `unitTarget` +---|"UNIT_THREAT_SITUATION_UPDATE" # `unitTarget` +---|"UPDATE_ACTIVE_BATTLEFIELD" +---|"UPDATE_ALL_UI_WIDGETS" +---|"UPDATE_BATTLEFIELD_SCORE" +---|"UPDATE_BATTLEFIELD_STATUS" # `battleFieldIndex` +---|"UPDATE_BINDINGS" +---|"UPDATE_BONUS_ACTIONBAR" +---|"UPDATE_BULLETIN_BOARD_MEMBER_TYPE" # `player, residentType` +---|"UPDATE_BULLETIN_BOARD_ROSTER" # `neighborhoodInfo, rosterMemberList` +---|"UPDATE_BULLETIN_BOARD_ROSTER_STATUSES" # `rosterMemberList` +---|"UPDATE_CHAT_COLOR" # `name, r, g, b` +---|"UPDATE_CHAT_COLOR_NAME_BY_CLASS" # `name, colorNameByClass` +---|"UPDATE_CHAT_WINDOWS" +---|"UPDATE_EXHAUSTION" +---|"UPDATE_EXTRA_ACTIONBAR" +---|"UPDATE_FACTION" +---|"UPDATE_FLOATING_CHAT_WINDOWS" +---|"UPDATE_INSTANCE_INFO" +---|"UPDATE_INVENTORY_ALERTS" +---|"UPDATE_INVENTORY_DURABILITY" +---|"UPDATE_LFG_LIST" +---|"UPDATE_MACROS" +---|"UPDATE_MASTER_LOOT_LIST" +---|"UPDATE_MOUSEOVER_UNIT" +---|"UPDATE_MULTI_CAST_ACTIONBAR" +---|"UPDATE_OVERRIDE_ACTIONBAR" +---|"UPDATE_PENDING_MAIL" +---|"UPDATE_POSSESS_BAR" +---|"UPDATE_SHAPESHIFT_COOLDOWN" +---|"UPDATE_SHAPESHIFT_FORM" +---|"UPDATE_SHAPESHIFT_FORMS" +---|"UPDATE_SHAPESHIFT_USABLE" +---|"UPDATE_SPELL_TARGET_ITEM_CONTEXT" +---|"UPDATE_STEALTH" +---|"UPDATE_SUMMONPETS_ACTION" +---|"UPDATE_TRADESKILL_CAST_STOPPED" # `isScrapping` +---|"UPDATE_UI_WIDGET" # `widgetInfo` +---|"UPDATE_VEHICLE_ACTIONBAR" +---|"UPDATE_WEB_TICKET" # `hasTicket, numTickets, ticketStatus, caseIndex, waitTimeMinutes, waitMessage, caseTitle, caseDescription` +---|"USER_WAYPOINT_UPDATED" +---|"USE_BIND_CONFIRM" +---|"USE_COMBINED_BAGS_CHANGED" # `useCombinedBags` +---|"USE_GLYPH" # `spellID` +---|"USE_NO_REFUND_CONFIRM" +---|"VARIABLES_LOADED" +---|"VEHICLE_ANGLE_SHOW" # `shouldShow` +---|"VEHICLE_ANGLE_UPDATE" # `normalizedPitch, radians` +---|"VEHICLE_PASSENGERS_CHANGED" +---|"VEHICLE_POWER_SHOW" # `shouldShow` +---|"VEHICLE_UPDATE" +---|"VIEWED_TRANSMOG_OUTFIT_CHANGED" +---|"VIEWED_TRANSMOG_OUTFIT_SECONDARY_SLOTS_CHANGED" +---|"VIEWED_TRANSMOG_OUTFIT_SITUATIONS_CHANGED" +---|"VIEWED_TRANSMOG_OUTFIT_SLOT_REFRESH" +---|"VIEWED_TRANSMOG_OUTFIT_SLOT_SAVE_SUCCESS" # `slot, type, option` +---|"VIEWED_TRANSMOG_OUTFIT_SLOT_WEAPON_OPTION_CHANGED" # `slot, weaponOption` +---|"VIEW_HOUSES_LIST_RECIEVED" # `houseInfos` +---|"VIGNETTES_UPDATED" +---|"VIGNETTE_MINIMAP_UPDATED" # `vignetteGUID, onMinimap` +---|"VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED" +---|"VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED" +---|"VOICE_CHAT_AUDIO_CAPTURE_ENERGY" # `isSpeaking, energy` +---|"VOICE_CHAT_AUDIO_CAPTURE_STARTED" +---|"VOICE_CHAT_AUDIO_CAPTURE_STOPPED" +---|"VOICE_CHAT_CHANNEL_ACTIVATED" # `channelID` +---|"VOICE_CHAT_CHANNEL_DEACTIVATED" # `channelID` +---|"VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED" # `channelID, channelDisplayName` +---|"VOICE_CHAT_CHANNEL_JOINED" # `status, channelID, channelType, clubId, streamId` +---|"VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED" # `memberID, channelID, isActive` +---|"VOICE_CHAT_CHANNEL_MEMBER_ADDED" # `memberID, channelID` +---|"VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED" # `memberID, channelID, speakingEnergy` +---|"VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED" # `memberID, channelID` +---|"VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED" # `memberID, channelID, isMutedForAll` +---|"VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED" # `memberID, channelID, isMutedForMe` +---|"VOICE_CHAT_CHANNEL_MEMBER_REMOVED" # `memberID, channelID` +---|"VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED" # `memberID, channelID, isSilenced` +---|"VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED" # `memberID, channelID, isSpeaking` +---|"VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE" # `memberID, channelID, message, language` +---|"VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED" # `memberID, channelID, volume` +---|"VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED" # `channelID, isMuted` +---|"VOICE_CHAT_CHANNEL_PTT_CHANGED" # `channelID, pushToTalkSetting` +---|"VOICE_CHAT_CHANNEL_REMOVED" # `channelID` +---|"VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED" # `channelID, isTranscribing` +---|"VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED" # `channelID, isTransmitting` +---|"VOICE_CHAT_CHANNEL_VOLUME_CHANGED" # `channelID, volume` +---|"VOICE_CHAT_COMMUNICATION_MODE_CHANGED" # `communicationMode` +---|"VOICE_CHAT_CONNECTION_SUCCESS" +---|"VOICE_CHAT_DEAFENED_CHANGED" # `isDeafened` +---|"VOICE_CHAT_ERROR" # `platformCode, statusCode` +---|"VOICE_CHAT_INPUT_DEVICES_UPDATED" +---|"VOICE_CHAT_LOGIN" # `status` +---|"VOICE_CHAT_LOGOUT" # `status` +---|"VOICE_CHAT_MUTED_CHANGED" # `isMuted` +---|"VOICE_CHAT_OUTPUT_DEVICES_UPDATED" +---|"VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE" # `channelType, clubId, streamId, pendingJoin` +---|"VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED" # `isPressed` +---|"VOICE_CHAT_SILENCED_CHANGED" # `isSilenced` +---|"VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED" +---|"VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED" +---|"VOICE_CHAT_TTS_PLAYBACK_BOOKMARK" # `utteranceID, bookmarkName` +---|"VOICE_CHAT_TTS_PLAYBACK_FAILED" # `utteranceID, status` +---|"VOICE_CHAT_TTS_PLAYBACK_FINISHED" # `utteranceID` +---|"VOICE_CHAT_TTS_PLAYBACK_STARTED" # `utteranceID` +---|"VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE" # `status, utteranceID` +---|"VOICE_CHAT_TTS_VOICES_UPDATE" +---|"VOICE_CHAT_VAD_SETTINGS_UPDATED" +---|"VOTE_KICK_REASON_NEEDED" # `name, resultGUID` +---|"WALK_IN_DATA_UPDATE" +---|"WARBAND_SCENE_FAVORITES_UPDATED" +---|"WARFRONT_COMPLETED" # `mapID, winner` +---|"WARGAME_INVITE_SENT" +---|"WARGAME_REQUESTED" # `opposingPartyMemberName, battlegroundName, timeoutSeconds, tournamentRules` +---|"WARGAME_REQUEST_RESPONSE" # `responderGUID, responderName, accepted` +---|"WAR_MODE_STATUS_UPDATE" # `warModeEnabled` +---|"WAYPOINT_UPDATE" +---|"WEAPON_ENCHANT_CHANGED" +---|"WEAPON_SLOT_CHANGED" +---|"WEEKLY_REWARDS_ITEM_CHANGED" +---|"WEEKLY_REWARDS_UPDATE" +---|"WHO_LIST_UPDATE" +---|"WORLD_CURSOR_TOOLTIP_UPDATE" # `anchorType` +---|"WORLD_LOOT_OBJECT_INFO_UPDATED" # `guid` +---|"WORLD_MAP_OPEN" # `uiMapID` +---|"WORLD_PVP_QUEUE" +---|"WORLD_QUEST_COMPLETED_BY_SPELL" # `questID` +---|"WORLD_STATE_TIMER_START" # `timerID` +---|"WORLD_STATE_TIMER_STOP" # `timerID` +---|"WOW_MOUSE_NOT_FOUND" +---|"ZONE_CHANGED" +---|"ZONE_CHANGED_INDOORS" +---|"ZONE_CHANGED_NEW_AREA" diff --git a/docs/annotations/Annotations/Core/Data/Wiki.lua b/docs/annotations/Annotations/Core/Data/Wiki.lua new file mode 100644 index 0000000..99de4de --- /dev/null +++ b/docs/annotations/Annotations/Core/Data/Wiki.lua @@ -0,0 +1,9095 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_AbandonSkill) +---@param skillLineID number +function AbandonSkill(skillLineID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptBattlefieldPort) +---@param index number +---@param accept boolean +function AcceptBattlefieldPort(index, accept) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptDuel) +function AcceptDuel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptGroup) +function AcceptGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptProposal) +function AcceptProposal() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptQuest) +function AcceptQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptSpellConfirmationPrompt) +---@param spellID number +function AcceptSpellConfirmationPrompt(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcceptTrade) +function AcceptTrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcknowledgeAutoAcceptQuest) +function AcknowledgeAutoAcceptQuest() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_AcknowledgeSurvey) +function AcknowledgeSurvey(caseIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AddAutoQuestPopUp) +---@param questID number +---@param type string +function AddAutoQuestPopUp(questID, type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AddChatWindowChannel) +---@param windowId number +---@param channelName string +function AddChatWindowChannel(windowId, channelName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AddChatWindowMessages) +---@param index number +---@param messageGroup string +function AddChatWindowMessages(index, messageGroup) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_AntiAliasingSupported) +function AntiAliasingSupported() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArchaeologyGetIconInfo) +---@param index number +function ArchaeologyGetIconInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArchaeologyMapUpdateAll) +---@param uiMapID number +---@return number numSites +function ArchaeologyMapUpdateAll(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ArcheologyGetVisibleBlobID) +---@param index number +---@return number blobID +function ArcheologyGetVisibleBlobID(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_AreTalentsLocked) +function AreTalentsLocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AscendStop) +function AscendStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_AttachGlyphToSpell) +function AttachGlyphToSpell(spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_AutoChooseCurrentGraphicsSetting) +function AutoChooseCurrentGraphicsSetting() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_AutoLootMailItem) +function AutoLootMailItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AutoStoreGuildBankItem) +---@param tab number +---@param slot number +function AutoStoreGuildBankItem(tab, slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNAcceptFriendInvite) +function BNAcceptFriendInvite(ID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNCheckBattleTagInviteToGuildMember) +function BNCheckBattleTagInviteToGuildMember(fullname) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNCheckBattleTagInviteToUnit) +function BNCheckBattleTagInviteToUnit(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNConnected) +---@return boolean connected +function BNConnected() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNDeclineFriendInvite) +function BNDeclineFriendInvite(ID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNFeaturesEnabled) +function BNFeaturesEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNFeaturesEnabledAndConnected) +function BNFeaturesEnabledAndConnected() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetBlockedInfo) +function BNGetBlockedInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetDisplayName) +function BNGetDisplayName(bnetIdAccount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetFOFInfo) +---@param mutual boolean +---@param nonMutual boolean +---@param index number +---@return number friendID +---@return string accountName +---@return boolean isMutual +function BNGetFOFInfo(mutual, nonMutual, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetFriendIndex) +---@param presenceID number +---@return number index +function BNGetFriendIndex(presenceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetFriendInviteInfo) +---@param inviteIndex number +---@return number inviteID +---@return number accountName +---@return boolean isBattleTag +---@return string? message +---@return number sentTime +function BNGetFriendInviteInfo(inviteIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetInfo) +---@return number? presenceID +---@return string battleTag +---@return number toonID +---@return string currentBroadcast +---@return boolean bnetAFK +---@return boolean bnetDND +---@return boolean isRIDEnabled +function BNGetInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetNumBlocked) +function BNGetNumBlocked() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetNumFOF) +function BNGetNumFOF(ID, mutual, non) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetNumFriendInvites) +function BNGetNumFriendInvites() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetNumFriends) +---@return number numBNetTotal +---@return number numBNetOnline +---@return number numBNetFavorite +---@return number numBNetFavoriteOnline +function BNGetNumFriends() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetSelectedBlock) +function BNGetSelectedBlock() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNGetSelectedFriend) +function BNGetSelectedFriend() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNInviteFriend) +function BNInviteFriend(bnetIDGameAccount) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNIsBlocked) +function BNIsBlocked(ID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNIsFriend) +function BNIsFriend(presenceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNIsSelf) +function BNIsSelf(presenceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNRemoveFriend) +function BNRemoveFriend(ID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNRequestFOFInfo) +function BNRequestFOFInfo(bnetIDAccount) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNRequestInviteFriend) +function BNRequestInviteFriend(presenceID, tank, heal, dps) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSendFriendInvite) +function BNSendFriendInvite(text, noteText) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSendFriendInviteByID) +function BNSendFriendInviteByID(ID, noteText) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSendVerifiedBattleTagInvite) +function BNSendVerifiedBattleTagInvite() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSetBlocked) +function BNSetBlocked(ID, bool) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSetFriendFavoriteFlag) +---@param id number +---@param isFavorite boolean +function BNSetFriendFavoriteFlag(id, isFavorite) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSetFriendNote) +---@param bnetIDAccount number +---@param noteText string +function BNSetFriendNote(bnetIDAccount, noteText) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSetSelectedBlock) +function BNSetSelectedBlock(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSetSelectedFriend) +function BNSetSelectedFriend(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNSummonFriendByIndex) +function BNSummonFriendByIndex(id) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BNTokenFindName) +function BNTokenFindName(target) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BattlefieldMgrEntryInviteResponse) +function BattlefieldMgrEntryInviteResponse(queueId, accept) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BattlefieldMgrExitRequest) +function BattlefieldMgrExitRequest(queueId) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BattlefieldMgrQueueInviteResponse) +function BattlefieldMgrQueueInviteResponse(queueId, accept) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BattlefieldMgrQueueRequest) +function BattlefieldMgrQueueRequest() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_BuyGuildBankTab) +function BuyGuildBankTab() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BuyGuildCharter) +---@param guildName string +function BuyGuildCharter(guildName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BuyMerchantItem) +---@param index number +---@param quantity? number +function BuyMerchantItem(index, quantity) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BuyTrainerService) +---@param index number +function BuyTrainerService(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_BuybackItem) +---@param slot number +function BuybackItem(slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountServices.IsAccountLockedPostSave) +function C_AccountServices.IsAccountLockedPostSave() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountServices.IsAccountSaveEnabled) +function C_AccountServices.IsAccountSaveEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountServices.IsAccountSaveInProgress) +function C_AccountServices.IsAccountSaveInProgress() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AccountServices.SaveAccountData) +function C_AccountServices.SaveAccountData() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.ActivateEntry) +function C_AdventureJournal.ActivateEntry(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.CanBeShown) +function C_AdventureJournal.CanBeShown() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.GetNumAvailableSuggestions) +function C_AdventureJournal.GetNumAvailableSuggestions() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.GetPrimaryOffset) +function C_AdventureJournal.GetPrimaryOffset() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.GetReward) +function C_AdventureJournal.GetReward() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.GetSuggestions) +function C_AdventureJournal.GetSuggestions(suggestions) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.SetPrimaryOffset) +function C_AdventureJournal.SetPrimaryOffset(offset) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureJournal.UpdateSuggestions) +function C_AdventureJournal.UpdateSuggestions(levelUp) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.Close) +function C_AdventureMap.Close() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetMapID) +function C_AdventureMap.GetMapID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetMapInsetDetailTileInfo) +function C_AdventureMap.GetMapInsetDetailTileInfo(insetIndex, tileIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetMapInsetInfo) +function C_AdventureMap.GetMapInsetInfo(insetIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetNumMapInsets) +function C_AdventureMap.GetNumMapInsets() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetNumQuestOffers) +function C_AdventureMap.GetNumQuestOffers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetNumZoneChoices) +function C_AdventureMap.GetNumZoneChoices() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetQuestInfo) +function C_AdventureMap.GetQuestInfo(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetQuestOfferInfo) +function C_AdventureMap.GetQuestOfferInfo(offerIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.GetZoneChoiceInfo) +function C_AdventureMap.GetZoneChoiceInfo(choiceIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_AdventureMap.StartQuest) +function C_AdventureMap.StartQuest(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArrowCalloutManager.AcknowledgeCallout) +function C_ArrowCalloutManager.AcknowledgeCallout() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ArrowCalloutManager.HideCallout) +function C_ArrowCalloutManager.HideCallout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.Close) +function C_BlackMarket.Close() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.GetItemInfoByID) +---@param marketID number +---@return string name +---@return string texture +---@return number quantity +---@return string itemType +---@return boolean usable +---@return number level +---@return string levelType +---@return string sellerName +---@return number minBid +---@return number minIncrement +---@return number currBid +---@return boolean youHaveHighBid +---@return number numBids +---@return number timeLeft +---@return string link +---@return number marketID +---@return number quality +function C_BlackMarket.GetItemInfoByID(marketID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.GetItemInfoByIndex) +---@param index number +---@return string name +---@return string texture +---@return number quantity +---@return string itemType +---@return boolean usable +---@return number level +---@return string levelType +---@return string sellerName +---@return number minBid +---@return number minIncrement +---@return number currBid +---@return boolean youHaveHighBid +---@return number numBids +---@return number timeLeft +---@return string link +---@return number marketID +---@return number quality +function C_BlackMarket.GetItemInfoByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.GetHotItem) +---@return string name +---@return string texture +---@return number quantity +---@return string itemType +---@return boolean usable +---@return number level +---@return string levelType +---@return string sellerName +---@return number minBid +---@return number minIncrement +---@return number currBid +---@return boolean youHaveHighBid +---@return number numBids +---@return number timeLeft +---@return string link +---@return number marketID +---@return number quality +function C_BlackMarket.GetHotItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.GetNumItems) +---@return number numItems +function C_BlackMarket.GetNumItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.IsViewOnly) +---@return boolean viewOnly +function C_BlackMarket.IsViewOnly() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.ItemPlaceBid) +---@param marketID number +---@param bid number +function C_BlackMarket.ItemPlaceBid(marketID, bid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_BlackMarket.RequestItems) +function C_BlackMarket.RequestItems() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.ArePaidCharacterTransfersBetweenBnetAccountsEnabled) +function C_CharacterServices.ArePaidCharacterTransfersBetweenBnetAccountsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.AssignFCMDistribution) +function C_CharacterServices.AssignFCMDistribution() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.AssignNameChangeDistribution) +function C_CharacterServices.AssignNameChangeDistribution() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.AssignPCTDistribution) +function C_CharacterServices.AssignPCTDistribution() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.AssignRaceOrFactionChangeDistribution) +function C_CharacterServices.AssignRaceOrFactionChangeDistribution() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.AssignUpgradeDistribution) +function C_CharacterServices.AssignUpgradeDistribution() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.CapitalizeCharName) +function C_CharacterServices.CapitalizeCharName() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetActiveCharacterUpgradeBoostType) +function C_CharacterServices.GetActiveCharacterUpgradeBoostType() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetActiveClassTrialBoostType) +function C_CharacterServices.GetActiveClassTrialBoostType() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetAutomaticBoost) +function C_CharacterServices.GetAutomaticBoost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetAutomaticBoostCharacter) +function C_CharacterServices.GetAutomaticBoostCharacter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetCharacterServiceDisplayData) +function C_CharacterServices.GetCharacterServiceDisplayData() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetCharacterServiceDisplayDataByVASType) +function C_CharacterServices.GetCharacterServiceDisplayDataByVASType() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetCharacterServiceDisplayInfo) +function C_CharacterServices.GetCharacterServiceDisplayInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.GetVASDistributions) +function C_CharacterServices.GetVASDistributions() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.HasRequiredBoostForClassTrial) +function C_CharacterServices.HasRequiredBoostForClassTrial() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.HasRequiredBoostForUnrevoke) +function C_CharacterServices.HasRequiredBoostForUnrevoke() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.SetAutomaticBoost) +function C_CharacterServices.SetAutomaticBoost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServices.SetAutomaticBoostCharacter) +function C_CharacterServices.SetAutomaticBoostCharacter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CharacterServicesPublic.ShouldSeeControlPopup) +function C_CharacterServicesPublic.ShouldSeeControlPopup() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTrial.GetClassTrialLogoutTimeSeconds) +function C_ClassTrial.GetClassTrialLogoutTimeSeconds() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ClassTrial.IsClassTrialCharacter) +function C_ClassTrial.IsClassTrialCharacter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.DashboardIsEnabled) +function C_Debug.DashboardIsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.FrameXMLDebug) +---@param newDebugLevel? number +---@return number result +function C_Debug.FrameXMLDebug(newDebugLevel) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.GetAllPortLocsForMap) +function C_Debug.GetAllPortLocsForMap(uiMapID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.GetMapDebugObjects) +function C_Debug.GetMapDebugObjects(uiMapID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.TeleportToMapDebugObject) +function C_Debug.TeleportToMapDebugObject(pinIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.TeleportToMapLocation) +function C_Debug.TeleportToMapLocation(uiMapID, mapX, mapY) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.ToggleDebugCharInfo) +function C_Debug.ToggleDebugCharInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Debug.ToggleWindDebugMenu) +function C_Debug.ToggleWindDebugMenu() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_FunctionContainers.CreateCallback) +---@param func function +---@return FunctionContainer container +function C_FunctionContainers.CreateCallback(func) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.AllowMissionStartAboveSoftCap) +function C_Garrison.AllowMissionStartAboveSoftCap(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.AreMissionFollowerRequirementsMet) +function C_Garrison.AreMissionFollowerRequirementsMet(missionRecID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.AssignFollowerToBuilding) +function C_Garrison.AssignFollowerToBuilding(plotInstanceID, followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CanGenerateRecruits) +function C_Garrison.CanGenerateRecruits() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CanOpenMissionChest) +function C_Garrison.CanOpenMissionChest(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CanSetRecruitmentPreference) +function C_Garrison.CanSetRecruitmentPreference() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CanSpellTargetFollowerIDWithAddAbility) +function C_Garrison.CanSpellTargetFollowerIDWithAddAbility(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CanUpgradeGarrison) +function C_Garrison.CanUpgradeGarrison() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CancelConstruction) +function C_Garrison.CancelConstruction(plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CastItemSpellOnFollowerAbility) +function C_Garrison.CastItemSpellOnFollowerAbility(followerID, abilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CastSpellOnFollower) +function C_Garrison.CastSpellOnFollower(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CastSpellOnFollowerAbility) +function C_Garrison.CastSpellOnFollowerAbility(followerID, abilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CastSpellOnMission) +function C_Garrison.CastSpellOnMission(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.ClearCompleteTalent) +function C_Garrison.ClearCompleteTalent(garrisonType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CloseArchitect) +function C_Garrison.CloseArchitect() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CloseGarrisonTradeskillNPC) +function C_Garrison.CloseGarrisonTradeskillNPC() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CloseMissionNPC) +function C_Garrison.CloseMissionNPC() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CloseRecruitmentNPC) +function C_Garrison.CloseRecruitmentNPC() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CloseTalentNPC) +function C_Garrison.CloseTalentNPC() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.CloseTradeskillCrafter) +function C_Garrison.CloseTradeskillCrafter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GenerateRecruits) +function C_Garrison.GenerateRecruits(mechanicTypeID, traitID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAllBonusAbilityEffects) +function C_Garrison.GetAllBonusAbilityEffects() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAllEncounterThreats) +function C_Garrison.GetAllEncounterThreats(garrFollowerTypeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAvailableMissions) +---@param garrFollowerTypeID Enum.GarrisonFollowerType +---@return MissionInfo[] info +---@overload fun(missionList: MissionInfo[], garrFollowerTypeID: Enum.GarrisonFollowerType) +function C_Garrison.GetAvailableMissions(garrFollowerTypeID) end + +---@class MissionInfo +---@field areaID number +---@field basecost number +---@field canStart boolean +---@field completed boolean +---@field cost number +---@field costCurrencyTypesID number +---@field description string +---@field duration string +---@field durationSeconds number +---@field followers table +---@field followerTypeID Enum.GarrisonFollowerType +---@field hasBonusEffect boolean +---@field iLevel number +---@field inProgress boolean +---@field isMaxLevel boolean +---@field isRare boolean +---@field isTutorialMission boolean +---@field isZoneSupport boolean +---@field level number +---@field location string +---@field locTextureKit string +---@field mapPosX number +---@field mapPosY number +---@field missionEndTime? number +---@field missionID number +---@field missionScalar number +---@field name string +---@field numFollowers number +---@field offeredGarrMissionTextureID number +---@field offerEndTime number +---@field offerTimeRemaining string +---@field overmaxRewards MissionOvermaxRewards +---@field overmaxSucceeded boolean +---@field requiredChampionCount number +---@field requiredSuccessChance number +---@field rewards MissionRewards +---@field timeLeft? string +---@field timeLeftSeconds? number +---@field type string +---@field typeAtlas string +---@field xp number + +---@class MissionOvermaxRewards +---@field followerXP number +---@field icon string +---@field name string +---@field title string +---@field tooltip string + +---@class MissionRewards +---@field currencyID number +---@field icon number +---@field quantity number +---@field title string + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetAvailableRecruits) +function C_Garrison.GetAvailableRecruits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBasicMissionInfo) +---@param missionID number +---@return MissionInfo info +function C_Garrison.GetBasicMissionInfo(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuffedFollowersForMission) +function C_Garrison.GetBuffedFollowersForMission(missionID, displayingAbilities) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingInfo) +---@param buildingID number +---@return number id +---@return string name +---@return string textureKit +---@return fileID icon +---@return string description +---@return number rank +---@return number currencyID +---@return number currencyQty +---@return number goldQty +---@return string buildTime +---@return boolean needsPlan +---@return boolean isPrebuilt +---@return table possSpecs +---@return number[] upgrades +---@return boolean canUpgrade +---@return boolean isMaxLevel +---@return boolean hasFollowerSlot +function C_Garrison.GetBuildingInfo(buildingID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingLockInfo) +function C_Garrison.GetBuildingLockInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingSizes) +function C_Garrison.GetBuildingSizes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingSpecInfo) +function C_Garrison.GetBuildingSpecInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingTimeRemaining) +function C_Garrison.GetBuildingTimeRemaining(plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingTooltip) +function C_Garrison.GetBuildingTooltip(buildingID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingUpgradeInfo) +function C_Garrison.GetBuildingUpgradeInfo(buildingID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildings) +function C_Garrison.GetBuildings(garrisonType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingsForPlot) +function C_Garrison.GetBuildingsForPlot(plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetBuildingsForSize) +function C_Garrison.GetBuildingsForSize(garrisonType, uiCategoryID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetClassSpecCategoryInfo) +function C_Garrison.GetClassSpecCategoryInfo(garrFollowerType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCombatAllyMission) +function C_Garrison.GetCombatAllyMission(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCompleteMissions) +function C_Garrison.GetCompleteMissions(missionList, garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCompleteTalent) +function C_Garrison.GetCompleteTalent(garrisonType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetCurrencyTypes) +function C_Garrison.GetCurrencyTypes(garrType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilities) +---@param followerID number|string +---@return AbilityInfo[] abilities +---@return AbilityInfo[]? extraAbilities +function C_Garrison.GetFollowerAbilities(followerID) end + +---@class AbilityInfo +---@field category? string +---@field counters table +---@field description string +---@field icon? fileID +---@field id number +---@field isEmptySlot boolean +---@field isSpecialization boolean +---@field isTrait boolean +---@field name string +---@field requiredQualityLevel? number +---@field temporary boolean + +---@class AbilityCounter +---@field description string +---@field factor number +---@field icon fileID +---@field name string + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityAtIndex) +---@param followerID string +---@param index number +---@return number abilityID +function C_Garrison.GetFollowerAbilityAtIndex(followerID, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityAtIndexByID) +function C_Garrison.GetFollowerAbilityAtIndexByID(garrFollowerID, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityCounterMechanicInfo) +function C_Garrison.GetFollowerAbilityCounterMechanicInfo(garrAbilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityCountersForMechanicTypes) +function C_Garrison.GetFollowerAbilityCountersForMechanicTypes(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityDescription) +function C_Garrison.GetFollowerAbilityDescription(garrAbilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityIcon) +function C_Garrison.GetFollowerAbilityIcon(garrAbilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityInfo) +function C_Garrison.GetFollowerAbilityInfo(garrAbilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityIsTrait) +function C_Garrison.GetFollowerAbilityIsTrait(garrAbilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityLink) +function C_Garrison.GetFollowerAbilityLink(abilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerAbilityName) +function C_Garrison.GetFollowerAbilityName(garrAbilityID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerActivationCost) +function C_Garrison.GetFollowerActivationCost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerBiasForMission) +function C_Garrison.GetFollowerBiasForMission(missionID, followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerClassSpec) +function C_Garrison.GetFollowerClassSpec(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerClassSpecAtlas) +function C_Garrison.GetFollowerClassSpecAtlas(garrSpecID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerClassSpecByID) +function C_Garrison.GetFollowerClassSpecByID(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerClassSpecName) +function C_Garrison.GetFollowerClassSpecName(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerDisplayID) +function C_Garrison.GetFollowerDisplayID(followerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerInfo) +---@param followerID number|string +---@return GarrFollowerInfo info +function C_Garrison.GetFollowerInfo(followerID) end + +---@class GarrFollowerInfo +---@field classAtlas string +---@field className string +---@field classSpec number +---@field displayHeight number +---@field displayIDs DisplayInfo[] +---@field displayScale number +---@field followerID string|number +---@field followerTypeID number +---@field garrFollowerID? number +---@field height number +---@field iLevel number +---@field isAutoTroop? boolean +---@field isCollected? boolean +---@field isFavorite boolean +---@field isMaxLevel boolean +---@field isSoulbind? boolean +---@field isTroop? boolean +---@field level number +---@field levelXP? number +---@field name string +---@field portraitIconID number +---@field quality Enum.ItemQuality +---@field scale number +---@field slotSoundKitID? number +---@field status? string +---@field xp? number + +---@class DisplayInfo +---@field followerPageScale number +---@field id number +---@field showWeapon? boolean + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerInfoForBuilding) +function C_Garrison.GetFollowerInfoForBuilding() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerIsTroop) +function C_Garrison.GetFollowerIsTroop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerItemLevelAverage) +function C_Garrison.GetFollowerItemLevelAverage(followerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerItems) +---@param followerID string +---@return number weaponItemID +---@return number weaponItemLevel +---@return number armorItemID +---@return number armorItemLevel +function C_Garrison.GetFollowerItems(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerLevel) +function C_Garrison.GetFollowerLevel(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerLevelXP) +function C_Garrison.GetFollowerLevelXP(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerLink) +function C_Garrison.GetFollowerLink(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerLinkByID) +function C_Garrison.GetFollowerLinkByID(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerMissionTimeLeft) +function C_Garrison.GetFollowerMissionTimeLeft(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerMissionTimeLeftSeconds) +function C_Garrison.GetFollowerMissionTimeLeftSeconds(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerModelItems) +function C_Garrison.GetFollowerModelItems(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerName) +function C_Garrison.GetFollowerName(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerNameByID) +function C_Garrison.GetFollowerNameByID(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerPortraitIconID) +function C_Garrison.GetFollowerPortraitIconID(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerPortraitIconIDByID) +function C_Garrison.GetFollowerPortraitIconIDByID(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerQuality) +function C_Garrison.GetFollowerQuality(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerQualityTable) +function C_Garrison.GetFollowerQualityTable(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerRecentlyGainedAbilityIDs) +function C_Garrison.GetFollowerRecentlyGainedAbilityIDs(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerRecentlyGainedTraitIDs) +function C_Garrison.GetFollowerRecentlyGainedTraitIDs(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerShipments) +function C_Garrison.GetFollowerShipments(garrTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerSoftCap) +function C_Garrison.GetFollowerSoftCap(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerSourceTextByID) +function C_Garrison.GetFollowerSourceTextByID(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerSpecializationAtIndex) +function C_Garrison.GetFollowerSpecializationAtIndex(followerID, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerStatus) +function C_Garrison.GetFollowerStatus(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerTraitAtIndex) +function C_Garrison.GetFollowerTraitAtIndex(followerID, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerTraitAtIndexByID) +function C_Garrison.GetFollowerTraitAtIndexByID(garrFollowerID, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerTypeByID) +function C_Garrison.GetFollowerTypeByID(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerTypeByMissionID) +function C_Garrison.GetFollowerTypeByMissionID(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerUnderBiasReason) +function C_Garrison.GetFollowerUnderBiasReason(missionID, followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerXP) +function C_Garrison.GetFollowerXP(followerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerXPTable) +function C_Garrison.GetFollowerXPTable(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowerZoneSupportAbilities) +function C_Garrison.GetFollowerZoneSupportAbilities() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowers) +---@param followerType? Enum.GarrisonFollowerType +---@return GarrFollowerInfo[] info +function C_Garrison.GetFollowers(followerType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowersSpellsForMission) +function C_Garrison.GetFollowersSpellsForMission(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetFollowersTraitsForMission) +function C_Garrison.GetFollowersTraitsForMission(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetGarrisonInfo) +---@param garrisonType Enum.GarrisonType +---@return number? garrisonLevel +---@return string? mapTexture +---@return number? townHallX +---@return number? townHallY +function C_Garrison.GetGarrisonInfo(garrisonType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetGarrisonUpgradeCost) +function C_Garrison.GetGarrisonUpgradeCost(followerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetInProgressMissions) +---@param garrFollowerTypeID Enum.GarrisonFollowerType +---@return MissionInfo[] info +function C_Garrison.GetInProgressMissions(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetLandingPageGarrisonType) +function C_Garrison.GetLandingPageGarrisonType() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetLandingPageItems) +function C_Garrison.GetLandingPageItems(garrTypeID, noSort) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetLandingPageShipmentCount) +function C_Garrison.GetLandingPageShipmentCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetLandingPageShipmentInfo) +---@param buildingID number +---@return string name +---@return string texture +---@return number shipmentCapacity +---@return number shipmentsReady +---@return number shipmentsTotal +---@return number creationTime +---@return number duration +---@return string timeleftString +---@return string itemName +---@return number itemIcon +---@return number itemQuality +---@return number itemID +function C_Garrison.GetLandingPageShipmentInfo(buildingID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetLandingPageShipmentInfoByContainerID) +---@param containerID number +---@return string name +---@return number texture +---@return number shipmentCapacity +---@return number shipmentsReady +---@return number shipmentsTotal +---@return number creationTime +---@return number duration +---@return string timeleftString +---@return string itemName +---@return number itemTexture +---@return number unk1 +---@return number itemID +---@return number followerID +function C_Garrison.GetLandingPageShipmentInfoByContainerID(containerID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetLooseShipments) +---@param garrisonType Enum.GarrisonType +---@return number[] looseShipments +function C_Garrison.GetLooseShipments(garrisonType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionBonusAbilityEffects) +function C_Garrison.GetMissionBonusAbilityEffects(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionCost) +function C_Garrison.GetMissionCost(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionDisplayIDs) +function C_Garrison.GetMissionDisplayIDs(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionLink) +function C_Garrison.GetMissionLink(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionMaxFollowers) +function C_Garrison.GetMissionMaxFollowers(garrMissionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionName) +function C_Garrison.GetMissionName(garrMissionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionRewardInfo) +function C_Garrison.GetMissionRewardInfo(garrMissionID, missionDBID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionSuccessChance) +function C_Garrison.GetMissionSuccessChance(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionTexture) +function C_Garrison.GetMissionTexture(offeredGarrMissionTextureID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionTimes) +function C_Garrison.GetMissionTimes(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetMissionUncounteredMechanics) +function C_Garrison.GetMissionUncounteredMechanics(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumActiveFollowers) +function C_Garrison.GetNumActiveFollowers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumFollowerActivationsRemaining) +function C_Garrison.GetNumFollowerActivationsRemaining(garrTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumFollowerDailyActivations) +function C_Garrison.GetNumFollowerDailyActivations() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumFollowers) +function C_Garrison.GetNumFollowers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumFollowersForMechanic) +function C_Garrison.GetNumFollowersForMechanic(followerType, mechanicID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumFollowersOnMission) +function C_Garrison.GetNumFollowersOnMission(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumPendingShipments) +function C_Garrison.GetNumPendingShipments() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumShipmentCurrencies) +function C_Garrison.GetNumShipmentCurrencies() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetNumShipmentReagents) +function C_Garrison.GetNumShipmentReagents() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetOwnedBuildingInfo) +function C_Garrison.GetOwnedBuildingInfo(plotInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetOwnedBuildingInfoAbbrev) +---@param plotID number +---@return number id +---@return string name +---@return string textureKit +---@return number icon +---@return number rank +---@return boolean isBuilding +---@return number timeStart +---@return number buildTime +---@return boolean canActivate +---@return boolean canUpgrade +---@return boolean isPrebuilt +function C_Garrison.GetOwnedBuildingInfoAbbrev(plotID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPartyBuffs) +function C_Garrison.GetPartyBuffs(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPartyMentorLevels) +function C_Garrison.GetPartyMentorLevels(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPartyMissionInfo) +function C_Garrison.GetPartyMissionInfo(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPendingShipmentInfo) +function C_Garrison.GetPendingShipmentInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPlots) +function C_Garrison.GetPlots(followerType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPlotsForBuilding) +function C_Garrison.GetPlotsForBuilding(buildingID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetPossibleFollowersForBuilding) +function C_Garrison.GetPossibleFollowersForBuilding(followerType, plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetRecruitAbilities) +function C_Garrison.GetRecruitAbilities(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetRecruiterAbilityCategories) +function C_Garrison.GetRecruiterAbilityCategories() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetRecruiterAbilityList) +function C_Garrison.GetRecruiterAbilityList(traits) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetRecruitmentPreferences) +function C_Garrison.GetRecruitmentPreferences() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetShipDeathAnimInfo) +function C_Garrison.GetShipDeathAnimInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetShipmentContainerInfo) +function C_Garrison.GetShipmentContainerInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetShipmentItemInfo) +function C_Garrison.GetShipmentItemInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetShipmentReagentCurrencyInfo) +function C_Garrison.GetShipmentReagentCurrencyInfo(currencyIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetShipmentReagentInfo) +function C_Garrison.GetShipmentReagentInfo(reagentIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetShipmentReagentItemLink) +function C_Garrison.GetShipmentReagentItemLink(reagentIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetSpecChangeCost) +function C_Garrison.GetSpecChangeCost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.GetTabForPlot) +function C_Garrison.GetTabForPlot(plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.HasGarrison) +function C_Garrison.HasGarrison(garrisonType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.HasShipyard) +---@return boolean hasShipyard +function C_Garrison.HasShipyard() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsAboveFollowerSoftCap) +function C_Garrison.IsAboveFollowerSoftCap(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsFollowerCollected) +function C_Garrison.IsFollowerCollected(garrFollowerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsInvasionAvailable) +function C_Garrison.IsInvasionAvailable() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsMechanicFullyCountered) +function C_Garrison.IsMechanicFullyCountered(missionID, followerID, mechanicID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsOnGarrisonMap) +function C_Garrison.IsOnGarrisonMap() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsOnShipmentQuestForNPC) +function C_Garrison.IsOnShipmentQuestForNPC() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsOnShipyardMap) +function C_Garrison.IsOnShipyardMap() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsPlayerInGarrison) +function C_Garrison.IsPlayerInGarrison(garrType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsUsingPartyGarrison) +---@return boolean usingPartyGarrison +function C_Garrison.IsUsingPartyGarrison() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.IsVisitGarrisonAvailable) +function C_Garrison.IsVisitGarrisonAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.MarkMissionComplete) +---@param missionID number +function C_Garrison.MarkMissionComplete(missionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.MissionBonusRoll) +---@param missionID number +function C_Garrison.MissionBonusRoll(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.PlaceBuilding) +function C_Garrison.PlaceBuilding(plotInstanceID, buildingID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RecruitFollower) +function C_Garrison.RecruitFollower(followerIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RemoveFollower) +function C_Garrison.RemoveFollower(dbID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RemoveFollowerFromBuilding) +function C_Garrison.RemoveFollowerFromBuilding() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RenameFollower) +function C_Garrison.RenameFollower(followerID, name) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RequestClassSpecCategoryInfo) +function C_Garrison.RequestClassSpecCategoryInfo(garrFollowerTypeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RequestGarrisonUpgradeable) +function C_Garrison.RequestGarrisonUpgradeable(followerType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RequestLandingPageShipmentInfo) +function C_Garrison.RequestLandingPageShipmentInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RequestShipmentCreation) +function C_Garrison.RequestShipmentCreation() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.RequestShipmentInfo) +function C_Garrison.RequestShipmentInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.ResearchTalent) +function C_Garrison.ResearchTalent(garrTalentID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SearchForFollower) +function C_Garrison.SearchForFollower() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetBuildingActive) +function C_Garrison.SetBuildingActive(plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetBuildingSpecialization) +function C_Garrison.SetBuildingSpecialization() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetFollowerFavorite) +function C_Garrison.SetFollowerFavorite() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetFollowerInactive) +function C_Garrison.SetFollowerInactive(followerID, inactive) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetRecruitmentPreferences) +function C_Garrison.SetRecruitmentPreferences(mechanicTypeID, traitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SetUsingPartyGarrison) +---@param enabled boolean +function C_Garrison.SetUsingPartyGarrison(enabled) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.ShouldShowMapTab) +function C_Garrison.ShouldShowMapTab(garrType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.ShowFollowerNameInErrorMessage) +function C_Garrison.ShowFollowerNameInErrorMessage(missionRecID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.StartMission) +---@param missionID number +function C_Garrison.StartMission(missionID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.SwapBuildings) +function C_Garrison.SwapBuildings(plotInstanceID1, plotInstanceID2) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.TargetSpellHasFollowerItemLevelUpgrade) +function C_Garrison.TargetSpellHasFollowerItemLevelUpgrade() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.TargetSpellHasFollowerReroll) +function C_Garrison.TargetSpellHasFollowerReroll() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.TargetSpellHasFollowerTemporaryAbility) +function C_Garrison.TargetSpellHasFollowerTemporaryAbility() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.UpgradeBuilding) +function C_Garrison.UpgradeBuilding(plotInstanceID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Garrison.UpgradeGarrison) +function C_Garrison.UpgradeGarrison(followerType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.CanHeirloomUpgradeFromPending) +---@param itemID number +---@return boolean canUpgrade +function C_Heirloom.CanHeirloomUpgradeFromPending(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.CreateHeirloom) +function C_Heirloom.CreateHeirloom(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetClassAndSpecFilters) +function C_Heirloom.GetClassAndSpecFilters() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetCollectedHeirloomFilter) +function C_Heirloom.GetCollectedHeirloomFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetHeirloomInfo) +---@param itemID number +---@return string name +---@return string itemEquipLoc +---@return boolean isPvP +---@return string itemTexture +---@return number upgradeLevel +---@return number source +---@return boolean searchFiltered +---@return number effectiveLevel +---@return number minLevel +---@return number maxLevel +function C_Heirloom.GetHeirloomInfo(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetHeirloomItemIDFromDisplayedIndex) +function C_Heirloom.GetHeirloomItemIDFromDisplayedIndex(heirloomIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetHeirloomItemIDs) +---@return number[] itemIDs +function C_Heirloom.GetHeirloomItemIDs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetHeirloomLink) +function C_Heirloom.GetHeirloomLink(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetHeirloomMaxUpgradeLevel) +function C_Heirloom.GetHeirloomMaxUpgradeLevel(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetHeirloomSourceFilter) +function C_Heirloom.GetHeirloomSourceFilter(source) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetNumDisplayedHeirlooms) +function C_Heirloom.GetNumDisplayedHeirlooms() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetNumHeirlooms) +function C_Heirloom.GetNumHeirlooms() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetNumKnownHeirlooms) +function C_Heirloom.GetNumKnownHeirlooms() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.GetUncollectedHeirloomFilter) +function C_Heirloom.GetUncollectedHeirloomFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.IsItemHeirloom) +function C_Heirloom.IsItemHeirloom(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.IsPendingHeirloomUpgrade) +function C_Heirloom.IsPendingHeirloomUpgrade() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.PlayerHasHeirloom) +function C_Heirloom.PlayerHasHeirloom(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.SetClassAndSpecFilters) +function C_Heirloom.SetClassAndSpecFilters(classID, specID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.SetCollectedHeirloomFilter) +function C_Heirloom.SetCollectedHeirloomFilter(boolean) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.SetHeirloomSourceFilter) +function C_Heirloom.SetHeirloomSourceFilter(source, filtered) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.SetSearch) +function C_Heirloom.SetSearch(searchValue) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.SetUncollectedHeirloomFilter) +function C_Heirloom.SetUncollectedHeirloomFilter(boolean) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.ShouldShowHeirloomHelp) +function C_Heirloom.ShouldShowHeirloomHelp() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Heirloom.UpgradeHeirloom) +function C_Heirloom.UpgradeHeirloom(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetFixtureDebugInfoForGUID) +function C_HouseExterior.GetFixtureDebugInfoForGUID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetHoveredFixtureDebugInfo) +function C_HouseExterior.GetHoveredFixtureDebugInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HouseExterior.GetSelectedFixtureDebugInfo) +function C_HouseExterior.GetSelectedFixtureDebugInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingCatalog.GetCatalogEntryDebugInfoForID) +function C_HousingCatalog.GetCatalogEntryDebugInfoForID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetDecorDebugInfoForGUID) +function C_HousingDecor.GetDecorDebugInfoForGUID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetHoveredDecorDebugInfo) +function C_HousingDecor.GetHoveredDecorDebugInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_HousingDecor.GetSelectedDecorDebugInfo) +function C_HousingDecor.GetSelectedDecorDebugInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.AcceptInvite) +function C_LFGList.AcceptInvite(resultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ApplyToGroup) +---@param resultID number +---@param tankOK? boolean +---@param healerOK? boolean +---@param damageOK? boolean +function C_LFGList.ApplyToGroup(resultID, tankOK, healerOK, damageOK) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.CancelApplication) +function C_LFGList.CancelApplication(resultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.ClearSearchResults) +function C_LFGList.ClearSearchResults() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.DeclineApplicant) +function C_LFGList.DeclineApplicant(applicantID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.DeclineInvite) +function C_LFGList.DeclineInvite(searchResultID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetActivityIDForQuestID) +function C_LFGList.GetActivityIDForQuestID(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetActivityInfoExpensive) +---@param activityID number +---@return boolean currentArea +function C_LFGList.GetActivityInfoExpensive(activityID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicantMemberInfo) +---@param applicantID number +---@param memberIndex number +---@return string name +---@return string class +---@return string localizedClass +---@return number level +---@return number itemLevel +---@return number honorLevel +---@return boolean tank +---@return boolean healer +---@return boolean damage +---@return string assignedRole +---@return boolean? relationship +---@return number dungeonScore +---@return number pvpItemLevel +---@return unknown factionGroup +---@return number raceID +---@return number specID +---@return boolean isLeaver +function C_LFGList.GetApplicantMemberInfo(applicantID, memberIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicantMemberStats) +---@param applicantID number +---@param memberIndex number +---@return table stats +function C_LFGList.GetApplicantMemberStats(applicantID, memberIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicants) +---@return table applicants +function C_LFGList.GetApplicants() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplicationInfo) +function C_LFGList.GetApplicationInfo(searchResultID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetApplications) +function C_LFGList.GetApplications() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetAvailableActivities) +---@param categoryID? number +---@param groupID? number +---@param filter? number +---@return table activities +function C_LFGList.GetAvailableActivities(categoryID, groupID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetAvailableCategories) +---@param filter? number +---@return table categories +function C_LFGList.GetAvailableCategories(filter) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetAvailableLanguageSearchFilter) +function C_LFGList.GetAvailableLanguageSearchFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetAvailableRoles) +function C_LFGList.GetAvailableRoles() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetDefaultLanguageSearchFilter) +function C_LFGList.GetDefaultLanguageSearchFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetLanguageSearchFilter) +function C_LFGList.GetLanguageSearchFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetNumApplicants) +function C_LFGList.GetNumApplicants() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetNumApplications) +function C_LFGList.GetNumApplications() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetNumInvitedApplicantMembers) +function C_LFGList.GetNumInvitedApplicantMembers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetNumPendingApplicantMembers) +function C_LFGList.GetNumPendingApplicantMembers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetRoleCheckInfo) +function C_LFGList.GetRoleCheckInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResultEncounterInfo) +function C_LFGList.GetSearchResultEncounterInfo(searchResultID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResultFriends) +---@param searchResultID number +---@return string[] bnetFriends +---@return string[] charFriends +---@return string[] guildMates +function C_LFGList.GetSearchResultFriends(searchResultID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.GetSearchResultMemberCounts) +function C_LFGList.GetSearchResultMemberCounts(searchResultID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.HasActivityList) +function C_LFGList.HasActivityList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.InviteApplicant) +---@param applicantID number +function C_LFGList.InviteApplicant(applicantID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.IsCurrentlyApplying) +function C_LFGList.IsCurrentlyApplying() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.RefreshApplicants) +function C_LFGList.RefreshApplicants() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.RemoveApplicant) +function C_LFGList.RemoveApplicant(applicantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.RemoveListing) +function C_LFGList.RemoveListing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.RequestAvailableActivities) +function C_LFGList.RequestAvailableActivities() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SaveLanguageSearchFilter) +function C_LFGList.SaveLanguageSearchFilter(enabled) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_LFGList.SetApplicantMemberRole) +function C_LFGList.SetApplicantMemberRole(applicantID, memberIndex, role) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.AcceptPVPDuel) +function C_PetBattles.AcceptPVPDuel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.AcceptQueuedPVPMatch) +function C_PetBattles.AcceptQueuedPVPMatch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.CanAcceptQueuedPVPMatch) +---@return boolean canAccept +function C_PetBattles.CanAcceptQueuedPVPMatch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.CanActivePetSwapOut) +---@return boolean usable +function C_PetBattles.CanActivePetSwapOut() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.CanPetSwapIn) +---@param petIndex number +---@return boolean usable +function C_PetBattles.CanPetSwapIn(petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.CancelPVPDuel) +function C_PetBattles.CancelPVPDuel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.ChangePet) +---@param petIndex number +function C_PetBattles.ChangePet(petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.DeclineQueuedPVPMatch) +function C_PetBattles.DeclineQueuedPVPMatch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.ForfeitGame) +function C_PetBattles.ForfeitGame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAbilityEffectInfo) +---@param abilityID number +---@param turnIndex number +---@param effectIndex number +---@param effectName string +---@return number value +function C_PetBattles.GetAbilityEffectInfo(abilityID, turnIndex, effectIndex, effectName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAbilityInfo) +---@param petOwner number +---@param petIndex number +---@param abilityIndex number +---@return number id +---@return string name +---@return string icon +---@return number maxCooldown +---@return string unparsedDescription +---@return number numTurns +---@return number petType +---@return boolean noStrongWeakHints +function C_PetBattles.GetAbilityInfo(petOwner, petIndex, abilityIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAbilityInfoByID) +---@param id number +---@return number id +---@return string name +---@return string icon +---@return number maxCooldown +---@return string unparsedDescription +---@return number numTurns +---@return number petType +---@return boolean noStrongWeakHints +function C_PetBattles.GetAbilityInfoByID(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAbilityProcTurnIndex) +---@param abilityID number +---@param procType number +---@return number turnIndex +function C_PetBattles.GetAbilityProcTurnIndex(abilityID, procType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAbilityState) +---@param petOwner number +---@param petIndex number +---@param actionIndex number +---@return boolean isUsable +---@return number currentCooldown +---@return number currentLockdown +function C_PetBattles.GetAbilityState(petOwner, petIndex, actionIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAbilityStateModification) +---@param abilityID number +---@param stateID number +---@return number abilityStateMod +function C_PetBattles.GetAbilityStateModification(abilityID, stateID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetActivePet) +---@param petOwner number +---@return number petIndex +function C_PetBattles.GetActivePet(petOwner) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAllEffectNames) +---@return string ... +function C_PetBattles.GetAllEffectNames() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAllStates) +---@param stateEnv? table +---@return table stateIDs +function C_PetBattles.GetAllStates(stateEnv) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAttackModifier) +---@param petType number +---@param enemyPetType number +---@return number modifier +function C_PetBattles.GetAttackModifier(petType, enemyPetType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetAuraInfo) +---@param petOwner number +---@param petIndex number +---@param auraIndex number +---@return number auraID +---@return number instanceID +---@return number turnsRemaining +---@return boolean isBuff +function C_PetBattles.GetAuraInfo(petOwner, petIndex, auraIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetBattleState) +---@return number battleState +function C_PetBattles.GetBattleState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetDisplayID) +---@param petOwner number +---@param petIndex number +---@return number displayID +function C_PetBattles.GetDisplayID(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetForfeitPenalty) +---@return number forfeitPenalty +function C_PetBattles.GetForfeitPenalty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetHealth) +---@param petOwner number +---@param petIndex number +---@return number health +function C_PetBattles.GetHealth(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetLevel) +---@param petOwner number +---@param petIndex number +---@return number level +function C_PetBattles.GetLevel(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetMaxHealth) +---@param petOwner number +---@param petIndex number +---@return number maxHealth +function C_PetBattles.GetMaxHealth(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetNumAuras) +---@param petOwner number +---@param petIndex number +---@return number numAuras +function C_PetBattles.GetNumAuras(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetNumPets) +---@param petOwner number +---@return number numPets +function C_PetBattles.GetNumPets(petOwner) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetPVPMatchmakingInfo) +---@return string queueState +---@return number estimatedTime +---@return number queuedTime +function C_PetBattles.GetPVPMatchmakingInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetPetSpeciesID) +---@param petOwner number +---@param petIndex number +---@return number speciesID +function C_PetBattles.GetPetSpeciesID(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetPetType) +---@param petOwner number +---@param petIndex number +---@return number petType +function C_PetBattles.GetPetType(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetPlayerTrapAbility) +---@return number trapAbilityID +function C_PetBattles.GetPlayerTrapAbility() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetPower) +---@param petOwner number +---@param petIndex number +---@return number power +function C_PetBattles.GetPower(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetSelectedAction) +---@return number selectedActionType +---@return number selectedActionIndex +function C_PetBattles.GetSelectedAction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetSpeed) +---@param petOwner number +---@param petIndex number +---@return number speed +function C_PetBattles.GetSpeed(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetStateValue) +---@param petOwner number +---@param petIndex number +---@param stateID number +---@return number stateValue +function C_PetBattles.GetStateValue(petOwner, petIndex, stateID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetTurnTimeInfo) +---@return number timeRemaining +---@return number turnTime +function C_PetBattles.GetTurnTimeInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.GetXP) +---@param petOwner number +---@param petIndex number +---@return number xp +---@return number maxXp +function C_PetBattles.GetXP(petOwner, petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.IsInBattle) +---@return boolean inBattle +function C_PetBattles.IsInBattle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.IsSkipAvailable) +---@return boolean usable +function C_PetBattles.IsSkipAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.IsTrapAvailable) +---@return boolean usable +function C_PetBattles.IsTrapAvailable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.IsWaitingOnOpponent) +---@return boolean isWaiting +function C_PetBattles.IsWaitingOnOpponent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.SetPendingReportBattlePetTarget) +---@param petIndex number +function C_PetBattles.SetPendingReportBattlePetTarget(petIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.SetPendingReportTargetFromUnit) +---@param unit UnitToken +function C_PetBattles.SetPendingReportTargetFromUnit(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.ShouldShowPetSelect) +---@return boolean shouldShow +function C_PetBattles.ShouldShowPetSelect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.SkipTurn) +function C_PetBattles.SkipTurn() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.StartPVPDuel) +function C_PetBattles.StartPVPDuel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.StartPVPMatchmaking) +function C_PetBattles.StartPVPMatchmaking() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.StopPVPMatchmaking) +function C_PetBattles.StopPVPMatchmaking() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.UseAbility) +---@param actionIndex number +function C_PetBattles.UseAbility(actionIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetBattles.UseTrap) +function C_PetBattles.UseTrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.CagePetByID) +---@param petID string +function C_PetJournal.CagePetByID(petID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.ClearFanfare) +function C_PetJournal.ClearFanfare() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.ClearRecentFanfares) +function C_PetJournal.ClearRecentFanfares() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.FindPetIDByName) +---@param petName string +---@return number speciesId +---@return string petGUID +function C_PetJournal.FindPetIDByName(petName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetBattlePetLink) +---@param petID string +---@return string link +function C_PetJournal.GetBattlePetLink(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumCollectedInfo) +---@param speciesId number +---@return number numCollected +---@return number limit +function C_PetJournal.GetNumCollectedInfo(speciesId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumPetSources) +---@return number numSources +function C_PetJournal.GetNumPetSources() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumPetTypes) +---@return number numTypes +function C_PetJournal.GetNumPetTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumPets) +---@return number numPets +---@return number numOwned +function C_PetJournal.GetNumPets() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetNumPetsNeedingFanfare) +function C_PetJournal.GetNumPetsNeedingFanfare() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetOwnedBattlePetString) +---@param speciesId number +---@return string ownedString +function C_PetJournal.GetOwnedBattlePetString(speciesId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetAbilityList) +---@param speciesID number +---@param idTable? table +---@param levelTable? table +---@return number[] idTable +---@return number[] levelTable +function C_PetJournal.GetPetAbilityList(speciesID, idTable, levelTable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetCooldownByGUID) +---@param GUID string +---@return number start +---@return number duration +---@return number isEnabled +function C_PetJournal.GetPetCooldownByGUID(GUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetInfoByIndex) +---@param index number +---@return string petID +---@return number speciesID +---@return boolean owned +---@return string customName +---@return number level +---@return boolean favorite +---@return boolean isRevoked +---@return string speciesName +---@return fileID icon +---@return number petType +---@return number companionID +---@return string tooltip +---@return string description +---@return boolean isWild +---@return boolean canBattle +---@return boolean isTradeable +---@return boolean isUnique +---@return boolean obtainable +function C_PetJournal.GetPetInfoByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetInfoByItemID) +---@param itemID number +---@return string name +---@return fileID icon +---@return number petType +---@return number creatureID +---@return string sourceText +---@return string description +---@return boolean isWild +---@return boolean canBattle +---@return boolean isTradeable +---@return boolean isUnique +---@return boolean obtainable +---@return number displayID +---@return number speciesID +function C_PetJournal.GetPetInfoByItemID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetInfoByPetID) +---@param petID string +---@return number speciesID +---@return string customName +---@return number level +---@return number xp +---@return number maxXp +---@return number displayID +---@return boolean favorite +---@return string name +---@return fileID icon +---@return number petType +---@return string creatureID +---@return string sourceText +---@return string description +---@return boolean isWild +---@return boolean canBattle +---@return boolean isTradeable +---@return boolean isUnique +---@return boolean obtainable +function C_PetJournal.GetPetInfoByPetID(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetInfoBySpeciesID) +---@param speciesID number +---@return string speciesName +---@return fileID speciesIcon +---@return number petType +---@return number companionID +---@return string tooltipSource +---@return string tooltipDescription +---@return boolean isWild +---@return boolean canBattle +---@return boolean isTradeable +---@return boolean isUnique +---@return boolean obtainable +---@return number creatureDisplayID +---@return number desiredScale +function C_PetJournal.GetPetInfoBySpeciesID(speciesID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetModelSceneInfoBySpeciesID) +function C_PetJournal.GetPetModelSceneInfoBySpeciesID(speciesID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetSortParameter) +---@return number sortParameter +function C_PetJournal.GetPetSortParameter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetStats) +---@param petID string +---@return number health +---@return number maxHealth +---@return number power +---@return number speed +---@return number rarity +function C_PetJournal.GetPetStats(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetPetTeamAverageLevel) +---@return number avgLevel +function C_PetJournal.GetPetTeamAverageLevel() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetSummonBattlePetCooldown) +function C_PetJournal.GetSummonBattlePetCooldown() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetSummonRandomFavoritePetGUID) +function C_PetJournal.GetSummonRandomFavoritePetGUID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.GetSummonedPetGUID) +---@return string summonedPetGUID +function C_PetJournal.GetSummonedPetGUID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsFilterChecked) +---@param filter number +---@return boolean isFiltered +function C_PetJournal.IsFilterChecked(filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsFindBattleEnabled) +---@return boolean isEnabled +function C_PetJournal.IsFindBattleEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsJournalReadOnly) +function C_PetJournal.IsJournalReadOnly() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsJournalUnlocked) +function C_PetJournal.IsJournalUnlocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsPetSourceChecked) +---@param index number +---@return boolean isChecked +function C_PetJournal.IsPetSourceChecked(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.IsPetTypeChecked) +---@param index number +---@return boolean isChecked +function C_PetJournal.IsPetTypeChecked(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetCanBeReleased) +---@param petID string +---@return boolean canRelease +function C_PetJournal.PetCanBeReleased(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsCapturable) +---@param petID string +---@return boolean isCapturable +function C_PetJournal.PetIsCapturable(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsFavorite) +---@param petGUID string +---@return boolean isFavorite +function C_PetJournal.PetIsFavorite(petGUID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsHurt) +---@param petID string +---@return boolean isHurt +function C_PetJournal.PetIsHurt(petID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsLockedForConvert) +function C_PetJournal.PetIsLockedForConvert(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsRevoked) +---@param petID string +---@return boolean isRevoked +function C_PetJournal.PetIsRevoked(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsSlotted) +---@param petID string +---@return boolean isSlotted +function C_PetJournal.PetIsSlotted(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsTradable) +---@param petID string +---@return boolean isTradable +function C_PetJournal.PetIsTradable(petID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetIsUsable) +function C_PetJournal.PetIsUsable(petID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PetNeedsFanfare) +function C_PetJournal.PetNeedsFanfare() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PickupPet) +---@param petID string +function C_PetJournal.PickupPet(petID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.PickupSummonRandomPet) +function C_PetJournal.PickupSummonRandomPet() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.ReleasePetByID) +---@param petID string +function C_PetJournal.ReleasePetByID(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetAbility) +---@param slotIndex number +---@param spellIndex number +---@param petSpellID number +function C_PetJournal.SetAbility(slotIndex, spellIndex, petSpellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetAllPetSourcesChecked) +---@param value boolean +function C_PetJournal.SetAllPetSourcesChecked(value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetAllPetTypesChecked) +---@param value boolean +function C_PetJournal.SetAllPetTypesChecked(value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetCustomName) +---@param petID string +---@param customName string +function C_PetJournal.SetCustomName(petID, customName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetFavorite) +---@param petID string +---@param value number +function C_PetJournal.SetFavorite(petID, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetFilterChecked) +---@param filter number +---@param value boolean +function C_PetJournal.SetFilterChecked(filter, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetPetLoadOutInfo) +---@param slotIndex number +---@param petID string +function C_PetJournal.SetPetLoadOutInfo(slotIndex, petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetPetSortParameter) +---@param sortParameter number +function C_PetJournal.SetPetSortParameter(sortParameter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetPetSourceChecked) +---@param index number +---@param value boolean +function C_PetJournal.SetPetSourceChecked(index, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SetPetTypeFilter) +---@param index number +---@param value boolean +function C_PetJournal.SetPetTypeFilter(index, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SummonPetByGUID) +---@param petID string +function C_PetJournal.SummonPetByGUID(petID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PetJournal.SummonRandomPet) +---@param favoritePets boolean +function C_PetJournal.SummonRandomPet(favoritePets) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PrototypeDialog.EnsureRemoved) +---@param instanceID number +function C_PrototypeDialog.EnsureRemoved(instanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_PrototypeDialog.SelectOption) +---@param instanceID number +---@param optionIndex number +function C_PrototypeDialog.SelectOption(instanceID, optionIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reincarnation.GetReincarnatingCharacter) +function C_Reincarnation.GetReincarnatingCharacter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reincarnation.IsReincarnating) +function C_Reincarnation.IsReincarnating() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reincarnation.StartReincarnation) +function C_Reincarnation.StartReincarnation() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Reincarnation.StopReincarnation) +function C_Reincarnation.StopReincarnation() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetBonusStepRewardQuestID) +function C_Scenario.GetBonusStepRewardQuestID(stepIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetBonusSteps) +function C_Scenario.GetBonusSteps() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetInfo) +function C_Scenario.GetInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetProvingGroundsInfo) +---@return number difficulty +---@return number curWave +---@return number maxWave +---@return number duration +function C_Scenario.GetProvingGroundsInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetScenarioIconInfo) +function C_Scenario.GetScenarioIconInfo(uiMapID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetStepInfo) +function C_Scenario.GetStepInfo(bonusStepIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.GetSupersededObjectives) +function C_Scenario.GetSupersededObjectives() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.IsInScenario) +function C_Scenario.IsInScenario() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.ShouldShowCriteria) +function C_Scenario.ShouldShowCriteria() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Scenario.TreatScenarioAsDungeon) +function C_Scenario.TreatScenarioAsDungeon() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.GetLastSeenCharacterUpgradePopup) +function C_SharedCharacterServices.GetLastSeenCharacterUpgradePopup() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.GetLastSeenExpansionTrialPopup) +function C_SharedCharacterServices.GetLastSeenExpansionTrialPopup() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.GetUpgradeDistributions) +function C_SharedCharacterServices.GetUpgradeDistributions() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.HasFreePromotionalUpgrade) +function C_SharedCharacterServices.HasFreePromotionalUpgrade() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.HasSeenFreePromotionalUpgradePopup) +function C_SharedCharacterServices.HasSeenFreePromotionalUpgradePopup() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.IsPurchaseIDPendingUpgrade) +function C_SharedCharacterServices.IsPurchaseIDPendingUpgrade() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.QueryClassTrialBoostResult) +function C_SharedCharacterServices.QueryClassTrialBoostResult() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.SetCharacterUpgradePopupSeen) +function C_SharedCharacterServices.SetCharacterUpgradePopupSeen(expansion_id) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.SetExpansionTrialPopupSeen) +function C_SharedCharacterServices.SetExpansionTrialPopupSeen(expansion_id) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SharedCharacterServices.SetPromotionalPopupSeen) +function C_SharedCharacterServices.SetPromotionalPopupSeen(seen) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpectatingUI.GetSpectateTargetInfo) +function C_SpectatingUI.GetSpectateTargetInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpectatingUI.GetSpectatingPlayerSpellItemQuality) +function C_SpectatingUI.GetSpectatingPlayerSpellItemQuality() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpectatingUI.IsSpectating) +function C_SpectatingUI.IsSpectating() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpectatingUI.LeaveSpectateMode) +function C_SpectatingUI.LeaveSpectateMode() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpectatingUI.SpectateChange) +function C_SpectatingUI.SpectateChange() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_SpectatingUI.StartSpectating) +function C_SpectatingUI.StartSpectating() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_StringUtil.GetDefaultAbbreviationBreakpoints) +function C_StringUtil.GetDefaultAbbreviationBreakpoints() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TalkingHead.GetConversationsDeferred) +function C_TalkingHead.GetConversationsDeferred() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TalkingHead.GetCurrentLineAnimationInfo) +function C_TalkingHead.GetCurrentLineAnimationInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TalkingHead.GetCurrentLineInfo) +function C_TalkingHead.GetCurrentLineInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TalkingHead.IgnoreCurrentTalkingHead) +function C_TalkingHead.IgnoreCurrentTalkingHead() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TalkingHead.IsCurrentTalkingHeadIgnored) +function C_TalkingHead.IsCurrentTalkingHeadIgnored() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TalkingHead.SetConversationsDeferred) +function C_TalkingHead.SetConversationsDeferred(deferred) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.ForceToyRefilter) +function C_ToyBox.ForceToyRefilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetCollectedShown) +function C_ToyBox.GetCollectedShown() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetIsFavorite) +function C_ToyBox.GetIsFavorite(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetNumFilteredToys) +function C_ToyBox.GetNumFilteredToys() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetNumLearnedDisplayedToys) +function C_ToyBox.GetNumLearnedDisplayedToys() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetNumTotalDisplayedToys) +function C_ToyBox.GetNumTotalDisplayedToys() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetNumToys) +---@return number numToys +function C_ToyBox.GetNumToys() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetToyFromIndex) +---@param index number +---@return number itemID +function C_ToyBox.GetToyFromIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetToyInfo) +---@param itemID number +---@return number itemID +---@return string toyName +---@return number icon +---@return boolean isFavorite +---@return boolean hasFanfare +---@return Enum.ItemQuality itemQuality +function C_ToyBox.GetToyInfo(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetToyLink) +---@param itemID number +---@return string? itemLink +function C_ToyBox.GetToyLink(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetUncollectedShown) +function C_ToyBox.GetUncollectedShown() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.GetUnusableShown) +function C_ToyBox.GetUnusableShown() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.HasFavorites) +function C_ToyBox.HasFavorites() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.IsExpansionTypeFilterChecked) +function C_ToyBox.IsExpansionTypeFilterChecked(expansionIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.IsSourceTypeFilterChecked) +function C_ToyBox.IsSourceTypeFilterChecked(sourceIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.IsToyUsable) +function C_ToyBox.IsToyUsable(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.PickupToyBoxItem) +function C_ToyBox.PickupToyBoxItem(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetAllExpansionTypeFilters) +function C_ToyBox.SetAllExpansionTypeFilters(checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetAllSourceTypeFilters) +function C_ToyBox.SetAllSourceTypeFilters(checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetCollectedShown) +function C_ToyBox.SetCollectedShown(checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetExpansionTypeFilter) +function C_ToyBox.SetExpansionTypeFilter(expansionIndex, checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetFilterString) +function C_ToyBox.SetFilterString(searchString) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetIsFavorite) +function C_ToyBox.SetIsFavorite(itemID, value) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetSourceTypeFilter) +function C_ToyBox.SetSourceTypeFilter(sourceIndex, checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetUncollectedShown) +function C_ToyBox.SetUncollectedShown(checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_ToyBox.SetUnusableShown) +function C_ToyBox.SetUnusableShown(checked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.AnyRecipeCategoriesFiltered) +function C_TradeSkillUI.AnyRecipeCategoriesFiltered() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.AreAnyInventorySlotsFiltered) +function C_TradeSkillUI.AreAnyInventorySlotsFiltered() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CanObliterateCursorItem) +function C_TradeSkillUI.CanObliterateCursorItem() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CanTradeSkillListLink) +function C_TradeSkillUI.CanTradeSkillListLink() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.ClearInventorySlotFilter) +function C_TradeSkillUI.ClearInventorySlotFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.ClearPendingObliterateItem) +function C_TradeSkillUI.ClearPendingObliterateItem() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.ClearRecipeCategoryFilter) +function C_TradeSkillUI.ClearRecipeCategoryFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.ClearRecipeSourceTypeFilter) +function C_TradeSkillUI.ClearRecipeSourceTypeFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.CloseObliterumForge) +function C_TradeSkillUI.CloseObliterumForge() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.DropPendingObliterateItemFromCursor) +function C_TradeSkillUI.DropPendingObliterateItemFromCursor() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetAllFilterableInventorySlots) +function C_TradeSkillUI.GetAllFilterableInventorySlots() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetAllFilterableInventorySlotsCount) +function C_TradeSkillUI.GetAllFilterableInventorySlotsCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetAllRecipeIDs) +---@return number[] recipeIDs +function C_TradeSkillUI.GetAllRecipeIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCategories) +---@return number[] categoryIDs +function C_TradeSkillUI.GetCategories() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetCategoryInfo) +---@param categoryID number +---@param returnTable? table +---@return TradeSkillCategoryInfo categoryInfo +function C_TradeSkillUI.GetCategoryInfo(categoryID, returnTable) end + +---@class TradeSkillCategoryInfo +---@field name string +---@field enabled boolean +---@field categoryID number +---@field parentCategoryID number +---@field type string +---@field hasProgressBar boolean +---@field numIndents number +---@field skillLineStartingRank number +---@field skillLineMaxLevel number +---@field skillLineCurrentLevel number + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetFilterableInventorySlotName) +function C_TradeSkillUI.GetFilterableInventorySlotName() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetFilterableInventorySlots) +function C_TradeSkillUI.GetFilterableInventorySlots() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetFilteredRecipeIDs) +function C_TradeSkillUI.GetFilteredRecipeIDs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetObliterateSpellID) +function C_TradeSkillUI.GetObliterateSpellID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetOnlyShowFirstCraftRecipes) +function C_TradeSkillUI.GetOnlyShowFirstCraftRecipes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetOnlyShowMakeableRecipes) +function C_TradeSkillUI.GetOnlyShowMakeableRecipes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetOnlyShowSkillUpRecipes) +function C_TradeSkillUI.GetOnlyShowSkillUpRecipes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetPendingObliterateItemID) +function C_TradeSkillUI.GetPendingObliterateItemID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetPendingObliterateItemLink) +function C_TradeSkillUI.GetPendingObliterateItemLink() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeCooldown) +function C_TradeSkillUI.GetRecipeCooldown(recipeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeItemLevelFilter) +function C_TradeSkillUI.GetRecipeItemLevelFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeItemLink) +---@param recipeId number +---@return string itemLink +function C_TradeSkillUI.GetRecipeItemLink(recipeId) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeItemNameFilter) +function C_TradeSkillUI.GetRecipeItemNameFilter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeLink) +function C_TradeSkillUI.GetRecipeLink(recipeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetRecipeSourceText) +function C_TradeSkillUI.GetRecipeSourceText(recipeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetSubCategories) +function C_TradeSkillUI.GetSubCategories(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetTradeSkillLineForRecipe) +---@param recipeID number +---@return number tradeSkillID +---@return string skillLineName +---@return number parentTradeSkillID +function C_TradeSkillUI.GetTradeSkillLineForRecipe(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetTradeSkillListLink) +---@return string? link +function C_TradeSkillUI.GetTradeSkillListLink() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.GetTradeSkillTexture) +function C_TradeSkillUI.GetTradeSkillTexture(tradeSkillID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsAnyRecipeFromSource) +function C_TradeSkillUI.IsAnyRecipeFromSource(sourceType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsDataSourceChanging) +function C_TradeSkillUI.IsDataSourceChanging() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsInventorySlotFiltered) +function C_TradeSkillUI.IsInventorySlotFiltered(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeCategoryFiltered) +function C_TradeSkillUI.IsRecipeCategoryFiltered(categoryID, subCategoryID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeFavorite) +function C_TradeSkillUI.IsRecipeFavorite(recipeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeRepeating) +function C_TradeSkillUI.IsRecipeRepeating() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeSearchInProgress) +function C_TradeSkillUI.IsRecipeSearchInProgress() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsRecipeSourceTypeFiltered) +function C_TradeSkillUI.IsRecipeSourceTypeFiltered(sourceType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsTradeSkillGuild) +---@return boolean isGuild +function C_TradeSkillUI.IsTradeSkillGuild() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsTradeSkillGuildMember) +function C_TradeSkillUI.IsTradeSkillGuildMember() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsTradeSkillLinked) +---@return boolean isLinked +function C_TradeSkillUI.IsTradeSkillLinked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.IsTradeSkillReady) +---@return boolean isReady +function C_TradeSkillUI.IsTradeSkillReady() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.ObliterateItem) +function C_TradeSkillUI.ObliterateItem() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetInventorySlotFilter) +function C_TradeSkillUI.SetInventorySlotFilter(index, enable, exclusive) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetOnlyShowFirstCraftRecipes) +function C_TradeSkillUI.SetOnlyShowFirstCraftRecipes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetOnlyShowMakeableRecipes) +function C_TradeSkillUI.SetOnlyShowMakeableRecipes(onlyMakable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetOnlyShowSkillUpRecipes) +---@param flag boolean +function C_TradeSkillUI.SetOnlyShowSkillUpRecipes(flag) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetRecipeCategoryFilter) +function C_TradeSkillUI.SetRecipeCategoryFilter(categoryID, subCategoryID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetRecipeFavorite) +function C_TradeSkillUI.SetRecipeFavorite(recipeID, favorite) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetRecipeItemLevelFilter) +function C_TradeSkillUI.SetRecipeItemLevelFilter(minLevel, maxLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetRecipeItemNameFilter) +---@param text? string +function C_TradeSkillUI.SetRecipeItemNameFilter(text) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.SetRecipeSourceTypeFilter) +function C_TradeSkillUI.SetRecipeSourceTypeFilter(sourceType, filtered) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_TradeSkillUI.StopRecipeRepeat) +function C_TradeSkillUI.StopRecipeRepeat() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentChangeAppearanceToTrophyID) +function C_Trophy.MonumentChangeAppearanceToTrophyID(trophyID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentCloseMonumentUI) +function C_Trophy.MonumentCloseMonumentUI() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentGetCount) +function C_Trophy.MonumentGetCount() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentGetSelectedTrophyID) +function C_Trophy.MonumentGetSelectedTrophyID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentGetTrophyInfoByIndex) +function C_Trophy.MonumentGetTrophyInfoByIndex(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentLoadList) +function C_Trophy.MonumentLoadList() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentLoadSelectedTrophyID) +function C_Trophy.MonumentLoadSelectedTrophyID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentRevertAppearanceToSaved) +function C_Trophy.MonumentRevertAppearanceToSaved() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Trophy.MonumentSaveSelection) +function C_Trophy.MonumentSaveSelection(trophyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Widget.IsFrameWidget) +---@param object? Object +---@return boolean isFrameWidget +function C_Widget.IsFrameWidget(object) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Widget.IsRenderableWidget) +function C_Widget.IsRenderableWidget(object) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_Widget.IsWidget) +---@param object? Object +---@return boolean isWidget +function C_Widget.IsWidget(object) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.AcceptPartyInvite) +function C_WoWLabsMatchmaking.AcceptPartyInvite() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.CanEnterMatchmaking) +function C_WoWLabsMatchmaking.CanEnterMatchmaking() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.ClearFastLogin) +function C_WoWLabsMatchmaking.ClearFastLogin() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.DeclinePartyInvite) +function C_WoWLabsMatchmaking.DeclinePartyInvite() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetAutoQueueOnLogout) +function C_WoWLabsMatchmaking.GetAutoQueueOnLogout() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetCurrentParty) +function C_WoWLabsMatchmaking.GetCurrentParty() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetInQueueTimeStart) +function C_WoWLabsMatchmaking.GetInQueueTimeStart() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetNumPartyInvites) +function C_WoWLabsMatchmaking.GetNumPartyInvites() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetPartyInviteByIndex) +function C_WoWLabsMatchmaking.GetPartyInviteByIndex() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetPartyPlaylistEntry) +function C_WoWLabsMatchmaking.GetPartyPlaylistEntry() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.GetPartySize) +function C_WoWLabsMatchmaking.GetPartySize() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsAloneInWoWLabsParty) +function C_WoWLabsMatchmaking.IsAloneInWoWLabsParty() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsFastLogin) +function C_WoWLabsMatchmaking.IsFastLogin() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsFindingMatch) +function C_WoWLabsMatchmaking.IsFindingMatch() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsPartyFull) +function C_WoWLabsMatchmaking.IsPartyFull() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsPartyLeader) +function C_WoWLabsMatchmaking.IsPartyLeader() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsPlayer) +function C_WoWLabsMatchmaking.IsPlayer() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsPlayerReady) +function C_WoWLabsMatchmaking.IsPlayerReady() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.IsWowLabsMatchmakingMember) +function C_WoWLabsMatchmaking.IsWowLabsMatchmakingMember() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.LeaveParty) +function C_WoWLabsMatchmaking.LeaveParty() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.RemovePlayerFromParty) +function C_WoWLabsMatchmaking.RemovePlayerFromParty() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.SendPartyInvite) +function C_WoWLabsMatchmaking.SendPartyInvite() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.SetAutoQueueOnLogout) +function C_WoWLabsMatchmaking.SetAutoQueueOnLogout() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.SetPartyPlaylistEntry) +function C_WoWLabsMatchmaking.SetPartyPlaylistEntry() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WoWLabsMatchmaking.SetPlayerReady) +function C_WoWLabsMatchmaking.SetPlayerReady() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.GetConfirmedWoWLabsArea) +function C_WowLabsDataManager.GetConfirmedWoWLabsArea() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.GetWoWLabsAreaInfo) +function C_WowLabsDataManager.GetWoWLabsAreaInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.IsInPrematch) +function C_WowLabsDataManager.IsInPrematch() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.PushCircleInfoToLua) +function C_WowLabsDataManager.PushCircleInfoToLua() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.QuerySelectedWoWLabsArea) +function C_WowLabsDataManager.QuerySelectedWoWLabsArea() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.QueryWoWLabsAreaInfo) +function C_WowLabsDataManager.QueryWoWLabsAreaInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowLabsDataManager.SelectWoWLabsArea) +function C_WowLabsDataManager.SelectWoWLabsArea() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.BuyToken) +function C_WowTokenPublic.BuyToken() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.GetCommerceSystemStatus) +function C_WowTokenPublic.GetCommerceSystemStatus() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.GetCurrentMarketPrice) +function C_WowTokenPublic.GetCurrentMarketPrice() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.GetGuaranteedPrice) +function C_WowTokenPublic.GetGuaranteedPrice() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.GetListedAuctionableTokenInfo) +function C_WowTokenPublic.GetListedAuctionableTokenInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.GetNumListedAuctionableTokens) +function C_WowTokenPublic.GetNumListedAuctionableTokens() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.IsAuctionableWowToken) +function C_WowTokenPublic.IsAuctionableWowToken(itemID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.IsConsumableWowToken) +function C_WowTokenPublic.IsConsumableWowToken() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.UpdateListedAuctionableTokens) +function C_WowTokenPublic.UpdateListedAuctionableTokens() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.UpdateMarketPrice) +function C_WowTokenPublic.UpdateMarketPrice() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_WowTokenPublic.UpdateTokenCount) +function C_WowTokenPublic.UpdateTokenCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CallCompanion) +---@param type string +---@param id number +function CallCompanion(type, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CameraOrSelectOrMoveStart) +function CameraOrSelectOrMoveStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CameraOrSelectOrMoveStop) +---@param stickyFlag? boolean +function CameraOrSelectOrMoveStop(stickyFlag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CameraZoomIn) +---@param increment number +function CameraZoomIn(increment) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CameraZoomOut) +---@param increment number +function CameraZoomOut(increment) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanAffordMerchantItem) +function CanAffordMerchantItem(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanAutoSetGamePadCursorControl) +function CanAutoSetGamePadCursorControl() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanCancelScene) +---@return boolean cancel +function CanCancelScene() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanComplainInboxItem) +---@param mailID number +---@return boolean? canComplain +function CanComplainInboxItem(mailID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEditGuildBankTabInfo) +function CanEditGuildBankTabInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEditGuildEvent) +function CanEditGuildEvent() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEditGuildInfo) +function CanEditGuildInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEditGuildTabInfo) +function CanEditGuildTabInfo(tab) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEditMOTD) +---@return boolean canEdit +function CanEditMOTD() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanEditPublicNote) +function CanEditPublicNote() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanExitVehicle) +function CanExitVehicle() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanGamePadControlCursor) +function CanGamePadControlCursor() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanGuildBankRepair) +function CanGuildBankRepair() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanGuildDemote) +---@return boolean canDemote +function CanGuildDemote() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanGuildInvite) +---@return boolean canInvite +function CanGuildInvite() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanGuildPromote) +---@return boolean canPromote +function CanGuildPromote() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanGuildRemove) +function CanGuildRemove() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanHearthAndResurrectFromArea) +function CanHearthAndResurrectFromArea() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanInitiateWarGame) +function CanInitiateWarGame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanItemBeSocketedToArtifact) +---@param itemID number +---@return boolean canSocket +function CanItemBeSocketedToArtifact(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanJoinBattlefieldAsGroup) +---@return boolean isTrue +function CanJoinBattlefieldAsGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanMerchantRepair) +---@return boolean canRepair +function CanMerchantRepair() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanPartyLFGBackfill) +function CanPartyLFGBackfill() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanReplaceGuildMaster) +---@return boolean canReplace +function CanReplaceGuildMaster() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanResetTutorials) +function CanResetTutorials() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanScanResearchSite) +---@return boolean onSite +function CanScanResearchSite() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanShowAchievementUI) +---@return boolean canShow +function CanShowAchievementUI() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanSignPetition) +function CanSignPetition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanSolveArtifact) +---@return boolean canSolve +function CanSolveArtifact() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanSurrenderArena) +function CanSurrenderArena() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanSwitchVehicleSeats) +---@return boolean canSwitchSeats +function CanSwitchVehicleSeats() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanViewGuildRecipes) +---@param skillID number +---@return boolean canView +function CanViewGuildRecipes(skillID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CanWithdrawGuildBankMoney) +function CanWithdrawGuildBankMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelDuel) +function CancelDuel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelItemTempEnchantment) +---@param weaponHand number +function CancelItemTempEnchantment(weaponHand) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelMasterLootRoll) +function CancelMasterLootRoll(slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelPetPossess) +function CancelPetPossess() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelScene) +function CancelScene() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelShapeshiftForm) +function CancelShapeshiftForm() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelSpellByName) +function CancelSpellByName(name) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelTradeAccept) +function CancelTradeAccept() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CancelUnitBuff) +---@param unit UnitToken +---@param buffIndex number +---@param filter? string +function CancelUnitBuff(unit, buffIndex, filter) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CannotBeResurrected) +function CannotBeResurrected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CastPetAction) +---@param index number +---@param target? UnitToken +function CastPetAction(index, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CastShapeshiftForm) +---@param index number +function CastShapeshiftForm(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CastSpell) +---@param spellIndex number +---@param spellbookType string +function CastSpell(spellIndex, spellbookType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CastSpellByID) +function CastSpellByID(spellID, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CastSpellByName) +---@param name string +---@param target? UnitToken +function CastSpellByName(name, target) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CenterCamera) +function CenterCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChangeChatColor) +---@param channelName string +---@param red number +---@param green number +---@param blue number +function ChangeChatColor(channelName, red, green, blue) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelBan) +---@param channelName string +---@param playerName string +function ChannelBan(channelName, playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelInvite) +---@param channelName string +---@param playerName string +function ChannelInvite(channelName, playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelKick) +---@param channelName string +---@param playerName string +function ChannelKick(channelName, playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelModerator) +---@param channelName string +---@param playerName string +function ChannelModerator(channelName, playerName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelSetAllSilent) +function ChannelSetAllSilent() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelSetPartyMemberSilent) +function ChannelSetPartyMemberSilent(partyMemberName, silenceOn) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelToggleAnnouncements) +---@param channelName string +---@param playerName string +function ChannelToggleAnnouncements(channelName, playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelUnban) +---@param channelName string +---@param playerName string +function ChannelUnban(channelName, playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ChannelUnmoderator) +---@param channelName string +---@param playerName string +function ChannelUnmoderator(channelName, playerName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckInbox) +function CheckInbox() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearAchievementComparisonUnit) +function ClearAchievementComparisonUnit() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearAchievementSearchString) +function ClearAchievementSearchString() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearAllLFGDungeons) +function ClearAllLFGDungeons(category) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearAutoAcceptQuestSound) +function ClearAutoAcceptQuestSound() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearBattlemaster) +function ClearBattlemaster() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearFailedPVPTalentIDs) +function ClearFailedPVPTalentIDs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearFailedTalentIDs) +function ClearFailedTalentIDs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearInspectPlayer) +function ClearInspectPlayer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearOverrideBindings) +---@param owner Frame +function ClearOverrideBindings(owner) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearPartyAssignment) +function ClearPartyAssignment() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearSendMail) +function ClearSendMail() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClearTutorials) +function ClearTutorials() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClickSendMailItemButton) +---@param itemIndex? number +---@param clearItem? boolean +function ClickSendMailItemButton(itemIndex, clearItem) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClickTargetTradeButton) +function ClickTargetTradeButton(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClickTradeButton) +function ClickTradeButton(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClickWorldMapActionButton) +function ClickWorldMapActionButton() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseGuildBankFrame) +function CloseGuildBankFrame() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseGuildRegistrar) +function CloseGuildRegistrar() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseGuildRoster) +function CloseGuildRoster() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseItemText) +function CloseItemText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseLoot) +---@param showUnopenableError? boolean +function CloseLoot(showUnopenableError) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseMail) +function CloseMail() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseMerchant) +function CloseMerchant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ClosePetition) +function ClosePetition() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseQuest) +function CloseQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseResearch) +function CloseResearch() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseTabardCreation) +function CloseTabardCreation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseTaxiMap) +function CloseTaxiMap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseTrade) +function CloseTrade() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CloseTrainer) +function CloseTrainer() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CollapseGuildTradeSkillHeader) +function CollapseGuildTradeSkillHeader(tradeSkillID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CollapseQuestHeader) +---@param index number +---@param isAuto boolean +function CollapseQuestHeader(index, isAuto) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CollapseWarGameHeader) +function CollapseWarGameHeader(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CompleteLFGReadyCheck) +function CompleteLFGReadyCheck(isReady) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CompleteLFGRoleCheck) +function CompleteLFGRoleCheck(isReady) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CompleteQuest) +function CompleteQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConfirmAcceptQuest) +function ConfirmAcceptQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConfirmBNRequestInviteFriend) +---@param presenceID number +---@param tank? boolean +---@param healer? boolean +---@param dps? boolean +function ConfirmBNRequestInviteFriend(presenceID, tank, healer, dps) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConfirmLootRoll) +---@param rollID number +---@param roll number +function ConfirmLootRoll(rollID, roll) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConfirmLootSlot) +---@param slot number +function ConfirmLootSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ConfirmReadyCheck) +---@param isReady? number +function ConfirmReadyCheck(isReady) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateFont) +---@param name string +---@return Font fontObject +function CreateFont(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateFrame) +---@generic T, Tp +---@param frameType `T` | FrameType +---@param name? string +---@param parent? any +---@param template? `Tp` | Template +---@param id? number +---@return table|T|Tp frame +function CreateFrame(frameType, name, parent, template, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateMacro) +---@param name string +---@param iconFileID number|string +---@param body? string +---@param perCharacter? boolean +---@return number macroId +function CreateMacro(name, iconFileID, body, perCharacter) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_CreateNewRaidProfile) +function CreateNewRaidProfile(name, baseOnProfile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineChannelInvite) +---@param channel string +function DeclineChannelInvite(channel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineGroup) +function DeclineGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineQuest) +function DeclineQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeclineSpellConfirmationPrompt) +---@param spellID number +function DeclineSpellConfirmationPrompt(spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeleteGMTicket) +function DeleteGMTicket() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeleteInboxItem) +---@param index number +function DeleteInboxItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeleteMacro) +---@param indexOrName number|string +function DeleteMacro(indexOrName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DeleteRaidProfile) +function DeleteRaidProfile(profile) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DemoteAssistant) +function DemoteAssistant(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DepositGuildBankMoney) +function DepositGuildBankMoney(money) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DescendStop) +function DescendStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DetectWowMouse) +function DetectWowMouse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DismissCompanion) +---@param type string +function DismissCompanion(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DisplayChannelOwner) +---@param channelName string +function DisplayChannelOwner(channelName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DoMasterLootRoll) +function DoMasterLootRoll(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DoReadyCheck) +function DoReadyCheck() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DoesTemplateExist) +function DoesTemplateExist(template) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_DungeonAppearsInRandomLFD) +function DungeonAppearsInRandomLFD(dungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_ClearSearch) +function EJ_ClearSearch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_EndSearch) +function EJ_EndSearch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetContentTuningID) +---@return number tuningID +function EJ_GetContentTuningID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetCreatureInfo) +---@param index number +---@param encounterID? number +---@return number id +---@return string name +---@return string description +---@return number displayInfo +---@return number iconImage +---@return number uiModelSceneID +function EJ_GetCreatureInfo(index, encounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetCurrentTier) +---@return number index +function EJ_GetCurrentTier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetDifficulty) +---@return number difficultyId +function EJ_GetDifficulty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetEncounterInfo) +---@param journalEncounterID number +---@return string name +---@return string description +---@return number journalEncounterID +---@return number rootSectionID +---@return string link +---@return number journalInstanceID +---@return number dungeonEncounterID +---@return number instanceID +function EJ_GetEncounterInfo(journalEncounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetEncounterInfoByIndex) +---@param index number +---@param journalInstanceID? number +---@return string name +---@return string description +---@return number journalEncounterID +---@return number rootSectionID +---@return string link +---@return number journalInstanceID +---@return number dungeonEncounterID +---@return number instanceID +function EJ_GetEncounterInfoByIndex(index, journalInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetInstanceByIndex) +---@param index number +---@param isRaid boolean +---@return number instanceID +---@return string name +---@return string description +---@return number bgImage +---@return number buttonImage1 +---@return number loreImage +---@return number buttonImage2 +---@return number dungeonAreaMapID +---@return string link +---@return boolean shouldDisplayDifficulty +---@return number mapID +---@return number covenantID +---@return boolean isRaid +function EJ_GetInstanceByIndex(index, isRaid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetInstanceForMap) +---@param mapID number +---@return number instanceID +function EJ_GetInstanceForMap(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetInstanceInfo) +---@param journalInstanceID? number +---@return string name +---@return string description +---@return number bgImage +---@return number buttonImage1 +---@return number loreImage +---@return number buttonImage2 +---@return number dungeonAreaMapID +---@return string link +---@return boolean shouldDisplayDifficulty +---@return number mapID +---@return number covenantID +---@return boolean isRaid +function EJ_GetInstanceInfo(journalInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetInvTypeSortOrder) +---@param invType number +---@return number sortOrder +function EJ_GetInvTypeSortOrder(invType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetLootFilter) +---@return number classID +---@return number specID +function EJ_GetLootFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetMapEncounter) +---@param uiMapID number +---@param index number +---@param fromJournal? boolean +---@return number x +---@return number y +---@return number instanceID +---@return string name +---@return string description +---@return number encounterID +---@return number rootSectionID +---@return string link +function EJ_GetMapEncounter(uiMapID, index, fromJournal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetNumEncountersForLootByIndex) +---@param index number +---@return number numLoot +function EJ_GetNumEncountersForLootByIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetNumLoot) +---@return number numLoot +function EJ_GetNumLoot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetNumSearchResults) +---@return number numResults +function EJ_GetNumSearchResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetNumTiers) +---@return number numTiers +function EJ_GetNumTiers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetSearchProgress) +---@return number searchProgress +function EJ_GetSearchProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetSearchResult) +---@param index number +---@return number id +---@return number stype +---@return number difficultyID +---@return number instanceID +---@return number encounterID +---@return string itemLink +function EJ_GetSearchResult(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetSearchSize) +---@return number searchSize +function EJ_GetSearchSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetSectionPath) +---@param sectionID number +---@return number sectionID +---@return number? parent1SectionID +---@return number? parent2SectionID +---@return number? rootSectionID +function EJ_GetSectionPath(sectionID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_GetTierInfo) +---@param index number +---@return string name +---@return string link +function EJ_GetTierInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_HandleLinkPath) +---@param journalType number +---@param id number +---@return number instanceID +---@return number? encounterID +---@return number? sectionID +---@return number? tierIndex +function EJ_HandleLinkPath(journalType, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_InstanceIsRaid) +---@return boolean isRaid +function EJ_InstanceIsRaid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_IsLootListOutOfDate) +---@return boolean listOutOfDate +function EJ_IsLootListOutOfDate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_IsSearchFinished) +---@return boolean isFinished +function EJ_IsSearchFinished() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_IsValidInstanceDifficulty) +---@param difficultyID number +---@return boolean isValid +function EJ_IsValidInstanceDifficulty(difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_ResetLootFilter) +function EJ_ResetLootFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_SelectEncounter) +---@param encounterID number +function EJ_SelectEncounter(encounterID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_SelectInstance) +---@param journalInstanceID number +function EJ_SelectInstance(journalInstanceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_SelectTier) +---@param index number +function EJ_SelectTier(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_SetDifficulty) +---@param difficultyID number +function EJ_SetDifficulty(difficultyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_SetLootFilter) +---@param classID number +---@param specID number +function EJ_SetLootFilter(classID, specID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EJ_SetSearch) +---@param text string +function EJ_SetSearch(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditMacro) +---@param macroInfo number|string +---@param name? string +---@param icon? number|string +---@param body? string +---@return number macroID +function EditMacro(macroInfo, name, icon, body) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EnumerateFrames) +---@param currentFrame? Frame +---@return Frame? nextFrame +function EnumerateFrames(currentFrame) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EnumerateServerChannels) +---@return string ... +function EnumerateServerChannels() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ExpandGuildTradeSkillHeader) +function ExpandGuildTradeSkillHeader(tradeSkillID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ExpandQuestHeader) +---@param index number +---@param isAuto boolean +function ExpandQuestHeader(index, isAuto) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ExpandWarGameHeader) +function ExpandWarGameHeader(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_FindSpellBookSlotBySpellID) +function FindSpellBookSlotBySpellID(spellID, isPet) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlagTutorial) +function FlagTutorial(tutorial) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipCameraYaw) +---@param angle number +function FlipCameraYaw(angle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlyoutHasSpell) +---@param flyoutID number +---@param spellID number +---@return boolean hasSpell +function FlyoutHasSpell(flyoutID, spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ForfeitDuel) +function ForfeitDuel() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMEuropaBugsEnabled) +function GMEuropaBugsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMEuropaComplaintsEnabled) +function GMEuropaComplaintsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMEuropaSuggestionsEnabled) +function GMEuropaSuggestionsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMEuropaTicketsEnabled) +function GMEuropaTicketsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMItemRestorationButtonEnabled) +function GMItemRestorationButtonEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMQuickTicketSystemEnabled) +function GMQuickTicketSystemEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMQuickTicketSystemThrottled) +function GMQuickTicketSystemThrottled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMReportLag) +function GMReportLag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMRequestPlayerInfo) +function GMRequestPlayerInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMResponseResolve) +function GMResponseResolve() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMSurveyAnswer) +function GMSurveyAnswer() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMSurveyAnswerSubmit) +function GMSurveyAnswerSubmit(question, rank, comment) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMSurveyCommentSubmit) +function GMSurveyCommentSubmit(comment) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMSurveyNumAnswers) +function GMSurveyNumAnswers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMSurveyQuestion) +---@param index number +function GMSurveyQuestion(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GMSurveySubmit) +function GMSurveySubmit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementCategory) +---@param achievementID number +---@return number categoryID +function GetAchievementCategory(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementComparisonInfo) +---@param achievementID number +---@return boolean completed +---@return number month +---@return number day +---@return number year +function GetAchievementComparisonInfo(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementCriteriaInfo) +---@param achievementID number +---@param criteriaIndex number +---@param countHidden? boolean +---@return string criteriaString +---@return number criteriaType +---@return boolean completed +---@return number quantity +---@return number reqQuantity +---@return string charName +---@return number flags +---@return number assetID +---@return string quantityString +---@return number criteriaID +---@return boolean eligible +---@return number duration +---@return number elapsed +function GetAchievementCriteriaInfo(achievementID, criteriaIndex, countHidden) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementCriteriaInfoByID) +---@param achievementID number +---@param criteriaID number +---@return string criteriaString +---@return number criteriaType +---@return boolean completed +---@return number quantity +---@return number reqQuantity +---@return string charName +---@return number flags +---@return number assetID +---@return string quantityString +---@return number criteriaID +---@return boolean eligible +---@return number duration +---@return number elapsed +function GetAchievementCriteriaInfoByID(achievementID, criteriaID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementGuildRep) +---@param id number +---@return boolean requiresRep +---@return boolean hasRep +---@return number repLevel +function GetAchievementGuildRep(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementInfo) +---@param achievementID number +---@return number id +---@return string name +---@return number points +---@return boolean completed +---@return number month +---@return number day +---@return number year +---@return string description +---@return number flags +---@return number icon +---@return string rewardText +---@return boolean isGuild +---@return boolean wasEarnedByMe +---@return string earnedBy +---@return boolean isStatistic +---@overload fun(categoryID: number, index: number) +function GetAchievementInfo(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementLink) +---@param id number +---@return string link +function GetAchievementLink(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementNumCriteria) +---@param achievementID number +---@return number numCriteria +function GetAchievementNumCriteria(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementNumRewards) +function GetAchievementNumRewards(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementReward) +function GetAchievementReward(achievementID, rewardIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementSearchProgress) +function GetAchievementSearchProgress() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAchievementSearchSize) +function GetAchievementSearchSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActionBarToggles) +---@return boolean bar1 +---@return boolean bar2 +---@return boolean bar3 +---@return boolean bar4 +---@return boolean bar5 +---@return boolean bar6 +---@return boolean bar7 +function GetActionBarToggles() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActionInfo) +---@param slot number +---@return string actionType +---@return number|string id +---@return string subType +function GetActionInfo(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActiveArtifactByRace) +---@param branchIndex number +---@param artifactIndex number +---@return string artifactName +---@return string artifactDescription +---@return string artifactRarity +---@return string artifactIcon +---@return string hoverDescription +---@return number keystoneCount +---@return string bgTexture +function GetActiveArtifactByRace(branchIndex, artifactIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActiveLevel) +function GetActiveLevel(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActiveLootRollIDs) +function GetActiveLootRollIDs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActiveQuestID) +function GetActiveQuestID(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetActiveTitle) +function GetActiveTitle(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAlternativeDefaultLanguage) +function GetAlternativeDefaultLanguage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetArchaeologyInfo) +---@return string localizedName +function GetArchaeologyInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetArchaeologyRaceInfo) +---@param raceIndex number +---@return string raceName +---@return number raceTexture +---@return number raceItemID +---@return number numFragmentsCollected +---@return number numFragmentsRequired +---@return number maxFragments +function GetArchaeologyRaceInfo(raceIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetArchaeologyRaceInfoByID) +---@param branchID number +---@return string raceName +---@return number raceTextureID +---@return number raceItemID +---@return number numFragmentsCollected +---@return number numFragmentsRequired +---@return number maxFragments +function GetArchaeologyRaceInfoByID(branchID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetArenaOpponentSpec) +---@param id number +---@return number specID +---@return number gender +function GetArenaOpponentSpec(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetArtifactInfoByRace) +---@param raceIndex number +---@param artifactIndex number +---@return string artifactName +---@return string artifactDescription +---@return number artifactRarity +---@return string artifactIcon +---@return string hoverDescription +---@return number keystoneCount +---@return string bgTexture +---@return number firstCompletionTime +---@return number completionCount +function GetArtifactInfoByRace(raceIndex, artifactIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetArtifactProgress) +---@return number numFragmentsCollected +---@return number numFragmentsAdded +---@return number numFragmentsRequired +function GetArtifactProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAutoQuestPopUp) +---@param index number +---@return number questID +---@return string type +function GetAutoQuestPopUp(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvailableLevel) +function GetAvailableLevel(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvailableQuestInfo) +---@param index number +---@return boolean isTrivial +---@return number frequency +---@return boolean isRepeatable +---@return boolean isLegendary +---@return number questID +---@return boolean isImportant +function GetAvailableQuestInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAvailableTitle) +function GetAvailableTitle(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetAverageItemLevel) +---@return number avgItemLevel +---@return number avgItemLevelEquipped +---@return number avgItemLevelPvp +function GetAverageItemLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldArenaFaction) +---@return number myFaction +function GetBattlefieldArenaFaction() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldEstimatedWaitTime) +---@return number waitTime +function GetBattlefieldEstimatedWaitTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldInstanceExpiration) +---@return number expiration +function GetBattlefieldInstanceExpiration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldInstanceRunTime) +---@return number time +function GetBattlefieldInstanceRunTime() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldMapIconScale) +function GetBattlefieldMapIconScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldPortExpiration) +---@param index number +---@return number expiration +function GetBattlefieldPortExpiration(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldStatus) +---@param index number +---@return string status +---@return string? mapName +---@return number teamSize +---@return boolean registeredMatch +---@return boolean suspendedQueue +---@return string? queueType +---@return string? gameType +---@return string? role +---@return boolean? asGroup +---@return string? shortDescription +---@return string? longDescription +---@return boolean isSoloQueue +function GetBattlefieldStatus(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldTeamInfo) +---@param index number +---@return string teamName +---@return number oldTeamRating +---@return number newTeamRating +---@return number teamRating +function GetBattlefieldTeamInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldTimeWaited) +---@param battlegroundQueuePosition number +---@return number timeInQueue +function GetBattlefieldTimeWaited(battlegroundQueuePosition) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlefieldWinner) +---@return number? winner +function GetBattlefieldWinner() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBattlegroundPoints) +---@param team number +---@return number currentPoints +---@return number maxPoints +function GetBattlegroundPoints(team) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBestFlexRaidChoice) +---@return number flexDungeonID +function GetBestFlexRaidChoice() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBestRFChoice) +---@return number dungeonId +function GetBestRFChoice() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBinding) +---@param index number +---@param alwaysIncludeGamepad? boolean +---@return string command +---@return string category +---@return string? key1 +---@return string? key2 +---@return string? ... +function GetBinding(index, alwaysIncludeGamepad) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBindingAction) +---@param binding string +---@param checkOverride? boolean +---@return string action +function GetBindingAction(binding, checkOverride) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBindingKey) +---@param command string +---@return string ... +function GetBindingKey(command) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBindingText) +---@param key? string +---@param prefix? string +---@param abbreviate? boolean +---@return string text +function GetBindingText(key, prefix, abbreviate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetButtonMetatable) +---@return table metatable +function GetButtonMetatable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBuybackItemInfo) +---@param slotIndex number +---@return string? name +---@return fileID? icon +---@return number price +---@return number quantity +---@return number numAvailable +---@return boolean isUsable +---@return boolean? isBound +function GetBuybackItemInfo(slotIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetBuybackItemLink) +function GetBuybackItemLink(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCallPetSpellInfo) +function GetCallPetSpellInfo(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCameraZoom) +---@return number zoom +function GetCameraZoom() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCategoryAchievementPoints) +function GetCategoryAchievementPoints(categoryID, includeSubCategories) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCategoryInfo) +---@param categoryID number +---@return string title +---@return number parentCategoryID +---@return number flags +function GetCategoryInfo(categoryID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCategoryList) +---@return number[] idTable +function GetCategoryList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCategoryNumAchievements) +---@param categoryId number +---@param includeAll? boolean +---@return number total +---@return number completed +---@return number incompleted +function GetCategoryNumAchievements(categoryId, includeAll) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChannelDisplayInfo) +---@param index number +---@return string name +---@return boolean header +---@return boolean? collapsed +---@return number? channelNumber +---@return number? count +---@return boolean? active +---@return string category +---@return number channelType +function GetChannelDisplayInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChannelList) +---@return number id +---@return string name +---@return boolean disabled +---@return ... +function GetChannelList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChannelName) +---@param name string|number +---@return number id +---@return string name +---@return number instanceID +---@return boolean isCommunitiesChannel +function GetChannelName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChatTypeIndex) +---@param messageGroup string +---@return number index +function GetChatTypeIndex(messageGroup) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChatWindowChannels) +---@param frameId number +---@return string channelName1 +---@return number channelId1 +---@return any ... +function GetChatWindowChannels(frameId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChatWindowInfo) +---@param frameIndex number +---@return string name +---@return number fontSize +---@return number r +---@return number g +---@return number b +---@return number alpha +---@return boolean shown +---@return boolean locked +---@return number docked +---@return boolean uninteractable +function GetChatWindowInfo(frameIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChatWindowMessages) +---@param index number +---@return string ... +function GetChatWindowMessages(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChatWindowSavedDimensions) +function GetChatWindowSavedDimensions(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetChatWindowSavedPosition) +function GetChatWindowSavedPosition(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetClassInfo) +---@param classID number +---@return string className +---@return string classFile +---@return number classID +function GetClassInfo(classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetClickFrame) +---@param name string +---@return table? frame +function GetClickFrame(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCompanionInfo) +---@param type string +---@param id number +---@return number creatureID +---@return string creatureName +---@return number creatureSpellID +---@return string icon +---@return boolean issummoned +---@return number mountType +function GetCompanionInfo(type, id) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetComparisonAchievementPoints) +function GetComparisonAchievementPoints() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetComparisonCategoryNumAchievements) +function GetComparisonCategoryNumAchievements(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetComparisonStatistic) +---@param achievementID number +---@return string value +function GetComparisonStatistic(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCriteriaSpell) +function GetCriteriaSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentArenaSeason) +---@return number season +function GetCurrentArenaSeason() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentBindingSet) +---@return number which +function GetCurrentBindingSet() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentEnvironment) +function GetCurrentEnvironment() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentGlyphNameForSpell) +function GetCurrentGlyphNameForSpell(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentGraphicsAPI) +---@return string gxAPI +function GetCurrentGraphicsAPI() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentGraphicsSetting) +function GetCurrentGraphicsSetting() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentGuildBankTab) +function GetCurrentGuildBankTab() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentKeyBoardFocus) +function GetCurrentKeyBoardFocus() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentLevelFeatures) +function GetCurrentLevelFeatures(level) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetCurrentScaledResolution) +function GetCurrentScaledResolution() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDailyQuestsCompleted) +function GetDailyQuestsCompleted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDefaultLanguage) +---@return string language +---@return number languageID +function GetDefaultLanguage() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDemotionRank) +function GetDemotionRank(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetDungeonForRandomSlot) +function GetDungeonForRandomSlot(randomID, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetEditBoxMetatable) +---@return table metatable +function GetEditBoxMetatable() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetEquipmentNameFromSpell) +function GetEquipmentNameFromSpell() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFailedPVPTalentIDs) +function GetFailedPVPTalentIDs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFailedTalentIDs) +function GetFailedTalentIDs() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFilteredAchievementID) +---@param index number +---@return number achievementID +function GetFilteredAchievementID(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFlexRaidDungeonInfo) +function GetFlexRaidDungeonInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFlyoutID) +function GetFlyoutID(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFlyoutInfo) +---@param flyoutID number +---@return string name +---@return string description +---@return number numSlots +---@return boolean isKnown +function GetFlyoutInfo(flyoutID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFlyoutSlotInfo) +---@param flyoutID number +---@param slot number +---@return number flyoutSpellID +---@return number overrideSpellID +---@return boolean isKnown +---@return string spellName +---@return number slotSpecID +function GetFlyoutSlotInfo(flyoutID, slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFollowerTypeIDFromSpell) +function GetFollowerTypeIDFromSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFontStringMetatable) +---@return table metatable +function GetFontStringMetatable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFrameMetatable) +---@return table metatable +function GetFrameMetatable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetFramesRegisteredForEvent) +---@param event FrameEvent +---@return Frame ... +function GetFramesRegisteredForEvent(event) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGMStatus) +function GetGMStatus() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGMTicket) +function GetGMTicket() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGlobalEnvironment) +function GetGlobalEnvironment() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGraphicsAPIs) +---@return string cvarValues +function GetGraphicsAPIs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGraphicsCVarValueForQualityLevel) +function GetGraphicsCVarValueForQualityLevel() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGreetingText) +function GetGreetingText() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGroupMemberCounts) +function GetGroupMemberCounts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildAchievementMemberInfo) +---@param achievementID number +---@param index number +---@return string? leftMemberName +function GetGuildAchievementMemberInfo(achievementID, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildAchievementMembers) +---@param achievementID number +function GetGuildAchievementMembers(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildAchievementNumMembers) +---@param achievementID number +---@return number numMembers +function GetGuildAchievementNumMembers(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankBonusDepositMoney) +function GetGuildBankBonusDepositMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankItemInfo) +---@param tab number +---@param slot number +---@return number texture +---@return number itemCount +---@return boolean locked +---@return boolean isFiltered +---@return number quality +function GetGuildBankItemInfo(tab, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankItemLink) +---@param tab number +---@param slot number +---@return string itemLink +function GetGuildBankItemLink(tab, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankMoney) +---@return number retVal1 +function GetGuildBankMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankMoneyTransaction) +---@param index number +---@return string transactionType +---@return string name +---@return number amount +---@return number years +---@return number months +---@return number days +---@return number hours +function GetGuildBankMoneyTransaction(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankTabCost) +function GetGuildBankTabCost() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankTabInfo) +---@param tab number +---@return string name +---@return string icon +---@return boolean isViewable +---@return boolean canDeposit +---@return number numWithdrawals +---@return number remainingWithdrawals +---@return boolean filtered +function GetGuildBankTabInfo(tab) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankTabPermissions) +---@param tab number +---@return boolean canView +---@return boolean canDeposit +---@return boolean canEdit +---@return number stacksPerDay +function GetGuildBankTabPermissions(tab) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankText) +function GetGuildBankText(tab) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankTransaction) +---@param tab number +---@param index number +---@return string type +---@return string name +---@return string itemLink +---@return number count +---@return number tab1 +---@return number tab2 +---@return number year +---@return number month +---@return number day +---@return number hour +function GetGuildBankTransaction(tab, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankWithdrawGoldLimit) +---@return number dailyWithdrawLimit +function GetGuildBankWithdrawGoldLimit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildBankWithdrawMoney) +---@return number withdrawLimit +function GetGuildBankWithdrawMoney() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildCategoryList) +function GetGuildCategoryList() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildChallengeInfo) +function GetGuildChallengeInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildCharterCost) +function GetGuildCharterCost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildEventInfo) +function GetGuildEventInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildFactionGroup) +function GetGuildFactionGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildInfo) +---@param unit UnitToken +---@return string guildName +---@return string guildRankName +---@return number guildRankIndex +---@return string? realm +function GetGuildInfo(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildLogoInfo) +function GetGuildLogoInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildMemberRecipes) +function GetGuildMemberRecipes(name, skillLineID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildNewsFilters) +function GetGuildNewsFilters() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildNewsMemberName) +function GetGuildNewsMemberName(index, nameIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildNewsSort) +function GetGuildNewsSort() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildPerkInfo) +function GetGuildPerkInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRecipeInfoPostQuery) +---@return number professionID +---@return number recipeID +---@return number numMembers +function GetGuildRecipeInfoPostQuery() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRecipeMember) +---@param index number +---@return string name +---@return boolean online +function GetGuildRecipeMember(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRenameRequired) +function GetGuildRenameRequired() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRewardInfo) +function GetGuildRewardInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRosterInfo) +---@param index number +---@return string name +---@return string rankName +---@return number rankIndex +---@return number level +---@return string classDisplayName +---@return string zone +---@return string publicNote +---@return string officerNote +---@return boolean isOnline +---@return number status +---@return string class +---@return number achievementPoints +---@return number achievementRank +---@return boolean isMobile +---@return boolean canSoR +---@return number repStanding +---@return string guid +function GetGuildRosterInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRosterLargestAchievementPoints) +function GetGuildRosterLargestAchievementPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRosterLastOnline) +---@param index number +---@return number yearsOffline +---@return number monthsOffline +---@return number daysOffline +---@return number hoursOffline +function GetGuildRosterLastOnline(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRosterSelection) +---@return number index +function GetGuildRosterSelection() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildRosterShowOffline) +---@return boolean showoffline +function GetGuildRosterShowOffline() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildTabardFiles) +---@return number tabardBackgroundUpper +---@return number tabardBackgroundLower +---@return number tabardEmblemUpper +---@return number tabardEmblemLower +---@return number tabardBorderUpper +---@return number tabardBorderLower +function GetGuildTabardFiles() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetGuildTradeSkillInfo) +---@param index number +---@return number skillID +---@return boolean isCollapsed +---@return string iconTexture +---@return string headerName +---@return number numOnline +---@return number numVisible +---@return number numPlayers +---@return string playerName +---@return string playerNameWithRealm +---@return string class +---@return boolean online +---@return string zone +---@return number skill +---@return string classFileName +---@return boolean isMobile +---@return number isAway +function GetGuildTradeSkillInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetHomePartyInfo) +---@param homePlayers table +---@return table homePlayers +function GetHomePartyInfo(homePlayers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInboxHeaderInfo) +---@param index number +---@return string packageIcon +---@return string stationeryIcon +---@return string sender +---@return string subject +---@return number money +---@return number CODAmount +---@return number daysLeft +---@return number hasItem +---@return boolean wasRead +---@return boolean wasReturned +---@return boolean textCreated +---@return boolean canReply +---@return boolean isGM +function GetInboxHeaderInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInboxInvoiceInfo) +---@param index number +---@return string? invoiceType +---@return string? itemName +---@return string? playerName +---@return number bid +---@return number buyout +---@return number deposit +---@return number consignment +---@return number moneyDelay +---@return number etaHour +---@return number etaMin +---@return number count +---@return boolean commerceAuction +function GetInboxInvoiceInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInboxItem) +---@param index number +---@param itemIndex number +---@return string name +---@return number itemID +---@return string texture +---@return number count +---@return number quality +---@return boolean canUse +function GetInboxItem(index, itemIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInboxItemLink) +---@param message number +---@param attachment number +---@return string itemLink +function GetInboxItemLink(message, attachment) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInboxNumItems) +---@return number numItems +---@return number totalItems +function GetInboxNumItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInboxText) +---@param index number +---@return string bodyText +---@return string stationaryMiddle +---@return string stationaryEdge +---@return boolean isTakeable +---@return boolean isInvoice +---@return boolean isConsortium +function GetInboxText(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInspectArenaData) +---@param bracketId number +---@return number rating +---@return number seasonPlayed +---@return number seasonWon +---@return number weeklyPlayed +---@return number weeklyWon +function GetInspectArenaData(bracketId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInspectHonorData) +---@return number todayHK +---@return number todayHonor +---@return number yesterdayHK +---@return number yesterdayHonor +---@return number lifetimeHK +---@return number lifetimeRank +function GetInspectHonorData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInspectSpecialization) +---@param unit UnitToken +---@return number id +function GetInspectSpecialization(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInspectTalent) +function GetInspectTalent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryAlertStatus) +---@param index string +---@return number alertStatus +function GetInventoryAlertStatus(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemBroken) +---@param unit UnitToken +---@param invSlotId number +---@return boolean isBroken +function GetInventoryItemBroken(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemCooldown) +---@param unit UnitToken +---@param invSlotId number +---@return number start +---@return number duration +---@return number enable +function GetInventoryItemCooldown(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemCount) +---@param unit UnitToken +---@param invSlotId number +---@return number count +function GetInventoryItemCount(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemDurability) +---@param invSlotId number +---@return number current +---@return number maximum +function GetInventoryItemDurability(invSlotId) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemEquippedUnusable) +function GetInventoryItemEquippedUnusable(unit, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemID) +---@param unit UnitToken +---@param invSlotId number +---@return number itemId +---@return number unknown +function GetInventoryItemID(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemLink) +---@param unit UnitToken +---@param invSlotId number +---@return string? itemLink +function GetInventoryItemLink(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemQuality) +---@param unit UnitToken +---@param invSlotId number +---@return Enum.ItemQuality quality +function GetInventoryItemQuality(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemTexture) +---@param unit UnitToken +---@param invSlotId number +---@return fileID texture +function GetInventoryItemTexture(unit, invSlotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventoryItemsForSlot) +---@param slot number +---@param returnTable table +---@param transmogrify? boolean +---@return table returnTable +function GetInventoryItemsForSlot(slot, returnTable, transmogrify) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInventorySlotInfo) +---@param invSlotName InventorySlotName +---@return number invSlotId +---@return string textureName +---@return boolean checkRelic +function GetInventorySlotInfo(invSlotName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetInviteConfirmationInfo) +---@param guid unknown +---@return number confirmationType +---@return string name +---@return string guid +---@return boolean rolesInvalid +---@return boolean willConvertToRaid +---@return number level +---@return number spec +---@return number itemLevel +function GetInviteConfirmationInfo(guid) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetItemLevelColor) +---@return number r +---@return number g +---@return number b +function GetItemLevelColor() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetJournalInfoForSpellConfirmation) +function GetJournalInfoForSpellConfirmation(spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDChoiceCollapseState) +function GetLFDChoiceCollapseState(LFGCollapseList) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDChoiceEnabledState) +function GetLFDChoiceEnabledState(LFGEnabledList) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDChoiceOrder) +function GetLFDChoiceOrder(LFDDungeonList) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDLockInfo) +function GetLFDLockInfo(dungeonID, playerIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDLockPlayerCount) +function GetLFDLockPlayerCount() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDRoleLockInfo) +function GetLFDRoleLockInfo(dungeonID, roleID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFDRoleRestrictions) +function GetLFDRoleRestrictions(dungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGBootProposal) +---@return boolean inProgress +---@return boolean didVote +---@return boolean myVote +---@return string targetName +---@return number totalVotes +---@return number bootVotes +---@return number timeLeft +---@return string reason +function GetLFGBootProposal() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGCategoryForID) +function GetLFGCategoryForID(partySlot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGCompletionReward) +function GetLFGCompletionReward() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGCompletionRewardItem) +function GetLFGCompletionRewardItem(rewardIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGCompletionRewardItemLink) +function GetLFGCompletionRewardItemLink(rewardIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDeserterExpiration) +---@return number? expiryTime +function GetLFGDeserterExpiration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonEncounterInfo) +---@param dungeonID number +---@param encounterIndex number +---@return string bossName +---@return string texture +---@return boolean isKilled +---@return boolean unknown4 +function GetLFGDungeonEncounterInfo(dungeonID, encounterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonInfo) +---@param dungeonID number +---@return string name +---@return number typeID +---@return number subtypeID +---@return number minLevel +---@return number maxLevel +---@return number recLevel +---@return number minRecLevel +---@return number maxRecLevel +---@return number expansionLevel +---@return number groupID +---@return string textureFilename +---@return number difficulty +---@return number maxPlayers +---@return string description +---@return boolean isHoliday +---@return number bonusRepAmount +---@return number minPlayers +---@return boolean isTimeWalker +---@return string name2 +---@return number minGearLevel +---@return boolean isScalingDungeon +---@return number lfgMapID +function GetLFGDungeonInfo(dungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonNumEncounters) +---@param dungeonID number +---@return number numEncounters +---@return number numCompleted +function GetLFGDungeonNumEncounters(dungeonID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonRewardCapBarInfo) +---@param dungeonID number +---@return number currencyID +---@return number dungeonID +---@return number quantity +---@return number limit +---@return number overallQuantity +---@return number overallLimit +---@return number periodPurseQuantity +---@return number periodPurseLimit +---@return number purseQuantity +---@return number purseLimit +function GetLFGDungeonRewardCapBarInfo(dungeonID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonRewardCapInfo) +function GetLFGDungeonRewardCapInfo(dungeonID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonRewardInfo) +function GetLFGDungeonRewardInfo(dungeonID, rewardIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonRewardLink) +function GetLFGDungeonRewardLink(dungeonID, rewardIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonRewards) +function GetLFGDungeonRewards(dungeonID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonShortageRewardInfo) +function GetLFGDungeonShortageRewardInfo(dungeonID, shortageIndex, rewardIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGDungeonShortageRewardLink) +function GetLFGDungeonShortageRewardLink(dungeonID, shortageIndex, rewardIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGInfoServer) +function GetLFGInfoServer(category, lfgID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGInviteRoleAvailability) +function GetLFGInviteRoleAvailability(roleID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGInviteRoleRestrictions) +function GetLFGInviteRoleRestrictions(roleID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGProposal) +---@return boolean proposalExists +---@return number id +---@return number typeID +---@return number subtypeID +---@return string name +---@return string texture +---@return string role +---@return boolean hasResponded +---@return number totalEncounters +---@return number completedEncounters +---@return number numMembers +---@return boolean isLeader +---@return boolean isHoliday +---@return number proposalCategory +function GetLFGProposal() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGProposalEncounter) +function GetLFGProposalEncounter(encounterIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGProposalMember) +function GetLFGProposalMember(memberIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGQueueStats) +---@param category number +---@param activeID? number +---@return boolean hasData +---@return boolean leaderNeeds +---@return boolean tankNeeds +---@return boolean healerNeeds +---@return boolean dpsNeeds +---@return number totalTanks +---@return number totalHealers +---@return number totalDPS +---@return number instanceType +---@return number instanceSubType +---@return string instanceName +---@return number averageWait +---@return number tankWait +---@return number healerWait +---@return number dpsWait +---@return number myWait +---@return number queuedTime +---@return number activeID +function GetLFGQueueStats(category, activeID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGQueuedList) +function GetLFGQueuedList(category, table) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRandomCooldownExpiration) +---@return number? expiryTime +function GetLFGRandomCooldownExpiration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRandomDungeonInfo) +---@param index number +---@return number id +---@return string name +---@return number typeID +---@return number subtypeID +---@return number minLevel +---@return number maxLevel +---@return number recLevel +---@return number minRecLevel +---@return number maxRecLevel +---@return number expansionLevel +---@return number groupID +---@return string textureFilename +---@return number difficultyID +---@return number maxPlayers +---@return string description +---@return boolean isHoliday +---@return number bonusRepAmount +---@return number minPlayers +---@return boolean isTimeWalker +---@return string name2 +---@return number minGearLevel +---@return boolean isScalingDungeon +function GetLFGRandomDungeonInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGReadyCheckUpdate) +function GetLFGReadyCheckUpdate() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGReadyCheckUpdateBattlegroundInfo) +function GetLFGReadyCheckUpdateBattlegroundInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRoleShortageRewards) +---@param dungeonID number +---@param shortageSeverity number +---@return boolean eligible +---@return boolean forTank +---@return boolean forHealer +---@return boolean forDamage +---@return number itemCount +---@return number money +---@return number xp +function GetLFGRoleShortageRewards(dungeonID, shortageSeverity) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRoleUpdate) +function GetLFGRoleUpdate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRoleUpdateBattlegroundInfo) +---@return string queueName +function GetLFGRoleUpdateBattlegroundInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRoleUpdateMember) +function GetLFGRoleUpdateMember(memberIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRoleUpdateSlot) +---@param index number +---@return number dungeonID +---@return number dungeonType +---@return number dungeonSubType +function GetLFGRoleUpdateSlot(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGRoles) +---@return boolean isLeader +---@return boolean isTank +---@return boolean isHealer +---@return boolean isDPS +function GetLFGRoles() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFGSuspendedPlayers) +function GetLFGSuspendedPlayers(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLFRChoiceOrder) +---@param LFRRaidList table +---@return table raidList +function GetLFRChoiceOrder(LFRRaidList) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLanguageByIndex) +---@param index number +---@return string language +---@return number languageID +function GetLanguageByIndex(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLatestCompletedAchievements) +function GetLatestCompletedAchievements() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLatestCompletedComparisonAchievements) +function GetLatestCompletedComparisonAchievements() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLatestThreeSenders) +---@return string? sender1 +---@return string? sender2 +---@return string? sender3 +function GetLatestThreeSenders() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLatestUpdatedComparisonStats) +function GetLatestUpdatedComparisonStats() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLatestUpdatedStats) +function GetLatestUpdatedStats() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLooseMacroIcons) +function GetLooseMacroIcons() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLooseMacroItemIcons) +function GetLooseMacroItemIcons() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootInfo) +---@return table[] info +function GetLootInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootRollItemInfo) +---@param rollID number +---@return string texture +---@return string name +---@return number count +---@return number quality +---@return boolean bindOnPickUp +---@return boolean canNeed +---@return boolean canGreed +---@return boolean canDisenchant +---@return number reasonNeed +---@return number reasonGreed +---@return number reasonDisenchant +---@return number deSkillRequired +---@return boolean canTransmog +function GetLootRollItemInfo(rollID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootRollItemLink) +---@param id number +---@return string itemLink +function GetLootRollItemLink(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootRollTimeLeft) +---@param rollID number +---@return number? timeLeft +function GetLootRollTimeLeft(rollID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootSlotInfo) +---@param slot number +---@return string lootIcon +---@return string lootName +---@return number lootQuantity +---@return number currencyID +---@return number lootQuality +---@return boolean locked +---@return boolean isQuestItem +---@return number questID +---@return boolean isActive +---@return boolean isCoin +function GetLootSlotInfo(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootSlotLink) +---@param index number +---@return string itemLink +function GetLootSlotLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootSlotType) +---@param slotIndex number +---@return number slotType +function GetLootSlotType(slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootSourceInfo) +---@param lootSlot number +---@return string guid +---@return number quantity +function GetLootSourceInfo(lootSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetLootThreshold) +---@return number threshold +function GetLootThreshold() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroBody) +---@param macro number|string +---@return string? body +function GetMacroBody(macro) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroIcons) +function GetMacroIcons(table) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroIndexByName) +---@param name string +---@return number macroSlot +function GetMacroIndexByName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroInfo) +---@param macro number|string +---@return string name +---@return fileID icon +---@return string body +function GetMacroInfo(macro) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroItem) +---@param name number|string +---@return string itemName +---@return string itemLink +function GetMacroItem(name) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroItemIcons) +function GetMacroItemIcons(table) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMacroSpell) +---@param name number|string +---@return number id +function GetMacroSpell(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMasterLootCandidate) +---@param slot number +---@param index number +---@return string candidate +function GetMasterLootCandidate(slot, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxBattlefieldID) +---@return number maxBattlefieldID +function GetMaxBattlefieldID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxNumCUFProfiles) +function GetMaxNumCUFProfiles() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxRenderScale) +function GetMaxRenderScale() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxRewardCurrencies) +function GetMaxRewardCurrencies() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMaxTalentTier) +---@return number tiers +function GetMaxTalentTier() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantCurrencies) +function GetMerchantCurrencies() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantFilter) +function GetMerchantFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantItemCostInfo) +---@param index number +---@return number itemCount +function GetMerchantItemCostInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantItemCostItem) +---@param index number +---@param itemIndex number +---@return string itemTexture +---@return number itemValue +---@return string itemLink +---@return string currencyName +function GetMerchantItemCostItem(index, itemIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantItemID) +---@param index number +---@return number itemID +function GetMerchantItemID(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantItemLink) +---@param index number +---@return string? link +function GetMerchantItemLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantItemMaxStack) +---@param index number +---@return number maxStack +function GetMerchantItemMaxStack(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMerchantNumItems) +---@return number numItems +function GetMerchantNumItems() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMinRenderScale) +function GetMinRenderScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetModifiedClick) +---@param action string +---@return string key +function GetModifiedClick(action) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetModifiedClickAction) +function GetModifiedClickAction(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMonitorAspectRatio) +function GetMonitorAspectRatio() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMonitorCount) +function GetMonitorCount() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMonitorName) +function GetMonitorName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetMultiCastTotemSpells) +---@param slot number +---@return number totem1 +---@return number totem2 +---@return number totem3 +---@return number totem4 +---@return number totem5 +---@return number totem6 +---@return number totem7 +function GetMultiCastTotemSpells(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNextAchievement) +---@param achievementID number +---@return number? nextID +---@return boolean? completed +function GetNextAchievement(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNextCompleatedTutorial) +function GetNextCompleatedTutorial(tutorial) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNextPendingInviteConfirmation) +function GetNextPendingInviteConfirmation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumActiveQuests) +---@return number numActiveQuests +function GetNumActiveQuests() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumArchaeologyRaces) +---@return number numRaces +function GetNumArchaeologyRaces() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumArenaOpponentSpecs) +function GetNumArenaOpponentSpecs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumArenaOpponents) +function GetNumArenaOpponents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumArtifactsByRace) +---@param raceIndex number +---@return number numProjects +function GetNumArtifactsByRace(raceIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumAutoQuestPopUps) +---@return number numPopups +function GetNumAutoQuestPopUps() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumAvailableQuests) +---@return number nbrAvailableQuests +function GetNumAvailableQuests() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumBattlefieldFlagPositions) +function GetNumBattlefieldFlagPositions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumBattlefieldScores) +---@return number numBattlefieldScores +function GetNumBattlefieldScores() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumBattlefieldVehicles) +function GetNumBattlefieldVehicles(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumBattlegroundTypes) +---@return number numBattlegrounds +function GetNumBattlegroundTypes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumBindings) +---@return number numKeyBindings +function GetNumBindings() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumBuybackItems) +---@return number numItems +function GetNumBuybackItems() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumChannelMembers) +function GetNumChannelMembers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumClasses) +---@return number numClasses +function GetNumClasses() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumCompanions) +---@param type string +---@return number count +function GetNumCompanions(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumComparisonCompletedAchievements) +---@param achievementID number +---@return number total +---@return number completed +function GetNumComparisonCompletedAchievements(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumCompletedAchievements) +---@return number total +---@return number completed +function GetNumCompletedAchievements() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumDisplayChannels) +---@return number channelCount +function GetNumDisplayChannels() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumDungeonForRandomSlot) +function GetNumDungeonForRandomSlot(randomID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumFilteredAchievements) +---@return number numFiltered +function GetNumFilteredAchievements() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumFlexRaidDungeons) +---@return number numInstances +function GetNumFlexRaidDungeons() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumFlyouts) +function GetNumFlyouts() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGroupChannels) +function GetNumGroupChannels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGroupMembers) +---@param groupType? number +---@return number numMembers +function GetNumGroupMembers(groupType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildBankMoneyTransactions) +function GetNumGuildBankMoneyTransactions() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildBankTabs) +function GetNumGuildBankTabs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildBankTransactions) +function GetNumGuildBankTransactions(tab) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildChallenges) +function GetNumGuildChallenges() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildEvents) +function GetNumGuildEvents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildMembers) +---@return number numTotal +---@return number numOnline +function GetNumGuildMembers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildNews) +function GetNumGuildNews() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildPerks) +function GetNumGuildPerks() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildRewards) +function GetNumGuildRewards() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumGuildTradeSkill) +function GetNumGuildTradeSkill() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumLanguages) +---@return number numLanguages +function GetNumLanguages() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumLootItems) +---@return number numLootItems +function GetNumLootItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumMacros) +---@return number global +---@return number perChar +function GetNumMacros() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumMembersInRank) +function GetNumMembersInRank(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumModifiedClickActions) +function GetNumModifiedClickActions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumPetitionNames) +---@return number numNames +function GetNumPetitionNames() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestChoices) +---@return number numChoices +function GetNumQuestChoices() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestCurrencies) +function GetNumQuestCurrencies() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestItemDrops) +function GetNumQuestItemDrops() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestItems) +---@return number numRequiredItems +function GetNumQuestItems() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestLeaderBoards) +---@param questID? number +---@return number numObjectives +function GetNumQuestLeaderBoards(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestLogChoices) +---@param questID number +---@param includeCurrencies? boolean +---@return number numQuestChoices +function GetNumQuestLogChoices(questID, includeCurrencies) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestLogRewardFactions) +function GetNumQuestLogRewardFactions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestLogRewards) +---@param questID? number +---@return number numQuestRewards +function GetNumQuestLogRewards(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestLogTasks) +function GetNumQuestLogTasks() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumQuestRewards) +---@return number numRewards +function GetNumQuestRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumRFDungeons) +---@return number numRFDungeons +function GetNumRFDungeons() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumRaidProfiles) +function GetNumRaidProfiles() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumRandomDungeons) +---@return number numRandomDungeons +function GetNumRandomDungeons() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumRandomScenarios) +function GetNumRandomScenarios() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumRoutes) +function GetNumRoutes(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumSavedInstances) +---@return number numInstances +function GetNumSavedInstances() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumSavedWorldBosses) +---@return number numSavedWorldBosses +function GetNumSavedWorldBosses() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumScenarios) +function GetNumScenarios() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumShapeshiftForms) +---@return number numForms +function GetNumShapeshiftForms() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumSpecGroups) +---@param b boolean +---@return number numSpecGroups +function GetNumSpecGroups(b) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumSpecializations) +---@param isInspect? boolean +---@param isPet? boolean +---@return number numSpecializations +function GetNumSpecializations(isInspect, isPet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumSubgroupMembers) +---@param groupType? number +---@return number numSubgroupMembers +function GetNumSubgroupMembers(groupType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumTrainerServices) +---@return number numTrainerServices +function GetNumTrainerServices() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumTreasurePickerItems) +function GetNumTreasurePickerItems() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumUnspentPvpTalents) +function GetNumUnspentPvpTalents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumUnspentTalents) +---@return number numUnspentTalents +function GetNumUnspentTalents() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetNumWarGameTypes) +function GetNumWarGameTypes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetObjectiveText) +function GetObjectiveText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetOptOutOfLoot) +---@return boolean optedOut +function GetOptOutOfLoot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPVPRoles) +---@return boolean tank +---@return boolean healer +---@return boolean dps +function GetPVPRoles() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPartyAssignment) +---@param assignment string +---@param raidmember? UnitToken +---@param exactMatch? boolean +---@return boolean isAssigned +function GetPartyAssignment(assignment, raidmember, exactMatch) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPartyLFGBackfillInfo) +function GetPartyLFGBackfillInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPartyLFGID) +function GetPartyLFGID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPendingGlyphName) +function GetPendingGlyphName() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPendingInviteConfirmations) +function GetPendingInviteConfirmations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPersonalRatedInfo) +---@param index number +---@return number rating +---@return number seasonBest +---@return number weeklyBest +---@return number seasonPlayed +---@return number seasonWon +---@return number weeklyPlayed +---@return number weeklyWon +---@return number cap +function GetPersonalRatedInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetActionCooldown) +---@param index number +---@return number startTime +---@return number duration +---@return number enable +function GetPetActionCooldown(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetActionInfo) +---@param index number +---@return string name +---@return string texture +---@return boolean isToken +---@return boolean isActive +---@return boolean autoCastAllowed +---@return boolean autoCastEnabled +---@return number spellID +---@return boolean checksRange +---@return boolean inRange +function GetPetActionInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetActionSlotUsable) +---@param index number +---@return boolean isUsable +function GetPetActionSlotUsable(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetActionsUsable) +function GetPetActionsUsable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetExperience) +---@return number currXP +---@return number nextXP +function GetPetExperience() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetFoodTypes) +---@return string ... +function GetPetFoodTypes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetIcon) +function GetPetIcon() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetTimeRemaining) +function GetPetTimeRemaining() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetitionInfo) +---@return string petitionType +---@return string title +---@return string bodyText +---@return number maxSigs +---@return string originator +---@return boolean isOriginator +---@return number minSigs +function GetPetitionInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPetitionNameInfo) +function GetPetitionNameInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPlayerTradeCurrency) +function GetPlayerTradeCurrency() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPlayerTradeMoney) +---@return number tradeMoney +function GetPlayerTradeMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPossessInfo) +---@param index number +---@return string texture +---@return number spellID +---@return boolean enabled +function GetPossessInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPrevCompleatedTutorial) +function GetPrevCompleatedTutorial(tutorial) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPreviousAchievement) +---@param achievementID number +---@return number previousAchievementID +function GetPreviousAchievement(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPreviousArenaSeason) +function GetPreviousArenaSeason() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPrimarySpecialization) +function GetPrimarySpecialization() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetProfessionInfo) +---@param index number +---@return string name +---@return fileID icon +---@return number skillLevel +---@return number maxSkillLevel +---@return number numAbilities +---@return number spelloffset +---@return number skillLine +---@return number skillModifier +---@return number specializationIndex +---@return number specializationOffset +---@return string skillLineName +function GetProfessionInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetProfessions) +---@return number prof1 +---@return number prof2 +---@return number archaeology +---@return number fishing +---@return number cooking +function GetProfessions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetProgressText) +---@return string progress +function GetProgressText() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPromotionRank) +function GetPromotionRank(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPvpTalentInfoByID) +---@param talentID number +---@param specGroupIndex? number +---@param isInspect? boolean +---@param inspectedUnit? string +---@return number talentID +---@return string name +---@return number icon +---@return boolean selected +---@return boolean available +---@return number spellID +---@return boolean unlocked +---@return number row +---@return number column +---@return boolean known +---@return boolean grantedByAura +function GetPvpTalentInfoByID(talentID, specGroupIndex, isInspect, inspectedUnit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPvpTalentInfoBySpecialization) +function GetPvpTalentInfoBySpecialization() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetPvpTalentLink) +function GetPvpTalentLink() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestBackgroundMaterial) +---@return string? material +function GetQuestBackgroundMaterial() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestCurrencyID) +function GetQuestCurrencyID(type, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestExpansion) +function GetQuestExpansion(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestFactionGroup) +---@param questID number +---@return number factionGroup +function GetQuestFactionGroup(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestID) +---@return number questID +function GetQuestID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestItemInfo) +---@param type string +---@param index number +---@return string name +---@return number texture +---@return number count +---@return Enum.ItemQuality quality +---@return boolean isUsable +---@return number itemID +function GetQuestItemInfo(type, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestItemInfoLootType) +function GetQuestItemInfoLootType(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestItemLink) +---@param type string +---@param index number +---@return string itemLink +function GetQuestItemLink(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLink) +---@param questID number +---@return string questLink +function GetQuestLink(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogChoiceInfo) +---@param index number +---@param questID? number +---@return string itemName +---@return fileID itemTexture +---@return number quantity +---@return Enum.ItemQuality quality +---@return boolean isUsable +---@return number itemID +function GetQuestLogChoiceInfo(index, questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogChoiceInfoLootType) +function GetQuestLogChoiceInfoLootType(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogCompletionText) +function GetQuestLogCompletionText() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogCriteriaSpell) +function GetQuestLogCriteriaSpell() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogItemDrop) +function GetQuestLogItemDrop(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogItemLink) +---@param type string +---@param index number +---@param questID? number +---@return string itemLink +function GetQuestLogItemLink(type, index, questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogLeaderBoard) +---@param objIndex number +---@param questIndex? number +---@return string description +---@return string objectiveType +---@return boolean isCompleted +function GetQuestLogLeaderBoard(objIndex, questIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogPortraitTurnIn) +function GetQuestLogPortraitTurnIn() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogQuestText) +---@param questLogIndex? number +---@return string questDescription +---@return string questObjectives +function GetQuestLogQuestText(questLogIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogQuestType) +function GetQuestLogQuestType() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardArtifactXP) +function GetQuestLogRewardArtifactXP() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardFactionInfo) +function GetQuestLogRewardFactionInfo(questIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardHonor) +function GetQuestLogRewardHonor(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardInfo) +---@param itemIndex number +---@param questID? number +---@return string itemName +---@return string itemTexture +---@return number numItems +---@return number quality +---@return boolean isUsable +---@return number itemID +---@return number itemLevel +function GetQuestLogRewardInfo(itemIndex, questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardMoney) +---@param questID? number +---@return number money +function GetQuestLogRewardMoney(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardSkillPoints) +function GetQuestLogRewardSkillPoints() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardTitle) +function GetQuestLogRewardTitle() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogRewardXP) +function GetQuestLogRewardXP(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogSpecialItemCooldown) +---@param questLogIndex number +---@return number start +---@return number duration +---@return number enable +function GetQuestLogSpecialItemCooldown(questLogIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogSpecialItemInfo) +---@param questLogIndex number +---@return string? link +---@return number item +---@return number charges +---@return boolean showItemWhenComplete +function GetQuestLogSpecialItemInfo(questLogIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestLogTimeLeft) +---@return number timeLeft +function GetQuestLogTimeLeft() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestMoneyToGet) +function GetQuestMoneyToGet() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestObjectiveInfo) +---@param questID number +---@param objectiveIndex number +---@param displayComplete boolean +---@return string text +---@return string objectiveType +---@return boolean finished +---@return number fulfilled +---@return number required +function GetQuestObjectiveInfo(questID, objectiveIndex, displayComplete) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestPOIBlobCount) +function GetQuestPOIBlobCount(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestPOILeaderBoard) +function GetQuestPOILeaderBoard(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestPOIs) +function GetQuestPOIs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestPortraitGiver) +function GetQuestPortraitGiver() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestPortraitTurnIn) +function GetQuestPortraitTurnIn() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestProgressBarPercent) +---@param questID number +---@return number percent +function GetQuestProgressBarPercent(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestResetTime) +---@return number nextReset +function GetQuestResetTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestReward) +---@param itemChoice number +function GetQuestReward(itemChoice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestSortIndex) +---@param questLogIndex number +---@return number sortIndex +function GetQuestSortIndex(questLogIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestText) +function GetQuestText() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetQuestUiMapID) +function GetQuestUiMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRFDungeonInfo) +---@param index number +---@return number id +---@return string name +---@return number typeID +---@return number subtypeID +---@return number minLevel +---@return number maxLevel +---@return number recLevel +---@return number minRecLevel +---@return number maxRecLevel +---@return number expansionLevel +---@return number groupID +---@return string textureFilename +---@return number difficulty +---@return number maxPlayers +---@return string description +---@return boolean isHoliday +---@return number bonusRepAmount +---@return number minPlayers +---@return boolean isTimeWalking +---@return string name2 +---@return number minGearLevel +---@return boolean isScaling +---@return number lfgMapID +function GetRFDungeonInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidProfileFlattenedOptions) +function GetRaidProfileFlattenedOptions(profile) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidProfileName) +function GetRaidProfileName(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidProfileOption) +function GetRaidProfileOption(profile, optionName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidProfileSavedPosition) +function GetRaidProfileSavedPosition(profile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRaidRosterInfo) +---@param raidIndex number +---@return string name +---@return number rank +---@return number subgroup +---@return number level +---@return string class +---@return string fileName +---@return string? zone +---@return boolean online +---@return boolean isDead +---@return string role +---@return boolean isML +---@return string combatRole +function GetRaidRosterInfo(raidIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRandomDungeonBestChoice) +function GetRandomDungeonBestChoice() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRandomScenarioBestChoice) +function GetRandomScenarioBestChoice() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRandomScenarioInfo) +function GetRandomScenarioInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRatedBattleGroundInfo) +function GetRatedBattleGroundInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetReadyCheckStatus) +function GetReadyCheckStatus(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetReadyCheckTimeLeft) +function GetReadyCheckTimeLeft() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRepairAllCost) +---@return number repairAllCost +---@return boolean? canRepair +function GetRepairAllCost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardArtifactXP) +function GetRewardArtifactXP() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardHonor) +function GetRewardHonor() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardMoney) +function GetRewardMoney() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardNumSkillUps) +function GetRewardNumSkillUps() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardPackArtifactPower) +function GetRewardPackArtifactPower(rewardPackID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardPackCurrencies) +function GetRewardPackCurrencies(rewardPackID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardPackItems) +function GetRewardPackItems(rewardPackID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardPackMoney) +function GetRewardPackMoney(rewardPackID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardPackTitle) +function GetRewardPackTitle(rewardPackID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardPackTitleName) +function GetRewardPackTitleName(titleID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardSkillLineID) +function GetRewardSkillLineID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardSkillPoints) +function GetRewardSkillPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardText) +---@return string reward +function GetRewardText() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardTitle) +function GetRewardTitle() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRewardXP) +---@return number xp +function GetRewardXP() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRunningMacro) +function GetRunningMacro() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetRunningMacroButton) +function GetRunningMacroButton() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSavedInstanceChatLink) +---@param index number +---@return string instanceChatLink +function GetSavedInstanceChatLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSavedInstanceEncounterInfo) +---@param instanceIndex number +---@param encounterIndex number +---@return string bossName +---@return number fileDataID +---@return boolean isKilled +---@return boolean unknown4 +function GetSavedInstanceEncounterInfo(instanceIndex, encounterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSavedInstanceInfo) +---@param index number +---@return string name +---@return number lockoutId +---@return number reset +---@return number difficultyId +---@return boolean locked +---@return boolean extended +---@return number instanceIDMostSig +---@return boolean isRaid +---@return number maxPlayers +---@return string difficultyName +---@return number numEncounters +---@return number encounterProgress +---@return boolean extendDisabled +---@return number instanceId +function GetSavedInstanceInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSavedWorldBossInfo) +---@param index number +---@return string name +---@return number worldBossID +---@return number reset +function GetSavedWorldBossInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetScenariosChoiceOrder) +---@param allScenarios? table +---@return table allScenarios +function GetScenariosChoiceOrder(allScenarios) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSelectedArtifactInfo) +---@return string artifactName +---@return string artifactDescription +---@return number artifactRarity +---@return number artifactIcon +---@return string hoverDescription +---@return number keystoneCount +---@return number bgTexture +---@return number spellID +function GetSelectedArtifactInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSelectedDisplayChannel) +function GetSelectedDisplayChannel() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSelectedWarGameType) +function GetSelectedWarGameType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSendMailCOD) +---@return number amount +function GetSendMailCOD() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSendMailItem) +---@param index number +---@return string name +---@return number itemID +---@return fileID texture +---@return number count +---@return Enum.ItemQuality quality +function GetSendMailItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSendMailItemLink) +---@param attachment number +---@return string itemLink +function GetSendMailItemLink(attachment) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSendMailMoney) +function GetSendMailMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSendMailPrice) +---@return number sendPrice +function GetSendMailPrice() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetShapeshiftForm) +---@param flag? boolean +---@return number index +function GetShapeshiftForm(flag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetShapeshiftFormCooldown) +---@param index number +---@return number startTime +---@return number duration +---@return number isActive +function GetShapeshiftFormCooldown(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetShapeshiftFormID) +---@return number index +function GetShapeshiftFormID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetShapeshiftFormInfo) +---@param index number +---@return string icon +---@return boolean active +---@return boolean castable +---@return number spellID +function GetShapeshiftFormInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSoundEntryCount) +---@param soundKit number +---@return number? entryCount +function GetSoundEntryCount(soundKit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationInfoByID) +---@param specID number +---@param gender? number +---@return number id +---@return string name +---@return string description +---@return number icon +---@return string role +---@return string classFile +---@return string className +function GetSpecializationInfoByID(specID, gender) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationRole) +---@param specIndex number +---@param isInspect? boolean +---@param isPet? boolean +---@return string roleToken +function GetSpecializationRole(specIndex, isInspect, isPet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationRoleByID) +---@param specID number +---@return string roleToken +function GetSpecializationRoleByID(specID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationRoleEnum) +function GetSpecializationRoleEnum() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationRoleEnumByID) +function GetSpecializationRoleEnumByID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecializationSpells) +---@param specIndex number +---@param isInspect? boolean +---@param isPet? boolean +---@return number spellID +---@return number level +---@return number ... +function GetSpecializationSpells(specIndex, isInspect, isPet) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpecsForSpell) +function GetSpecsForSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellBaseCooldown) +---@param spellid number +---@return number cooldownMS +---@return number gcdMS +function GetSpellBaseCooldown(spellid) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellConfirmationPromptsInfo) +function GetSpellConfirmationPromptsInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSpellsForCharacterUpgradeTier) +function GetSpellsForCharacterUpgradeTier(tierIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetStatistic) +---@param category number +---@param index? number +---@return string value +---@return boolean skip +---@return string id +function GetStatistic(category, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetStatisticsCategoryList) +---@return table categories +function GetStatisticsCategoryList() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetSuggestedGroupSize) +function GetSuggestedGroupSize() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTabardCreationCost) +function GetTabardCreationCost() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTabardInfo) +function GetTabardInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTalentInfoByID) +function GetTalentInfoByID(talentID, specGroupIndex, isInspect, inspectUnit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTalentInfoBySpecialization) +function GetTalentInfoBySpecialization(specIndex, tier, column) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTalentLink) +function GetTalentLink(talentID, isInspect, specGroup, inspectID, classID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTalentTierInfo) +---@param tier number +---@param specGroupIndex number +---@param isInspect? boolean +---@param inspectUnit? string +---@return boolean tierAvailable +---@return number selectedTalent +---@return number tierUnlockLevel +function GetTalentTierInfo(tier, specGroupIndex, isInspect, inspectUnit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTargetTradeCurrency) +function GetTargetTradeCurrency() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTargetTradeMoney) +---@return number amount +function GetTargetTradeMoney() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTaskInfo) +---@param questID number +---@return boolean isInArea +---@return boolean isOnMap +---@return number numObjectives +function GetTaskInfo(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTaskPOIs) +function GetTaskPOIs() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTasksTable) +function GetTasksTable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTaxiMapID) +---@return number taxiMapID +function GetTaxiMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetText) +---@param token string +---@param gender number +---@param ordinal unknown +---@return string text +function GetText(token, gender, ordinal) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTitleText) +---@return string title +function GetTitleText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTotalAchievementPoints) +---@param guild? boolean +---@return number points +function GetTotalAchievementPoints(guild) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTradePlayerItemInfo) +---@param id number +---@return string name +---@return number texture +---@return number numItems +---@return Enum.ItemQuality quality +---@return string enchantment +---@return boolean canLoseTransmog +function GetTradePlayerItemInfo(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTradePlayerItemLink) +---@param index number +---@return string itemLink +function GetTradePlayerItemLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTradeTargetItemInfo) +---@param index number +---@return string name +---@return string texture +---@return number quantity +---@return number quality +---@return number isUsable +---@return string enchant +function GetTradeTargetItemInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTradeTargetItemLink) +---@param index number +---@return string itemLink +function GetTradeTargetItemLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerGreetingText) +---@return string greetingText +function GetTrainerGreetingText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerSelectionIndex) +---@return number selectionIndex +function GetTrainerSelectionIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceAbilityReq) +---@param trainerIndex number +---@param reqIndex number +---@return string ability +---@return boolean hasReq +function GetTrainerServiceAbilityReq(trainerIndex, reqIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceCost) +---@param index number +---@return number serviceCost +---@return number talentCost +---@return number professionCost +function GetTrainerServiceCost(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceDescription) +---@param index number +---@return string serviceDescription +function GetTrainerServiceDescription(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceIcon) +---@param index number +---@return fileID icon +function GetTrainerServiceIcon(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceInfo) +---@param index number +---@return string name +---@return string rank +---@return string category +---@return number expanded +function GetTrainerServiceInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceItemLink) +---@param index number +---@return string link +function GetTrainerServiceItemLink(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceLevelReq) +---@param id number +---@return number reqLevel +function GetTrainerServiceLevelReq(id) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceNumAbilityReq) +function GetTrainerServiceNumAbilityReq() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceSkillLine) +---@param index number +---@return string skillLine +function GetTrainerServiceSkillLine(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceSkillReq) +---@param index number +---@return string? skillName +---@return number skillLevel +---@return boolean hasReq +function GetTrainerServiceSkillReq(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceStepIndex) +function GetTrainerServiceStepIndex() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerServiceTypeFilter) +---@param type string +---@return boolean status +function GetTrainerServiceTypeFilter(type) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTrainerTradeskillRankValues) +function GetTrainerTradeskillRankValues() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTreasurePickerItemInfo) +function GetTreasurePickerItemInfo(index, questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetTutorialsEnabled) +function GetTutorialsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetVideoCaps) +function GetVideoCaps() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWarGameQueueStatus) +function GetWarGameQueueStatus() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWarGameTypeInfo) +function GetWarGameTypeInfo(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWeaponEnchantInfo) +---@return boolean hasMainHandEnchant +---@return number mainHandExpiration +---@return number mainHandCharges +---@return number mainHandEnchantID +---@return boolean hasOffHandEnchant +---@return number offHandExpiration +---@return number offHandCharges +---@return number offHandEnchantID +---@return boolean hasRangedEnchant +---@return number rangedExpiration +---@return number rangedCharges +---@return number rangedEnchantID +function GetWeaponEnchantInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWebTicket) +function GetWebTicket() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWorldElapsedTime) +---@param timerID number +---@return string description +---@return number elapsedTime +---@return number type +function GetWorldElapsedTime(timerID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWorldElapsedTimers) +function GetWorldElapsedTimers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWorldMapActionButtonSpellInfo) +function GetWorldMapActionButtonSpellInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GetWorldPVPQueueStatus) +---@param index number +---@return string status +---@return string? mapName +---@return number queueID +---@return number expireTime +---@return number averageWaitTime +---@return number queuedTime +---@return boolean suspended +function GetWorldPVPQueueStatus(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GiveMasterLoot) +---@param slot number +---@param index number +function GiveMasterLoot(slot, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GroupHasOfflineMember) +function GroupHasOfflineMember() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlAddRank) +function GuildControlAddRank(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlDelRank) +---@param index number +function GuildControlDelRank(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlGetAllowedShifts) +function GuildControlGetAllowedShifts(rankOrder) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlGetNumRanks) +function GuildControlGetNumRanks() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlGetRank) +function GuildControlGetRank() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlGetRankName) +---@param index number +---@return string rankName +function GuildControlGetRankName(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlSaveRank) +---@param name string +function GuildControlSaveRank(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlSetRank) +---@param rankOrder number +function GuildControlSetRank(rankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlSetRankFlag) +---@param index number +---@param enabled boolean +function GuildControlSetRankFlag(index, enabled) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlShiftRankDown) +function GuildControlShiftRankDown(rankOrder) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildControlShiftRankUp) +function GuildControlShiftRankUp(rankOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildInfo) +function GuildInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildMasterAbsent) +function GuildMasterAbsent() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildNewsSetSticky) +function GuildNewsSetSticky(index, bool) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_GuildNewsSort) +function GuildNewsSort(byDate) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HandleAtlasMemberCommand) +function HandleAtlasMemberCommand() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasArtifactEquipped) +function HasArtifactEquipped() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasAttachedGlyph) +function HasAttachedGlyph(spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasCompletedAnyAchievement) +function HasCompletedAnyAchievement(achievementID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasInboxItem) +function HasInboxItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasLFGRestrictions) +---@return boolean isRestricted +function HasLFGRestrictions() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasLoadedCUFProfiles) +function HasLoadedCUFProfiles() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasNewMail) +function HasNewMail() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasPendingGlyphCast) +function HasPendingGlyphCast() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasPetUI) +---@return boolean hasUI +---@return boolean isHunterPet +function HasPetUI() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasSendMailItem) +function HasSendMailItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HasWandEquipped) +---@return boolean wandEquipped +function HasWandEquipped() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HaveQuestData) +function HaveQuestData(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HaveQuestRewardData) +function HaveQuestRewardData(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_HearthAndResurrectFromArea) +function HearthAndResurrectFromArea() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HideRepairCursor) +function HideRepairCursor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InCombatLockdown) +---@return boolean inLockdown +function InCombatLockdown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InGuildParty) +---@return boolean inGroup +---@return number numGuildPresent +---@return number numGuildRequired +---@return number xpMultiplier +function InGuildParty() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InRepairMode) +---@return number inRepairMode +function InRepairMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_InboxItemCanDelete) +---@param index number +---@return boolean canDelete +function InboxItemCanDelete(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsAchievementEligible) +---@param achievementID number +---@return boolean eligible +function IsAchievementEligible(achievementID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsActiveBattlefieldArena) +---@return boolean isArena +---@return boolean isRegistered +function IsActiveBattlefieldArena() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsActiveQuestTrivial) +function IsActiveQuestTrivial(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsAllowedToUserTeleport) +---@return boolean allowedToTeleport +function IsAllowedToUserTeleport() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsArenaSkirmish) +function IsArenaSkirmish() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsArtifactCompletionHistoryAvailable) +---@return boolean available +function IsArtifactCompletionHistoryAvailable() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsAvailableQuestTrivial) +function IsAvailableQuestTrivial(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsBNLogin) +function IsBNLogin() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsBindingForGamePad) +function IsBindingForGamePad(KEY) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsBreadcrumbQuest) +function IsBreadcrumbQuest(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsCastingGlyph) +function IsCastingGlyph() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsChatAFK) +function IsChatAFK() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsChatChannelRaid) +function IsChatChannelRaid() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsChatDND) +function IsChatDND() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsCurrentQuestFailed) +function IsCurrentQuestFailed() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsDisplayChannelModerator) +function IsDisplayChannelModerator() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsDisplayChannelOwner) +function IsDisplayChannelOwner() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsEveryoneAssistant) +function IsEveryoneAssistant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsFishingLoot) +---@return boolean isFishingLoot +function IsFishingLoot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGMClient) +---@return boolean isGM +function IsGMClient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGUIDInGroup) +---@param guid WOWGUID +---@param groupType? number +---@return boolean inGroup +function IsGUIDInGroup(guid, groupType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGamePadCursorControlEnabled) +function IsGamePadCursorControlEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGamePadFreelookEnabled) +function IsGamePadFreelookEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGraphicsCVarValueSupported) +function IsGraphicsCVarValueSupported() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGraphicsSettingValueSupported) +function IsGraphicsSettingValueSupported() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGuildMember) +---@param player string +---@return boolean isGuildMember +function IsGuildMember(player) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsGuildRankAssignmentAllowed) +function IsGuildRankAssignmentAllowed(playerIndex, rankIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInActiveWorldPVP) +function IsInActiveWorldPVP() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInAuthenticatedRank) +function IsInAuthenticatedRank() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInCinematicScene) +---@return boolean inCinematicScene +function IsInCinematicScene() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInGlobalEnvironment) +function IsInGlobalEnvironment() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInGroup) +---@param groupType? number +---@return boolean inGroup +function IsInGroup(groupType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInGuildGroup) +---@return boolean inGuildGroup +function IsInGuildGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInLFGDungeon) +---@return boolean inLFGDungeon +function IsInLFGDungeon() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInRaid) +---@param groupType? number +---@return boolean isInRaid +function IsInRaid(groupType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInScenarioGroup) +function IsInScenarioGroup() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInventoryItemLocked) +---@param slotId number +---@return boolean isLocked +function IsInventoryItemLocked(slotId) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsInventoryItemProfessionBag) +function IsInventoryItemProfessionBag(unit, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLFGComplete) +---@return boolean isComplete +function IsLFGComplete() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsLFGDungeonJoinable) +---@param dungeonID number +---@return boolean isAvailableForAll +---@return boolean isAvailableForPlayer +---@return boolean hideIfNotJoinable +---@return number totalGroupSizeRequired +function IsLFGDungeonJoinable(dungeonID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMasterLooter) +function IsMasterLooter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsModifiedClick) +---@param action? string +---@return boolean isHeld +function IsModifiedClick(action) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsMouselooking) +---@return boolean isMouseLooking +function IsMouselooking() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsOutlineModeSupported) +function IsOutlineModeSupported() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPartyLFG) +function IsPartyLFG() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPartyWorldPVP) +function IsPartyWorldPVP() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPendingGlyphRemoval) +function IsPendingGlyphRemoval() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPetActive) +function IsPetActive() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPetAttackAction) +function IsPetAttackAction(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPetAttackActive) +---@return boolean isActive +function IsPetAttackActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsPlayerNeutral) +---@return boolean isNeutral +function IsPlayerNeutral() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsQuestCompletable) +---@return boolean isQuestCompletable +function IsQuestCompletable() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsQuestIDValidSpellTarget) +function IsQuestIDValidSpellTarget(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsQuestItemHidden) +function IsQuestItemHidden(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsQuestLogSpecialItemInRange) +function IsQuestLogSpecialItemInRange(index, target) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsQuestSequenced) +function IsQuestSequenced(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsSelectedSpellBookItem) +function IsSelectedSpellBookItem(spellSlot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsServerControlledBackfill) +function IsServerControlledBackfill() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsSpecializationActivateSpell) +function IsSpecializationActivateSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsSpellClassOrSpec) +---@param spellName string +---@return string? spec +---@return string class +---@overload fun(spellIndex: number, bookType: string) +function IsSpellClassOrSpec(spellName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsSpellValidForPendingGlyph) +function IsSpellValidForPendingGlyph(spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsStoryQuest) +function IsStoryQuest(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsTradeskillTrainer) +---@return boolean isTradeskillTrainer +function IsTradeskillTrainer() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsTutorialFlagged) +function IsTutorialFlagged(tutorial) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsUsingVehicleControls) +function IsUsingVehicleControls() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsVehicleAimAngleAdjustable) +---@return boolean adjustable +function IsVehicleAimAngleAdjustable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsVehicleAimPowerAdjustable) +---@return boolean adjustable +function IsVehicleAimPowerAdjustable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_IsWargame) +---@return boolean isWargame +function IsWargame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemAddedToArtifact) +---@param index number +---@return boolean added +function ItemAddedToArtifact(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemCanTargetGarrisonFollowerAbility) +function ItemCanTargetGarrisonFollowerAbility() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextGetCreator) +---@return string? creatorName +function ItemTextGetCreator() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextGetItem) +---@return string textName +function ItemTextGetItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextGetMaterial) +---@return string materialName +function ItemTextGetMaterial() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextGetPage) +---@return number pageNum +function ItemTextGetPage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextGetText) +---@return string pageBody +function ItemTextGetText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextHasNextPage) +---@return boolean hasNext +function ItemTextHasNextPage() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextIsFullPage) +function ItemTextIsFullPage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextNextPage) +function ItemTextNextPage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ItemTextPrevPage) +function ItemTextPrevPage() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinArena) +function JoinArena() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinChannelByName) +---@param channelName string +---@param password? string +---@param frameID? number +---@param hasVoice boolean +---@return number type +---@return string? name +function JoinChannelByName(channelName, password, frameID, hasVoice) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinLFG) +function JoinLFG(category) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinPermanentChannel) +---@param channelName string +---@param password? string +---@param frameID? number +---@param hasVoice? boolean +---@return number type +---@return string name +function JoinPermanentChannel(channelName, password, frameID, hasVoice) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinRatedBattlefield) +function JoinRatedBattlefield() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinRatedSoloShuffle) +function JoinRatedSoloShuffle() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinSingleLFG) +function JoinSingleLFG(category, lfgID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinSkirmish) +---@param arenaID number +---@param joinAsGroup? boolean +function JoinSkirmish(arenaID, joinAsGroup) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_JoinTemporaryChannel) +---@param channelName string +---@param password? string +---@param frameID? number +---@param hasVoice? boolean +---@return number type +---@return string name +function JoinTemporaryChannel(channelName, password, frameID, hasVoice) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_JumpOrAscendStart) +function JumpOrAscendStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LFGTeleport) +---@param toSafety boolean +function LFGTeleport(toSafety) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LearnPvpTalent) +---@param talentID number +---@param slotIndex number +function LearnPvpTalent(talentID, slotIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_LearnPvpTalents) +function LearnPvpTalents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LearnTalent) +---@param talentID number +---@return boolean success +function LearnTalent(talentID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_LearnTalents) +function LearnTalents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LeaveBattlefield) +function LeaveBattlefield() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_LeaveChannelByLocalID) +function LeaveChannelByLocalID(localID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LeaveChannelByName) +---@param channelName string +function LeaveChannelByName(channelName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_LeaveLFG) +function LeaveLFG(category) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_LeaveSingleLFG) +function LeaveSingleLFG(category, lfgID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ListChannelByName) +---@param channel number|string +function ListChannelByName(channel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ListChannels) +function ListChannels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LoadBindings) +---@param bindingSet number +function LoadBindings(bindingSet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LoggingChat) +---@param newState? boolean +---@return boolean? isLogging +function LoggingChat(newState) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LoggingCombat) +---@param newState? boolean +---@return boolean? isLogging +function LoggingCombat(newState) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_LootMoneyNotify) +function LootMoneyNotify(money, soleLooter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LootSlot) +---@param slot number +function LootSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_LootSlotHasItem) +---@param lootSlot number +---@return boolean isLootItem +function LootSlotHasItem(lootSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MouselookStart) +function MouselookStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MouselookStop) +function MouselookStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveAndSteerStart) +function MoveAndSteerStart() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveAndSteerStop) +function MoveAndSteerStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveBackwardStart) +---@param startTime number +function MoveBackwardStart(startTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveBackwardStop) +function MoveBackwardStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveForwardStart) +---@param startTime number +function MoveForwardStart(startTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveForwardStop) +function MoveForwardStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewDownStart) +---@param speed number +function MoveViewDownStart(speed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewDownStop) +function MoveViewDownStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewInStart) +---@param speed number +function MoveViewInStart(speed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewInStop) +function MoveViewInStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewLeftStart) +---@param speed number +function MoveViewLeftStart(speed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewLeftStop) +function MoveViewLeftStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewOutStart) +---@param speed number +function MoveViewOutStart(speed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewOutStop) +function MoveViewOutStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewRightStart) +---@param speed number +function MoveViewRightStart(speed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewRightStop) +function MoveViewRightStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewUpStart) +---@param speed number +function MoveViewUpStart(speed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MoveViewUpStop) +function MoveViewUpStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_MultiSampleAntiAliasingSupported) +function MultiSampleAntiAliasingSupported() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MuteSoundFile) +---@param sound number|string +function MuteSoundFile(sound) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_NeutralPlayerSelectFaction) +---@param factionIndex number +function NeutralPlayerSelectFaction(factionIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_NextView) +function NextView() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_NumTaxiNodes) +---@return number numNodes +function NumTaxiNodes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_OfferPetition) +function OfferPetition() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_OpenTrainer) +function OpenTrainer() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PartyLFGStartBackfill) +function PartyLFGStartBackfill() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetAggressiveMode) +function PetAggressiveMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetAttack) +function PetAttack() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetCanBeAbandoned) +---@return boolean canAbandon +function PetCanBeAbandoned() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetCanBeDismissed) +function PetCanBeDismissed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetDefensiveAssistMode) +function PetDefensiveAssistMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetDefensiveMode) +function PetDefensiveMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetDismiss) +function PetDismiss() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetFollow) +function PetFollow() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetHasActionBar) +---@return boolean hasActionBar +function PetHasActionBar() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetHasSpellbook) +function PetHasSpellbook() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetMoveTo) +function PetMoveTo(target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetPassiveMode) +function PetPassiveMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetStopAttack) +function PetStopAttack() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetUsesPetFrame) +function PetUsesPetFrame() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PetWait) +function PetWait() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupAction) +---@param slot number +function PickupAction(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupBagFromSlot) +---@param slot number +function PickupBagFromSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupCompanion) +---@param type string +---@param index number +function PickupCompanion(type, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupGuildBankItem) +function PickupGuildBankItem(tab, slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupGuildBankMoney) +function PickupGuildBankMoney(money) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupInventoryItem) +---@param slotId number +function PickupInventoryItem(slotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupMacro) +---@param name number|string +function PickupMacro(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupMerchantItem) +---@param index number +function PickupMerchantItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupPetAction) +---@param petActionSlot number +function PickupPetAction(petActionSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupPetSpell) +---@param spellID number +function PickupPetSpell(spellID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupPvpTalent) +function PickupPvpTalent() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PickupTalent) +function PickupTalent(talentID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PitchDownStart) +function PitchDownStart() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PitchDownStop) +function PitchDownStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PitchUpStart) +function PitchUpStart() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PitchUpStop) +function PitchUpStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlaceAction) +---@param slot number +function PlaceAction(slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayAutoAcceptQuestSound) +function PlayAutoAcceptQuestSound() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayMusic) +---@param sound number|string +---@return boolean willPlay +function PlayMusic(sound) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlaySound) +---@param soundKitID number +---@param channel? string +---@param forceNoDuplicates? boolean +---@param runFinishCallback? boolean +---@return boolean willPlay +---@return number soundHandle +function PlaySound(soundKitID, channel, forceNoDuplicates, runFinishCallback) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlaySoundFile) +---@param sound number|string +---@param channel? string +---@return boolean willPlay +---@return number soundHandle +function PlaySoundFile(sound, channel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PlayerHasToy) +---@param itemId number +---@return boolean hasToy +function PlayerHasToy(itemId) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PrevView) +function PrevView() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ProcessExceptionClient) +---@param description string +function ProcessExceptionClient(description) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ProcessQuestLogRewardFactions) +function ProcessQuestLogRewardFactions() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_PromoteToAssistant) +function PromoteToAssistant(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PromoteToLeader) +---@param unit UnitToken +---@overload fun(name: string, exactmatch: boolean) +function PromoteToLeader(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PutItemInBackpack) +function PutItemInBackpack() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_PutItemInBag) +---@param inventoryID? number +---@return boolean? hadItem +function PutItemInBag(inventoryID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QueryGuildBankLog) +function QueryGuildBankLog(tab) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QueryGuildBankTab) +function QueryGuildBankTab(tab) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QueryGuildBankText) +function QueryGuildBankText() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QueryGuildEventLog) +function QueryGuildEventLog() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QueryGuildNews) +function QueryGuildNews() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QueryGuildRecipes) +function QueryGuildRecipes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestChooseRewardError) +function QuestChooseRewardError() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestFlagsPVP) +function QuestFlagsPVP() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestGetAutoAccept) +---@return boolean isAutoAccepted +function QuestGetAutoAccept() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestGetAutoLaunched) +function QuestGetAutoLaunched() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestHasPOIInfo) +function QuestHasPOIInfo(questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestIsDaily) +---@return boolean isDaily +function QuestIsDaily() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestIsFromAdventureMap) +function QuestIsFromAdventureMap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestIsFromAreaTrigger) +---@return boolean isFromArea +function QuestIsFromAreaTrigger() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestIsWeekly) +---@return boolean isWeekly +function QuestIsWeekly() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestLogPushQuest) +function QuestLogPushQuest() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestLogRewardHasTreasurePicker) +function QuestLogRewardHasTreasurePicker() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestLogShouldShowPortrait) +function QuestLogShouldShowPortrait() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestMapUpdateAllQuests) +function QuestMapUpdateAllQuests() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestPOIUpdateIcons) +function QuestPOIUpdateIcons() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RaidProfileExists) +function RaidProfileExists(profile) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RaidProfileHasUnsavedChanges) +function RaidProfileHasUnsavedChanges() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RedockChatWindows) +function RedockChatWindows() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RefreshLFGList) +function RefreshLFGList() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RegisterStaticConstants) +function RegisterStaticConstants(table) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RejectProposal) +function RejectProposal() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ReleaseAction) +function ReleaseAction() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemoveAutoQuestPopUp) +function RemoveAutoQuestPopUp() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemoveChatWindowChannel) +---@param windowId number +---@param channelName string +function RemoveChatWindowChannel(windowId, channelName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemoveChatWindowMessages) +---@param index number +---@param messageGroup string +function RemoveChatWindowMessages(index, messageGroup) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemoveItemFromArtifact) +---@return boolean keystoneRemoved +function RemoveItemFromArtifact() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemovePvpTalent) +function RemovePvpTalent() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RemoveTalent) +function RemoveTalent(talentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RenamePetition) +---@param name string +function RenamePetition(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RepairAllItems) +---@param guildBankRepair? boolean +function RepairAllItems(guildBankRepair) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ReplaceGuildMaster) +function ReplaceGuildMaster() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestBattlefieldScoreData) +function RequestBattlefieldScoreData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestBattlegroundInstanceInfo) +---@param index number +function RequestBattlegroundInstanceInfo(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestBottomLeftActionBar) +function RequestBottomLeftActionBar() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestGuildChallengeInfo) +function RequestGuildChallengeInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestGuildPartyState) +function RequestGuildPartyState() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestGuildRewards) +function RequestGuildRewards() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestLFDPartyLockInfo) +function RequestLFDPartyLockInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestLFDPlayerLockInfo) +function RequestLFDPlayerLockInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestPVPOptionsEnabled) +function RequestPVPOptionsEnabled() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestPVPRewards) +function RequestPVPRewards() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestRaidInfo) +function RequestRaidInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestRandomBattlegroundInstanceInfo) +function RequestRandomBattlegroundInstanceInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequestRatedInfo) +function RequestRatedInfo() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RequeueSkirmish) +function RequeueSkirmish() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetChatColors) +function ResetChatColors() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetChatWindows) +function ResetChatWindows() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetSetMerchantFilter) +function ResetSetMerchantFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetTutorials) +function ResetTutorials() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ResetView) +function ResetView(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RespondMailLockSendItem) +function RespondMailLockSendItem(slot, keepItem) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RespondToInviteConfirmation) +function RespondToInviteConfirmation(guid, accept) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_RestoreRaidProfileFromCopy) +function RestoreRaidProfileFromCopy() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ReturnInboxItem) +function ReturnInboxItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RollOnLoot) +---@param rollID number +---@param rollType? number +function RollOnLoot(rollID, rollType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RunBinding) +---@param command string +---@param up? string +function RunBinding(command, up) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_RunMacro) +---@param name number|string +function RunMacro(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SaveBindings) +---@param which number +function SaveBindings(which) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SaveRaidProfileCopy) +function SaveRaidProfileCopy(profile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SaveView) +---@param viewIndex number +function SaveView(viewIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGGetEncounterResults) +function SearchLFGGetEncounterResults(index, encounterIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGGetJoinedID) +function SearchLFGGetJoinedID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGGetNumResults) +---@return number numResults +---@return number totalResults +function SearchLFGGetNumResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGGetPartyResults) +---@param index number +---@param partyIndex number +---@return any ... +function SearchLFGGetPartyResults(index, partyIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGGetResults) +---@param index number +---@return any ... +function SearchLFGGetResults(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGJoin) +---@param typeID number +---@param lfgID number +function SearchLFGJoin(typeID, lfgID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGLeave) +function SearchLFGLeave() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SearchLFGSort) +function SearchLFGSort(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SecureCmdOptionParse) +---@param options string +---@return string result +---@return string target +function SecureCmdOptionParse(options) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SelectActiveQuest) +function SelectActiveQuest() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SelectAvailableQuest) +function SelectAvailableQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SelectTrainerService) +---@param index number +function SelectTrainerService(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SendMail) +---@param recipient string +---@param subject string +---@param body? string +function SendMail(recipient, subject, body) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SendSystemMessage) +---@param msg string +function SendSystemMessage(msg) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAchievementComparisonUnit) +---@param unit UnitToken +---@return boolean success +function SetAchievementComparisonUnit(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetAchievementSearchString) +---@param searchText string +---@return boolean searchFinished +function SetAchievementSearchString(searchText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetActionBarToggles) +---@param bar1 boolean +---@param bar2 boolean +---@param bar3 boolean +---@param bar4 boolean +---@param bar5 boolean +---@param bar6 boolean +---@param bar7 boolean +---@param alwaysShow string +function SetActionBarToggles(bar1, bar2, bar3, bar4, bar5, bar6, bar7, alwaysShow) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBarSlotFromIntro) +function SetBarSlotFromIntro(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBattlefieldScoreFaction) +---@param faction number +function SetBattlefieldScoreFaction(faction) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBinding) +---@param key string +---@param command? string +---@param mode? number +---@return boolean ok +function SetBinding(key, command, mode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBindingClick) +---@param key string +---@param buttonName string +---@param button string +---@return boolean ok +function SetBindingClick(key, buttonName, button) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBindingItem) +---@param key string +---@param item string +---@return boolean ok +function SetBindingItem(key, item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBindingMacro) +---@param key string +---@param name number| +---@return boolean success +function SetBindingMacro(key, name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetBindingSpell) +---@param key string +---@param spell string +---@return boolean ok +function SetBindingSpell(key, spell) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChannelOwner) +---@param channel string +---@param newowner string +function SetChannelOwner(channel, newowner) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChannelPassword) +---@param channelName string +---@param password string +function SetChannelPassword(channelName, password) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatColorNameByClass) +function SetChatColorNameByClass(chatType, colorNameByClass) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowAlpha) +function SetChatWindowAlpha(index, alpha) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowColor) +function SetChatWindowColor(index, r, g, b) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowDocked) +function SetChatWindowDocked(index, docked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowLocked) +function SetChatWindowLocked(index, locked) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowName) +function SetChatWindowName(index, name) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowSavedDimensions) +function SetChatWindowSavedDimensions(index, width, height) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowSavedPosition) +function SetChatWindowSavedPosition(index, point, xOffsetRatio, yOffsetRatio) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowShown) +function SetChatWindowShown(index, shown) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowSize) +function SetChatWindowSize(index, size) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetChatWindowUninteractable) +function SetChatWindowUninteractable(id, isUninteractable) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCurrentGraphicsSetting) +function SetCurrentGraphicsSetting() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetCurrentGuildBankTab) +function SetCurrentGuildBankTab(tab) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetEveryoneIsAssistant) +function SetEveryoneIsAssistant() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetFocusedAchievement) +---@param id? number +function SetFocusedAchievement(id) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGamePadCursorControl) +function SetGamePadCursorControl() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGamePadFreeLook) +function SetGamePadFreeLook() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildBankTabInfo) +---@param tab number +---@param name string +---@param icon number +function SetGuildBankTabInfo(tab, name, icon) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildBankTabItemWithdraw) +function SetGuildBankTabItemWithdraw() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildBankTabPermissions) +---@param tab number +---@param index number +---@param enabled boolean +function SetGuildBankTabPermissions(tab, index, enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildBankText) +---@param tab number +---@param infoText string +function SetGuildBankText(tab, infoText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildBankWithdrawGoldLimit) +---@param amount number +function SetGuildBankWithdrawGoldLimit(amount) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildMemberRank) +function SetGuildMemberRank(playerIndex, rankIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildNewsFilter) +function SetGuildNewsFilter(index, bool) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildRosterSelection) +---@param index number +function SetGuildRosterSelection(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildRosterShowOffline) +---@param enabled boolean +function SetGuildRosterShowOffline(enabled) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildTradeSkillCategoryFilter) +function SetGuildTradeSkillCategoryFilter(tradeSkillID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetGuildTradeSkillItemNameFilter) +function SetGuildTradeSkillItemNameFilter(itemName) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLFGBootVote) +function SetLFGBootVote(shouldKick) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLFGComment) +---@param comment string +function SetLFGComment(comment) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLFGDungeon) +function SetLFGDungeon(LE_LFG_CATEGORY, type) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLFGDungeonEnabled) +function SetLFGDungeonEnabled(dungeonID, isEnabled) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLFGHeaderCollapsed) +function SetLFGHeaderCollapsed(headerID, isCollapsed) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLFGRoles) +function SetLFGRoles(leader, tank, healer, dps) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLootPortrait) +function SetLootPortrait() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetLootThreshold) +---@param threshold number +function SetLootThreshold(threshold) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetMacroItem) +function SetMacroItem(macro, item, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetMacroSpell) +---@param name number|string +---@param spell string +---@param target UnitToken +function SetMacroSpell(name, spell, target) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetMerchantFilter) +function SetMerchantFilter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetModifiedClick) +---@param action string +---@param key string +function SetModifiedClick(action, key) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetMouselookOverrideBinding) +function SetMouselookOverrideBinding(key, command) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetMoveEnabled) +function SetMoveEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetMultiCastSpell) +---@param actionID number +---@param spellID number +function SetMultiCastSpell(actionID, spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetOptOutOfLoot) +---@param optOut boolean +function SetOptOutOfLoot(optOut) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetOverrideBinding) +---@param owner Frame +---@param isPriority boolean +---@param key string +---@param command string +function SetOverrideBinding(owner, isPriority, key, command) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetOverrideBindingClick) +---@param owner Frame +---@param isPriority boolean +---@param key string +---@param buttonName string +---@param mouseClick? string +function SetOverrideBindingClick(owner, isPriority, key, buttonName, mouseClick) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetOverrideBindingItem) +---@param owner Frame +---@param isPriority boolean +---@param key string +---@param item string +function SetOverrideBindingItem(owner, isPriority, key, item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetOverrideBindingMacro) +---@param owner Frame +---@param isPriority boolean +---@param key string +---@param macro string +function SetOverrideBindingMacro(owner, isPriority, key, macro) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetOverrideBindingSpell) +---@param owner Frame +---@param isPriority boolean +---@param key string +---@param spell string +function SetOverrideBindingSpell(owner, isPriority, key, spell) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPOIIconOverlapDistance) +function SetPOIIconOverlapDistance(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPOIIconOverlapPushDistance) +function SetPOIIconOverlapPushDistance(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPVPRoles) +---@param tank boolean +---@param healer boolean +---@param dps boolean +function SetPVPRoles(tank, healer, dps) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetPartyAssignment) +function SetPartyAssignment(assignment, player) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetRaidProfileOption) +function SetRaidProfileOption(profile, optionName, value) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetRaidProfileSavedPosition) +function SetRaidProfileSavedPosition(profile, isDynamic, topPoint, topOffset, bottomPoint, bottomOffset, leftPoint, leftOffset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetRaidSubgroup) +---@param index number +---@param subgroup number +function SetRaidSubgroup(index, subgroup) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSavedInstanceExtend) +function SetSavedInstanceExtend(index, extend) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSelectedArtifact) +---@param raceIndex number +---@param index? number +function SetSelectedArtifact(raceIndex, index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSelectedDisplayChannel) +function SetSelectedDisplayChannel(channelID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSelectedScreenResolutionIndex) +function SetSelectedScreenResolutionIndex(integerIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSelectedWarGameType) +function SetSelectedWarGameType(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSendMailCOD) +function SetSendMailCOD(amount) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSendMailMoney) +function SetSendMailMoney(amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSendMailShowing) +---@param shown boolean +function SetSendMailShowing(shown) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetSpellbookPetAction) +function SetSpellbookPetAction(slot, target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetTaxiMap) +---@param texture string +function SetTaxiMap(texture) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetTradeCurrency) +function SetTradeCurrency(type, amount) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetTrainerServiceTypeFilter) +---@param type string +---@param enable boolean +---@param exclusive boolean +function SetTrainerServiceTypeFilter(type, enable, exclusive) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetTurnEnabled) +function SetTurnEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetView) +---@param viewIndex number +function SetView(viewIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SetupFullscreenScale) +---@param frame Frame +function SetupFullscreenScale(frame) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowBuybackSellCursor) +function ShowBuybackSellCursor(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowQuestComplete) +---@param questID number +function ShowQuestComplete(questID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowQuestOffer) +function ShowQuestOffer(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ShowRepairCursor) +function ShowRepairCursor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SignPetition) +function SignPetition() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SocketInventoryItem) +function SocketInventoryItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SocketItemToArtifact) +---@return boolean keystoneAdded +function SocketItemToArtifact() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SolveArtifact) +function SolveArtifact() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SortBGList) +---@return boolean unk +function SortBGList() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SortBattlefieldScoreData) +function SortBattlefieldScoreData(type) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SortGuildRoster) +---@param sortType string +function SortGuildRoster(sortType) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SortGuildTradeSkill) +function SortGuildTradeSkill(type) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SortQuestSortTypes) +function SortQuestSortTypes() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SortQuests) +function SortQuests() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_ChatSystem_GetInputDriverNameByIndex) +function Sound_ChatSystem_GetInputDriverNameByIndex(InputDriverIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_ChatSystem_GetNumInputDrivers) +function Sound_ChatSystem_GetNumInputDrivers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_ChatSystem_GetNumOutputDrivers) +function Sound_ChatSystem_GetNumOutputDrivers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_ChatSystem_GetOutputDriverNameByIndex) +function Sound_ChatSystem_GetOutputDriverNameByIndex(OutputDriverIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_GameSystem_GetInputDriverNameByIndex) +function Sound_GameSystem_GetInputDriverNameByIndex(InputDriverIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_GameSystem_GetNumInputDrivers) +function Sound_GameSystem_GetNumInputDrivers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_GameSystem_GetNumOutputDrivers) +function Sound_GameSystem_GetNumOutputDrivers() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_GameSystem_GetOutputDriverNameByIndex) +function Sound_GameSystem_GetOutputDriverNameByIndex(OutputDriverIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_Sound_GameSystem_RestartSoundSystem) +function Sound_GameSystem_RestartSoundSystem() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetGarrisonFollower) +function SpellCanTargetGarrisonFollower() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetGarrisonFollowerAbility) +function SpellCanTargetGarrisonFollowerAbility() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetGarrisonMission) +function SpellCanTargetGarrisonMission() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetItem) +function SpellCanTargetItem() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetItemID) +function SpellCanTargetItemID() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetQuest) +function SpellCanTargetQuest() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCanTargetUnit) +---@param unit UnitToken +---@return boolean canTarget +function SpellCanTargetUnit(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellCancelQueuedSpell) +function SpellCancelQueuedSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellIsTargeting) +---@return boolean isTargeting +function SpellIsTargeting() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellStopCasting) +---@return boolean stopped +function SpellStopCasting() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellStopTargeting) +function SpellStopTargeting() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellTargetItem) +function SpellTargetItem(item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SpellTargetUnit) +---@param unit UnitToken +function SpellTargetUnit(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SplitGuildBankItem) +function SplitGuildBankItem(tab, slot, amount) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartAutoRun) +function StartAutoRun() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartDuel) +---@param unit string +---@overload fun(name: string, exactMatch?: boolean) +function StartDuel(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartSoloShuffleWarGameByName) +function StartSoloShuffleWarGameByName() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartSpectatorSoloShuffleWarGame) +function StartSpectatorSoloShuffleWarGame() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartSpectatorWarGame) +function StartSpectatorWarGame(target1, target2, size, area, isTournamentMode) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartWarGame) +function StartWarGame(target, name, isTournament) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StartWarGameByName) +function StartWarGameByName(msg) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StopAutoRun) +function StopAutoRun() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StopMacro) +function StopMacro() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StopMusic) +function StopMusic() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StopSound) +---@param soundHandle number +---@param fadeoutTime? number +function StopSound(soundHandle, fadeoutTime) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_StoreSecureReference) +function StoreSecureReference(name, obj) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StrafeLeftStart) +function StrafeLeftStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StrafeLeftStop) +function StrafeLeftStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StrafeRightStart) +function StrafeRightStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StrafeRightStop) +function StrafeRightStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SubmitRequiredGuildRename) +function SubmitRequiredGuildRename() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SummonRandomCritter) +function SummonRandomCritter() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SurrenderArena) +function SurrenderArena() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SwapRaidSubgroup) +---@param index1 number +---@param index2 number +function SwapRaidSubgroup(index1, index2) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SwapToGlobalEnvironment) +function SwapToGlobalEnvironment() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_SwitchAchievementSearchTab) +function SwitchAchievementSearchTab(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TakeInboxItem) +---@param messageIndex number +---@param attachIndex number +function TakeInboxItem(messageIndex, attachIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TakeInboxMoney) +---@param index number +function TakeInboxMoney(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TakeInboxTextItem) +function TakeInboxTextItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TakeTaxiNode) +---@param index number +function TakeTaxiNode(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiGetDestX) +---@param destinationIndex? number +---@param routeIndex? number +---@return number dX +function TaxiGetDestX(destinationIndex, routeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiGetDestY) +---@param destinationIndex? number +---@param routeIndex? number +---@return number dY +function TaxiGetDestY(destinationIndex, routeIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiGetNodeSlot) +function TaxiGetNodeSlot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiGetSrcX) +---@param destinationIndex? number +---@param routeIndex? number +---@return number sX +function TaxiGetSrcX(destinationIndex, routeIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiGetSrcY) +---@param destinationIndex? number +---@param routeIndex? number +---@return number sY +function TaxiGetSrcY(destinationIndex, routeIndex) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiIsDirectFlight) +function TaxiIsDirectFlight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiNodeCost) +---@param slot number +---@return number cost +function TaxiNodeCost(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiNodeGetType) +---@param index number +---@return string type +function TaxiNodeGetType(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiNodeName) +---@param index number +---@return string name +function TaxiNodeName(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiNodePosition) +---@param index number +---@return number x +---@return number y +function TaxiNodePosition(index) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TaxiRequestEarlyLanding) +function TaxiRequestEarlyLanding() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleAutoRun) +function ToggleAutoRun() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TogglePetAutocast) +function TogglePetAutocast(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleRun) +function ToggleRun() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ToggleWindowed) +function ToggleWindowed() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TriggerTutorial) +function TriggerTutorial(tutorial) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnInGuildCharter) +function TurnInGuildCharter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnLeftStart) +---@param startTime number +function TurnLeftStart(startTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnLeftStop) +function TurnLeftStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnOrActionStart) +function TurnOrActionStart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnOrActionStop) +function TurnOrActionStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnRightStart) +---@param startTime number +function TurnRightStart(startTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TurnRightStop) +function TurnRightStop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UninviteUnit) +---@param name string +---@param reason? string +function UninviteUnit(name, reason) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasIncomingResurrection) +---@param unit UnitToken +---@return boolean isBeingResurrected +function UnitHasIncomingResurrection(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasLFGDeserter) +---@param unit UnitToken +---@return boolean isDeserter +function UnitHasLFGDeserter(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHasLFGRandomCooldown) +---@param unit UnitToken +---@return boolean hasRandomCooldown +function UnitHasLFGRandomCooldown(unit) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnlearnSpecialization) +function UnlearnSpecialization(specIndex, isPet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnmuteSoundFile) +---@param sound number|string +function UnmuteSoundFile(sound) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_UpdateInventoryAlertStatus) +function UpdateInventoryAlertStatus() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_UpdateWarGamesList) +function UpdateWarGamesList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UseAction) +---@param slot number +---@param checkCursor? number +---@param onSelf? number +function UseAction(slot, checkCursor, onSelf) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UseInventoryItem) +---@param slot number +function UseInventoryItem(slot) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_UseQuestLogSpecialItem) +function UseQuestLogSpecialItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UseToy) +---@param itemId number +function UseToy(itemId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UseToyByName) +---@param name string +function UseToyByName(name) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_UseWorldMapActionButtonSpellOnQuest) +function UseWorldMapActionButtonSpellOnQuest() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimDecrement) +function VehicleAimDecrement() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimDownStart) +function VehicleAimDownStart() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimDownStop) +function VehicleAimDownStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimGetNormPower) +function VehicleAimGetNormPower() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimIncrement) +function VehicleAimIncrement() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimRequestAngle) +function VehicleAimRequestAngle() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimSetNormPower) +function VehicleAimSetNormPower() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimUpStart) +function VehicleAimUpStart() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleAimUpStop) +function VehicleAimUpStop() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleExit) +function VehicleExit() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehicleNextSeat) +function VehicleNextSeat() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_VehiclePrevSeat) +function VehiclePrevSeat() end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_ViewGuildRecipes) +function ViewGuildRecipes(skillLineID) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_WarGameRespond) +function WarGameRespond(accept) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_WithdrawGuildBankMoney) +function WithdrawGuildBankMoney(money) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_addframetext) +---@param text string +function addframetext(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_debuglocals) +---@param level number +---@return string? locals +function debuglocals(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_debugstack) +---@param coroutine thread +---@param start number +---@param count1 number +---@param count2 number +---@return string description +---@overload fun(start?: number, count1?: number, count2?: number) +function debugstack(coroutine, start, count1, count2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_forceinsecure) +function forceinsecure() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_geterrorhandler) +---@return function handler +function geterrorhandler() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_hooksecurefunc) +---@param tbl table +---@param name string +---@param hook function +---@overload fun(name: string, hook: function) +function hooksecurefunc(tbl, name, hook) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_issecure) +---@return boolean secure +function issecure() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_issecurevalue) +---@param value any +---@return boolean isSecure +---@return string? taint +function issecurevalue(value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_issecurevariable) +---@param tbl table +---@param variable string +---@return boolean isSecure +---@return string? taint +---@overload fun(variable: string) +function issecurevariable(tbl, variable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_pcallwithenv) +---@param func string +---@param env table +---@return boolean ok +function pcallwithenv(func, env) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_securecall) +---@generic A, R +---@generic S : string +---@param funcOrKey S|fun(...: A): ...:R +---@param ... A +---@return R ... +function securecall(funcOrKey, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_securecallfunction) +---@generic A, R +---@param func fun(...: A): ...:R +---@param ... A +---@return R ... +function securecallfunction(func, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_secureexecuterange) +---@param tbl table +---@param func function +---@param ... any +function secureexecuterange(tbl, func, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_seterrorhandler) +---@param errFunc function +function seterrorhandler(errFunc) end + +---#nopage +---[Documentation](https://warcraft.wiki.gg/wiki/API_setsecurehookforbidden) +function setsecurehookforbidden() end + diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_5.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_5.lua new file mode 100644 index 0000000..b4e93dd --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_5.lua @@ -0,0 +1,42 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_TaskQuest.GetQuestsOnMap](https://warcraft.wiki.gg/wiki/API_C_TaskQuest.GetQuestsOnMap) +---@param uiMapID number +---@return QuestPOIMapInfo[] taskPOIs +function C_TaskQuest.GetQuestsForPlayerByMapID(uiMapID) end + +---@deprecated +---Deprecated by [C_MerchantFrame.GetItemInfo](https://warcraft.wiki.gg/wiki/API_C_MerchantFrame.GetItemInfo) +---@param index number +---@return string name +---@return number texture +---@return number price +---@return number stackCount +---@return number numAvailable +---@return boolean isPurchasable +---@return boolean isUsable +---@return boolean hasExtendedCost +---@return number currencyID +---@return number spellID +function GetMerchantItemInfo(index) end + +---@deprecated +---Deprecated by [C_ChallengeMode.GetChallengeCompletionInfo](https://warcraft.wiki.gg/wiki/API_C_ChallengeMode.GetChallengeCompletionInfo) +---@return number mapChallengeModeID +---@return number level +---@return number time +---@return boolean onTime +---@return number keystoneUpgradeLevels +---@return boolean practiceRun +---@return number oldOverallDungeonScore +---@return number newOverallDungeonScore +---@return boolean isAffixRecord +---@return boolean isMapRecord, 0 +---@return boolean isEligibleForScore +---@return ChallengeModeCompletionMemberInfo[] members +function C_ChallengeMode.GetCompletionInfo() end + +---@deprecated +---@return boolean +function C_MythicPlus.IsWeeklyRewardAvailable() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_7.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_7.lua new file mode 100644 index 0000000..6f68e6e --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_0_7.lua @@ -0,0 +1,18 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_QuestInfoSystem.GetQuestClassification](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestClassification) +---@param questIndex number +---@return boolean +function IsActiveQuestLegendary(questIndex) end + +---@deprecated +---Deprecated by [C_QuestInfoSystem.GetQuestClassification](https://warcraft.wiki.gg/wiki/API_C_QuestInfoSystem.GetQuestClassification) +---@param questID number +---@return boolean +function C_QuestLog.IsLegendaryQuest(questID) end + +---@deprecated +---@param questID number +---@return boolean +function C_QuestLog.IsQuestRepeatableType(questID) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_5.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_5.lua new file mode 100644 index 0000000..9f733f5 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_5.lua @@ -0,0 +1,12 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_Log.LogMessage](https://warcraft.wiki.gg/wiki/API_C_Log.LogMessage) +---@param ... string +function ConsolePrint(...) end + +---@deprecated +---Deprecated by [SetBasicMessageDialogText](https://www.townlong-yak.com/framexml/go/SetBasicMessageDialogText) +---@param text string +---@param force boolean +function message(text, force) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_7.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_7.lua new file mode 100644 index 0000000..92fbe31 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_1_7.lua @@ -0,0 +1,11 @@ +---@meta _ + +---@deprecated +---Deprecated by [ActionButtonSpellAlertManager:ShowAlert](https://www.townlong-yak.com/framexml/go/ActionButtonSpellAlertManager:ShowAlert) +---@param button table +function ActionButton_ShowOverlayGlow(button) end + +---@deprecated +---Deprecated by [ActionButtonSpellAlertManager:HideAlert](https://www.townlong-yak.com/framexml/go/ActionButtonSpellAlertManager:HideAlert) +---@param button table +function ActionButton_HideOverlayGlow(button) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_2_0.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_2_0.lua new file mode 100644 index 0000000..64492de --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_11_2_0.lua @@ -0,0 +1,12 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_SpellActivationOverlay.IsSpellOverlayed](https://warcraft.wiki.gg/wiki/API_C_SpellActivationOverlay.IsSpellOverlayed) +---@param spellID number +---@return boolean isSpellOverlayed +function IsSpellOverlayed(spellID) end + +---@deprecated +---Deprecated by [EquipmentManager_GetLocationData](https://www.townlong-yak.com/framexml/go/EquipmentManager_GetLocationData) +---@param packedLocation number +function EquipmentManager_UnpackLocation(packedLocation) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ChatInfo.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ChatInfo.lua new file mode 100644 index 0000000..e4a74ae --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ChatInfo.lua @@ -0,0 +1,9 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_ChatInfo.SendChatMessage](https://warcraft.wiki.gg/wiki/API_C_ChatInfo.SendChatMessage) +---@param message string +---@param chatType? SendChatMessageType +---@param languageID? number +---@param target? string +function SendChatMessage(message, chatType, languageID, target) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_CurrencyScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_CurrencyScript.lua new file mode 100644 index 0000000..b091c83 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_CurrencyScript.lua @@ -0,0 +1,21 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_CurrencyInfo.GetCoinIcon](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCoinIcon) +---@param amount WOWMONEY +---@return fileID result +function GetCoinIcon(amount) end + +---@deprecated +---Deprecated by [C_CurrencyInfo.GetCoinText](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCoinText) +---@param amount WOWMONEY +---@param separator? string Default = , +---@return string result +function GetCoinText(amount, separator) end + +---@deprecated +---Deprecated by [C_CurrencyInfo.GetCoinTextureString](https://warcraft.wiki.gg/wiki/API_C_CurrencyInfo.GetCoinTextureString) +---@param amount WOWMONEY +---@param fontHeight? number Default = 14 +---@return string result +function GetCoinTextureString(amount, fontHeight) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_GuildScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_GuildScript.lua new file mode 100644 index 0000000..fb17875 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_GuildScript.lua @@ -0,0 +1,39 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_GuildInfo.Invite](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Invite) +---@param name string +function GuildInvite(name) end + +---@deprecated +---Deprecated by [C_GuildInfo.Uninvite](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Uninvite) +---@param name string +function GuildUninvite(name) end + +---@deprecated +---Deprecated by [C_GuildInfo.Promote](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Promote) +---@param name string +function GuildPromote(name) end + +---@deprecated +---Deprecated by [C_GuildInfo.Demote](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Demote) +---@param name string +function GuildDemote(name) end + +---@deprecated +---Deprecated by [C_GuildInfo.SetLeader](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetLeader) +---@param name string +function GuildSetLeader(name) end + +---@deprecated +---Deprecated by [C_GuildInfo.SetMOTD](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.SetMOTD) +---@param motd string +function GuildSetMOTD(motd) end + +---@deprecated +---Deprecated by [C_GuildInfo.Leave](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Leave) +function GuildLeave() end + +---@deprecated +---Deprecated by [C_GuildInfo.Disband](https://warcraft.wiki.gg/wiki/API_C_GuildInfo.Disband) +function GuildDisband() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ItemScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ItemScript.lua new file mode 100644 index 0000000..d9b1f8a --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_ItemScript.lua @@ -0,0 +1,307 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_Item.GetItemQualityColor](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemQualityColor) +---@param quality number +---@return number colorRGBR +---@return number colorRGBG +---@return number colorRGBB +---@return string qualityString +function GetItemQualityColor(quality) end + +---@deprecated +---Deprecated by [C_Item.GetItemInfoInstant](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInfoInstant) +---@param itemInfo ItemInfo +---@return number itemID +---@return string itemType +---@return string itemSubType +---@return string itemEquipLoc +---@return fileID icon +---@return number classID +---@return number subClassID +function GetItemInfoInstant(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemSetInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSetInfo) +---@param setID number +---@return string result +function GetItemSetInfo(setID) end + +---@deprecated +---Deprecated by [C_Item.GetItemChildInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemChildInfo) +---@param itemInfo ItemInfo +---@param slotID? number +---@return number[] result +function GetItemChildInfo(itemInfo, slotID) end + +---@deprecated +---Deprecated by [C_Item.DoesItemContainSpec](https://warcraft.wiki.gg/wiki/API_C_Item.DoesItemContainSpec) +---@param itemInfo ItemInfo +---@param classID number +---@param specID? number Default = 0 +---@return boolean result +function DoesItemContainSpec(itemInfo, classID, specID) end + +---@deprecated +---Deprecated by [C_Item.GetItemGem](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemGem) +---@param hyperlink string +---@param index number +---@return string gemName +---@return string gemLink +function GetItemGem(hyperlink, index) end + +---@deprecated +---Deprecated by [C_Item.GetItemCreationContext](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemCreationContext) +---@param itemInfo ItemInfo +---@return number itemID +---@return string creationContext +function GetItemCreationContext(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemIconByID](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemIconByID) +---@param itemInfo ItemInfo +---@return fileID? icon +function GetItemIcon(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemFamily](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemFamily) +---@param itemInfo ItemInfo +---@return number? result +function GetItemFamily(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemSpell](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSpell) +---@param itemInfo ItemInfo +---@return string spellName +---@return number spellID +function GetItemSpell(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsArtifactPowerItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsArtifactPowerItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsArtifactPowerItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsCurrentItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsCurrentItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsCurrentItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsUsableItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsUsableItem) +---@param itemInfo ItemInfo +---@return boolean usable +---@return boolean noMana +function IsUsableItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsHelpfulItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsHelpfulItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsHelpfulItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsHarmfulItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsHarmfulItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsHarmfulItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsConsumableItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsConsumableItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsConsumableItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsEquippableItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsEquippableItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsEquippableItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsEquippedItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsEquippedItem) +---@param itemInfo ItemInfo +---@return boolean result +function IsEquippedItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsEquippedItemType](https://warcraft.wiki.gg/wiki/API_C_Item.IsEquippedItemType) +---@param type string +---@return boolean result +function IsEquippedItemType(type) end + +---@deprecated +---Deprecated by [C_Item.ItemHasRange](https://warcraft.wiki.gg/wiki/API_C_Item.ItemHasRange) +---@param itemInfo ItemInfo +---@return boolean result +function ItemHasRange(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsItemInRange](https://warcraft.wiki.gg/wiki/API_C_Item.IsItemInRange) +---@param itemInfo ItemInfo +---@param targetToken string +---@return boolean? result +function IsItemInRange(itemInfo, targetToken) end + +---@deprecated +---Deprecated by [C_Item.GetItemClassInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemClassInfo) +---@param itemClassID number +---@return string result +function GetItemClassInfo(itemClassID) end + +---@deprecated +---Deprecated by [C_Item.GetItemInventorySlotInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInventorySlotInfo) +---@param inventorySlot number|Enum.InventoryType +---@return string result +function GetItemInventorySlotInfo(inventorySlot) end + +---@deprecated +---Deprecated by [C_Item.BindEnchant](https://warcraft.wiki.gg/wiki/API_C_Item.BindEnchant) +function BindEnchant() end + +---@deprecated +---Deprecated by [C_Item.ActionBindsItem](https://warcraft.wiki.gg/wiki/API_C_Item.ActionBindsItem) +function ActionBindsItem() end + +---@deprecated +---Deprecated by [C_Item.ReplaceEnchant](https://warcraft.wiki.gg/wiki/API_C_Item.ReplaceEnchant) +function ReplaceEnchant() end + +---@deprecated +---Deprecated by [C_Item.ReplaceTradeEnchant](https://warcraft.wiki.gg/wiki/API_C_Item.ReplaceTradeEnchant) +function ReplaceTradeEnchant() end + +---@deprecated +---Deprecated by [C_Item.ConfirmBindOnUse](https://warcraft.wiki.gg/wiki/API_C_Item.ConfirmBindOnUse) +function ConfirmBindOnUse() end + +---@deprecated +---Deprecated by [C_Item.ConfirmOnUse](https://warcraft.wiki.gg/wiki/API_C_Item.ConfirmOnUse) +function ConfirmOnUse() end + +---@deprecated +---Deprecated by [C_Item.ConfirmNoRefundOnUse](https://warcraft.wiki.gg/wiki/API_C_Item.ConfirmNoRefundOnUse) +function ConfirmNoRefundOnUse() end + +---@deprecated +---Deprecated by [C_Item.DropItemOnUnit](https://warcraft.wiki.gg/wiki/API_C_Item.DropItemOnUnit) +---@param unitGUID UnitToken +function DropItemOnUnit(unitGUID) end + +---@deprecated +---Deprecated by [C_Item.EndBoundTradeable](https://warcraft.wiki.gg/wiki/API_C_Item.EndBoundTradeable) +---@param type string +function EndBoundTradeable(type) end + +---@deprecated +---Deprecated by [C_Item.EndRefund](https://warcraft.wiki.gg/wiki/API_C_Item.EndRefund) +---@param type number +function EndRefund(type) end + +---@deprecated +---Deprecated by [C_Item.GetItemInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemInfo) +---@param itemInfo ItemInfo +---@return string itemName +---@return string itemLink +---@return Enum.ItemQuality itemQuality +---@return number itemLevel +---@return number itemMinLevel +---@return string itemType +---@return string itemSubType +---@return number itemStackCount +---@return string itemEquipLoc +---@return fileID itemTexture +---@return number sellPrice +---@return number classID +---@return number subclassID +---@return number bindType +---@return number expansionID +---@return number? setID +---@return boolean isCraftingReagent +function GetItemInfo(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetDetailedItemLevelInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetDetailedItemLevelInfo) +---@param itemInfo ItemInfo +---@return number actualItemLevel +---@return boolean previewLevel +---@return number sparseItemLevel +function GetDetailedItemLevelInfo(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemSpecInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSpecInfo) +---@param itemInfo ItemInfo +---@return number[] specTable +function GetItemSpecInfo(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemUniqueness](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemUniqueness) +---@param itemInfo ItemInfo +---@return number limitCategory +---@return number limitMax +function GetItemUniqueness(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemCount](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemCount) +---@param itemInfo ItemInfo +---@param includeBank? boolean Default = false +---@param includeUses? boolean Default = false +---@param includeReagentBank? boolean Default = false +---@return number count +function GetItemCount(itemInfo, includeBank, includeUses, includeReagentBank) end + +---@deprecated +---Deprecated by [C_Item.PickupItem](https://warcraft.wiki.gg/wiki/API_C_Item.PickupItem) +---@param itemInfo ItemInfo +function PickupItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.GetItemSubClassInfo](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemSubClassInfo) +---@param itemClassID number +---@param itemSubClassID number +---@return string subClassName +---@return boolean subClassUsesInvType +function GetItemSubClassInfo(itemClassID, itemSubClassID) end + +---@deprecated +---Deprecated by [C_Item.UseItemByName](https://warcraft.wiki.gg/wiki/API_C_Item.UseItemByName) +---@param itemInfo ItemInfo +---@param target? string +function UseItemByName(itemInfo, target) end + +---@deprecated +---Deprecated by [C_Item.EquipItemByName](https://warcraft.wiki.gg/wiki/API_C_Item.EquipItemByName) +---@param itemInfo ItemInfo +---@param dstSlot? number +function EquipItemByName(itemInfo, dstSlot) end + +---@deprecated +---Deprecated by [C_Item.ReplaceTradeskillEnchant](https://warcraft.wiki.gg/wiki/API_C_Item.ReplaceTradeskillEnchant) +function ReplaceTradeskillEnchant() end + +---@deprecated +---Deprecated by [C_Item.GetItemCooldown](https://warcraft.wiki.gg/wiki/API_C_Item.GetItemCooldown) +---@param itemInfo ItemInfo +---@return number startTimeSeconds +---@return number durationSeconds +---@return boolean enableCooldownTimer +function GetItemCooldown(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsCorruptedItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsCorruptedItem) +---@param itemInfo ItemInfo +---@return boolean? result +function IsCorruptedItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsCosmeticItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsCosmeticItem) +---@param itemInfo ItemInfo +---@return boolean? result +function IsCosmeticItem(itemInfo) end + +---@deprecated +---Deprecated by [C_Item.IsDressableItem](https://warcraft.wiki.gg/wiki/API_C_Item.IsDressableItem) +---@param itemInfo ItemInfo +---@return boolean isDressableItem +function IsDressableItem(itemInfo) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_PvpScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_PvpScript.lua new file mode 100644 index 0000000..aa0b0bc --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_PvpScript.lua @@ -0,0 +1,22 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_PvP.IsSubZonePVPPOI](https://warcraft.wiki.gg/wiki/API_C_PvP.IsSubZonePVPPOI) +---@return boolean result +function IsSubZonePVPPOI() end + +---@deprecated +---Deprecated by [C_PvP.GetZonePVPInfo](https://warcraft.wiki.gg/wiki/API_C_PvP.GetZonePVPInfo) +---@return string pvpType +---@return boolean isSubZonePvP +---@return string? factionName +function GetZonePVPInfo() end + +---@deprecated +---Deprecated by [C_PvP.TogglePVP](https://warcraft.wiki.gg/wiki/API_C_PvP.TogglePVP) +function TogglePVP() end + +---@deprecated +---Deprecated by [C_PvP.SetPVP](https://warcraft.wiki.gg/wiki/API_C_PvP.SetPVP) +---@param enablePVP? boolean Default = false +function SetPVP(enablePVP) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SoundScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SoundScript.lua new file mode 100644 index 0000000..8cc5cdc --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SoundScript.lua @@ -0,0 +1,6 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_Sound.PlayVocalErrorSound](https://warcraft.wiki.gg/wiki/API_C_Sound.PlayVocalErrorSound) +---@param vocalErrorSoundID number|Enum.Vocalerrorsounds +function PlayVocalErrorSoundID(vocalErrorSoundID) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_Specialization_Standard.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_Specialization_Standard.lua new file mode 100644 index 0000000..68764b4 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_Specialization_Standard.lua @@ -0,0 +1,66 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_SpecializationInfo.GetNumSpecializationsForClassID](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetNumSpecializationsForClassID) +---@param classID number +---@return number specCount +function GetNumSpecializationsForClassID(classID) end + +---Deprecated by [C_SpecializationInfo.GetSpecializationInfo](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecializationInfo) +---@param specializationIndex number +---@param isInspect? boolean Default = false +---@param isPet? boolean Default = false +---@param inspectTarget? string +---@param sex? number +---@param groupIndex? number +---@return number? specId Default = 0 +---@return string? name +---@return string? description +---@return fileID? icon +---@return string? role +---@return number? primaryStat +---@return number? pointsSpent Default = 0 +---@return string? background +---@return number? previewPointsSpent Default = 0 +---@return boolean? isUnlocked Default = true +function GetSpecializationInfo(specializationIndex, isInspect, isPet, inspectTarget, sex, groupIndex) end + +---Deprecated by [C_SpecializationInfo.GetSpecialization](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecialization) +---@param isInspect? boolean +---@param isPet? boolean +---@param specGroupIndex? number +---@return number specializationIndex +function GetSpecialization(isInspect, isPet, specGroupIndex) end + +---Deprecated by [C_SpecializationInfo.GetActiveSpecGroup](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetActiveSpecGroup) +---@param isInspect? boolean +---@param isPet? boolean +---@return number groupIndex +function GetActiveSpecGroup(isInspect, isPet) end + +---Deprecated by [C_SpecializationInfo.GetSpecializationMasterySpells](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetSpecializationMasterySpells) +---@param specializationIndex number +---@param isInspect? boolean +---@param isPet? boolean +---@return number masterySpell1 +---@return number masterySpell2 +function GetSpecializationMasterySpells(specializationIndex, isInspect, isPet) end + +---Deprecated by [C_SpecializationInfo.GetTalentInfo](https://warcraft.wiki.gg/wiki/API_C_SpecializationInfo.GetTalentInfo) +---@param talentTier number +---@param talentColumn number +---@param specGroupIndex number +---@param isInspect? boolean +---@param target? string +---@return number talentID +---@return string name +---@return number icon +---@return boolean selected +---@return boolean available +---@return number spellID +---@return boolean isPVPTalentUnlocked +---@return number tier +---@return number column +---@return boolean known +---@return boolean isGrantedByAura; +function GetTalentInfo(talentTier, talentColumn, specGroupIndex, isInspect, target) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellBook.lua.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellBook.lua.lua new file mode 100644 index 0000000..bb96465 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellBook.lua.lua @@ -0,0 +1,21 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_SpellBook.IsSpellKnown](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellKnown) +---@param spellID number +---@return boolean isKnown +function IsPlayerSpell(spellID) end + +---@deprecated +---Deprecated by [C_SpellBook.IsSpellInSpellBook](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellInSpellBook) +---@param spellID number +---@param isPet boolean +---@return boolean isInSpellBook +function IsSpellKnown(spellID, isPet) end + +---@deprecated +---Deprecated by [C_SpellBook.IsSpellInSpellBook](https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellInSpellBook) +---@param spellID number +---@param isPet boolean +---@return boolean isInSpellBook +function IsSpellKnownOrOverridesKnown(spellID, isPet) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellScript.lua new file mode 100644 index 0000000..180b3e0 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_SpellScript.lua @@ -0,0 +1,22 @@ +---@meta _ + +---@deprecated +---Deprecated by [C_Spell.TargetSpellReplacesBonusTree](https://warcraft.wiki.gg/wiki/API_C_Spell.TargetSpellReplacesBonusTree) +---@return boolean result +function TargetSpellReplacesBonusTree() end + +---@deprecated +---Deprecated by [C_Spell.GetSpellQueueWindow](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellQueueWindow) +---@return number result +function GetMaxSpellStartRecoveryOffset() end + +---@deprecated +---Deprecated by [C_Spell.GetSpellQueueWindow](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSpellQueueWindow) +---@return number result +function GetSpellQueueWindow() end + +---@deprecated +---Deprecated by [C_Spell.GetSchoolString](https://warcraft.wiki.gg/wiki/API_C_Spell.GetSchoolString) +---@param schoolMask number +---@return string result +function GetSchoolString(schoolMask) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_UnitScript.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_UnitScript.lua new file mode 100644 index 0000000..828cb45 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Deprecated/Deprecated_UnitScript.lua @@ -0,0 +1,7 @@ +---@meta _ + +---@deprecated +---Deprecated by [UnitIsVisible](https://warcraft.wiki.gg/wiki/API_UnitIsVisible) +---@param unit? UnitToken Default = WOWGUID_NULL +---@return boolean result +function ShowBossFrameWhenUninteractable(unit) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/AuraUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/AuraUtil.lua new file mode 100644 index 0000000..5403603 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/AuraUtil.lua @@ -0,0 +1,50 @@ +---@meta _ +AuraUtil = {} + +---[FrameXML](https://github.com/Gethe/wow-ui-source/blob/live/Interface/FrameXML/AuraUtil.lua#L32) +-- Finds the first aura that matches the name +---@param auraName string +---@param unit string +---@param filter? string +---@return string name +---@return number icon +---@return number count +---@return string? dispelType +---@return number duration +---@return number expirationTime +---@return string source +---@return boolean isStealable +---@return boolean nameplateShowPersonal +---@return number spellId +---@return boolean canApplyAura +---@return boolean isBossDebuff +---@return boolean castByPlayer +---@return boolean nameplateShowAll +---@return number timeMod +---@return ... +function AuraUtil.FindAuraByName(auraName, unit, filter) end + +---[FrameXML](https://github.com/Gethe/wow-ui-source/blob/live/Interface/FrameXML/AuraUtil.lua#L51) +--- Iterates over a filtered list of auras +---@param unit string +---@param filter string +---@param maxCount? any +---@param func function +---@param usePackedAura? boolean +---@return string name +---@return number icon +---@return number count +---@return string? dispelType +---@return number duration +---@return number expirationTime +---@return string source +---@return boolean isStealable +---@return boolean nameplateShowPersonal +---@return number spellId +---@return boolean canApplyAura +---@return boolean isBossDebuff +---@return boolean castByPlayer +---@return boolean nameplateShowAll +---@return number timeMod +---@return ... +function AuraUtil.ForEachAura(unit, filter, maxCount, func, usePackedAura) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/BNet.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/BNet.lua new file mode 100644 index 0000000..1015136 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/BNet.lua @@ -0,0 +1,8 @@ +---@meta _ +WOW_PROJECT_ID = 0 +WOW_PROJECT_MAINLINE = 1 +WOW_PROJECT_CLASSIC = 2 +WOW_PROJECT_BURNING_CRUSADE_CLASSIC = 5 +WOW_PROJECT_WRATH_CLASSIC = 11 +WOW_PROJECT_CATACLYSM_CLASSIC = 14 +WOW_PROJECT_MISTS_CLASSIC = 19 diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ItemUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ItemUtil.lua new file mode 100644 index 0000000..b6c0a05 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ItemUtil.lua @@ -0,0 +1,25 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ItemTransmogInfoMixin) +---@class ItemTransmogInfoMixin +ItemTransmogInfoMixin = {} + +--- See [CreateAndInitFromMixin](https://www.townlong-yak.com/framexml/go/CreateAndInitFromMixin) +---@param appearanceID number +---@param secondaryAppearanceID number? +---@param illusionID number? +function ItemTransmogInfoMixin:Init(appearanceID, secondaryAppearanceID, illusionID) end + +---@param itemTransmogInfo table +---@return boolean +function ItemTransmogInfoMixin:IsEqual(itemTransmogInfo) end + +function ItemTransmogInfoMixin:Clear() end + +---@param isLegionArtifact boolean +function ItemTransmogInfoMixin:ConfigureSecondaryForMainHand(isLegionArtifact) end + +---@return boolean +function ItemTransmogInfoMixin:IsMainHandIndividualWeapon() end + +---@return boolean +function ItemTransmogInfoMixin:IsMainHandPairedWeapon() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ReportFrame.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ReportFrame.lua new file mode 100644 index 0000000..a424c99 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/ReportFrame.lua @@ -0,0 +1,41 @@ +---@meta _ +---[Documentation](https://www.townlong-yak.com/framexml/go/ReportInfoMixin) +---@class ReportInfoMixin +ReportInfoMixin = {} + +function ReportInfoMixin:Clear() end + +---@param mailIndex number +function ReportInfoMixin:SetMailIndex(mailIndex) end + +---@param clubFinderGUID string +function ReportInfoMixin:SetClubFinderGUID(clubFinderGUID) end + +---@param reportTarget string +function ReportInfoMixin:SetReportTarget(reportTarget) end + +---@param comment string +function ReportInfoMixin:SetComment(comment) end + +---@param groupFinderSearchResultID number +function ReportInfoMixin:SetGroupFinderSearchResultID(groupFinderSearchResultID) end + +---@param groupFinderApplicantID number +function ReportInfoMixin:SetGroupFinderApplicantID(groupFinderApplicantID) end + +---@param reportType Enum.ReportType +function ReportInfoMixin:SetReportType(reportType) end + +---@param majorCategory Enum.ReportMajorCategory +function ReportInfoMixin:SetReportMajorCategory(majorCategory) end + +---@param minorCategoryFlags Enum.ReportMinorCategory +function ReportInfoMixin:SetMinorCategoryFlags(minorCategoryFlags) end + +---@param petGUID string +function ReportInfoMixin:SetPetGUID(petGUID) end + +---@param reportType? Enum.ReportType +---@param majorCategory Enum.ReportMajorCategory +---@param minorCategoryFlags Enum.ReportMinorCategory +function ReportInfoMixin:SetBasicReportInfo(reportType, majorCategory, minorCategoryFlags) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/TransmogUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/TransmogUtil.lua new file mode 100644 index 0000000..4b5364d --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/TransmogUtil.lua @@ -0,0 +1,58 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/TransmogLocationMixin) +---@class TransmogPendingInfoMixin +TransmogPendingInfoMixin = {} + +--- See [CreateAndInitFromMixin](https://www.townlong-yak.com/framexml/go/CreateAndInitFromMixin) +---@param pendingType Enum.TransmogPendingType +---@param transmogID number +---@param category number +function TransmogPendingInfoMixin:Init(pendingType, transmogID, category) end + +---@class TransmogLocationType +---@field slotID? InventorySlots +---@field type? Enum.TransmogType +---@field modification? Enum.TransmogModification + +---[Documentation](https://warcraft.wiki.gg/wiki/TransmogLocationMixin) +---@class TransmogLocationMixin : TransmogLocationType +TransmogLocationMixin = {} + +---@param slotID number +---@param transmogType Enum.TransmogType +---@param modification Enum.TransmogModification +function TransmogLocationMixin:Set(slotID, transmogType, modification) end + +---@return boolean +function TransmogLocationMixin:IsAppearance() end + +---@return boolean +function TransmogLocationMixin:IsIllusion() end + +---@return number slotID +function TransmogLocationMixin:GetSlotID() end + +---@return string slotName +function TransmogLocationMixin:GetSlotName() end + +---@return boolean +function TransmogLocationMixin:IsEitherHand() end + +---@return boolean +function TransmogLocationMixin:IsMainHand() end + +---@return boolean +function TransmogLocationMixin:IsOffHand() end + +---@param transmogLocation TransmogLocationMixin +---@return boolean +function TransmogLocationMixin:IsEqual(transmogLocation) end + +---@return number armorCategoryID +function TransmogLocationMixin:GetArmorCategoryID() end + +---@return number lookupKey +function TransmogLocationMixin:GetLookupKey() end + +---@return boolean +function TransmogLocationMixin:IsSecondary() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/UIParent.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/UIParent.lua new file mode 100644 index 0000000..b9dab00 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_FrameXML/UIParent.lua @@ -0,0 +1,52 @@ +---@meta _ +---@class UIParent : Frame +---@field firstTimeLoaded number +---@field variablesLoaded boolean +UIParent = {} + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ShowUIPanel) +---@param frame Frame +---@param force? number +function ShowUIPanel(frame, force) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/HideUIPanel) +---@param frame Frame +---@param skipSetPoint? boolean +function HideUIPanel(frame, skipSetPoint) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/UIFrameFade) +--- Generic fade function +---@param frame Frame +---@param fadeInfo table +function UIFrameFade(frame, fadeInfo) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/UIFrameFadeIn) +--- Convenience function to do a simple fade in +---@param frame Frame +---@param timeToFade number +---@param startAlpha number +---@param endAlpha number +function UIFrameFadeIn(frame, timeToFade, startAlpha, endAlpha) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/UIFrameFadeOut) +--- Convenience function to do a simple fade out +---@param frame Frame +---@param timeToFade number +---@param startAlpha number +---@param endAlpha number +function UIFrameFadeOut(frame, timeToFade, startAlpha, endAlpha) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/getglobal) +---@param varr string +---@return any +function getglobal(varr) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/setglobal) +---@param varr string +---@param value any +function setglobal(varr, value) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/AbbreviateNumbers) +---@param value number +---@return string +function AbbreviateNumbers(value) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Menu.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Menu.lua new file mode 100644 index 0000000..fb7a3d8 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Menu.lua @@ -0,0 +1,37 @@ +---@meta _ + +Menu = {} + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.GetManager) +---@return MenuManagerProxy +function Menu.GetManager() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.CreateRootMenuDescription) +---@generic M: table +---@param menuMixin M +---@return RootMenuDescriptionProxy|M rootMenuDescription +function Menu.CreateRootMenuDescription(menuMixin) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.CreateMenuElementDescription) +---@return ElementMenuDescriptionProxy +function Menu.CreateMenuElementDescription() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.PopulateDescription) +---@param menuGenerator fun(ownerRegion: Region, description: RootMenuDescriptionProxy, ...) +---@param ownerRegion Region +---@param description RootMenuDescriptionProxy +---@param ... any? # passed to the generator +function Menu.PopulateDescription(menuGenerator, ownerRegion, description, ...) end + +---Can be used by addons to modify blizzard's menus in a taint-safe manner +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.ModifyMenu) +---@param tag string +---@param callback fun(ownerRegion: Region, description: RootMenuDescriptionProxy, contextData: any?) +function Menu.ModifyMenu(tag, callback) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.GetOpenMenuTags) +---@return string[] tags +function Menu.GetOpenMenuTags() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Menu.PrintOpenMenuTags) +function Menu.PrintOpenMenuTags() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuTypes.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuTypes.lua new file mode 100644 index 0000000..c935f9e --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuTypes.lua @@ -0,0 +1,24 @@ +---@meta _ + +---@alias MenuResponder fun(data: any, menuInputData: MenuInputData, menu: MenuProxy): MenuResponse? # data = element:GetData() + +---@alias MenuDescriptionInitializer fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy, menu: MenuProxy) + +---@class MenuInputData +---@field context MenuInputContext +---@field buttonName mouseButton? + +---@alias MenuResponse +---| 1 # `MenuResponse.Open` - Menu remains open and unchanged +---| 2 # `MenuResponse.Refresh` - All frames in the menu are reinitialized +---| 3 # `MenuResponse.Close` - Parent menus remain open but this menu closes +---| 4 # `MenuResponse.CloseAll` - All menus close + +---@alias MenuInputContext +---| 1 # `MenuInputContext.None` +---| 2 # `MenuInputContext.MouseButton` +---| 3 # `MenuInputContext.MouseWheel` + +---@alias MenuGridDirection +---| 2 # `MenuConstants.VerticalGridDirection` +---| 3 # `MenuConstants.HorizontalGridDirection` diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuUtil.lua new file mode 100644 index 0000000..a45ea94 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/MenuUtil.lua @@ -0,0 +1,172 @@ +---@meta _ + +MenuUtil = {} + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.TraverseMenu) +---@param elementDescription RootMenuDescriptionProxy|ElementMenuDescriptionProxy +---@param op fun(elementDescription: ElementMenuDescriptionProxy): boolean? # return true to stop traversal +---@param condition nil|fun(elementDescription: ElementMenuDescriptionProxy): boolean # return true to apply `op` to the element description; if nil, all elements are processed +---@return boolean stopped # true if the traversal was stopped by `op` returning true +function MenuUtil.TraverseMenu(elementDescription, op, condition) end + +---Return a list of all selected elements, optionally filtered by a condition +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.GetSelections) +---@param elementDescription RootMenuDescriptionProxy|ElementMenuDescriptionProxy +---@param condition nil|fun(elementDescription: ElementMenuDescriptionProxy): boolean # return true to include the element description +function MenuUtil.GetSelections(elementDescription, condition) end + +---Sets up a tooltip anchored to the right of the owner, applying the given function to it, and showing it +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.ShowTooltip) +---@param owner Region +---@param func fun(tooltip: GameTooltip, ...) +---@param ... any? +function MenuUtil.ShowTooltip(owner, func, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.HideTooltip) +---@param owner Region +function MenuUtil.HideTooltip(owner) end + +---Hooks OnEnter and OnLeave for a reagion, configures a tooltip, calls the given function, and shows the tooltip +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.HookTooltipScripts) +---@param owner Region +---@param func fun(tooltip: GameTooltip) # called both in OnEnter and OnLeave +function MenuUtil.HookTooltipScripts(owner, func) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateRootMenuDescription) +---@generic M: table +---@param menuMixin M +---@return RootMenuDescriptionProxy|M rootMenuDescription +function MenuUtil.CreateRootMenuDescription(menuMixin) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateContextMenu) +---@param ownerRegion Region? # if nil, defaults to UIParent +---@param generator fun(ownerRegion: Region, description: RootMenuDescriptionProxy, ...) +---@param ... any? # passed to the generator +---@return MenuProxy? menu +function MenuUtil.CreateContextMenu(ownerRegion, generator, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.SetElementText) +---@param elementDescription ElementMenuDescriptionProxy +---@param text string +function MenuUtil.SetElementText(elementDescription, text) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.GetElementText) +---@param elementDescription ElementMenuDescriptionProxy +---@return string text +function MenuUtil.GetElementText(elementDescription) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateFrame) +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateFrame() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateTemplate) +---@param template Template +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateTemplate(template) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateTitle) +---@param text string +---@param color colorRGBA? # defaults to NORMAL_FONT_COLOR +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateTitle(text, color) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateButton) +---@param text string +---@param callback MenuResponder +---@param data any? # stored as element's data +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateButton(text, callback, data) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateCheckbox) +---@param text string +---@param isSelected fun(data: any): boolean # data = data param -> element:GetData() +---@param setSelected MenuResponder +---@param data any? # stored as element's data +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateCheckbox(text, isSelected, setSelected, data) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateRadio) +---@param text string +---@param isSelected fun(data: any): boolean # data = data param -> element:GetData() +---@param setSelected MenuResponder +---@param data any? # stored as element's data +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateRadio(text, isSelected, setSelected, data) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateColorSwatch) +---@param text string +---@param callback MenuResponder +---@param colorInfo colorRGBA # stored as element's data +---@return ElementMenuDescriptionProxy +function MenuUtil.CreateColorSwatch(text, callback, colorInfo) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuTemplates.CreateDivider) +---@return ElementMenuDescriptionProxy # some inserters and utility functions are missing +function MenuUtil.CreateDivider() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuTemplates.CreateSpacer) +---@param extend number? # height of the spacer, default = 10 +---@return ElementMenuDescriptionProxy # some inserters and utility functions are missing +function MenuUtil.CreateSpacer(extend) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateButtonMenu) +---@param dropdown DropdownButton +---@param ... {[1]:string, [2]: MenuResponder, [3]: any?} # list of {text, callback, data} +function MenuUtil.CreateButtonMenu(dropdown, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateButtonContextMenu) +---@param ownerRegion Region? # if nil, defaults to UIParent +---@param ... {[1]:string, [2]: MenuResponder, [3]: any?} # list of {text, callback, data} +---@return MenuProxy? menu +function MenuUtil.CreateButtonContextMenu(ownerRegion, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateCheckboxMenu) +---@param dropdown DropdownButton +---@param isSelected fun(data: any): boolean # shared between all menu items +---@param setSelected MenuResponder # shared between all menu items +---@param ... {[1]:string, [2]: any?} # list of {text, data} +function MenuUtil.CreateCheckboxMenu(dropdown, isSelected, setSelected, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateCheckboxContextMenu) +---@param ownerRegion Region? # if nil, defaults to UIParent +---@param isSelected fun(data: any): boolean # shared between all menu items +---@param setSelected MenuResponder # shared between all menu items +---@param ... {[1]:string, [2]: any?} # list of {text, data} +---@return MenuProxy? menu +function MenuUtil.CreateCheckboxContextMenu(ownerRegion, isSelected, setSelected, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateRadioMenu) +---@param dropdown DropdownButton +---@param isSelected fun(data: any): boolean # shared between all menu items +---@param setSelected MenuResponder # shared between all menu items +---@param ... {[1]:string, [2]: any?} # list of {text, data} +function MenuUtil.CreateRadioMenu(dropdown, isSelected, setSelected, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateRadioContextMenu) +---@param ownerRegion Region? # if nil, defaults to UIParent +---@param isSelected fun(data: any): boolean # shared between all menu items +---@param setSelected MenuResponder # shared between all menu items +---@param ... {[1]:string, [2]: any?} # list of {text, data} +---@return MenuProxy? menu +function MenuUtil.CreateRadioContextMenu(ownerRegion, isSelected, setSelected, ...) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateEnumRadioMenu) +---@generic V +---@param dropdown DropdownButton +---@param enum table # a list of values; the value is saved as the element's data +---@param enumTranslator fun(enumValue: V): string # translate the enum value into the text to display +---@param isSelected fun(data: any): boolean # data = enum value +---@param setSelected MenuResponder +---@param orderTbl table? # optional table to specify the order of the menu buttons, defaults to ordering by enum value +function MenuUtil.CreateEnumRadioMenu(dropdown, enum, enumTranslator, isSelected, setSelected, orderTbl) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MenuUtil.CreateEnumRadioContextMenu) +---@generic V +---@param dropdown Region? # if nil, defaults to UIParent +---@param enum table # a list of values; the value is saved as the element's data +---@param enumTranslator fun(enumValue: V): string # translate the enum value into the text to display +---@param isSelected fun(data: any): boolean # data = enum value +---@param setSelected MenuResponder +---@param orderTbl table? # optional table to specify the order of the menu buttons, defaults to ordering by enum value +---@return MenuProxy? menu +function MenuUtil.CreateEnumRadioContextMenu(dropdown, enum, enumTranslator, isSelected, setSelected, orderTbl) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/ElementMenuDescriptionProxy.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/ElementMenuDescriptionProxy.lua new file mode 100644 index 0000000..44225a8 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/ElementMenuDescriptionProxy.lua @@ -0,0 +1,118 @@ +---@meta _ + +---@class ElementMenuDescriptionProxy: SharedMenuDescriptionProxy +local ElementMenuDescriptionProxy = {} + +function ElementMenuDescriptionProxy:SetSelectionIgnored() end + +---@return boolean +function ElementMenuDescriptionProxy:IsSelectionIgnored() end + +---@param data any +function ElementMenuDescriptionProxy:SetData(data) end + +---@return any data # from SetData or element creation +function ElementMenuDescriptionProxy:GetData() end + +---simulates selecting/clicking a dropdown option +---@param menuInputContext MenuInputContext +---@param menuInputButtonName mouseButton? +function ElementMenuDescriptionProxy:Pick(menuInputContext, menuInputButtonName) end + +---@param isEnabled boolean|fun(elementDescription: ElementMenuDescriptionProxy): boolean +function ElementMenuDescriptionProxy:SetEnabled(isEnabled) end + +---@return boolean +function ElementMenuDescriptionProxy:IsEnabled() end + +---@return boolean # true if a function was passed to SetEnabled() +function ElementMenuDescriptionProxy:ShouldPollEnabled() end + +---@param onLeave fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy) +function ElementMenuDescriptionProxy:SetOnLeave(onLeave) end + +---hooks OnLeave if it exists, else calls SetOnLeave +---@param onLeave fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy) +function ElementMenuDescriptionProxy:HookOnLeave(onLeave) end + +---@return nil|fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy) onLeave +function ElementMenuDescriptionProxy:GetOnLeave() end + +---@param frame Frame # frame:OnLeave(elementDescription) is called if it exists, otherwise the onLeave callback is called +function ElementMenuDescriptionProxy:HandleOnLeave(frame) end + +---@param onEnter fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy) +function ElementMenuDescriptionProxy:SetOnEnter(onEnter) end + +---hooks OnEnter if it exists, else calls SetOnEnter +---@param onEnter fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy) +function ElementMenuDescriptionProxy:HookOnEnter(onEnter) end + +---@return nil|fun(frame: Frame, elementDescription: ElementMenuDescriptionProxy) onEnter +function ElementMenuDescriptionProxy:GetOnEnter() end + +---@param frame Frame # frame:OnEnter(elementDescription) is called if it exists, otherwise the onEnter callback is called +function ElementMenuDescriptionProxy:HandleOnEnter(frame) end + +---@param canSelect boolean +function ElementMenuDescriptionProxy:SetCanSelect(canSelect) end + +---@return boolean +function ElementMenuDescriptionProxy:CanSelect() end + +---@param isSelected fun(data: any): boolean # data = element:GetData() +function ElementMenuDescriptionProxy:SetIsSelected(isSelected) end + +---@return boolean isSelected # calls the isSelected callback with the element's data; if no callback is set, returns false +function ElementMenuDescriptionProxy:IsSelected() end + +---@param isRadio boolean +function ElementMenuDescriptionProxy:SetRadio(isRadio) end + +---@return boolean +function ElementMenuDescriptionProxy:IsRadio() end + +---@param defaultResponse MenuResponse|fun(menuInputContext: MenuInputContext, menuInputButtonName: mouseButton): MenuResponse +function ElementMenuDescriptionProxy:SetResponse(defaultResponse) end + +---@param menuInputContext MenuInputContext +---@param menuInputButtonName mouseButton +---@return MenuResponse +function ElementMenuDescriptionProxy:GetDefaultResponse(menuInputContext, menuInputButtonName) end + +---@param responder MenuResponder +function ElementMenuDescriptionProxy:SetResponder(responder) end + +---hooks responder if it exists, else calls SetResponder +---@param responder MenuResponder +function ElementMenuDescriptionProxy:HookResponder(responder) end + +function ElementMenuDescriptionProxy:SetElementFactory(callback) end + +---@param soundKit number|fun(elementDescription: ElementMenuDescriptionProxy): number +function ElementMenuDescriptionProxy:SetSoundKit(soundKit) end + +---@return number soundKit +function ElementMenuDescriptionProxy:GetSoundKit() end + +---@param canPlay boolean +function ElementMenuDescriptionProxy:SetShouldPlaySoundOnSubmenuClick(canPlay) end + +---@return boolean +function ElementMenuDescriptionProxy:ShouldPlaySoundOnSubmenuClick() end + +function ElementMenuDescriptionProxy:DeactivateSubmenu() end + +---@param canRespond boolean +function ElementMenuDescriptionProxy:SetShouldRespondIfSubmenu(canRespond) end + +---@return boolean +function ElementMenuDescriptionProxy:ShouldRespondIfSubmenu() end + +---@return boolean canOpenSubmenu # true if there are subItems and opening submenus isn't blocked +function ElementMenuDescriptionProxy:CanOpenSubmenu() end + +function ElementMenuDescriptionProxy:ForceOpenSubmenu() end + +---@param callback fun(frame: Frame, descriptionProxy: ElementMenuDescriptionProxy, menuFrame: Frame, finalColumns: number, finalRows: number) +function ElementMenuDescriptionProxy:SetFinalizeGridLayout(callback) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuManagerProxy.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuManagerProxy.lua new file mode 100644 index 0000000..9f92359 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuManagerProxy.lua @@ -0,0 +1,41 @@ +---@meta _ + +---@see MenuManagerProxyMixin +---@class MenuManagerProxy +local MenuManagerProxy = {} + +---@see MenuManagerProxyMixin.GetOpenMenu +---@return MenuProxy? +function MenuManagerProxy:GetOpenMenu() end + +---@see MenuManagerProxyMixin.CloseMenu +---@param menu MenuProxy +function MenuManagerProxy:CloseMenu(menu) end + +---@see MenuManagerProxyMixin.CloseMenus +function MenuManagerProxy:CloseMenus() end + +---@see MenuManagerProxyMixin.IsAnyMenuOpen +---@return boolean +function MenuManagerProxy:IsAnyMenuOpen() end + +---@see MenuManagerProxyMixin.OpenMenu +---@param ownerRegion Region +---@param menuDescriptionProxy RootMenuDescriptionProxy +---@param anchor AnchorMixin +---@return MenuProxy? menu +function MenuManagerProxy:OpenMenu(ownerRegion, menuDescriptionProxy, anchor) end + +---@see MenuManagerProxyMixin.OpenContextMenu +---@param ownerRegion Region +---@param menuDescriptionProxy RootMenuDescriptionProxy +---@return MenuProxy? menu +function MenuManagerProxy:OpenContextMenu(ownerRegion, menuDescriptionProxy) end + +---@see MenuManagerMixin.HandleESC +function MenuManagerProxy:HandleESC() end + +---@see MenuManagerMixin.HandleGlobalMouseEvent +---@param buttonName mouseButton +---@param event FrameEvent +function MenuManagerProxy:HandleGlobalMouseEvent(buttonName, event) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuProxy.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuProxy.lua new file mode 100644 index 0000000..1efd68f --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/MenuProxy.lua @@ -0,0 +1,38 @@ +---@meta _ + +---@see MenuProxyMixin +---@class MenuProxy: Frame, MenuTemplateBase +local MenuProxy = {} + +---@see MenuProxyMixin.Close +function MenuProxy:Close() end + +---@see MenuMixin.ReinitializeAll # proxied +function MenuProxy:ReinitializeAll() end + +---@see MenuProxyMixin.GetOwnerRegion +---@return Frame +function MenuProxy:GetOwnerRegion() end + +---@see MenuProxyMixin.SendResponse +function MenuProxy:SendResponse(descriptionProxy, response) end + +---@see MenuProxyMixin.SetMenuDescription +function MenuProxy:SetMenuDescription(descriptionProxy) end + +---@see MenuMixin.SetClosedCallback # proxied +---@param onCloseCallback fun(menu: MenuProxy) +function MenuProxy:SetClosedCallback(onCloseCallback) end + +---usually you want to use SharedMenuDescriptionProxy:SetScrollMode instead +---@see MenuProxyMixin.InitScrollLayout +---@param childWidth number +---@param maxScrollExtent number # item height * number of items +function MenuProxy:InitScrollLayout(childWidth, maxScrollExtent) end + +---@see MenuProxyMixin.ClearScrollLayout +function MenuProxy:ClearScrollLayout() end + +---usually there's no need to call it manually +---@see MenuProxyMixin.OnLoad +function MenuProxy:OnLoad() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/RootMenuDescriptionProxy.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/RootMenuDescriptionProxy.lua new file mode 100644 index 0000000..e3f5729 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/RootMenuDescriptionProxy.lua @@ -0,0 +1,21 @@ +---@meta _ + +---@class RootMenuDescriptionProxy: SharedMenuDescriptionProxy +local RootMenuDescriptionProxy = {} + +---@param callback fun(menu: MenuProxy) +function RootMenuDescriptionProxy:AddMenuAcquiredCallback(callback) end + +---@param callback fun() +function RootMenuDescriptionProxy:AddMenuChangedCallback(callback) end + +---@param callback fun(menu: MenuProxy, description: SharedMenuDescriptionProxy) +function RootMenuDescriptionProxy:AddMenuResponseCallback(callback) end + +---@param callback fun(rootDescription: RootMenuDescriptionProxy) +function RootMenuDescriptionProxy:AddMenuReleasedCallback(callback) end + +function RootMenuDescriptionProxy:DisableCompositor() end + +function RootMenuDescriptionProxy:DisableReacquireFrames() end + diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/SharedMenuDescriptionProxy.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/SharedMenuDescriptionProxy.lua new file mode 100644 index 0000000..180e061 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_Menu/Proxies/SharedMenuDescriptionProxy.lua @@ -0,0 +1,139 @@ +---@meta _ + +---@class SharedMenuDescriptionProxy +local SharedMenuDescriptionProxy = {} + +---@return boolean +function SharedMenuDescriptionProxy:HasElements() end + +---@return fun(): number, ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:EnumerateElementDescriptions() end + +---@param elementDescription ElementMenuDescriptionProxy +---@param index number? # allows inserting at a specific index, default is last +function SharedMenuDescriptionProxy:Insert(elementDescription, index) end + +---@see MenuUtil.CreateTitle +---@param text string +---@param color colorRGBA? # defaults to NORMAL_FONT_COLOR +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateTitle(text, color) end + +---@see MenuUtil.CreateDivider +---@return ElementMenuDescriptionProxy # some inserters and utility functions are missing +function SharedMenuDescriptionProxy:CreateDivider() end + +---@see MenuUtil.CreateSpacer +---@param extend number? # height of the spacer, default = 10 +---@return ElementMenuDescriptionProxy # some inserters and utility functions are missing +function SharedMenuDescriptionProxy:CreateSpacer(extend) end + +---@see MenuUtil.CreateButton +---@param text string +---@param callback MenuResponder? +---@param data any? # stored as element's data +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateButton(text, callback, data) end + +---@see MenuUtil.CreateCheckbox +---@param text string +---@param isSelected fun(data: any): boolean # data = data param -> element:GetData() +---@param setSelected MenuResponder? +---@param data any? # stored as element's data +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateCheckbox(text, isSelected, setSelected, data) end + +---@see MenuUtil.CreateRadio +---@param text string +---@param isSelected fun(data: any): boolean # data = data param -> element:GetData() +---@param setSelected MenuResponder? +---@param data any? # stored as element's data +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateRadio(text, isSelected, setSelected, data) end + +---@see MenuUtil.CreateColorSwatch +---@param text string +---@param callback MenuResponder? +---@param colorInfo colorRGBA # stored as element's data +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateColorSwatch(text, callback, colorInfo) end + +---@see MenuUtil.CreateFrame +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateFrame() end + +---@see MenuUtil.CreateTemplate +---@param template Template +---@return ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:CreateTemplate(template) end + +---@see RootMenuDescriptionProxyMixin.AddQueuedDescription +---@param queuedDescription ElementMenuDescriptionProxy +function SharedMenuDescriptionProxy:AddQueuedDescription(queuedDescription) end + +---@see RootMenuDescriptionProxyMixin.ClearQueuedDescriptions +function SharedMenuDescriptionProxy:ClearQueuedDescriptions() end + +---@see MenuUtilPrivate.Utilities.QueueTitle +---@param text string +---@param color colorRGBA? # defaults to NORMAL_FONT_COLOR +---@param clearQueue boolean? # if true, all previously queued descriptions are cleared +function SharedMenuDescriptionProxy:QueueTitle(text, color, clearQueue) end + +---@see MenuUtilPrivate.Utilities.QueueDivider +---@param clearQueue boolean? # if true, all previously queued descriptions are cleared +function SharedMenuDescriptionProxy:QueueDivider(clearQueue) end + +---@see MenuUtilPrivate.Utilities.QueueSpacer +---@param extend number? # height of the spacer, default = 10 +---@param clearQueue boolean? # if true, all previously queued descriptions are cleared +function SharedMenuDescriptionProxy:QueueSpacer(extend, clearQueue) end + +---@see MenuUtilPrivate.Utilities.SetTitleAndTextTooltip +---@param title string +---@param text string +function SharedMenuDescriptionProxy:SetTitleAndTextTooltip(title, text) end + +---@see MenuUtilPrivate.Utilities.SetTooltip +---@param initializer fun(tooltip: GameTooltip, elementDescription: ElementMenuDescriptionProxy) +function SharedMenuDescriptionProxy:SetTooltip(initializer) end + +---@param initializer MenuDescriptionInitializer +---@param index number? # allows specifying an insert order, to run before / after some other initializer; default is last +function SharedMenuDescriptionProxy:AddInitializer(initializer, index) end + +---@param initializer MenuDescriptionInitializer +function SharedMenuDescriptionProxy:SetFinalInitializer(initializer) end + +---Registers a callback that will be executed when the MenuDescription's frame is cleaned up on hiding +---Especially useful if you add customizations in the Initializer that aren't reset automatically +---@param resetter fun(frame: Frame) +function SharedMenuDescriptionProxy:AddResetter(resetter) end + +---@see RootMenuDescriptionProxyMixin.GetTag +---@return string? tag +---@return any? contextData +function SharedMenuDescriptionProxy:GetTag() end + +---@see RootMenuDescriptionProxyMixin.SetTag +---@param tag string +---@param contextData any? +function SharedMenuDescriptionProxy:SetTag(tag, contextData) end + +---@return number +function SharedMenuDescriptionProxy:GetMinimumWidth() end + +---@param width number +function SharedMenuDescriptionProxy:SetMinimumWidth(width) end + +---@param width number +function SharedMenuDescriptionProxy:SetMaximumWidth(width) end + +---@param direction MenuGridDirection +---@param columns number? # if not specified, determines the number of columns based on the number of elements +---@param padding number? # defaults to 0 +---@param compactionMargin number? # defaults to disabled +function SharedMenuDescriptionProxy:SetGridMode(direction, columns, padding, compactionMargin) end + +---@param maxScrollExtent number? # item height * number of items, defaults to 200 +function SharedMenuDescriptionProxy:SetScrollMode(maxScrollExtent) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_NamePlates/Blizzard_NamePlates.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_NamePlates/Blizzard_NamePlates.lua new file mode 100644 index 0000000..cbf5b83 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_NamePlates/Blizzard_NamePlates.lua @@ -0,0 +1,38 @@ +---@meta _ +---@meta _ +---@class NamePlateFrame : Frame, NamePlateBaseMixin +local NamePlateFrame = {} + +---@class NamePlateBaseMixin +---@field UnitFrame Button +---@field driverFrame NamePlateDriverFrame +---@field namePlateUnitToken UnitToken +---@field template string +local NamePlateBaseMixin = {} + +---@param namePlateUnitToken UnitToken +---@param driverFrame NamePlateDriverFrame +function NamePlateBaseMixin:OnAdded(namePlateUnitToken, driverFrame) end + +function NamePlateBaseMixin:OnRemoved() end + +function NamePlateBaseMixin:OnOptionsUpdated() end + +function NamePlateBaseMixin:ApplyOffsets() end + +---@param insetWidth number +---@param insetHeight number +---@return number widthPadding +---@return number heightPadding +function NamePlateBaseMixin:GetAdditionalInsetPadding(insetWidth, insetHeight) end + +---@return number left +---@return number right +---@return number top +---@return number bottom +function NamePlateBaseMixin:GetPreferredInsets() end + +function NamePlateBaseMixin:OnSizeChanged() end + +--- not yet annotated, inherits NamePlateDriverMixin +---@class NamePlateDriverFrame diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ContinuableContainer.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ContinuableContainer.lua new file mode 100644 index 0000000..8000b27 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ContinuableContainer.lua @@ -0,0 +1,28 @@ +---@meta _ +---@class ContinuableContainer +ContinuableContainer = {}; + +---@return ContinuableContainer +function ContinuableContainer:Create() end + +function ContinuableContainer:AddContinuables(tbl) end + +function ContinuableContainer:AddContinuable(continuable) end + +---@return boolean checkIfSatisfied +function ContinuableContainer:ContinueOnLoad(callbackFunction) end + +---@return number numOutstanding +function ContinuableContainer:GetNumOutstandingLoads() end + +---@return number mumOutstandingLoads +function ContinuableContainer:AreAnyLoadsOutstanding() end + +function ContinuableContainer:Cancel() end + +-- "private" +---@return boolean checkIfSatisfied +function ContinuableContainer:CheckIfSatisfied() end + +---@return boolean areAllLoaded +function ContinuableContainer:RecheckEvictableContinuables() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Item.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Item.lua new file mode 100644 index 0000000..f48156a --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Item.lua @@ -0,0 +1,109 @@ +---@meta _ +Item = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/ItemMixin) +---@class ItemMixin +ItemMixin = {} + +---@param itemLocation ItemLocation +---@return ItemMixin +function Item:CreateFromItemLocation(itemLocation) end + +---@param bagID number +---@param slotIndex number +---@return ItemMixin +function Item:CreateFromBagAndSlot(bagID, slotIndex) end + +---@param equipmentSlotIndex number +---@return ItemMixin +function Item:CreateFromEquipmentSlot(equipmentSlotIndex) end + +---@param itemLink string +---@return ItemMixin +function Item:CreateFromItemLink(itemLink) end + +---@param itemID number +---@return ItemMixin +function Item:CreateFromItemID(itemID) end + +---@param itemLocation ItemLocation +function ItemMixin:SetItemLocation(itemLocation) end + +---@param itemLink string +function ItemMixin:SetItemLink(itemLink) end + +---@param itemID number +function ItemMixin:SetItemID(itemID) end + +---@return ItemLocation +function ItemMixin:GetItemLocation() end + +---@return boolean +function ItemMixin:HasItemLocation() end + +function ItemMixin:Clear() end + +---@return boolean +function ItemMixin:IsItemEmpty() end + +---@return string|number +function ItemMixin:GetStaticBackingItem() end + +---@return boolean +function ItemMixin:IsItemInPlayersControl() end + +-- Item API +---@return number +function ItemMixin:GetItemID() end + +---@return boolean +function ItemMixin:IsItemLocked() end + +function ItemMixin:LockItem() end + +function ItemMixin:UnlockItem() end + +---@return number +function ItemMixin:GetItemIcon() end + +---@return string +function ItemMixin:GetItemName() end + +---@return string +function ItemMixin:GetItemLink() end + +---@return Enum.ItemQuality +function ItemMixin:GetItemQuality() end + +---@return number +function ItemMixin:GetCurrentItemLevel() end + +---@return table +function ItemMixin:GetItemQualityColor() end + +---@return Enum.InventoryType +function ItemMixin:GetInventoryType() end + +---@return string +function ItemMixin:GetItemGUID() end + +---@return string +function ItemMixin:GetInventoryTypeName() end + +---@return boolean +function ItemMixin:IsItemDataCached() end + +---@return boolean +function ItemMixin:IsDataEvictable() end + +---@return number +function ItemMixin:GetStackCount() end + +--- Add a callback to be executed when item data is loaded, if the item data is already loaded then execute it immediately +---@param callbackFunction function +function ItemMixin:ContinueOnItemLoad(callbackFunction) end + +--- Same as ContinueOnItemLoad, except it returns a function that when called will cancel the continue +---@param callbackFunction function +---@return function +function ItemMixin:ContinueWithCancelOnItemLoad(callbackFunction) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ItemLocation.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ItemLocation.lua new file mode 100644 index 0000000..8df164b --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/ItemLocation.lua @@ -0,0 +1,66 @@ +---@meta _ +ItemLocation = {} + +---@class ItemLocation : ItemLocationData, ItemLocationMixin + +---@class ItemLocationData +---@field equipmentSlotIndex? number +---@field bagID? number +---@field slotIndex? number + +---@class ItemLocationMixin +---[Documentation](https://warcraft.wiki.gg/wiki/ItemLocationMixin) +ItemLocationMixin = {} + +---@return ItemLocation +function ItemLocation:CreateEmpty() end + +---@param bagID number +---@param slotIndex number +---@return ItemLocation +function ItemLocation:CreateFromBagAndSlot(bagID, slotIndex) end + +---@param equipmentSlotIndex number +---@return ItemLocation +function ItemLocation:CreateFromEquipmentSlot(equipmentSlotIndex) end + +function ItemLocationMixin:Clear() end + +---@param bagID number +---@param slotIndex number +function ItemLocationMixin:SetBagAndSlot(bagID, slotIndex) end + +---@return number bagID +---@return number slotIndex +function ItemLocationMixin:GetBagAndSlot() end + +---@param equipmentSlotIndex number +function ItemLocationMixin:SetEquipmentSlot(equipmentSlotIndex) end + +---@return number +function ItemLocationMixin:GetEquipmentSlot() end + +---@return boolean +function ItemLocationMixin:IsEquipmentSlot() end + +---@return boolean +function ItemLocationMixin:IsBagAndSlot() end + +---@return boolean +function ItemLocationMixin:HasAnyLocation() end + +---@return boolean +function ItemLocationMixin:IsValid() end + +---@param otherBagID number +---@param otherSlotIndex number +---@return boolean +function ItemLocationMixin:IsEqualToBagAndSlot(otherBagID, otherSlotIndex) end + +---@param otherEquipmentSlotIndex number +---@return boolean +function ItemLocationMixin:IsEqualToEquipmentSlot(otherEquipmentSlotIndex) end + +---@param otherItemLocation ItemLocation +---@return boolean +function ItemLocationMixin:IsEqualTo(otherItemLocation) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/PlayerLocation.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/PlayerLocation.lua new file mode 100644 index 0000000..180cd72 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/PlayerLocation.lua @@ -0,0 +1,158 @@ +---@meta _ +PlayerLocation = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/PlayerLocationMixin) +---@class PlayerLocationMixin +---@field unit? UnitId +---@field chatLineID? number +---@field guid? string +---@field SetGUID? function +---@field IsValid? function +---@field IsGUID? function +---@field IsBattleNetGUID? function +---@field GetGUID? function +---@field SetUnit? function +---@field IsUnit? function +---@field GetUnit? function +---@field SetChatLineID? function +---@field IsChatLineID? function +---@field GetChatLineID? function +---@field SetBattlefieldScoreIndex? function +---@field IsBattlefieldScoreIndex? function +---@field GetBattlefieldScoreIndex? function +---@field SetVoiceID? function +---@field IsVoiceID? function +---@field GetVoiceID? function +---@field SetBattleNetID? function +---@field IsBattleNetID? function +---@field GetBattleNetID? function +---@field SetCommunityData? function +---@field IsCommunityData? function +---@field SetCommunityInvitation? function +---@field IsCommunityInvitation? function +---@field Clear? function +---@field ClearAndSetField? function +PlayerLocationMixin = {} + +---@param guid string +---@return PlayerLocationMixin +function PlayerLocation:CreateFromGUID(guid) end + +---@param unit string +---@return PlayerLocationMixin +function PlayerLocation:CreateFromUnit(unit) end + +---@param lineID number +---@return PlayerLocationMixin +function PlayerLocation:CreateFromChatLineID(lineID) end + +---@param clubID string +---@param streamID string +---@param epoch number +---@param position number +---@return PlayerLocationMixin +function PlayerLocation:CreateFromCommunityChatData(clubID, streamID, epoch, position) end + +---@param clubID string +---@param guid string +---@return PlayerLocationMixin +function PlayerLocation:CreateFromCommunityInvitation(clubID, guid) end + +---@param battlefieldScoreIndex number +---@return PlayerLocationMixin +function PlayerLocation:CreateFromBattlefieldScoreIndex(battlefieldScoreIndex) end + +---@param memberID number +---@param channelID number +---@return PlayerLocationMixin +function PlayerLocation:CreateFromVoiceID(memberID, channelID) end + +---@param battleNetID number +---@return PlayerLocationMixin +function PlayerLocation:CreateFromBattleNetID(battleNetID) end + +--[[public api]] +---@param guid string +function PlayerLocationMixin:SetGUID(guid) end + +---@return boolean +function PlayerLocationMixin:IsValid() end + +---@return boolean +function PlayerLocationMixin:IsGUID() end + +---@return boolean +function PlayerLocationMixin:IsBattleNetGUID() end + +---@return string +function PlayerLocationMixin:GetGUID() end + +---@param unit string +function PlayerLocationMixin:SetUnit(unit) end + +---@return boolean +function PlayerLocationMixin:IsUnit() end + +---@return string +function PlayerLocationMixin:GetUnit() end + +---@param lineID number +function PlayerLocationMixin:SetChatLineID(lineID) end + +---@return boolean +function PlayerLocationMixin:IsChatLineID() end + +---@return number +function PlayerLocationMixin:GetChatLineID() end + +---@param index number +function PlayerLocationMixin:SetBattlefieldScoreIndex(index) end + +---@return boolean +function PlayerLocationMixin:IsBattlefieldScoreIndex() end + +---@return number +function PlayerLocationMixin:GetBattlefieldScoreIndex() end + +---@param memberID number +---@param channelID number +function PlayerLocationMixin:SetVoiceID(memberID, channelID) end + +---@return boolean +function PlayerLocationMixin:IsVoiceID() end + +---@return number voiceMemberID +---@return number voiceChannelID +function PlayerLocationMixin:GetVoiceID() end + +---@param battleNetID number +function PlayerLocationMixin:SetBattleNetID(battleNetID) end + +---@return boolean +function PlayerLocationMixin:IsBattleNetID() end + +---@return number +function PlayerLocationMixin:GetBattleNetID() end + +---@param clubID string +---@param streamID string +---@param epoch number +---@param position number +function PlayerLocationMixin:SetCommunityData(clubID, streamID, epoch, position) end + +---@return boolean +function PlayerLocationMixin:IsCommunityData() end + +---@param clubID string +---@param guid string +function PlayerLocationMixin:SetCommunityInvitation(clubID, guid) end + +---@return boolean +function PlayerLocationMixin:IsCommunityInvitation() end + +--[[private api]] +function PlayerLocationMixin:Clear() end + +---@param fieldName string +---@param field any +function PlayerLocationMixin:ClearAndSetField(fieldName, field) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Spell.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Spell.lua new file mode 100644 index 0000000..e74e960 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_ObjectAPI/Spell.lua @@ -0,0 +1,42 @@ +---@meta _ +Spell = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/SpellMixin) +---@class SpellMixin +SpellMixin = {} + +---@param spellID number +---@return SpellMixin +function Spell:CreateFromSpellID(spellID) end + +---@param spellID number +function SpellMixin:SetSpellID(spellID) end + +---@return number +function SpellMixin:GetSpellID() end + +function SpellMixin:Clear() end + +---@return boolean +function SpellMixin:IsSpellEmpty() end + +---@return boolean +function SpellMixin:IsSpellDataCached() end + +---@return string +function SpellMixin:GetSpellName() end + +---@return string +function SpellMixin:GetSpellSubtext() end + +---@return string +function SpellMixin:GetSpellDescription() end + +-- Add a callback to be executed when spell data is loaded, if the spell data is already loaded then execute it immediately +---@param callbackFunction function +function SpellMixin:ContinueOnSpellLoad(callbackFunction) end + +-- Same as ContinueOnSpellLoad, except it returns a function that when called will cancel the continue +---@param callbackFunction function +---@return function +function SpellMixin:ContinueWithCancelOnSpellLoad(callbackFunction) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Backdrop.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Backdrop.lua new file mode 100644 index 0000000..604ce8f --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Backdrop.lua @@ -0,0 +1,85 @@ +---@meta _ +---@class backdropInfo +---@field bgFile? string +---@field edgeFile? string +---@field tile? boolean +---@field tileSize? number +---@field tileEdge? boolean +---@field edgeSize? number +---@field insets? backdropInsets + +---@class backdropInsets +---@field left number +---@field right number +---@field top number +---@field bottom number + +---@class BackdropTemplate +---[Documentation](https://warcraft.wiki.gg/wiki/BackdropTemplate) +local BackdropTemplateMixin = {} +_G.BackdropTemplateMixin = BackdropTemplateMixin + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:OnBackdropLoaded) +function BackdropTemplateMixin:OnBackdropLoaded() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:OnBackdropSizeChanged) +function BackdropTemplateMixin:OnBackdropSizeChanged() end + +---@return number +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:GetEdgeSize) +function BackdropTemplateMixin:GetEdgeSize() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:SetupTextureCoordinates) +function BackdropTemplateMixin:SetupTextureCoordinates() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:SetupPieceVisuals) +function BackdropTemplateMixin:SetupPieceVisuals(piece, setupInfo, pieceLayout) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:SetBorderBlendMode) +function BackdropTemplateMixin:SetBorderBlendMode(blendMode) end + +---@param backdropInfo backdropInfo +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:HasBackdropInfo) +function BackdropTemplateMixin:HasBackdropInfo(backdropInfo) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:ClearBackdrop) +function BackdropTemplateMixin:ClearBackdrop() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:ApplyBackdrop) +function BackdropTemplateMixin:ApplyBackdrop() end + +---@param backdropInfo? backdropInfo +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:SetBackdrop) +function BackdropTemplateMixin:SetBackdrop(backdropInfo) end + +---@return backdropInfo +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:GetBackdrop) +function BackdropTemplateMixin:GetBackdrop() end + +---@return number r Returns nil if `self.backdropInfo` is not defined +---@return number g +---@return number b +---@return number a +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:GetBackdropColor) +function BackdropTemplateMixin:GetBackdropColor() end + +---@param r number +---@param g number +---@param b number +---@param a? number +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:SetBackdropColor) +function BackdropTemplateMixin:SetBackdropColor(r, g, b, a) end + +---@return number r Returns nil if `self.backdropInfo` is not defined +---@return number g +---@return number b +---@return number a +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:GetBackdropBorderColor) +function BackdropTemplateMixin:GetBackdropBorderColor() end + +---@param r number +---@param g number +---@param b number +---@param a? number +---[FrameXML](https://www.townlong-yak.com/framexml/go/BackdropTemplateMixin:SetBackdropBorderColor) +function BackdropTemplateMixin:SetBackdropBorderColor(r, g, b, a) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CallbackRegistry.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CallbackRegistry.lua new file mode 100644 index 0000000..aaedb83 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CallbackRegistry.lua @@ -0,0 +1,38 @@ +---@meta _ +---@class CallbackRegistryMixin +CallbackRegistryMixin = {} + +function CallbackRegistryMixin:SetUndefinedEventsAllowed(allowed) end + +---@return table +function CallbackRegistryMixin:GetCallbackTables() end + +---@return table +function CallbackRegistryMixin:GetCallbackTable(callbackType) end + +---@return table +function CallbackRegistryMixin:GetCallbacksByEvent(callbackType, event) end + +---@return boolean +function CallbackRegistryMixin:HasRegistrantsForEvent(event) end + +function CallbackRegistryMixin:SecureInsertEvent(event) end + +---@return any owner +function CallbackRegistryMixin:RegisterCallback(event, func, owner, ...) end + +---@return table +function CallbackRegistryMixin:RegisterCallbackWithHandle(event, func, owner, ...) end + +function CallbackRegistryMixin:TriggerEvent(event, ...) end + +function CallbackRegistryMixin:UnregisterCallback(event, owner) end + +function CallbackRegistryMixin:UnregisterEvents(eventTable) end + +function CallbackRegistryMixin:GenerateCallbackEvents(events) end + +---@return boolean +function CallbackRegistryMixin.DoesFrameHaveEvent(frame, event) end + +function CallbackRegistryMixin:OnLoad() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Color.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Color.lua new file mode 100644 index 0000000..67b5cc4 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Color.lua @@ -0,0 +1,88 @@ +---@meta _ + +---@class ColorRGBData +---@field r number +---@field g number +---@field b number +---@field colorStr? string + +---@class ColorRGBAData : ColorRGBData +---@field a number + +---@class colorRGB : ColorRGBData, ColorMixin +---@class colorRGBA : ColorRGBAData, colorRGB + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin) +---@class ColorMixin +ColorMixin = {} + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateColor) +---@param r number +---@param g number +---@param b number +---@param a? number +---@return colorRGBA +function CreateColor(r, g, b, a) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:IsEqualTo) +---@param otherColor colorRGBA +---@return boolean +function ColorMixin:IsEqualTo(otherColor) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:GetRGB) +---@return number r +---@return number g +---@return number b +function ColorMixin:GetRGB() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:GetRGBAsBytes) +---@return number r +---@return number g +---@return number b +function ColorMixin:GetRGBAsBytes() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:GetRGBA) +---@return number r +---@return number g +---@return number b +---@return number? a +function ColorMixin:GetRGBA() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:GetRGBAAsBytes) +---@return number r +---@return number g +---@return number b +---@return number? a +function ColorMixin:GetRGBAAsBytes() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:SetRGBA) +---@param r number +---@param g number +---@param b number +---@param a? number +function ColorMixin:SetRGBA(r, g, b, a) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:SetRGB) +---@param r number +---@param g number +---@param b number +function ColorMixin:SetRGB(r, g, b) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:GenerateHexColor) +---@return string +function ColorMixin:GenerateHexColor() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:GenerateHexColorMarkup) +---@return string +function ColorMixin:GenerateHexColorMarkup() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ColorMixin:WrapTextInColorCode) +---@param text string +---@return string +function ColorMixin:WrapTextInColorCode(text) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/WrapTextInColorCode) +---@param text string +---@param colorHexString string +---@return string +function WrapTextInColorCode(text, colorHexString) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/ColorUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/ColorUtil.lua new file mode 100644 index 0000000..7979e14 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/ColorUtil.lua @@ -0,0 +1,44 @@ +---@meta _ + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateColorFromHexString) +---@param hexColor string +---@return colorRGBA +function CreateColorFromHexString(hexColor) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateColorFromBytes) +---@param r number +---@param g number +---@param b number +---@param a number +---@return colorRGBA +function CreateColorFromBytes(r, g, b, a) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/AreColorsEqual) +---@param left colorRGBA +---@param right colorRGBA +---@return boolean +function AreColorsEqual(left, right) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetClassColor) +---@param classFilename ClassFile +---@return number r +---@return number g +---@return number b +---@return string colorStr +function GetClassColor(classFilename) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetClassColorObj) +---@param classFilename string +---@return colorRGB +function GetClassColorObj(classFilename) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetClassColoredTextForUnit) +---@param unit string +---@param text string +---@return string +function GetClassColoredTextForUnit(unit, text) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetFactionColor) +---@param factionGroupTag string +---@return colorRGBA +function GetFactionColor(factionGroupTag) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CvarUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CvarUtil.lua new file mode 100644 index 0000000..1536ae6 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/CvarUtil.lua @@ -0,0 +1,62 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.RegisterCVar) +---@param name CVar +---@param value? string +function RegisterCVar(name, value) + C_CVar.RegisterCVar(name, value); +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.ResetTestCVars) +function ResetTestCvars() + C_CVar.ResetTestCVars(); +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.SetCVar) +---@param name CVar +---@param value? boolean|string|number +---@return boolean success +function SetCVar(name, value) + if type(value) == "boolean" then + return C_CVar.SetCVar(name, value and "1" or "0"); + else + return C_CVar.SetCVar(name, value and tostring(value) or nil); + end +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVar) +---@param name CVar +---@return string? value +function GetCVar(name) + return C_CVar.GetCVar(name); +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.SetCVarBitfield) +---@param name CVar +---@param index number +---@param value boolean +---@return boolean success +function SetCVarBitfield(name, index, value) + return C_CVar.SetCVarBitfield(name, index, value); +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarBitfield) +---@param name CVar +---@param index number +---@return boolean? value +function GetCVarBitfield(name, index) + return C_CVar.GetCVarBitfield(name, index); +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarBool) +---@param name CVar +---@return boolean? value +function GetCVarBool(name) + return C_CVar.GetCVarBool(name); +end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_C_CVar.GetCVarDefault) +---@param name CVar +---@return string? defaultValue +function GetCVarDefault(name) + return C_CVar.GetCVarDefault(name); +end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Dump.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Dump.lua new file mode 100644 index 0000000..01b5c9d --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Dump.lua @@ -0,0 +1,5 @@ +---@meta _ +---[FrameXML](https://www.townlong-yak.com/framexml/go/DevTools_Dump) +---@param value any +---@param startKey? string +function DevTools_Dump(value, startKey) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/FormattingUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/FormattingUtil.lua new file mode 100644 index 0000000..25e4074 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/FormattingUtil.lua @@ -0,0 +1,72 @@ +---@meta _ +---[FrameXML](https://www.townlong-yak.com/framexml/go/SplitTextIntoLines) +---@param text string +---@param delimiter string +---@return string[] +function SplitTextIntoLines(text, delimiter) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SplitTextIntoHeaderAndNonHeader) +---@param text string +---@return string? header +---@return string? nonHeader +function SplitTextIntoHeaderAndNonHeader(text) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FormatValueWithSign) +---@param value number +---@return string +function FormatValueWithSign(value) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FormatLargeNumber) +---@param amount string|number +---@return string +function FormatLargeNumber(amount) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetMoneyString) +---@param money number +---@param separateThousands? boolean +---@return string +function GetMoneyString(money, separateThousands) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FormatPercentage) +---@param percentage number +---@param roundToNearestInteger? boolean +---@return string +function FormatPercentage(percentage, roundToNearestInteger) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FormatFraction) +---@param numerator number +---@param denominator number +---@return string +function FormatFraction(numerator, denominator) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetHighlightedNumberDifferenceString) +---@param baseString string +---@param newString string +---@return string +function GetHighlightedNumberDifferenceString(baseString, newString) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FormatUnreadMailTooltip) +---@param tooltip GameTooltip +---@param headerText string +---@param senders string[] +function FormatUnreadMailTooltip(tooltip, headerText, senders) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetCurrencyString) +---@param currencyID number +---@param overrideAmount? number +---@param colorCode? string +---@param abbreviate? boolean +---@return string +function GetCurrencyString(currencyID, overrideAmount, colorCode, abbreviate) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetCurrenciesString) +---@param currencies number[] | table[] an array of currencyIDs, or a table with e.g. `{currencyID=x, amount=y} ` +---@return string +function GetCurrenciesString(currencies) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ReplaceGenderTokens) +--- This is a very simple parser that will only handle $G/$g tokens +---@param string string +---@param gender string +---@return string +function ReplaceGenderTokens(string, gender) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/GlobalCallbackRegistry.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/GlobalCallbackRegistry.lua new file mode 100644 index 0000000..38c0bd1 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/GlobalCallbackRegistry.lua @@ -0,0 +1,29 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/EventRegistry) +EventRegistry = CreateFromMixins(CallbackRegistryMixin) + +-- function EventRegistry:OnLoad() end + +---@param frameEvent FrameEvent +---@param value number +function EventRegistry:OnAttributeChanged(frameEvent, value) end + +---@param frameEvent FrameEvent +function EventRegistry:RegisterFrameEvent(frameEvent) end + +---@param frameEvent FrameEvent +function EventRegistry:UnregisterFrameEvent(frameEvent) end + +---@param frameEvent FrameEvent +---@return any owner +function EventRegistry:RegisterFrameEventAndCallback(frameEvent, ...) end + +---@param frameEvent FrameEvent +---@return table +function EventRegistry:RegisterFrameEventAndCallbackWithHandle(frameEvent, ...) end + +---@param frameEvent FrameEvent +function EventRegistry:UnregisterFrameEventAndCallback(frameEvent, ...) end + +---@return string +function EventRegistry:GetEventCounts(...) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Mixin.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Mixin.lua new file mode 100644 index 0000000..8990e73 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Mixin.lua @@ -0,0 +1,38 @@ +---@meta _ +---[FrameXML](https://www.townlong-yak.com/framexml/go/Mixin) +--- Copies mixins into an existing object +---@generic T1, T2 +---@param object T1 +---@param ... T2 +---@return T1|T2 mixin +function Mixin(object, ...) + for i = 1, select("#", ...) do + local mixin = select(i, ...); + for k, v in pairs(mixin) do + object[k] = v; + end + end + return object; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateFromMixins) +--- Copies mixins into a new object +---@generic T1, T2 +---@param mixin T1 +---@param ... T2 +---@return T1|T2 mixin +function CreateFromMixins(mixin, ...) + return Mixin({}, mixin, ...) +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateAndInitFromMixin) +--- Copies mixins into a new object and initializes it +---@generic T +---@param mixin T +---@param ... any +---@return T mixin +function CreateAndInitFromMixin(mixin, ...) + local object = CreateFromMixins(mixin); + object:Init(...); + return object; +end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TableUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TableUtil.lua new file mode 100644 index 0000000..6d16698 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TableUtil.lua @@ -0,0 +1,233 @@ +---@meta _ +local function ripairsiter(table, index) + index = index - 1; + if index > 0 then + return index, table[index]; + end +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ripairs) +-- Reverse iterates over a sequential table. Example: +-- ``` +-- for i, v in ripairs(tbl) do body end +-- ``` +---@param tbl table +---@return function iter +---@return table invariant +---@return number init +function ripairs(tbl) + return ripairsiter, tbl, #tbl + 1; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tDeleteItem) +-- Removes a value from a sequential table. +---@param tbl table +---@param item any +function tDeleteItem(tbl, item) + local index = 1; + while tbl[index] do + if ( item == tbl[index] ) then + tremove(tbl, index); + else + index = index + 1; + end + end +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tIndexOf) +-- Returns the index for a value in a table. +---@param tbl table +---@param item any +---@return number? index +function tIndexOf(tbl, item) + for i, v in ipairs(tbl) do + if item == v then + return i; + end + end +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tContains) +-- Returns true if a table contains a value. +---@param tbl table +---@param item any +---@return boolean +function tContains(tbl, item) + for k, v in pairs(tbl) do + if item == v then + return true; + end + end + return false; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tCompare) +-- This is a deep compare on the values of the table (based on depth) but not a deep comparison +-- of the keys, as this would be an expensive check and won't be necessary in most cases. +---@param lhsTable table +---@param rhsTable table +---@param depth? number +---@return boolean +function tCompare(lhsTable, rhsTable, depth) + depth = depth or 1; + for key, value in pairs(lhsTable) do + if type(value) == "table" then + local rhsValue = rhsTable[key]; + if type(rhsValue) ~= "table" then + return false; + end + if depth > 1 then + if not tCompare(value, rhsValue, depth - 1) then + return false; + end + end + elseif value ~= rhsTable[key] then + return false; + end + end + + -- Check for any keys that are in rhsTable and not lhsTable. + for key, value in pairs(rhsTable) do + if lhsTable[key] == nil then + return false; + end + end + + return true; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tInvert) +-- Returns an inverted table. +---@param tbl table +---@return table +function tInvert(tbl) + local inverted = {}; + for k, v in pairs(tbl) do + inverted[v] = k; + end + return inverted; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tFilter) +---@param tbl table +---@param pred function +---@param isIndexTable boolean +---@return table +function tFilter(tbl, pred, isIndexTable) + local out = {}; + + if (isIndexTable) then + local currentIndex = 1; + for i, v in ipairs(tbl) do + if (pred(v)) then + out[currentIndex] = v; + currentIndex = currentIndex + 1; + end + end + else + for k, v in pairs(tbl) do + if (pred(v)) then + out[k] = v; + end + end + end + + return out; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tAppendAll) +-- Appends the contents of a sequential table to another table. +---@param tbl table +---@param addedArray table +function tAppendAll(tbl, addedArray) + for i, element in ipairs(addedArray) do + tinsert(tbl, element); + end +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/tUnorderedRemove) +---@param tbl table +---@param index number +function tUnorderedRemove(tbl, index) + if index ~= #tbl then + tbl[index] = tbl[#tbl]; + end + + table.remove(tbl); +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CopyTable) +-- Returns a deep copy of a table. +---@param settings table +---@param shallow? boolean +---@return table +function CopyTable(settings, shallow) + local copy = {}; + for k, v in pairs(settings) do + if type(v) == "table" and not shallow then + copy[k] = CopyTable(v); + else + copy[k] = v; + end + end + return copy; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/AccumulateIf) +---@param tbl table +---@param pred function +---@return number +function AccumulateIf(tbl, pred) + local count = 0; + for k, v in pairs(tbl) do + if pred(v) then + count = count + 1; + end + end + return count; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ContainsIf) +---@param tbl table +---@param pred function +---@return boolean +function ContainsIf(tbl, pred) + for k, v in pairs(tbl) do + if (pred(v)) then + return true; + end + end + + return false; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FindInTableIf) +---@param tbl table +---@param pred function +---@return string|number key +---@return any value +function FindInTableIf(tbl, pred) + for k, v in pairs(tbl) do + if (pred(v)) then + return k, v; + end + end + ---@diagnostic disable-next-line: return-type-mismatch + return nil; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SafePack) +---@param ... any +---@return table +function SafePack(...) + local tbl = { ... }; + tbl.n = select("#", ...); + return tbl; +end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SafeUnpack) +---@param tbl table +---@return ... +function SafeUnpack(tbl) + return unpack(tbl, 1, tbl.n); +end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TextureUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TextureUtil.lua new file mode 100644 index 0000000..a694d84 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TextureUtil.lua @@ -0,0 +1,148 @@ +---@meta _ +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetTextureInfo) +---@param obj Texture +---@return string assetName +---@return string assetType +---@return number ulX +---@return number ulY +---@return number blX +---@return number blY +---@return number urX +---@return number urY +---@return number brX +---@return number brY +function GetTextureInfo(obj) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SetClampedTextureRotation) +---@param texture Texture +---@param rotationDegrees number +function SetClampedTextureRotation(texture, rotationDegrees) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/ClearClampedTextureRotation) +---@param texture Texture +function ClearClampedTextureRotation(texture) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetMicroIconForRole +---@param role string +---@return string icon +function GetMicroIconForRole(role) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetTexCoordsByGrid) +---@param xOffset number +---@param yOffset number +---@param textureWidth number +---@param textureHeight number +---@param gridWidth number +---@param gridHeight number +---@return number minX +---@return number maxX +---@return number minY +---@return number maxY +function GetTexCoordsByGrid(xOffset, yOffset, textureWidth, textureHeight, gridWidth, gridHeight) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetTexCoordsForRole) +---@param role string +---@return number minX +---@return number maxX +---@return number minY +---@return number maxY +function GetTexCoordsForRole(role) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateTextureMarkup) +---@param file number|string +---@param fileWidth number +---@param fileHeight number +---@param width number +---@param height number +---@param left number +---@param right number +---@param top number +---@param bottom number +---@param xOffset? number +---@param yOffset? number +---@return string +function CreateTextureMarkup(file, fileWidth, fileHeight, width, height, left, right, top, bottom, xOffset, yOffset) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateAtlasMarkup) +---@param atlasName number|string +---@param width? number +---@param height? number +---@param offsetX? number +---@param offsetY? number +---@param rVertexColor? number +---@param gVertexColor? number +---@param bVertexColor? number +---@return string +function CreateAtlasMarkup(atlasName, width, height, offsetX, offsetY, rVertexColor, gVertexColor, bVertexColor) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateAtlasMarkupWithAtlasSize) +---@param atlasName number|string +---@param offsetX? number +---@param offsetY? number +---@param rVertexColor? number +---@param gVertexColor? number +---@param bVertexColor? number +---@return string +function CreateAtlasMarkupWithAtlasSize(atlasName, offsetX, offsetY, rVertexColor, gVertexColor, bVertexColor, scale) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SetupAtlasesOnRegions) +--- Pass in a frame and a table containing parentKeys (on frame) as keys and atlas member names as the values +---@param frame Frame +---@param regionsToAtlases table +---@param useAtlasSize? boolean +function SetupAtlasesOnRegions(frame, regionsToAtlases, useAtlasSize) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetFinalNameFromTextureKit) +---@param fmt string +---@param textureKits string|table +---@return string +function GetFinalNameFromTextureKit(fmt, textureKits) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SetupTextureKitOnFrame) +--- Pass in a TextureKit name, a frame and a formatting string. +--- The TextureKit name will be inserted into fmt (at the first %s). The resulting atlas name will be set on frame +--- Use "%s" for fmt if the TextureKit name is the entire atlas element name +---@param textureKit string|table +---@param frame Texture|StatusBar +---@param fmt string +---@param setVisibility boolean +---@param useAtlasSize? boolean +function SetupTextureKitOnFrame(textureKit, frame, fmt, setVisibility, useAtlasSize) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SetupTextureKitOnFrames) +--- Pass in a TextureKit name and a table containing frames as keys and formatting strings as values +--- For each frame key in frames, the TextureKit name will be inserted into fmt (at the first %s). The resulting atlas name will be set on frame +--- Use "%s" for fmt if the TextureKit name is the entire atlas element name +---@param textureKit string|table +---@param frames table +---@param setVisibilityOfRegions boolean +---@param useAtlasSize? boolean +function SetupTextureKitOnFrames(textureKit, frames, setVisibilityOfRegions, useAtlasSize) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SetupTextureKitOnRegions) +--- Pass in a TextureKit name, a frame and a table containing parentKeys (on frame) as keys and formatting strings as values +--- For each frame key in frames, the TextureKit name will be inserted into fmt (at the first %s). The resulting atlas name will be set on frame +--- Use "%s" for fmt if the TextureKit name is the entire atlas element name +---@param textureKit string|table +---@param frame Frame +---@param regions table +---@param setVisibilityOfRegions boolean +---@param useAtlasSize? boolean +function SetupTextureKitOnRegions(textureKit, frame, regions, setVisibilityOfRegions, useAtlasSize) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SetupTextureKitsFromRegionInfo) +--- Pass in a TextureKit name, a frame and a table containing parentKeys (on frame) as keys and a table as values +--- The values table should contain formatString as a member (setVisibility and useAtlasSize can also be added if desired) +--- For each frame key in frames, the TextureKit name will be inserted into formatString (at the first %s). The resulting atlas name will be set on frame +--- Use "%s" for formatString if the TextureKit name is the entire atlas element name +---@param textureKit string|table +---@param frame Frame +---@param regionInfoList table +function SetupTextureKitsFromRegionInfo(textureKit, frame, regionInfoList) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/GetFinalAtlasFromTextureKitIfExists) +--- Pass the texture and the textureKit, if the atlas exists in data then it will return the actual atlas name otherwise, return nil. +---@param texture string +---@param textureKit string|table +---@return string? +function GetFinalAtlasFromTextureKitIfExists(texture, textureKit) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TimeUtil.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TimeUtil.lua new file mode 100644 index 0000000..d42f966 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/TimeUtil.lua @@ -0,0 +1,50 @@ +---@meta _ +---[FrameXML](https://www.townlong-yak.com/framexml/go/SecondsToMinutes) +---@param seconds number +---@return number +function SecondsToMinutes(seconds) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MinutesToSeconds) +---@param minutes number +---@return number +function MinutesToSeconds(minutes) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/HasTimePassed) +---@param testTime number +---@param amountOfTime number +---@return boolean +function HasTimePassed(testTime, amountOfTime) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SecondsToClock) +---@param seconds number +---@param displayZeroHours? boolean +---@return string +function SecondsToClock(seconds, displayZeroHours) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SecondsToTime) +---@param seconds number +---@param noSeconds? boolean +---@param notAbbreviated? boolean +---@param maxCount? number +---@param roundUp? boolean +---@return string +function SecondsToTime(seconds, noSeconds, notAbbreviated, maxCount, roundUp) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/MinutesToTime) +---@param mins number +---@param hideDays? boolean +---@return string +function MinutesToTime(mins, hideDays) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/SecondsToTimeAbbrev) +---@param seconds number +---@return string format +---@return number time +function SecondsToTimeAbbrev(seconds) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/FormatShortDate) +---@param day number +---@param month number +---@param year number +---@return string +function FormatShortDate(day, month, year) end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector2D.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector2D.lua new file mode 100644 index 0000000..a11b804 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector2D.lua @@ -0,0 +1,84 @@ +---@meta _ + +---@class Vector2DType +---@field x number +---@field y number + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin) +---@class Vector2DMixin : Vector2DType +Vector2DMixin = {} + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateVector2D) +---@param x number +---@param y number +---@return Vector2DMixin +function CreateVector2D(x, y) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/AreVector2DEqual) +---@param left Vector2DMixin +---@param right Vector2DMixin +---@return boolean +function AreVector2DEqual(left, right) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:IsEqualTo) +---@param otherVector Vector2DMixin +---@return boolean +function Vector2DMixin:IsEqualTo(otherVector) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:GetXY) +---@return number x +---@return number y +function Vector2DMixin:GetXY() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:SetXY) +---@param x number +---@param y number +function Vector2DMixin:SetXY(x, y) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:ScaleBy) +---@param scalar number +function Vector2DMixin:ScaleBy(scalar) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:DivideBy) +---@param scalar number +function Vector2DMixin:DivideBy(scalar) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:Add) +---@param other Vector2DMixin +function Vector2DMixin:Add(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:Subtract) +---@param other Vector2DMixin +function Vector2DMixin:Subtract(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:Cross) +---@param other Vector2DMixin +function Vector2DMixin:Cross(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:Dot) +---@param other Vector2DMixin +---@return number +function Vector2DMixin:Dot(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:IsZero) +---@return boolean +function Vector2DMixin:IsZero() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:GetLengthSquared) +---@return number +function Vector2DMixin:GetLengthSquared() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:GetLength) +---@return number +function Vector2DMixin:GetLength() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:Normalize) +function Vector2DMixin:Normalize() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:RotateDirection) +---@param rotationRadians number +function Vector2DMixin:RotateDirection(rotationRadians) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector2DMixin:Clone) +---@return Vector2DMixin +function Vector2DMixin:Clone() end diff --git a/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector3D.lua b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector3D.lua new file mode 100644 index 0000000..6cd61f6 --- /dev/null +++ b/docs/annotations/Annotations/Core/FrameXML/Blizzard_SharedXML/Vector3D.lua @@ -0,0 +1,80 @@ +---@meta _ + +---@class Vector3DType +---@field x number +---@field y number +---@field z number + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin) +---@class Vector3DMixin : Vector3DType +Vector3DMixin = {} + +---[FrameXML](https://www.townlong-yak.com/framexml/go/CreateVector3D) +---@param x number +---@param y number +---@param z number +---@return Vector3DMixin +function CreateVector3D(x, y, z) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/AreVector3DEqual) +---@param left Vector3DMixin +---@param right Vector3DMixin +---@return boolean +function AreVector3DEqual(left, right) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:IsEqualTo) +---@param otherVector Vector3DMixin +---@return boolean +function Vector3DMixin:IsEqualTo(otherVector) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:GetXYZ) +---@return number x +---@return number y +---@return number z +function Vector3DMixin:GetXYZ() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:SetXYZ) +---@param x number +---@param y number +---@param z number +function Vector3DMixin:SetXYZ(x, y, z) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:ScaleBy) +---@param scalar number +function Vector3DMixin:ScaleBy(scalar) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:DivideBy) +---@param scalar number +function Vector3DMixin:DivideBy(scalar) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:Add) +---@param other Vector3DMixin +function Vector3DMixin:Add(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:Subtract) +---@param other Vector3DMixin +function Vector3DMixin:Subtract(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:Cross) +---@param other Vector3DMixin +function Vector3DMixin:Cross(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:Dot) +---@param other Vector3DMixin +---@return number +function Vector3DMixin:Dot(other) end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:GetLengthSquared) +---@return number +function Vector3DMixin:GetLengthSquared() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:GetLength) +---@return number +function Vector3DMixin:GetLength() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:Normalize) +function Vector3DMixin:Normalize() end + +---[FrameXML](https://www.townlong-yak.com/framexml/go/Vector3DMixin:Clone) +---@return Vector3DMixin +function Vector3DMixin:Clone() end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceAddon-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceAddon-3.0.lua new file mode 100644 index 0000000..721b8cf --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceAddon-3.0.lua @@ -0,0 +1,192 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- AceAddon-3.0 +-- ---------------------------------------------------------------------------- + +---@class AceAddon-3.0 +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0) +local lib = {} + +---@param name string +---@param silent? boolean +---@return AceAddon +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-15) +function lib:GetAddon(name, silent) end + +---@return function iter +---@return table invariant +---@return number init +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-16) +function lib:IterateAddonStatus() end + +---@return function iter +---@return table invariant +---@return number init +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-17) +function lib:IterateAddons() end + +---@param object table +---@param name string +---@param ...? string List of libraries to embed into the addon +---@return table|AceAddon +---@overload fun(self, name: string, ...: string): table|AceAddon +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-18) +function lib:NewAddon(object, name, ...) end + +-- ---------------------------------------------------------------------------- +-- AceAddon +-- ---------------------------------------------------------------------------- + +---@class AceAddon +---@field defaultModuleLibraries table +---@field defaultModuleState boolean +---@field enabledState boolean +---@field modules { [string]: AceModule } +---@field name string +---@field orderedModules AceModule[] +local addon = {} + +-- Disables the Addon, if possible. +---@return boolean success +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-2) +function addon:Disable() end + +-- Disables the Module, if possible. +---@param name string +---@return boolean success +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-3) +function addon:DisableModule(name) end + +-- Enables the Addon, if possible. +---@return boolean success +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-4) +function addon:Enable() end + +-- Enables the Module, if possible. +---@param name string +---@return boolean success +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-5) +function addon:EnableModule(name) end + +-- Return the specified module from an Addon object. +---@param name string Unique name of the Module +---@param silent? boolean If true, the module is optional. Silently return nil if its not found. +---@return AceModule module +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-6) +function addon:GetModule(name, silent) end + +-- Returns the real name of the Addon or Module, without any prefix. +---@return string name +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-7) +function addon:GetName() end + +-- Query the enabledState of an Addon. +---@return boolean enabled +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-8) +function addon:IsEnabled() end + +-- Returns whether or not the object is a Module. +---@return boolean isModule +function addon:IsModule() end + +-- Return an iterator of all modules associated to the addon. +---@return function iter +---@return table invariant +---@return number init +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-9) +function addon:IterateModules() end + +-- Create a new module for the addon. +-- +-- The new module can have its own embeded libraries and/or use a module prototype to be mixed into the module. +-- +-- A module has the same functionality as a real addon, it can have modules of its own, and has the same API as an addon object. +---@param name string +---@param ... string List of libraries to embed into the addon +---@return AceModule +---@overload fun(self, name: string, prototype: table, ...: string) +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-10) +function addon:NewModule(name, ...) end + +-- dont define .OnInitialize, .OnEnable, .OnDisable since this would trigger `duplicate-set-field` diagnostic +-- those methods technically only exist when defined by the user + +-- Callback function called when your addon is manually being disabled. +-- function addon:OnDisable() end + +-- Callback function called during the PLAYER_LOGIN event, when most of the data provided by the game is already present. +-- function addon:OnEnable() end + +-- Callback function called directly after the addon is fully loaded. +-- function addon:OnInitialize() end + +-- Set the default libraries to be mixed into all modules created by this object. +-- +-- Note that you can only change the default module libraries before any module is created. +---@param ... string List of libraries to embed into the addon +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-11) +function addon:SetDefaultModuleLibraries(...) end + +-- Set the default prototype to use for new modules on creation. +-- +-- Note that you can only change the default prototype before any module is created. +---@param prototype table +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-12) +function addon:SetDefaultModulePrototype(prototype) end + +-- Set the default state in which new modules are being created. +-- +-- Note that you can only change the default state before any module is created. +---@param state boolean +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-13) +function addon:SetDefaultModuleState(state) end + +-- Set the state of an addon or module This should only be called before any enabling actually happend, e.g. in/before OnInitialize. +---@param state boolean +-- +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-addon-3-0#title-14) +function addon:SetEnabledState(state) end + +-- ---------------------------------------------------------------------------- +-- AceModule +-- ---------------------------------------------------------------------------- + +---@class AceModule : AceAddon +---@field moduleName string +local module = {} diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceBucket-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceBucket-3.0.lua new file mode 100644 index 0000000..afec411 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceBucket-3.0.lua @@ -0,0 +1,31 @@ +---@meta _ +-- ---------------------------------------------------------------------------- +-- AceBucket-3.0 +-- ---------------------------------------------------------------------------- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-bucket-3-0) +---@class AceBucket-3.0 +local AceBucket = {} + +---@param event FrameEvent|FrameEvent[] The event to listen for, or a table of events. +---@param interval number The Bucket interval (burst interval) +---@param callback? function|string The callback function to call when the event is triggered (funcref or method, defaults to a method with the event name) +--- --- +---@return string bucketHandle -- The handle of the bucket (for unregistering) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-bucket-3-0#title-2) +function AceBucket:RegisterBucketEvent(event, interval, callback) end + +---@param message string|string[] The message to listen for, or a table of messages. +---@param interval number The Bucket interval (burst interval) +---@param callback? function|string The callback function, either as a function reference, or a string pointing to a method of the addon object. +--- --- +---@return string bucketHandle -- The handle of the bucket (for unregistering) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-bucket-3-0#title-3) +function AceBucket:RegisterBucketMessage(message, interval, callback) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-bucket-3-0#title-4) +function AceBucket:UnregisterAllBuckets() end + +---@param handle string The handle of the bucket as returned by RegisterBucket +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-bucket-3-0#title-5) +function AceBucket:UnregisterBucket(handle) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceComm-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceComm-3.0.lua new file mode 100644 index 0000000..c09bdf6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceComm-3.0.lua @@ -0,0 +1,54 @@ +---@meta _ +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-comm-3-0) +---@class AceComm-3.0 +local AceComm = {} + +---@param prefix string A printable character (\032-\255) classification of the message (typically AddonName or AddonNameEvent), max 16 characters +---@param method? function|string OPTIONAL: Callback to call on message reception: Function reference, or method name (string) to call on self. Defaults to "OnCommReceived" +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-comm-3-0#title-1) +function AceComm:RegisterComm(prefix, method) end + +---@param eventname string +function AceComm:UnregisterComm(eventname) end + +---@param ... table +function AceComm:UnregisterAllComm(...) end + +---@param prefix string A printable character (\032-\255) classification of the message (typically AddonName or AddonNameEvent) +---@param text string Data to send, nils (\000) not allowed. Any length. +---@param distribution string Addon channel, e.g. "RAID", "GUILD", etc; see SendAddonMessage API +---@param target string? Destination for some distributions; see SendAddonMessage API +---@param prio "BULK"|"NORMAL"|"ALERT"? OPTIONAL: ChatThrottleLib priority, "BULK", "NORMAL" or "ALERT". Defaults to "NORMAL". +---@param callbackFn function? OPTIONAL: callback function to be called as each chunk is sent. receives 3 args: the user supplied arg (see next), the number of bytes sent so far, and the number of bytes total to send. +---@param callbackArg ...? OPTIONAL: first arg to the callback function. nil will be passed if not specified. +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-comm-3-0#title-1) +function AceComm:SendCommMessage(prefix, text, distribution, target, prio, callbackFn, callbackArg) end + +---@param target table +function AceComm:Embed(target) end + +---@param target table +function AceComm:OnEmbedDisable(target) end + +---@protected +---@param prefix string +---@param message string +---@param distribution string +---@param sender string +function AceComm:OnReceiveMultipartFirst(prefix, message, distribution, sender) end + +---@protected +---@param prefix string +---@param message string +---@param distribution string +---@param sender string +function AceComm:OnReceiveMultipartNext(prefix, message, distribution, sender) end + +---@protected +---@param prefix string +---@param message string +---@param distribution string +---@param sender string +function AceComm:OnReceiveMultipartLast(prefix, message, distribution, sender) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfig-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfig-3.0.lua new file mode 100644 index 0000000..2201770 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfig-3.0.lua @@ -0,0 +1,75 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- AceConfig-3.0 +-- ---------------------------------------------------------------------------- +---@class AceConfig-3.0 +local AceConfig = {} + +---@paramsig appName, options [, slashcmd] +---@param appName string The application name for the config table. +---@param options table|function|AceConfig.OptionsTable The option table (or a function to generate one on demand). [Options table documentation](http://www.wowace.com/addons/ace3/pages/ace-config-3-0-options-tables/) +---@param slashcmd? string|table A slash command to register for the option table, or a table of slash commands. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-3-0#title-1) +function AceConfig:RegisterOptionsTable(appName, options, slashcmd) +end + +-- ---------------------------------------------------------------------------- +-- AceConfig.OptionsTable +-- ---------------------------------------------------------------------------- + +---@alias AceConfig.OptionsTable.ChildGroup +---|"select" +---|"tab" +---|"tree" + +---@alias AceConfig.OptionsTable.DescStyle +---|"inline" +---|"tooltip" + +---@alias AceConfig.OptionsTable.Type +---|"color" +---|"description" +---|"execute" +---|"group" +---|"header" +---|"input" +---|"keybinding" +---|"multiselect" +---|"range" +---|"select" +---|"toggle" + +---@alias AceConfig.OptionsTable.Width +---|"double" +---|"full" +---|"half" +---|"normal" +---|number + +---@class AceConfig.OptionsTable +---@field args? table a table containing a list of options +---@field childGroups? AceConfig.OptionsTable.ChildGroup decides how children groups of this group are displayed +---@field cmdHidden? boolean hide this from commandline +---@field confirm? string|function|boolean prompt for confirmation before changing a value if true display "name - desc", or contents of .confirmText if supplied. +---@field confirmText? string text to display in the confirmation dialog +---@field desc? string|function description for the option (or nil for a self-describing name) +---@field descStyle? AceConfig.OptionsTable.DescStyle "inline" if you want the description to show below the option in a GUI (rather than as a tooltip). Currently only supported by AceGUI "Toggle". +---@field dialogHidden? boolean hide this from dialog UIs +---@field disabled? string|function|boolean disabled but visible +---@field dropdownHidden? boolean hide this from dropdown UIs +---@field func? function function to execute +---@field get? string|function getter function +---@field guiHidden? boolean hide this from graphical UIs (dialog, dropdown) +---@field handler? table object on which getter/setter functions are called if they are declared as strings rather than function references +---@field hidden? string|function|boolean hidden (but usable if you can get to it, i.e. via commandline) +---@field icon? string|function path to icon texture +---@field iconCoords? table|string|function arguments to pass to SetTexCoord, e.g. {0.1,0.9,0.1,0.9}. +---@field name string|function Display name for the option +---@field order? number|string|function relative position of item (default = 100, 0=first, -1=last) +---@field set? string|function setter function +---@field type AceConfig.OptionsTable.Type Type of the option +---@field validate? string|function|false validate the input/value before setting it. return a string (error message) to indicate error. +---@field width? AceConfig.OptionsTable.Width If a number multiplier of the default width, ie. 0.5 equals "half", 2.0 equals "double" +---[Documentation](http://www.wowace.com/addons/ace3/pages/ace-config-3-0-options-tables/) +local OptionsTable = {} diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigCmd-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigCmd-3.0.lua new file mode 100644 index 0000000..883651b --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigCmd-3.0.lua @@ -0,0 +1,31 @@ +---@meta _ +-- ---------------------------------------------------------------------------- +-- AceConfigCmd-3.0 +-- ---------------------------------------------------------------------------- +---@class AceConfigCmd-3.0 +local lib = {} + +--- Utility function to create a slash command handler. +--- +--- Also registers tab completion with AceTab +---@param slashcmd string The slash command WITHOUT leading slash (only used for error output) +---@param appName string The application name as given to `:RegisterOptionsTable()` +function lib:CreateChatCommand(slashcmd, appName) end + +--- Utility function that returns the options table that belongs to a slashcommand. +--- +--- Designed to be used for the AceTab interface. +---@param slashcmd string The slash command WITHOUT leading slash (only used for error output) +---@return table|nil optionsTable The options table associated with the slash command (or nil if the slash command was not registered) +function lib:GetChatCommandOptions(slashcmd) end + +--- Handle the chat command. +--- +--- This is usually called from a chat command handler to parse the command input as operations on an aceoptions table. +--- +--- AceConfigCmd uses this function internally when a slash command is registered with `:CreateChatCommand` +---@param slashcmd string The slash command WITHOUT leading slash (only used for error output) +---@param appName string The application name as given to `:RegisterOptionsTable()` +---@param input string The commandline input (as given by the WoW handler, i.e. without the command itself) +function lib:HandleCommand(slashcmd, appName, input) end + diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigDialog-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigDialog-3.0.lua new file mode 100644 index 0000000..257f5d2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigDialog-3.0.lua @@ -0,0 +1,57 @@ +---@meta _ +---@class AceConfigDialog-3.0 +---@field OpenFrames table +---@field Status table +---@field tooltip GameTooltip +local AceConfigDialog = {} + +---@class AceConfigDialog-3.0.frame : Frame +---@field apps table +---@field closing table +---@field closeAllOverride table +AceConfigDialog.frame = {} + +---@paramsig appName, name, parent, ... +--- Add an option table into the Blizzard Interface Options panel +---@param appName string The application name as given to `:RegisterOptionsTable()` +---@param name? string A descriptive name to display in the options tree. Defaults to appName +---@param parent? string The parent to use in the interface options tree +---@param ...? string The path in the options table to feed into the interface options panel +---@return any # The reference to the frame registered into the Interface Options. +---@return any # The registered category ID +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-dialog-3-0#title-1) +function AceConfigDialog:AddToBlizOptions(appName, name, parent, ...) end + +---@paramsig appName +--- Close a specific options window +---@param appName string The application name as given to `:RegisterOptionsTable()` +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-dialog-3-0#title-2) +function AceConfigDialog:Close(appName) end + +--- Close all open options windows +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-dialog-3-0#title-3) +function AceConfigDialog:CloseAll() end + +---@paramsig appName, container, ... +---Open an option winddow at the specified path, if any +---@param appName string The application name as given to `:RegisterOptionsTable()` +---@param container? table +---@param ...? string The path to open after creating the options window (see `:SelectGroup` for details) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-dialog-3-0#title-4) +function AceConfigDialog:Open(appName, container, ...) end + +---@paramsig appName, ... +--- Selects the specified path in the options window. +--- The path specified has to match the keys of the groups in the table. +---@param appName string The application name as given to `:RegisterOptionsTable()` +---@param ... string The path to the key that should be selected +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-dialog-3-0#title-5) +function AceConfigDialog:SelectGroup(appName, ...) end + +---@paramsig appName, width, height +--- Sets the default size of the options window for a specific application. +---@param appName any The application name as given to `:RegisterOptionsTable()` +---@param width number The default width +---@param height number The default height +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-config-dialog-3-0#title-6) +function AceConfigDialog:SetDefaultSize(appName, width, height) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigRegistry-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigRegistry-3.0.lua new file mode 100644 index 0000000..843781b --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConfig-3.0/AceConfigRegistry-3.0.lua @@ -0,0 +1,57 @@ +---@meta _ +-- ---------------------------------------------------------------------------- +-- Type Aliases +-- ---------------------------------------------------------------------------- + +--- The AceConfig UI Type +---@alias AceConfigRegistry.UIType +---|"cmd" +---|"dialog" +---|"dropdown" + +---@alias AceConfigRegistry.OptionsGenerator fun(uiType: AceConfigRegistry.UIType, uiName: string, appName: string): table +---@alias AceConfigRegistry.OptionsGetter fun(uiType: AceConfigRegistry.UIType, uiName: string, errlvl?: number): table + +-- ---------------------------------------------------------------------------- +-- AceConfigRegistry-3.0 +-- ---------------------------------------------------------------------------- + +---@class AceConfigRegistry-3.0 +local lib = {} + +--- Query the registry for a specific options table. +--- +--- If only appName is given, a function is returned which you can call with (uiType,uiName) to get the table. +--- +--- If uiType&uiName are given, the table is returned. +---@param appName string The application name as given to `:RegisterOptionsTable()` +---@param uiType? AceConfigRegistry.UIType The type of UI to get the table for +---@param uiName? string The name of the library/addon querying for the table, e.g. "MyLib-1.0" +---@return AceConfigRegistry.OptionsGetter|table|nil +function lib:GetOptionsTable(appName, uiType, uiName) end + +--- Returns an iterator of ["appName"]=funcref pairs +---@generic T: table, K: string, V: AceConfigRegistry.OptionsGetter +---@return fun(table: table, index?: K):K, V +---@return T +function lib:IterateOptionsTables() end + +--- Fires a "ConfigTableChange" callback for those listening in on it, allowing config GUIs to refresh. +--- +--- You should call this function if your options table changed from any outside event, like a game event or a timer. +---@param appName string The application name as given to `:RegisterOptionsTable()` +function lib:NotifyChange(appName) end + +--- Register an options table with the config registry. +---@param appName string The application name +---@param options AceConfigRegistry.OptionsGenerator|table The options table, OR a function reference that generates it on demand. +---@param skipValidation? boolean Skip options table validation (primarily useful for extremely huge options, with a noticeable slowdown) +function lib:RegisterOptionsTable(appName, options, skipValidation) end + +--- Validates basic structure and integrity of an options table +--- +--- Does NOT verify that get/set etc actually exist, since they can be defined at any depth +---@param options table The table to be validated +---@param name string The name of the table to be validated (shown in any error message) +---@param errlvl? number Error level offset, default 0 (=errors point to the function calling :ValidateOptionsTable) +function lib:ValidateOptionsTable(options, name, errlvl) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceConsole-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConsole-3.0.lua new file mode 100644 index 0000000..cc29dd9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceConsole-3.0.lua @@ -0,0 +1,58 @@ +---@meta _ +---@class AceConsole-3.0 +---@field embeds table ---table containing objects AceConsole is embedded in. +---@field commands table ---table containing commands registered +---@field weakcommands table ---table containing self, command => func references for weak commands that don't persist through enable/disable +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0) +local AceConsole = {} + +---@param chatframe Frame Custom ChatFrame to print to (or any frame with an .AddMessage function) +---@param ... any List of any values to be printed +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-3) +---@diagnostic disable-next-line: duplicate-set-field +function AceConsole:Print(chatframe, ...) end + +---@param ... any List of any values to be printed +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-3) +---@diagnostic disable-next-line: duplicate-set-field +function AceConsole:Print(...) end + +---@param chatframe? Frame Custom ChatFrame to print to (or any frame with an .AddMessage function) +---@param format string same syntax as standard Lua format() +---@param ...? any Arguments to the format string +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-4) +---@diagnostic disable-next-line: duplicate-set-field +function AceConsole:Printf(chatframe, format, ...) end + +---@param format string same syntax as standard Lua format() +---@param ...? any Arguments to the format string +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-4) +---@diagnostic disable-next-line: duplicate-set-field +function AceConsole:Printf(format, ...) end + +---@param command string Chat command to be registered WITHOUT leading "/" +---@param func function|string Function to call when the slash command is being used (funcref or methodname) +---@param persist? boolean if false, the command will be soft disabled/enabled when aceconsole is used as a mixin (default: true) +---@return boolean -- true if successful +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-5) +function AceConsole:RegisterChatCommand(command, func, persist) end + +---@param command string Chat command to be unregistered WITHOUT leading "/" +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-6) +function AceConsole:UnregisterChatCommand(command) end + +---@return fun(table: table, index?: string): string, string -- Iterator (pairs) over all commands +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-2) +function AceConsole:IterateChatCommands() end + +---@param str string The raw argument string +---@param numargs? number How many arguments to get (default 1) +---@param startpos? number Where in the string to start scanning (default 1) +---@return ... +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-console-3-0#title-1) +function AceConsole:GetArgs(str, numargs, startpos) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceDB-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceDB-3.0.lua new file mode 100644 index 0000000..f73f386 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceDB-3.0.lua @@ -0,0 +1,148 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- AceDB-3.0 +-- ---------------------------------------------------------------------------- +---@class AceDB-3.0 +local AceDB = {} + +-- Creates a new database object that can be used to handle database settings and profiles. +-- By default, an empty DB is created, using a character specific profile. +-- +-- You can override the default profile used by passing any profile name as the third argument, or by passing true as the third argument to use a globally shared profile called "Default". +-- +-- Note that there is no token replacement in the default profile name, passing a defaultProfile as "char" will use a profile named "char", and not a character-specific profile. +---@param tbl string|table The name of variable, or table to use for the database +---@param defaults? AceDB.Schema A table of database defaults +---@param defaultProfile? string|true The name of the default profile. If not set, a character specific profile will be used as the default. You can also pass true to use a shared global profile called "Default". +---@return AceDBObject-3.0 DB +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-2) +function AceDB:New(tbl, defaults, defaultProfile) end + +-- ---------------------------------------------------------------------------- +-- AceDBObject-3.0 +-- ---------------------------------------------------------------------------- +---@class AceDBObject-3.0: AceDB.Schema +---@field keys table +---@field sv table +---@field defaults AceDB.Schema Cache of defaults +---@field parent table +local DBObjectLib = {} + +-- Copies a named profile into the current profile, overwriting any conflicting settings. +---@param name string The name of the profile to be copied into the current profile +---@param silent? boolean If true, do not raise an error when the profile does not exist +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-3) +function DBObjectLib:CopyProfile(name, silent) end + +-- Deletes a named profile. +-- +-- This profile must not be the active profile. +---@param name string The name of the profile to be deleted +---@param silent? boolean If true, do not raise an error when the profile does not exist +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-4) +function DBObjectLib:DeleteProfile(name, silent) end + +-- Returns the current profile name used by the database +---@return string profileName +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-5) +function DBObjectLib:GetCurrentProfile() end + +-- Returns an already existing namespace from the database object. +---@param name string The name of the existing namespace +---@param silent? boolean if true, the addon is optional, silently return nil if its not found +---@return table|nil namespace the namespace object if found +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-6) +function DBObjectLib:GetNamespace(name, silent) end + +-- Returns a table with the names of the existing profiles in the database. +-- +-- You can optionally supply a table to re-use for this purpose. +---@param tbl? table A table to store the profile names in +---@return table profiles Contains the names of the existing profiles in the database. +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-7) +function DBObjectLib:GetProfiles(tbl) end + +---@param target table The object registering to listen for the callback. +---@param eventName AceDB.EventName The name of the event triggering the callback +---@param method string|function The method to call when the event is fired. +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-db-3-0-tutorial#title-5) +function DBObjectLib.RegisterCallback(target, eventName, method) end + +--Sets the defaults table for the given database object by clearing any that are currently set, and then setting the new defaults. +---@param defaults AceDB.Schema A table of defaults for this database +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-8) +function DBObjectLib:RegisterDefaults(defaults) end + +-- Creates a new database namespace, directly tied to the database. +-- +-- This is a full scale database in it's own rights other than the fact that it cannot control its profile individually +---@param name string The name of the new namespace +---@param defaults? AceDB.Schema A table of values to use as defaults +---@return AceDBObject-3.0 namespace The created database namespace +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-9) +function DBObjectLib:RegisterNamespace(name, defaults) end + +-- Resets the entire database, using the string defaultProfile as the new default profile. +---@param defaultProfile? string The profile name to use as the default +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-10) +function DBObjectLib:ResetDB(defaultProfile) end + +-- Resets the current profile to the default values (if specified). +---@param noChildren? boolean if set to true, the reset will not be populated to the child namespaces of this DB object +---@param noCallbacks? boolean if set to true, won't fire the OnProfileReset callback +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-11) +function DBObjectLib:ResetProfile(noChildren, noCallbacks) end + +-- Changes the profile of the database and all of it's namespaces to the supplied named profile +-- +-- Callback parameters: "OnProfileChanged", database, newProfileKey +---@param name string The name of the profile to set as the current profile +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0#title-12) +function DBObjectLib:SetProfile(name) end + +---@param target table The object unregistering to listen for callbacks. +function DBObjectLib.UnregisterAllCallbacks(target) end + +---@param target table The object unregistering to listen for the callback. +---@param eventName AceDB.EventName The event to unregister. +function DBObjectLib.UnregisterCallback(target, eventName) end + +-- ---------------------------------------------------------------------------- +-- Types +-- ---------------------------------------------------------------------------- + +---@alias AceDB.EventName +---|"OnDatabaseReset" +---|"OnDatabaseShutdown" +---|"OnNewProfile" +---|"OnProfileChanged" +---|"OnProfileCopied" +---|"OnProfileDeleted" +---|"OnProfileReset" +---|"OnProfileShutdown" + +---@class AceDB.Schema +---@field char? table Character-specific data. Every character has its own database. +---@field realm? table Realm-specific data. All of the players characters on the same realm share this database. +---@field class? table Class-specific data. All of the players characters of the same class share this database. +---@field race? table Race-specific data. All of the players characters of the same race share this database. +---@field faction? table Faction-specific data. All of the players characters of the same faction share this database. +---@field factionrealm? table Faction and realm specific data. All of the players characters on the same realm and of the same faction share this database. +---@field factionrealmregion? table Faction, realm and region specific data. All of the players characters on the same realm, of the same faction and in the same region share this database. +---@field locale? table Locale specific data, based on the locale of the players game client. +---@field global? table Global Data. All characters on the same account share this database. +---@field profile? table Profile-specific data. All characters using the same profile share this database. The user can control which profile should be used. +---@field profiles? table Contains all profiles diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceDBOptions-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceDBOptions-3.0.lua new file mode 100644 index 0000000..45344a7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceDBOptions-3.0.lua @@ -0,0 +1,23 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- AceDBOptions-3.0 +-- ---------------------------------------------------------------------------- +---@class AceDBOptions-3.0 +local AceDBOptions = {} + +--[[ +Get/Create a option table that you can use in your addon to control the profiles of AceDB-3.0. + +Usage: + + Assuming `options` is your top-level options table and `self.db` is your database: + + `options.args.profiles = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db)` +]] +---@paramsig db, noDefaultProfiles +---@param db AceDBObject-3.0 The database object to create the options table for. +---@param noDefaultProfiles? boolean +---@return AceConfig.OptionsTable optionsTable The options table to be used in AceConfig-3.0 +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-dboptions-3-0#title-1) +function AceDBOptions:GetOptionsTable(db, noDefaultProfiles) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceEvent-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceEvent-3.0.lua new file mode 100644 index 0000000..47379d8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceEvent-3.0.lua @@ -0,0 +1,55 @@ +---@meta _ + +-------------------------------------------------------------------------------- +---- AceEvent-3.0 +-------------------------------------------------------------------------------- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0) +---@class AceEvent-3.0 +local AceEvent = {} + +---@param event FrameEvent The event to register for +---@param callback? function|string The callback function to call when the event is triggered (funcref or method, defaults to a method with the event name) +---@param arg? any An optional argument to pass to the callback function +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0#title-1) +function AceEvent:RegisterEvent(event, callback, arg) end + +---@param event FrameEvent The event to unregister +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0#title-4) +function AceEvent:UnregisterEvent(event) end + +---@param message string The message to register for +---@param callback? function|string The callback function to call when the message is triggered (funcref or method, defaults to a method with the event name) +---@param arg? any An optional argument to pass to the callback function +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0#title-2) +function AceEvent:RegisterMessage(message, callback, arg) end + +---@param message string The message to unregister +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0#title-5) +function AceEvent:UnregisterMessage(message) end + +---@name AceEvent:SendMessage +---@param message string The message to send +---@param ... any Any arguments to the message +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0#title-3) +function AceEvent:SendMessage(message, ...) end + +---@generic T +---@param target T target object to embed AceEvent in +---@return T|AceEvent-3.0 augmentedTarget +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0) +function AceEvent:Embed(target) end + +---@param target AceEvent-3.0 +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-event-3-0) +function AceEvent:OnEmbedDisable(target) end + +function AceEvent:UnregisterAllEvents() end + +function AceEvent:UnregisterAllMessages() end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/AceGUI-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/AceGUI-3.0.lua new file mode 100644 index 0000000..91c4a5b --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/AceGUI-3.0.lua @@ -0,0 +1,229 @@ +---@meta _ +---@alias AceGUILayoutType +---|"Flow" +---|"List" +---|"Fill" +---|"Table" + +---@alias AceGUIWidgetType +---|"BlizOptionsGroup" +---|"Button" +---|"CheckBox" +---|"ColorPicker" +---|"Dropdown" +---|"EditBox" +---|"Heading" +---|"Icon" +---|"InteractiveLabel" +---|"Keybinding" +---|"Label" +---|"MultiLineEditBox" +---|"Slider" + +---@alias AceGUIContainerType +---|"DropdownGroup" +---|"Frame" +---|"InlineGroup" +---|"ScrollFrame" +---|"SimpleGroup" +---|"TabGroup" +---|"TreeGroup" +---|"Window" + +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0) +---@class AceGUI-3.0 +---@field tooltip GameTooltip +local AceGUI = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-2) +function AceGUI:ClearFocus() end + +---@param type AceGUIWidgetType|AceGUIContainerType +---@return AceGUIWidget +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-3) +function AceGUI:Create(type) end + +---@param Name AceGUILayoutType +---@return function +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-4) +function AceGUI:GetLayout(Name) end + +---@param type string +---@return number +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-5) +function AceGUI:GetNextWidgetNum(type) end + +---@param type string +---@return number +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-6) +function AceGUI:GetWidgetCount(type) end + +---@param type string +---@return number +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-7) +function AceGUI:GetWidgetVersion(type) end + +---@param widget AceGUIWidget +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-8) +function AceGUI:RegisterAsContainer(widget) end + +---@param widget AceGUIWidget +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-9) +function AceGUI:RegisterAsWidget(widget) end + +---@param Name string +---@param LayoutFunc function +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-10) +function AceGUI:RegisterLayout(Name, LayoutFunc) end + +---@param Name string +---@param Constructor function +---@param Version number +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-11) +function AceGUI:RegisterWidgetType(Name, Constructor, Version) end + +---@param widget AceGUIWidget +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-12) +function AceGUI:Release(widget) end + +---@param widget AceGUIWidget +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-gui-3-0#title-13) +function AceGUI:SetFocus(widget) end + +---@meta _ +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets) +---@class AceGUIWidget +---@field public type string +---@field protected frame Frame +---@field protected userdata table +---@field protected events table +---@field protected width? string|number +---@field protected height? string|number +local AceGUIWidget = {} + +---@param name string +---@param func function +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-1) +function AceGUIWidget:SetCallback(name, func) end + +---@param width number +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-2) +function AceGUIWidget:SetWidth(width) end + +---@param width number +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-3) +function AceGUIWidget:SetRelativeWidth(width) end + +---@param height number +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-4) +function AceGUIWidget:SetHeight(height) end + +---@return boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-5) +function AceGUIWidget:IsVisible() end + +---@return boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-6) +function AceGUIWidget:IsShown() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-7) +function AceGUIWidget:Release() end + +---@param point FramePoint +---@param relativeTo Region|string +---@param relativePoint string +---@param ofsx? number +---@param ofsy? number +---@overload fun(self, point: FramePoint, relativeTo: Region|string, ofsx?: number, ofsy?: number) +---@overload fun(self, point: FramePoint, ofsx?: number, ofsy?: number) +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetPoint) +function AceGUIWidget:SetPoint(point, relativeTo, relativePoint, ofsx, ofsy) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-9) +function AceGUIWidget:ClearAllPoints() end + +---@return number +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-10) +function AceGUIWidget:GetNumPoints() end + +---@param index number +---@return string point +---@return Region relativeTo +---@return string relativePoint +---@return number xOfs +---@return number yOfs +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_GetPoint) +function AceGUIWidget:GetPoint(index) end + +---@return table +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-12) +function AceGUIWidget:GetUserDataTable() end + +---@param key any +---@param value any +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-13) +function AceGUIWidget:SetUserData(key, value) end + +---@param key any +---@return any +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-14) +function AceGUIWidget:GetUserData(key) end + +---@param isFull boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-15) +function AceGUIWidget:SetFullHeight(isFull) end + +---@return boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-16) +function AceGUIWidget:IsFullHeight() end + +---@param isFull boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-17) +function AceGUIWidget:SetFullWidth(isFull) end + +---@return boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-1-18) +function AceGUIWidget:IsFullWidth() end + +---@param parent Region|string|nil +function AceGUIWidget:SetParent(parent) end + +---@param name string +function AceGUIWidget:Fire(name, ...) end + +---@return boolean +function AceGUIWidget:IsReleasing() end + +---@meta _ +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets) +---@class AceGUIContainer : AceGUIWidget +---@field protected children AceGUIWidget[] +---@field protected content Frame +local AceGUIContainer = {} + +---@param widget AceGUIWidget +---@param beforeWidget? AceGUIWidget +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-1) +function AceGUIContainer:AddChild(widget, beforeWidget) end + +---@param layout AceGUILayoutType +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-2) +function AceGUIContainer:SetLayout(layout) end + +---@param flag boolean +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-3) +function AceGUIContainer:SetAutoAdjustHeight(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-4) +function AceGUIContainer:ReleaseChildren() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-5) +function AceGUIContainer:DoLayout() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-6) +function AceGUIContainer:PauseLayout() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-3-7) +function AceGUIContainer:ResumeLayout() end + +function AceGUIContainer:PerformLayout() end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-BlizOptionsGroup.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-BlizOptionsGroup.lua new file mode 100644 index 0000000..04635d9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-BlizOptionsGroup.lua @@ -0,0 +1,31 @@ +---@meta _ +---@class AceGUIBlizOptionsGroup : AceGUIContainer +---@field protected label FontString +local AceGUIBlizOptionsGroup = {} + +---@param text string +function AceGUIBlizOptionsGroup:SetTitle(text) end + +---@param name string +---@param parent unknown +function AceGUIBlizOptionsGroup:SetName(name, parent) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param key unknown +function AceGUIBlizOptionsGroup:SetGroup(key) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param width number +function AceGUIBlizOptionsGroup:SetDropdownWidth(width) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param statusTable table +function AceGUIBlizOptionsGroup:SetStatusTable(statusTable) end + +---@protected +---@param width integer +function AceGUIBlizOptionsGroup:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUIBlizOptionsGroup:OnHeightSet(height) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-DropDownGroup.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-DropDownGroup.lua new file mode 100644 index 0000000..352dc7a --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-DropDownGroup.lua @@ -0,0 +1,48 @@ +---@meta _ +---@class AceGUIDropdownGroup : AceGUIContainer +---@field protected localstatus table +---@field protected status? table +---@field protected titletext FontString +---@field protected dropdown AceGUIDropdown +---@field protected border Frame|BackdropTemplate +local AceGUIDropdownGroup = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param text string +function AceGUIDropdownGroup:SetTitle(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param groupList table +---@param order? unknown[] +function AceGUIDropdownGroup:SetGroupList(groupList, order) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param key unknown +function AceGUIDropdownGroup:SetGroup(key) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param width number +function AceGUIDropdownGroup:SetDropdownWidth(width) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-1-1) +---@param statusTable table +function AceGUIDropdownGroup:SetStatusTable(statusTable) end + +---@protected +---@param width integer +function AceGUIDropdownGroup:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUIDropdownGroup:OnHeightSet(height) end + +---@protected +---@param width integer +---@param height integer +function AceGUIDropdownGroup:LayoutFinished(width, height) end + +---@class AceGUIDropdownGroupStatus +---@field selected? unknown +---@field left? number +---@field width? number +---@field height? number diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Frame.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Frame.lua new file mode 100644 index 0000000..04010e1 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Frame.lua @@ -0,0 +1,48 @@ +---@meta _ +---@class AceGUIFrame : AceGUIContainer +---@field protected localstatus AceGUIFrameStatus +---@field protected status? AceGUIFrameStatus +---@field protected titletext FontString +---@field protected statustext FontString +---@field protected titlebg Texture +---@field protected sizer_se Frame +---@field protected sizer_s Frame +---@field protected sizer_e Frame +---@field protected frame Frame|BackdropTemplate +local AceGUIFrame = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-2-1) +---@param text string +function AceGUIFrame:SetTitle(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-2-1) +---@param text string +function AceGUIFrame:SetStatusText(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-2-1) +---@param statusTable table +function AceGUIFrame:SetStatusTable(statusTable) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-2-1) +function AceGUIFrame:ApplyStatus() end + +function AceGUIFrame:Show() end + +function AceGUIFrame:Hide() end + +---@param state boolean +function AceGUIFrame:EnableResize(state) end + +---@protected +---@param width integer +function AceGUIFrame:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUIFrame:OnHeightSet(height) end + +---@class AceGUIFrameStatus +---@field top? number +---@field left? number +---@field width? number +---@field height? number diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-InlineGroup.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-InlineGroup.lua new file mode 100644 index 0000000..53038fc --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-InlineGroup.lua @@ -0,0 +1,21 @@ +---@meta _ +---@class AceGUIInlineGroup : AceGUIContainer +---@field protected titletext FontString +local AceGUIInlineGroup = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-3-1) +---@param text string +function AceGUIInlineGroup:SetTitle(text) end + +---@protected +---@param width integer +function AceGUIInlineGroup:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUIInlineGroup:OnHeightSet(height) end + +---@protected +---@param width integer +---@param height integer +function AceGUIInlineGroup:LayoutFinished(width, height) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-ScrollFrame.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-ScrollFrame.lua new file mode 100644 index 0000000..9c7fede --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-ScrollFrame.lua @@ -0,0 +1,38 @@ +---@meta _ +---@class AceGUIScrollFrame : AceGUIContainer +---@field protected localstatus AceGUIScrollFrameStatus +---@field protected status? AceGUIScrollFrameStatus +---@field protected scrollframe ScrollFrame +---@field protected scrollbar Slider +local AceGUIScrollFrame = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-4-1) +---@param value number +function AceGUIScrollFrame:SetScroll(value) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-4-1) +---@param statusTable table +function AceGUIScrollFrame:SetStatusTable(statusTable) end + +---@param value number +function AceGUIScrollFrame:MoveScroll(value) end + +---@protected +function AceGUIScrollFrame:FixScroll() end + +---@protected +---@param width integer +function AceGUIScrollFrame:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUIScrollFrame:OnHeightSet(height) end + +---@protected +---@param width integer +---@param height integer +function AceGUIScrollFrame:LayoutFinished(width, height) end + +---@class AceGUIScrollFrameStatus +---@field scrollvalue number +---@field offset integer? diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-SimpleGroup.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-SimpleGroup.lua new file mode 100644 index 0000000..fb15889 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-SimpleGroup.lua @@ -0,0 +1,16 @@ +---@meta _ +---@class AceGUISimpleGroup : AceGUIContainer +local AceGUISimpleGroup = {} + +---@protected +---@param width integer +function AceGUISimpleGroup:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUISimpleGroup:OnHeightSet(height) end + +---@protected +---@param width integer +---@param height integer +function AceGUISimpleGroup:LayoutFinished(width, height) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TabGroup.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TabGroup.lua new file mode 100644 index 0000000..327d85e --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TabGroup.lua @@ -0,0 +1,57 @@ +---@meta _ +---@class AceGUITabGroup : AceGUIContainer +---@field protected num integer +---@field protected localstatus AceGUITabGroupStatus +---@field protected status? AceGUITabGroupStatus +---@field protected alignoffset number +---@field protected titletext FontString +---@field protected border Frame|BackdropTemplate +---@field protected borderoffset number +---@field protected tabs Button[] +---@field protected tablist AceGUITabGroupTab[] +local AceGUITabGroup = {} + +---@class AceGUITabGroupTab +---@field value unknown +---@field text string +---@field disabled? boolean + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-6-1) +---@param text string +function AceGUITabGroup:SetTitle(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-6-1) +---@param tabsTable AceGUITabGroupTab[] +function AceGUITabGroup:SetTabs(tabsTable) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-6-1) +---@param key string +function AceGUITabGroup:SelectTab(key) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-6-1) +---@param statusTable table +function AceGUITabGroup:SetStatusTable(statusTable) end + +---@protected +function AceGUITabGroup:BuildTabs() end + +---@protected +---@param id integer +---@return Button +function AceGUITabGroup:CreateTab(id) end + +---@protected +---@param width integer +function AceGUITabGroup:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUITabGroup:OnHeightSet(height) end + +---@protected +---@param width integer +---@param height integer +function AceGUITabGroup:LayoutFinished(width, height) end + +---@class AceGUITabGroupStatus +---@field selected? string diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TreeGroup.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TreeGroup.lua new file mode 100644 index 0000000..aa92162 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-TreeGroup.lua @@ -0,0 +1,101 @@ +---@meta _ +---@class AceGUITreeGroup : AceGUIContainer +---@field protected lines AceGUITreeGroupLine[] +---@field protected buttons Button[] +---@field protected localstatus AceGUITreeGroupStatus +---@field protected status? AceGUITreeGroupStatus +---@field protected filter boolean +---@field protected treeframe Frame|BackdropTemplate +---@field protected dragger Frame|BackdropTemplate +---@field protected scrollbar Slider +---@field protected border Frame|BackdropTemplate +---@field protected enabletooltips boolean +local AceGUITreeGroup = {} + +---@protected +---@return Button +function AceGUITreeGroup:CreateButton() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-7-1) +---@param tree table +---@param filter? boolean +function AceGUITreeGroup:SetTree(tree, filter) end + +---@param value string +function AceGUITreeGroup:SetSelected(value) end + +---@param uniquevalue string +---@param ... string +function AceGUITreeGroup:Select(uniquevalue, ...) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-7-1) +---@param ... string +function AceGUITreeGroup:SelectByPath(...) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-7-1) +---@param uniquevalue string +function AceGUITreeGroup:SelectByValue(uniquevalue) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-7-1) +---@param flag boolean +function AceGUITreeGroup:EnableButtonTooltips(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-4-7-1) +---@param statusTable table +function AceGUITreeGroup:SetStatusTable(statusTable) end + +---@param show boolean +function AceGUITreeGroup:ShowScroll(show) end + +---@param treewidth integer +---@param resizable boolean +function AceGUITreeGroup:SetTreeWidth(treewidth, resizable) end + +---@return integer +function AceGUITreeGroup:GetTreeWidth() end + +---@protected +---@param tree table +---@param level? integer +---@param parent? AceGUITreeGroupLine +function AceGUITreeGroup:BuildLevel(tree, level, parent) end + +---@protected +---@param scrollToSelection? boolean +---@param fromOnUpdate? boolean +function AceGUITreeGroup:RefreshTree(scrollToSelection, fromOnUpdate) end + +---@protected +---@param width integer +function AceGUITreeGroup:OnWidthSet(width) end + +---@protected +---@param height integer +function AceGUITreeGroup:OnHeightSet(height) end + +---@protected +---@param width integer +---@param height integer +function AceGUITreeGroup:LayoutFinished(width, height) end + +---@class AceGUITreeGroupStatus +---@field groups table +---@field scrollvalue number +---@field scrollToSelection? boolean +---@field fullwidth? boolean +---@field treewidth? integer +---@field treesizable? boolean +---@field selected? string + +---@class AceGUITreeGroupLine +---@field value any +---@field text string +---@field icon? string|integer +---@field iconCoords? number[] +---@field disabled? boolean +---@field tree table +---@field level integer +---@field parent? AceGUITreeGroupLine +---@field visible? boolean +---@field uniquevalue string +---@field hasChildren? boolean diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Window.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Window.lua new file mode 100644 index 0000000..cef4a81 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIContainer-Window.lua @@ -0,0 +1,31 @@ +---@meta _ +---@class AceGUIWindow : AceGUIContainer +---@field protected status? table +---@field protected localstatus table +---@field protected closebutton Button +---@field protected titletext FontString +---@field protected title Button +---@field protected sizer_se Frame +---@field protected line1 Texture +---@field protected line2 Texture +---@field protected sizer_s Frame +---@field protected sizer_e Frame +local AceGUIWindow = {} + +function AceGUIWindow:Hide() end + +function AceGUIWindow:Show() end + +function AceGUIWindow:ApplyStatus() end + +---@param title string +function AceGUIWindow:SetTitle(title) end + +---@param status table +function AceGUIWindow:SetStatusTable(status) end + +---@param text string +function AceGUIWindow:SetStatusText(text) end + +---@param state boolean +function AceGUIWindow:EnableResize(state) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Button.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Button.lua new file mode 100644 index 0000000..47f09e8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Button.lua @@ -0,0 +1,16 @@ +---@meta _ +---@class AceGUIButton : AceGUIWidget +---@field protected text FontString +local AceGUIButton = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-1-1) +---@param text string +function AceGUIButton:SetText(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-1-1) +---@param autoWidth boolean +function AceGUIButton:SetAutoWidth(autoWidth) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-1-1) +---@param flag boolean +function AceGUIButton:SetDisabled(flag) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-CheckBox.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-CheckBox.lua new file mode 100644 index 0000000..fa872bd --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-CheckBox.lua @@ -0,0 +1,44 @@ +---@meta _ +---@class AceGUICheckBox : AceGUIWidget +---@field protected checkbg Texture +---@field protected check Texture +---@field protected text FontString +---@field protected highlight Texture +---@field protected image Texture +local AceGUICheckBox = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param flag boolean|nil +function AceGUICheckBox:SetValue(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@return boolean|nil +function AceGUICheckBox:GetValue() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param checkType "radio"|"checkbox" +function AceGUICheckBox:SetType(checkType) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +function AceGUICheckBox:ToggleChecked() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param text string +function AceGUICheckBox:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param state boolean +function AceGUICheckBox:SetTriState(state) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param flag boolean +function AceGUICheckBox:SetDisabled(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param description string +function AceGUICheckBox:SetDescription(description) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-2-1) +---@param path string|number +---@param ...? unknown +function AceGUICheckBox:SetImage(path, ...) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-ColorPicker.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-ColorPicker.lua new file mode 100644 index 0000000..1119727 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-ColorPicker.lua @@ -0,0 +1,24 @@ +---@meta _ +---@class AceGUIColorPicker : AceGUIWidget +---@field protected colorSwatch Texture +---@field protected text FontString +local AceGUIColorPicker = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-3-1) +---@param r number +---@param g number +---@param b number +---@param a number +function AceGUIColorPicker:SetColor(r, g, b, a) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-3-1) +---@param text string +function AceGUIColorPicker:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-3-1) +---@param flag boolean +function AceGUIColorPicker:SetHasAlpha(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-3-1) +---@param flag boolean +function AceGUIColorPicker:SetDisabled(flag) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-DropDown.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-DropDown.lua new file mode 100644 index 0000000..6a022fa --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-DropDown.lua @@ -0,0 +1,61 @@ +---@meta _ +---@class AceGUIDropdown : AceGUIWidget +---@field protected dropdown Frame +---@field protected count number +---@field protected button Button +---@field protected button_cover Button +---@field protected text FontString +---@field protected label FontString +local AceGUIDropdown = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param key unknown +function AceGUIDropdown:SetValue(key) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param list table +---@param order? unknown[] +function AceGUIDropdown:SetList(list, order) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param text string +function AceGUIDropdown:SetText(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param text string +function AceGUIDropdown:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param key unknown +---@param value string +function AceGUIDropdown:AddItem(key, value) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param flag boolean +function AceGUIDropdown:SetMultiselect(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@return boolean +function AceGUIDropdown:GetMultiselect() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param key unknown +---@param value string +function AceGUIDropdown:SetItemValue(key, value) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param key unknown +---@param flag boolean +function AceGUIDropdown:SetItemDisabled(key, flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-4-1) +---@param flag boolean +function AceGUIDropdown:SetDisabled(flag) end + +function AceGUIDropdown:ClearFocus() end + +---@return unknown +function AceGUIDropdown:GetValue() end + +---@param width number +function AceGUIDropdown:SetPulloutWidth(width) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-EditBox.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-EditBox.lua new file mode 100644 index 0000000..a0efc35 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-EditBox.lua @@ -0,0 +1,40 @@ +---@meta _ +---@class AceGUIEditBox : AceGUIWidget +---@field protected alignoffset number +---@field protected editbox EditBox +---@field protected label FontString +---@field protected button Button +local AceGUIEditBox = {} +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@param text string +function AceGUIEditBox:SetText(text) end + +--- ---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@return string +function AceGUIEditBox:GetText() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@param text string +function AceGUIEditBox:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@param flag boolean +function AceGUIEditBox:SetDisabled(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@param flag boolean +function AceGUIEditBox:DisableButton(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@param num number +function AceGUIEditBox:SetMaxLetters(num) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +function AceGUIEditBox:SetFocus() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-5-1) +---@param from? number +---@param to? number +function AceGUIEditBox:HighlightText(from, to) end + +function AceGUIEditBox:ClearFocus() end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Heading.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Heading.lua new file mode 100644 index 0000000..17a5194 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Heading.lua @@ -0,0 +1,10 @@ +---@meta _ +---@class AceGUIHeading : AceGUIWidget +---@field protected label FontString +---@field protected left Texture +---@field protected right Texture +local AceGUIHeading = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-6-1) +---@param text string +function AceGUIHeading:SetText(text) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Icon.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Icon.lua new file mode 100644 index 0000000..f18c6b0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Icon.lua @@ -0,0 +1,22 @@ +---@meta _ +---@class AceGUIIcon : AceGUIWidget +---@field protected label FontString +---@field protected image Texture +local AceGUIIcon = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-7-1) +---@param image string|number +---@param ...? unknown +function AceGUIIcon:SetImage(image, ...) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-7-1) +---@param width number +---@param height number +function AceGUIIcon:SetImageSize(width, height) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-7-1) +---@param text string +function AceGUIIcon:SetLabel(text) end + +---@param disabled boolean +function AceGUIIcon:SetDisabled(disabled) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-InteractiveLabel.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-InteractiveLabel.lua new file mode 100644 index 0000000..d8f540d --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-InteractiveLabel.lua @@ -0,0 +1,51 @@ +---@meta _ +---@class AceGUIInteractiveLabel : AceGUIWidget +---@field protected highlight Texture +local AceGUIInteractiveLabel = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param text string +function AceGUIInteractiveLabel:SetText(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param r number +---@param g number +---@param b number +function AceGUIInteractiveLabel:SetColor(r, g, b) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param font FontFile +---@param height number +---@param flags string? +function AceGUIInteractiveLabel:SetFont(font, height, flags) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param font? FontObject +function AceGUIInteractiveLabel:SetFontObject(font) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param image string|number +---@param ...? unknown +function AceGUIInteractiveLabel:SetImage(image, ...) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param width number +---@param height number +function AceGUIInteractiveLabel:SetImageSize(width, height) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param ... number Set the image of the highlight. +function AceGUIInteractiveLabel:SetHighlight(...) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-8-1) +---@param ... number? Pass 4 or 8 SetTexCoords parameters +function AceGUIInteractiveLabel:SetHighlightTexCoord(...) end + +---@param disabled boolean +function AceGUIInteractiveLabel:SetDisabled(disabled) end + +---@param justifyH JustifyHorizontal +function AceGUIInteractiveLabel:SetJustifyH(justifyH) end + +---@param justifyV JustifyVertical +function AceGUIInteractiveLabel:SetJustifyV(justifyV) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Keybinding.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Keybinding.lua new file mode 100644 index 0000000..ac5130b --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Keybinding.lua @@ -0,0 +1,23 @@ +---@meta _ +---@class AceGUIKeybinding : AceGUIWidget +---@field protected button Button +---@field protected label FontString +---@field protected msgframe Frame|BackdropTemplate +---@field protected alignoffset number +local AceGUIKeybinding = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-9-1) +---@param key string +function AceGUIKeybinding:SetKey(key) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-9-1) +---@return string +function AceGUIKeybinding:GetKey() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-9-1) +---@param text string +function AceGUIKeybinding:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-9-1) +---@param flag boolean +function AceGUIKeybinding:SetDisabled(flag) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Label.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Label.lua new file mode 100644 index 0000000..bc07aa8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Label.lua @@ -0,0 +1,41 @@ +---@meta _ +---@class AceGUILabel : AceGUIWidget +---@field protected label FontString +---@field protected image Texture +local AceGUILabel = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-10-1) +---@param text string +function AceGUILabel:SetText(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-10-1) +---@param r number +---@param g number +---@param b number +function AceGUILabel:SetColor(r, g, b) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-10-1) +---@param font FontFile +---@param height number +---@param flags string? +function AceGUILabel:SetFont(font, height, flags) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-10-1) +---@param font? FontObject +function AceGUILabel:SetFontObject(font) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-10-1) +---@param image string|number +---@param ... number? Pass 4 or 8 SetTexCoords parameters +function AceGUILabel:SetImage(image, ...) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-10-1) +---@param width number +---@param height number +function AceGUILabel:SetImageSize(width, height) end + +---@param justifyH JustifyHorizontal +function AceGUILabel:SetJustifyH(justifyH) end + +---@param justifyV JustifyVertical +function AceGUILabel:SetJustifyV(justifyV) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-MultiLineEditBox.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-MultiLineEditBox.lua new file mode 100644 index 0000000..8e43cd4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-MultiLineEditBox.lua @@ -0,0 +1,55 @@ +---@meta _ +---@class AceGUIMultiLineEditBox : AceGUIWidget +---@field protected button Button +---@field protected editBox EditBox +---@field protected label FontString +---@field protected labelHeight number +---@field protected numlines number +---@field protected scrollBar Frame +---@field protected scrollBG Frame|BackdropTemplate +---@field protected scrollFrame ScrollFrame +local AceGUIMultiLineEditBox = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param text string +function AceGUIMultiLineEditBox:SetText(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@return string +function AceGUIMultiLineEditBox:GetText() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param text string +function AceGUIMultiLineEditBox:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param num number +function AceGUIMultiLineEditBox:SetNumLines(num) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param flag boolean +function AceGUIMultiLineEditBox:SetDisabled(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param num number +function AceGUIMultiLineEditBox:SetMaxLetters(num) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param flag boolean +function AceGUIMultiLineEditBox:DisableButton(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +function AceGUIMultiLineEditBox:SetFocus() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-11-1) +---@param from? number +---@param to? number +function AceGUIMultiLineEditBox:HighlightText(from, to) end + +function AceGUIMultiLineEditBox:ClearFocus() end + +---@return number +function AceGUIMultiLineEditBox:GetCursorPosition() end + +---@param position number +function AceGUIMultiLineEditBox:SetCursorPosition(position) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Slider.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Slider.lua new file mode 100644 index 0000000..366255f --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceGUI-3.0/widgets/AceGUIWidget-Slider.lua @@ -0,0 +1,35 @@ +---@meta _ +---@class AceGUISlider : AceGUIWidget +---@field protected label FontString +---@field protected slider Slider|BackdropTemplate +---@field protected lowtext FontString +---@field protected hightext FontString +---@field protected editbox EditBox|BackdropTemplate +---@field protected alignoffset number +local AceGUISlider = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-12-1) +---@param value number +function AceGUISlider:SetValue(value) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-12-1) +---@return number +function AceGUISlider:GetValue() end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-12-1) +---@param min? number +---@param max? number +---@param step? number +function AceGUISlider:SetSliderValues(min, max, step) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-12-1) +---@param flag boolean +function AceGUISlider:SetIsPercent(flag) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-12-1) +---@param text string +function AceGUISlider:SetLabel(text) end + +---[Documentation](https://www.wowace.com/projects/ace3/pages/ace-gui-3-0-widgets#title-2-12-1) +---@param flag boolean +function AceGUISlider:SetDisabled(flag) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceHook-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceHook-3.0.lua new file mode 100644 index 0000000..3bbef4e --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceHook-3.0.lua @@ -0,0 +1,152 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- AceHook-3.0 +-- ---------------------------------------------------------------------------- + +---@class AceHook-3.0 +---@field hooks { [table]: { [string]: function } } | { [string]: function } +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0) +local AceHook = {} + +-- ---------------------------------------------------------------------------- +-- AceHook-3.0 Methods +-- ---------------------------------------------------------------------------- + +-- Hook a function or a method on an object. +-- +-- The hook created will be a "safe hook", that means that your handler will be called before the hooked function ("Pre-Hook"), and you don't have to call the original function yourself, however you cannot stop the execution of the function, or modify any of the arguments/return values. +-- +-- This type of hook is typically used if you need to know if some function got called, and don't want to modify it. +---@param object table The object to hook a method from +---@param method string The name of the object method to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) +---@param hookSecure? boolean If true, AceHook will allow hooking of secure functions. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-1) +function AceHook:Hook(object, method, handler, hookSecure) end + +-- Hook a function or a method on an object. +-- +-- The hook created will be a "safe hook", that means that your handler will be called before the hooked function ("Pre-Hook"), and you don't have to call the original function yourself, however you cannot stop the execution of the function, or modify any of the arguments/return values. +-- +-- This type of hook is typically used if you need to know if some function got called, and don't want to modify it. +---@param method string The name of the function to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) +---@param hookSecure? boolean If true, AceHook will allow hooking of secure functions. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-1) +function AceHook:Hook(method, handler, hookSecure) end + +-- Hook a script handler on a frame. +-- +-- The hook created will be a "safe hook", that means that your handler will be called before the hooked script ("Pre-Hook"), and you don't have to call the original function yourself, however you cannot stop the execution of the function, or modify any of the arguments/return values. +-- +-- This is the frame script equivalent of the :Hook safe-hook. It would typically be used to be notified when a certain event happens to a frame. +---@param frame Frame The Frame to hook the script on +---@param script ScriptFrame The script to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked script) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-2) +function AceHook:HookScript(frame, script, handler) end + +-- Check if the specific function, method or script is already hooked. +---@param obj table The object or frame to unhook from +---@param method string The name of the method, function or script to unhook from. +---@return boolean isHooked +---@return function|nil hookedFunction +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-3) +function AceHook:IsHooked(obj, method) end + +-- Check if the specific function, method or script is already hooked. +---@param method string The name of the method, function or script to unhook from. +---@return boolean isHooked +---@return function|nil hookedFunction +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-3) +function AceHook:IsHooked(method) end + +-- RawHook a function or a method on an object. +-- +-- The hook created will be a "raw hook", that means that your handler will completly replace the original function, and your handler has to call the original function (or not, depending on your intentions). +-- +-- The original function will be stored in `self.hooks[object][method]` or `self.hooks[functionName]` respectively. +-- +-- This type of hook can be used for all purposes, and is usually the most common case when you need to modify arguments or want to control execution of the original function. +---@param object table The object to hook a method from +---@param method string The name of the object method to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) +---@param hookSecure? boolean If true, AceHook will allow hooking of secure functions. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-4) +function AceHook:RawHook(object, method, handler, hookSecure) end + +-- RawHook a function or a method on an object. +-- +-- The hook created will be a "raw hook", that means that your handler will completly replace the original function, and your handler has to call the original function (or not, depending on your intentions). +-- +-- The original function will be stored in `self.hooks[object][method]` or `self.hooks[functionName]` respectively. +-- +-- This type of hook can be used for all purposes, and is usually the most common case when you need to modify arguments or want to control execution of the original function. +---@param method string The name of the function to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) +---@param hookSecure? boolean If true, AceHook will allow hooking of secure functions. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-4) +function AceHook:RawHook(method, handler, hookSecure) end + +-- RawHook a script handler on a frame. +-- +-- The hook created will be a "raw hook", that means that your handler will completly replace the original script, and your handler has to call the original script (or not, depending on your intentions). +-- +-- The original script will be stored in `self.hooks[frame][script]`. +-- +-- This type of hook can be used for all purposes, and is usually the most common case when you need to modify arguments or want to control execution of the original script. +---@param frame Frame The Frame to hook the script on +---@param script ScriptFrame The script to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked script) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-5) +function AceHook:RawHookScript(frame, script, handler) end + +-- SecureHook a function or a method on an object. +-- +-- This function is a wrapper around the `hooksecurefunc` function in the WoW API. Using AceHook extends the functionality of secure hooks, and adds the ability to unhook once the hook isn't required anymore, or the addon is being disabled. +-- +-- Secure Hooks should be used if the secure-status of the function is vital to its function, and taint would block execution. Secure Hooks are always called after the original function was called ("Post Hook"), and you cannot modify the arguments, return values or control the execution. +---@param object table The object to hook a method from +---@param method string The name of the object method to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-6) +function AceHook:SecureHook(object, method, handler) end + +-- SecureHook a function or a method on an object. +-- +-- This function is a wrapper around the `hooksecurefunc` function in the WoW API. Using AceHook extends the functionality of secure hooks, and adds the ability to unhook once the hook isn't required anymore, or the addon is being disabled. +-- +-- Secure Hooks should be used if the secure-status of the function is vital to its function, and taint would block execution. Secure Hooks are always called after the original function was called ("Post Hook"), and you cannot modify the arguments, return values or control the execution. +---@param method string The name of the function to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-6) +function AceHook:SecureHook(method, handler) end + +-- SecureHook a script handler on a frame. +-- +-- This function is a wrapper around the `frame:HookScript` function in the WoW API. Using AceHook extends the functionality of secure hooks, and adds the ability to unhook once the hook isn't required anymore, or the addon is being disabled. +-- +-- Secure Hooks should be used if the secure-status of the function is vital to its function, and taint would block execution. Secure Hooks are always called after the original function was called ("Post Hook"), and you cannot modify the arguments, return values or control the execution. +---@param frame Frame The Frame to hook the script on +---@param script ScriptFrame The script to hook +---@param handler? function|string The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked script) +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-7) +function AceHook:SecureHookScript(frame, script, handler) end + +-- Unhook from the specified function, method or script. +---@param obj table The object or frame to unhook from +---@param method string The name of the method, function or script to unhook from. +---@return boolean success Whether or not the operation was successful +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-8) +function AceHook:Unhook(obj, method) end + +-- Unhook from the specified function, method or script. +---@param method string The name of the method, function or script to unhook from. +---@return boolean success Whether or not the operation was successful +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-8) +function AceHook:Unhook(method) end + +-- Unhook all existing hooks for this addon. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-hook-3-0#title-9) +function AceHook:UnhookAll() end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceLocale-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceLocale-3.0.lua new file mode 100644 index 0000000..d3b9394 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceLocale-3.0.lua @@ -0,0 +1,32 @@ +---@meta _ +---@class AceLocale-3.0 +local AceLocale = {} + +---@param application string Unique name of addon / module +---@param silent? boolean If true, the locale is optional, silently return nil if it's not found (defaults to false, optional) +---@return table locale The locale table for the current language. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-locale-3-0#title-1) +function AceLocale:GetLocale(application, silent) end + +---@paramsig application, locale[, isDefault[, silent]] +---@param application string Unique name of addon / module +---@param locale AceLocale.LocaleCode Name of the locale to register, e.g. "enUS", "deDE", etc. +---@param isDefault? boolean If this is the default locale being registered. Your addon is written in this language, generally enUS, set this to true (defaults to false) +---@param silent? boolean If true, the locale will not issue warnings for missing keys. Must be `true` on the first locale registered. If set to "raw", nils will be returned for unknown keys (no metatable used). +---@return table? locale Locale Table to add localizations to, or nil if the current locale is not required. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-locale-3-0#title-2) +function AceLocale:NewLocale(application, locale, isDefault, silent) end + +---@alias AceLocale.LocaleCode +---|"deDE": German (Germany) +---|"enGB": English (Great Britain) +---|"enUS": English (America) +---|"esES": Spanish (Spain) +---|"esMX": Spanish (Mexico) +---|"frFR": French (France) +---|"itIT": Italian (Italy) +---|"koKR": Korean (Korea) +---|"ptBR": Portuguese (Brazil) +---|"ruRU": Russian (Russia) +---|"zhCN": Simplified Chinese (China) +---|"zhTW": Traditional Chinese (Taiwan) diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceSerializer-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceSerializer-3.0.lua new file mode 100644 index 0000000..c0b670a --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceSerializer-3.0.lua @@ -0,0 +1,16 @@ +---@meta _ +---@class AceSerializer-3.0 +local AceSerializer = {} + +---@param str string The serialized data (from :Serialize) +---@return boolean -- true followed by a list of values, OR false followed by an error message +---@return ... -- List of values or error message +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-serializer-3-0#title-1) +function AceSerializer:Deserialize(str)end + +---@param ... any List of values to serialize +---@return string -- The data in its serialized form (string) +--- --- +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-serializer-3-0#title-2) +function AceSerializer:Serialize(...) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceTab-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceTab-3.0.lua new file mode 100644 index 0000000..58e4e5b --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceTab-3.0.lua @@ -0,0 +1,35 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- AceTab-3.0 +-- ---------------------------------------------------------------------------- + +---@class AceTab-3.0 +local AceTab = {} + +-- stylua: ignore start + +-- Registers a tab completion set with AceTab +---@param descriptor string Unique identifier for this tab completion set +---@param prematches string|table|nil String match(es) AFTER which this tab completion will apply.
AceTab will ignore tabs NOT preceded by the string(s).
If no value is passed, will check all tabs pressed in the specified editframe(s) UNLESS a more-specific tab complete applies. +---@param wordlist function|table Function that will be passed a table into which it will insert strings corresponding to all possible completions, or an equivalent table.
The text in the editbox, the position of the start of the word to be completed, and the uncompleted partial word are passed as second, third, and fourth arguments, to facilitate pre-filtering or conditional formatting, if desired. +---@param usagefunc function|boolean|nil Usage statement function. Defaults to the wordlist, one per line. A boolean true squelches usage output. +---@param listenframes string|EditBox|nil EditFrames to monitor. Defaults to ChatFrameEditBox. +---@param postfunc function|nil Post-processing function. If supplied, matches will be passed through this function after they've been identified as a match. +---@param pmoverwrite boolean|number|nil Offset the beginning of the completion string in the editbox when making a completion.
Passing a boolean true indicates that we want to overwrite the entire prematch string, and passing a number will overwrite that many characters prior to the cursor.
This is useful when you want to use the prematch as an indicator character, but ultimately do not want it as part of the text, itself. +function AceTab:RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite) end + +-- stylua: ignore end + +-- Returns whether or not a tab completion set is registered. +---@param descriptor string Unique identifier for this tab completion set +---@return boolean +function AceTab:IsTabCompletionRegistered(descriptor) end + +-- Unregisters a tab completion set from AceTab +---@param descriptor string Unique identifier for this tab completion set +function AceTab:UnregisterTabCompletion(descriptor) end + +-- AceTab internal OnTabPressed script hook +---@param editBox EditBox The editbox to operate on +function AceTab:OnTabPressed(editBox) end diff --git a/docs/annotations/Annotations/Core/Libraries/Ace3/AceTimer-3.0.lua b/docs/annotations/Annotations/Core/Libraries/Ace3/AceTimer-3.0.lua new file mode 100644 index 0000000..03c3e57 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/Ace3/AceTimer-3.0.lua @@ -0,0 +1,37 @@ +---@meta _ +---@class AceTimerObj +---@field object table The object that the timer is registered on (self) +---@field func function Callback function +---@field looping boolean If true, the timer will loop +---@field argsCount number number of arguments to pass to the callback function +---@field delay number delay in seconds +---@field ends number GetTime() + delay, + +---@class AceTimer-3.0 +local AceTimer = {} + +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-timer-3-0#title-1) +function AceTimer:CancelAllTimers() end + +---@param id AceTimerObj The id of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer` +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-timer-3-0#title-2) +function AceTimer:CancelTimer(id) end + +---@param func function|string Callback function for the timer pulse (funcref or method name). +---@param delay number Delay for the timer, in seconds. +---@param ... any An optional, unlimited amount of arguments to pass to the callback function. +---@return AceTimerObj +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-timer-3-0#title-3) +function AceTimer:ScheduleRepeatingTimer(func, delay, ...) end + +---@param func function|string callback Callback function for the timer pulse (funcref or method name). +---@param delay number Delay for the timer, in seconds. +---@param ... any An optional, unlimited amount of arguments to pass to the callback function. +---@return AceTimerObj +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-timer-3-0#title-4) +function AceTimer:ScheduleTimer(func, delay, ...) end + +---@param id AceTimerObj The id of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer` +---@return number -- The time left on the timer. +---[Documentation](https://www.wowace.com/projects/ace3/pages/api/ace-timer-3-0#title-5) +function AceTimer:TimeLeft(id) end diff --git a/docs/annotations/Annotations/Core/Libraries/CallbackHandler-1.0/CallbackHandler-1.0.lua b/docs/annotations/Annotations/Core/Libraries/CallbackHandler-1.0/CallbackHandler-1.0.lua new file mode 100644 index 0000000..194d6a5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/CallbackHandler-1.0/CallbackHandler-1.0.lua @@ -0,0 +1,27 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- CallbackHandler-1.0 +-- ---------------------------------------------------------------------------- +---@class CallbackHandler-1.0 +local CallbackHandler = {} + +---@param target table target object to embed public APIs in +---@param RegisterName? string name of the callback registration API, default "RegisterCallback" +---@param UnregisterName? string name of the callback unregistration API, default "UnregisterCallback" +---@param UnregisterAllName? string name of the API to unregister all callbacks, default "UnregisterAllCallbacks". false == don't publish this API. +---@return CallbackHandlerRegistry +function CallbackHandler:New(target, RegisterName, UnregisterName, UnregisterAllName) end + +-- ---------------------------------------------------------------------------- +-- CallbackHandlerRegistry +-- ---------------------------------------------------------------------------- +---@class CallbackHandlerRegistry +---@field OnUnused? fun(registry: CallbackHandlerRegistry, target: table, eventName: string) If defined, called when an event stops. +---@field OnUsed? fun(registry: CallbackHandlerRegistry, target: table, eventName: string) If defined, called when an event starts. +local CallbackHandlerRegistry = {} + +---fires the given event/message into the registry +---@param eventname string +---@param ... unknown passed to the functions listening to the event. +function CallbackHandlerRegistry:Fire(eventname, ...) end diff --git a/docs/annotations/Annotations/Core/Libraries/ChatThrottleLib/ChatThrottleLib.lua b/docs/annotations/Annotations/Core/Libraries/ChatThrottleLib/ChatThrottleLib.lua new file mode 100644 index 0000000..e318ef6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/ChatThrottleLib/ChatThrottleLib.lua @@ -0,0 +1,50 @@ +---@meta _ + +---@class ChatThrottleLib +---[Documentation](https://warcraft.wiki.gg/wiki/ChatThrottleLib) +ChatThrottleLib = {} + +---@alias ChatThrottleLib.prio "BULK"|"NORMAL"|"ALERT" + +---@param prio ChatThrottleLib.prio +---@param prefix string +---@param text string +---@param chattype string +---@param languageID? number +---@param destination? string +---@param queueName? string +---@param callbackFn? function +---@param callbackArg? any +---[Documentation](https://warcraft.wiki.gg/wiki/ChatThrottleLib#ChatThrottleLib:SendChatMessage) +function ChatThrottleLib:SendChatMessage(prio, prefix, text, chattype, languageID, destination, queueName, callbackFn, callbackArg) end + +---@param prio ChatThrottleLib.prio +---@param prefix string +---@param text string +---@param chattype string +---@param target? string +---@param queueName? string +---@param callbackFn? function +---@param callbackArg? any +---[Documentation](https://warcraft.wiki.gg/wiki/ChatThrottleLib#ChatThrottleLib:SendAddonMessage) +function ChatThrottleLib:SendAddonMessage(prio, prefix, text, chattype, target, queueName, callbackFn, callbackArg) end + +---@param prio ChatThrottleLib.prio +---@param prefix string +---@param text string +---@param chattype string +---@param target? string +---@param queueName? string +---@param callbackFn? function +---@param callbackArg? any +function ChatThrottleLib:SendAddonMessageLogged(prio, prefix, text, chattype, target, queueName, callbackFn, callbackArg) end + +---@param prio ChatThrottleLib.prio +---@param prefix string +---@param text string +---@param chattype string must be WHISPER +---@param gameAccountID number +---@param queueName? string +---@param callbackFn? function +---@param callbackArg? any +function ChatThrottleLib:BNSendGameData(prio, prefix, text, chattype, gameAccountID, queueName, callbackFn, callbackArg) end diff --git a/docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-2.0.lua b/docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-2.0.lua new file mode 100644 index 0000000..5b5694b --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-2.0.lua @@ -0,0 +1,164 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- HereBeDragons-2.0 +-- ---------------------------------------------------------------------------- + +---@class HereBeDragons-2.0 +---[Documentation](https://www.wowace.com/projects/herebedragons/pages/api/here-be-dragons-2-0) +local lib = {} + +-- ---------------------------------------------------------------------------- +-- Map Info +-- ---------------------------------------------------------------------------- + +--- Get a table with all known UI Map IDs +---@return number[] uiMapIDs An array-style table with all known/valid map IDs +function lib:GetAllMapIDs() end + +--- Get the localized name of the map +---@param uiMapID number The ID of the map to query +---@return string mapName The localized name of the map +function lib:GetLocalizedMap(uiMapID) end + +--- Get the physical size of a zone, in yards +---@param uiMapID number The ID of the map to query +---@return number width Zone Width in Yards +---@return number height Zone Height in Yards +function lib:GetZoneSize(uiMapID) end + +-- ---------------------------------------------------------------------------- +-- Coordinate Transformation +-- ---------------------------------------------------------------------------- + +--- Get the Azeroth World Map Coordinates to the specified World Coordinates, within the specified continent instance. +---@param x number X coordinates in the World Coordinate system +---@param y number Y coordinates in the World Coordinate system +---@param instance number InstanceID of the continent these coordinates belong to +---@param allowOutOfBounds? boolean If true, do not clip the coordinates into the 0-1 range if the point is outside of the current map. +---@return number x X coordinate in the Zone Coordinate system +---@return number y Y coordinate in the Zone Coordinate system +function lib:GetAzerothWorldMapCoordinatesFromWorld(x, y, instance, allowOutOfBounds) end + +--- Get the World Coordinates to the specified Azeroth world map coordinates +---@param x number X coordinates in the zone coordinate system (0-1) +---@param y number Y coordinates in the zone coordinate system (0-1) +---@param instance number InstanceID of the continent these coordinates belong to +---@return number x X coordinate in the World Coordinate system +---@return number y Y coordinate in the World Coordinate system +function lib:GetWorldCoordinatesFromAzerothWorldMap(x, y, instance) end + +--- Get the World Coordinates to the specified Zone Coordinates +---@param x number X coordinates in the Zone Coordinate system (0-1) +---@param y number Y coordinates in the Zone Coordinate system (0-1) +---@param zone number UIMapID of the zone +---@return number x X coordinate in the World Coordinate system +---@return number y Y coordinate in the World Coordinate system +function lib:GetWorldCoordinatesFromZone(x, y, zone) end + +--- Calculate the distance between two points in the same World Coordinate system (ie. the same instance) +---@param instanceID number Instance ID of the World Coordinate system (currently unused) +---@param oX number X coordinate of the origin point +---@param oY number Y coordinate of the origin point +---@param dX number X coordinate of the destination point +---@param dY number Y coordinate of the destination point +---@return number distance Distance in yards +---@return number deltaX Delta of the X coordinate in yards +---@return number deltaY Delta of the Y coordinate in yards +function lib:GetWorldDistance(instanceID, oX, oY, dX, dY) end + +--- Calculate a vector between the two points in the World Coordinate system +---@param instanceID number Instance ID of the World Coordinate system (currently unused) +---@param oX number X coordinate of the origin point +---@param oY number Y coordinate of the origin point +---@param dX number X coordinate of the destination point +---@param dY number Y coordinate of the destination point +---@return number angle The angle between the two points, in radians +---@return number distance Distance in yards +function lib:GetWorldVector(instanceID, oX, oY, dX, dY) end + +--- Get the Zone Coordinates to the specified World Coordinates, within the specified zone. +--- +--- Note: It is the callers responsibility to ensure the x/y coordinates are in the same instance/continent as the zone. +---@param x number X coordinates in the World Coordinate system +---@param y number Y coordinates in the World Coordinate system +---@param zone number UIMapID of the zone of the destination Zone Coordinate system +---@param allowOutOfBounds? boolean If true, do not clip the coordinates into the 0-1 range if the point is outside of the current map. +---@return number x X coordinate in the Zone Coordinate system +---@return number y Y coordinate in the Zone Coordinate system +function lib:GetZoneCoordinatesFromWorld(x, y, zone, allowOutOfBounds) end + +--- Calculate the distance between two points in different zones. +--- +--- Note: Both zones need to be on the same continent for this function to return valid values. +---@param oZone number UIMapID of the origin zone +---@param oX number X coordinate of the origin point +---@param oY number Y coordinate of the origin point +---@param dZone number UIMapID of the destination zone +---@param dX number X coordinate of the destination point +---@param dY number Y coordinate of the destination point +---@return number distance Distance in yards +---@return number deltaX Delta of the X coordinate in yards +---@return number deltaY Delta of the Y coordinate in yards +function lib:GetZoneDistance(oZone, oX, oY, dZone, dX, dY) end + +--- Translate the coordinates between two Zone Coordinate systems +---@param x number X coordinate in the origin zone +---@param y number Y coordinate in the origin zone +---@param oZone number UIMapID of the origin zone +---@param dZone number UIMapID of the destination zone +---@param allowOutOfBounds? boolean If true, do not clip the coordinates into the 0-1 range if the point is outside of the destination map. +---@return number x X coordinate in the destination Zone Coordinate system +---@return number y Y coordinate in the destination Zone Coordinate system +function lib:TranslateZoneCoordinates(x, y, oZone, dZone, allowOutOfBounds) end + +-- ---------------------------------------------------------------------------- +-- Unit Position +-- ---------------------------------------------------------------------------- + +--- Retrieve the world position of the player. +--- +--- Same as calling HBD:GetUnitWorldPosition("player") +---@return number x X coordinate of the player's position +---@return number y Y coordinate of the player's position +---@return number instance Instance ID of the World Coordinate system the player is in +function lib:GetPlayerWorldPosition() end + +--- Retrieve the zone information the player is currently in. +--- +--- This function does not rely on the world map to retrieve the player's current position. +---@return number currentPlayerUIMapID The UIMapID of the zone +---@return Enum.UIMapType currentPlayerUIMapType The UIMapType of the current map +function lib:GetPlayerZone() end + +--- Retrieve the zone information the player is currently in. +--- +--- This function does not rely on the world map to retrieve the player's current position. +---@return number x X Zone Coordinate of the player +---@return number y Y Zone Coordinate of the player +---@return number currentPlayerUIMapID The UIMapID of the zone +---@return Enum.UIMapType currentPlayerUIMapType The UIMapType of the current map +function lib:GetPlayerZonePosition() end + +--- Get the world position of any unit eligible for UnitPosition +---@param unitID UnitToken Supports player, party, raid only +---@return number x X coordinate of the unit's position +---@return number y Y coordinate of the unit's position +---@return number instance Instance ID of the World Coordinate system the unit is in +function lib:GetUnitWorldPosition(unitID) end + +-- ---------------------------------------------------------------------------- +-- Callbacks +-- ---------------------------------------------------------------------------- + +---@alias HereBeDragons.EventName +---|"PlayerZoneChanged" + +---@param target table The object registering to listen for the callback. +---@param eventName HereBeDragons.EventName The event to register. +---@param method string|function The method to call when the event is fired. +function lib.RegisterCallback(target, eventName, method) end + +---@param target table The object unregistering to listen for the callback. +---@param eventName HereBeDragons.EventName The event to unregister. +function lib.UnregisterCallback(target, eventName) end diff --git a/docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-Pins-2.0.lua b/docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-Pins-2.0.lua new file mode 100644 index 0000000..652a3d4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/HereBeDragons-2.0/HereBeDragons-Pins-2.0.lua @@ -0,0 +1,99 @@ +-- ---------------------------------------------------------------------------- +-- HereBeDragons-Pins-2.0 +-- ---------------------------------------------------------------------------- +---@meta _ +---@class HereBeDragons-Pins-2.0 +local lib = {} + +-- ---------------------------------------------------------------------------- +-- Minimap +-- ---------------------------------------------------------------------------- + +--- Add a icon to the minimap, specified by World Coordinates +---@param ref string|table Reference to track the icons under, typically a reference to your addon +---@param icon Frame The icon frame +---@param instanceID number The instance ID of the World Coordinate system +---@param x number X World Coordinate +---@param y number Y World Coordinate +---@param floatOnEdge? boolean Flag if the icon should float on the edge of the map when it goes beyond the visible area, or be hidden. +function lib:AddMinimapIconWorld(ref, icon, instanceID, x, y, floatOnEdge) end + +--- Add an icon to the minimap, specified by the uiMapID and local Zone Coordinates +---@param ref string|table Reference to track the icons under, typically a reference to your addon +---@param icon Frame The icon frame +---@param uiMapID number UI Map ID of the map to place the icon on +---@param x number X position in local Zone Coordinates +---@param y number Y position in local Zone Coordinates +---@param showInParentZone? boolean Flag if the icon should be shown in the parent zone (if any) of the specified zone. If false, it'll only be shown in the specified zone. +---@param floatOnEdge? boolean Flag if the icon should float on the edge of the map when it goes beyond the visible area, or be hidden. +function lib:AddMinimapIconMap(ref, icon, uiMapID, x, y, showInParentZone, floatOnEdge) end + +--- Check wether an icon is floating on the edge of the map +---@param icon Frame The icon frame +---@return boolean|nil +function lib:IsMinimapIconOnEdge(icon) end + +--- Remove the specified Minimap Icon +---@param ref string|table Reference to track the icons under, typically a reference to your addon +---@param icon Frame The icon frame +function lib:RemoveMinimapIcon(ref, icon) end + +--- Remove all minimap icons registered to the reference "ref" +---@param ref string|table Reference to track the icons under, typically a reference to your addon +function lib:RemoveAllMinimapIcons(ref) end + +--- Set an alternative Minimap to draw icons on. +---@param minimapObject? Minimap The new minimap object, or nil to restore the default +function lib:SetMinimapObject(minimapObject) end + +-- ---------------------------------------------------------------------------- +-- World Map Constants +-- ---------------------------------------------------------------------------- + +HBD_PINS_WORLDMAP_SHOW_PARENT = 1 --- Show pin on the specified map and zone parent maps +HBD_PINS_WORLDMAP_SHOW_CONTINENT = 2 --- Show pin on parent and the continent map +HBD_PINS_WORLDMAP_SHOW_WORLD = 3 --- Show pin on parent, continent and the world map + +---@alias HereBeDragons-Pins-2.0.WorldMapShowFlag +---|1 # HBD_PINS_WORLDMAP_SHOW_PARENT +---|2 # HBD_PINS_WORLDMAP_SHOW_CONTINENT +---|3 # HBD_PINS_WORLDMAP_SHOW_WORLD + +-- ---------------------------------------------------------------------------- +-- World Map +-- ---------------------------------------------------------------------------- + +--- Add an Icon to the World Map using World Coordinates +---@param ref string|table Reference to track the icons under, typically a reference to your addon +---@param icon Frame The icon frame +---@param instanceID number The instance ID of the World Coordinate system +---@param x number X World Coordinate +---@param y number Y World Coordinate +---@param showFlag? HereBeDragons-Pins-2.0.WorldMapShowFlag Flag where to show the pin. If no flag is specified, the pin is only shown on the specified map. +---@param frameLevelType? string Optional Frame Level type registered with the WorldMapFrame, defaults to PIN_FRAME_LEVEL_AREA_POI +function lib:AddWorldMapIconWorld(ref, icon, instanceID, x, y, showFlag, frameLevelType) end + +--- Add a Icon to the World Map using uiMapID and local zone coordinates +---@param ref string|table Reference to track the icons under, typically a reference to your addon +---@param icon Frame The icon frame +---@param uiMapID number UI Map ID of the map to place the icon on +---@param x number X position in local Zone Coordinates +---@param y number Y position in local Zone Coordinates +---@param showFlag? HereBeDragons-Pins-2.0.WorldMapShowFlag Flag where to show the pin. If no flag is specified, the pin is only shown on the specified map. +---@param frameLevelType? string Optional Frame Level type registered with the WorldMapFrame, defaults to PIN_FRAME_LEVEL_AREA_POI +function lib:AddWorldMapIconMap(ref, icon, uiMapID, x, y, showFlag, frameLevelType) end + +--- Remove the specified World Map Icon +---@param ref string|table Reference to track the icons under, typically a reference to your addon +---@param icon Frame The icon frame +function lib:RemoveWorldMapIcon(ref, icon) end + +--- Remove all World Map icons registered to the reference "ref" +---@param ref string|table Reference to track the icons under, typically a reference to your addon +function lib:RemoveAllWorldMapIcons(ref) end + +--- Compute the vector to an icon, see HereBeDragons-2.0 GetWorldVector for usage. +---@param icon Frame The icon frame +---@return number angle The angle, in radians +---@return number distance Distance in yards +function lib:GetVectorToIcon(icon) end diff --git a/docs/annotations/Annotations/Core/Libraries/LibDBIcon-1.0/LibDBIcon-1.0.lua b/docs/annotations/Annotations/Core/Libraries/LibDBIcon-1.0/LibDBIcon-1.0.lua new file mode 100644 index 0000000..3fac094 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibDBIcon-1.0/LibDBIcon-1.0.lua @@ -0,0 +1,111 @@ +---@meta _ +---@class LibDBIcon-1.0 +---@field loggedIn boolean +---@field callbackRegistered boolean +---@field objects table +---@field radius integer +---@field isDraggingButton boolean +---@field tooltip Frame : GameTooltipTemplate +---@field notCreated table +---@field callbacks CallbackHandlerRegistry +local lib = {} + +---@alias LibDBIcon.CallbackKey "icon"|"iconCoords"|"iconR"|"iconG"|"iconB" + +---@param event any +---@param name string +---@param key LibDBIcon.CallbackKey +---@param value string|number +function lib:IconCallback(event, name, key, value) +end + +---@param name string +---@param object LibDataBroker.DataObject +---@param db? LibDBIcon.button.DB +function lib:Register(name, object, db) +end + +---@param name string +function lib:Lock(name) +end + +---@param name string +function lib:Unlock(name) +end + +---@param name string +function lib:Hide(name) +end + +---@param name string +function lib:Show(name) +end + +---@param name string +---@return boolean +function lib:IsRegistered(name) +end + +---@param name string +---@param db LibDBIcon.button.DB +function lib:Refresh(name, db) +end + +---@param name string +---@return LibDBIcon.button +function lib:GetMinimapButton(name) +end + +---@return table +function lib:GetButtonList() +end + +---Use to set the radius of the minimap +---@param radius integer +function lib:SetButtonRadius(radius) +end + +---@param button string|LibDBIcon.button +---@param position integer +function lib:SetButtonToPosition(button, position) +end + +---@param buttonName string +---@return boolean +function lib:IsButtonInCompartment(buttonName) +end + +---@param buttonName string +---@param customIcon? string|number +function lib:AddButtonToCompartment(buttonName, customIcon) +end + +---@param buttonName string +function lib:RemoveButtonFromCompartment(buttonName) +end + +---@class LibDBIcon.button.DB +---@field hide boolean +---@field lock boolean +---@field minimapPos integer +local DB = {} + +---@class LibDBIcon.dataObject +---@field OnClick function +---@field icon string|number +---@field iconR integer +---@field iconG integer +---@field iconB integer +local dataObject = {} + +---@class LibDBIcon.button.icon : Texture +local icon = {} +icon.UpdateCoord = function() end + +---@class LibDBIcon.button : Button +local button = {} +button.dataObject = dataObject +button.db = DB +button.icon = icon +button.isMouseDown = false +button.fadeOut = {} ---@type AnimationGroup \ No newline at end of file diff --git a/docs/annotations/Annotations/Core/Libraries/LibDataBroker-1.1/LibDataBroker-1.1.lua b/docs/annotations/Annotations/Core/Libraries/LibDataBroker-1.1/LibDataBroker-1.1.lua new file mode 100644 index 0000000..340da3d --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibDataBroker-1.1/LibDataBroker-1.1.lua @@ -0,0 +1,91 @@ +---@meta _ + +-------------------------------------------------------------------------------- +---- LibDataBroker-1.1 +-------------------------------------------------------------------------------- + +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/API) +---@class LibDataBroker-1.1 +local lib = {} + +---@param name string +---@param dataObject? LibDataBroker.DataObject +---@return LibDataBroker.DataObject +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/API#ldbnewdataobjectname-dataobject--dataobject) +function lib:NewDataObject(name, dataObject) end + +---@param dataObjectName string +---@return LibDataBroker.DataObject +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/API#ldbgetdataobjectbynamedataobjectname--dataobject) +function lib:GetDataObjectByName(dataObjectName) end + +---@param dataObject LibDataBroker.DataObject +---@return string +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/API#ldbgetnamebydataobjectdataobject--name) +function lib:GetNameByDataObject(dataObject) end + +---@return table +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/API#ldbdataobjectiterator) +function lib:DataObjectIterator() end + +---@param addon table|string +---@param eventName string +---@param method? string|function +---@param arg? any +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/API#ldbregistercallbackmytable-or-myaddonid-eventname-method-arg) +function lib:RegisterCallback(addon, eventName, method, arg) end + +-------------------------------------------------------------------------------- +-- LibDataBroker.DataDisplay +-------------------------------------------------------------------------------- +-- Data display addons provide a LDB “feed” for an always-up addon to display. These addons can be thought of like RSS feeds, where the display addon is similar to an RSS reader. +-- +--- --- +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/data-specifications#data-display) +---@class LibDataBroker.DataDisplay: LibDataBroker.DataObjectCommonFields +---@field type "data source" Indicates that this data object is a data source. +---@field text string The text to be shown. +---@field value string? Raw value from the text, for example text "75.0 FPS" would have value "75.0" +---@field suffix string? The “unit” appended to the end of text. For example text "75.0 FPS" would have the suffix "FPS" +---@field label string? A title for your feed, often shown to the left of the text, user might choose to hide this. If missing, the dataobject’s name may be used instead. +---@field icon string? Full path to a texture, often shown to the left of the label or text. +---@field OnClick fun(displayFrame: Frame, buttonName: string)? An OnClick script handler to be directly attached to the display frame. +---@field OnEnter fun(displayFrame: Frame)? An OnEnter script handler to be directly attached to the display frame. Usually used to display a tooltip. This handler should check the position of the frame it is passed and anchor the tooltip to that frame accordingly. +---@field OnLeave fun(displayFrame: Frame)? An OnLeave script handler to be directly attached to the display frame. Usually used to hide the toolip. +---@field tooltip Frame? A frame to be displayed when the display frame is entered. The display addon is responsible for anchoring, showing and hiding this frame as needed. The tooltip frame’s OnShow can be used to refresh the frame. Note that this frame doesn’t have to be a GameTooltip. + +-------------------------------------------------------------------------------- +-- LibDataBroker.QuickLauncher +-------------------------------------------------------------------------------- +-- A quicklauncher is a LDB object that does not provide any data, but instead provides an OnClick handler to allow fast access to config panels, toggle settings, or perform other actions. +-- +-- Quicklaunchers should never expect a secure frame to be used, therefore actions like spellcasting are not possible. +-- +--- --- +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/data-specifications#data-display) +---@class LibDataBroker.QuickLauncher: LibDataBroker.DataObjectCommonFields +---@field type "launcher" Indicates that this data object is a launcher and does not provide any data to be rendered in an always-up frame. +---@field icon string Full path to a texture for display. +---@field OnClick fun(displayFrame: Frame, buttonName: string) An OnClick script handler to be directly attached to the display frame. +---@field tocname string? The name of the addon providing the launcher, if it’s name does not match the DataObject’s name. Used by displays to get TOC metadata about the addon. +---@field label string? A label to use for the launcher, overriding the DataObject name. + +-------------------------------------------------------------------------------- +-- LibDataBroker.DataObject +-------------------------------------------------------------------------------- +-- Represents either a DataDisplay or a Quicklauncher. +-- +--- +---[Documentation](https://github.com/tekkub/libdatabroker-1-1/wiki/data-specifications) +---@alias LibDataBroker.DataObject LibDataBroker.DataDisplay|LibDataBroker.QuickLauncher + +-------------------------------------------------------------------------------- +-- LibDataBroker.DataObjectCommonFields +-------------------------------------------------------------------------------- +-- Fields common to both the LibDataBroker.DataDisplay and LibDataBroker.QuickLauncher types. +---@class LibDataBroker.DataObjectCommonFields +---@field iconR number? The red component value to be used when coloring the icon. +---@field iconG number? The green component value to be used when coloring the icon. +---@field iconB number? The blue component value to be used when coloring the icon. +---@field iconCoords table? A table containing the arguments to be supplied to SetTexCoord() on the icon texture. Combined with icon, iconR, iconG and iconB this attribute provides a way for addons to use icons that require TexCoords (such as re-using the icons from the default user interface without the button background). This is currently used by TomTom to display a spinning arrow that points towards your current waypoint. +---@field OnTooltipShow fun(tooltip: GameTooltip)? A function to call when the display wants to show a tooltip. The display will manage positioning, clearing and showing the tooltip, all this handler needs to do is populate the tooltip using :AddLine or similar. The display should pass the tooltip to this callback, in case it isn’t using GameTooltip. The display shouldn’t pass a non-GameTooltip frame unless it mimics the API of GameTooltip. diff --git a/docs/annotations/Annotations/Core/Libraries/LibDeflate/LibDeflate.lua b/docs/annotations/Annotations/Core/Libraries/LibDeflate/LibDeflate.lua new file mode 100644 index 0000000..b338772 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibDeflate/LibDeflate.lua @@ -0,0 +1,192 @@ +---@meta _ +---@class LibDeflate +local lib = {} + +---@alias LibDeflate.Dictionary { adler32: integer, hash_tables: table, string_table: table, strlen: integer } + +---Calculate the Adler-32 checksum of the string. +--- +---See RFC1950 Page 9 https://tools.ietf.org/html/rfc1950 for the definition of Adler-32 checksum. +---@param str string the input string to calcuate its Adler-32 checksum. +---@return integer checksum The Adler-32 checksum, which is greater or equal to 0, and less than 2^32 (4294967296). +function lib:Adler32(str) +end + +---Create a preset dictionary. +--- +---This function is not fast, and the memory consumption of the produced dictionary is about 50 times of the input string. Therefore, it is suggestted to run +---this function only once in your program. +--- +---It is very important to know that if you do use a preset dictionary, compressors and decompressors MUST USE THE SAME dictionary. That is, dictionary must be +---created using the same string. If you update your program with a new dictionary, people with the old version won't be able to transmit data with people with +---the new version. Therefore, changing the dictionary must be done very carefully. +--- +---The parameters `strlen` and `adler32` add a layer of verification to ensure the parameter `str` is not modified unintentionally during the program +---development. +--- +--- ``` +---local dict_str = "1234567890" +--- +----- print(dict_str:len(), LibDeflate:Adler32(dict_str)) +----- Hardcode the print result below to verify it to avoid accidental modification of 'str' during the program development. +----- string length: 10, Adler-32: 187433486, +----- Don't calculate string length and its Adler-32 at run-time. +--- +---local dict = LibDeflate:CreateDictionary(dict_str, 10, 187433486) +--- ``` +--- +---@param str string The string used as the preset dictionary.
You should put stuffs that frequently appears in the dictionary string and preferablely put more appeared stuff toward the end of the string.
Empty string and string longer than `32768` bytes are not allowed. +---@param strlen integer The length of `str`. Please pass in this parameter as a hardcoded constant, in order to verify the content of `str`. The value of this parameter should be known before your program runs. +---@param adler32 integer The Adler-32 checksum of `str`. Please pass in this parameter as a hardcoded constant, in order to verify the content of `str`. The value of this parameter should be known before your program runs. +---@return LibDeflate.Dictionary dictionary The dictionary used for preset dictionary compression and decompression. +function lib:CreateDictionary(str, strlen, adler32) +end + +---Compress using the raw deflate format. +---@param str string The data to be compressed. +---@param configs? table The configuration table to control the compression. If nil, use the default configuration. +---@return string data The compressed data. +---@return integer padding The number of bits padded at the end of output. `0 <= bits < 8`
This means the most significant "bits" of the last byte of the returned compressed data are padding bits and they don't affect decompression. You don't need to use this value unless you want to do some postprocessing to the compressed data. +function lib:CompressDeflate(str, configs) +end + +---Compress using the raw deflate format with a preset dictionary. +---@param str string The data to be compressed. +---@param dictionary LibDeflate.Dictionary The preset dictionary produced by `LibDeflate:CreateDictionary` +---@param configs? table The configuration table to control the compression. If nil, use the default configuration. +---@return string data The compressed data. +---@return integer padding The number of bits padded at the end of output. `0 <= bits < 8`
This means the most significant "bits" of the last byte of the returned compressed data are padding bits and they don't affect decompression. You don't need to use this value unless you want to do some postprocessing to the compressed data. +function lib:CompressDeflateWithDict(str, dictionary, configs) +end + +---Compress using the zlib format. +---@param str string The data to be compressed. +---@param configs? table The configuration table to control the compression. If nil, use the default configuration. +---@return string data The compressed data. +---@return integer padding The number of bits padded at the end of output. Should always be 0. Zlib formatted compressed data never has padding bits at the end. +function lib:CompressZlib(str, configs) +end + +---Compress using the zlib format with a preset dictionary. +---@param str string The data to be compressed. +---@param dictionary LibDeflate.Dictionary The preset dictionary produced by `LibDeflate:CreateDictionary` +---@param configs? table The configuration table to control the compression. If nil, use the default configuration. +---@return string data The compressed data. +---@return integer padding The number of bits padded at the end of output. Should always be 0. Zlib formatted compressed data never has padding bits at the end. +function lib:CompressZlib(str, dictionary, configs) +end + +---Decompress a raw deflate compressed data. +---@param str string The data to be decompressed. +---@return string? data If the decompression succeeds, return the decompressed data. If the decompression fails, return nil. You should check if this return value is non-nil to know if the decompression succeeds. +---@return integer? numUnprocessedBytes If the decompression succeeds, return the number of unprocessed bytes in the input compressed data. This return value is a positive integer if the input data is a valid compressed data appended by an arbitary non-empty string. This return value is 0 if the input data does not contain any extra bytes.
If the decompression fails (The first return value of this function is nil), this return value is undefined. +function lib:DecompressDeflate(str) +end + +---Decompress a raw deflate compressed data with a preset dictionary. +---@param str string The data to be decompressed. +---@param dictionary LibDeflate.Dictionary The preset dictionary used by `LibDeflate:CompressDeflateWithDict` when the compressed data is produced. Decompression and compression must use the same dictionary. Otherwise wrong decompressed data could be produced without generating any error. +---@return string? data If the decompression succeeds, return the decompressed data. If the decompression fails, return nil. You should check if this return value is non-nil to know if the decompression succeeds. +---@return integer? numUnprocessedBytes If the decompression succeeds, return the number of unprocessed bytes in the input compressed data. This return value is a positive integer if the input data is a valid compressed data appended by an arbitary non-empty string. This return value is 0 if the input data does not contain any extra bytes.
If the decompression fails (The first return value of this function is nil), this return value is undefined. +function lib:DecompressDeflateWithDict(str, dictionary) +end + +---Decompress a zlib compressed data. +---@param str string The data to be decompressed. +---@return string? data If the decompression succeeds, return the decompressed data. If the decompression fails, return nil. You should check if this return value is non-nil to know if the decompression succeeds. +---@return integer? numUnprocessedBytes If the decompression succeeds, return the number of unprocessed bytes in the input compressed data. This return value is a positive integer if the input data is a valid compressed data appended by an arbitary non-empty string. This return value is 0 if the input data does not contain any extra bytes.
If the decompression fails (The first return value of this function is nil), this return value is undefined. +function lib:DecompressZlib(str) +end + +---Decompress a raw deflate compressed data with a preset dictionary. +---@param str string The data to be decompressed. +---@param dictionary LibDeflate.Dictionary The preset dictionary used by `LibDeflate:CompressZlibWithDict` when the compressed data is produced. Decompression and compression must use the same dictionary. Otherwise wrong decompressed data could be produced without generating any error. +---@return string? data If the decompression succeeds, return the decompressed data. If the decompression fails, return nil. You should check if this return value is non-nil to know if the decompression succeeds. +---@return integer? numUnprocessedBytes If the decompression succeeds, return the number of unprocessed bytes in the input compressed data. This return value is a positive integer if the input data is a valid compressed data appended by an arbitary non-empty string. This return value is 0 if the input data does not contain any extra bytes.
If the decompression fails (The first return value of this function is nil), this return value is undefined. +function lib:DecompressZlibWithDict(str, dictionary) +end + +---Create a custom codec with encoder and decoder. +--- +---This codec is used to convert an input string to make it not contain some specific bytes. This created codec and the parameters of this function do NOT take +---localization into account. One byte (0-255) in the string is exactly one character (0-255). Credits to LibCompress. +--- +---``` +----- Create an encoder/decoder that maps all "\000" to "\003", and escape "\001" (and "\002" and "\003") properly +---local codec = LibDeflate:CreateCodec("\000\001", "\002", "\003") +--- +---local encoded = codec:Encode(SOME_STRING) +----- "encoded" does not contain "\000" or "\001" +---local decoded = codec:Decode(encoded) +----- assert(decoded == SOME_STRING) +---``` +---@param reserved_chars string The created encoder will ensure encoded data does not contain any single character in reserved_chars. This parameter should be non-empty. +---@param escape_chars string The escape character(s) used in the created codec. The codec converts any character included in `reserved_chars` / `escape_chars` / `map_chars` to (one escape char + one character not in `reserved_chars` / `escape_chars` / `map_chars`). You usually only need to provide a length-1 string for this parameter. Length-2 string is only needed when `reserved_chars` + `escape_chars` + `map_chars` is longer than 127. This parameter should be non-empty. +---@param map_chars string The created encoder will map every `reserved_chars:sub(i, i) (1 <= i <= #map_chars)` to `map_chars:sub(i, i)`. This parameter CAN be empty string. +---@return LibDeflate.Codec? codec If the codec cannot be created, return nil. If the codec can be created according to the given parameters, return the codec, which is a encode/decode table. +---@return string? error If the codec is successfully created, return nil. If not, return a string that describes the reason why the codec cannot be created. +function lib:CreateCodec(reserved_chars, escape_chars, map_chars) +end + +---Encode the string to make it ready to be transmitted in World of Warcraft addon channel. +--- +---The encoded string is guaranteed to contain no NULL ("\000") character. +---@param str string The string to be encoded. +---@return string encoded The encoded string. +function lib:EncodeForWoWAddonChannel(str) +end + +---Decode the string produced by `LibDeflate:EncodeForWoWAddonChannel` +---@param str string The string to be decoded. +---@return string? decoded The decoded string if succeeds. nil if fails. +function lib:DecodeForWoWAddonChannel(str) +end + +---Encode the string to make it ready to be transmitted in World of Warcraft chat channel. +--- +---See also https://warcraft.wiki.gg/wiki/Valid_chat_message_characters +---@param str string The string to be encoded. +---@return string encoded The encoded string. +function lib:EncodeForWoWChatChannel(str) +end + +---Decode the string produced by `LibDeflate:EncodeForWoWChatChannel`. +---@param str string The string to be decoded. +---@return string? decoded The decoded string if succeeds. nil if fails. +function lib:DecodeForWoWChatChannel(str) +end + +---Encode the string to make it printable. +--- +---Credis to WeakAuras2, this function is equivalant to the implementation it is using right now. +--- +---The encoded string will be 25% larger than the origin string. However, every single byte of the encoded string will be one of 64 printable ASCII characters +---which are can be easier copied, pasted and displayed. (26 lowercase letters, 26 uppercase letters, 10 numbers digits, left parenthese, or right parenthese) +---@param str string The string to be encoded. +---@return string encoded The encoded string. +function lib:EncodeForPrint(str) +end + +---Decode the printable string produced by `LibDeflate:EncodeForPrint`. +--- +---`str` will have its prefixed and trailing control characters or space removed before it is decoded, so it is easier to use if "str" comes form user copy and +---paste with some prefixed or trailing spaces. Then decode fails if the string contains any characters cant be produced by `LibDeflate:EncodeForPrint`. That +---means, decode fails if the string contains a characters NOT one of 26 lowercase letters, 26 uppercase letters, 10 numbers digits, left parenthese, or right +---parenthese. +---@param str string The string to be decoded. +---@return string? decoded The decoded string if succeeds. nil if fails. +function lib:DecodeForPrint(str) +end + +---@class LibDeflate.Codec +local codec = {} + +---@param str string +---@return string encoded The encoded string +function codec:Encode(str) +end + +---@param str string +---@return string? decoded The decoded string if succeeds. nil if fails. +function codec:Decode(str) +end diff --git a/docs/annotations/Annotations/Core/Libraries/LibDialog-1.0/LibDialog-1.0.lua b/docs/annotations/Annotations/Core/Libraries/LibDialog-1.0/LibDialog-1.0.lua new file mode 100644 index 0000000..6a1a764 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibDialog-1.0/LibDialog-1.0.lua @@ -0,0 +1,154 @@ +-- ---------------------------------------------------------------------------- +-- LibDialog-1.0 +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibDialog-1.0 +local lib = {} + +--- Determines whether or not a specific dialog is currently active. +---@param reference string|LibDialog.Delegate The delegate criteria for the dialog being targeted. Can be either a string, in which case the delegate must be registered, or a delegate definition table. +---@param data? unknown Additional data to be used as further criteria to determine if the target dialog is active - this would be the same data used to spawn the dialog. +---@return LibDialog.Dialog|nil +function lib:ActiveDialog(reference, data) +end + +--- Dismisses a specific dialog. +---@param reference string|LibDialog.Delegate The delegate criteria for the dialog being targeted. Can be either a string, in which case the delegate must be registered, or a delegate definition table. +function lib:Dismiss(reference, data) +end + +--- Registers a new dialog delegate. +---@param delegateName string The name the delegate table will be registered under. +---@param delegate LibDialog.Delegate The delegate properties definition. +function lib:Register(delegateName, delegate) +end + +--- Spawns a dialog from a delegate reference. +---@param reference string|LibDialog.Delegate The delegate to be used for the spawned dialog. Can be either a string, in which case the delegate must be registered, or a delegate definition table. +---@param data? unknown Additional data to be passed on to the resultant dialog. +---@return LibDialog.Dialog|nil +function lib:Spawn(reference, data) +end + +-- ---------------------------------------------------------------------------- +-- LibDialog.Dialog +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibDialog.Dialog +local dialog = {} + +--- Resets the dialog to default settings. +function dialog:Reset() +end + +--- Resizes the dialog according to its buttons and other widgets. +function dialog:Resize() +end + +-- ---------------------------------------------------------------------------- +-- LibDialog.Delegate +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibDialog.Delegate +---@field buttons LibDialog.Delegate.Button[] List of Buttons to define in the Dialog. +---@field cancels_on_spawn string[] When the Dialog is spawned, it will cancel all other Dialogs named in the list. +---@field checkboxes LibDialog.Delegate.CheckBox[] List of CheckBoxes to define in the Dialog. +---@field duration number Number of seconds the Dialog will exist before automatically being dismissed. +---@field editboxes LibDialog.Delegate.EditBox[] List of EditBoxes to define in the Dialog. +---@field height number Height for the Dialog (in pixels); if omitted or 0, causes the Dialog's height to be determined automatically based on its contents. +---@field hide_on_escape boolean Causes the Dialog to be dismissed when the Escape key is pressed. +---@field icon string Assigns an icon to the Dialog found at the given file path. +---@field icon_size number Sets the width and height of the Dialog's icon (in pixels). Defaults to 36. +---@field is_exclusive boolean If set to true, the Dialog will dismiss other exclusive Dialogs when spawned. +---@field no_cancel_on_escape boolean When set to true, do not cancel this Dialog when the Escape key is pressed. +---@field no_cancel_on_reuse boolean When set to true, do not cancel pre-existing Dialogs of this designation when a new instance is created. +---@field show_during_cinematic boolean When set to true, do not cancel this Dialog when a Cinematic cut-scene begins. +---@field show_while_dead boolean When set to true, allow the Dialog to be shown while the character is dead. +---@field sound string Plays an audio file at the given path when the Dialog is shown. +---@field static_size number Sets the Dialog's width to the specified size. Ignores contained widgets for resizing purposes. +---@field text string The text displayed on the Dialog, before its widgets. +---@field text_justify_h JustifyHorizontal Sets the Dialog's horizontal text alignment style. +---@field text_justify_v JustifyVertical Sets the Dialog's vertical text alignment style. +---@field width number Width for the Dialog (in pixels); if omitted or 0, causes the Dialog's height to be determined automatically based on its contents. +local delegate = {} + +--- Called when the Dialog is canceled. +---@param self Frame Reference to the Dialog for which the script was run. +---@param data unknown|nil The data passed to the Delegate when the Dialog was instantiated via lib:Spawn() +---@param reason? string Reason for cancelation. Not always present. The library will use the following according to circumstance: timeout - Passed when a Dialog's duration has run out. override - Passed when a Dialog is dismissed by either being in the cancelsonspawn list of another Dialog, having its is_exclusive value set to true when another Dialog with its is_exclusive value set is spawned, or when the same Dialog is spawned again and its no_cancel_on_reuse value is empty or false. +function delegate:on_cancel(data, reason) +end + +--- Run when the Dialog becomes invisible. +---@param self Frame Reference to the Dialog for which the script was run. +function delegate:on_hide() +end + +--- Run when the Dialog becomes visible. +---@param self Frame Reference to the Dialog for which the script was run. +function delegate:on_show() +end + +--- Run each time the screen is drawn by the game engine. This handler runs for each frame draw. +---@param self Frame Reference to the Dialog for which the script was run. +---@param elapsed number Number of seconds since the OnUpdate handlers were last run (likely a fraction of a second). +function delegate:on_update(elapsed) +end + +-- ---------------------------------------------------------------------------- +-- LibDialog.Delegate.Button +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibDialog.Delegate.Button: Button +---@field text string The text displayed on the Button. Required. +local button = {} + +--- Run when the Button is clicked. +---@param mouseButton string Name of the mouse button responsible for the click action. +---@param down boolean True for a mouse button down action; false for button up or other actions. +function button:on_click(mouseButton, down) +end + +-- ---------------------------------------------------------------------------- +-- LibDialog.Delegate.CheckBox +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibDialog.Delegate.CheckBox: CheckButton +---@field label string The CheckBox label. Required. +local checkBox = {} + +--- Run when the CheckBox is clicked. +---@param mouseButton string Name of the mouse button responsible for the click action. +---@param down boolean True for a mouse button down action; false for button up or other actions. +function checkBox:on_click(mouseButton, down) +end + +-- ---------------------------------------------------------------------------- +-- LibDialog.Delegate.EditBox +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibDialog.Delegate.EditBox: EditBox +---@field auto_focus boolean Sets whether the EditBox automatically acquires keyboard input focus. +---@field label string The EditBox label. +---@field max_bytes number Sets the maximum number of bytes of text allowed in the EditBox. Attempts to type more than this number into the EditBox will produce no results; programmatically inserting text or setting the EditBox's text will truncate input to the maximum length. Omitting this value, or setting it to 0, results in no limit. Note: Unicode characters may consist of more than one byte each, so the behavior of a byte limit may differ from that of a character limit in practical use. +---@field max_letters number Sets the maximum number of text characters allowed in the EditBox. Attempts to type more than this number into the EditBox will produce no results; programmatically inserting text or setting the EditBox's text will truncate input to the maximum length. Omitting this value, or setting it to 0, results in no limit. +---@field text string Initial text of the EditBox. +---@field width number Width for the EditBox (in pixels); if 0, causes the EditBox's width to be determined automatically according to its anchor points. +local editBox = {} + +--- Run when the Enter (or Return) key is pressed while the EditBox has keyboard focus. +function editBox:on_enter_pressed() +end + +--- Run when the Escape key is pressed while the EditBox has keyboard focus. +function editBox:on_escape_pressed() +end + +--- Run when the EditBox becomes visible. +function editBox:on_show() +end + +--- Run when the EditBox's text is changed. This script is run both when text is typed in the EditBox (for each character entered) and when the EditBox's contents are changed via :SetText() (but only if the text is actually changed). +---@param userInput boolean True if the text changed due to user input; false if the text was changed via :SetText() +function editBox:on_text_changed(userInput) +end diff --git a/docs/annotations/Annotations/Core/Libraries/LibDualSpec-1.0/LibDualSpec-1.0.lua b/docs/annotations/Annotations/Core/Libraries/LibDualSpec-1.0/LibDualSpec-1.0.lua new file mode 100644 index 0000000..f4c8183 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibDualSpec-1.0/LibDualSpec-1.0.lua @@ -0,0 +1,11 @@ +---@meta _ +---@class LibDualSpec-1.0 +local lib = {} + +---@param target table the AceDB-3.0 instance. +---@param name string a user-friendly name of the database (best bet is the addon name). +function lib:EnhanceDatabase(target, name) end + +---@param optionTable table The option table returned by AceDBOptions-3.0. +---@param target table The AceDB-3.0 the options operate on. +function lib:EnhanceOptions(optionTable, target) end \ No newline at end of file diff --git a/docs/annotations/Annotations/Core/Libraries/LibQTip-1.0/LibQTip-1.0.lua b/docs/annotations/Annotations/Core/Libraries/LibQTip-1.0/LibQTip-1.0.lua new file mode 100644 index 0000000..c0e9016 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibQTip-1.0/LibQTip-1.0.lua @@ -0,0 +1,307 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- LibQTip-1.0 +-- ---------------------------------------------------------------------------- +---@class LibQTip-1.0 +---@field LabelProvider LibQTip.CellProvider The default CellProvider used to create tooltip cells. +local lib = {} + +--- Create or retrieve the tooltip with the given key. +--- +-- If additional arguments are passed, they are passed to :SetColumnLayout for the acquired tooltip. +---@param key string|table - The tooltip key. Any value that can be used as a table key is accepted though you should try to provide unique keys to avoid conflicts. +---Numbers and booleans should be avoided and strings should be carefully chosen to avoid namespace clashes - no "MyTooltip" - you have been warned! +---@param numColumns? number Minimum number of columns +---@param ... JustifyHorizontal Column horizontal justifications ("CENTER", "LEFT" or "RIGHT"). Defaults to "LEFT". +--- Example tooltip with 5 columns justified as left, center, left, left, left: +--- +--- local tip = LibStub('LibQTip-1.0'):Acquire('MyFooBarTooltip', 5, "LEFT", "CENTER") +---@return LibQTip.Tooltip +function lib:Acquire(key, numColumns, ...) end + +--- Convenience method to create a new cell provider. +--- +--- Although one can use anything that matches the CellProvider and Cell interfaces, this method provides an easy way to create new providers. +---@param baseProvider? LibQTip.CellProvider An existing provider to base the new provider on. +---@return LibQTip.CellProvider provider The new CellProvider. +---@return table cellPrototype The prototype of the new cell. It must be extended with the mandatory :InitializeCell() and :SetupCell() methods. +---@return table baseCellPrototype The prototype of baseProvider cells. It may be used to call base cell methods. +function lib:CreateCellProvider(baseProvider) end + +--- Check if a given tooltip has been acquired and not released. +---@param key string|table - The tooltip key. +---@return boolean +function lib:IsAcquired(key) end + +--- Return an iterator on the acquired tooltips. +---@generic T: LibQTip.Tooltip, K, V +---@return fun(tooltip: LibQTip.Tooltip, index?: K):K, V +---@return T +function lib:IterateTooltips() end + +--- Return an acquired tooltip to the heap. The tooltip is cleared and hidden. +---@param tooltip LibQTip.Tooltip The tooltip to release. Any invalid values are silently ignored. +function lib:Release(tooltip) end + +-- ---------------------------------------------------------------------------- +-- LibQTip.ScriptType +-- ---------------------------------------------------------------------------- +---@alias LibQTip.ScriptType +---|"OnEnter" +---|"OnLeave" +---|"OnMouseDown" +---|"OnMouseUp"| +---|"OnReceiveDrag" + +-- ---------------------------------------------------------------------------- +-- LibQTip.Tooltip +-- ---------------------------------------------------------------------------- +---@class LibQTip.Tooltip: BackdropTemplate, Frame +local tooltip = {} + +--- Add a new column to the right of the tooltip. +---@param justification? JustifyHorizontal The horizontal justification of cells in this column ("CENTER", "LEFT" or "RIGHT"). Defaults to "LEFT". +function tooltip:AddColumn(justification) end + +--- Add a new header line at the bottom of the tooltip. +--- Provided values are displayed on the line with the header font. Nil values are ignored. If the number of values is greater than the number of columns, an error is raised. +---@param ... unknown Value to be displayed in each column of the line. +---@return number lineIndex The index of the newly added line. +---@return number columnIndex The index of the next empty cell in the line or nil if it is full. +function tooltip:AddHeader(...) end + +--- Add a new line at the bottom of the tooltip. +--- Provided values are displayed on the line with the regular font. Nil values are ignored. If the number of values is greater than the number of columns, an error is raised. +---@param ... unknown Value to be displayed in each column of the line. +---@return number lineIndex The index of the newly added line. +---@return number columnIndex The index of the next empty cell in the line or nil if it is full. +function tooltip:AddLine(...) end + +--- Adds a graphical separator line at the bottom of the tooltip. +---@param height? number Height, in pixels, of the separator. Defaults to 1. +---@param r? number Red color value of the separator. Defaults to NORMAL_FONT_COLOR.r +---@param g? number Green color value of the separator. Defaults to NORMAL_FONT_COLOR.g +---@param b? number Blue color value of the separator. Defaults to NORMAL_FONT_COLOR.b +---@param a? number Alpha level of the separator. Defaults to 1. +---@return number lineIndex The index of the newly added line. +---@return number columnIndex The index of the next empty cell in the line or nil if it is full. +function tooltip:AddSeparator(height, r, g, b, a) end + +--- Reset the contents of the tootip. The column layout is preserved but all lines are wiped. +function tooltip:Clear() end + +--- Returns the total number of columns of the tooltip. +---@return number columnCount The number of columns added using :SetColumnLayout or :AddColumn. +function tooltip:GetColumnCount() end + +--- Return the CellProvider used for cell functionality. +---@return LibQTip.CellProvider +function tooltip:GetDefaultProvider() end + +--- Return the font used for regular lines. +---@return Font +function tooltip:GetFont() end + +--- Return the font used for header lines. +---@return Font +function tooltip:GetHeaderFont() end + +--- Returns the total number of lines of the tooltip. +---@return number lineCount The number of lines added using :AddLine or :AddHeader. +function tooltip:GetLineCount() end + +--- Sets the length of time in which the mouse pointer can be outside of the tooltip, or an alternate frame, before the tooltip is automatically hidden and then released. +---@param delay number Whole or fractional seconds. +---@param alternateFrame? Frame If specified, the tooltip will not be automatically hidden while the mouse pointer is over it. +---@param releaseHandler? fun(frame: Frame, delay: number) Called when the tooltip is released. Generally used to clean up a reference an AddOn has to the tooltip frame, since another AddOn can subsequently acquire it. +function tooltip:SetAutoHideDelay(delay, alternateFrame, releaseHandler) end + +-- stylua: ignore start + +--- Add or replace a cell at the given line and column indices. The additional arguments override the tooltip defaults. +---@param lineNum number The line index of the cell. Indexes greater than tooltip:GetLineCount() raise an error. +---@param colNum number The column index of the cell. Indexes greater than tooltip:GetColumnCount() raise an error. +---@param value unknown The value to display in the cell. +---@param font? FontObject|Font The rendering font. Defaults to regular font. +---@param justification? JustifyHorizontal Cell-specific justification to use ("CENTER", "LEFT" or "RIGHT"). Defaults to column justification. +---@param colSpan? number The number of columns the cell will span. Defaults to 1. +---@param provider? LibQTip.CellProvider CellProvider to use instead of the default one. Defaults to LibQTip.LabelProvider. +---@param leftPadding? number Pixel padding on the left side of the cell's value. Defaults to 0. +---@param rightPadding? number Pixel padding on the right side of the cell's value. Defaults to 0. +---@param maxWidth? number The maximum width (in pixels) of the cell. If the cell's value is textual and exceeds this width, it will wrap to a new line. Must not be less than the value of minWidth. +---@param minWidth? number The minimum width (in pixels) of the cell. Must not exceed the value of maxWidth. +---@param ...? unknown Additional arguments to pass to the cell:SetupCell method. +---@return number lineIndex The index of the cell's line. +---@return number columnIndex The index of the next empty cell in the line or nil if it is full. +function tooltip:SetCell(lineNum, colNum, value, font, justification, colSpan, provider, leftPadding, rightPadding, maxWidth, minWidth, ...) end + +-- stylua: ignore end + +--- Sets the horizontal margin size of all cells within the tooltip. This function can only be used before the tooltip has had lines set. +---@param size number The desired margin size. Must be a positive number or zero. +function tooltip:SetCellMarginH(size) end + +--- Sets the vertical margin size of all cells within the tooltip. This function can only be used before the tooltip has had lines set. +---@param size number The desired margin size. Must be a positive number or zero. +function tooltip:SetCellMarginV(size) end + +--- Assign a script to a cell at the given line and column indices. +---@param lineNum number Line index of the cell. +---@param colNum number Column index of the cell. +---@param scriptType LibQTip.ScriptType The cell ScriptType. +---@param func fun(frame: Frame, ...) The function called when the script is run. Parameters conform to the given ScriptType. +---@param arg? unknown Data to be passed to the script function. +function tooltip:SetCellScript(lineNum, colNum, scriptType, func, arg) end + +--- Sets the color of the specified column of the tooltip. +---@param colNum number Column number to set. +---@param r? number Red color value of the column. Defaults to the tooltip's current red value. +---@param g? number Green color value of the column. Defaults to the tooltip's current green value. +---@param b? number Blue color value of the column. Defaults to the tooltip's current blue value. +---@param a? number Alpha level of the column. Defaults to 1. +function tooltip:SetColumnColor(colNum, r, g, b, a) end + +--- Ensure the tooltip has at least the passed number of columns, adding new columns if need be. +--- +--- The justification of existing columns is reset to the passed values. +---@param numColumns number Minimum number of columns +---@param ... JustifyHorizontal? Column horizontal justifications ("CENTER", "LEFT" or "RIGHT"). Defaults to "LEFT". +--- Example tooltip with 5 columns justified as left, center, left, left, left: +--- +--- tooltip:SetColumnLayout(5, "LEFT", "CENTER") +function tooltip:SetColumnLayout(numColumns, ...) end + +--- Assign a script to a column at the given index. +---@param colNum number Index of the column. +---@param scriptType LibQTip.ScriptType The column ScriptType. +---@param func fun(frame: Frame, ...) The function called when the script is run. Parameters conform to the given ScriptType. +---@param arg? unknown Data to be passed to the script function. +function tooltip:SetColumnScript(colNum, scriptType, func, arg) end + +--- Sets the color of the text for the specified column of the tooltip. +---@param colNum number Column number to set. +---@param r? number Red color value of the column text. Defaults to the red value of the tooltip's current font. +---@param g? number Green color value of the column text. Defaults to the green value of the tooltip's current font. +---@param b? number Blue color value of the column text. Defaults to the blue value of the tooltip's current font. +---@param a? number Alpha level of the column's text. Defaults to 1. +function tooltip:SetColumnTextColor(colNum, r, g, b, a) end + +--- Define the cellprovider to be used for all cell functionality. +---@param provider LibQTip.CellProvider The new default cellprovider. +function tooltip:SetDefaultProvider(provider) end + +--- Define the font used when adding new lines. +---@param font FontObject|Font The new default font. +function tooltip:SetFont(font) end + +--- Define the font used when adding new header lines. +---@param font FontObject|Font The new default font. +function tooltip:SetHeaderFont(font) end + +--- Works identically to the default UI's texture:SetTexCoord() API, for the tooltip's highlight texture. +---@param ULx number +---@param ULy number +---@param LLx number +---@param LLy number +---@param URx number +---@param URy number +---@param LRx number +---@param LRy number +---@overload fun(minX: number, maxX: number, minY: number, maxY: number) +function tooltip:SetHighlightTexCoord(ULx, ULy, LLx, LLy, URx, URy, LRx, LRy) end + +--- Sets the texture of the highlight when mousing over a line or cell that has a script assigned to it. +--- +--- Works identically to the default UI's texture:SetTexture() API. +---@param file string|number +---@param horizWrap? WrapMode +---@param vertWrap? WrapMode +---@param filterMode? FilterMode +function tooltip:SetHighlightTexture(file, horizWrap, vertWrap, filterMode) end + +--- Sets the color of the specified line of the tooltip. +---@param lineNum number Line number to set. +---@param r? number Red color value of the line. Defaults to the tooltip's current red value. +---@param g? number Green color value of the line. Defaults to the tooltip's current green value. +---@param b? number Blue color value of the line. Defaults to the tooltip's current blue value. +---@param a? number Alpha level of the line. Defaults to 1. +function tooltip:SetLineColor(lineNum, r, g, b, a) end + +--- Assign a script to a line at the given index. +---@param lineNum number Index of the line. +---@param scriptType LibQTip.ScriptType The column ScriptType. +---@param func fun(frame: Frame, ...) The function called when the script is run. Parameters conform to the given ScriptType. +---@param arg? unknown Data to be passed to the script function. +function tooltip:SetLineScript(lineNum, scriptType, func, arg) end + +--- Sets the color of the text for the specified line of the tooltip. +---@param lineNum number Line number to set. +---@param r? number Red color value of the line text. Defaults to the red value of the tooltip's current font. +---@param g? number Green color value of the line text. Defaults to the green value of the tooltip's current font. +---@param b? number Blue color value of the line text. Defaults to the blue value of the tooltip's current font. +---@param a? number Alpha level of the line's text. Defaults to 1. +function tooltip:SetLineTextColor(lineNum, r, g, b, a) end + +--- Set the step size for the scroll bar +---@param step number The new step size. +function tooltip:SetScrollStep(step) end + +--- Smartly anchor the tooltip to the given frame and ensure that it is always on screen. +---@param frame Frame The frame that will serve as the tooltip anchor. +function tooltip:SmartAnchorTo(frame) end + +--- Resizes the tooltip to fit the screen and show a scrollbar if needed. +---@param maxheight? number Maximum tooltip height in pixels. +function tooltip:UpdateScrolling(maxheight) end + +-- ---------------------------------------------------------------------------- +-- LibQTip.Cell +-- ---------------------------------------------------------------------------- +---@class LibQTip.Cell: Frame +local cell = {} + +--- Returns the cell's position within the containing tooltip. +---@return number lineIndex The line index of cell. +---@return number columnIndex The column index of cell. +function cell:GetPosition() end + +--- This method is called on newly created Cells, typically to perform one-time initialization. +function cell:InitializeCell() end + +--- Setup the cell with the given arguments. +---@param tooltip LibQTip.Tooltip The tooltip the cell belongs to. +---@param value unknown The value to display in the cell. +---@param justification JustifyHorizontal Cell-specific justification to use ("CENTER", "LEFT" or "RIGHT"). +---@param font? FontObject|Font The rendering font. Defaults to regular or header font, depending on the cell's designation. +---@param leftPadding? number Pixel padding on the left side of the cell's value. Defaults to 0. +---@param rightPadding? number Pixel padding on the right side of the cell's value. Defaults to 0. +---@param maxWidth? number The maximum width (in pixels) of the cell. If the cell's value is textual and exceeds this width, it will wrap to a new line. Must not be less than the value of minWidth. +---@param minWidth? number The minimum width (in pixels) of the cell. Must not exceed the value of maxWidth. +function cell:SetupCell(tooltip, value, justification, font, leftPadding, rightPadding, maxWidth, minWidth) end + +-- ---------------------------------------------------------------------------- +-- LibQTip.CellProvider +-- ---------------------------------------------------------------------------- +---@class LibQTip.CellProvider +local cellProvider = {} + +--- Acquire a new cell to be displayed in the tooltip. LibQTip manages parent, framelevel, anchors, visibility and size of the cell. +---@param tooltip LibQTip.Tooltip The tooltip the cell is being acquired for. +---@return LibQTip.Cell cell The acquired cell. +function cellProvider:AcquireCell(tooltip) end + +--- Return the prototype and metatable used to create new cells. +---@return table cellPrototype The prototype on which cell are based. +---@return table cellMetatable The metatable used to create new cell. +function cellProvider:GetCellPrototype() end + +--- Return an iterator on currently acquired cells. +---@generic T: LibQTip.Cell, K, V +---@return fun(tooltip: LibQTip.Cell, index?: K):K, V +---@return T +function cellProvider:IterateCells() end + +--- Release a cell that LibQTip is no longer using. The cell has already been hidden, unanchored and orphaned by LibQTip. +---@param cell LibQTip.Cell The cell to release. +function cellProvider:ReleaseCell(cell) end diff --git a/docs/annotations/Annotations/Core/Libraries/LibSharedMedia-3.0/LibSharedMedia-3.0.lua b/docs/annotations/Annotations/Core/Libraries/LibSharedMedia-3.0/LibSharedMedia-3.0.lua new file mode 100644 index 0000000..fb5b0ec --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibSharedMedia-3.0/LibSharedMedia-3.0.lua @@ -0,0 +1,74 @@ +---@meta _ +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation) +---@class LibSharedMedia-3.0 +local LibSharedMedia = {} + +LibSharedMedia.LOCALE_BIT_koKR = 1 +LibSharedMedia.LOCALE_BIT_ruRU = 2 +LibSharedMedia.LOCALE_BIT_zhCN = 4 +LibSharedMedia.LOCALE_BIT_zhTW = 8 +LibSharedMedia.LOCALE_BIT_western = 128 + +LibSharedMedia.MediaType = { + BACKGROUND = "background", + BORDER = "border", + FONT = "font", + STATUSBAR = "statusbar", + SOUND = "sound", +} + +---@alias LibSharedMediaTypes +---| "background" # Backgrounds +---| "border" # Borders +---| "font" # Fonts +---| "sound" # Sounds +---| "statusbar" # Statusbars + +---@param mediatype LibSharedMediaTypes +---@param key string +---@param data string|number the data to associate with the handle; a filename or FileID +---@param langmask? number +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:Register(mediatype, key, data, langmask) end + +---@param mediatype LibSharedMediaTypes +---@param key string +---@param noDefault? boolean +---@return string? +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:Fetch(mediatype, key, noDefault) end + +---@param mediatype LibSharedMediaTypes +---@param key? string +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:IsValid(mediatype, key) end + +---@param mediatype LibSharedMediaTypes +---@return table +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:HashTable(mediatype) end + +---@param mediatype LibSharedMediaTypes +---@return string[] +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:List(mediatype) end + +---@param mediatype LibSharedMediaTypes +---@return string? +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:GetGlobal(mediatype) end + +---@param mediatype LibSharedMediaTypes +---@param key? string +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:SetGlobal(mediatype, key) end + +---@param mediatype LibSharedMediaTypes +---@return string? +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:GetDefault(mediatype) end + +---@param type string +---@param handle string +---[Documentation](https://www.wowace.com/projects/libsharedmedia-3-0/pages/api-documentation/) +function LibSharedMedia:SetDefault(type, handle) end diff --git a/docs/annotations/Annotations/Core/Libraries/LibSink-2.0/LibSink-2.0.lua b/docs/annotations/Annotations/Core/Libraries/LibSink-2.0/LibSink-2.0.lua new file mode 100644 index 0000000..8cb24dd --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibSink-2.0/LibSink-2.0.lua @@ -0,0 +1,45 @@ +---@meta _ + +-- ---------------------------------------------------------------------------- +-- LibSink-2.0 +-- ---------------------------------------------------------------------------- +---@class LibSink-2.0 +local lib = {} + +-- Gets or creates an AceConfig-2.0 OptionsTable +---@return table optionsTable +function lib:GetSinkAce2OptionsDataTable() end + +-- Gets or creates an AceConfig-3.0 OptionsTable +---@return table optionsTable +function lib:GetSinkAce3OptionsDataTable() end + +-- Sends a message to the registered sink. +---@param textOrAddon number|string|table The text to send, or an object to use as the sender. If an object is passed, the remaining arguments are shifted up internally. +---@param r number Red value of the text - should be passed as decimal values ranging from 0.0 to 1.0. +---@param g number Green value of the text - should be passed as decimal values ranging from 0.0 to 1.0. +---@param b number Blue value of the text - should be passed as decimal values ranging from 0.0 to 1.0. +---@param fontName? string The name of the font to use. Does not work for all sink types. +---@param fontSize? number The size of the font. Does not work for all sink types. +---@param outlineIndex? number The index of the outline style to use. Does not work for all sink types. +---@param isSticky? boolean Set messages from this source to appear as sticky. +---@param location? unknown Unused by the library. +---@param iconTexturePath? string The path of the icon texture to use. +function lib:Pour(textOrAddon, r, g, b, fontName, fontSize, outlineIndex, isSticky, location, iconTexturePath) end + +-- Registers a sink with the library +---@param shortName string +---@param name string +---@param desc string|nil +---@param func function|string +---@param scrollAreaFunc? function|string +---@param hasSticky? boolean +function lib:RegisterSink(shortName, name, desc, func, scrollAreaFunc, hasSticky) end + +-- Sets the storage location for user preferences +---@param storage table The location in the SavedVariables table +function lib:SetSinkStorage(storage) end + +-- Sets a sink override for -all- addons, librarywide. +---@param override? string +function lib:SetSinkOverride(override) end diff --git a/docs/annotations/Annotations/Core/Libraries/LibStub/LibStub.lua b/docs/annotations/Annotations/Core/Libraries/LibStub/LibStub.lua new file mode 100644 index 0000000..0ec4092 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibStub/LibStub.lua @@ -0,0 +1,29 @@ +---@meta _ +---[Documentation](https://www.wowace.com/projects/libstub) +LibStub = {} + +---@generic T +---@param major `T` +---@param minor number +---@return table|T library +---@return number? oldMinor +function LibStub:NewLibrary(major, minor) end + +---@generic T +---@param major `T` +---@param silent? boolean +---@return table|T library +function LibStub:GetLibrary(major, silent) end + +---@return function iter +---@return table invariant +function LibStub:IterateLibraries() end + +-- not sure how to annotate this +--setmetatable(LibStub, { __call = LibStub.GetLibrary }) + +---@generic T +---@param major `T` +---@param silent? boolean +---@return table|T library +function LibStub(major, silent) end diff --git a/docs/annotations/Annotations/Core/Libraries/LibTextDump-1.0/LibTextDump-1.0.lua b/docs/annotations/Annotations/Core/Libraries/LibTextDump-1.0/LibTextDump-1.0.lua new file mode 100644 index 0000000..9fb7802 --- /dev/null +++ b/docs/annotations/Annotations/Core/Libraries/LibTextDump-1.0/LibTextDump-1.0.lua @@ -0,0 +1,54 @@ +-- ---------------------------------------------------------------------------- +-- LibTextDump-1.0 +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibTextDump-1.0 +local lib = {} + +---Creates an interface. +---@param frameTitle string Text to be displayed on the title bar of the display frame for the interface. +---@param width number +---@param height number +---@return LibTextDump.Interface +function lib:New(frameTitle, width, height) +end + +-- ---------------------------------------------------------------------------- +-- LibTextDump.Interface +-- ---------------------------------------------------------------------------- +---@meta _ +---@class LibTextDump.Interface +local interface = {} + +---Adds a line of text to the interface's buffer. +---@param text string Text to be added to a new line. +---@param dateFormat string? Optional format parameter passed to the Lua date function. If present, prefixes text with [dateFormat]. +function interface:AddLine(text, dateFormat) +end + +---Clears the contents of the interface's buffer. +function interface:Clear() +end + +---Shows the display frame for the interface, populated with the contents of the interface's buffer. +---@param separator string? Optional separator for concatenating the buffer's lines together. Defaults to a newline. +function interface:Display(separator) +end + +---Inserts a line of text at the specified position in the interface's buffer. +---@param position number Index of insertion. +---@param text string Text to be added to a new line. +---@param dateFormat string? Optional format parameter passed to the Lua date function. If present, prefixes text with [dateFormat]. +function interface:InsertLine(position, text, dateFormat) +end + +---Returns the number of lines in the interface's buffer. +---@return number +function interface:Lines() +end + +---Returns the string representation of the interface's buffer. +---@param separator string? Optional separator for concatenating the buffer's lines together. Defaults to a newline. +---@return string +function interface:String(separator) +end diff --git a/docs/annotations/Annotations/Core/Lua/basic.lua b/docs/annotations/Annotations/Core/Lua/basic.lua new file mode 100644 index 0000000..61bc386 --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/basic.lua @@ -0,0 +1,371 @@ +---@meta _ +---@diagnostic disable: duplicate-doc-field +---@diagnostic disable: duplicate-doc-alias +--- added: gcinfo +--- edited: xpcall (lua 5.2), getfenv +--- removed: dofile, load, loadfile, module, rawlen, warn + +--- +---Command-line arguments of Lua Standalone. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-arg"]) +--- +---@type string[] +arg = {} + +--- +---Raises an error if the value of its argument v is false (i.e., `nil` or `false`); otherwise, returns all its arguments. In case of error, `message` is the error object; when absent, it defaults to `"assertion failed!"` +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-assert"]) +--- +---@generic T +---@param v? T +---@param message? any +---@param ... any +---@return T +---@return any ... +function assert(v, message, ...) end + +---@alias gcoptions +---|>"collect" # Performs a full garbage-collection cycle. +---| "stop" # Stops automatic execution. +---| "restart" # Restarts automatic execution. +---| "count" # Returns the total memory in Kbytes. +---| "step" # Performs a garbage-collection step. +---| "isrunning" # Returns whether the collector is running. +---| "setpause" # Set `pause`. +---| "setstepmul" # Set `step multiplier`. + +--- +---This function is a generic interface to the garbage collector. It performs different functions according to its first argument, `opt`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-collectgarbage"]) +--- +---@param opt? gcoptions +---@param arg? integer +---@return any +function collectgarbage(opt, arg) end + +--- +---Terminates the last protected function called and returns message as the error object. +--- +---Usually, `error` adds some information about the error position at the beginning of the message, if the message is a string. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-error"]) +--- +---@param message any +---@param level? integer +function error(message, level) end + +--- +---A global variable (not a function) that holds the global environment (see [§2.2](command:extension.lua.doc?["en-us/51/manual.html/2.2"])). Lua itself does not use this variable; changing its value does not affect any environment, nor vice versa. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-_G"]) +--- +---@class _G +_G = {} + +---Returns the current environment in use by the function. `f` can be a Lua function or a number that specifies the function at that stack level. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-getfenv"]), [Wiki](https://warcraft.wiki.gg/wiki/API_getfenv) +--- +---@param f? integer|async fun(...):... +---@return table|_G +---@nodiscard +function getfenv(f) end + +--- +---If object does not have a metatable, returns nil. Otherwise, if the object's metatable has a __metatable field, returns the associated value. Otherwise, returns the metatable of the given object. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-getmetatable"]) +--- +---@param object any +---@return table metatable +---@nodiscard +function getmetatable(object) end + +--- +---Returns three values (an iterator function, the table `t`, and `0`) so that the construction +---```lua +--- for i,v in ipairs(t) do body end +---``` +---will iterate over the key–value pairs `(1,t[1]), (2,t[2]), ...`, up to the first absent index. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-ipairs"]) +--- +---@generic T: table, V +---@param t T +---@return fun(table: V[], i?: integer):integer, V +---@return T +---@return integer i +function ipairs(t) end + +---@alias loadmode +---| "b" # Only binary chunks. +---| "t" # Only text chunks. +---|>"bt" # Both binary and text. + +---Loads a chunk from the given string. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-loadstring"]) +--- +---@param text string +---@param chunkname? string +---@return function? +---@return string? error_message +---@nodiscard +function loadstring(text, chunkname) end + +---Creates a zero-size "userdata" object, optionally swith a sharable empty metatable. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_newproxy) +---@param proxy boolean|table|userdata +---@return userdata +---@nodiscard +function newproxy(proxy) end + +--- +---Allows a program to traverse all fields of a table. Its first argument is a table and its second argument is an index in this table. A call to `next` returns the next index of the table and its associated value. When called with `nil` as its second argument, `next` returns an initial index and its associated value. When called with the last index, or with `nil` in an empty table, `next` returns `nil`. If the second argument is absent, then it is interpreted as `nil`. In particular, you can use `next(t)` to check whether a table is empty. +--- +---The order in which the indices are enumerated is not specified, *even for numeric indices*. (To traverse a table in numerical order, use a numerical `for`.) +--- +---The behavior of `next` is undefined if, during the traversal, you assign any value to a non-existent field in the table. You may however modify existing fields. In particular, you may set existing fields to nil. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-next"]) +--- +---@generic K, V +---@param tbl table +---@param index? K +---@return K? +---@return V? +---@nodiscard +function next(tbl, index) end + +--- +---If `t` has a metamethod `__pairs`, calls it with t as argument and returns the first three results from the call. +--- +---Otherwise, returns three values: the [next](command:extension.lua.doc?["en-us/51/manual.html/pdf-next"]) function, the table `t`, and `nil`, so that the construction +---```lua +--- for k,v in pairs(t) do body end +---``` +---will iterate over all key–value pairs of table `t`. +--- +---See function [next](command:extension.lua.doc?["en-us/51/manual.html/pdf-next"]) for the caveats of modifying the table during its traversal. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-pairs"]) +--- +---@generic T: table, K, V +---@param t T +---@return fun(table: table, index?: K):K, V +---@return T +function pairs(t) end + +--- +---Calls the function `f` with the given arguments in *protected mode*. This means that any error inside `f` is not propagated; instead, `pcall` catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, `pcall` also returns all results from the call, after this first result. In case of any error, `pcall` returns `false` plus the error object. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-pcall"]) +--- +---@param f function +---@param arg1? any +---@param ... any +---@return boolean success +---@return any result +---@return any ... +function pcall(f, arg1, ...) end + +--- +---Receives any number of arguments and prints their values to `stdout`, converting each argument to a string following the same rules of [tostring](command:extension.lua.doc?["en-us/51/manual.html/pdf-tostring"]). +---The function print is not intended for formatted output, but only as a quick way to show a value, for instance for debugging. For complete control over the output, use [string.format](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.format"]) and [io.write](command:extension.lua.doc?["en-us/51/manual.html/pdf-io.write"]). +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-print"]) +--- +---@param ... any +function print(...) end + +--- +---Checks whether v1 is equal to v2, without invoking the `__eq` metamethod. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-rawequal"]) +--- +---@param v1 any +---@param v2 any +---@return boolean +---@nodiscard +function rawequal(v1, v2) end + +--- +---Gets the real value of `table[index]`, without invoking the `__index` metamethod. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-rawget"]) +--- +---@param tbl table +---@param index any +---@return any +---@nodiscard +function rawget(tbl, index) end +--- +---Sets the real value of `table[index]` to `value`, without using the `__newindex` metavalue. `table` must be a table, `index` any value different from `nil` and `NaN`, and `value` any Lua value. +---This function returns `table`. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-rawset"]) +--- +---@param tbl table +---@param index any +---@param value any +---@return table +function rawset(tbl, index, value) end +--- +---If `index` is a number, returns all arguments after argument number `index`; a negative number indexes from the end (`-1` is the last argument). Otherwise, `index` must be the string `"#"`, and `select` returns the total number of extra arguments it received. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-select"]) +--- +---@param index integer|"#" +---@param ... any +---@return any +---@nodiscard +function select(index, ...) end + +---Sets the environment to be used by the given function. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-setfenv"]) +--- +---@param f (async fun(...):...)|integer +---@param tbl table +---@return function +function setfenv(f, tbl) end + + +---@class metatable +---@field __mode 'v'|'k'|'kv'|nil +---@field __metatable any|nil +---@field __tostring (fun(t):string)|nil +---@field __gc fun(t)|nil +---@field __add (fun(t1,t2):any)|nil +---@field __sub (fun(t1,t2):any)|nil +---@field __mul (fun(t1,t2):any)|nil +---@field __div (fun(t1,t2):any)|nil +---@field __mod (fun(t1,t2):any)|nil +---@field __pow (fun(t1,t2):any)|nil +---@field __unm (fun(t):any)|nil +---@field __concat (fun(t1,t2):any)|nil +---@field __len (fun(t):integer)|nil +---@field __eq (fun(t1,t2):boolean)|nil +---@field __lt (fun(t1,t2):boolean)|nil +---@field __le (fun(t1,t2):boolean)|nil +---@field __index table|(fun(t,k):any)|nil +---@field __newindex table|fun(t,k,v)|nil +---@field __call (fun(t,...):...)|nil + +--- +---Sets the metatable for the given table. If `metatable` is `nil`, removes the metatable of the given table. If the original metatable has a `__metatable` field, raises an error. +--- +---This function returns `table`. +--- +---To change the metatable of other types from Lua code, you must use the debug library ([§6.10](command:extension.lua.doc?["en-us/51/manual.html/6.10"])). +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-setmetatable"]) +--- +---@param tbl table +---@param metatable? metatable|table +---@return table +function setmetatable(tbl, metatable) end + +--- +---When called with no `base`, `tonumber` tries to convert its argument to a number. If the argument is already a number or a string convertible to a number, then `tonumber` returns this number; otherwise, it returns `fail`. +--- +---The conversion of strings can result in integers or floats, according to the lexical conventions of Lua (see [§3.1](command:extension.lua.doc?["en-us/51/manual.html/3.1"])). The string may have leading and trailing spaces and a sign. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-tonumber"]) +--- +---@overload fun(e: string, base: integer):integer +---@param e any +---@return number? +---@nodiscard +function tonumber(e) end + +--- +---Receives a value of any type and converts it to a string in a human-readable format. +--- +---If the metatable of `v` has a `__tostring` field, then `tostring` calls the corresponding value with `v` as argument, and uses the result of the call as its result. Otherwise, if the metatable of `v` has a `__name` field with a string value, `tostring` may use that string in its final result. +--- +---For complete control of how numbers are converted, use [string.format](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.format"]). +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-tostring"]) +--- +---@param v any +---@return string +---@nodiscard +function tostring(v) end + +---@alias type +---| "nil" +---| "number" +---| "string" +---| "boolean" +---| "table" +---| "function" +---| "thread" +---| "userdata" + +--- +---Returns the type of its only argument, coded as a string. The possible results of this function are `"nil"` (a string, not the value `nil`), `"number"`, `"string"`, `"boolean"`, `"table"`, `"function"`, `"thread"`, and `"userdata"`. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-type"]) +--- +---@param v any +---@return type type +---@nodiscard +function type(v) end + +--- +---A global variable (not a function) that holds a string containing the running Lua version. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-_VERSION"]) +--- +_VERSION = "Lua 5.1" + +--- +---Calls function `f` with the given arguments in protected mode with a new message handler. +--- +---[View documents](command:extension.lua.doc?["en-us/52/manual.html/pdf-xpcall"]), [Wiki](https://warcraft.wiki.gg/wiki/API_xpcall) +--- +---@param f async fun(...):... +---@param msgh function +---@param arg1? any +---@param ... any +---@return boolean success +---@return any result +---@return any ... +function xpcall(f, msgh, arg1, ...) end + +---Returns the elements from the given `list`. This function is equivalent to +---```lua +--- return list[i], list[i+1], ···, list[j] +---``` +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-unpack"]), [Wiki](https://warcraft.wiki.gg/wiki/API_unpack) +--- +---@generic T +---@param list T[] +---@param i? integer +---@param j? integer +---@return T ... +---@nodiscard +function unpack(list, i, j) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_gcinfo) +---@return number memoryInUse +---@nodiscard +function gcinfo() end diff --git a/docs/annotations/Annotations/Core/Lua/bit.lua b/docs/annotations/Annotations/Core/Lua/bit.lua new file mode 100644 index 0000000..4f12b6d --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/bit.lua @@ -0,0 +1,57 @@ +---@meta bit_wow +bit = {} + +--- Returns the one's complement of `a` +---@param a number +---@return number +---@nodiscard +function bit.bnot(a) end + +--- Returns the bitwise "AND" of the values +---@param a1 number +---@param ... number +---@return number +---@nodiscard +function bit.band(a1, ...) end + +--- Returns the bitwise "OR" of the values +---@param a1 number +---@param ... number +---@return number +---@nodiscard +function bit.bor(a1, ...) end + +--- Returns the bitwise "exclusive OR" of the values +---@param a1 number +---@param ... number +---@return number +---@nodiscard +function bit.bxor(a1, ...) end + +--- Returns `a` logical shifted left by `n` bits +---@param a number +---@param n number +---@return number +---@nodiscard +function bit.lshift(a, n) end + +--- Returns `a` logical shifted right by `n` bits +---@param a number +---@param n number +---@return number +---@nodiscard +function bit.rshift(a, n) end + +--- Returns `a` arithmetically shifted right by `n` bits +---@param a number +---@param n number +---@return number +---@nodiscard +function bit.arshift(a, n) end + +--- Returns the signed value of `a` modulo `n` +---@param a number +---@param n number +---@return number +---@nodiscard +function bit.mod(a, n) end diff --git a/docs/annotations/Annotations/Core/Lua/compat.lua b/docs/annotations/Annotations/Core/Lua/compat.lua new file mode 100644 index 0000000..78f99ff --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/compat.lua @@ -0,0 +1,64 @@ +---@meta _ +---@diagnostic disable: deprecated + +------------------------------------------------------------------- +-- Table library +local tab = table +foreach = tab.foreach +foreachi = tab.foreachi +getn = tab.getn +tinsert = tab.insert +tremove = tab.remove +sort = tab.sort +wipe = tab.wipe + +------------------------------------------------------------------- +-- math library +local math = math +abs = math.abs +acos = function (x) return math.deg(math.acos(x)) end +asin = function (x) return math.deg(math.asin(x)) end +atan = function (x) return math.deg(math.atan(x)) end +atan2 = function (x,y) return math.deg(math.atan2(x,y)) end +ceil = math.ceil +cos = function (x) return math.cos(math.rad(x)) end +deg = math.deg +exp = math.exp +floor = math.floor +frexp = math.frexp +ldexp = math.ldexp +log = math.log +log10 = math.log10 +max = math.max +min = math.min +mod = math.fmod +PI = math.pi +--pow = math.pow +rad = math.rad +random = math.random +sin = function (x) return math.sin(math.rad(x)) end +sqrt = math.sqrt +tan = function (x) return math.tan(math.rad(x)) end + +------------------------------------------------------------------- +-- string library +local str = string +strbyte = str.byte +strchar = str.char +strfind = str.find +format = str.format +gmatch = str.gmatch +gsub = str.gsub +strlen = str.len +strlower = str.lower +strmatch = str.match +strrep = str.rep +strrev = str.reverse +strsub = str.sub +strupper = str.upper +------------------------------------------------------------------- +-- Add custom string functions to the string table +strtrim = str.trim +strsplit = str.split +strjoin = str.join +strconcat = str.concat diff --git a/docs/annotations/Annotations/Core/Lua/math.lua b/docs/annotations/Annotations/Core/Lua/math.lua new file mode 100644 index 0000000..1e2d4a5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/math.lua @@ -0,0 +1,312 @@ +---@meta math_wow +---@diagnostic disable: duplicate-doc-field +--- added: fastrandom +--- removed: math.randomseed, math.tointeger, math.type, math.ult + +--- +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math"]) +--- +---@class mathlib +--- +---A value larger than any other numeric value. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.huge"]) +--- +---@field huge number +--- +---The value of *π*. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.pi"]) +--- +---@field pi number +math = {} + +--- +---Returns the absolute value of `x`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.abs"]) +--- +---@generic Number: number +---@param x Number +---@return Number +---@nodiscard +function math.abs(x) end + +--- +---Returns the arc cosine of `x` (in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.acos"]) +--- +---@param x number +---@return number +---@nodiscard +function math.acos(x) end + +--- +---Returns the arc sine of `x` (in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.asin"]) +--- +---@param x number +---@return number +---@nodiscard +function math.asin(x) end + +--- +---Returns the arc tangent of `x` (in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.atan"]) +--- +---@param y number +---@return number +---@nodiscard +function math.atan(y) end + +---Returns the arc tangent of `y/x` (in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.atan2"]) +--- +---@param y number +---@param x number +---@return number +---@nodiscard +function math.atan2(y, x) end + +--- +---Returns the smallest integral value larger than or equal to `x`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.ceil"]) +--- +---@param x number +---@return integer +---@nodiscard +function math.ceil(x) end + +--- +---Returns the cosine of `x` (assumed to be in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.cos"]) +--- +---@param x number +---@return number +---@nodiscard +function math.cos(x) end + +---Returns the hyperbolic cosine of `x` (assumed to be in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.cosh"]) +--- +---@param x number +---@return number +---@nodiscard +function math.cosh(x) end + +--- +---Converts the angle `x` from radians to degrees. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.deg"]) +--- +---@param x number +---@return number +---@nodiscard +function math.deg(x) end + +--- +---Returns the value `e^x` (where `e` is the base of natural logarithms). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.exp"]) +--- +---@param x number +---@return number +---@nodiscard +function math.exp(x) end + +--- +---Returns the largest integral value smaller than or equal to `x`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.floor"]) +--- +---@param x number +---@return integer +---@nodiscard +function math.floor(x) end + +--- +---Returns the remainder of the division of `x` by `y` that rounds the quotient towards zero. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.fmod"]) +--- +---@param x number +---@param y number +---@return number +---@nodiscard +function math.fmod(x, y) end + +---Decompose `x` into tails and exponents. Returns `m` and `e` such that `x = m * (2 ^ e)`, `e` is an integer and the absolute value of `m` is in the range [0.5, 1) (or zero when `x` is zero). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.frexp"]) +--- +---@param x number +---@return number m +---@return number e +---@nodiscard +function math.frexp(x) end + +---Returns `m * (2 ^ e)` . +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.ldexp"]) +--- +---@param m number +---@param e number +---@return number +---@nodiscard +function math.ldexp(m, e) end + +--- +---Returns the natural logarithm of `x` . +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.log"]) +--- +---@param x number +---@return number +---@nodiscard +function math.log(x) end + +---Returns the base-10 logarithm of x. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.log10"]) +--- +---@param x number +---@return number +---@nodiscard +function math.log10(x) end + +--- +---Returns the argument with the maximum value, according to the Lua operator `<`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.max"]) +--- +---@generic Number: number +---@param x Number +---@param ... Number +---@return Number +---@nodiscard +function math.max(x, ...) end + +--- +---Returns the argument with the minimum value, according to the Lua operator `<`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.min"]) +--- +---@generic Number: number +---@param x Number +---@param ... Number +---@return Number +---@nodiscard +function math.min(x, ...) end + +--- +---Returns the integral part of `x` and the fractional part of `x`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.modf"]) +--- +---@param x number +---@return integer +---@return number +---@nodiscard +function math.modf(x) end + +---Returns `x ^ y` . +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.pow"]) +--- +---@param x number +---@param y number +---@return number +---@nodiscard +function math.pow(x, y) end + +--- +---Converts the angle `x` from degrees to radians. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.rad"]) +--- +---@param x number +---@return number +---@nodiscard +function math.rad(x) end + +--- +---* `math.random()`: Returns a float in the range [0,1). +---* `math.random(n)`: Returns a integer in the range [1, n]. +---* `math.random(m, n)`: Returns a integer in the range [m, n]. +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.random"]) +--- +---@overload fun():number +---@overload fun(m: integer):integer +---@param m integer +---@param n integer +---@return integer +---@nodiscard +function math.random(m, n) end + +--- +---Returns the sine of `x` (assumed to be in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.sin"]) +--- +---@param x number +---@return number +---@nodiscard +function math.sin(x) end + +---Returns the hyperbolic sine of `x` (assumed to be in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.sinh"]) +--- +---@param x number +---@return number +---@nodiscard +function math.sinh(x) end + +--- +---Returns the square root of `x`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.sqrt"]) +--- +---@param x number +---@return number +---@nodiscard +function math.sqrt(x) end + +--- +---Returns the tangent of `x` (assumed to be in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.tan"]) +--- +---@param x number +---@return number +---@nodiscard +function math.tan(x) end + +---Returns the hyperbolic tangent of `x` (assumed to be in radians). +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-math.tanh"]) +--- +---@param x number +---@return number +---@nodiscard +function math.tanh(x) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_fastrandom) +---@param lower? number +---@param upper? number +---@return number +---@nodiscard +function fastrandom(lower, upper) end + +return math diff --git a/docs/annotations/Annotations/Core/Lua/os.lua b/docs/annotations/Annotations/Core/Lua/os.lua new file mode 100644 index 0000000..4bcaea6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/os.lua @@ -0,0 +1,148 @@ +---@meta os_wow +---@diagnostic disable: duplicate-doc-field +--- removed: os.clock, os.execute, os.exit, os.getenv, os.remove, os.rename, os.setlocale, os.tmpname +--- no namespace: os.date, os.difftime, os.time + +---@class osdate +--- +---four digits +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.year"]) +--- +---@field year integer|string +--- +---1-12 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.month"]) +--- +---@field month integer|string +--- +---1-31 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.day"]) +--- +---@field day integer|string +--- +---0-23 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.hour"]) +--- +---@field hour integer|string +--- +---0-59 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.min"]) +--- +---@field min integer|string +--- +---0-61 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.sec"]) +--- +---@field sec integer|string +--- +---weekday, 1–7, Sunday is 1 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.wday"]) +--- +---@field wday integer|string +--- +---day of the year, 1–366 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.yday"]) +--- +---@field yday integer|string +--- +---daylight saving flag, a boolean +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.isdst"]) +--- +---@field isdst boolean + +--- +---Returns a string or a table containing date and time, formatted according to the given string `format`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-os.date"]), [Wiki](https://warcraft.wiki.gg/wiki/API_date) +--- +---@param format? string +---@param time? integer +---@return string|osdate +---@nodiscard +function date(format, time) end + +--- +---Returns the difference, in seconds, from time `t1` to time `t2`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-os.difftime"]), [Wiki](https://warcraft.wiki.gg/wiki/API_difftime) +--- +---@param t2 integer +---@param t1 integer +---@return integer +---@nodiscard +function difftime(t2, t1) end + +---@class osdateparam +--- +---four digits +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.year"]) +--- +---@field year integer|string +--- +---1-12 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.month"]) +--- +---@field month integer|string +--- +---1-31 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.day"]) +--- +---@field day integer|string +--- +---0-23 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.hour"]) +--- +---@field hour (integer|string)? +--- +---0-59 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.min"]) +--- +---@field min (integer|string)? +--- +---0-61 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.sec"]) +--- +---@field sec (integer|string)? +--- +---weekday, 1–7, Sunday is 1 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.wday"]) +--- +---@field wday (integer|string)? +--- +---day of the year, 1–366 +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.yday"]) +--- +---@field yday (integer|string)? +--- +---daylight saving flag, a boolean +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-osdate.isdst"]) +--- +---@field isdst boolean? + +--- +---Returns the current time when called without arguments, or a time representing the local date and time specified by the given table. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-os.time"]), [Wiki](https://warcraft.wiki.gg/wiki/API_time) +--- +---@param date? osdateparam +---@return integer +---@nodiscard +function time(date) end diff --git a/docs/annotations/Annotations/Core/Lua/string.lua b/docs/annotations/Annotations/Core/Lua/string.lua new file mode 100644 index 0000000..825158b --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/string.lua @@ -0,0 +1,242 @@ +---@meta string_wow +--- added: string.join, string.rtgsub, string.split, strsplittable, string.trim +--- added: strcmputf8i, strlenutf8, strconcat, tostringall +--- removed: string.dump, string.pack, string.packsize, string.unpack +--- obsolete-removed: string.gfind -> renamed to string.gmatch +--- string.rtgsub is from RestrictedTable_rtgsub + +--- +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string"]) +--- +---@class stringlib +string = {} + +--- +---Returns the internal numeric codes of the characters `s[i], s[i+1], ..., s[j]`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.byte"]) +--- +---@param s string|number +---@param i? integer +---@param j? integer +---@return integer ... +---@nodiscard +function string.byte(s, i, j) end + +--- +---Returns a string with length equal to the number of arguments, in which each character has the internal numeric code equal to its corresponding argument. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.char"]) +--- +---@param byte integer +---@param ... integer +---@return string +---@nodiscard +function string.char(byte, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_string.concat) +---@param ... string +---@return string +---@nodiscard +function string.concat(...) end + +--- +---Looks for the first match of `pattern` (see [§6.4.1](command:extension.lua.doc?["en-us/51/manual.html/6.4.1"])) in the string. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.find"]) +--- +---@param s string|number +---@param pattern string|number +---@param init? integer +---@param plain? boolean +---@return integer|nil start +---@return integer|nil end +---@return any|nil ... captured +---@nodiscard +function string.find(s, pattern, init, plain) end + +--- +---Returns a formatted version of its variable number of arguments following the description given in its first argument. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.format"]) +--- +---@param s string|number +---@param ... any +---@return string +---@nodiscard +function string.format(s, ...) end + +--- +---Returns an iterator function that, each time it is called, returns the next captures from `pattern` (see [§6.4.1](command:extension.lua.doc?["en-us/51/manual.html/6.4.1"])) over the string s. +--- +---As an example, the following loop will iterate over all the words from string s, printing one per line: +---```lua +--- s = +---"hello world from Lua" +--- for w in string.gmatch(s, "%a+") do +--- print(w) +--- end +---``` +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.gmatch"]) +--- +---@param s string|number +---@param pattern string|number +---@return fun():string, ... +---@nodiscard +function string.gmatch(s, pattern) end + +--- +---Returns a copy of s in which all (or the first `n`, if given) occurrences of the `pattern` (see [§6.4.1](command:extension.lua.doc?["en-us/51/manual.html/6.4.1"])) have been replaced by a replacement string specified by `repl`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.gsub"]) +--- +---@param s string|number +---@param pattern string|number +---@param repl string|number|table|function +---@param n? integer +---@return string +---@return integer count +---@nodiscard +function string.gsub(s, pattern, repl, n) end + +--- +---Returns its length. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.len"]) +--- +---@param s string|number +---@return integer +---@nodiscard +function string.len(s) end + +--- +---Returns a copy of this string with all uppercase letters changed to lowercase. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.lower"]) +--- +---@param s string|number +---@return string +---@nodiscard +function string.lower(s) end + +--- +---Looks for the first match of `pattern` (see [§6.4.1](command:extension.lua.doc?["en-us/51/manual.html/6.4.1"])) in the string. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.match"]) +--- +---@param s string|number +---@param pattern string|number +---@param init? integer +---@return any ... +---@nodiscard +function string.match(s, pattern, init) end + +--- +---Returns a string that is the concatenation of `n` copies of the string `s` . +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.rep"]) +--- +---@param s string|number +---@param n integer +---@return string +---@nodiscard +function string.rep(s, n) end + +--- +---Returns a string that is the string `s` reversed. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.reverse"]) +--- +---@param s string|number +---@return string +---@nodiscard +function string.reverse(s) end + +--- +---Returns the substring of the string that starts at `i` and continues until `j`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.sub"]) +--- +---@param s string|number +---@param i integer +---@param j? integer +---@return string +---@nodiscard +function string.sub(s, i, j) end + +--- +---Returns a copy of this string with all lowercase letters changed to uppercase. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-string.upper"]) +--- +---@param s string|number +---@return string +---@nodiscard +function string.upper(s) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_strjoin) +---@param delim string|number +---@param ... string|number +---@return string +---@nodiscard +function string.join(delim, ...) end + +---string.gsub but for restricted tables +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_string.rtgsub) +---@param s string|number +---@param pattern string|number +---@param repl string|number|table|function +---@param n? integer +---@return string +---@return integer count +---@nodiscard +function string.rtgsub(s, pattern, repl, n) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_strsplit) +---@param delimiter string +---@param str string +---@param pieces? number +---@return string ... +---@nodiscard +function string.split(delimiter, str, pieces) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_strsplittable) +---@param delimiter string +---@param str string +---@param pieces? number +---@return string[] chunks +---@nodiscard +function strsplittable(delimiter, str, pieces) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_strtrim) +---@param str string +---@param chars? string +---@return string +---@nodiscard +function string.trim(str, chars) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_strcmputf8i) +---@param str1 string +---@param str2 string +---@return number result <= -1: smaller, 0: equal, >= 1: larger +---@nodiscard +function strcmputf8i(str1, str2) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_strlenutf8) +---@param str string +---@return number +---@nodiscard +function strlenutf8(str) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_tostringall) +---@param ... any +---@return string ... +---@nodiscard +function tostringall(...) end + +return string diff --git a/docs/annotations/Annotations/Core/Lua/table.lua b/docs/annotations/Annotations/Core/Lua/table.lua new file mode 100644 index 0000000..802eb89 --- /dev/null +++ b/docs/annotations/Annotations/Core/Lua/table.lua @@ -0,0 +1,131 @@ +---@meta table_wow +--- added: table.removemulti, table.wipe +--- removed: table.move, table.pack, table.unpack +--- obsolete-removed: table.setn +--- unpack is in basic.lua + +--- +--- +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table"]) +--- +---@class tablelib +table = {} + +--- +---Given a list where all elements are strings or numbers, returns the string `list[i]..sep..list[i+1] ··· sep..list[j]`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.concat"]) +--- +---@param list table +---@param sep? string +---@param i? integer +---@param j? integer +---@return string +---@nodiscard +function table.concat(list, sep, i, j) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_table.count) +---@param tbl table +---@return number numTableNodes Total number of elements within the table +---@return number numArrayNodes Total number of elements within the table that had integral keys in the range [1..numTableNodes]" +---@return number maxArrayIndex Largest integral key within the table, or zero if no such keys were found" +function table.count(tbl) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_table.create) +---@param arraySizeHint number +---@param nodeSizeHint? number +---@return table +---@nodiscard +function table.create(arraySizeHint, nodeSizeHint) end + +--- +---Inserts element `value` at position `pos` in `list`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.insert"]) +--- +---@overload fun(list: table, value: any) +---@param list table +---@param pos integer +---@param value any +function table.insert(list, pos, value) end + +---Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.maxn"]) +--- +---@param tbl table +---@return integer +---@nodiscard +function table.maxn(tbl) end + +--- +---Removes from `list` the element at position `pos`, returning the value of the removed element. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.remove"]) +--- +---@param list table +---@param pos? integer +---@return any +function table.remove(list, pos) end + +--- +---Sorts list elements in a given order, *in-place*, from `list[1]` to `list[#list]`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.sort"]) +--- +---@generic T +---@param list T[] +---@param comp? fun(a: T, b: T):boolean +function table.sort(list, comp) end + +---Executes the given f over all elements of table. For each element, f is called with the index and respective value as arguments. If f returns a non-nil value, then the loop is broken, and this value is returned as the final value of foreach. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.foreach"]) +--- +---@generic T +---@param list any +---@param callback fun(key: string, value: any):T|nil +---@return T|nil +---@deprecated +function table.foreach(list, callback) end + +---Executes the given f over the numerical indices of table. For each index, f is called with the index and respective value as arguments. Indices are visited in sequential order, from 1 to n, where n is the size of the table. If f returns a non-nil value, then the loop is broken and this value is returned as the result of foreachi. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.foreachi"]) +--- +---@generic T +---@param list any +---@param callback fun(key: string, value: any):T|nil +---@return T|nil +---@deprecated +function table.foreachi(list, callback) end + +---Returns the number of elements in the table. This function is equivalent to `#list`. +--- +---[View documents](command:extension.lua.doc?["en-us/51/manual.html/pdf-table.getn"]), [Wiki](https://warcraft.wiki.gg/wiki/API_table.getn) +--- +---@generic T +---@param list T[] +---@return integer +---@nodiscard +---@deprecated +function table.getn(list) end + +---Removes `count` elements from a table starting at index `pos`. +--- +---[Wiki](https://warcraft.wiki.gg/wiki/API_table.removemulti) +--- +---@param list table +---@param pos? integer +---@return any +function table.removemulti(list, pos, count) end + +---Wipes a table of all contents. +--- +---[Wiki](https://warcraft.wiki.gg/wiki/API_wipe) +---@param tbl table +---@return table +function table.wipe(tbl) end + +return table diff --git a/docs/annotations/Annotations/Core/ScriptObject/AbbreviateConfig.lua b/docs/annotations/Annotations/Core/ScriptObject/AbbreviateConfig.lua new file mode 100644 index 0000000..bfb6c39 --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/AbbreviateConfig.lua @@ -0,0 +1,12 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_AbbreviateConfig) +---@class AbbreviateConfig +local AbbreviateConfig = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AbbreviateConfig_GetAbbreviateNumberData) +---@return NumberAbbreviationBreakpoint[] data +function AbbreviateConfig:GetAbbreviateNumberData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AbbreviateConfig_SetAbbreviateNumberData) +---@param data NumberAbbreviationBreakpoint[] +function AbbreviateConfig:SetAbbreviateNumberData(data) end diff --git a/docs/annotations/Annotations/Core/ScriptObject/ColorCurveObject.lua b/docs/annotations/Annotations/Core/ScriptObject/ColorCurveObject.lua new file mode 100644 index 0000000..76f208b --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/ColorCurveObject.lua @@ -0,0 +1,79 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_ColorCurveObject) +---@class ColorCurveObject : CurveObjectBase +local ColorCurveObject = {} + +---Adds a single point to the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_AddPoint) +---@param x number +---@param y colorRGBA +function ColorCurveObject:AddPoint(x, y) end + +---Removes all points from the curve. Evaluating an empty curve always yields a zero value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_ClearPoints) +function ColorCurveObject:ClearPoints() end + +---Returns a new copy of this curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_Copy) +---@return ColorCurveObject curve +function ColorCurveObject:Copy() end + +---Returns a calculated color value from the configured curve points. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_Evaluate) +---@param x number +---@return colorRGBA y +function ColorCurveObject:Evaluate(x) end + +---Returns an unpacked calculated color value from the configured curve points. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_EvaluateUnpacked) +---@param x number +---@return number yR +---@return number yG +---@return number yB +---@return number yA +function ColorCurveObject:EvaluateUnpacked(x) end + +---Returns the vector for an individual point index on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_GetPoint) +---@param index number +---@return LuaColorCurvePoint? point +function ColorCurveObject:GetPoint(index) end + +---Returns the total number of points on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_GetPointCount) +---@return size count +function ColorCurveObject:GetPointCount() end + +---Returns the vectors for all points on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_GetPoints) +---@return LuaColorCurvePoint[] point +function ColorCurveObject:GetPoints() end + +---Removes a single point from the curve. Raises an error if the supplied point index is out of range. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_RemovePoint) +---@param index number +function ColorCurveObject:RemovePoint(index) end + +---Replaces all points on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_SetPoints) +---@param point LuaColorCurvePoint[] +function ColorCurveObject:SetPoints(point) end + +---Resets all state on the curve, and clears the secret values flag. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorCurveObject_SetToDefaults) +function ColorCurveObject:SetToDefaults() end + +---@class LuaColorCurvePoint +---@field x number +---@field y colorRGBA diff --git a/docs/annotations/Annotations/Core/ScriptObject/CurveObject.lua b/docs/annotations/Annotations/Core/ScriptObject/CurveObject.lua new file mode 100644 index 0000000..371b2b8 --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/CurveObject.lua @@ -0,0 +1,65 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_CurveObject) +---@class CurveObject : CurveObjectBase +local CurveObject = {} + +---Adds a single point to the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_AddPoint) +---@param pointX number +---@param pointY number +function CurveObject:AddPoint(pointX, pointY) end + +---Removes all points from the curve. Evaluating an empty curve always yields a zero value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_ClearPoints) +function CurveObject:ClearPoints() end + +---Returns a new copy of this curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_Copy) +---@return CurveObject curve +function CurveObject:Copy() end + +---Returns a calculated 'y' value from the configured curve points. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_Evaluate) +---@param x number +---@return number y +function CurveObject:Evaluate(x) end + +---Returns the vector for an individual point index on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_GetPoint) +---@param index number +---@return vector2? point +function CurveObject:GetPoint(index) end + +---Returns the total number of points on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_GetPointCount) +---@return size count +function CurveObject:GetPointCount() end + +---Returns the vectors for all points on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_GetPoints) +---@return vector2[] point +function CurveObject:GetPoints() end + +---Removes a single point from the curve. Raises an error if the supplied point index is out of range. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_RemovePoint) +---@param index number +function CurveObject:RemovePoint(index) end + +---Replaces all points on the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_SetPoints) +---@param point vector2[] +function CurveObject:SetPoints(point) end + +---Resets all state on the curve, and clears the secret values flag. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObject_SetToDefaults) +function CurveObject:SetToDefaults() end diff --git a/docs/annotations/Annotations/Core/ScriptObject/CurveObjectBase.lua b/docs/annotations/Annotations/Core/ScriptObject/CurveObjectBase.lua new file mode 100644 index 0000000..35e7f15 --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/CurveObjectBase.lua @@ -0,0 +1,22 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_CurveObjectBase) +---@class CurveObjectBase +local CurveObjectBase = {} + +---Returns the configured type of the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObjectBase_GetType) +---@return Enum.LuaCurveType curveType +function CurveObjectBase:GetType() end + +---Returns true if the curve has been configured with any secret values. Curves with secret values always produce secret results when evaluated. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObjectBase_HasSecretValues) +---@return boolean hasSecretValues +function CurveObjectBase:HasSecretValues() end + +---Changes the evaluation type of the curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_CurveObjectBase_SetType) +---@param type Enum.LuaCurveType +function CurveObjectBase:SetType(type) end diff --git a/docs/annotations/Annotations/Core/ScriptObject/DurationObject.lua b/docs/annotations/Annotations/Core/ScriptObject/DurationObject.lua new file mode 100644 index 0000000..6894fdb --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/DurationObject.lua @@ -0,0 +1,154 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_DurationObject) +---@class DurationObject +local DurationObject = {} + +---Copies another duration object and assigns it to this one. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_Assign) +---@param other DurationObject +function DurationObject:Assign(other) end + +---Returns a copy of this duration object. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_Copy) +---@return DurationObject copy +function DurationObject:Copy() end + +---Calculates the elapsed duration in seconds and evaluates it against a supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateElapsedDuration) +---@param curve CurveObjectBase +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return LuaCurveEvaluatedResult result +function DurationObject:EvaluateElapsedDuration(curve, modifier) end + +---Calculates the elapsed duration as a percentage value and evaluates it against a supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateElapsedPercent) +---@param curve CurveObjectBase +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return LuaCurveEvaluatedResult result +function DurationObject:EvaluateElapsedPercent(curve, modifier) end + +---Calculates the remaining duration in seconds and evaluates it against a supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateRemainingDuration) +---@param curve CurveObjectBase +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return LuaCurveEvaluatedResult result +function DurationObject:EvaluateRemainingDuration(curve, modifier) end + +---Calculates the remaining duration as a percentage value and evaluates it against a supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_EvaluateRemainingPercent) +---@param curve CurveObjectBase +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return LuaCurveEvaluatedResult result +function DurationObject:EvaluateRemainingPercent(curve, modifier) end + +---Returns the current time of the clock source used by this object. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetClockTime) +---@return FrameTime clockTime +function DurationObject:GetClockTime() end + +---Calculates the elapsed duration of the stored time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetElapsedDuration) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return DurationSeconds elapsedDuration +function DurationObject:GetElapsedDuration(modifier) end + +---Calculates the elapsed duration as a percentage value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetElapsedPercent) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return number elapsedPercent +function DurationObject:GetElapsedPercent(modifier) end + +---Calculates the end time of the stored time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetEndTime) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return FrameTime endTime +function DurationObject:GetEndTime(modifier) end + +---Returns the divisor used to convert a duration from real time to base time. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetModRate) +---@return number modRate +function DurationObject:GetModRate() end + +---Calculates the remaining duration of the stored time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetRemainingDuration) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return DurationSeconds remainingDuration +function DurationObject:GetRemainingDuration(modifier) end + +---Calculates the remaining duration as a percentage value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetRemainingPercent) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return number remainingPercent +function DurationObject:GetRemainingPercent(modifier) end + +---Calculates the start time of the stored time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetStartTime) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return FrameTime startTime +function DurationObject:GetStartTime(modifier) end + +---Calculates the total duration of the stored time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_GetTotalDuration) +---@param modifier? Enum.DurationTimeModifier Default = RealTime +---@return DurationSeconds totalDuration +function DurationObject:GetTotalDuration(modifier) end + +---Returns true if the duration has been configured with any secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_HasSecretValues) +---@return boolean hasSecretValues +function DurationObject:HasSecretValues() end + +---Returns true if the duration object is measuring a zero duration time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_IsZero) +---@return boolean isZero +function DurationObject:IsZero() end + +---Resets the duration object to represent a zero duration time span. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_Reset) +function DurationObject:Reset() end + +---Configures the duration object to represent an end time and a duration. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetTimeFromEnd) +---@param endTime FrameTime +---@param duration DurationSeconds +---@param modRate? number Default = 1 +function DurationObject:SetTimeFromEnd(endTime, duration, modRate) end + +---Configures the duration object to represent a start time and a duration. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetTimeFromStart) +---@param startTime FrameTime +---@param duration DurationSeconds +---@param modRate? number Default = 1 +function DurationObject:SetTimeFromStart(startTime, duration, modRate) end + +---Configures the duration object to represent a fixed start and end time span. If the end time is earlier than the start time, the duration will clamp to zero. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetTimeSpan) +---@param startTime FrameTime +---@param endTime FrameTime +function DurationObject:SetTimeSpan(startTime, endTime) end + +---Resets all state on the duration, and clears the secret values flag. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_DurationObject_SetToDefaults) +function DurationObject:SetToDefaults() end diff --git a/docs/annotations/Annotations/Core/ScriptObject/HousingCatalogSearcher.lua b/docs/annotations/Annotations/Core/ScriptObject/HousingCatalogSearcher.lua new file mode 100644 index 0000000..7cef611 --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/HousingCatalogSearcher.lua @@ -0,0 +1,227 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_HousingCatalogSearcher) +---@class HousingCatalogSearcher +local HousingCatalogSearcher = {} + +---Returns all catalog entries being searched (note these are NOT search results, this is the source collection of what's being searched) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetAllSearchItems) +---@return HousingCatalogEntryID[] matchingEntryIDs +function HousingCatalogSearcher:GetAllSearchItems() end + +---Returns the most recent search result entries +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetCatalogSearchResults) +---@return HousingCatalogEntryID[] matchingEntryIDs +function HousingCatalogSearcher:GetCatalogSearchResults() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetEditorModeContext) +---@return Enum.HouseEditorMode? editorModeContext +function HousingCatalogSearcher:GetEditorModeContext() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetFilterTagStatus) +---@param groupID number +---@param tagID number +---@return boolean active +function HousingCatalogSearcher:GetFilterTagStatus(groupID, tagID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetFilteredCategoryID) +---@return number? categoryID +function HousingCatalogSearcher:GetFilteredCategoryID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetFilteredSubcategoryID) +---@return number? subcategoryID +function HousingCatalogSearcher:GetFilteredSubcategoryID() end + +---Returns the total number of entries being searched through +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetNumSearchItems) +---@return number numSearchItems +function HousingCatalogSearcher:GetNumSearchItems() end + +---Returns the total number of owned instances across all most recent search result entries +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetSearchCount) +---@return number searchCount +function HousingCatalogSearcher:GetSearchCount() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetSearchText) +---@return string? searchText +function HousingCatalogSearcher:GetSearchText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_GetSortType) +---@return Enum.HousingCatalogSortType sortType +function HousingCatalogSearcher:GetSortType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsAllowedIndoorsActive) +---@return boolean isActive +function HousingCatalogSearcher:IsAllowedIndoorsActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsAllowedOutdoorsActive) +---@return boolean isActive +function HousingCatalogSearcher:IsAllowedOutdoorsActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsCollectedActive) +---@return boolean isActive +function HousingCatalogSearcher:IsCollectedActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsCustomizableOnlyActive) +---@return boolean isActive +function HousingCatalogSearcher:IsCustomizableOnlyActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsDistinctPerRecordIDActive) +---@return boolean isActive +function HousingCatalogSearcher:IsDistinctPerRecordIDActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsFirstAcquisitionBonusOnlyActive) +---@return boolean isActive +function HousingCatalogSearcher:IsFirstAcquisitionBonusOnlyActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsOwnedOnlyActive) +---@return boolean isActive +function HousingCatalogSearcher:IsOwnedOnlyActive() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsSearchInProgress) +---@return boolean isSearchInProgress +function HousingCatalogSearcher:IsSearchInProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_IsUncollectedActive) +---@return boolean isActive +function HousingCatalogSearcher:IsUncollectedActive() end + +---Run search with all current param values +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_RunSearch) +function HousingCatalogSearcher:RunSearch() end + +---Set the toggle state of all filter tags within a specific group; If active, only entries that match Any of the tags in the group will be included in search results +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAllInFilterTagGroup) +---@param groupID number +---@param active boolean +function HousingCatalogSearcher:SetAllInFilterTagGroup(groupID, active) end + +---Search parameter; If true, entries that can be placed in house interiors will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed outdoors +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAllowedIndoors) +---@param isActive boolean +function HousingCatalogSearcher:SetAllowedIndoors(isActive) end + +---Search parameter; If true, entries that can be placed outside in plots will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed indoors +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAllowedOutdoors) +---@param isActive boolean +function HousingCatalogSearcher:SetAllowedOutdoors(isActive) end + +---If true, searcher automatically updates results whenever search param values are changed +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetAutoUpdateOnParamChanges) +---@param autoUpdateActive boolean +function HousingCatalogSearcher:SetAutoUpdateOnParamChanges(autoUpdateActive) end + +---Search parameter; If true, includes all owned entries, including those that are in storage OR placed in an owned house or plot; See IsOwnedOnlyActive for a more exclusive toggle +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetCollected) +---@param isActive boolean +function HousingCatalogSearcher:SetCollected(isActive) end + +---Search parameter; If true, catalog entries that cannot be customized (ie dyed) will be excluded from the search +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetCustomizableOnly) +---@param isActive boolean +function HousingCatalogSearcher:SetCustomizableOnly(isActive) end + +---Search parameter; If true, only the first entry per recordID will be included +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetDistinctPerRecordID) +---@param isActive boolean +function HousingCatalogSearcher:SetDistinctPerRecordID(isActive) end + +---Search parameter; If set, limits search results to only entries that are used/valid in the specified editor mode +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetEditorModeContext) +---@param editorModeContext? Enum.HouseEditorMode +function HousingCatalogSearcher:SetEditorModeContext(editorModeContext) end + +---Set the toggle state of a single filter tag within a specific group +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFilterTagStatus) +---@param groupID number +---@param tagID number +---@param active boolean +function HousingCatalogSearcher:SetFilterTagStatus(groupID, tagID, active) end + +---Search parameter; If set, limits search results to only those within the specified category +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFilteredCategoryID) +---@param categoryID? number +function HousingCatalogSearcher:SetFilteredCategoryID(categoryID) end + +---Search parameter; If set, limits search results to only those within the specified subcategory +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFilteredSubcategoryID) +---@param subcategoryID? number +function HousingCatalogSearcher:SetFilteredSubcategoryID(subcategoryID) end + +---Search parameter; If true, excludes any entries that do not reward house xp when acquired for the first time +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetFirstAcquisitionBonusOnly) +---@param isActive boolean +function HousingCatalogSearcher:SetFirstAcquisitionBonusOnly(isActive) end + +---Search parameter; If true, only entries that you own, and have instances of available in storage, will be included; This does not include entries that you own but have all been placed in a house; See IsCollectedActive for param that includes placed entries +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetOwnedOnly) +---@param isActive boolean +function HousingCatalogSearcher:SetOwnedOnly(isActive) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetResultsUpdatedCallback) +---@param callback HousingCatalogSearchResultsUpdatedCallback +function HousingCatalogSearcher:SetResultsUpdatedCallback(callback) end + +---Search parameter; If set, multiple text fields are checked for instances of the text, including name, category, subcategory, and data tags +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetSearchText) +---@param searchText? string +function HousingCatalogSearcher:SetSearchText(searchText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetSortType) +---@param sortType Enum.HousingCatalogSortType +function HousingCatalogSearcher:SetSortType(sortType) end + +---Search parameter; If true, includes entries that are not owned, meaning not available in storage nor placed in any owned houses or plots +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_SetUncollected) +---@param isActive boolean +function HousingCatalogSearcher:SetUncollected(isActive) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleAllowedIndoors) +function HousingCatalogSearcher:ToggleAllowedIndoors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleAllowedOutdoors) +function HousingCatalogSearcher:ToggleAllowedOutdoors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleCollected) +function HousingCatalogSearcher:ToggleCollected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleCustomizableOnly) +function HousingCatalogSearcher:ToggleCustomizableOnly() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleDistinctPerRecordID) +function HousingCatalogSearcher:ToggleDistinctPerRecordID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleFilterTag) +---@param groupID number +---@param tagID number +function HousingCatalogSearcher:ToggleFilterTag(groupID, tagID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleFirstAcquisitionBonusOnly) +function HousingCatalogSearcher:ToggleFirstAcquisitionBonusOnly() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleOwnedOnly) +function HousingCatalogSearcher:ToggleOwnedOnly() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingCatalogSearcher_ToggleUncollected) +function HousingCatalogSearcher:ToggleUncollected() end + +---@alias HousingCatalogSearchResultsUpdatedCallback FunctionContainer|fun() diff --git a/docs/annotations/Annotations/Core/ScriptObject/HousingFixturePointFrame.lua b/docs/annotations/Annotations/Core/ScriptObject/HousingFixturePointFrame.lua new file mode 100644 index 0000000..c887f33 --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/HousingFixturePointFrame.lua @@ -0,0 +1,25 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_HousingFixturePointFrame) +---@class HousingFixturePointFrame +local HousingFixturePointFrame = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_HasAttachedFixture) +---@return boolean hasAttachedFixture +function HousingFixturePointFrame:HasAttachedFixture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_IsSelected) +---@return boolean isSelected +function HousingFixturePointFrame:IsSelected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_IsValid) +---@return boolean isValid +function HousingFixturePointFrame:IsValid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_Select) +function HousingFixturePointFrame:Select() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingFixturePointFrame_SetUpdateCallback) +---@param cb FixturePointUpdatedCallback +function HousingFixturePointFrame:SetUpdateCallback(cb) end + +---@alias FixturePointUpdatedCallback FunctionContainer|fun() diff --git a/docs/annotations/Annotations/Core/ScriptObject/HousingLayoutPinFrame.lua b/docs/annotations/Annotations/Core/ScriptObject/HousingLayoutPinFrame.lua new file mode 100644 index 0000000..6b51df6 --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/HousingLayoutPinFrame.lua @@ -0,0 +1,69 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_HousingLayoutPinFrame) +---@class HousingLayoutPinFrame +local HousingLayoutPinFrame = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_CanMove) +---@return Enum.HousingLayoutRestriction moveRestriction +function HousingLayoutPinFrame:CanMove() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_CanRemove) +---@return Enum.HousingLayoutRestriction removalRestriction +function HousingLayoutPinFrame:CanRemove() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_CanRotate) +---@return Enum.HousingLayoutRestriction rotateRestriction +function HousingLayoutPinFrame:CanRotate() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_Drag) +---@param isAccessible boolean +function HousingLayoutPinFrame:Drag(isAccessible) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetDoorConnectionInfo) +---@return DoorConnectionInfo? connectionInfo +function HousingLayoutPinFrame:GetDoorConnectionInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetPinType) +---@return Enum.HousingLayoutPinType type +function HousingLayoutPinFrame:GetPinType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetRoomGUID) +---@return WOWGUID roomGUID +function HousingLayoutPinFrame:GetRoomGUID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_GetRoomName) +---@return string? name +function HousingLayoutPinFrame:GetRoomName() end + +---Returns true if this pin's associated room, or anything attached to it, is selected. Ex: If pin is for a door, returns true if its room, or any other doors on that room, are selected +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsAnyPartOfRoomSelected) +---@return boolean isSelected +function HousingLayoutPinFrame:IsAnyPartOfRoomSelected() end + +---Will be nil if pin is not a Door +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsOccupiedDoor) +---@return boolean? isOccupied +function HousingLayoutPinFrame:IsOccupiedDoor() end + +---Returns true if this pin's object is itself selected; See IsAnyPartOfRoomSelected for a broader Selected check +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsSelected) +---@return boolean isSelected +function HousingLayoutPinFrame:IsSelected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsValid) +---@return boolean isValid +function HousingLayoutPinFrame:IsValid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_IsValidForSelectedFloorplan) +---@return boolean isValid +function HousingLayoutPinFrame:IsValidForSelectedFloorplan() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_Select) +function HousingLayoutPinFrame:Select() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_HousingLayoutPinFrame_SetUpdateCallback) +---@param cb PinUpdatedCallback +function HousingLayoutPinFrame:SetUpdateCallback(cb) end diff --git a/docs/annotations/Annotations/Core/ScriptObject/UnitHealPredictionCalculator.lua b/docs/annotations/Annotations/Core/ScriptObject/UnitHealPredictionCalculator.lua new file mode 100644 index 0000000..5ae30ef --- /dev/null +++ b/docs/annotations/Annotations/Core/ScriptObject/UnitHealPredictionCalculator.lua @@ -0,0 +1,218 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/ScriptObject_UnitHealPredictionCalculator) +---@class UnitHealPredictionCalculator +local UnitHealPredictionCalculator = {} + +---Calculates the percentage of current unit health and evaluates it against the supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_EvaluateCurrentHealthPercent) +---@param curve LuaCurveObjectBase +---@return LuaCurveEvaluatedResult result +function UnitHealPredictionCalculator:EvaluateCurrentHealthPercent(curve) end + +---Calculates the percentage of missing unit health and evaluates it against the supplied curve. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_EvaluateMissingHealthPercent) +---@param curve LuaCurveObjectBase +---@return LuaCurveEvaluatedResult result +function UnitHealPredictionCalculator:EvaluateMissingHealthPercent(curve) end + +---Returns the base amount of unit health. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetCurrentHealth) +---@return number currentHealth +function UnitHealPredictionCalculator:GetCurrentHealth() end + +---Returns the percentage of current unit health. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetCurrentHealthPercent) +---@return number currentHealthPercent +function UnitHealPredictionCalculator:GetCurrentHealthPercent() end + +---Returns the configured damage absorb clamping mode. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetDamageAbsorbClampMode) +---@return Enum.UnitDamageAbsorbClampMode damageAbsorbClampMode +function UnitHealPredictionCalculator:GetDamageAbsorbClampMode() end + +---Calculates damage absorb values and clamping according to the configured options. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetDamageAbsorbs) +---@return number amount +---@return boolean clamped +function UnitHealPredictionCalculator:GetDamageAbsorbs() end + +---Returns the configured heal absorb clamping mode. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetHealAbsorbClampMode) +---@return Enum.UnitHealAbsorbClampMode healAbsorbClampMode +function UnitHealPredictionCalculator:GetHealAbsorbClampMode() end + +---Returns the configured heal absorb processing mode. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetHealAbsorbMode) +---@return Enum.UnitHealAbsorbMode healAbsorbMode +function UnitHealPredictionCalculator:GetHealAbsorbMode() end + +---Calculates heal absorb values and clamping according to the configured options. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetHealAbsorbs) +---@return number amount +---@return boolean clamped +function UnitHealPredictionCalculator:GetHealAbsorbs() end + +---Returns the configured incoming heal clamping mode. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetIncomingHealClampMode) +---@return Enum.UnitIncomingHealClampMode incomingHealClampMode +function UnitHealPredictionCalculator:GetIncomingHealClampMode() end + +---Returns the configured incoming heal maximum overflow percentage. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetIncomingHealOverflowPercent) +---@return number incomingHealOverflowPercent +function UnitHealPredictionCalculator:GetIncomingHealOverflowPercent() end + +---Calculates incoming heal values and clamping according to the configured options. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetIncomingHeals) +---@return number amount +---@return number amountFromHealer +---@return number amountFromOthers +---@return boolean clamped +function UnitHealPredictionCalculator:GetIncomingHeals() end + +---Returns the maximum clamping amount for damage absorbs. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumDamageAbsorbs) +---@return number maximumDamageAbsorbs +function UnitHealPredictionCalculator:GetMaximumDamageAbsorbs() end + +---Returns the maximum clamping amount for heal absorbs. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumHealAbsorbs) +---@return number maximumHealAbsorbs +function UnitHealPredictionCalculator:GetMaximumHealAbsorbs() end + +---Returns the base amount of maximum unit health. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumHealth) +---@return number maximumHealth +function UnitHealPredictionCalculator:GetMaximumHealth() end + +---Returns the configured maximum health mode. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumHealthMode) +---@return Enum.UnitMaximumHealthMode maximumHealthMode +function UnitHealPredictionCalculator:GetMaximumHealthMode() end + +---Returns the maximum clamping amount for incoming heals. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMaximumIncomingHeals) +---@return number maximumIncomingHeals +function UnitHealPredictionCalculator:GetMaximumIncomingHeals() end + +---Returns the base amount of missing unit health. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMissingHealth) +---@return number missingHealth +function UnitHealPredictionCalculator:GetMissingHealth() end + +---Returns the percentage of missing unit health. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetMissingHealthPercent) +---@return number missingHealthPercent +function UnitHealPredictionCalculator:GetMissingHealthPercent() end + +---Returns the raw total figures used for data calculations. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetPredictedValues) +---@return UnitHealPredictionValues predictedValues +function UnitHealPredictionCalculator:GetPredictedValues() end + +---Returns the base total amount of all applied damage absorb shields. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalDamageAbsorbs) +---@return number totalDamageAbsorbs +function UnitHealPredictionCalculator:GetTotalDamageAbsorbs() end + +---Returns the base total amount of all applied heal absorption effects. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalHealAbsorbs) +---@return number totalHealAbsorbs +function UnitHealPredictionCalculator:GetTotalHealAbsorbs() end + +---Returns the base total amount of all incoming heals. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalIncomingHeals) +---@return number totalIncomingHeals +function UnitHealPredictionCalculator:GetTotalIncomingHeals() end + +---Returns the base total amount of all incoming heals from the healer unit, if any. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_GetTotalIncomingHealsFromHealer) +---@return number totalIncomingHealsFromHealer +function UnitHealPredictionCalculator:GetTotalIncomingHealsFromHealer() end + +---Returns true if the object has been configured with any secret values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_HasSecretValues) +---@return boolean hasSecretValues +function UnitHealPredictionCalculator:HasSecretValues() end + +---Resets all stored state on the object. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_Reset) +function UnitHealPredictionCalculator:Reset() end + +---Resets all stored healing values used for calculations. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_ResetPredictedValues) +function UnitHealPredictionCalculator:ResetPredictedValues() end + +---Changes the clamping mode used when calculating damage absorb amounts. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetDamageAbsorbClampMode) +---@param damageAbsorbClampMode Enum.UnitDamageAbsorbClampMode +function UnitHealPredictionCalculator:SetDamageAbsorbClampMode(damageAbsorbClampMode) end + +---Changes the clamping mode used when calculating heal absorb amounts. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetHealAbsorbClampMode) +---@param healAbsorbClampMode Enum.UnitHealAbsorbClampMode +function UnitHealPredictionCalculator:SetHealAbsorbClampMode(healAbsorbClampMode) end + +---Changes the processing mode used when calculating both heal absorb and incoming heal amounts. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetHealAbsorbMode) +---@param healAbsorbMode Enum.UnitHealAbsorbMode +function UnitHealPredictionCalculator:SetHealAbsorbMode(healAbsorbMode) end + +---Changes the clamping mode used when calculating incoming heal amounts. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetIncomingHealClampMode) +---@param incomingHealClampMode Enum.UnitIncomingHealClampMode +function UnitHealPredictionCalculator:SetIncomingHealClampMode(incomingHealClampMode) end + +---Changes the maximum overflow percentage for incoming heals. Increasing this to a value over 1.0 will mean that incoming heals can extend beyond maximum health. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetIncomingHealOverflowPercent) +---@param incomingHealOverflowPercent number +function UnitHealPredictionCalculator:SetIncomingHealOverflowPercent(incomingHealOverflowPercent) end + +---Changes the calculation mode for maximum health values used for clamping. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetMaximumHealthMode) +---@param maximumHealthMode Enum.UnitMaximumHealthMode +function UnitHealPredictionCalculator:SetMaximumHealthMode(maximumHealthMode) end + +---Sets the healing values used for all calculations. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetPredictedValues) +---@param predictedValues UnitHealPredictionValues +function UnitHealPredictionCalculator:SetPredictedValues(predictedValues) end + +---Resets all state on the object, and clears the secret values flag. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitHealPredictionCalculator_SetToDefaults) +function UnitHealPredictionCalculator:SetToDefaults() end diff --git a/docs/annotations/Annotations/Core/Type/BlizzardType.lua b/docs/annotations/Annotations/Core/Type/BlizzardType.lua new file mode 100644 index 0000000..be1d04e --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/BlizzardType.lua @@ -0,0 +1,63 @@ +---@meta _ + +---@alias AnimationDataEnum number +---@alias ArtifactTiers number +---@alias AuraFilters string +---@alias BigInteger number +---@alias BigUInteger number +---@alias CalendarEventID number +---@alias ClubId string +---@alias ClubInvitationId string +---@alias ClubStreamId string +---@alias ConnectionIptype number 1=IPv4, 2=IPv6 +---@alias DurationSeconds number +---@alias EncounterTimelineEventID number +---@alias FileAsset string +---@alias fileID integer +---@alias FrameTime number +---@alias GarrisonFollower string +---@alias HTMLTextType string +---@alias IDOrLink number|string +---@alias InventorySlots number +---@alias ItemInfo number|string +---@alias kstringClubMessage string +---@alias kstringLfgListApplicant string +---@alias kstringLfgListSearch string +---@alias LuaCurveEvaluatedResult number|colorRGBA +---@alias luaFunction function +---@alias LuaValueReference any +---@alias LuaValueVariant table +---@alias ModelAsset number FileID +---@alias normalizedValue number [0.0 - 1.0] +---@alias NotificationDbId string +---@alias QuestObjectiveType number +---@alias RecruitAcceptanceID string +---@alias SingleColorValue number +---@alias size number +---@alias SoundHandle number +---@alias SpellIdentifier number|string +---@alias StoreError number +---@alias stringView string +---@alias TextureAsset fileID|string|Texture +---@alias TextureAssetDisk fileID|string +---@alias textureAtlas string +---@alias textureKit string +---@alias time_t number +---@alias uiAddon string|number +---@alias uiFontHeight number +---@alias UISoundSubType number +---@alias uiUnit number +---@alias WeeklyRewardItemDBID string +---@alias WOWGUID string +---@alias WOWMONEY number + +-- scriptobjects +---@alias LuaCurveObjectBase CurveObjectBase +---@alias LuaCurveObject CurveObject +---@alias LuaColorCurveObject ColorCurveObject +---@alias LuaDurationObject DurationObject + +-- backwards compat +---@alias UnitId UnitToken +---@alias WowEvent FrameEvent +---@alias Nameplate NamePlateFrame diff --git a/docs/annotations/Annotations/Core/Type/EmoteToken.lua b/docs/annotations/Annotations/Core/Type/EmoteToken.lua new file mode 100644 index 0000000..ea474a7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/EmoteToken.lua @@ -0,0 +1,265 @@ +---@meta _ +---@alias EmoteToken string +---|"ABSENT" +---|"AGREE" +---|"ALLIANCE" +---|"AMAZE" +---|"ANGRY" +---|"APOLOGIZE" +---|"APPLAUD" +---|"ARM" +---|"ATTACKMYTARGET" +---|"AWE" +---|"BACKPACK" +---|"BADFEELING" +---|"BARK" +---|"BASHFUL" +---|"BECKON" +---|"BEG" +---|"BITE" +---|"BLAME" +---|"BLANK" +---|"BLEED" +---|"BLINK" +---|"BLUSH" +---|"BOGGLE" +---|"BONK" +---|"BOOP" +---|"BOOT" +---|"BORED" +---|"BOUNCE" +---|"BOW" +---|"BRANDISH" +---|"BRB" +---|"BREATH" +---|"BURP" +---|"BYE" +---|"CACKLE" +---|"CALM" +---|"CHALLENGE" +---|"CHARGE" +---|"CHARM" +---|"CHEER" +---|"CHICKEN" +---|"CHUCKLE" +---|"CHUG" +---|"CLAP" +---|"COLD" +---|"COMFORT" +---|"COMMEND" +---|"CONFUSED" +---|"CONGRATULATE" +---|"COUGH" +---|"COVEREARS" +---|"COWER" +---|"CRACK" +---|"CRINGE" +---|"CROSSARMS" +---|"CRY" +---|"CUDDLE" +---|"CURIOUS" +---|"CURTSEY" +---|"DANCE" +---|"DING" +---|"DISAGREE" +---|"DOUBT" +---|"DRINK" +---|"DROOL" +---|"DUCK" +---|"EAT" +---|"EMBARRASS" +---|"ENCOURAGE" +---|"ENEMY" +---|"EYE" +---|"EYEBROW" +---|"FACEPALM" +---|"FAIL" +---|"FAINT" +---|"FART" +---|"FIDGET" +---|"FLEE" +---|"FLEX" +---|"FLIRT" +---|"FLOP" +---|"FOLLOW" +---|"FORTHEALLIANCE" +---|"FORTHEHORDE" +---|"FROWN" +---|"GASP" +---|"GAZE" +---|"GIGGLE" +---|"GLARE" +---|"GLOAT" +---|"GLOWER" +---|"GO" +---|"GOING" +---|"GOLFCLAP" +---|"GOODLUCK" +---|"GREET" +---|"GRIN" +---|"GROAN" +---|"GROVEL" +---|"GROWL" +---|"GUFFAW" +---|"HAIL" +---|"HAPPY" +---|"HEADACHE" +---|"HEALME" +---|"HELLO" +---|"HELPME" +---|"HICCUP" +---|"HIGHFIVE" +---|"HISS" +---|"HOLDHAND" +---|"HORDE" +---|"HUG" +---|"HUNGRY" +---|"HURRY" +---|"HUZZAH" +---|"IDEA" +---|"IMPRESSED" +---|"INCOMING" +---|"INSULT" +---|"INTRODUCE" +---|"JEALOUS" +---|"JK" +---|"JOKE" +---|"KISS" +---|"KNEEL" +---|"LAUGH" +---|"LAYDOWN" +---|"LICK" +---|"LISTEN" +---|"LOOK" +---|"LOST" +---|"LOVE" +---|"LUCK" +---|"MAGNIFICENT" +---|"MAP" +---|"MASSAGE" +---|"MEOW" +---|"MERCY" +---|"MOCK" +---|"MOO" +---|"MOON" +---|"MOUNTSPECIAL" +---|"MOURN" +---|"MUTTER" +---|"NERVOUS" +---|"NO" +---|"NOD" +---|"NOSEPICK" +---|"OBJECT" +---|"OFFER" +---|"OOM" +---|"OOPS" +---|"OPENFIRE" +---|"PANIC" +---|"PAT" +---|"PEER" +---|"PET" +---|"PINCH" +---|"PITY" +---|"PLEAD" +---|"POINT" +---|"POKE" +---|"PONDER" +---|"POUNCE" +---|"POUT" +---|"PRAISE" +---|"PRAY" +---|"PROMISE" +---|"PROUD" +---|"PULSE" +---|"PUNCH" +---|"PURR" +---|"PUZZLE" +---|"RAISE" +---|"RASP" +---|"READ" +---|"READY" +---|"REGRET" +---|"REVENGE" +---|"ROAR" +---|"ROFL" +---|"ROLLEYES" +---|"RUDE" +---|"RUFFLE" +---|"SAD" +---|"SALUTE" +---|"SCARED" +---|"SCOFF" +---|"SCOLD" +---|"SCOWL" +---|"SCRATCH" +---|"SEARCH" +---|"SERIOUS" +---|"SEXY" +---|"SHAKEFIST" +---|"SHIFTY" +---|"SHIMMY" +---|"SHIVER" +---|"SHOO" +---|"SHOUT" +---|"SHRUG" +---|"SHUDDER" +---|"SHY" +---|"SIGH" +---|"SIGNAL" +---|"SILENCE" +---|"SING" +---|"SIT" +---|"SLAP" +---|"SLEEP" +---|"SMACK" +---|"SMILE" +---|"SMIRK" +---|"SNAP" +---|"SNARL" +---|"SNEAK" +---|"SNEEZE" +---|"SNICKER" +---|"SNIFF" +---|"SNORT" +---|"SNUB" +---|"SOOTHE" +---|"SPIT" +---|"SQUEAL" +---|"STAND" +---|"STARE" +---|"STOPATTACK" +---|"SURPRISED" +---|"SURRENDER" +---|"SUSPICIOUS" +---|"SWEAT" +---|"TALK" +---|"TALKEX" +---|"TALKQ" +---|"TAP" +---|"TAUNT" +---|"TEASE" +---|"THANK" +---|"THINK" +---|"THIRSTY" +---|"THREATEN" +---|"TICKLE" +---|"TIRED" +---|"TOAST" +---|"TRAIN" +---|"TRUCE" +---|"TWIDDLE" +---|"VETO" +---|"VICTORY" +---|"VIOLIN" +---|"WAIT" +---|"WARN" +---|"WAVE" +---|"WELCOME" +---|"WHINE" +---|"WHISTLE" +---|"WHOA" +---|"WINCE" +---|"WINK" +---|"WORK" +---|"YAWN" +---|"YW" diff --git a/docs/annotations/Annotations/Core/Type/FunctionContainer.lua b/docs/annotations/Annotations/Core/Type/FunctionContainer.lua new file mode 100644 index 0000000..3ad6269 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/FunctionContainer.lua @@ -0,0 +1,11 @@ +---@meta _ + +---@class FunctionContainer +local FunctionContainer = {} + +function FunctionContainer:Cancel() end + +---@return boolean +function FunctionContainer:IsCancelled() end + +function FunctionContainer:Invoke() end diff --git a/docs/annotations/Annotations/Core/Type/GlobalColors.lua b/docs/annotations/Annotations/Core/Type/GlobalColors.lua new file mode 100644 index 0000000..dde4da0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/GlobalColors.lua @@ -0,0 +1,282 @@ +---@meta _ +-- AUTOMATICALLY GENERATED -- Full of tales and lies. + +ACCOUNT_WIDE_FONT_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +ACHIEVEMENT_COLOR = CreateColor(1.000, 1.000, 0.000, 1.000) +ACHIEVEMENT_COMPLETE_COLOR = CreateColor(1.000, 0.502, 0.251, 1.000) +ACHIEVEMENT_INCOMPLETE_COLOR = CreateColor(1.000, 1.000, 0.000, 1.000) +ACTIONBAR_HOTKEY_FONT_COLOR = CreateColor(0.800, 0.800, 0.800, 1.000) +ADVENTURES_BUFF_BLUE = CreateColor(0.000, 0.847, 1.000, 1.000) +ADVENTURES_COMBAT_LOG_BLUE = CreateColor(0.306, 0.678, 0.843, 1.000) +ADVENTURES_COMBAT_LOG_GREY = CreateColor(0.725, 0.725, 0.725, 1.000) +ADVENTURES_COMBAT_LOG_ORANGE = CreateColor(0.776, 0.392, 0.294, 1.000) +ADVENTURES_COMBAT_LOG_YELLOW = CreateColor(1.000, 0.824, 0.000, 1.000) +ADVENTURES_HEALING_GREEN = CreateColor(0.000, 1.000, 0.071, 1.000) +ARCHAEOLOGY_BROWN = CreateColor(0.851, 0.710, 0.435, 0.000) +ARCHAEOLOGY_LIGHT_BROWN = CreateColor(1.000, 0.933, 0.737, 0.000) +AREA_DESCRIPTION_FONT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +AREA_DESCRIPTION_FONT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +AREA_NAME_FONT_COLOR = CreateColor(1.000, 0.918, 0.761, 1.000) +ARENA_NAME_FONT_COLOR = CreateColor(1.000, 0.929, 0.761, 1.000) +ARTIFACT_BAR_COLOR = CreateColor(0.902, 0.800, 0.600, 1.000) +ARTIFACT_GOLD_COLOR = CreateColor(0.902, 0.800, 0.502, 1.000) +AZERITE_ESSENCE_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +AZERITE_SUBTEXT_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +BANK_BAG_BACKGROUND_COLOR = CreateColor(0.345, 0.369, 0.376, 0.800) +BATTLENET_FONT_COLOR = CreateColor(0.510, 0.773, 1.000, 1.000) +BATTLEPET_ABILITY_LINK_COLOR = CreateColor(0.306, 0.588, 0.969, 1.000) +BIND_TRADE_TOOLTIP_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +BLACK_FONT_COLOR = CreateColor(0.000, 0.000, 0.000, 1.000) +BLUE_FONT_COLOR = CreateColor(0.000, 0.749, 0.953, 1.000) +BRIGHTBLUE_FONT_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +BRONZE_MATERIAL_TEXT_COLOR = CreateColor(0.180, 0.122, 0.059, 1.000) +BRONZE_MATERIAL_TITLETEXT_COLOR = CreateColor(0.929, 0.820, 0.000, 1.000) +CAMPAIGN_COMPLETE_COLOR = CreateColor(1.000, 0.871, 0.722, 1.000) +CANDLE_MAJOR_FACTION_COLOR = CreateColor(1.000, 0.463, 0.106, 1.000) +CENTAUR_MAJOR_FACTION_COLOR = CreateColor(1.000, 0.824, 0.000, 1.000) +CHALLENGE_MODE_TOAST_TITLE_COLOR = CreateColor(0.871, 0.800, 0.612, 1.000) +COMBAT_TEXT_PET_COLOR = CreateColor(1.000, 0.518, 0.000, 0.000) +COMBAT_TEXT_SPELL_COLOR = CreateColor(1.000, 1.000, 0.871, 1.000) +COMMON_GRAY_COLOR = CreateColor(0.659, 0.659, 0.659, 1.000) +CONTEXT_FEEDBACK_COLOR = CreateColor(0.533, 0.667, 1.000, 1.000) +CORRUPTION_COLOR = CreateColor(0.584, 0.427, 0.820, 1.000) +DARKGRAY_COLOR = CreateColor(0.400, 0.400, 0.400, 1.000) +DARKYELLOW_FONT_COLOR = CreateColor(1.000, 0.820, 0.000, 1.000) +DECREASE_STAT_COLOR = CreateColor(1.000, 0.125, 0.125, 1.000) +DEFAULT_CHAT_CHANNEL_COLOR = CreateColor(1.000, 0.753, 0.753, 1.000) +DEFAULT_MATERIAL_TEXT_COLOR = CreateColor(0.180, 0.122, 0.059, 1.000) +DEFAULT_MATERIAL_TITLETEXT_COLOR = CreateColor(0.000, 0.000, 0.000, 1.000) +DELVES_SCENARIO_NAME_COLOR = CreateColor(0.992, 0.906, 0.678, 0.000) +DIFFICULT_DIFFICULTY_COLOR = CreateColor(1.000, 0.502, 0.251, 1.000) +DIM_GREEN_FONT_COLOR = CreateColor(0.251, 0.753, 0.251, 1.000) +DIM_RED_FONT_COLOR = CreateColor(0.800, 0.098, 0.098, 1.000) +DISABLED_FONT_COLOR = CreateColor(0.502, 0.502, 0.502, 1.000) +DISABLED_REAGENT_COLOR = CreateColor(0.627, 0.627, 0.627, 1.000) +DRAGONFLIGHT_BLACK_COLOR = CreateColor(0.588, 0.588, 0.588, 0.000) +DRAGONFLIGHT_BLUE_COLOR = CreateColor(0.231, 0.616, 0.890, 0.000) +DRAGONFLIGHT_BRONZE_COLOR = CreateColor(0.702, 0.573, 0.059, 0.000) +DRAGONFLIGHT_GREEN_COLOR = CreateColor(0.176, 0.682, 0.353, 0.000) +DRAGONFLIGHT_RED_COLOR = CreateColor(1.000, 0.380, 0.380, 0.000) +DREAM_MAJOR_FACTION_COLOR = CreateColor(0.043, 0.745, 0.463, 1.000) +DULL_RED_FONT_COLOR = CreateColor(0.749, 0.149, 0.149, 1.000) +EASY_DIFFICULTY_COLOR = CreateColor(0.251, 0.753, 0.251, 1.000) +EDIT_MODE_GRID_CENTER_LINE_COLOR = CreateColor(0.784, 0.271, 0.980, 0.498) +EDIT_MODE_GRID_LINE_COLOR = CreateColor(1.000, 1.000, 1.000, 0.247) +EDIT_MODE_LAYOUT_LINK_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +EJ_SPELL_COLOR = CreateColor(0.161, 0.349, 0.827, 1.000) +ENCHANT_COLOR = CreateColor(1.000, 0.816, 0.000, 1.000) +ENCOUNTER_JOURNAL_SCROLL_BAR_BACKGROUND_COLOR = CreateColor(1.000, 0.129, 0.078, 0.247) +ENHANCED_CONDUIT_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +EPIC_PURPLE_COLOR = CreateColor(0.784, 0.271, 0.980, 1.000) +ERROR_COLOR = CreateColor(1.000, 0.125, 0.125, 1.000) +EXPANSION_COLOR_10 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_11 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_12 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_13 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_1 = CreateColor(1.000, 1.000, 1.000, 0.000) +EXPANSION_COLOR_2 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_3 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_4 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_5 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_6 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_7 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_8 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPANSION_COLOR_9 = CreateColor(1.000, 0.000, 1.000, 0.000) +EXPEDITION_MAJOR_FACTION_COLOR = CreateColor(0.769, 0.118, 0.231, 1.000) +FACTION_AT_WAR_COLOR = CreateColor(0.412, 0.012, 0.000, 1.000) +FACTION_GREEN_COLOR = CreateColor(0.000, 0.600, 0.102, 1.000) +FACTION_ORANGE_COLOR = CreateColor(0.749, 0.271, 0.000, 1.000) +FACTION_RED_COLOR = CreateColor(0.800, 0.302, 0.220, 1.000) +FACTION_YELLOW_COLOR = CreateColor(0.902, 0.702, 0.000, 1.000) +FAIR_DIFFICULTY_COLOR = CreateColor(1.000, 1.000, 0.000, 1.000) +FLAME_MAJOR_FACTION_COLOR = CreateColor(0.839, 0.733, 0.655, 1.000) +FRAMESTACK_FRAME_COLOR = CreateColor(0.400, 0.600, 1.000, 1.000) +FRAMESTACK_HIDDEN_COLOR = CreateColor(0.400, 0.400, 0.400, 1.000) +FRAMESTACK_REGION_COLOR = CreateColor(0.533, 0.867, 0.867, 1.000) +FRIENDLY_STATUS_COLOR = CreateColor(0.000, 1.000, 0.000, 1.000) +FRIENDS_BNET_BACKGROUND_COLOR = CreateColor(0.000, 0.773, 0.941, 0.047) +FRIENDS_BNET_NAME_COLOR = CreateColor(0.510, 0.773, 1.000, 1.000) +FRIENDS_BROADCAST_TIME_COLOR = CreateColor(0.263, 0.506, 0.659, 1.000) +FRIENDS_GRAY_COLOR = CreateColor(0.486, 0.518, 0.541, 1.000) +FRIENDS_OFFLINE_BACKGROUND_COLOR = CreateColor(0.569, 0.569, 0.569, 0.047) +FRIENDS_OTHER_NAME_COLOR = CreateColor(0.482, 0.518, 0.537, 1.000) +FRIENDS_WOW_BACKGROUND_COLOR = CreateColor(1.000, 0.824, 0.000, 0.047) +FRIENDS_WOW_NAME_COLOR = CreateColor(0.996, 0.882, 0.361, 1.000) +GLUE_DIALOG_FONT_COLOR = CreateColor(0.208, 0.000, 0.000, 1.000) +GLYPH_LINK_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +GOLD_FONT_COLOR = CreateColor(0.949, 0.902, 0.600, 1.000) +GRAY_FONT_COLOR = CreateColor(0.502, 0.502, 0.502, 1.000) +GREEN_FONT_COLOR = CreateColor(0.098, 1.000, 0.098, 1.000) +HEALTHBAR_HEAL_ABSORB_COLOR = CreateColor(0.424, 0.651, 0.051, 1.000) +HEALTHBAR_MY_HEAL_PREDICTION_COLOR = CreateColor(0.000, 0.827, 0.765, 1.000) +HEALTHBAR_OTHER_HEAL_PREDICTION_COLOR = CreateColor(0.000, 0.631, 0.557, 1.000) +HEALTHBAR_TOTAL_ABSORB_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +HEIRLOOM_BLUE_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +HIGHLIGHT_FONT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +HIGHLIGHT_LIGHT_BLUE = CreateColor(0.243, 0.569, 1.000, 1.000) +HOSTILE_STATUS_COLOR = CreateColor(1.000, 0.000, 0.000, 1.000) +IMPOSSIBLE_DIFFICULTY_COLOR = CreateColor(1.000, 0.125, 0.125, 1.000) +INACTIVE_COLOR = CreateColor(0.502, 0.502, 0.502, 1.000) +INCREASE_STAT_COLOR = CreateColor(0.000, 1.000, 0.000, 1.000) +INFLUENCE_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +INSTANCE_LOCK_LINK_COLOR = CreateColor(1.000, 0.502, 0.000, 1.000) +INVALID_EQUIPMENT_COLOR = CreateColor(0.596, 0.000, 0.000, 1.000) +INVASION_DESCRIPTION_FONT_COLOR = CreateColor(1.000, 0.973, 0.035, 1.000) +INVASION_DESCRIPTION_FONT_COLOR = CreateColor(1.000, 0.973, 0.035, 1.000) +INVASION_FONT_COLOR = CreateColor(0.780, 1.000, 0.000, 1.000) +INVASION_FONT_COLOR = CreateColor(0.780, 1.000, 0.000, 1.000) +ITEM_ARTIFACT_COLOR = CreateColor(0.902, 0.800, 0.502, 1.000) +ITEM_EPIC_COLOR = CreateColor(0.639, 0.208, 0.933, 1.000) +ITEM_GOOD_COLOR = CreateColor(0.118, 1.000, 0.000, 1.000) +ITEM_LEGENDARY_COLOR = CreateColor(1.000, 0.502, 0.000, 1.000) +ITEM_POOR_COLOR = CreateColor(0.616, 0.616, 0.616, 1.000) +ITEM_SCALING_STAT_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +ITEM_STANDARD_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +ITEM_SUPERIOR_COLOR = CreateColor(0.000, 0.439, 0.867, 1.000) +ITEM_WOW_TOKEN_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +JOURNAL_LINK_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +KYRIAN_BLUE_COLOR = CreateColor(0.165, 0.635, 1.000, 1.000) +LEGENDARY_ORANGE_COLOR = CreateColor(1.000, 0.502, 0.000, 1.000) +LIGHTBLUE_FONT_COLOR = CreateColor(0.529, 0.671, 1.000, 1.000) +LIGHTERBLUE_FONT_COLOR = CreateColor(0.769, 0.867, 0.988, 1.000) +LIGHTERGRAY_FONT_COLOR = CreateColor(0.475, 0.475, 0.475, 1.000) +LIGHTGRAY_FONT_COLOR = CreateColor(0.600, 0.600, 0.600, 1.000) +LIGHTYELLOW_FONT_COLOR = CreateColor(1.000, 1.000, 0.600, 1.000) +LINK_FONT_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +LOOT_LINK_COLOR = CreateColor(0.443, 0.835, 1.000, 1.000) +LORE_TEXT_BODY_COLOR = CreateColor(0.792, 0.776, 0.741, 1.000) +MARBLE_MATERIAL_TEXT_COLOR = CreateColor(0.000, 0.000, 0.000, 1.000) +MARBLE_MATERIAL_TITLETEXT_COLOR = CreateColor(0.929, 0.820, 0.000, 1.000) +NECROLORD_GREEN_COLOR = CreateColor(0.090, 0.784, 0.392, 1.000) +NEUTRAL_STATUS_COLOR = CreateColor(1.000, 1.000, 0.000, 1.000) +NEW_FEATURE_SHADOW_COLOR = CreateColor(0.322, 0.502, 1.000, 1.000) +NIFFEN_MAJOR_FACTION_COLOR = CreateColor(0.914, 0.694, 0.239, 1.000) +NIGHT_FAE_BLUE_COLOR = CreateColor(0.502, 0.710, 0.992, 1.000) +NORMAL_FONT_COLOR = CreateColor(1.000, 0.824, 0.000, 1.000) +NOT_ON_THREAT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +NO_THREAT_COLOR = CreateColor(0.690, 0.690, 0.690, 1.000) +OBJECTIVE_TRACKER_BLOCK_HEADER_COLOR = CreateColor(0.749, 0.612, 0.000, 0.000) +ORANGE_FONT_COLOR = CreateColor(1.000, 0.502, 0.251, 1.000) +ORANGE_THREAT_COLOR = CreateColor(1.000, 0.600, 0.000, 1.000) +PANEL_BACKGROUND_COLOR = CreateColor(0.122, 0.118, 0.129, 0.800) +PAPER_FRAME_COLLAPSED_COLOR = CreateColor(0.827, 0.659, 0.463, 1.000) +PAPER_FRAME_DARK_COLOR = CreateColor(0.251, 0.149, 0.020, 1.000) +PAPER_FRAME_EXPANDED_COLOR = CreateColor(0.929, 0.788, 0.620, 1.000) +PAPER_FRAME_TEXT_COLOR = CreateColor(0.208, 0.000, 0.000, 1.000) +PAPER_FRAME_TITLE_COLOR = CreateColor(0.208, 0.000, 0.000, 1.000) +PARCHMENTLARGE_MATERIAL_TEXT_COLOR = CreateColor(0.141, 0.000, 0.000, 1.000) +PARCHMENTLARGE_MATERIAL_TITLETEXT_COLOR = CreateColor(0.208, 0.000, 0.000, 1.000) +PARCHMENT_MATERIAL_TEXT_COLOR = CreateColor(0.180, 0.122, 0.059, 1.000) +PARCHMENT_MATERIAL_TITLETEXT_COLOR = CreateColor(0.000, 0.000, 0.000, 1.000) +PASSIVE_SPELL_FONT_COLOR = CreateColor(0.769, 0.639, 0.000, 1.000) +PLAYER_FACTION_COLOR_ALLIANCE = CreateColor(0.000, 0.678, 0.941, 1.000) +PLAYER_FACTION_COLOR_HORDE = CreateColor(1.000, 0.161, 0.204, 1.000) +PLAYER_NAMEPLATE_ALTERNATE_HEALTH_COLOR = CreateColor(0.000, 0.678, 0.941, 1.000) +PLUNDERSTORM_WANTED_COLOR = CreateColor(0.549, 0.357, 0.251, 1.000) +POWERBAR_PREDICTION_COLOR_ENERGY = CreateColor(0.451, 0.400, 0.000, 1.000) +POWERBAR_PREDICTION_COLOR_FOCUS = CreateColor(0.400, 0.133, 0.000, 1.000) +POWERBAR_PREDICTION_COLOR_FURY = CreateColor(0.282, 0.008, 0.392, 1.000) +POWERBAR_PREDICTION_COLOR_INSANITY = CreateColor(0.200, 0.000, 0.400, 1.000) +POWERBAR_PREDICTION_COLOR_LUNAR_POWER = CreateColor(0.059, 0.184, 0.404, 1.000) +POWERBAR_PREDICTION_COLOR_MAELSTROM = CreateColor(0.000, 0.200, 0.400, 1.000) +POWERBAR_PREDICTION_COLOR_MANA = CreateColor(0.000, 0.176, 0.408, 1.000) +POWERBAR_PREDICTION_COLOR_PAIN = CreateColor(0.400, 0.247, 0.000, 1.000) +POWERBAR_PREDICTION_COLOR_RAGE = CreateColor(0.400, 0.000, 0.000, 1.000) +POWERBAR_PREDICTION_COLOR_RUNIC_POWER = CreateColor(0.000, 0.325, 0.400, 1.000) +PROFESSIONS_JEWELCRAFTING_GEMSTONES_AMBER = CreateColor(0.973, 0.604, 0.122, 0.000) +PROFESSIONS_JEWELCRAFTING_GEMSTONES_CITRINE = CreateColor(0.973, 0.855, 0.122, 0.000) +PROFESSIONS_JEWELCRAFTING_GEMSTONES_EMERALD = CreateColor(0.263, 0.878, 0.137, 0.000) +PROFESSIONS_JEWELCRAFTING_GEMSTONES_ONYX = CreateColor(0.839, 0.122, 0.914, 0.000) +PROFESSIONS_JEWELCRAFTING_GEMSTONES_RUBY = CreateColor(0.918, 0.294, 0.294, 0.000) +PROFESSIONS_JEWELCRAFTING_GEMSTONES_SAPPHIRE = CreateColor(0.137, 0.671, 0.878, 0.000) +PROFESSION_RECIPE_COLOR = CreateColor(0.886, 0.863, 0.839, 1.000) +PROFESSION_SPEC_COLOR_ALCHEMY = CreateColor(0.659, 0.090, 0.741, 1.000) +PROFESSION_SPEC_COLOR_ARCHAEOLOGY = CreateColor(0.729, 0.584, 0.341, 1.000) +PROFESSION_SPEC_COLOR_BLACKSMITHING = CreateColor(0.863, 0.294, 0.055, 1.000) +PROFESSION_SPEC_COLOR_COOKING = CreateColor(0.863, 0.580, 0.384, 1.000) +PROFESSION_SPEC_COLOR_ENCHANTING = CreateColor(0.671, 0.439, 0.890, 1.000) +PROFESSION_SPEC_COLOR_ENGINEERING = CreateColor(0.886, 0.659, 0.212, 1.000) +PROFESSION_SPEC_COLOR_FIRST_AID = CreateColor(1.000, 1.000, 1.000, 1.000) +PROFESSION_SPEC_COLOR_FISHING = CreateColor(0.451, 0.655, 0.737, 1.000) +PROFESSION_SPEC_COLOR_HERBALISM = CreateColor(0.129, 0.604, 0.278, 1.000) +PROFESSION_SPEC_COLOR_INSCRIPTION = CreateColor(0.306, 0.992, 0.835, 1.000) +PROFESSION_SPEC_COLOR_JEWELCRAFTING = CreateColor(0.757, 0.055, 0.231, 1.000) +PROFESSION_SPEC_COLOR_LEATHERWORKING = CreateColor(0.400, 0.227, 0.145, 1.000) +PROFESSION_SPEC_COLOR_MINING = CreateColor(0.475, 0.502, 0.502, 1.000) +PROFESSION_SPEC_COLOR_SKINNING = CreateColor(0.588, 0.282, 0.133, 1.000) +PROFESSION_SPEC_COLOR_TAILORING = CreateColor(0.145, 0.251, 0.796, 1.000) +PROGENITOR_MATERIAL_TEXT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +PROGENITOR_MATERIAL_TITLETEXT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +PURE_BLUE_COLOR = CreateColor(0.000, 0.000, 1.000, 1.000) +PURE_GREEN_COLOR = CreateColor(0.000, 1.000, 0.000, 1.000) +PURE_RED_COLOR = CreateColor(0.800, 0.000, 0.000, 1.000) +PURE_RED_COLOR = CreateColor(1.000, 0.000, 0.000, 1.000) +PVP_SCOREBOARD_ALLIANCE_ALT_CELL_COLOR = CreateColor(1.000, 0.820, 0.000, 1.000) +PVP_SCOREBOARD_ALLIANCE_ALT_ROW_COLOR = CreateColor(0.851, 0.710, 0.259, 1.000) +PVP_SCOREBOARD_ALLIANCE_CELL_COLOR = CreateColor(0.000, 0.678, 0.941, 1.000) +PVP_SCOREBOARD_ALLIANCE_ROW_COLOR = CreateColor(0.110, 0.259, 0.510, 1.000) +PVP_SCOREBOARD_HORDE_ALT_CELL_COLOR = CreateColor(0.804, 0.561, 1.000, 1.000) +PVP_SCOREBOARD_HORDE_ALT_ROW_COLOR = CreateColor(0.482, 0.192, 0.824, 1.000) +PVP_SCOREBOARD_HORDE_CELL_COLOR = CreateColor(1.000, 0.161, 0.204, 1.000) +PVP_SCOREBOARD_HORDE_ROW_COLOR = CreateColor(0.459, 0.067, 0.161, 1.000) +QUEST_ACCOUNT_COMPLETED_NOTICE_FONT_COLOR = CreateColor(0.208, 0.000, 0.000, 1.000) +QUEST_ACTIVE_TRIVIAL_GRAY = CreateColor(0.749, 0.749, 0.749, 1.000) +QUEST_INELIGIBLE_GRAY = CreateColor(0.200, 0.200, 0.200, 1.000) +QUEST_OBJECTIVE_COMPLETED_FONT_COLOR = CreateColor(0.200, 0.200, 0.200, 1.000) +QUEST_OBJECTIVE_COMPLETED_FONT_COLOR_DARK_BACKGROUND = CreateColor(0.831, 0.780, 0.733, 1.000) +QUEST_OBJECTIVE_DISABLED_FONT_COLOR = CreateColor(0.498, 0.498, 0.498, 1.000) +QUEST_OBJECTIVE_DISABLED_HIGHLIGHT_FONT_COLOR = CreateColor(0.600, 0.600, 0.600, 1.000) +QUEST_OBJECTIVE_FONT_COLOR = CreateColor(0.800, 0.800, 0.800, 1.000) +QUEST_OBJECTIVE_HIGHLIGHT_FONT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +QUEST_REWARD_CONTEXT_FONT_COLOR = CreateColor(0.533, 0.667, 1.000, 1.000) +RAF_VERSION_THREE_COLOR = CreateColor(0.412, 0.694, 0.302, 0.098) +RAF_VERSION_TWO_COLOR = CreateColor(0.000, 0.773, 0.941, 0.043) +RARE_BLUE_COLOR = CreateColor(0.000, 0.569, 0.949, 1.000) +RARE_MISSION_COLOR = CreateColor(0.000, 0.012, 0.290, 1.000) +RED_FONT_COLOR = CreateColor(1.000, 0.125, 0.125, 1.000) +RED_THREAT_COLOR = CreateColor(1.000, 0.000, 0.000, 1.000) +REFUND_TOOLTIP_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +REFUND_TOOLTIP_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +RPE_FONT_COLOR = CreateColor(0.667, 1.000, 0.667, 1.000) +RUNEFORGE_LEGEDARY_SPEC_COLOR = CreateColor(0.718, 0.561, 0.416, 1.000) +SCENARIO_STAGE_COLOR = CreateColor(1.000, 0.914, 0.682, 1.000) +SCENARIO_SUBTITLE_COLOR = CreateColor(1.000, 0.831, 0.380, 1.000) +SEPIA_COLOR = CreateColor(0.565, 0.376, 0.157, 1.000) +SET_ITEM_COLOR = CreateColor(1.000, 1.000, 0.592, 1.000) +SILVER_MATERIAL_TEXT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +SILVER_MATERIAL_TITLETEXT_COLOR = CreateColor(0.929, 0.820, 0.000, 1.000) +SOULBIND_CONDUIT_ENHANCED_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +SPELLBOOK_FONT_COLOR = CreateColor(0.180, 0.106, 0.059, 1.000) +SPELLBOOK_UNLEARNED_TINT_COLOR = CreateColor(0.675, 0.533, 0.365, 1.000) +SPELL_LINK_COLOR = CreateColor(0.443, 0.835, 1.000, 1.000) +SPELL_SUBTEXT_COLOR = CreateColor(0.349, 0.200, 0.000, 1.000) +STONE_MATERIAL_TEXT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +STONE_MATERIAL_TITLETEXT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +STORM_MAJOR_FACTION_COLOR = CreateColor(0.259, 0.557, 0.996, 1.000) +SUBSCRIPTION_INTERSTITIAL_COLOR = CreateColor(0.851, 0.835, 0.808, 1.000) +TALENT_LINK_COLOR = CreateColor(0.443, 0.835, 1.000, 1.000) +TOOLTIP_DEFAULT_BACKGROUND_COLOR = CreateColor(0.090, 0.090, 0.188, 1.000) +TOOLTIP_DEFAULT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +TOY_LINK_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +TRADESKILL_EXPERIENCE_COLOR = CreateColor(0.353, 1.000, 0.129, 1.000) +TRANSMOGRIFY_COLOR = CreateColor(1.000, 0.502, 1.000, 1.000) +TRANSMOGRIFY_FONT_COLOR = CreateColor(1.000, 0.502, 1.000, 1.000) +TRIVIAL_DIFFICULTY_COLOR = CreateColor(0.502, 0.502, 0.502, 1.000) +TUSKARR_MAJOR_FACTION_COLOR = CreateColor(0.051, 0.506, 0.953, 1.000) +TUTORIAL_BLUE_FONT_COLOR = CreateColor(0.000, 0.800, 1.000, 1.000) +TUTORIAL_FONT_COLOR = CreateColor(0.800, 0.800, 0.800, 1.000) +UI_TOOLS_DISABLED_COLOR = CreateColor(0.176, 0.220, 0.376, 1.000) +UI_TOOLS_LINE_COLOR = CreateColor(0.224, 0.255, 0.369, 1.000) +UI_TOOLS_PRESSED_BUTTON_COLOR = CreateColor(0.800, 0.800, 0.800, 1.000) +UNCOMMON_GREEN_COLOR = CreateColor(0.082, 0.702, 0.000, 1.000) +USED_IN_TRADESKILL_COLOR = CreateColor(0.400, 0.733, 1.000, 1.000) +VALDRAKKEN_MAJOR_FACTION_COLOR = CreateColor(0.651, 0.529, 0.933, 1.000) +VENTHYR_RED_COLOR = CreateColor(0.894, 0.051, 0.055, 1.000) +VERY_DARK_GRAY_COLOR = CreateColor(0.149, 0.149, 0.149, 1.000) +VERY_LIGHT_GRAY_COLOR = CreateColor(0.898, 0.898, 0.898, 1.000) +WARBOARD_OPTION_TEXT_COLOR = CreateColor(0.278, 0.020, 0.020, 1.000) +WARNING_FONT_COLOR = CreateColor(1.000, 0.282, 0.000, 1.000) +WEB_MAJOR_FACTION_COLOR = CreateColor(0.596, 0.259, 0.722, 1.000) +WHITE_FONT_COLOR = CreateColor(1.000, 1.000, 1.000, 1.000) +YELLOW_FONT_COLOR = CreateColor(1.000, 1.000, 0.000, 1.000) +YELLOW_THREAT_COLOR = CreateColor(1.000, 1.000, 0.467, 1.000) diff --git a/docs/annotations/Annotations/Core/Type/Mixin.lua b/docs/annotations/Annotations/Core/Type/Mixin.lua new file mode 100644 index 0000000..4391858 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/Mixin.lua @@ -0,0 +1,12 @@ +---@meta _ + +---@alias AzeriteEmpoweredItemLocation ItemLocation +---@alias AzeriteItemLocation ItemLocation +---@alias EmptiableItemLocation ItemLocation +---@alias ItemTransmogInfo ItemTransmogInfoMixin +---@alias PlayerLocation PlayerLocationMixin +---@alias ReportInfo ReportInfoMixin +---@alias TransmogLocation TransmogLocationType +---@alias TransmogPendingInfo TransmogPendingInfoMixin +---@alias vector2 Vector2DMixin +---@alias vector3 Vector3DMixin diff --git a/docs/annotations/Annotations/Core/Type/Namespace.lua b/docs/annotations/Annotations/Core/Type/Namespace.lua new file mode 100644 index 0000000..1b5ce49 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/Namespace.lua @@ -0,0 +1,25 @@ +---@meta _ +-- these namespaces didnt document any functions + +C_AccountServices = {} -- no doc +C_AdventureJournal = {} -- AdventureJournalDocumentation.lua +C_ArrowCalloutManager = {} -- no doc +C_BlackMarket = {} -- BlackMarketInfoDocumentation.lua; C_BlackMarketInfo +C_CharacterServices = {} -- no doc +C_CharacterServicesPublic = {} -- no doc +C_ClassTrial = {} -- ClassTrialDocumentation.lua +C_Debug = {} -- no doc +C_FunctionContainers = {} -- no doc +C_Heirloom = {} -- HeirloomInfoDocumentation.lua +C_PrototypeDialog = {} -- no doc +C_Reincarnation = {} -- no doc +C_Scenario = {} -- ScenarioInfoDocumentation.lua; C_ScenarioInfo +C_SharedCharacterServices = {} -- no doc +C_SpectatingUI = {} -- no doc +C_TalkingHead = {} -- TalkingHeadDocumentation.lua +C_ToyBox = {} -- no doc +C_Trophy = {} -- no doc +C_Widget = {} -- no doc +C_WowLabsDataManager = {} -- no doc +C_WoWLabsMatchmaking = {} -- no doc +C_WowTokenPublic = {} -- no doc diff --git a/docs/annotations/Annotations/Core/Type/StringEnum.lua b/docs/annotations/Annotations/Core/Type/StringEnum.lua new file mode 100644 index 0000000..01b5761 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/StringEnum.lua @@ -0,0 +1,113 @@ +---@meta _ +---@alias ChatType +---|"SAY" +---|"EMOTE" +---|"YELL" +---|"PARTY" +---|"RAID" +---|"RAID_WARNING" +---|"INSTANCE_CHAT" +---|"GUILD" +---|"OFFICER" +---|"WHISPER" +---|"CHANNEL" +---|"AFK" +---|"DND" +---|"VOICE_TEXT" + +---@alias ClassFile #41 +---|"WARRIOR" +---|"PALADIN" +---|"HUNTER" +---|"ROGUE" +---|"PRIEST" +---|"DEATHKNIGHT" +---|"SHAMAN" +---|"MAGE" +---|"WARLOCK" +---|"MONK" +---|"DRUID" +---|"DEMONHUNTER" +---|"EVOKER" + +---@alias HyperlinkType #41 +---|"achievement" +---|"api" +---|"azessence" +---|"battlepet" +---|"battlePetAbil" +---|"calendarEvent" +---|"channel" +---|"clubFinder" +---|"clubTicket" +---|"community" +---|"conduit" +---|"currency" +---|"death" +---|"enchant" +---|"garrfollower" +---|"garrfollowerability" +---|"garrmission" +---|"instancelock" +---|"item" +---|"journal" +---|"keystone" +---|"levelup" +---|"lootHistory" +---|"outfit" +---|"player" +---|"playerCommunity" +---|"BNplayer" +---|"BNplayerCommunity" +---|"quest" +---|"shareachieve" +---|"shareitem" +---|"sharess" +---|"spell" +---|"storecategory" +---|"talent" +---|"trade" +---|"transmogappearance" +---|"transmogillusion" +---|"transmogset" +---|"unit" +---|"urlIndex" +---|"worldmap" + +---@alias InventorySlotName +---|"AMMOSLOT" +---|"HEADSLOT" +---|"NECKSLOT" +---|"SHOULDERSLOT" +---|"SHIRTSLOT" +---|"CHESTSLOT" +---|"WAISTSLOT" +---|"LEGSSLOT" +---|"FEETSLOT" +---|"WRISTSLOT" +---|"HANDSSLOT" +---|"FINGER0SLOT" +---|"FINGER1SLOT" +---|"TRINKET0SLOT" +---|"TRINKET1SLOT" +---|"BACKSLOT" +---|"MAINHANDSLOT" +---|"SECONDARYHANDSLOT" +---|"RANGEDSLOT" +---|"TABARDSLOT" + +---@alias SendChatMessageType +---|"SAY" +---|"EMOTE" +---|"YELL" +---|"PARTY" +---|"RAID" +---|"RAID_WARNING" +---|"INSTANCE_CHAT" +---|"GUILD" +---|"OFFICER" +---|"WHISPER" +---|"CHANNEL" +---|"AFK" +---|"DND" +---|"VOICE_TEXT" diff --git a/docs/annotations/Annotations/Core/Type/Structure.lua b/docs/annotations/Annotations/Core/Type/Structure.lua new file mode 100644 index 0000000..01f8ff5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/Structure.lua @@ -0,0 +1,64 @@ +---@meta _ +-- these structures are not documented by Blizzard + +---@class AuraData +---@field applications number +---@field auraInstanceID number +---@field canApplyAura boolean +---@field charges number +---@field dispelName string? +---@field duration number +---@field expirationTime number +---@field icon number +---@field isBossAura boolean +---@field isFromPlayerOrPlayerPet boolean +---@field isHarmful boolean +---@field isHelpful boolean +---@field isNameplateOnly boolean +---@field isRaid boolean +---@field isStealable boolean +---@field maxCharges number +---@field name string +---@field nameplateShowAll boolean +---@field nameplateShowPersonal boolean +---@field points number[] +---@field sourceUnit string? +---@field spellId number +---@field timeMod number + +---@class UiMapPoint +---@field uiMapID number +---@field position vector2 +---@field z number? + +---@class TooltipComparisonItem +---@field guid WOWGUID? +---@field hyperlink string? +---@field overrideItemLevel number + +---@class TooltipData +---@field type Enum.TooltipDataType? +---@field dataInstanceID number +---@field lines TooltipDataLine[] +---@field hyperlink string? +---@field guid WOWGUID? +---@field isAzeriteItem boolean? +---@field isAzeriteEmpoweredItem boolean? +---@field isCorruptedItem boolean? +---@field overrideItemLevel number? +---@field repairCost number? +---@field healthGUID WOWGUID? + +---@class TooltipDataLine +---@field type Enum.TooltipDataLineType +---@field leftColor colorRGB +---@field leftText string +---@field rightColor colorRGB +---@field rightText string +---@field wrapText boolean +---@field unitToken string? +---@field price WOWMONEY? +---@field maxPrice WOWMONEY? +---@field tooltipType number? +---@field tooltipID number? +---@field bonding number? diff --git a/docs/annotations/Annotations/Core/Type/UnitToken.lua b/docs/annotations/Annotations/Core/Type/UnitToken.lua new file mode 100644 index 0000000..a062484 --- /dev/null +++ b/docs/annotations/Annotations/Core/Type/UnitToken.lua @@ -0,0 +1,29 @@ +---@meta _ +-- does not include pet and target suffices and spectated +-- but any string is accepted anyway + +---@alias UnitToken string +---|"player" +---|"target" +---|"focus" +---|"mouseover" +---|"pet" +---|"vehicle" +---|"npc" +---|"questnpc" +---|"none" +---|"party1" +---|"raid1" +---|"arena1" +---|"boss1" +---|"nameplate1" +---|"anyenemy" +---|"anyfriend" +---|"anyinteract" +---|"softenemy" +---|"softfriend" +---|"softinteract" + +---@alias UnitTokenNamePlate UnitToken +---@alias UnitTokenRestrictedForAddOns UnitToken +---@alias UnitTokenPvPRestrictedForAddOns UnitToken diff --git a/docs/annotations/Annotations/Core/Widget/Animation/Alpha.lua b/docs/annotations/Annotations/Core/Widget/Animation/Alpha.lua new file mode 100644 index 0000000..1e26c7d --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/Alpha.lua @@ -0,0 +1,23 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Alpha) +---@class Alpha : Animation +local Alpha = {} +---@class alpha : Alpha +---@class ALPHA : Alpha + +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_Alpha_GetFromAlpha) +---@return number normalizedAlpha +function Alpha:GetFromAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Alpha_GetToAlpha) +---@return number normalizedAlpha +function Alpha:GetToAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Alpha_SetFromAlpha) +---@param normalizedAlpha number +function Alpha:SetFromAlpha(normalizedAlpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Alpha_SetToAlpha) +---@param normalizedAlpha number +function Alpha:SetToAlpha(normalizedAlpha) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/Animation.lua b/docs/annotations/Annotations/Core/Widget/Animation/Animation.lua new file mode 100644 index 0000000..812682c --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/Animation.lua @@ -0,0 +1,165 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Animation) +---@class Animation : Object +local Animation = {} +---@class animation : Animation +---@class ANIMATION : Animation + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParent) +---@return AnimationGroup parent +function Animation:GetParent() end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetDuration) +---@return number durationSec +function Animation:GetDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetElapsed) +---@return number elapsedSec +function Animation:GetElapsed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetEndDelay) +---@return number delaySec +function Animation:GetEndDelay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetOrder) +---@return number order +function Animation:GetOrder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetProgress) +---@return number progress +function Animation:GetProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetRegionParent) +---@return CScriptObject region +function Animation:GetRegionParent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetScript) +---@param scriptTypeName ScriptAnimation +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return luaFunction script +function Animation:GetScript(scriptTypeName, bindingType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetSmoothProgress) +---@return number progress +function Animation:GetSmoothProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetSmoothing) +---@return SmoothingType weights +function Animation:GetSmoothing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetStartDelay) +---@return number delaySec +function Animation:GetStartDelay() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_GetTarget) +---@return CScriptObject target +function Animation:GetTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_HasScript) +---@param scriptName string +---@return boolean hasScript +function Animation:HasScript(scriptName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_HookScript) +---@param scriptTypeName ScriptAnimation +---@param script luaFunction +---@param bindingType? LE_SCRIPT_BINDING_TYPE +function Animation:HookScript(scriptTypeName, script, bindingType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_IsDelaying) +---@return boolean isDelaying +function Animation:IsDelaying() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_IsDone) +---@return boolean isDone +function Animation:IsDone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_IsPaused) +---@return boolean isPaused +function Animation:IsPaused() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_IsPlaying) +---@return boolean isPlaying +function Animation:IsPlaying() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_IsStopped) +---@return boolean isStopped +function Animation:IsStopped() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_Pause) +function Animation:Pause() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_Play) +function Animation:Play() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_Restart) +function Animation:Restart() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetChildKey) +---@param childKey string +---@return boolean success +function Animation:SetChildKey(childKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetDuration) +---@param durationSec number +---@param recomputeGroupDuration? boolean Default = true +function Animation:SetDuration(durationSec, recomputeGroupDuration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetEndDelay) +---@param delaySec number +---@param recomputeGroupDuration? boolean Default = true +function Animation:SetEndDelay(delaySec, recomputeGroupDuration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetOrder) +---@param newOrder number +function Animation:SetOrder(newOrder) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetParent) +---@param parent SimpleAnimGroup +---@param order? number +function Animation:SetParent(parent, order) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetPlaying) +---@param play boolean +function Animation:SetPlaying(play) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetScript) +---@param scriptTypeName string +---@param script? luaFunction +function Animation:SetScript(scriptTypeName, script) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetSmoothProgress) +---@param durationSec number +function Animation:SetSmoothProgress(durationSec) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetSmoothing) +---@param weights SmoothingType +function Animation:SetSmoothing(weights) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetStartDelay) +---@param delaySec number +---@param recomputeGroupDuration? boolean Default = true +function Animation:SetStartDelay(delaySec, recomputeGroupDuration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetTarget) +---@param target CScriptObject +---@return boolean success +function Animation:SetTarget(target) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetTargetKey) +---@param key string +---@return boolean success +function Animation:SetTargetKey(key) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetTargetName) +---@param name string +---@return boolean success +function Animation:SetTargetName(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_SetTargetParent) +---@return boolean success +function Animation:SetTargetParent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Animation_Stop) +function Animation:Stop() end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/AnimationGroup.lua b/docs/annotations/Annotations/Core/Widget/Animation/AnimationGroup.lua new file mode 100644 index 0000000..be85c26 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/AnimationGroup.lua @@ -0,0 +1,131 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_AnimationGroup) +---@class AnimationGroup : Object +local AnimationGroup = {} +---@class animationgroup : AnimationGroup +---@class ANIMATIONGROUP : AnimationGroup + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParent) +---@return Frame parent +function AnimationGroup:GetParent() end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_CreateAnimation) +---@generic T +---@param animationType? `T` | AnimationType +---@param name? string +---@param templateName? string +---@return table|T animation +function AnimationGroup:CreateAnimation(animationType, name, templateName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_Finish) +function AnimationGroup:Finish() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetAnimationSpeedMultiplier) +---@return number animationSpeedMultiplier +function AnimationGroup:GetAnimationSpeedMultiplier() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetAnimations) +---@return Animation ... scriptObject +function AnimationGroup:GetAnimations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetDuration) +---@return number durationSec +function AnimationGroup:GetDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetElapsed) +---@return number elapsedSec +function AnimationGroup:GetElapsed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetLoopState) +---@return string loopState +function AnimationGroup:GetLoopState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetLooping) +---@return LoopType loopType +function AnimationGroup:GetLooping() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetProgress) +---@return number progress +function AnimationGroup:GetProgress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_GetScript) +---@param scriptTypeName ScriptAnimationGroup +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return luaFunction script +function AnimationGroup:GetScript(scriptTypeName, bindingType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_HasScript) +---@param scriptName ScriptAnimationGroup +---@return boolean hasScript +function AnimationGroup:HasScript(scriptName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_HookScript) +---@param scriptTypeName ScriptAnimationGroup +---@param script luaFunction +---@param bindingType? LE_SCRIPT_BINDING_TYPE +function AnimationGroup:HookScript(scriptTypeName, script, bindingType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_IsDone) +---@return boolean isDone +function AnimationGroup:IsDone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_IsPaused) +---@return boolean isPaused +function AnimationGroup:IsPaused() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_IsPendingFinish) +---@return boolean isPendingFinish +function AnimationGroup:IsPendingFinish() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_IsPlaying) +---@return boolean isPlaying +function AnimationGroup:IsPlaying() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_IsReverse) +---@return boolean isReverse +function AnimationGroup:IsReverse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_IsSetToFinalAlpha) +---@return boolean isSetToFinalAlpha +function AnimationGroup:IsSetToFinalAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_Pause) +function AnimationGroup:Pause() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_Play) +---@param reverse? boolean Default = false +---@param offset? number Default = 0 +function AnimationGroup:Play(reverse, offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_RemoveAnimations) +function AnimationGroup:RemoveAnimations() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_Restart) +---@param reverse? boolean Default = false +---@param offset? number Default = 0 +function AnimationGroup:Restart(reverse, offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_SetAnimationSpeedMultiplier) +---@param animationSpeedMultiplier number +function AnimationGroup:SetAnimationSpeedMultiplier(animationSpeedMultiplier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_SetLooping) +---@param loopType LoopType +function AnimationGroup:SetLooping(loopType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_SetPlaying) +---@param play boolean +function AnimationGroup:SetPlaying(play) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_SetScript) +---@param scriptTypeName ScriptAnimationGroup +---@param script? luaFunction +function AnimationGroup:SetScript(scriptTypeName, script) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_SetToFinalAlpha) +---@param setToFinalAlpha boolean +function AnimationGroup:SetToFinalAlpha(setToFinalAlpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimationGroup_Stop) +function AnimationGroup:Stop() end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/ControlPoint.lua b/docs/annotations/Annotations/Core/Widget/Animation/ControlPoint.lua new file mode 100644 index 0000000..8316497 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/ControlPoint.lua @@ -0,0 +1,33 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ControlPoint) +---@class ControlPoint : Object +local ControlPoint = {} +---@class controlpoint : ControlPoint +---@class CONTROLPOINT : ControlPoint + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParent) +---@return Path parent +function ControlPoint:GetParent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ControlPoint_GetOffset) +---@return uiUnit offsetX +---@return uiUnit offsetY +function ControlPoint:GetOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ControlPoint_GetOrder) +---@return number order +function ControlPoint:GetOrder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ControlPoint_SetOffset) +---@param offsetX uiUnit +---@param offsetY uiUnit +function ControlPoint:SetOffset(offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ControlPoint_SetOrder) +---@param order number +function ControlPoint:SetOrder(order) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ControlPoint_SetParent) +---@param parent SimplePathAnim +---@param order? number +function ControlPoint:SetParent(parent, order) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/FlipBook.lua b/docs/annotations/Annotations/Core/Widget/Animation/FlipBook.lua new file mode 100644 index 0000000..4090aa7 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/FlipBook.lua @@ -0,0 +1,46 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_FlipBook) +---@class FlipBook : Animation +local FlipBook = {} +---@class flipbook : FlipBook +---@class FLIPBOOK : FlipBook + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_GetFlipBookColumns) +---@return number columns +function FlipBook:GetFlipBookColumns() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_GetFlipBookFrameHeight) +---@return number height +function FlipBook:GetFlipBookFrameHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_GetFlipBookFrameWidth) +---@return number width +function FlipBook:GetFlipBookFrameWidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_GetFlipBookFrames) +---@return number frames +function FlipBook:GetFlipBookFrames() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_GetFlipBookRows) +---@return number rows +function FlipBook:GetFlipBookRows() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_SetFlipBookColumns) +---@param columns number +function FlipBook:SetFlipBookColumns(columns) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_SetFlipBookFrameHeight) +---@param height number +function FlipBook:SetFlipBookFrameHeight(height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_SetFlipBookFrameWidth) +---@param width number +function FlipBook:SetFlipBookFrameWidth(width) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_SetFlipBookFrames) +---@param frames number +function FlipBook:SetFlipBookFrames(frames) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FlipBook_SetFlipBookRows) +---@param rows number +function FlipBook:SetFlipBookRows(rows) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/Path.lua b/docs/annotations/Annotations/Core/Widget/Animation/Path.lua new file mode 100644 index 0000000..ea5d08d --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/Path.lua @@ -0,0 +1,29 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Path) +---@class Path : Animation +local Path = {} +---@class path : Path +---@class PATH : Path + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Path_CreateControlPoint) +---@param name? string +---@param templateName? string +---@param order? number +---@return SimpleControlPoint point +function Path:CreateControlPoint(name, templateName, order) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Path_GetControlPoints) +---@return ControlPoint ... ScriptObject +function Path:GetControlPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Path_GetCurveType) +---@return CurveType curveType +function Path:GetCurveType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Path_GetMaxControlPointOrder) +---@return number maxOrder +function Path:GetMaxControlPointOrder() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Path_SetCurveType) +---@param curveType CurveType +function Path:SetCurveType(curveType) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/Rotation.lua b/docs/annotations/Annotations/Core/Widget/Animation/Rotation.lua new file mode 100644 index 0000000..9a0cddb --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/Rotation.lua @@ -0,0 +1,34 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Rotation) +---@class Rotation : Animation +local Rotation = {} +---@class rotation : Rotation +---@class ROTATION : Rotation + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Rotation_GetDegrees) +---@return number angle +function Rotation:GetDegrees() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Rotation_GetOrigin) +---@return FramePoint point +---@return number originX +---@return number originY +function Rotation:GetOrigin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Rotation_GetRadians) +---@return number angle +function Rotation:GetRadians() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Rotation_SetDegrees) +---@param angle number +function Rotation:SetDegrees(angle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Rotation_SetOrigin) +---@param point FramePoint +---@param originX number +---@param originY number +function Rotation:SetOrigin(point, originX, originY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Rotation_SetRadians) +---@param angle number +function Rotation:SetRadians(angle) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/Scale.lua b/docs/annotations/Annotations/Core/Widget/Animation/Scale.lua new file mode 100644 index 0000000..69576e9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/Scale.lua @@ -0,0 +1,49 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Scale) +---@class Scale : Animation +local Scale = {} +---@class scale : Scale +---@class SCALE : Scale +---@class LineScale : Scale + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_GetOrigin) +---@return FramePoint point +---@return number originX +---@return number originY +function Scale:GetOrigin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_GetScale) +---@return number scaleX +---@return number scaleY +function Scale:GetScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_GetScaleFrom) +---@return number scaleX +---@return number scaleY +function Scale:GetScaleFrom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_GetScaleTo) +---@return number scaleX +---@return number scaleY +function Scale:GetScaleTo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_SetOrigin) +---@param point FramePoint +---@param originX number +---@param originY number +function Scale:SetOrigin(point, originX, originY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_SetScale) +---@param scaleX number +---@param scaleY number +function Scale:SetScale(scaleX, scaleY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_SetScaleFrom) +---@param scaleX number +---@param scaleY number +function Scale:SetScaleFrom(scaleX, scaleY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Scale_SetScaleTo) +---@param scaleX number +---@param scaleY number +function Scale:SetScaleTo(scaleX, scaleY) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/TextureCoordTranslation.lua b/docs/annotations/Annotations/Core/Widget/Animation/TextureCoordTranslation.lua new file mode 100644 index 0000000..e587461 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/TextureCoordTranslation.lua @@ -0,0 +1,16 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_TextureCoordTranslation) +---@class TextureCoordTranslation : Animation +local TextureCoordTranslation = {} +---@class textureCoordTranslation : TextureCoordTranslation +---@class TEXTURECOORDTRANSLATION : TextureCoordTranslation + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureCoordTranslation_GetOffset) +---@return number offsetU +---@return number offsetV +function TextureCoordTranslation:GetOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureCoordTranslation_SetOffset) +---@param offsetU number +---@param offsetV number +function TextureCoordTranslation:SetOffset(offsetU, offsetV) end diff --git a/docs/annotations/Annotations/Core/Widget/Animation/Translation.lua b/docs/annotations/Annotations/Core/Widget/Animation/Translation.lua new file mode 100644 index 0000000..7cb50f2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/Translation.lua @@ -0,0 +1,20 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Translation) +---@class Translation : Animation +local Translation = {} +---@class translation : Translation +---@class TRANSLATION : Translation +---@class LineTranslation : Translation + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Translation_GetOffset) +---@return uiUnit offsetX +---@return uiUnit offsetY +function Translation:GetOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Translation_SetOffset) +---@param offsetX uiUnit +---@param offsetY uiUnit +function Translation:SetOffset(offsetX, offsetY) end + +---@class LineTranslation : Translation +local LineTranslation = {} diff --git a/docs/annotations/Annotations/Core/Widget/Animation/VertexColor.lua b/docs/annotations/Annotations/Core/Widget/Animation/VertexColor.lua new file mode 100644 index 0000000..18147c2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Animation/VertexColor.lua @@ -0,0 +1,23 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_VertexColor) +---@class VertexColor : Animation +local VertexColor = {} +---@class vertexcolor : VertexColor +---@class VERTEXCOLOR : VertexColor + +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_VertexColor_GetEndColor) +---@return colorRGBA color +function VertexColor:GetEndColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_VertexColor_GetStartColor) +---@return colorRGBA color +function VertexColor:GetStartColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_VertexColor_SetEndColor) +---@param color colorRGBA +function VertexColor:SetEndColor(color) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_VertexColor_SetStartColor) +---@param color colorRGBA +function VertexColor:SetStartColor(color) end diff --git a/docs/annotations/Annotations/Core/Widget/Base/AnimatableObject.lua b/docs/annotations/Annotations/Core/Widget/Base/AnimatableObject.lua new file mode 100644 index 0000000..bdedbb4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/AnimatableObject.lua @@ -0,0 +1,17 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ScriptRegion) +---@class AnimatableObject : Object +local AnimatableObject = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimatableObject_CreateAnimationGroup) +---@param name? string +---@param templateName? string +---@return SimpleAnimGroup group +function AnimatableObject:CreateAnimationGroup(name, templateName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimatableObject_GetAnimationGroups) +---@return SimpleAnimGroup ... scriptObject +function AnimatableObject:GetAnimationGroups() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_AnimatableObject_StopAnimating) +function AnimatableObject:StopAnimating() end diff --git a/docs/annotations/Annotations/Core/Widget/Base/Blob.lua b/docs/annotations/Annotations/Core/Widget/Base/Blob.lua new file mode 100644 index 0000000..726a95b --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/Blob.lua @@ -0,0 +1,59 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_POIFrame) +---@class Blob : Frame +local Blob = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_DrawAll) +function Blob:DrawAll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_DrawBlob) +---@param questID number +---@param draw? boolean Default = false +function Blob:DrawBlob(questID, draw) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_DrawNone) +function Blob:DrawNone() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_EnableMerging) +---@param enable? boolean Default = false +function Blob:EnableMerging(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_EnableSmoothing) +---@param enable? boolean Default = false +function Blob:EnableSmoothing(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_GetMapID) +---@return number uiMapID +function Blob:GetMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetBorderAlpha) +---@param alpha number +function Blob:SetBorderAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetBorderScalar) +---@param scalar number +function Blob:SetBorderScalar(scalar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetBorderTexture) +---@param asset FileAsset +function Blob:SetBorderTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetFillAlpha) +---@param alpha number +function Blob:SetFillAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetFillTexture) +---@param asset FileAsset +function Blob:SetFillTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetMapID) +---@param uiMapID number +function Blob:SetMapID(uiMapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetMergeThreshold) +---@param threshold number +function Blob:SetMergeThreshold(threshold) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Blob_SetNumSplinePoints) +---@param numSplinePoints number +function Blob:SetNumSplinePoints(numSplinePoints) end diff --git a/docs/annotations/Annotations/Core/Widget/Base/CharacterModelBase.lua b/docs/annotations/Annotations/Core/Widget/Base/CharacterModelBase.lua new file mode 100644 index 0000000..482893e --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/CharacterModelBase.lua @@ -0,0 +1,111 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_PlayerModel) +---@class CharacterModelBase : Model +local CharacterModelBase = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_ApplySpellVisualKit) +---@param spellVisualKitID number +---@param oneShot? boolean Default = false +function CharacterModelBase:ApplySpellVisualKit(spellVisualKitID, oneShot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_CanSetUnit) +---@param unit UnitToken +function CharacterModelBase:CanSetUnit(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_FreezeAnimation) +---@param anim AnimationDataEnum +---@param variation number +---@param frame number +function CharacterModelBase:FreezeAnimation(anim, variation, frame) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_GetDisplayInfo) +---@return number displayID +function CharacterModelBase:GetDisplayInfo() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_GetDoBlend) +---@return boolean doBlend +function CharacterModelBase:GetDoBlend() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_GetKeepModelOnHide) +---@return boolean keepModelOnHide +function CharacterModelBase:GetKeepModelOnHide() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_HasAnimation) +---@param anim AnimationDataEnum +---@return boolean hasAnimation +function CharacterModelBase:HasAnimation(anim) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_PlayAnimKit) +---@param animKit number +---@param loop? boolean Default = false +function CharacterModelBase:PlayAnimKit(animKit, loop) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_RefreshCamera) +function CharacterModelBase:RefreshCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_RefreshUnit) +function CharacterModelBase:RefreshUnit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetAnimation) +---@param anim AnimationDataEnum +---@param variation? number +function CharacterModelBase:SetAnimation(anim, variation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetBarberShopAlternateForm) +function CharacterModelBase:SetBarberShopAlternateForm() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetCamDistanceScale) +---@param scale number +function CharacterModelBase:SetCamDistanceScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetCreature) +---@param creatureID number +---@param displayID? number Default = 0 +function CharacterModelBase:SetCreature(creatureID, displayID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetDisplayInfo) +---@param displayID number +---@param mountDisplayID? number +function CharacterModelBase:SetDisplayInfo(displayID, mountDisplayID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetDoBlend) +---@param doBlend? boolean Default = false +function CharacterModelBase:SetDoBlend(doBlend) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetItem) +---@param itemID number +---@param appearanceModID? number +---@param itemVisualID? number +function CharacterModelBase:SetItem(itemID, appearanceModID, itemVisualID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetItemAppearance) +---@param itemAppearanceID number +---@param itemVisualID? number +---@param itemSubclass? number|Enum.ItemWeaponSubclass +function CharacterModelBase:SetItemAppearance(itemAppearanceID, itemVisualID, itemSubclass) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetKeepModelOnHide) +---@param keepModelOnHide boolean +function CharacterModelBase:SetKeepModelOnHide(keepModelOnHide) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetPortraitZoom) +---@param zoom number +function CharacterModelBase:SetPortraitZoom(zoom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetRotation) +---@param radians number +---@param animate? boolean Default = true +function CharacterModelBase:SetRotation(radians, animate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_SetUnit) +---@param unit UnitToken +---@param blend? boolean Default = true +---@param useNativeForm? boolean +---@return boolean success +function CharacterModelBase:SetUnit(unit, blend, useNativeForm) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_StopAnimKit) +function CharacterModelBase:StopAnimKit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CharacterModelBase_ZeroCachedCenterXY) +function CharacterModelBase:ZeroCachedCenterXY() end diff --git a/docs/annotations/Annotations/Core/Widget/Base/FrameScriptObject.lua b/docs/annotations/Annotations/Core/Widget/Base/FrameScriptObject.lua new file mode 100644 index 0000000..604bebd --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/FrameScriptObject.lua @@ -0,0 +1,50 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_FrameScriptObject) +---@class FrameScriptObject +local FrameScriptObject = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_GetName) +---@return string name +function FrameScriptObject:GetName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_GetObjectType) +---@return string objectType +function FrameScriptObject:GetObjectType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_HasAnySecretAspect) +---@return boolean hasSecretAspect +function FrameScriptObject:HasAnySecretAspect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_HasSecretAspect) +---@param aspect Enum.SecretAspect +---@return boolean hasSecretAspect +function FrameScriptObject:HasSecretAspect(aspect) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_HasSecretValues) +---@return boolean hasSecretValues +function FrameScriptObject:HasSecretValues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_IsForbidden) +---@return boolean isForbidden +function FrameScriptObject:IsForbidden() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_IsObjectType) +---@param objectType string +---@return boolean isType +function FrameScriptObject:IsObjectType(objectType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_IsPreventingSecretValues) +---@return boolean isPreventingSecretValues +function FrameScriptObject:IsPreventingSecretValues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_SetForbidden) +function FrameScriptObject:SetForbidden() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_SetPreventSecretValues) +---@param preventSecretValues boolean +function FrameScriptObject:SetPreventSecretValues(preventSecretValues) end + +---Reset all script accessible values to their default values. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_FrameScriptObject_SetToDefaults) +function FrameScriptObject:SetToDefaults() end diff --git a/docs/annotations/Annotations/Core/Widget/Base/ModelSceneActorBase.lua b/docs/annotations/Annotations/Core/Widget/Base/ModelSceneActorBase.lua new file mode 100644 index 0000000..9fb9eff --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/ModelSceneActorBase.lua @@ -0,0 +1,227 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ModelSceneActorBase) +---@class ModelSceneActorBase : Object +local ModelSceneActorBase = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_ClearModel) +function ModelSceneActorBase:ClearModel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetActiveBoundingBox) +---@return vector3 boxBottom +---@return vector3 boxTop +function ModelSceneActorBase:GetActiveBoundingBox() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetAlpha) +---@return number alpha +function ModelSceneActorBase:GetAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetAnimation) +---@return AnimationDataEnum animation +function ModelSceneActorBase:GetAnimation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetAnimationBlendOperation) +---@return Enum.ModelBlendOperation blendOp +function ModelSceneActorBase:GetAnimationBlendOperation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetAnimationVariation) +---@return number variation +function ModelSceneActorBase:GetAnimationVariation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetDesaturation) +---@return number strength +function ModelSceneActorBase:GetDesaturation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetMaxBoundingBox) +---@return vector3 boxBottom +---@return vector3 boxTop +function ModelSceneActorBase:GetMaxBoundingBox() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetModelFileID) +---@return fileID file +function ModelSceneActorBase:GetModelFileID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetModelPath) +---@return string path +function ModelSceneActorBase:GetModelPath() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetModelUnitGUID) +---@return WOWGUID guid +function ModelSceneActorBase:GetModelUnitGUID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetParticleOverrideScale) +---@return number? scale +function ModelSceneActorBase:GetParticleOverrideScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetPitch) +---@return number pitch +function ModelSceneActorBase:GetPitch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetPosition) +---@return number positionX +---@return number positionY +---@return number positionZ +function ModelSceneActorBase:GetPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetRoll) +---@return number roll +function ModelSceneActorBase:GetRoll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetScale) +---@return number scale +function ModelSceneActorBase:GetScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetSpellVisualKit) +---@return number spellVisualKitID +function ModelSceneActorBase:GetSpellVisualKit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_GetYaw) +---@return number yaw +function ModelSceneActorBase:GetYaw() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_Hide) +function ModelSceneActorBase:Hide() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_IsLoaded) +---@return boolean isLoaded +function ModelSceneActorBase:IsLoaded() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_IsPreferringModelCollisionBounds) +---@return boolean preferringCollisionBounds +function ModelSceneActorBase:IsPreferringModelCollisionBounds() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_IsShown) +---@return boolean isShown +function ModelSceneActorBase:IsShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_IsUsingCenterForOrigin) +---@return boolean x +---@return boolean y +---@return boolean z +function ModelSceneActorBase:IsUsingCenterForOrigin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_IsVisible) +---@return boolean isVisible +function ModelSceneActorBase:IsVisible() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_PlayAnimationKit) +---@param animationKit number +---@param isLooping? boolean Default = false +function ModelSceneActorBase:PlayAnimationKit(animationKit, isLooping) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetAlpha) +---@param alpha number +function ModelSceneActorBase:SetAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetAnimation) +---@param animation AnimationDataEnum +---@param variation? number +---@param animSpeed? number Default = 1 +---@param animOffsetSeconds? number Default = 0 +function ModelSceneActorBase:SetAnimation(animation, variation, animSpeed, animOffsetSeconds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetAnimationBlendOperation) +---@param blendOp number|Enum.ModelBlendOperation +function ModelSceneActorBase:SetAnimationBlendOperation(blendOp) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetDesaturation) +---@param strength number +function ModelSceneActorBase:SetDesaturation(strength) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetGradientMask) +---@param gradientIndex0 number +---@param gradientIndex1 number +---@param gradientIndex2 number +---@param gradientIndex3 number +function ModelSceneActorBase:SetGradientMask(gradientIndex0, gradientIndex1, gradientIndex2, gradientIndex3) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetModelByCreatureDisplayID) +---@param creatureDisplayID number +---@param useActivePlayerCustomizations? boolean Default = false +---@return boolean success +function ModelSceneActorBase:SetModelByCreatureDisplayID(creatureDisplayID, useActivePlayerCustomizations) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetModelByFileID) +---@param asset FileAsset +---@param useMips? boolean Default = false +---@return boolean success +function ModelSceneActorBase:SetModelByFileID(asset, useMips) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetModelByPath) +---@param asset FileAsset +---@param useMips? boolean Default = false +---@return boolean success +function ModelSceneActorBase:SetModelByPath(asset, useMips) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetModelByUnit) +---@param unit UnitToken +---@param sheatheWeapons? boolean Default = false +---@param autoDress? boolean Default = true +---@param hideWeapons? boolean Default = false +---@param usePlayerNativeForm? boolean Default = true +---@param holdBowString? boolean Default = false +---@param customRaceID? number +---@return boolean success +function ModelSceneActorBase:SetModelByUnit(unit, sheatheWeapons, autoDress, hideWeapons, usePlayerNativeForm, holdBowString, customRaceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetParticleOverrideScale) +---@param scale? number +function ModelSceneActorBase:SetParticleOverrideScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetPitch) +---@param pitch number +function ModelSceneActorBase:SetPitch(pitch) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetPlayerModelFromGlues) +---@param characterIndex? number +---@param sheatheWeapons? boolean Default = false +---@param autoDress? boolean Default = true +---@param hideWeapons? boolean Default = false +---@param usePlayerNativeForm? boolean Default = true +---@param customRaceID? number +---@return boolean success +function ModelSceneActorBase:SetPlayerModelFromGlues(characterIndex, sheatheWeapons, autoDress, hideWeapons, usePlayerNativeForm, customRaceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetPosition) +---@param positionX number +---@param positionY number +---@param positionZ number +function ModelSceneActorBase:SetPosition(positionX, positionY, positionZ) end + +---If true, will try to use the collision bounds of models for sizing and centering. Will fall back to default model bounds if set to False, or if collision bounds are unavailable. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetPreferModelCollisionBounds) +---@param preferCollisionBounds boolean +function ModelSceneActorBase:SetPreferModelCollisionBounds(preferCollisionBounds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetRoll) +---@param roll number +function ModelSceneActorBase:SetRoll(roll) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetScale) +---@param scale number +function ModelSceneActorBase:SetScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetShown) +---@param show? boolean Default = false +function ModelSceneActorBase:SetShown(show) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetSpellVisualKit) +---@param spellVisualKitID? number Default = 0 +---@param oneShot? boolean Default = false +function ModelSceneActorBase:SetSpellVisualKit(spellVisualKitID, oneShot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetUseCenterForOrigin) +---@param x? boolean Default = false +---@param y? boolean Default = false +---@param z? boolean Default = false +function ModelSceneActorBase:SetUseCenterForOrigin(x, y, z) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_SetYaw) +---@param yaw number +function ModelSceneActorBase:SetYaw(yaw) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_Show) +function ModelSceneActorBase:Show() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActorBase_StopAnimationKit) +function ModelSceneActorBase:StopAnimationKit() end diff --git a/docs/annotations/Annotations/Core/Widget/Base/Object.lua b/docs/annotations/Annotations/Core/Widget/Base/Object.lua new file mode 100644 index 0000000..3004dda --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/Object.lua @@ -0,0 +1,24 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Object) +---@class Object : FrameScriptObject +local Object = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_ClearParentKey) +function Object:ClearParentKey() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetDebugName) +---@param preferParentKey? boolean Default = false +---@return string debugName +function Object:GetDebugName(preferParentKey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParent) +---@return CScriptObject parent +function Object:GetParent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParentKey) +---@return string parentKey +function Object:GetParentKey() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_SetParentKey) +---@param parentKey string +function Object:SetParentKey(parentKey) end diff --git a/docs/annotations/Annotations/Core/Widget/Base/Region.lua b/docs/annotations/Annotations/Core/Widget/Base/Region.lua new file mode 100644 index 0000000..83456e6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/Region.lua @@ -0,0 +1,81 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Region) +---@class Region : ScriptRegion, ScriptRegionResizing, AnimatableObject +local Region = {} + +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_GetAlpha) +---@return SingleColorValue alpha +function Region:GetAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_GetDrawLayer) +---@return DrawLayer layer +---@return number sublayer +function Region:GetDrawLayer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_GetEffectiveScale) +---@return number effectiveScale +function Region:GetEffectiveScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_GetScale) +---@return number scale +function Region:GetScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_GetVertexColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function Region:GetVertexColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_IsIgnoringParentAlpha) +---@return boolean isIgnoring +function Region:IsIgnoringParentAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_IsIgnoringParentScale) +---@return boolean isIgnoring +function Region:IsIgnoringParentScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_IsObjectLoaded) +---@return boolean isLoaded +function Region:IsObjectLoaded() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetAlpha) +---@param alpha SingleColorValue +function Region:SetAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetAlphaFromBoolean) +---@param value boolean +---@param alphaIfTrue? SingleColorValue Default = 255 +---@param alphaIfFalse? SingleColorValue Default = 0 +function Region:SetAlphaFromBoolean(value, alphaIfTrue, alphaIfFalse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetDrawLayer) +---@param layer DrawLayer +---@param sublevel? number Default = 0 +function Region:SetDrawLayer(layer, sublevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetIgnoreParentAlpha) +---@param ignore boolean +function Region:SetIgnoreParentAlpha(ignore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetIgnoreParentScale) +---@param ignore boolean +function Region:SetIgnoreParentScale(ignore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetScale) +---@param scale number +function Region:SetScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetVertexColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function Region:SetVertexColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Region_SetVertexColorFromBoolean) +---@param value boolean +---@param colorIfTrue colorRGBA +---@param colorIfFalse colorRGBA +function Region:SetVertexColorFromBoolean(value, colorIfTrue, colorIfFalse) end diff --git a/docs/annotations/Annotations/Core/Widget/Base/ScriptRegion.lua b/docs/annotations/Annotations/Core/Widget/Base/ScriptRegion.lua new file mode 100644 index 0000000..4ac70a9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/ScriptRegion.lua @@ -0,0 +1,228 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ScriptRegion) +---@class ScriptRegion : Object +local ScriptRegion = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParent) +---@return Frame parent +function ScriptRegion:GetParent() end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_CanChangeProtectedState) +---@return boolean canChange +function ScriptRegion:CanChangeProtectedState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_CanPropagateMouseClicks) +---@return boolean canPropagate +function ScriptRegion:CanPropagateMouseClicks() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_CanPropagateMouseMotion) +---@return boolean canPropagate +function ScriptRegion:CanPropagateMouseMotion() end + +---Remove all script handlers set through Scripts in XML or SetScript in Lua +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_ClearScripts) +function ScriptRegion:ClearScripts() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_CollapsesLayout) +---@return boolean collapsesLayout +function ScriptRegion:CollapsesLayout() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_EnableMouse) +---@param enable? boolean Default = false +function ScriptRegion:EnableMouse(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_EnableMouseMotion) +---@param enable? boolean Default = false +function ScriptRegion:EnableMouseMotion(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_EnableMouseWheel) +---@param enable? boolean Default = false +function ScriptRegion:EnableMouseWheel(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetBottom) +---@return uiUnit bottom +function ScriptRegion:GetBottom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetCenter) +---@return uiUnit x +---@return uiUnit y +function ScriptRegion:GetCenter() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetHeight) +---@param ignoreRect? boolean Default = false +---@return uiUnit height +function ScriptRegion:GetHeight(ignoreRect) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetLeft) +---@return uiUnit left +function ScriptRegion:GetLeft() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetRect) +---@return uiUnit left +---@return uiUnit bottom +---@return uiUnit width +---@return uiUnit height +function ScriptRegion:GetRect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetRight) +---@return uiUnit right +function ScriptRegion:GetRight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetScaledRect) +---@return uiUnit left +---@return uiUnit bottom +---@return uiUnit width +---@return uiUnit height +function ScriptRegion:GetScaledRect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetScript) +---@param scriptTypeName ScriptType +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return luaFunction script +function ScriptRegion:GetScript(scriptTypeName, bindingType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetSize) +---@param ignoreRect? boolean Default = false +---@return uiUnit width +---@return uiUnit height +function ScriptRegion:GetSize(ignoreRect) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetSourceLocation) +---@return string location +function ScriptRegion:GetSourceLocation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetTop) +---@return uiUnit top +function ScriptRegion:GetTop() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_GetWidth) +---@param ignoreRect? boolean Default = false +---@return uiUnit width +function ScriptRegion:GetWidth(ignoreRect) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_HasScript) +---@param scriptName ScriptType +---@return boolean hasScript +function ScriptRegion:HasScript(scriptName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_Hide) +function ScriptRegion:Hide() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_HookScript) +---@param scriptTypeName ScriptType +---@param script luaFunction +---@param bindingType? LE_SCRIPT_BINDING_TYPE +function ScriptRegion:HookScript(scriptTypeName, script, bindingType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_Intersects) +---@param region ScriptRegion +---@return boolean intersects +function ScriptRegion:Intersects(region) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsAnchoringRestricted) +---@return boolean isRestricted +function ScriptRegion:IsAnchoringRestricted() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsAnchoringSecret) +---@return boolean isSecret +function ScriptRegion:IsAnchoringSecret() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsCollapsed) +---@return boolean isCollapsed +function ScriptRegion:IsCollapsed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsDragging) +---@return boolean isDragging +function ScriptRegion:IsDragging() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsMouseClickEnabled) +---@return boolean enabled +function ScriptRegion:IsMouseClickEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsMouseEnabled) +---@return boolean enabled +function ScriptRegion:IsMouseEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsMouseMotionEnabled) +---@return boolean enabled +function ScriptRegion:IsMouseMotionEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsMouseMotionFocus) +---@return boolean isMouseMotionFocus +function ScriptRegion:IsMouseMotionFocus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsMouseOver) +---@param offsetTop? uiUnit Default = 0 +---@param offsetBottom? uiUnit Default = 0 +---@param offsetLeft? uiUnit Default = 0 +---@param offsetRight? uiUnit Default = 0 +---@return boolean isMouseOver +function ScriptRegion:IsMouseOver(offsetTop, offsetBottom, offsetLeft, offsetRight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsMouseWheelEnabled) +---@return boolean enabled +function ScriptRegion:IsMouseWheelEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsProtected) +---@return boolean isProtected +---@return boolean isProtectedExplicitly +function ScriptRegion:IsProtected() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsRectValid) +---@return boolean isValid +function ScriptRegion:IsRectValid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsShown) +---@return boolean isShown +function ScriptRegion:IsShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_IsVisible) +---@return boolean isVisible +function ScriptRegion:IsVisible() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetCollapsesLayout) +---@param collapsesLayout boolean +function ScriptRegion:SetCollapsesLayout(collapsesLayout) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetMouseClickEnabled) +---@param enabled? boolean Default = false +function ScriptRegion:SetMouseClickEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetMouseMotionEnabled) +---@param enabled? boolean Default = false +function ScriptRegion:SetMouseMotionEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetParent) +---@param parent? SimpleFrame +function ScriptRegion:SetParent(parent) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetPassThroughButtons) +---@param ... MouseButton buttons +function ScriptRegion:SetPassThroughButtons(...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetPropagateMouseClicks) +---@param propagate boolean +function ScriptRegion:SetPropagateMouseClicks(propagate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetPropagateMouseMotion) +---@param propagate boolean +function ScriptRegion:SetPropagateMouseMotion(propagate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetScript) +---@param scriptTypeName ScriptType +---@param script? luaFunction +function ScriptRegion:SetScript(scriptTypeName, script) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_SetShown) +---@param show? boolean Default = false +function ScriptRegion:SetShown(show) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_ShouldButtonPassThrough) +---@param button MouseButton +---@return boolean shouldPassThrough +function ScriptRegion:ShouldButtonPassThrough(button) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegion_Show) +function ScriptRegion:Show() end diff --git a/docs/annotations/Annotations/Core/Widget/Base/ScriptRegionResizing.lua b/docs/annotations/Annotations/Core/Widget/Base/ScriptRegionResizing.lua new file mode 100644 index 0000000..7fdc9c9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/ScriptRegionResizing.lua @@ -0,0 +1,77 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ScriptRegion) +---@class ScriptRegionResizing : Object +local ScriptRegionResizing = {} + +---@param x uiUnit +---@param y uiUnit +function ScriptRegionResizing:AdjustPointsOffset(x, y) end + +---Clears all points and immediately invalidates the rect. (Prior to 11.2.0, this would only invalidate rect immediately for AnchoringRestricted regions.) +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_ClearAllPoints) +function ScriptRegionResizing:ClearAllPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_ClearPoint) +---@param point FramePoint +function ScriptRegionResizing:ClearPoint(point) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_ClearPointsOffset) +function ScriptRegionResizing:ClearPointsOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_GetNumPoints) +---@return number numPoints +function ScriptRegionResizing:GetNumPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_GetPoint) +---@param anchorIndex? number Default = 0 +---@param resolveCollapsed? boolean Default = false +---@return FramePoint point +---@return ScriptRegion relativeTo +---@return FramePoint relativePoint +---@return uiUnit offsetX +---@return uiUnit offsetY +function ScriptRegionResizing:GetPoint(anchorIndex, resolveCollapsed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_GetPointByName) +---@param point FramePoint +---@param resolveCollapsed? boolean Default = false +---@return FramePoint point +---@return ScriptRegion relativeTo +---@return FramePoint relativePoint +---@return uiUnit offsetX +---@return uiUnit offsetY +function ScriptRegionResizing:GetPointByName(point, resolveCollapsed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_SetAllPoints) +---@param relativeTo? ScriptRegion +---@param doResize? boolean Default = true +function ScriptRegionResizing:SetAllPoints(relativeTo, doResize) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_SetHeight) +---@param height uiUnit +function ScriptRegionResizing:SetHeight(height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_SetPoint) +---@param point FramePoint +---@param relativeTo? any +---@param relativePoint? FramePoint +---@param offsetX? uiUnit +---@param offsetY? uiUnit +---@overload fun(self, point: FramePoint, relativeTo?: any, ofsx?: number, ofsy?: number) +---@overload fun(self, point: FramePoint, ofsx?: number, ofsy?: number) +function ScriptRegionResizing:SetPoint(point, relativeTo, relativePoint, offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_SetPointsOffset) +---@param x uiUnit +---@param y uiUnit +function ScriptRegionResizing:SetPointsOffset(x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_SetSize) +---@param x uiUnit +---@param y uiUnit +function ScriptRegionResizing:SetSize(x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptRegionResizing_SetWidth) +---@param width uiUnit +function ScriptRegionResizing:SetWidth(width) end diff --git a/docs/annotations/Annotations/Core/Widget/Base/TabardModelBase.lua b/docs/annotations/Annotations/Core/Widget/Base/TabardModelBase.lua new file mode 100644 index 0000000..3330713 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/TabardModelBase.lua @@ -0,0 +1,30 @@ +---@meta _ +---@class TabardModelBase : PlayerModel +local TabardModelBase = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_CanSaveTabardNow) +---@return boolean canSave +function TabardModelBase:CanSaveTabardNow() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_CycleVariation) +---@param variationIndex number +---@param delta number +function TabardModelBase:CycleVariation(variationIndex, delta) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_GetLowerEmblemTexture) +---@param texture SimpleTexture +function TabardModelBase:GetLowerEmblemTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_GetUpperEmblemTexture) +---@param texture SimpleTexture +function TabardModelBase:GetUpperEmblemTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_InitializeTabardColors) +function TabardModelBase:InitializeTabardColors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_IsGuildTabard) +---@return boolean isGuildTabard +function TabardModelBase:IsGuildTabard() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModelBase_Save) +function TabardModelBase:Save() end diff --git a/docs/annotations/Annotations/Core/Widget/Base/TextureBase.lua b/docs/annotations/Annotations/Core/Widget/Base/TextureBase.lua new file mode 100644 index 0000000..e637add --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Base/TextureBase.lua @@ -0,0 +1,204 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_TextureBase) +---@class TextureBase : Region +local TextureBase = {} + +---Disable shader based nineslice texture rendering. Since SetAtlas will automatically load slice data for the atlas from the DB, can be useful if you want to disable nineslice after setting an atlas. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_ClearTextureSlice) +function TextureBase:ClearTextureSlice() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_ClearVertexOffsets) +function TextureBase:ClearVertexOffsets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetAtlas) +---@return textureAtlas atlas +function TextureBase:GetAtlas() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetBlendMode) +---@return BlendMode blendMode +function TextureBase:GetBlendMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetDesaturation) +---@return normalizedValue desaturation +function TextureBase:GetDesaturation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetHorizTile) +---@return boolean tiling +function TextureBase:GetHorizTile() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetRotation) +---@return number radians +---@return vector2 normalizedRotationPoint +function TextureBase:GetRotation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTexCoord) +---@return number ulX +---@return number ulY +---@return number llX +---@return number llY +---@return number urX +---@return number urY +---@return number lrX +---@return number lrY +function TextureBase:GetTexCoord() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTexelSnappingBias) +---@return normalizedValue bias +function TextureBase:GetTexelSnappingBias() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTexture) +---@return string? textureFile +function TextureBase:GetTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTextureFileID) +---@return fileID textureFile +function TextureBase:GetTextureFileID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTextureFilePath) +---@return string? textureFile +function TextureBase:GetTextureFilePath() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTextureSliceMargins) +---@return number left +---@return number top +---@return number right +---@return number bottom +function TextureBase:GetTextureSliceMargins() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetTextureSliceMode) +---@return Enum.UITextureSliceMode sliceMode +function TextureBase:GetTextureSliceMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetVertTile) +---@return boolean tiling +function TextureBase:GetVertTile() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_GetVertexOffset) +---@param vertexIndex number +---@return uiUnit offsetX +---@return uiUnit offsetY +function TextureBase:GetVertexOffset(vertexIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_IsBlockingLoadRequested) +---@return boolean blocking +function TextureBase:IsBlockingLoadRequested() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_IsDesaturated) +---@return boolean desaturated +function TextureBase:IsDesaturated() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_IsSnappingToPixelGrid) +---@return boolean snap +function TextureBase:IsSnappingToPixelGrid() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_ResetTexCoord) +function TextureBase:ResetTexCoord() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetAtlas) +---@param atlas textureAtlas +---@param useAtlasSize? boolean Default = false +---@param filterMode? FilterMode +---@param resetTexCoords? boolean +---@param wrapModeHorizontal? string +---@param wrapModeVertical? string +function TextureBase:SetAtlas(atlas, useAtlasSize, filterMode, resetTexCoords, wrapModeHorizontal, wrapModeVertical) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetBlendMode) +---@param blendMode BlendMode +function TextureBase:SetBlendMode(blendMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetBlockingLoadsRequested) +---@param blocking? boolean Default = false +function TextureBase:SetBlockingLoadsRequested(blocking) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetColorTexture) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function TextureBase:SetColorTexture(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetDesaturated) +---@param desaturated? boolean Default = false +function TextureBase:SetDesaturated(desaturated) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetDesaturation) +---@param desaturation normalizedValue +function TextureBase:SetDesaturation(desaturation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetGradient) +---@param orientation Orientation +---@param minColor colorRGBA +---@param maxColor colorRGBA +function TextureBase:SetGradient(orientation, minColor, maxColor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetHorizTile) +---@param tiling? boolean Default = false +function TextureBase:SetHorizTile(tiling) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetMask) +---@param file string +function TextureBase:SetMask(file) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetRotation) +---@param radians number +---@param normalizedRotationPoint? vector2 +function TextureBase:SetRotation(radians, normalizedRotationPoint) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetSnapToPixelGrid) +---@param snap? boolean Default = false +function TextureBase:SetSnapToPixelGrid(snap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetSpriteSheetCell) +---@param cell number +---@param numRows number +---@param numColumns number +---@param cellWidth? number +---@param cellHeight? number +function TextureBase:SetSpriteSheetCell(cell, numRows, numColumns, cellWidth, cellHeight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetTexCoord) +---@param left number +---@param right number +---@param top number +---@param bottom number +---@overload fun(self, ulX:number, ulY:number, llX:number, llY:number, urX:number, urY:number, lrX:number, lrY:number) +function TextureBase:SetTexCoord(left, right, top, bottom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetTexelSnappingBias) +---@param bias normalizedValue +function TextureBase:SetTexelSnappingBias(bias) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetTexture) +---@param textureAsset? string|number +---@param wrapModeHorizontal? WrapMode +---@param wrapModeVertical? WrapMode +---@param filterMode? FilterMode +---@return boolean success +function TextureBase:SetTexture(textureAsset, wrapModeHorizontal, wrapModeVertical, filterMode) end + +---Enables nineslice texture rendering using the specified pixel margins. Preferred over legacy nineslice approach that uses 9 separate textures. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetTextureSliceMargins) +---@param left number +---@param top number +---@param right number +---@param bottom number +function TextureBase:SetTextureSliceMargins(left, top, right, bottom) end + +---Controls whether the center and sides are Stretched or Tiled when using nineslice texture rendering. Defaults to Stretched. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetTextureSliceMode) +---@param sliceMode Enum.UITextureSliceMode +function TextureBase:SetTextureSliceMode(sliceMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetVertTile) +---@param tiling? boolean Default = false +function TextureBase:SetVertTile(tiling) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TextureBase_SetVertexOffset) +---@param vertexIndex number +---@param offsetX uiUnit +---@param offsetY uiUnit +function TextureBase:SetVertexOffset(vertexIndex, offsetX, offsetY) end diff --git a/docs/annotations/Annotations/Core/Widget/Font/Font.lua b/docs/annotations/Annotations/Core/Widget/Font/Font.lua new file mode 100644 index 0000000..1fbbb8b --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Font/Font.lua @@ -0,0 +1,123 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Font) +---@class Font : FrameScriptObject +local Font = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_CopyFontObject) +---@param sourceFont SimpleFont|FontObject +function Font:CopyFontObject(sourceFont) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetAlpha) +---@return SingleColorValue alpha +function Font:GetAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetFont) +---@return string fontFile +---@return uiFontHeight height +---@return TBFFlags flags +function Font:GetFont() end + +---Return is either in uiUnits or internal height due to fixedHeight. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetFontHeight) +---@return number height +function Font:GetFontHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetFontObject) +---@return SimpleFont font +function Font:GetFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetFontObjectForAlphabet) +---@param alphabet FontAlphabet +---@return SimpleFont font +function Font:GetFontObjectForAlphabet(alphabet) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetIndentedWordWrap) +---@return boolean wordWrap +function Font:GetIndentedWordWrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetJustifyH) +---@return JustifyHorizontal justifyH +function Font:GetJustifyH() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetJustifyV) +---@return JustifyVertical justifyV +function Font:GetJustifyV() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetShadowColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function Font:GetShadowColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetShadowOffset) +---@return number offsetX +---@return number offsetY +function Font:GetShadowOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetSpacing) +---@return uiUnit spacing +function Font:GetSpacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_GetTextColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function Font:GetTextColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetAlpha) +---@param alpha SingleColorValue +function Font:SetAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetFont) +---@param fontFile FontFile +---@param height uiFontHeight +---@param flags TBFFlags +function Font:SetFont(fontFile, height, flags) end + +---Preserves all flags, does correct height conversion due to fixedHeight. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetFontHeight) +---@param height number +function Font:SetFontHeight(height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetFontObject) +---@param font FontObject|nil +function Font:SetFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetIndentedWordWrap) +---@param wordWrap boolean +function Font:SetIndentedWordWrap(wordWrap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetJustifyH) +---@param justifyH JustifyHorizontal +function Font:SetJustifyH(justifyH) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetJustifyV) +---@param justifyV JustifyVertical +function Font:SetJustifyV(justifyV) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetShadowColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function Font:SetShadowColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetShadowOffset) +---@param offsetX number +---@param offsetY number +function Font:SetShadowOffset(offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetSpacing) +---@param spacing uiUnit +function Font:SetSpacing(spacing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Font_SetTextColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function Font:SetTextColor(colorR, colorG, colorB, a) end diff --git a/docs/annotations/Annotations/Core/Widget/Font/FontString.lua b/docs/annotations/Annotations/Core/Widget/Font/FontString.lua new file mode 100644 index 0000000..b49a4c6 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Font/FontString.lua @@ -0,0 +1,245 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_FontString) +---@class FontString : Region +local FontString = {} +---@class fontstring : FontString +---@class FONTSTRING : FontString + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_CalculateScreenAreaFromCharacterSpan) +---@param leftIndex number +---@param rightIndex number +---@return uiBoundsRect[]? areas +function FontString:CalculateScreenAreaFromCharacterSpan(leftIndex, rightIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_CanNonSpaceWrap) +---@return boolean wrap +function FontString:CanNonSpaceWrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_CanWordWrap) +---@return boolean wrap +function FontString:CanWordWrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_ClearAlphaGradient) +function FontString:ClearAlphaGradient() end + +---Sets text to an empty string and removes the Text secret aspect. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_ClearText) +function FontString:ClearText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_FindCharacterIndexAtCoordinate) +---@param x uiUnit +---@param y uiUnit +---@return number characterIndex +---@return boolean inside +function FontString:FindCharacterIndexAtCoordinate(x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetAlphaGradient) +---@return number start +---@return number length +function FontString:GetAlphaGradient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetFieldSize) +---@return number fieldSize +function FontString:GetFieldSize() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetFont) +---@return string? fontFile +---@return uiUnit fontHeight +---@return TBFFlags flags +function FontString:GetFont() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetFontHeight) +---@param calculated? boolean Default = true +---@return uiUnit height +function FontString:GetFontHeight(calculated) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetFontObject) +---@return SimpleFont font +function FontString:GetFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetIndentedWordWrap) +---@return boolean wrap +function FontString:GetIndentedWordWrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetJustifyH) +---@return JustifyHorizontal justifyH +function FontString:GetJustifyH() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetJustifyV) +---@return JustifyVertical justifyV +function FontString:GetJustifyV() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetLineHeight) +---@return uiUnit lineHeight +function FontString:GetLineHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetMaxLines) +---@return number maxLines +function FontString:GetMaxLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetNumLines) +---@return number numLines +function FontString:GetNumLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetRotation) +---@return number radians +function FontString:GetRotation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetScaleAnimationMode) +---@return Enum.FontStringScaleAnimationMode scaleAnimationMode +function FontString:GetScaleAnimationMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetShadowColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function FontString:GetShadowColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetShadowOffset) +---@return number offsetX +---@return number offsetY +function FontString:GetShadowOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetSpacing) +---@return uiUnit spacing +function FontString:GetSpacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetStringHeight) +---@return uiUnit height +function FontString:GetStringHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetStringWidth) +---@return uiUnit width +function FontString:GetStringWidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetText) +---@return string text +function FontString:GetText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetTextColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function FontString:GetTextColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetTextScale) +---@return number textScale +function FontString:GetTextScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetUnboundedStringWidth) +---@return uiUnit width +function FontString:GetUnboundedStringWidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_GetWrappedWidth) +---@return uiUnit width +function FontString:GetWrappedWidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_IsTruncated) +---@return boolean isTruncated +function FontString:IsTruncated() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_OnColorsUpdated) +function FontString:OnColorsUpdated() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetAlphaGradient) +---@param start number +---@param length number +---@return boolean isWithinText +function FontString:SetAlphaGradient(start, length) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetFixedColor) +---@param fixedColor boolean +function FontString:SetFixedColor(fixedColor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetFont) +---@param fontFile FontFile +---@param fontHeight uiUnit +---@param flags? TBFFlags +function FontString:SetFont(fontFile, fontHeight, flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetFontHeight) +---@param height uiUnit +function FontString:SetFontHeight(height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetFontObject) +---@param font FontObject|nil +function FontString:SetFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetFormattedText) +---@param text string +---@param ... string|number +function FontString:SetFormattedText(text, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetIndentedWordWrap) +---@param wrap boolean +function FontString:SetIndentedWordWrap(wrap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetJustifyH) +---@param justifyH JustifyHorizontal +function FontString:SetJustifyH(justifyH) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetJustifyV) +---@param justifyV JustifyVertical +function FontString:SetJustifyV(justifyV) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetMaxLines) +---@param maxLines number +function FontString:SetMaxLines(maxLines) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetNonSpaceWrap) +---@param wrap boolean +function FontString:SetNonSpaceWrap(wrap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetRotation) +---@param radians number +function FontString:SetRotation(radians) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetScaleAnimationMode) +---@param scaleAnimationMode Enum.FontStringScaleAnimationMode +function FontString:SetScaleAnimationMode(scaleAnimationMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetShadowColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function FontString:SetShadowColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetShadowOffset) +---@param offsetX number +---@param offsetY number +function FontString:SetShadowOffset(offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetSpacing) +---@param spacing uiUnit +function FontString:SetSpacing(spacing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetText) +---@param text? string Default = +function FontString:SetText(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetTextColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function FontString:SetTextColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetTextHeight) +---@param height uiUnit +function FontString:SetTextHeight(height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetTextScale) +---@param textScale number +function FontString:SetTextScale(textScale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetTextToFit) +---@param text? string Default = +function FontString:SetTextToFit(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FontString_SetWordWrap) +---@param wrap boolean +function FontString:SetWordWrap(wrap) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Button/Button.lua b/docs/annotations/Annotations/Core/Widget/Frame/Button/Button.lua new file mode 100644 index 0000000..acba347 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Button/Button.lua @@ -0,0 +1,199 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Button) +---@class Button : Frame +local Button = {} +---@class button : Button +---@class BUTTON : Button + +---@param scriptType ScriptButton +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function Button:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptButton +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function Button:HasScript(scriptType) end + +---@param scriptType ScriptButton +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function Button:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptButton +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function Button:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_ClearDisabledTexture) +function Button:ClearDisabledTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_ClearHighlightTexture) +function Button:ClearHighlightTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_ClearNormalTexture) +function Button:ClearNormalTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_ClearPushedTexture) +function Button:ClearPushedTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_Click) +---@param button? string Default = LeftButton +---@param isDown? boolean Default = false +function Button:Click(button, isDown) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_Disable) +function Button:Disable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_Enable) +function Button:Enable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetButtonState) +---@return SimpleButtonStateToken buttonState +function Button:GetButtonState() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetDisabledFontObject) +---@return SimpleFont font +function Button:GetDisabledFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetDisabledTexture) +---@return SimpleTexture texture +function Button:GetDisabledTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetFontString) +---@return SimpleFontString fontString +function Button:GetFontString() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetHighlightFontObject) +---@return SimpleFont font +function Button:GetHighlightFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetHighlightTexture) +---@return SimpleTexture texture +function Button:GetHighlightTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetMotionScriptsWhileDisabled) +---@return boolean motionScriptsWhileDisabled +function Button:GetMotionScriptsWhileDisabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetNormalFontObject) +---@return SimpleFont font +function Button:GetNormalFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetNormalTexture) +---@return SimpleTexture texture +function Button:GetNormalTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetPushedTextOffset) +---@return uiUnit offsetX +---@return uiUnit offsetY +function Button:GetPushedTextOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetPushedTexture) +---@return SimpleTexture texture +function Button:GetPushedTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetText) +---@return string text +function Button:GetText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetTextHeight) +---@return uiUnit height +function Button:GetTextHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_GetTextWidth) +---@return uiUnit width +function Button:GetTextWidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_IsEnabled) +---@return boolean isEnabled +function Button:IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_RegisterForClicks) +---@param ... ClickButton buttons +function Button:RegisterForClicks(...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_RegisterForMouse) +---@param ... ClickButton buttons +function Button:RegisterForMouse(...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetButtonState) +---@param buttonState SimpleButtonStateToken +---@param lock? boolean Default = false +function Button:SetButtonState(buttonState, lock) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetDisabledAtlas) +---@param atlas textureAtlas +function Button:SetDisabledAtlas(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetDisabledFontObject) +---@param font SimpleFont|FontObject +function Button:SetDisabledFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetDisabledTexture) +---@param asset TextureAsset +function Button:SetDisabledTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetEnabled) +---@param enabled? boolean Default = false +function Button:SetEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetFontString) +---@param fontString SimpleFontString +function Button:SetFontString(fontString) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetFormattedText) +---@param text string +---@param ... string|number +function Button:SetFormattedText(text, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetHighlightAtlas) +---@param atlas textureAtlas +---@param blendMode? BlendMode +function Button:SetHighlightAtlas(atlas, blendMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetHighlightFontObject) +---@param font SimpleFont|FontObject +function Button:SetHighlightFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetHighlightTexture) +---@param asset TextureAsset +---@param blendMode? BlendMode +function Button:SetHighlightTexture(asset, blendMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetMotionScriptsWhileDisabled) +---@param motionScriptsWhileDisabled boolean +function Button:SetMotionScriptsWhileDisabled(motionScriptsWhileDisabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetNormalAtlas) +---@param atlas textureAtlas +function Button:SetNormalAtlas(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetNormalFontObject) +---@param font SimpleFont|FontObject +function Button:SetNormalFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetNormalTexture) +---@param asset TextureAsset +function Button:SetNormalTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetPushedAtlas) +---@param atlas textureAtlas +function Button:SetPushedAtlas(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetPushedTextOffset) +---@param offsetX uiUnit +---@param offsetY uiUnit +function Button:SetPushedTextOffset(offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetPushedTexture) +---@param asset TextureAsset +function Button:SetPushedTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Button_SetText) +---@param text? string Default = +function Button:SetText(text) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Button/CheckButton.lua b/docs/annotations/Annotations/Core/Widget/Frame/Button/CheckButton.lua new file mode 100644 index 0000000..cab86e3 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Button/CheckButton.lua @@ -0,0 +1,30 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_CheckButton) +---@class CheckButton : Button +local CheckButton = {} +---@class checkbutton : CheckButton +---@class CHECKBUTTON : CheckButton + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckButton_GetChecked) +---@return boolean checked +function CheckButton:GetChecked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckButton_GetCheckedTexture) +---@return SimpleTexture texture +function CheckButton:GetCheckedTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckButton_GetDisabledCheckedTexture) +---@return SimpleTexture texture +function CheckButton:GetDisabledCheckedTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckButton_SetChecked) +---@param checked? boolean Default = false +function CheckButton:SetChecked(checked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckButton_SetCheckedTexture) +---@param asset TextureAsset +function CheckButton:SetCheckedTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CheckButton_SetDisabledCheckedTexture) +---@param asset TextureAsset +function CheckButton:SetDisabledCheckedTexture(asset) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/ColorSelect.lua b/docs/annotations/Annotations/Core/Widget/Frame/ColorSelect.lua new file mode 100644 index 0000000..e8c0a6a --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/ColorSelect.lua @@ -0,0 +1,113 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ColorSelect) +---@class ColorSelect : Frame +local ColorSelect = {} +---@class colorselect : ColorSelect +---@class COLORSELECT : ColorSelect + +---@param scriptType ScriptColorSelect +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function ColorSelect:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptColorSelect +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function ColorSelect:HasScript(scriptType) end + +---@param scriptType ScriptColorSelect +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function ColorSelect:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptColorSelect +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function ColorSelect:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_ClearColorWheelTexture) +function ColorSelect:ClearColorWheelTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorAlpha) +---@return number alpha +function ColorSelect:GetColorAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorAlphaTexture) +---@return SimpleTexture texture +function ColorSelect:GetColorAlphaTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorAlphaThumbTexture) +---@return SimpleTexture texture +function ColorSelect:GetColorAlphaThumbTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorHSV) +---@return number hsvX +---@return number hsvY +---@return number hsvZ +function ColorSelect:GetColorHSV() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorRGB) +---@return number rgbR +---@return number rgbG +---@return number rgbB +function ColorSelect:GetColorRGB() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorValueTexture) +---@return SimpleTexture texture +function ColorSelect:GetColorValueTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorValueThumbTexture) +---@return SimpleTexture texture +function ColorSelect:GetColorValueThumbTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorWheelTexture) +---@return SimpleTexture texture +function ColorSelect:GetColorWheelTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_GetColorWheelThumbTexture) +---@return SimpleTexture texture +function ColorSelect:GetColorWheelThumbTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorAlpha) +---@param alpha number +function ColorSelect:SetColorAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorAlphaTexture) +---@param texture SimpleTexture +function ColorSelect:SetColorAlphaTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorAlphaThumbTexture) +---@param texture TextureAsset +function ColorSelect:SetColorAlphaThumbTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorHSV) +---@param hsvX number +---@param hsvY number +---@param hsvZ number +function ColorSelect:SetColorHSV(hsvX, hsvY, hsvZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorRGB) +---@param rgbR number +---@param rgbG number +---@param rgbB number +function ColorSelect:SetColorRGB(rgbR, rgbG, rgbB) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorValueTexture) +---@param texture SimpleTexture +function ColorSelect:SetColorValueTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorValueThumbTexture) +---@param texture TextureAsset +function ColorSelect:SetColorValueThumbTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorWheelTexture) +---@param texture SimpleTexture +function ColorSelect:SetColorWheelTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ColorSelect_SetColorWheelThumbTexture) +---@param texture TextureAsset +function ColorSelect:SetColorWheelThumbTexture(texture) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Cooldown.lua b/docs/annotations/Annotations/Core/Widget/Frame/Cooldown.lua new file mode 100644 index 0000000..c7cdc6a --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Cooldown.lua @@ -0,0 +1,227 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Cooldown) +---@class Cooldown : Frame +local Cooldown = {} +---@class cooldown : Cooldown +---@class COOLDOWN : Cooldown + +---@param scriptType ScriptCooldown +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function Cooldown:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptCooldown +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function Cooldown:HasScript(scriptType) end + +---@param scriptType ScriptCooldown +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function Cooldown:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptCooldown +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function Cooldown:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_Clear) +function Cooldown:Clear() end + +---The returned duration unit is milliseconds, unaffected by modRate. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetCooldownDisplayDuration) +---@return number duration +function Cooldown:GetCooldownDisplayDuration() end + +---The returned duration unit is milliseconds and is multiplied by the modRate. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetCooldownDuration) +---@return number duration +function Cooldown:GetCooldownDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetCooldownTimes) +---@return number start +---@return number duration +function Cooldown:GetCooldownTimes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetCountdownFontString) +---@return SimpleFontString countdownString +function Cooldown:GetCountdownFontString() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetDrawBling) +---@return boolean drawBling +function Cooldown:GetDrawBling() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetDrawEdge) +---@return boolean drawEdge +function Cooldown:GetDrawEdge() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetDrawSwipe) +---@return boolean drawSwipe +function Cooldown:GetDrawSwipe() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetEdgeScale) +---@return number edgeScale +function Cooldown:GetEdgeScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetHideCountdownNumbers) +---@return boolean hideNumbers +function Cooldown:GetHideCountdownNumbers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetMinimumCountdownDuration) +---@return number milliseconds +function Cooldown:GetMinimumCountdownDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetReverse) +---@return boolean reverse +function Cooldown:GetReverse() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetRotation) +---@return number rotationRadians +function Cooldown:GetRotation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_GetUseAuraDisplayTime) +---@return boolean useAuraDisplayTime +function Cooldown:GetUseAuraDisplayTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_IsPaused) +---@return boolean isPaused +function Cooldown:IsPaused() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_Pause) +function Cooldown:Pause() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_Resume) +function Cooldown:Resume() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetBlingTexture) +---@param texture FileAsset +---@param colorR number +---@param colorG number +---@param colorB number +---@param colorA number +function Cooldown:SetBlingTexture(texture, colorR, colorG, colorB, colorA) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCooldown) +---@param start number +---@param duration number +---@param modRate? number Default = 1 +function Cooldown:SetCooldown(start, duration, modRate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCooldownDuration) +---@param duration number +---@param modRate? number Default = 1 +function Cooldown:SetCooldownDuration(duration, modRate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCooldownFromDurationObject) +---@param duration LuaDurationObject +---@param clearIfZero? boolean Default = true +function Cooldown:SetCooldownFromDurationObject(duration, clearIfZero) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCooldownFromExpirationTime) +---@param expirationTime DurationSeconds +---@param duration DurationSeconds +---@param modRate? number Default = 1 +function Cooldown:SetCooldownFromExpirationTime(expirationTime, duration, modRate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCooldownUNIX) +---@param start number +---@param duration number +---@param modRate? number Default = 1 +function Cooldown:SetCooldownUNIX(start, duration, modRate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCountdownAbbrevThreshold) +---@param seconds number +function Cooldown:SetCountdownAbbrevThreshold(seconds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetCountdownFont) +---@param fontName string +function Cooldown:SetCountdownFont(fontName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetDrawBling) +---@param drawBling? boolean Default = false +function Cooldown:SetDrawBling(drawBling) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetDrawEdge) +---@param drawEdge? boolean Default = false +function Cooldown:SetDrawEdge(drawEdge) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetDrawSwipe) +---@param drawSwipe? boolean Default = false +function Cooldown:SetDrawSwipe(drawSwipe) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetEdgeColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function Cooldown:SetEdgeColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetEdgeScale) +---@param scale number +function Cooldown:SetEdgeScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetEdgeTexture) +---@param texture FileAsset +---@param colorR number +---@param colorG number +---@param colorB number +---@param colorA number +function Cooldown:SetEdgeTexture(texture, colorR, colorG, colorB, colorA) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetHideCountdownNumbers) +---@param hideNumbers? boolean Default = false +function Cooldown:SetHideCountdownNumbers(hideNumbers) end + +---Controls the minimum duration above which countdown text will be shown. This is applied based upon the total duration of the cooldown, not the remaining duration as it ticks down. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetMinimumCountdownDuration) +---@param milliseconds number +function Cooldown:SetMinimumCountdownDuration(milliseconds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetPaused) +---@param paused boolean +function Cooldown:SetPaused(paused) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetReverse) +---@param reverse? boolean Default = false +function Cooldown:SetReverse(reverse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetRotation) +---@param rotationRadians number +function Cooldown:SetRotation(rotationRadians) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetSwipeColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function Cooldown:SetSwipeColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetSwipeTexture) +---@param texture FileAsset +---@param colorR number +---@param colorG number +---@param colorB number +---@param colorA number +function Cooldown:SetSwipeTexture(texture, colorR, colorG, colorB, colorA) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetTexCoordRange) +---@param low vector2 +---@param high vector2 +function Cooldown:SetTexCoordRange(low, high) end + +---Aura durations are displayed slightly differently than cooldown durations. Setting this to true will adjust the display logic to stay in sync with aura timers. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetUseAuraDisplayTime) +---@param useAuraDisplayTime? boolean Default = false +function Cooldown:SetUseAuraDisplayTime(useAuraDisplayTime) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Cooldown_SetUseCircularEdge) +---@param useCircularEdge? boolean Default = false +function Cooldown:SetUseCircularEdge(useCircularEdge) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/EditBox.lua b/docs/annotations/Annotations/Core/Widget/Frame/EditBox.lua new file mode 100644 index 0000000..b4febec --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/EditBox.lua @@ -0,0 +1,368 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_EditBox) +---@class EditBox : Frame +local EditBox = {} +---@class editbox : EditBox +---@class EDITBOX : EditBox + +---@param scriptType ScriptEditBox +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function EditBox:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptEditBox +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function EditBox:HasScript(scriptType) end + +---@param scriptType ScriptEditBox +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function EditBox:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptEditBox +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function EditBox:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_AddHistoryLine) +---@param text string +function EditBox:AddHistoryLine(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_ClearFocus) +function EditBox:ClearFocus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_ClearHighlightText) +function EditBox:ClearHighlightText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_ClearHistory) +function EditBox:ClearHistory() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_Disable) +function EditBox:Disable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_Enable) +function EditBox:Enable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetAltArrowKeyMode) +---@return boolean altMode +function EditBox:GetAltArrowKeyMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetBlinkSpeed) +---@return number cursorBlinkSpeedSec +function EditBox:GetBlinkSpeed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetCursorPosition) +---@return number cursorPosition +function EditBox:GetCursorPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetDisplayText) +---@return string displayText +function EditBox:GetDisplayText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetFont) +---@return string name +---@return uiUnit fontHeight +---@return TBFFlags flags +function EditBox:GetFont() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetFontObject) +---@return SimpleFont font +function EditBox:GetFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetHighlightColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function EditBox:GetHighlightColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetHistoryLines) +---@return number numHistoryLines +function EditBox:GetHistoryLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetIndentedWordWrap) +---@return boolean isIndented +function EditBox:GetIndentedWordWrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetInputLanguage) +---@return string language +function EditBox:GetInputLanguage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetJustifyH) +---@return JustifyHorizontal justifyH +function EditBox:GetJustifyH() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetJustifyV) +---@return JustifyVertical justifyV +function EditBox:GetJustifyV() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetMaxBytes) +---@return number maxBytes +function EditBox:GetMaxBytes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetMaxLetters) +---@return number maxLetters +function EditBox:GetMaxLetters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetNumLetters) +---@return number numLetters +function EditBox:GetNumLetters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetNumLines) +---@return number lines +function EditBox:GetNumLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetNumber) +---@return number? number +function EditBox:GetNumber() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetShadowColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function EditBox:GetShadowColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetShadowOffset) +---@return number offsetX +---@return number offsetY +function EditBox:GetShadowOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetSpacing) +---@return uiUnit fontHeight +function EditBox:GetSpacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetText) +---@return string text +function EditBox:GetText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetTextColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function EditBox:GetTextColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetTextInsets) +---@return uiUnit left +---@return uiUnit right +---@return uiUnit top +---@return uiUnit bottom +function EditBox:GetTextInsets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetUTF8CursorPosition) +---@return number cursorPosition +function EditBox:GetUTF8CursorPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_GetVisibleTextByteLimit) +---@return number maxVisibleBytes +function EditBox:GetVisibleTextByteLimit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_HasFocus) +---@return boolean hasFocus +function EditBox:HasFocus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_HasText) +---@return boolean hasText +function EditBox:HasText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_HighlightText) +---@param start? number Default = 0 +---@param stop? number Default = -1 +function EditBox:HighlightText(start, stop) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_Insert) +---@param text string +function EditBox:Insert(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsAlphabeticOnly) +---@return boolean enabled +function EditBox:IsAlphabeticOnly() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsAutoFocus) +---@return boolean autoFocus +function EditBox:IsAutoFocus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsCountInvisibleLetters) +---@return boolean countInvisibleLetters +function EditBox:IsCountInvisibleLetters() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsEnabled) +---@return boolean isEnabled +function EditBox:IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsInIMECompositionMode) +---@return boolean isInIMECompositionMode +function EditBox:IsInIMECompositionMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsMultiLine) +---@return boolean multiline +function EditBox:IsMultiLine() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsNumeric) +---@return boolean isNumeric +function EditBox:IsNumeric() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsNumericFullRange) +---@return boolean isNumeric +function EditBox:IsNumericFullRange() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsPassword) +---@return boolean isPassword +function EditBox:IsPassword() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_IsSecureText) +---@return boolean isSecure +function EditBox:IsSecureText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_ResetInputMode) +function EditBox:ResetInputMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetAlphabeticOnly) +---@param enabled? boolean Default = false +function EditBox:SetAlphabeticOnly(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetAltArrowKeyMode) +---@param altMode? boolean Default = false +function EditBox:SetAltArrowKeyMode(altMode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetAutoFocus) +---@param autoFocus? boolean Default = false +function EditBox:SetAutoFocus(autoFocus) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetBlinkSpeed) +---@param cursorBlinkSpeedSec number +function EditBox:SetBlinkSpeed(cursorBlinkSpeedSec) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetCountInvisibleLetters) +---@param countInvisibleLetters? boolean Default = false +function EditBox:SetCountInvisibleLetters(countInvisibleLetters) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetCursorPosition) +---@param cursorPosition number +function EditBox:SetCursorPosition(cursorPosition) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetEnabled) +---@param enabled? boolean Default = false +function EditBox:SetEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetFocus) +function EditBox:SetFocus() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetFont) +---@param fontFile FontFile +---@param height uiFontHeight +---@param flags TBFFlags +---@return boolean success +function EditBox:SetFont(fontFile, height, flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetFontObject) +---@param font FontObject|nil +function EditBox:SetFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetHighlightColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function EditBox:SetHighlightColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetHistoryLines) +---@param numHistoryLines number +function EditBox:SetHistoryLines(numHistoryLines) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetIndentedWordWrap) +---@param isIndented? boolean Default = false +function EditBox:SetIndentedWordWrap(isIndented) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetJustifyH) +---@param justifyH JustifyHorizontal +function EditBox:SetJustifyH(justifyH) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetJustifyV) +---@param justifyV JustifyVertical +function EditBox:SetJustifyV(justifyV) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetMaxBytes) +---@param maxBytes number +function EditBox:SetMaxBytes(maxBytes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetMaxLetters) +---@param maxLetters number +function EditBox:SetMaxLetters(maxLetters) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetMultiLine) +---@param multiline? boolean Default = false +function EditBox:SetMultiLine(multiline) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetNumber) +---@param number number +function EditBox:SetNumber(number) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetNumeric) +---@param isNumeric? boolean Default = false +function EditBox:SetNumeric(isNumeric) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetNumericFullRange) +---@param isNumeric? boolean Default = false +function EditBox:SetNumericFullRange(isNumeric) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetPassword) +---@param isPassword? boolean Default = false +function EditBox:SetPassword(isPassword) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetSecureText) +---@param isSecure? boolean Default = false +function EditBox:SetSecureText(isSecure) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetSecurityDisablePaste) +function EditBox:SetSecurityDisablePaste() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetSecurityDisableSetText) +function EditBox:SetSecurityDisableSetText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetShadowColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function EditBox:SetShadowColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetShadowOffset) +---@param offsetX number +---@param offsetY number +function EditBox:SetShadowOffset(offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetSpacing) +---@param fontHeight uiUnit +function EditBox:SetSpacing(fontHeight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetText) +---@param text string +function EditBox:SetText(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetTextColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function EditBox:SetTextColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetTextInsets) +---@param left uiUnit +---@param right uiUnit +---@param top uiUnit +---@param bottom uiUnit +function EditBox:SetTextInsets(left, right, top, bottom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_SetVisibleTextByteLimit) +---@param maxVisibleBytes number +function EditBox:SetVisibleTextByteLimit(maxVisibleBytes) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_EditBox_ToggleInputLanguage) +function EditBox:ToggleInputLanguage() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/FogOfWarFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/FogOfWarFrame.lua new file mode 100644 index 0000000..05baa91 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/FogOfWarFrame.lua @@ -0,0 +1,79 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_FogOfWarFrame) +---@class FogOfWarFrame : Frame +local FogOfWarFrame = {} +---@class fogofwarframe : FogOfWarFrame +---@class FOGOFWARFRAME : FogOfWarFrame + +---@param scriptType ScriptFogOfWarFrame +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function FogOfWarFrame:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptFogOfWarFrame +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function FogOfWarFrame:HasScript(scriptType) end + +---@param scriptType ScriptFogOfWarFrame +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function FogOfWarFrame:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptFogOfWarFrame +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function FogOfWarFrame:SetScript(scriptType, handler) end + + +---@return textureAtlas atlas +function FogOfWarFrame:GetFogOfWarBackgroundAtlas() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_GetFogOfWarBackgroundTexture) +---@return FileAsset? asset +function FogOfWarFrame:GetFogOfWarBackgroundTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_GetFogOfWarMaskAtlas) +---@return textureAtlas atlas +function FogOfWarFrame:GetFogOfWarMaskAtlas() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_GetFogOfWarMaskTexture) +---@return FileAsset? asset +function FogOfWarFrame:GetFogOfWarMaskTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_GetMaskScalar) +---@return number scalar +function FogOfWarFrame:GetMaskScalar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_GetUiMapID) +---@return number uiMapID +function FogOfWarFrame:GetUiMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_SetFogOfWarBackgroundAtlas) +---@param atlas textureAtlas +function FogOfWarFrame:SetFogOfWarBackgroundAtlas(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_SetFogOfWarBackgroundTexture) +---@param asset FileAsset +---@param horizontalTile boolean +---@param verticalTile boolean +function FogOfWarFrame:SetFogOfWarBackgroundTexture(asset, horizontalTile, verticalTile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_SetFogOfWarMaskAtlas) +---@param atlas textureAtlas +function FogOfWarFrame:SetFogOfWarMaskAtlas(atlas) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_SetFogOfWarMaskTexture) +---@param asset FileAsset +function FogOfWarFrame:SetFogOfWarMaskTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_SetMaskScalar) +---@param scalar number +function FogOfWarFrame:SetMaskScalar(scalar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_FogOfWarFrame_SetUiMapID) +---@param uiMapID number +function FogOfWarFrame:SetUiMapID(uiMapID) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Frame.lua b/docs/annotations/Annotations/Core/Widget/Frame/Frame.lua new file mode 100644 index 0000000..330d65b --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Frame.lua @@ -0,0 +1,555 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Frame) +---@class Frame : Region, ScriptObject +local Frame = {} +---@class frame : Frame +---@class FRAME : Frame + +---@param scriptType ScriptFrame +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function Frame:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptFrame +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function Frame:HasScript(scriptType) end + +---@param scriptType ScriptFrame +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function Frame:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptFrame +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function Frame:SetScript(scriptType, handler) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Object_GetParent) +---@return Frame? parent +function Frame:GetParent() end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_AbortDrag) +function Frame:AbortDrag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_CanChangeAttribute) +---@return boolean canChangeAttributes +function Frame:CanChangeAttribute() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_ClearAlphaGradient) +function Frame:ClearAlphaGradient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_ClearAttribute) +---@param attributeName string +---@return boolean cleared +function Frame:ClearAttribute(attributeName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_ClearAttributes) +function Frame:ClearAttributes() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_CreateFontString) +---@param name? string +---@param drawLayer? DrawLayer +---@param templateName? string +---@return SimpleFontString line +function Frame:CreateFontString(name, drawLayer, templateName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_CreateLine) +---@param name? string +---@param drawLayer? DrawLayer +---@param templateName? string +---@param subLevel? number +---@return SimpleLine line +function Frame:CreateLine(name, drawLayer, templateName, subLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_CreateMaskTexture) +---@param name? string +---@param drawLayer? DrawLayer +---@param templateName? string +---@param subLevel? number +---@return SimpleMaskTexture maskTexture +function Frame:CreateMaskTexture(name, drawLayer, templateName, subLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_CreateTexture) +---@param name? string +---@param drawLayer? DrawLayer +---@param templateName? string +---@param subLevel? number +---@return SimpleTexture texture +function Frame:CreateTexture(name, drawLayer, templateName, subLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_DesaturateHierarchy) +---@param desaturation number +---@param excludeRoot? boolean Default = false +function Frame:DesaturateHierarchy(desaturation, excludeRoot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_DisableDrawLayer) +---@param layer DrawLayer +function Frame:DisableDrawLayer(layer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_DoesClipChildren) +---@return boolean clipsChildren +function Frame:DoesClipChildren() end + +---Returns whether hyperlink events (ex. OnHyperlinkEnter, OnHyperlinkLeave, OnHyperlinkClick) are propagated to this frame's parent. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_DoesHyperlinkPropagateToParent) +---@return boolean canPropagate +function Frame:DoesHyperlinkPropagateToParent() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_EnableDrawLayer) +---@param layer DrawLayer +function Frame:EnableDrawLayer(layer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_EnableGamePadButton) +---@param enable? boolean Default = false +function Frame:EnableGamePadButton(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_EnableGamePadStick) +---@param enable? boolean Default = false +function Frame:EnableGamePadStick(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_EnableKeyboard) +---@param enable? boolean Default = false +function Frame:EnableKeyboard(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_ExecuteAttribute) +---@param attributeName string +---@param ...? string arguments +---@return boolean success +---@return string? ... returns +function Frame:ExecuteAttribute(attributeName, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetAlpha) +---@return SingleColorValue alpha +function Frame:GetAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetAttribute) +---@param attributeName string +---@return any value +function Frame:GetAttribute(attributeName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetBoundsRect) +---@return uiUnit left +---@return uiUnit bottom +---@return uiUnit width +---@return uiUnit height +function Frame:GetBoundsRect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetChildren) +---@return SimpleFrame ... children +function Frame:GetChildren() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetClampRectInsets) +---@return uiUnit left +---@return uiUnit right +---@return uiUnit top +---@return uiUnit bottom +function Frame:GetClampRectInsets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetDontSavePosition) +---@return boolean dontSave +function Frame:GetDontSavePosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetEffectiveAlpha) +---@return SingleColorValue effectiveAlpha +function Frame:GetEffectiveAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetEffectiveScale) +---@return number effectiveScale +function Frame:GetEffectiveScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetEffectivelyFlattensRenderLayers) +---@return boolean flatten +function Frame:GetEffectivelyFlattensRenderLayers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetFlattensRenderLayers) +---@return boolean flatten +function Frame:GetFlattensRenderLayers() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetFrameLevel) +---@return number frameLevel +function Frame:GetFrameLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetFrameStrata) +---@return FrameStrata strata +function Frame:GetFrameStrata() end + +---Returns the highest framelevel of the frame and its first order children, or all children if iterateAllChildren is true. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetHighestFrameLevel) +---@param iterateAllChildren? boolean Default = false +---@return number frameLevel +function Frame:GetHighestFrameLevel(iterateAllChildren) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetHitRectInsets) +---@return uiUnit left +---@return uiUnit right +---@return uiUnit top +---@return uiUnit bottom +function Frame:GetHitRectInsets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetHyperlinksEnabled) +---@return boolean enabled +function Frame:GetHyperlinksEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetID) +---@return number id +function Frame:GetID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetNumChildren) +---@return number numChildren +function Frame:GetNumChildren() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetNumRegions) +---@return number numRegions +function Frame:GetNumRegions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetPropagateKeyboardInput) +---@return boolean propagate +function Frame:GetPropagateKeyboardInput() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetRaisedFrameLevel) +---@return number frameLevel +function Frame:GetRaisedFrameLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetRegions) +---@return SimpleRegion ... regions +function Frame:GetRegions() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetResizeBounds) +---@return uiUnit minWidth +---@return uiUnit minHeight +---@return uiUnit maxWidth +---@return uiUnit maxHeight +function Frame:GetResizeBounds() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetScale) +---@return number frameScale +function Frame:GetScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_GetWindow) +---@return SimpleWindow window +function Frame:GetWindow() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_HasAlphaGradient) +---@return boolean hasAlphaGradient +function Frame:HasAlphaGradient() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_HasFixedFrameLevel) +---@return boolean isFixed +function Frame:HasFixedFrameLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_HasFixedFrameStrata) +---@return boolean isFixed +function Frame:HasFixedFrameStrata() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_Hide) +function Frame:Hide() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_InterceptStartDrag) +---@param delegate SimpleFrame +---@return boolean success +function Frame:InterceptStartDrag(delegate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsClampedToScreen) +---@return boolean clampedToScreen +function Frame:IsClampedToScreen() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsDrawLayerEnabled) +---@param layer DrawLayer +---@return boolean isEnabled +function Frame:IsDrawLayerEnabled(layer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsEventRegistered) +---@param eventName FrameEvent +---@return boolean isRegistered +---@return UnitToken? ... units +function Frame:IsEventRegistered(eventName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsFrameBuffer) +---@return boolean isFrameBuffer +function Frame:IsFrameBuffer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsGamePadButtonEnabled) +---@return boolean enabled +function Frame:IsGamePadButtonEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsGamePadStickEnabled) +---@return boolean enabled +function Frame:IsGamePadStickEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsHighlightLocked) +---@return boolean locked +function Frame:IsHighlightLocked() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsIgnoringChildrenForBounds) +---@return boolean ignore +function Frame:IsIgnoringChildrenForBounds() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsIgnoringParentAlpha) +---@return boolean ignore +function Frame:IsIgnoringParentAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsIgnoringParentScale) +---@return boolean ignore +function Frame:IsIgnoringParentScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsKeyboardEnabled) +---@return boolean enabled +function Frame:IsKeyboardEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsMovable) +---@return boolean isMovable +function Frame:IsMovable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsObjectLoaded) +---@return boolean isLoaded +function Frame:IsObjectLoaded() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsResizable) +---@return boolean resizable +function Frame:IsResizable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsShown) +---@return boolean isShown +function Frame:IsShown() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsToplevel) +---@return boolean isTopLevel +function Frame:IsToplevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsUserPlaced) +---@return boolean isUserPlaced +function Frame:IsUserPlaced() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsUsingParentLevel) +---@return boolean usingParentLevel +function Frame:IsUsingParentLevel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_IsVisible) +---@return boolean isVisible +function Frame:IsVisible() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_LockHighlight) +function Frame:LockHighlight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_Lower) +function Frame:Lower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_Raise) +function Frame:Raise() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RegisterAllEvents) +function Frame:RegisterAllEvents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RegisterEvent) +---@param eventName FrameEvent +---@return boolean registered +function Frame:RegisterEvent(eventName) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RegisterEventCallback) +---@param eventName string +---@param cb FrameEventCallbackType +---@return boolean registered +function Frame:RegisterEventCallback(eventName, cb) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RegisterForDrag) +---@param ... MouseButton buttons +function Frame:RegisterForDrag(...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RegisterUnitEvent) +---@param eventName FrameEvent +---@param ... UnitToken units +---@return boolean registered +function Frame:RegisterUnitEvent(eventName, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RegisterUnitEventCallback) +---@param eventName string +---@param cb FrameEventCallbackType +---@param ... string units +---@return boolean registered +function Frame:RegisterUnitEventCallback(eventName, cb, ...) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_RotateTextures) +---@param radians number +---@param x? number Default = 0.5 +---@param y? number Default = 0.5 +function Frame:RotateTextures(radians, x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetAlpha) +---@param alpha SingleColorValue +function Frame:SetAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetAlphaGradient) +---@param index number +---@param gradient vector2 +function Frame:SetAlphaGradient(index, gradient) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetAttribute) +---@param attributeName string +---@param value any +function Frame:SetAttribute(attributeName, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetAttributeNoHandler) +---@param attributeName string +---@param value any +function Frame:SetAttributeNoHandler(attributeName, value) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetClampRectInsets) +---@param left uiUnit +---@param right uiUnit +---@param top uiUnit +---@param bottom uiUnit +function Frame:SetClampRectInsets(left, right, top, bottom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetClampedToScreen) +---@param clampedToScreen boolean +function Frame:SetClampedToScreen(clampedToScreen) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetClipsChildren) +---@param clipsChildren boolean +function Frame:SetClipsChildren(clipsChildren) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetDontSavePosition) +---@param dontSave boolean +function Frame:SetDontSavePosition(dontSave) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetDrawLayerEnabled) +---@param layer DrawLayer +---@param isEnabled? boolean Default = false +function Frame:SetDrawLayerEnabled(layer, isEnabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetFixedFrameLevel) +---@param isFixed boolean +function Frame:SetFixedFrameLevel(isFixed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetFixedFrameStrata) +---@param isFixed boolean +function Frame:SetFixedFrameStrata(isFixed) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetFlattensRenderLayers) +---@param flatten boolean +function Frame:SetFlattensRenderLayers(flatten) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetFrameLevel) +---@param frameLevel number +function Frame:SetFrameLevel(frameLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetFrameStrata) +---@param strata FrameStrata +function Frame:SetFrameStrata(strata) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetHighlightLocked) +---@param locked boolean +function Frame:SetHighlightLocked(locked) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetHitRectInsets) +---@param left uiUnit +---@param right uiUnit +---@param top uiUnit +---@param bottom uiUnit +function Frame:SetHitRectInsets(left, right, top, bottom) end + +---Enables or disables propagating hyperlink events (ex. OnHyperlinkEnter, OnHyperlinkLeave, OnHyperlinkClick) to this frame's parent. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetHyperlinkPropagateToParent) +---@param canPropagate boolean +function Frame:SetHyperlinkPropagateToParent(canPropagate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetHyperlinksEnabled) +---@param enabled? boolean Default = false +function Frame:SetHyperlinksEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetID) +---@param id number +function Frame:SetID(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetIgnoreParentAlpha) +---@param ignore boolean +function Frame:SetIgnoreParentAlpha(ignore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetIgnoreParentScale) +---@param ignore boolean +function Frame:SetIgnoreParentScale(ignore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetIgnoringChildrenForBounds) +---@param ignore boolean +function Frame:SetIgnoringChildrenForBounds(ignore) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetIsFrameBuffer) +---@param isFrameBuffer boolean +function Frame:SetIsFrameBuffer(isFrameBuffer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetMovable) +---@param movable boolean +function Frame:SetMovable(movable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetPropagateKeyboardInput) +---@param propagate boolean +function Frame:SetPropagateKeyboardInput(propagate) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetResizable) +---@param resizable boolean +function Frame:SetResizable(resizable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetResizeBounds) +---@param minWidth uiUnit +---@param minHeight uiUnit +---@param maxWidth? uiUnit +---@param maxHeight? uiUnit +function Frame:SetResizeBounds(minWidth, minHeight, maxWidth, maxHeight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetScale) +---@param scale number +function Frame:SetScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetShown) +---@param shown? boolean Default = false +function Frame:SetShown(shown) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetToplevel) +---@param topLevel boolean +function Frame:SetToplevel(topLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetUserPlaced) +---@param userPlaced boolean +function Frame:SetUserPlaced(userPlaced) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetUsingParentLevel) +---@param usingParentLevel boolean +function Frame:SetUsingParentLevel(usingParentLevel) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_SetWindow) +---@param window? SimpleWindow +function Frame:SetWindow(window) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_Show) +function Frame:Show() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_StartMoving) +---@param alwaysStartFromMouse? boolean Default = false +function Frame:StartMoving(alwaysStartFromMouse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_StartSizing) +---@param resizePoint? FramePoint +---@param alwaysStartFromMouse? boolean Default = false +function Frame:StartSizing(resizePoint, alwaysStartFromMouse) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_StopMovingOrSizing) +function Frame:StopMovingOrSizing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_UnlockHighlight) +function Frame:UnlockHighlight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_UnregisterAllEvents) +function Frame:UnregisterAllEvents() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Frame_UnregisterEvent) +---@param eventName FrameEvent +---@return boolean registered +function Frame:UnregisterEvent(eventName) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/GameTooltip.lua b/docs/annotations/Annotations/Core/Widget/Frame/GameTooltip.lua new file mode 100644 index 0000000..a91bb5e --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/GameTooltip.lua @@ -0,0 +1,458 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_GameTooltip) +---@class GameTooltip : Frame +GameTooltip = {} +---@class gametooltip : GameTooltip +---@class GAMETOOLTIP : GameTooltip + +---@param scriptType ScriptGameTooltip +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function GameTooltip:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptGameTooltip +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function GameTooltip:HasScript(scriptType) end + +---@param scriptType ScriptGameTooltip +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function GameTooltip:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptGameTooltip +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function GameTooltip:SetScript(scriptType, handler) end + + +---@class TextureInfoTable +---@field width number +---@field height number +---@field anchor Enum.TooltipTextureAnchor +---@field margin TextureInfoTable.margin + +---@class TextureInfoTable.margin +---@field left number +---@field right number +---@field top number +---@field bottom number + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AddAtlas) +---@param atlas string +---@param textureInfoTable TextureInfoTable +function GameTooltip:AddAtlas(atlas, textureInfoTable) end + +---@param atlas string +---@param minx number +---@param maxx number +---@param miny number +---@param maxy number +function GameTooltip:AddAtlas(atlas, minx, maxx, miny, maxy) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AddDoubleLine) +---@param textL string +---@param textR string? +---@param rL number? +---@param gL number? +---@param bL number? +---@param rR number? +---@param gR number? +---@param bR number? +function GameTooltip:AddDoubleLine(textL, textR, rL, gL, bL, rR, gR, bR) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AddFontStrings) +function GameTooltip:AddFontStrings(leftstring, rightstring) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AddLine) +---@param tooltipText string +---@param r number? +---@param g number? +---@param b number? +---@param wrapText boolean? +function GameTooltip:AddLine(tooltipText, r, g, b, wrapText) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AddTexture) +function GameTooltip:AddTexture(texture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AppendText) +---@param text string +function GameTooltip:AppendText(text) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_ClearLines) +function GameTooltip:ClearLines() end + +---Set all padding values to 0.0 and remove the Padding SecretAspect. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_ClearPadding) +function GameTooltip:ClearPadding() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_CopyTooltip) +function GameTooltip:CopyTooltip() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_FadeOut) +function GameTooltip:FadeOut() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetAnchorType) +---@return string anchorType +function GameTooltip:GetAnchorType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetCustomLineSpacing) +---@return number spacing +function GameTooltip:GetCustomLineSpacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetLeftLine) +---@param line number +---@return SimpleFontString leftFontString +function GameTooltip:GetLeftLine(line) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetMinimumWidth) +---@return number width +---@return boolean forced +function GameTooltip:GetMinimumWidth() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetOwner) +---@return Frame owner +function GameTooltip:GetOwner() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetPadding) +---@return number right +---@return number bottom +---@return number left +---@return number top +function GameTooltip:GetPadding() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetRightLine) +---@param line number +---@return SimpleFontString rightFontString +function GameTooltip:GetRightLine(line) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_IsOwned) +---@param frame Frame +---@return boolean owned +function GameTooltip:IsOwned(frame) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_NumLines) +---@return number lines +function GameTooltip:NumLines() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAllowShowWithNoLines) +---@param bool boolean +function GameTooltip:SetAllowShowWithNoLines(bool) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAnchorType) +function GameTooltip:SetAnchorType(anchorType, Xoffset, Yoffset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCustomLineSpacing) +function GameTooltip:SetCustomLineSpacing(spacing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCustomWordWrapMinWidth) +function GameTooltip:SetCustomWordWrapMinWidth(width) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetFrameStack) +function GameTooltip:SetFrameStack(showhidden) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetMinimumWidth) +---@param width number +---@param force? boolean Default = false +function GameTooltip:SetMinimumWidth(width, force) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetObjectTooltipPosition) +function GameTooltip:SetObjectTooltipPosition() end + +---@param owner Frame +---@param anchor TooltipAnchor +---@param x? number +---@param y? number +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetOwner) +function GameTooltip:SetOwner(owner, anchor, x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetPadding) +---@param right number +---@param bottom number +---@param left? number +---@param top? number +function GameTooltip:SetPadding(right, bottom, left, top) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetShrinkToFitWrapped) +function GameTooltip:SetShrinkToFitWrapped() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetText) +---@param text string +---@param colorR? number +---@param colorG? number +---@param colorB? number +---@param alpha? number +---@param wrap? boolean +function GameTooltip:SetText(text, colorR, colorG, colorB, alpha, wrap) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AddSpellByID) +function GameTooltip:AddSpellByID(spellID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_AdvanceSecondaryCompareItem) +function GameTooltip:AdvanceSecondaryCompareItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetAzeritePowerID) +function GameTooltip:GetAzeritePowerID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetItem) +function GameTooltip:GetItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetSpell) +function GameTooltip:GetSpell() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_GetUnit) +function GameTooltip:GetUnit() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_IsEquippedItem) +function GameTooltip:IsEquippedItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_IsUnit) +function GameTooltip:IsUnit(unit) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_ResetSecondaryCompareItem) +function GameTooltip:ResetSecondaryCompareItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAchievementByID) +function GameTooltip:SetAchievementByID(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAction) +function GameTooltip:SetAction(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetArtifactItem) +function GameTooltip:SetArtifactItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetArtifactPowerByID) +function GameTooltip:SetArtifactPowerByID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAzeriteEssence) +function GameTooltip:SetAzeriteEssence(essenceID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAzeriteEssenceSlot) +function GameTooltip:SetAzeriteEssenceSlot(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetAzeritePower) +function GameTooltip:SetAzeritePower(itemID, itemLevel, powerID, owningItemLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetBackpackToken) +function GameTooltip:SetBackpackToken(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetBagItem) +function GameTooltip:SetBagItem(bag, slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetBagItemChild) +function GameTooltip:SetBagItemChild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetBuybackItem) +function GameTooltip:SetBuybackItem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCompanionPet) +function GameTooltip:SetCompanionPet() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCompareAzeritePower) +function GameTooltip:SetCompareAzeritePower(itemID, itemLevel, powerID, owningItemLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCompareItem) +function GameTooltip:SetCompareItem(shoppingTooltipTwo, primaryMouseover) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetConduit) +function GameTooltip:SetConduit(id, rank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCurrencyByID) +function GameTooltip:SetCurrencyByID(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCurrencyToken) +function GameTooltip:SetCurrencyToken(tokenId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetCurrencyTokenByID) +function GameTooltip:SetCurrencyTokenByID(currencyID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetEquipmentSet) +function GameTooltip:SetEquipmentSet(name) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetExistingSocketGem) +function GameTooltip:SetExistingSocketGem(index,toDestroy) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetGuildBankItem) +function GameTooltip:SetGuildBankItem(tab, id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetHeirloomByItemID) +function GameTooltip:SetHeirloomByItemID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetHyperlink) +function GameTooltip:SetHyperlink(itemString_or_itemLink) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetInboxItem) +function GameTooltip:SetInboxItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetInstanceLockEncountersComplete) +function GameTooltip:SetInstanceLockEncountersComplete(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetInventoryItem) +function GameTooltip:SetInventoryItem(unit, slot, nameOnly, hideUselessStats) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetInventoryItemByID) +function GameTooltip:SetInventoryItemByID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetItemByID) +function GameTooltip:SetItemByID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetItemKey) +function GameTooltip:SetItemKey(itemID, itemLevel, itemSuffix) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetLFGDungeonReward) +function GameTooltip:SetLFGDungeonReward(dungeonID, lootIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetLFGDungeonShortageReward) +function GameTooltip:SetLFGDungeonShortageReward(dungeonID, shortageSeverity, lootIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetLootCurrency) +function GameTooltip:SetLootCurrency(lootSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetLootItem) +function GameTooltip:SetLootItem(lootSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetLootRollItem) +function GameTooltip:SetLootRollItem(id) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetMerchantCostItem) +function GameTooltip:SetMerchantCostItem(index, item) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetMerchantItem) +function GameTooltip:SetMerchantItem(merchantSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetMountBySpellID) +function GameTooltip:SetMountBySpellID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetOwnedItemByID) +function GameTooltip:SetOwnedItemByID(ID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetPetAction) +function GameTooltip:SetPetAction(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetPossession) +function GameTooltip:SetPossession(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetPvpBrawl) +function GameTooltip:SetPvpBrawl() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetPvpTalent) +function GameTooltip:SetPvpTalent(talentID, talentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestCurrency) +function GameTooltip:SetQuestCurrency(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestItem) +function GameTooltip:SetQuestItem(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestLogCurrency) +function GameTooltip:SetQuestLogCurrency(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestLogItem) +function GameTooltip:SetQuestLogItem(type, index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestLogRewardSpell) +function GameTooltip:SetQuestLogRewardSpell(rewardSpellIndex, questID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestLogSpecialItem) +function GameTooltip:SetQuestLogSpecialItem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestPartyProgress) +function GameTooltip:SetQuestPartyProgress(questID, omitTitle, ignoreActivePlayer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetQuestRewardSpell) +function GameTooltip:SetQuestRewardSpell(rewardSpellIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetRecipeRankInfo) +function GameTooltip:SetRecipeRankInfo(recipeID, learnedRank) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetRecipeReagentItem) +function GameTooltip:SetRecipeReagentItem(recipeID, reagentIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetRecipeResultItem) +function GameTooltip:SetRecipeResultItem(recipeID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetRuneforgeResultItem) +function GameTooltip:SetRuneforgeResultItem(itemID, itemLevel, powerID, modifiers) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSendMailItem) +function GameTooltip:SetSendMailItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetShapeshift) +function GameTooltip:SetShapeshift(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSocketedItem) +function GameTooltip:SetSocketedItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSocketedRelic) +function GameTooltip:SetSocketedRelic(relicSlotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSocketGem) +function GameTooltip:SetSocketGem(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSpecialPvpBrawl) +function GameTooltip:SetSpecialPvpBrawl() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSpellBookItem) +function GameTooltip:SetSpellBookItem(spellId, bookType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetSpellByID) +function GameTooltip:SetSpellByID(spellId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetTalent) +function GameTooltip:SetTalent(talentIndex, isInspect, talentGroup, inspectedUnit, classId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetTotem) +function GameTooltip:SetTotem(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetToyByItemID) +function GameTooltip:SetToyByItemID(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetTradePlayerItem) +function GameTooltip:SetTradePlayerItem(tradeSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetTradeTargetItem) +function GameTooltip:SetTradeTargetItem(tradeSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetTrainerService) +function GameTooltip:SetTrainerService(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetTransmogrifyItem) +function GameTooltip:SetTransmogrifyItem(slotId) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUnit) +function GameTooltip:SetUnit(unit, hideStatus) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUnitAura) +function GameTooltip:SetUnitAura(unit, auraIndex, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUnitBuff) +function GameTooltip:SetUnitBuff(unit, buffIndex, raidFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUnitBuffByAuraInstanceID) +function GameTooltip:SetUnitBuffByAuraInstanceID(unitTokenString, auraInstanceID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUnitDebuff) +function GameTooltip:SetUnitDebuff(unit, buffIndex, raidFilter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUnitDebuffByAuraInstanceID) +function GameTooltip:SetUnitDebuffByAuraInstanceID(unitTokenString, auraInstanceID, filter) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetUpgradeItem) +function GameTooltip:SetUpgradeItem() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetVoidDepositItem) +function GameTooltip:SetVoidDepositItem(slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetVoidItem) +function GameTooltip:SetVoidItem(slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetVoidWithdrawalItem) +function GameTooltip:SetVoidWithdrawalItem(slotIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_GameTooltip_SetWeeklyReward) +function GameTooltip:SetWeeklyReward(itemDBID) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/MessageFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/MessageFrame.lua new file mode 100644 index 0000000..36cafd5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/MessageFrame.lua @@ -0,0 +1,162 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_MessageFrame) +---@class MessageFrame : Frame +local MessageFrame = {} +---@class messageframe : MessageFrame +---@class MESSAGEFRAME : MessageFrame + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_AddMessage) +---@param text string +---@param colorR? number +---@param colorG? number +---@param colorB? number +---@param a? SingleColorValue +---@param messageID? number +function MessageFrame:AddMessage(text, colorR, colorG, colorB, a, messageID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_Clear) +function MessageFrame:Clear() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetFadeDuration) +---@return number fadeDurationSeconds +function MessageFrame:GetFadeDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetFadePower) +---@return number fadePower +function MessageFrame:GetFadePower() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetFading) +---@return boolean isFading +function MessageFrame:GetFading() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetFont) +---@return string fontFile +---@return uiFontHeight height +---@return TBFFlags flags +function MessageFrame:GetFont() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetFontObject) +---@return SimpleFont font +function MessageFrame:GetFontObject() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetFontStringByID) +---@param messageID number +---@return SimpleFontString fontString +function MessageFrame:GetFontStringByID(messageID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetIndentedWordWrap) +---@return boolean wordWrap +function MessageFrame:GetIndentedWordWrap() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetInsertMode) +---@return InsertMode mode +function MessageFrame:GetInsertMode() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetJustifyH) +---@return JustifyHorizontal justifyH +function MessageFrame:GetJustifyH() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetJustifyV) +---@return JustifyVertical justifyV +function MessageFrame:GetJustifyV() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetShadowColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function MessageFrame:GetShadowColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetShadowOffset) +---@return number offsetX +---@return number offsetY +function MessageFrame:GetShadowOffset() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetSpacing) +---@return uiUnit spacing +function MessageFrame:GetSpacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetTextColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function MessageFrame:GetTextColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_GetTimeVisible) +---@return number timeVisibleSeconds +function MessageFrame:GetTimeVisible() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_HasMessageByID) +---@param messageID number +---@return boolean hasMessage +function MessageFrame:HasMessageByID(messageID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_ResetMessageFadeByID) +---@param messageID number +function MessageFrame:ResetMessageFadeByID(messageID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetFadeDuration) +---@param fadeDurationSeconds number +function MessageFrame:SetFadeDuration(fadeDurationSeconds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetFadePower) +---@param fadePower number +function MessageFrame:SetFadePower(fadePower) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetFading) +---@param fading boolean +function MessageFrame:SetFading(fading) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetFont) +---@param fontFile FontFile +---@param height uiFontHeight +---@param flags TBFFlags +function MessageFrame:SetFont(fontFile, height, flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetFontObject) +---@param font FontObject|nil +function MessageFrame:SetFontObject(font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetIndentedWordWrap) +---@param wordWrap boolean +function MessageFrame:SetIndentedWordWrap(wordWrap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetInsertMode) +---@param mode InsertMode +function MessageFrame:SetInsertMode(mode) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetJustifyH) +---@param justifyH JustifyHorizontal +function MessageFrame:SetJustifyH(justifyH) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetJustifyV) +---@param justifyV JustifyVertical +function MessageFrame:SetJustifyV(justifyV) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetShadowColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function MessageFrame:SetShadowColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetShadowOffset) +---@param offsetX number +---@param offsetY number +function MessageFrame:SetShadowOffset(offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetSpacing) +---@param spacing uiUnit +function MessageFrame:SetSpacing(spacing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetTextColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function MessageFrame:SetTextColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MessageFrame_SetTimeVisible) +---@param timeVisibleSeconds number +function MessageFrame:SetTimeVisible(timeVisibleSeconds) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Minimap.lua b/docs/annotations/Annotations/Core/Widget/Frame/Minimap.lua new file mode 100644 index 0000000..09280e4 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Minimap.lua @@ -0,0 +1,112 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Minimap) +---@class Minimap : Frame +Minimap = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_GetPingPosition) +function Minimap:GetPingPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_GetZoom) +function Minimap:GetZoom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_GetZoomLevels) +function Minimap:GetZoomLevels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_PingLocation) +function Minimap:PingLocation(x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobInsideAlpha) +function Minimap:SetArchBlobInsideAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobInsideTexture) +function Minimap:SetArchBlobInsideTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobOutsideAlpha) +function Minimap:SetArchBlobOutsideAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobOutsideTexture) +function Minimap:SetArchBlobOutsideTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobRingAlpha) +function Minimap:SetArchBlobRingAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobRingScalar) +function Minimap:SetArchBlobRingScalar(scalar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetArchBlobRingTexture) +function Minimap:SetArchBlobRingTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetBlipTexture) +function Minimap:SetBlipTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetCorpsePOIArrowTexture) +function Minimap:SetCorpsePOIArrowTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetIconTexture) +function Minimap:SetIconTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetMaskTexture) +function Minimap:SetMaskTexture(file) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetPOIArrowTexture) +function Minimap:SetPOIArrowTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetPlayerTexture) +function Minimap:SetPlayerTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobInsideAlpha) +function Minimap:SetQuestBlobInsideAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobInsideTexture) +function Minimap:SetQuestBlobInsideTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobOutsideAlpha) +function Minimap:SetQuestBlobOutsideAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobOutsideSelectedTexture) +function Minimap:SetQuestBlobOutsideSelectedTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobOutsideTexture) +function Minimap:SetQuestBlobOutsideTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobRingAlpha) +function Minimap:SetQuestBlobRingAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobRingScalar) +function Minimap:SetQuestBlobRingScalar(scalar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetQuestBlobRingTexture) +function Minimap:SetQuestBlobRingTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetStaticPOIArrowTexture) +function Minimap:SetStaticPOIArrowTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobInsideAlpha) +function Minimap:SetTaskBlobInsideAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobInsideTexture) +function Minimap:SetTaskBlobInsideTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobOutsideAlpha) +function Minimap:SetTaskBlobOutsideAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobOutsideSelectedTexture) +function Minimap:SetTaskBlobOutsideSelectedTexture(file) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobOutsideTexture) +function Minimap:SetTaskBlobOutsideTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobRingAlpha) +function Minimap:SetTaskBlobRingAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobRingScalar) +function Minimap:SetTaskBlobRingScalar(scalar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetTaskBlobRingTexture) +function Minimap:SetTaskBlobRingTexture(textureFile) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_SetZoom) +function Minimap:SetZoom(level) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Minimap_UpdateBlips) +function Minimap:UpdateBlips() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Model/CinematicModel.lua b/docs/annotations/Annotations/Core/Widget/Frame/Model/CinematicModel.lua new file mode 100644 index 0000000..b09b7ee --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Model/CinematicModel.lua @@ -0,0 +1,110 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_CinematicModel) +---@class CinematicModel : PlayerModel +local CinematicModel = {} +---@class cinematicmodel : CinematicModel +---@class CINEMATICMODEL : CinematicModel + +---@param scriptType ScriptCinematicModel +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function CinematicModel:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptCinematicModel +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function CinematicModel:HasScript(scriptType) end + +---@param scriptType ScriptCinematicModel +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function CinematicModel:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptCinematicModel +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function CinematicModel:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_EquipItem) +---@param itemID number +function CinematicModel:EquipItem(itemID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_InitializeCamera) +---@param scaleFactor? number Default = 0 +function CinematicModel:InitializeCamera(scaleFactor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_InitializePanCamera) +---@param scaleFactor? number Default = 0 +function CinematicModel:InitializePanCamera(scaleFactor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_RefreshCamera) +function CinematicModel:RefreshCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetAnimOffset) +---@param offset number +function CinematicModel:SetAnimOffset(offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetCameraPosition) +---@param positionX number +---@param positionY number +---@param positionZ number +function CinematicModel:SetCameraPosition(positionX, positionY, positionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetCameraTarget) +---@param positionX number +---@param positionY number +---@param positionZ number +function CinematicModel:SetCameraTarget(positionX, positionY, positionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetCreatureData) +---@param creatureID number +function CinematicModel:SetCreatureData(creatureID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetFacingLeft) +---@param isFacingLeft? boolean Default = false +function CinematicModel:SetFacingLeft(isFacingLeft) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetFadeTimes) +---@param fadeInSeconds number +---@param fadeOutSeconds number +function CinematicModel:SetFadeTimes(fadeInSeconds, fadeOutSeconds) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetHeightFactor) +---@param factor number +function CinematicModel:SetHeightFactor(factor) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetJumpInfo) +---@param jumpLength number +---@param jumpHeight number +function CinematicModel:SetJumpInfo(jumpLength, jumpHeight) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetPanDistance) +---@param scale number +function CinematicModel:SetPanDistance(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetSpellVisualKit) +---@param visualKitID number +function CinematicModel:SetSpellVisualKit(visualKitID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_SetTargetDistance) +---@param scale number +function CinematicModel:SetTargetDistance(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_StartPan) +---@param panType number +---@param durationSeconds number +---@param doFade? boolean Default = false +---@param visKitID? number Default = 0 +---@param startPositionScale? number Default = 0 +---@param speedMultiplier? number Default = 1 +function CinematicModel:StartPan(panType, durationSeconds, doFade, visKitID, startPositionScale, speedMultiplier) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_StopPan) +function CinematicModel:StopPan() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_CinematicModel_UnequipItems) +function CinematicModel:UnequipItems() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Model/DressUpModel.lua b/docs/annotations/Annotations/Core/Widget/Frame/Model/DressUpModel.lua new file mode 100644 index 0000000..bdea281 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Model/DressUpModel.lua @@ -0,0 +1,118 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_DressUpModel) +---@class DressUpModel : PlayerModel +local DressUpModel = {} +---@class dressupmodel : DressUpModel +---@class DRESSUPMODEL : DressUpModel + +---@param scriptType ScriptDressUpModel +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function DressUpModel:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptDressUpModel +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function DressUpModel:HasScript(scriptType) end + +---@param scriptType ScriptDressUpModel +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function DressUpModel:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptDressUpModel +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function DressUpModel:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_Dress) +function DressUpModel:Dress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetAutoDress) +---@return boolean enabled +function DressUpModel:GetAutoDress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetItemTransmogInfo) +---@param inventorySlot number +---@return ItemTransmogInfo itemTransmogInfo +function DressUpModel:GetItemTransmogInfo(inventorySlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetItemTransmogInfoList) +---@return ItemTransmogInfo[] infoList +function DressUpModel:GetItemTransmogInfoList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetObeyHideInTransmogFlag) +---@return boolean enabled +function DressUpModel:GetObeyHideInTransmogFlag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetSheathed) +---@return boolean sheathed +function DressUpModel:GetSheathed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetUseTransmogChoices) +---@return boolean enabled +function DressUpModel:GetUseTransmogChoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_GetUseTransmogSkin) +---@return boolean enabled +function DressUpModel:GetUseTransmogSkin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_IsGeoReady) +---@return boolean ready +function DressUpModel:IsGeoReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_IsSlotAllowed) +---@param slot number +---@return boolean allowed +function DressUpModel:IsSlotAllowed(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_IsSlotVisible) +---@param slot number +---@return boolean visible +function DressUpModel:IsSlotVisible(slot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_SetAutoDress) +---@param enabled? boolean Default = false +function DressUpModel:SetAutoDress(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_SetItemTransmogInfo) +---@param itemTransmogInfo ItemTransmogInfo +---@param inventorySlot? number +---@param ignoreChildItems? boolean Default = false +---@return Enum.ItemTryOnReason result +function DressUpModel:SetItemTransmogInfo(itemTransmogInfo, inventorySlot, ignoreChildItems) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_SetObeyHideInTransmogFlag) +---@param enabled? boolean Default = false +function DressUpModel:SetObeyHideInTransmogFlag(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_SetSheathed) +---@param sheathed? boolean Default = false +---@param hideWeapons? boolean Default = false +function DressUpModel:SetSheathed(sheathed, hideWeapons) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_SetUseTransmogChoices) +---@param enabled? boolean Default = false +function DressUpModel:SetUseTransmogChoices(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_SetUseTransmogSkin) +---@param enabled? boolean Default = false +function DressUpModel:SetUseTransmogSkin(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_TryOn) +---@param linkOrItemModifiedAppearanceID IDOrLink +---@param handSlotName? string +---@param spellEnchantID? number +---@return Enum.ItemTryOnReason? result +function DressUpModel:TryOn(linkOrItemModifiedAppearanceID, handSlotName, spellEnchantID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_Undress) +function DressUpModel:Undress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_DressUpModel_UndressSlot) +---@param inventorySlot number +function DressUpModel:UndressSlot(inventorySlot) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Model/Model.lua b/docs/annotations/Annotations/Core/Widget/Frame/Model/Model.lua new file mode 100644 index 0000000..a97071f --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Model/Model.lua @@ -0,0 +1,322 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Model) +---@class Model : Frame +local Model = {} +---@class model : Model +---@class MODEL : Model + +---@param scriptType ScriptModel +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function Model:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptModel +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function Model:HasScript(scriptType) end + +---@param scriptType ScriptModel +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function Model:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptModel +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function Model:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_AdvanceTime) +function Model:AdvanceTime() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_ClearFog) +function Model:ClearFog() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_ClearModel) +function Model:ClearModel() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_ClearTransform) +function Model:ClearTransform() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetCameraDistance) +---@return number distance +function Model:GetCameraDistance() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetCameraFacing) +---@return number radians +function Model:GetCameraFacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetCameraPosition) +---@return number positionX +---@return number positionY +---@return number positionZ +function Model:GetCameraPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetCameraRoll) +---@return number radians +function Model:GetCameraRoll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetCameraTarget) +---@return number targetX +---@return number targetY +---@return number targetZ +function Model:GetCameraTarget() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetDesaturation) +---@return number strength +function Model:GetDesaturation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetFacing) +---@return number facing +function Model:GetFacing() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetFogColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function Model:GetFogColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetFogFar) +---@return number fogFar +function Model:GetFogFar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetFogNear) +---@return number fogNear +function Model:GetFogNear() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetLight) +---@return boolean enabled +---@return ModelLight light +function Model:GetLight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetModelAlpha) +---@return number alpha +function Model:GetModelAlpha() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetModelDrawLayer) +---@return DrawLayer layer +---@return number sublayer +function Model:GetModelDrawLayer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetModelFileID) +---@return fileID modelFileID +function Model:GetModelFileID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetModelScale) +---@return number scale +function Model:GetModelScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetPaused) +---@return boolean paused +function Model:GetPaused() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetPitch) +---@return number pitch +function Model:GetPitch() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetPosition) +---@return number positionX +---@return number positionY +---@return number positionZ +function Model:GetPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetRoll) +---@return number roll +function Model:GetRoll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetShadowEffect) +---@return number strength +function Model:GetShadowEffect() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetViewInsets) +---@return uiUnit left +---@return uiUnit right +---@return uiUnit top +---@return uiUnit bottom +function Model:GetViewInsets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetViewTranslation) +---@return uiUnit x +---@return uiUnit y +function Model:GetViewTranslation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_GetWorldScale) +---@return number worldScale +function Model:GetWorldScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_HasAttachmentPoints) +---@return boolean hasAttachmentPoints +function Model:HasAttachmentPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_HasCustomCamera) +---@return boolean hasCustomCamera +function Model:HasCustomCamera() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_IsUsingModelCenterToTransform) +---@return boolean useCenter +function Model:IsUsingModelCenterToTransform() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_MakeCurrentCameraCustom) +function Model:MakeCurrentCameraCustom() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_ReplaceIconTexture) +---@param asset FileAsset +function Model:ReplaceIconTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCamera) +---@param cameraIndex number +function Model:SetCamera(cameraIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCameraDistance) +---@param distance number +function Model:SetCameraDistance(distance) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCameraFacing) +---@param radians number +function Model:SetCameraFacing(radians) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCameraPosition) +---@param positionX number +---@param positionY number +---@param positionZ number +function Model:SetCameraPosition(positionX, positionY, positionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCameraRoll) +---@param radians number +function Model:SetCameraRoll(radians) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCameraTarget) +---@param targetX number +---@param targetY number +---@param targetZ number +function Model:SetCameraTarget(targetX, targetY, targetZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetCustomCamera) +---@param cameraIndex number +function Model:SetCustomCamera(cameraIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetDesaturation) +---@param strength number +function Model:SetDesaturation(strength) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetFacing) +---@param facing number +function Model:SetFacing(facing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetFogColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function Model:SetFogColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetFogFar) +---@param fogFar number +function Model:SetFogFar(fogFar) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetFogNear) +---@param fogNear number +function Model:SetFogNear(fogNear) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetGlow) +---@param glow number +function Model:SetGlow(glow) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetGradientMask) +---@param grad0 number +---@param grad1 number +---@param grad2 number +---@param grad3 number +function Model:SetGradientMask(grad0, grad1, grad2, grad3) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetLight) +---@param enabled boolean +---@param light ModelLight +function Model:SetLight(enabled, light) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetModel) +---@param asset ModelAsset +---@param noMip? boolean Default = false +function Model:SetModel(asset, noMip) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetModelAlpha) +---@param alpha number +function Model:SetModelAlpha(alpha) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetModelDrawLayer) +---@param layer DrawLayer +function Model:SetModelDrawLayer(layer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetModelScale) +---@param scale number +function Model:SetModelScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetParticlesEnabled) +---@param enabled boolean +function Model:SetParticlesEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetPaused) +---@param paused boolean +function Model:SetPaused(paused) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetPitch) +---@param pitch number +function Model:SetPitch(pitch) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetPosition) +---@param positionX number +---@param positionY number +---@param positionZ number +function Model:SetPosition(positionX, positionY, positionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetRoll) +---@param roll number +function Model:SetRoll(roll) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetSequence) +---@param sequence number +function Model:SetSequence(sequence) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetSequenceTime) +---@param sequence number +---@param timeOffset number +function Model:SetSequenceTime(sequence, timeOffset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetShadowEffect) +---@param strength number +function Model:SetShadowEffect(strength) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetTransform) +---@param translation? vector3 +---@param rotation? vector3 +---@param scale? number +function Model:SetTransform(translation, rotation, scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetUseGBuffer) +---@param useGBuffer boolean +function Model:SetUseGBuffer(useGBuffer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetViewInsets) +---@param left uiUnit +---@param right uiUnit +---@param top uiUnit +---@param bottom uiUnit +function Model:SetViewInsets(left, right, top, bottom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_SetViewTranslation) +---@param x uiUnit +---@param y uiUnit +function Model:SetViewTranslation(x, y) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_TransformCameraSpaceToModelSpace) +---@param cameraPosition vector3 +---@return vector3 modelPosition +function Model:TransformCameraSpaceToModelSpace(cameraPosition) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Model_UseModelCenterToTransform) +---@param useCenter boolean +function Model:UseModelCenterToTransform(useCenter) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Model/PlayerModel.lua b/docs/annotations/Annotations/Core/Widget/Frame/Model/PlayerModel.lua new file mode 100644 index 0000000..b456c19 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Model/PlayerModel.lua @@ -0,0 +1,4 @@ +---@meta _ +---@class PlayerModel : CharacterModelBase +---@class playermodel : PlayerModel +---@class PLAYERMODEL : PlayerModel diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Model/TabardModel.lua b/docs/annotations/Annotations/Core/Widget/Frame/Model/TabardModel.lua new file mode 100644 index 0000000..eea2648 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Model/TabardModel.lua @@ -0,0 +1,30 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_TabardModel) +---@class TabardModel : TabardModelBase +local TabardModel = {} +---@class tabardmodel : TabardModel +---@class TABARDMODEL : TabardModel + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModel_GetLowerBackgroundFileName) +---@return fileID file +function TabardModel:GetLowerBackgroundFileName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModel_GetLowerBorderFile) +---@return fileID file +function TabardModel:GetLowerBorderFile() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModel_GetLowerEmblemFile) +---@return fileID file +function TabardModel:GetLowerEmblemFile() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModel_GetUpperBackgroundFileName) +---@return fileID file +function TabardModel:GetUpperBackgroundFileName() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModel_GetUpperBorderFile) +---@return fileID file +function TabardModel:GetUpperBorderFile() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_TabardModel_GetUpperEmblemFile) +---@return fileID file +function TabardModel:GetUpperEmblemFile() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/ModelScene.lua b/docs/annotations/Annotations/Core/Widget/Frame/ModelScene.lua new file mode 100644 index 0000000..f5db605 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/ModelScene.lua @@ -0,0 +1,252 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ModelScene) +---@class ModelScene : Frame +local ModelScene = {} +---@class modelscene : ModelScene +---@class MODELSCENE : ModelScene + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_ClearFog) +function ModelScene:ClearFog() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_CreateActor) +---@param name string? +---@param template string? +---@return ModelSceneActor actor +function ModelScene:CreateActor(name, template) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetActorAtIndex) +---@param index number +---@return ModelSceneActor actor +function ModelScene:GetActorAtIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetAllowOverlappedModels) +---@return boolean allowOverlappedModels +function ModelScene:GetAllowOverlappedModels() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraFarClip) +---@return number farClip +function ModelScene:GetCameraFarClip() end + +---Field of view in radians +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraFieldOfView) +---@return number fov +function ModelScene:GetCameraFieldOfView() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraForward) +---@return number forwardX +---@return number forwardY +---@return number forwardZ +function ModelScene:GetCameraForward() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraNearClip) +---@return number nearClip +function ModelScene:GetCameraNearClip() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraPosition) +---@return number positionX +---@return number positionY +---@return number positionZ +function ModelScene:GetCameraPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraRight) +---@return number rightX +---@return number rightY +---@return number rightZ +function ModelScene:GetCameraRight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetCameraUp) +---@return number upX +---@return number upY +---@return number upZ +function ModelScene:GetCameraUp() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetDrawLayer) +---@return DrawLayer layer +---@return number sublevel +function ModelScene:GetDrawLayer() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetFogColor) +---@return number colorR +---@return number colorG +---@return number colorB +function ModelScene:GetFogColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetFogFar) +---@return number far +function ModelScene:GetFogFar() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetFogNear) +---@return number near +function ModelScene:GetFogNear() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetLightAmbientColor) +---@return number colorR +---@return number colorG +---@return number colorB +function ModelScene:GetLightAmbientColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetLightDiffuseColor) +---@return number colorR +---@return number colorG +---@return number colorB +function ModelScene:GetLightDiffuseColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetLightDirection) +---@return number directionX +---@return number directionY +---@return number directionZ +function ModelScene:GetLightDirection() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetLightPosition) +---@return number positionX +---@return number positionY +---@return number positionZ +function ModelScene:GetLightPosition() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetLightType) +---@return Enum.ModelLightType? lightType +function ModelScene:GetLightType() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetNumActors) +---@return number numActors +function ModelScene:GetNumActors() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetViewInsets) +---@return uiUnit left +---@return uiUnit right +---@return uiUnit top +---@return uiUnit bottom +function ModelScene:GetViewInsets() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_GetViewTranslation) +---@return number translationX +---@return number translationY +function ModelScene:GetViewTranslation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_IsLightVisible) +---@return boolean isVisible +function ModelScene:IsLightVisible() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_Project3DPointTo2D) +---@param pointX number +---@param pointY number +---@param pointZ number +---@return number point2DX +---@return number point2DY +---@return number depth +function ModelScene:Project3DPointTo2D(pointX, pointY, pointZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetAllowOverlappedModels) +---@param allowOverlappedModels boolean +function ModelScene:SetAllowOverlappedModels(allowOverlappedModels) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetCameraFarClip) +---@param farClip number +function ModelScene:SetCameraFarClip(farClip) end + +---Field of view in radians +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetCameraFieldOfView) +---@param fov number +function ModelScene:SetCameraFieldOfView(fov) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetCameraNearClip) +---@param nearClip number +function ModelScene:SetCameraNearClip(nearClip) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetCameraOrientationByAxisVectors) +---@param forwardX number +---@param forwardY number +---@param forwardZ number +---@param rightX number +---@param rightY number +---@param rightZ number +---@param upX number +---@param upY number +---@param upZ number +function ModelScene:SetCameraOrientationByAxisVectors(forwardX, forwardY, forwardZ, rightX, rightY, rightZ, upX, upY, upZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetCameraOrientationByYawPitchRoll) +---@param yaw number +---@param pitch number +---@param roll number +function ModelScene:SetCameraOrientationByYawPitchRoll(yaw, pitch, roll) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetCameraPosition) +---@param positionX number +---@param positionY number +---@param positionZ number +function ModelScene:SetCameraPosition(positionX, positionY, positionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetDesaturation) +---@param strength number +function ModelScene:SetDesaturation(strength) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetDrawLayer) +---@param layer DrawLayer +function ModelScene:SetDrawLayer(layer) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetFogColor) +---@param colorR number +---@param colorG number +---@param colorB number +function ModelScene:SetFogColor(colorR, colorG, colorB) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetFogFar) +---@param far number +function ModelScene:SetFogFar(far) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetFogNear) +---@param near number +function ModelScene:SetFogNear(near) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetLightAmbientColor) +---@param colorR number +---@param colorG number +---@param colorB number +function ModelScene:SetLightAmbientColor(colorR, colorG, colorB) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetLightDiffuseColor) +---@param colorR number +---@param colorG number +---@param colorB number +function ModelScene:SetLightDiffuseColor(colorR, colorG, colorB) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetLightDirection) +---@param directionX number +---@param directionY number +---@param directionZ number +function ModelScene:SetLightDirection(directionX, directionY, directionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetLightPosition) +---@param positionX number +---@param positionY number +---@param positionZ number +function ModelScene:SetLightPosition(positionX, positionY, positionZ) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetLightType) +---@param lightType number|Enum.ModelLightType +function ModelScene:SetLightType(lightType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetLightVisible) +---@param visible? boolean Default = false +function ModelScene:SetLightVisible(visible) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetPaused) +---@param paused boolean +---@param affectsGlobalPause? boolean Default = true +function ModelScene:SetPaused(paused, affectsGlobalPause) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetViewInsets) +---@param left uiUnit +---@param right uiUnit +---@param top uiUnit +---@param bottom uiUnit +function ModelScene:SetViewInsets(left, right, top, bottom) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_SetViewTranslation) +---@param translationX number +---@param translationY number +function ModelScene:SetViewTranslation(translationX, translationY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelScene_TakeActor) +function ModelScene:TakeActor() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/ModelSceneActor.lua b/docs/annotations/Annotations/Core/Widget/Frame/ModelSceneActor.lua new file mode 100644 index 0000000..ddf5de8 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/ModelSceneActor.lua @@ -0,0 +1,149 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ModelSceneActor) +---@class ModelSceneActor : ModelSceneActorBase +local ModelSceneActor = {} + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_AttachToMount) +---@param rider ModelSceneActor +---@param animation AnimationDataEnum +---@param spellKitVisualID? number +---@return boolean success +function ModelSceneActor:AttachToMount(rider, animation, spellKitVisualID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_CalculateMountScale) +---@param rider ModelSceneActor +---@return number scale +function ModelSceneActor:CalculateMountScale(rider) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_DetachFromMount) +---@param rider ModelSceneActor +---@return boolean success +function ModelSceneActor:DetachFromMount(rider) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_Dress) +function ModelSceneActor:Dress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_DressPlayerSlot) +---@param invSlot number +function ModelSceneActor:DressPlayerSlot(invSlot) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetAutoDress) +---@return boolean autoDress +function ModelSceneActor:GetAutoDress() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetItemTransmogInfo) +---@param inventorySlots number +---@return ItemTransmogInfo? itemTransmogInfo +function ModelSceneActor:GetItemTransmogInfo(inventorySlots) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetItemTransmogInfoList) +---@return ItemTransmogInfo[] infoList +function ModelSceneActor:GetItemTransmogInfoList() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetObeyHideInTransmogFlag) +---@return boolean obey +function ModelSceneActor:GetObeyHideInTransmogFlag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetPaused) +---@return boolean paused +---@return boolean globalPaused +function ModelSceneActor:GetPaused() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetSheathed) +---@return boolean sheathed +function ModelSceneActor:GetSheathed() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetUseTransmogChoices) +---@return boolean use +function ModelSceneActor:GetUseTransmogChoices() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_GetUseTransmogSkin) +---@return boolean use +function ModelSceneActor:GetUseTransmogSkin() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_IsGeoReady) +---@return boolean isReady +function ModelSceneActor:IsGeoReady() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_IsSlotAllowed) +---@param inventorySlots number +---@return boolean allowed +function ModelSceneActor:IsSlotAllowed(inventorySlots) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_IsSlotVisible) +---@param inventorySlots number +---@return boolean visible +function ModelSceneActor:IsSlotVisible(inventorySlots) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_ReleaseFrontEndCharacterDisplays) +---@return boolean success +function ModelSceneActor:ReleaseFrontEndCharacterDisplays() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_ResetNextHandSlot) +function ModelSceneActor:ResetNextHandSlot() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetAutoDress) +---@param autoDress boolean +function ModelSceneActor:SetAutoDress(autoDress) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetFrontEndLobbyModelFromDefaultCharacterDisplay) +---@param characterIndex number +---@return boolean success +function ModelSceneActor:SetFrontEndLobbyModelFromDefaultCharacterDisplay(characterIndex) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetItemTransmogInfo) +---@param transmogInfo ItemTransmogInfo +---@param inventorySlots? number +---@param ignoreChildItems? boolean Default = false +---@return Enum.ItemTryOnReason result +function ModelSceneActor:SetItemTransmogInfo(transmogInfo, inventorySlots, ignoreChildItems) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetModelByHyperlink) +---@param link string +---@return boolean success +function ModelSceneActor:SetModelByHyperlink(link) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetObeyHideInTransmogFlag) +---@param obey boolean +function ModelSceneActor:SetObeyHideInTransmogFlag(obey) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetPaused) +---@param paused boolean +---@param affectsGlobalPause? boolean Default = true +function ModelSceneActor:SetPaused(paused, affectsGlobalPause) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetPlayerModelFromGlues) +---@param sheatheWeapons? boolean Default = false +---@param autoDress? boolean Default = true +---@param hideWeapons? boolean Default = false +---@param usePlayerNativeForm? boolean Default = true +---@return boolean success +function ModelSceneActor:SetPlayerModelFromGlues(sheatheWeapons, autoDress, hideWeapons, usePlayerNativeForm) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetSheathed) +---@param sheathed boolean +---@param hidden? boolean Default = false +function ModelSceneActor:SetSheathed(sheathed, hidden) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetUseTransmogChoices) +---@param use boolean +function ModelSceneActor:SetUseTransmogChoices(use) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_SetUseTransmogSkin) +---@param use boolean +function ModelSceneActor:SetUseTransmogSkin(use) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_TryOn) +---@param itemLinkOrItemModifiedAppearanceID string +---@param handSlotName? string +---@param spellEnchantmentID? number Default = 0 +---@return Enum.ItemTryOnReason? reason +function ModelSceneActor:TryOn(itemLinkOrItemModifiedAppearanceID, handSlotName, spellEnchantmentID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_Undress) +---@param includeWeapons? boolean Default = true +function ModelSceneActor:Undress(includeWeapons) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ModelSceneActor_UndressSlot) +---@param inventorySlots number +function ModelSceneActor:UndressSlot(inventorySlots) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/MovieFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/MovieFrame.lua new file mode 100644 index 0000000..deb67c0 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/MovieFrame.lua @@ -0,0 +1,52 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_MovieFrame) +---@class MovieFrame : Frame +local MovieFrame = {} +---@class movieframe : MovieFrame +---@class MOVIEFRAME : MovieFrame + +---@param scriptType ScriptMovieFrame +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function MovieFrame:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptMovieFrame +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function MovieFrame:HasScript(scriptType) end + +---@param scriptType ScriptMovieFrame +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function MovieFrame:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptMovieFrame +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function MovieFrame:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MovieFrame_EnableSubtitles) +---@param enable boolean +function MovieFrame:EnableSubtitles(enable) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MovieFrame_StartMovie) +---@param movieID number +---@param looping? boolean Default = false +---@return boolean success +---@return number returnCode +function MovieFrame:StartMovie(movieID, looping) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MovieFrame_StartMovieByName) +---@param movieName string +---@param looping? boolean Default = false +---@param resolution? number Default = 0 +---@return boolean success +---@return number returnCode +function MovieFrame:StartMovieByName(movieName, looping, resolution) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_MovieFrame_StopMovie) +function MovieFrame:StopMovie() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ArchaeologyDigSiteFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ArchaeologyDigSiteFrame.lua new file mode 100644 index 0000000..bf7d509 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ArchaeologyDigSiteFrame.lua @@ -0,0 +1,4 @@ +---@meta _ +---@class ArchaeologyDigSiteFrame : Blob +---@class archaeologydigsiteframe : ArchaeologyDigSiteFrame +---@class ARCHAEOLOGYDIGSITEFRAME : ArchaeologyDigSiteFrame diff --git a/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/QuestPOIFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/QuestPOIFrame.lua new file mode 100644 index 0000000..27af370 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/QuestPOIFrame.lua @@ -0,0 +1,22 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_QuestPOIFrame) +---@class QuestPOIFrame : Blob +local QuestPOIFrame = {} +---@class questpoiframe : QuestPOIFrame +---@class QUESTPOIFRAME : QuestPOIFrame + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestPOIFrame_GetNumTooltips) +---@return number numObjectives +function QuestPOIFrame:GetNumTooltips() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestPOIFrame_GetTooltipIndex) +---@param index number +---@return number objectiveIndex +function QuestPOIFrame:GetTooltipIndex(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_QuestPOIFrame_UpdateMouseOverTooltip) +---@param x number +---@param y number +---@return number? questID +---@return number? numObjectives +function QuestPOIFrame:UpdateMouseOverTooltip(x, y) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ScenarioPOIFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ScenarioPOIFrame.lua new file mode 100644 index 0000000..627f677 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/POIFrame/ScenarioPOIFrame.lua @@ -0,0 +1,16 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ScenarioPOIFrame) +---@class ScenarioPOIFrame : Blob +local ScenarioPOIFrame = {} +---@class scenariopoiframe : ScenarioPOIFrame +---@class SCENARIOPOIFRAME : ScenarioPOIFrame + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScenarioPOIFrame_GetScenarioTooltipText) +---@return string? tooltipText +function ScenarioPOIFrame:GetScenarioTooltipText() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScenarioPOIFrame_UpdateMouseOverTooltip) +---@param x number +---@param y number +---@return boolean hasTooltip +function ScenarioPOIFrame:UpdateMouseOverTooltip(x, y) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/ScrollFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/ScrollFrame.lua new file mode 100644 index 0000000..b4056d9 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/ScrollFrame.lua @@ -0,0 +1,65 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_ScrollFrame) +---@class ScrollFrame : Frame +local ScrollFrame = {} +---@class scrollframe : ScrollFrame +---@class SCROLLFRAME : ScrollFrame + +---@param scriptType ScriptScrollFrame +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function ScrollFrame:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptScrollFrame +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function ScrollFrame:HasScript(scriptType) end + +---@param scriptType ScriptScrollFrame +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function ScrollFrame:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptScrollFrame +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function ScrollFrame:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_GetHorizontalScroll) +---@return uiUnit offset +function ScrollFrame:GetHorizontalScroll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_GetHorizontalScrollRange) +---@return uiUnit range +function ScrollFrame:GetHorizontalScrollRange() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_GetScrollChild) +---@return SimpleFrame scrollChild +function ScrollFrame:GetScrollChild() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_GetVerticalScroll) +---@return uiUnit offset +function ScrollFrame:GetVerticalScroll() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_GetVerticalScrollRange) +---@return uiUnit range +function ScrollFrame:GetVerticalScrollRange() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_SetHorizontalScroll) +---@param offset uiUnit +function ScrollFrame:SetHorizontalScroll(offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_SetScrollChild) +---@param scrollChild SimpleFrame +function ScrollFrame:SetScrollChild(scrollChild) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_SetVerticalScroll) +---@param offset uiUnit +function ScrollFrame:SetVerticalScroll(offset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScrollFrame_UpdateScrollChildRect) +function ScrollFrame:UpdateScrollChildRect() end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/SimpleHTML.lua b/docs/annotations/Annotations/Core/Widget/Frame/SimpleHTML.lua new file mode 100644 index 0000000..0d5d5a2 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/SimpleHTML.lua @@ -0,0 +1,135 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_SimpleHTML) +---@class SimpleHTML : Frame +local SimpleHTML = {} +---@class simplehtml : SimpleHTML +---@class SIMPLEHTML : SimpleHTML + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetContentHeight) +---@return uiUnit height +function SimpleHTML:GetContentHeight() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetFont) +---@param textType HTMLTextType +---@return string fontFile +---@return uiFontHeight height +---@return TBFFlags flags +function SimpleHTML:GetFont(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetFontObject) +---@param textType HTMLTextType +---@return SimpleFont font +function SimpleHTML:GetFontObject(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetHyperlinkFormat) +---@return string format +function SimpleHTML:GetHyperlinkFormat() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetIndentedWordWrap) +---@param textType HTMLTextType +---@return boolean wordWrap +function SimpleHTML:GetIndentedWordWrap(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetJustifyH) +---@param textType HTMLTextType +---@return JustifyHorizontal justifyH +function SimpleHTML:GetJustifyH(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetJustifyV) +---@param textType HTMLTextType +---@return JustifyVertical justifyV +function SimpleHTML:GetJustifyV(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetShadowColor) +---@param textType HTMLTextType +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function SimpleHTML:GetShadowColor(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetShadowOffset) +---@param textType HTMLTextType +---@return number offsetX +---@return number offsetY +function SimpleHTML:GetShadowOffset(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetSpacing) +---@param textType HTMLTextType +---@return uiUnit spacing +function SimpleHTML:GetSpacing(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetTextColor) +---@param textType HTMLTextType +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function SimpleHTML:GetTextColor(textType) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_GetTextData) +---@return HTMLContentNode[] content +function SimpleHTML:GetTextData() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetFont) +---@param textType HTMLTextType +---@param fontFile FontFile +---@param height uiFontHeight +---@param flags TBFFlags +function SimpleHTML:SetFont(textType, fontFile, height, flags) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetFontObject) +---@param textType HTMLTextType +---@param font FontObject +function SimpleHTML:SetFontObject(textType, font) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetHyperlinkFormat) +---@param format string +function SimpleHTML:SetHyperlinkFormat(format) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetIndentedWordWrap) +---@param textType HTMLTextType +---@param wordWrap boolean +function SimpleHTML:SetIndentedWordWrap(textType, wordWrap) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetJustifyH) +---@param textType HTMLTextType +---@param justifyH JustifyHorizontal +function SimpleHTML:SetJustifyH(textType, justifyH) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetJustifyV) +---@param textType HTMLTextType +---@param justifyV JustifyVertical +function SimpleHTML:SetJustifyV(textType, justifyV) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetShadowColor) +---@param textType HTMLTextType +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function SimpleHTML:SetShadowColor(textType, colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetShadowOffset) +---@param textType HTMLTextType +---@param offsetX number +---@param offsetY number +function SimpleHTML:SetShadowOffset(textType, offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetSpacing) +---@param textType HTMLTextType +---@param spacing uiUnit +function SimpleHTML:SetSpacing(textType, spacing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetText) +---@param text string +---@param ignoreMarkup? boolean Default = false +function SimpleHTML:SetText(text, ignoreMarkup) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_SimpleHTML_SetTextColor) +---@param textType HTMLTextType +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function SimpleHTML:SetTextColor(textType, colorR, colorG, colorB, a) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/Slider.lua b/docs/annotations/Annotations/Core/Widget/Frame/Slider.lua new file mode 100644 index 0000000..212c474 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/Slider.lua @@ -0,0 +1,107 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Slider) +---@class Slider : Frame +local Slider = {} +---@class slider : Slider +---@class SLIDER : Slider + +---@param scriptType ScriptSlider +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function Slider:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptSlider +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function Slider:HasScript(scriptType) end + +---@param scriptType ScriptSlider +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function Slider:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptSlider +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function Slider:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_Disable) +function Slider:Disable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_Enable) +function Slider:Enable() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetMinMaxValues) +---@return number minValue +---@return number maxValue +function Slider:GetMinMaxValues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetObeyStepOnDrag) +---@return boolean isObeyStepOnDrag +function Slider:GetObeyStepOnDrag() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetOrientation) +---@return Orientation orientation +function Slider:GetOrientation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetStepsPerPage) +---@return number stepsPerPage +function Slider:GetStepsPerPage() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetThumbTexture) +---@return SimpleTexture texture +function Slider:GetThumbTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetValue) +---@return number value +function Slider:GetValue() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_GetValueStep) +---@return number valueStep +function Slider:GetValueStep() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_IsDraggingThumb) +---@return boolean isDraggingThumb +function Slider:IsDraggingThumb() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_IsEnabled) +---@return boolean enabled +function Slider:IsEnabled() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetEnabled) +---@param enabled boolean +function Slider:SetEnabled(enabled) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetMinMaxValues) +---@param minValue number +---@param maxValue number +function Slider:SetMinMaxValues(minValue, maxValue) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetObeyStepOnDrag) +---@param obeyStepOnDrag boolean +function Slider:SetObeyStepOnDrag(obeyStepOnDrag) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetOrientation) +---@param orientation Orientation +function Slider:SetOrientation(orientation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetStepsPerPage) +---@param stepsPerPage number +function Slider:SetStepsPerPage(stepsPerPage) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetThumbTexture) +---@param asset TextureAsset +function Slider:SetThumbTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetValue) +---@param value number +---@param treatAsMouseEvent? boolean Default = false +function Slider:SetValue(value, treatAsMouseEvent) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Slider_SetValueStep) +---@param valueStep number +function Slider:SetValueStep(valueStep) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/StatusBar.lua b/docs/annotations/Annotations/Core/Widget/Frame/StatusBar.lua new file mode 100644 index 0000000..a5d94bc --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/StatusBar.lua @@ -0,0 +1,155 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_StatusBar) +---@class StatusBar : Frame +local StatusBar = {} +---@class statusbar : StatusBar +---@class STATUSBAR : StatusBar + +---@param scriptType ScriptStatusBar +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return function handler +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_GetScript) +function StatusBar:GetScript(scriptType, bindingType) end + +---@param scriptType ScriptStatusBar +---@return boolean hasScript +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HasScript) +function StatusBar:HasScript(scriptType) end + +---@param scriptType ScriptStatusBar +---@param handler function +---@param bindingType? LE_SCRIPT_BINDING_TYPE +---@return boolean success +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_HookScript) +function StatusBar:HookScript(scriptType, handler, bindingType) end + +---@param scriptType ScriptStatusBar +---@param handler function|nil +---[Documentation](https://warcraft.wiki.gg/wiki/API_ScriptObject_SetScript) +function StatusBar:SetScript(scriptType, handler) end + + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetFillStyle) +---@return StatusBarFillStyle fillStyle +function StatusBar:GetFillStyle() end + +---Returns the current interpolated value displayed by the bar. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetInterpolatedValue) +---@return number value +function StatusBar:GetInterpolatedValue() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetMinMaxValues) +---@return number minValue +---@return number maxValue +function StatusBar:GetMinMaxValues() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetOrientation) +---@return Orientation orientation +function StatusBar:GetOrientation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetReverseFill) +---@return boolean isReverseFill +function StatusBar:GetReverseFill() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetRotatesTexture) +---@return boolean rotatesTexture +function StatusBar:GetRotatesTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetStatusBarColor) +---@return number colorR +---@return number colorG +---@return number colorB +---@return number colorA +function StatusBar:GetStatusBarColor() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetStatusBarDesaturation) +---@return normalizedValue desaturation +function StatusBar:GetStatusBarDesaturation() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetStatusBarTexture) +---@return SimpleTexture texture +function StatusBar:GetStatusBarTexture() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetTimerDuration) +---@return LuaDurationObject duration +function StatusBar:GetTimerDuration() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_GetValue) +---@return number value +function StatusBar:GetValue() end + +---Returns true if the status bar is currently interpolating toward a target value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_IsInterpolating) +---@return boolean isInterpolating +function StatusBar:IsInterpolating() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_IsStatusBarDesaturated) +---@return boolean desaturated +function StatusBar:IsStatusBarDesaturated() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetColorFill) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function StatusBar:SetColorFill(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetFillStyle) +---@param fillStyle StatusBarFillStyle +function StatusBar:SetFillStyle(fillStyle) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetMinMaxValues) +---@param minValue number +---@param maxValue number +---@param interpolation? Enum.StatusBarInterpolation Default = Immediate +function StatusBar:SetMinMaxValues(minValue, maxValue, interpolation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetOrientation) +---@param orientation Orientation +function StatusBar:SetOrientation(orientation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetReverseFill) +---@param isReverseFill boolean +function StatusBar:SetReverseFill(isReverseFill) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetRotatesTexture) +---@param rotatesTexture boolean +function StatusBar:SetRotatesTexture(rotatesTexture) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetStatusBarColor) +---@param colorR number +---@param colorG number +---@param colorB number +---@param a? SingleColorValue +function StatusBar:SetStatusBarColor(colorR, colorG, colorB, a) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetStatusBarDesaturated) +---@param desaturated? boolean Default = false +function StatusBar:SetStatusBarDesaturated(desaturated) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetStatusBarDesaturation) +---@param desaturation normalizedValue +function StatusBar:SetStatusBarDesaturation(desaturation) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetStatusBarTexture) +---@param asset TextureAsset +---@return boolean success +function StatusBar:SetStatusBarTexture(asset) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetTimerDuration) +---@param duration LuaDurationObject +---@param interpolation? Enum.StatusBarInterpolation Default = Immediate +---@param direction? Enum.StatusBarTimerDirection Default = ElapsedTime +function StatusBar:SetTimerDuration(duration, interpolation, direction) end + +---Immediately finishes any interpolation of the bar and snaps it to the target value. +--- +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetToTargetValue) +function StatusBar:SetToTargetValue() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_StatusBar_SetValue) +---@param value number +---@param interpolation? Enum.StatusBarInterpolation Default = Immediate +function StatusBar:SetValue(value, interpolation) end diff --git a/docs/annotations/Annotations/Core/Widget/Frame/UnitPositionFrame.lua b/docs/annotations/Annotations/Core/Widget/Frame/UnitPositionFrame.lua new file mode 100644 index 0000000..4f926fd --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Frame/UnitPositionFrame.lua @@ -0,0 +1,68 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_UnitPositionFrame) +---@class UnitPositionFrame : Frame +local UnitPositionFrame = {} +---@class unitpositionframe : UnitPositionFrame +---@class UNITPOSITIONFRAME : UnitPositionFrame + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_AddUnit) +---@param unitTokenString string +---@param asset TextureAssetDisk +---@param width? uiUnit +---@param height? uiUnit +---@param r? number +---@param g? number +---@param b? number +---@param a? number +---@param sublayer? number +---@param showFacing? boolean +function UnitPositionFrame:AddUnit(unitTokenString, asset, width, height, r, g, b, a, sublayer, showFacing) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_ClearUnits) +function UnitPositionFrame:ClearUnits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_FinalizeUnits) +function UnitPositionFrame:FinalizeUnits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_GetMouseOverUnits) +---@return string units +function UnitPositionFrame:GetMouseOverUnits() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_GetPlayerPingScale) +---@return number scale +function UnitPositionFrame:GetPlayerPingScale() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_GetUiMapID) +---@return number mapID +function UnitPositionFrame:GetUiMapID() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_SetPlayerPingScale) +---@param scale number +function UnitPositionFrame:SetPlayerPingScale(scale) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_SetPlayerPingTexture) +---@param textureType number|Enum.PingTextureType +---@param asset FileAsset +---@param width? uiUnit Default = 0 +---@param height? uiUnit Default = 0 +function UnitPositionFrame:SetPlayerPingTexture(textureType, asset, width, height) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_SetUiMapID) +---@param mapID number +function UnitPositionFrame:SetUiMapID(mapID) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_SetUnitColor) +---@param unit string +---@param colorR number +---@param colorG number +---@param colorB number +---@param colorA number +function UnitPositionFrame:SetUnitColor(unit, colorR, colorG, colorB, colorA) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_StartPlayerPing) +---@param duration? number Default = 0 +---@param fadeDuration? number Default = 0 +function UnitPositionFrame:StartPlayerPing(duration, fadeDuration) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_UnitPositionFrame_StopPlayerPing) +function UnitPositionFrame:StopPlayerPing() end diff --git a/docs/annotations/Annotations/Core/Widget/Intrinsic/DropdownButton.lua b/docs/annotations/Annotations/Core/Widget/Intrinsic/DropdownButton.lua new file mode 100644 index 0000000..601f3fe --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Intrinsic/DropdownButton.lua @@ -0,0 +1,9 @@ +---@meta _ +---@class DropdownButtonMixin : CallbackRegistryMixin +DropdownButtonMixin = {} + +function DropdownButtonMixin:OnLoad_Intrinsic() end +function DropdownButtonMixin:OnHide_Intrinsic() end +function DropdownButtonMixin:OnShow_Intrinsic() end + +---@class DropdownButton : DropdownButtonMixin, Button diff --git a/docs/annotations/Annotations/Core/Widget/Intrinsic/EventFrame.lua b/docs/annotations/Annotations/Core/Widget/Intrinsic/EventFrame.lua new file mode 100644 index 0000000..9fcf667 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Intrinsic/EventFrame.lua @@ -0,0 +1,13 @@ +---@meta _ +---@class EventFrameMixin : CallbackRegistryMixin +EventFrameMixin = {} + +function EventFrameMixin:OnLoad_Intrinsic() end +function EventFrameMixin:OnHide_Intrinsic() end +function EventFrameMixin:OnShow_Intrinsic() end + +---@param width number +---@param height number +function EventFrameMixin:OnSizeChanged_Intrinsic(width, height) end + +---@class EventFrame : EventFrameMixin, Frame diff --git a/docs/annotations/Annotations/Core/Widget/Texture/Line.lua b/docs/annotations/Annotations/Core/Widget/Texture/Line.lua new file mode 100644 index 0000000..8c178af --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Texture/Line.lua @@ -0,0 +1,54 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Line) +---@class Line : TextureBase +local Line = {} +---@class line : Line +---@class LINE : Line + +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_ClearAllPoints) +function Line:ClearAllPoints() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_GetEndPoint) +---@return FramePoint relativePoint +---@return ScriptRegion relativeTo +---@return uiUnit offsetX +---@return uiUnit offsetY +function Line:GetEndPoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_GetHitRectThickness) +---@return uiUnit thickness +function Line:GetHitRectThickness() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_GetStartPoint) +---@return FramePoint relativePoint +---@return ScriptRegion relativeTo +---@return uiUnit offsetX +---@return uiUnit offsetY +function Line:GetStartPoint() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_GetThickness) +---@return uiUnit thickness +function Line:GetThickness() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_SetEndPoint) +---@param relativePoint FramePoint +---@param relativeTo ScriptRegion +---@param offsetX? uiUnit Default = 0 +---@param offsetY? uiUnit Default = 0 +function Line:SetEndPoint(relativePoint, relativeTo, offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_SetHitRectThickness) +---@param thickness uiUnit +function Line:SetHitRectThickness(thickness) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_SetStartPoint) +---@param relativePoint FramePoint +---@param relativeTo ScriptRegion +---@param offsetX? uiUnit Default = 0 +---@param offsetY? uiUnit Default = 0 +function Line:SetStartPoint(relativePoint, relativeTo, offsetX, offsetY) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Line_SetThickness) +---@param thickness uiUnit +function Line:SetThickness(thickness) end diff --git a/docs/annotations/Annotations/Core/Widget/Texture/Texture.lua b/docs/annotations/Annotations/Core/Widget/Texture/Texture.lua new file mode 100644 index 0000000..6e02500 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/Texture/Texture.lua @@ -0,0 +1,28 @@ +---@meta _ +---[Documentation](https://warcraft.wiki.gg/wiki/UIOBJECT_Texture) +---@class Texture : TextureBase +local Texture = {} +---@class texture : Texture +---@class TEXTURE : Texture + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Texture_AddMaskTexture) +---@param mask SimpleMaskTexture +function Texture:AddMaskTexture(mask) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Texture_GetMaskTexture) +---@param index number +---@return SimpleMaskTexture mask +function Texture:GetMaskTexture(index) end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Texture_GetNumMaskTextures) +---@return size count +function Texture:GetNumMaskTextures() end + +---[Documentation](https://warcraft.wiki.gg/wiki/API_Texture_RemoveMaskTexture) +---@param mask SimpleMaskTexture +function Texture:RemoveMaskTexture(mask) end + +---@class MaskTexture : TextureBase +local MaskTexture = {} +---@class masktexture : MaskTexture +---@class MASKTEXTURE : MaskTexture \ No newline at end of file diff --git a/docs/annotations/Annotations/Core/Widget/UIType/Font.lua b/docs/annotations/Annotations/Core/Widget/UIType/Font.lua new file mode 100644 index 0000000..428fef5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/UIType/Font.lua @@ -0,0 +1,733 @@ +---@meta _ +---@alias FontFile string +---|"fonts/arialn.ttf" +---|"fonts/frizqt__.ttf" +---|"fonts/skurri.ttf" +---|"fonts/morpheus.ttf" +---|"fonts/blei00d.ttf" +---|"fonts/arhei.ttf" +---|"fonts/bkai00m.ttf" +---|"fonts/2002.ttf" +---|"fonts/nim_____.ttf" +---|"fonts/2002b.ttf" +---|"fonts/bhei00m.ttf" +---|"fonts/arkai_c.ttf" +---|"fonts/frizqt___cyr.ttf" +---|"fonts/k_pagetext.ttf" +---|"fonts/skurri_cyr.ttf" +---|"fonts/arkai_t.ttf" +---|"fonts/k_damage.ttf" +---|"fonts/morpheus_cyr.ttf" +---|"fonts/bhei01b.ttf" +---|"fonts/arheiuhk_bd.ttf" + +---@alias FontObject string|Font +---|"AchievementCriteriaFont" +---|"AchievementDateFont" +---|"AchievementDescriptionFont" +---|"AchievementFont_Small" +---|"AchievementPointsFont" +---|"AchievementPointsFontSmall" +---|"ArtifactAppearanceSetHighlightFont" +---|"ArtifactAppearanceSetNormalFont" +---|"BossEmoteNormalHuge" +---|"ChatBubbleFont" +---|"ChatFontNormal" +---|"ChatFontSmall" +---|"CombatLogFont" +---|"CombatTextFont" +---|"CombatTextFontOutline" +---|"CommentatorCCFont" +---|"CommentatorDampeningFont" +---|"CommentatorFontMedium" +---|"CommentatorFontSmall" +---|"CommentatorTeamNameFont" +---|"CommentatorTeamScoreFont" +---|"CommentatorVictoryFanfare" +---|"CommentatorVictoryFanfareTeam" +---|"ConsoleFontNormal" +---|"ConsoleFontSmall" +---|"CoreAbilityFont" +---|"DestinyFontHuge" +---|"DestinyFontLarge" +---|"DestinyFontMed" +---|"DialogButtonHighlightText" +---|"DialogButtonNormalText" +---|"ErrorFont" +---|"Fancy12Font" +---|"Fancy14Font" +---|"Fancy16Font" +---|"Fancy18Font" +---|"Fancy20Font" +---|"Fancy22Font" +---|"Fancy24Font" +---|"Fancy27Font" +---|"Fancy30Font" +---|"Fancy32Font" +---|"Fancy48Font" +---|"FocusFontSmall" +---|"FriendsFont_11" +---|"FriendsFont_Large" +---|"FriendsFont_Normal" +---|"FriendsFont_Small" +---|"FriendsFont_UserText" +---|"Game10Font_o1" +---|"Game11Font" +---|"Game11Font_o1" +---|"Game11Font_Shadow" +---|"Game120Font" +---|"Game12Font" +---|"Game12Font_o1" +---|"Game13Font" +---|"Game13Font_o1" +---|"Game13FontShadow" +---|"Game15Font" +---|"Game15Font_o1" +---|"Game16Font" +---|"Game17Font_Shadow" +---|"Game18Font" +---|"Game20Font" +---|"Game24Font" +---|"Game27Font" +---|"Game30Font" +---|"Game32Font" +---|"Game32Font_Shadow2" +---|"Game36Font" +---|"Game36Font_Shadow2" +---|"Game40Font" +---|"Game40Font_Shadow2" +---|"Game42Font" +---|"Game46Font" +---|"Game46Font_Shadow2" +---|"Game48Font" +---|"Game48FontShadow" +---|"Game52Font_Shadow2" +---|"Game58Font_Shadow2" +---|"Game60Font" +---|"Game69Font_Shadow2" +---|"Game72Font" +---|"Game72Font_Shadow" +---|"GameFont72Highlight" +---|"GameFont72HighlightShadow" +---|"GameFont72Normal" +---|"GameFont72NormalShadow" +---|"GameFont_Gigantic" +---|"GameFontBlack" +---|"GameFontBlackMedium" +---|"GameFontBlackSmall" +---|"GameFontBlackSmall2" +---|"GameFontBlackTiny" +---|"GameFontBlackTiny2" +---|"GameFontDarkGraySmall" +---|"GameFontDisable" +---|"GameFontDisableHuge" +---|"GameFontDisableLarge" +---|"GameFontDisableLeft" +---|"GameFontDisableMed2" +---|"GameFontDisableMed3" +---|"GameFontDisableOutline22" +---|"GameFontDisableSmall" +---|"GameFontDisableSmall2" +---|"GameFontDisableSmallLeft" +---|"GameFontDisableTiny" +---|"GameFontDisableTiny2" +---|"GameFontGreen" +---|"GameFontGreenLarge" +---|"GameFontGreenSmall" +---|"GameFontHighlight" +---|"GameFontHighlightCenter" +---|"GameFontHighlightExtraSmall" +---|"GameFontHighlightExtraSmallLeft" +---|"GameFontHighlightExtraSmallLeftTop" +---|"GameFontHighlightHuge" +---|"GameFontHighlightHuge2" +---|"GameFontHighlightLarge" +---|"GameFontHighlightLarge2" +---|"GameFontHighlightLeft" +---|"GameFontHighlightMed2" +---|"GameFontHighlightMedium" +---|"GameFontHighlightOutline" +---|"GameFontHighlightOutline22" +---|"GameFontHighlightRight" +---|"GameFontHighlightShadowHuge2" +---|"GameFontHighlightShadowOutline22" +---|"GameFontHighlightSmall" +---|"GameFontHighlightSmall2" +---|"GameFontHighlightSmallLeft" +---|"GameFontHighlightSmallLeftTop" +---|"GameFontHighlightSmallOutline" +---|"GameFontHighlightSmallRight" +---|"GameFontNormal" +---|"GameFontNormal_NoShadow" +---|"GameFontNormalCenter" +---|"GameFontNormalGraySmall" +---|"GameFontNormalHuge" +---|"GameFontNormalHuge2" +---|"GameFontNormalHuge3" +---|"GameFontNormalHuge3Outline" +---|"GameFontNormalHuge4" +---|"GameFontNormalHuge4Outline" +---|"GameFontNormalHugeBlack" +---|"GameFontNormalHugeOutline" +---|"GameFontNormalLarge" +---|"GameFontNormalLarge2" +---|"GameFontNormalLargeLeft" +---|"GameFontNormalLargeLeftTop" +---|"GameFontNormalLargeOutline" +---|"GameFontNormalLeft" +---|"GameFontNormalLeftBottom" +---|"GameFontNormalLeftGreen" +---|"GameFontNormalLeftGrey" +---|"GameFontNormalLeftLightGreen" +---|"GameFontNormalLeftOrange" +---|"GameFontNormalLeftRed" +---|"GameFontNormalLeftYellow" +---|"GameFontNormalMed1" +---|"GameFontNormalMed2" +---|"GameFontNormalMed2Outline" +---|"GameFontNormalMed3" +---|"GameFontNormalMed3Outline" +---|"GameFontNormalOutline" +---|"GameFontNormalOutline22" +---|"GameFontNormalRight" +---|"GameFontNormalShadowHuge2" +---|"GameFontNormalShadowOutline22" +---|"GameFontNormalSmall" +---|"GameFontNormalSmall2" +---|"GameFontNormalSmallBattleNetBlueLeft" +---|"GameFontNormalSmallLeft" +---|"GameFontNormalTiny" +---|"GameFontNormalTiny2" +---|"GameFontNormalWTF2" +---|"GameFontNormalWTF2Outline" +---|"GameFontRed" +---|"GameFontRedLarge" +---|"GameFontRedSmall" +---|"GameFontWhite" +---|"GameFontWhiteSmall" +---|"GameFontWhiteTiny" +---|"GameFontWhiteTiny2" +---|"GameNormalNumberFont" +---|"GameTooltipHeader" +---|"GameTooltipHeaderText" +---|"GameTooltipText" +---|"GameTooltipTextSmall" +---|"IMEHighlight" +---|"IMENormal" +---|"InvoiceFont_Med" +---|"InvoiceFont_Small" +---|"InvoiceTextFontNormal" +---|"InvoiceTextFontSmall" +---|"ItemTextFontNormal" +---|"MailFont_Large" +---|"MailTextFontNormal" +---|"MissionCombatTextFontOutline" +---|"MovieSubtitleFont" +---|"NewSubSpellFont" +---|"Number11Font" +---|"Number11FontWhite" +---|"Number12Font" +---|"Number12Font_o1" +---|"Number13Font" +---|"Number13FontGray" +---|"Number13FontRed" +---|"Number13FontWhite" +---|"Number13FontYellow" +---|"Number14FontGray" +---|"Number14FontGreen" +---|"Number14FontRed" +---|"Number14FontWhite" +---|"Number15Font" +---|"Number15FontWhite" +---|"Number16Font" +---|"Number18Font" +---|"Number18FontWhite" +---|"NumberFont_GameNormal" +---|"NumberFont_Normal_Med" +---|"NumberFont_Outline_Huge" +---|"NumberFont_Outline_Large" +---|"NumberFont_Outline_Med" +---|"NumberFont_OutlineThick_Mono_Small" +---|"NumberFont_Shadow_Large" +---|"NumberFont_Shadow_Med" +---|"NumberFont_Shadow_Small" +---|"NumberFont_Shadow_Tiny" +---|"NumberFont_Small" +---|"NumberFontNormal" +---|"NumberFontNormalGray" +---|"NumberFontNormalHuge" +---|"NumberFontNormalLarge" +---|"NumberFontNormalLargeRight" +---|"NumberFontNormalLargeRightGray" +---|"NumberFontNormalLargeRightRed" +---|"NumberFontNormalLargeRightYellow" +---|"NumberFontNormalLargeYellow" +---|"NumberFontNormalRight" +---|"NumberFontNormalRightGray" +---|"NumberFontNormalRightGreen" +---|"NumberFontNormalRightRed" +---|"NumberFontNormalRightYellow" +---|"NumberFontNormalSmall" +---|"NumberFontNormalSmallGray" +---|"NumberFontNormalYellow" +---|"NumberFontSmallBattleNetBlueLeft" +---|"NumberFontSmallWhiteLeft" +---|"NumberFontSmallYellowLeft" +---|"ObjectiveFont" +---|"OptionsFontHighlight" +---|"OptionsFontHighlightSmall" +---|"OptionsFontLarge" +---|"OptionsFontLeft" +---|"OptionsFontSmall" +---|"OptionsFontSmallLeft" +---|"PriceFont" +---|"PriceFontGray" +---|"PriceFontGreen" +---|"PriceFontRed" +---|"PriceFontWhite" +---|"PriceFontYellow" +---|"PVPInfoTextFont" +---|"QuestDifficulty_Difficult" +---|"QuestDifficulty_Header" +---|"QuestDifficulty_Impossible" +---|"QuestDifficulty_Standard" +---|"QuestDifficulty_Trivial" +---|"QuestDifficulty_VeryDifficult" +---|"QuestFont" +---|"QuestFont_30" +---|"QuestFont_39" +---|"QuestFont_Enormous" +---|"QuestFont_Huge" +---|"QuestFont_Large" +---|"QuestFont_Outline_Huge" +---|"QuestFont_Shadow_Enormous" +---|"QuestFont_Shadow_Huge" +---|"QuestFont_Shadow_Small" +---|"QuestFont_Shadow_Super_Huge" +---|"QuestFont_Super_Huge" +---|"QuestFont_Super_Huge_Outline" +---|"QuestFontHighlightHuge" +---|"QuestFontLeft" +---|"QuestFontNormalHuge" +---|"QuestFontNormalLarge" +---|"QuestFontNormalSmall" +---|"QuestMapRewardsFont" +---|"QuestTitleFont" +---|"QuestTitleFontBlackShadow" +---|"ReputationDetailFont" +---|"SpellFont_Small" +---|"SplashHeaderFont" +---|"SubSpellFont" +---|"SubZoneTextFont" +---|"System15Font" +---|"System_IME" +---|"SystemFont22_Outline" +---|"SystemFont22_Shadow_Outline" +---|"SystemFont_Huge1" +---|"SystemFont_Huge1_Outline" +---|"SystemFont_Huge2" +---|"SystemFont_Huge4" +---|"SystemFont_InverseShadow_Small" +---|"SystemFont_Large" +---|"SystemFont_LargeNamePlate" +---|"SystemFont_LargeNamePlateFixed" +---|"SystemFont_Med1" +---|"SystemFont_Med2" +---|"SystemFont_Med3" +---|"SystemFont_NamePlate" +---|"SystemFont_NamePlateCastBar" +---|"SystemFont_NamePlateFixed" +---|"SystemFont_Outline" +---|"SystemFont_Outline_Small" +---|"SystemFont_Outline_WTF2" +---|"SystemFont_OutlineThick_Huge2" +---|"SystemFont_OutlineThick_Huge4" +---|"SystemFont_OutlineThick_WTF" +---|"SystemFont_Shadow_Huge1" +---|"SystemFont_Shadow_Huge2" +---|"SystemFont_Shadow_Huge2_Outline" +---|"SystemFont_Shadow_Huge3" +---|"SystemFont_Shadow_Huge4" +---|"SystemFont_Shadow_Huge4_Outline" +---|"SystemFont_Shadow_Large" +---|"SystemFont_Shadow_Large2" +---|"SystemFont_Shadow_Large_Outline" +---|"SystemFont_Shadow_Med1" +---|"SystemFont_Shadow_Med1_Outline" +---|"SystemFont_Shadow_Med2" +---|"SystemFont_Shadow_Med2_Outline" +---|"SystemFont_Shadow_Med3" +---|"SystemFont_Shadow_Med3_Outline" +---|"SystemFont_Shadow_Outline_Huge3" +---|"SystemFont_Shadow_Small" +---|"SystemFont_Shadow_Small2" +---|"SystemFont_Small" +---|"SystemFont_Small2" +---|"SystemFont_Tiny" +---|"SystemFont_Tiny2" +---|"SystemFont_World" +---|"SystemFont_World_ThickOutline" +---|"SystemFont_WTF2" +---|"TextStatusBarText" +---|"TextStatusBarTextLarge" +---|"Tooltip_Med" +---|"Tooltip_Small" +---|"VehicleMenuBarStatusBarText" +---|"WhiteNormalNumberFont" +---|"WorldMapTextFont" +---|"ZoneTextFont" + +AchievementCriteriaFont = CreateFont("AchievementCriteriaFont") +AchievementDateFont = CreateFont("AchievementDateFont") +AchievementDescriptionFont = CreateFont("AchievementDescriptionFont") +AchievementFont_Small = CreateFont("AchievementFont_Small") +AchievementPointsFont = CreateFont("AchievementPointsFont") +AchievementPointsFontSmall = CreateFont("AchievementPointsFontSmall") +ArtifactAppearanceSetHighlightFont = CreateFont("ArtifactAppearanceSetHighlightFont") +ArtifactAppearanceSetNormalFont = CreateFont("ArtifactAppearanceSetNormalFont") +BossEmoteNormalHuge = CreateFont("BossEmoteNormalHuge") +ChatBubbleFont = CreateFont("ChatBubbleFont") +ChatFontNormal = CreateFont("ChatFontNormal") +ChatFontSmall = CreateFont("ChatFontSmall") +CombatLogFont = CreateFont("CombatLogFont") +CombatTextFont = CreateFont("CombatTextFont") +CombatTextFontOutline = CreateFont("CombatTextFontOutline") +CommentatorCCFont = CreateFont("CommentatorCCFont") +CommentatorDampeningFont = CreateFont("CommentatorDampeningFont") +CommentatorFontMedium = CreateFont("CommentatorFontMedium") +CommentatorFontSmall = CreateFont("CommentatorFontSmall") +CommentatorTeamNameFont = CreateFont("CommentatorTeamNameFont") +CommentatorTeamScoreFont = CreateFont("CommentatorTeamScoreFont") +CommentatorVictoryFanfare = CreateFont("CommentatorVictoryFanfare") +CommentatorVictoryFanfareTeam = CreateFont("CommentatorVictoryFanfareTeam") +ConsoleFontNormal = CreateFont("ConsoleFontNormal") +ConsoleFontSmall = CreateFont("ConsoleFontSmall") +CoreAbilityFont = CreateFont("CoreAbilityFont") +DestinyFontHuge = CreateFont("DestinyFontHuge") +DestinyFontLarge = CreateFont("DestinyFontLarge") +DestinyFontMed = CreateFont("DestinyFontMed") +DialogButtonHighlightText = CreateFont("DialogButtonHighlightText") +DialogButtonNormalText = CreateFont("DialogButtonNormalText") +ErrorFont = CreateFont("ErrorFont") +Fancy12Font = CreateFont("Fancy12Font") +Fancy14Font = CreateFont("Fancy14Font") +Fancy16Font = CreateFont("Fancy16Font") +Fancy18Font = CreateFont("Fancy18Font") +Fancy20Font = CreateFont("Fancy20Font") +Fancy22Font = CreateFont("Fancy22Font") +Fancy24Font = CreateFont("Fancy24Font") +Fancy27Font = CreateFont("Fancy27Font") +Fancy30Font = CreateFont("Fancy30Font") +Fancy32Font = CreateFont("Fancy32Font") +Fancy48Font = CreateFont("Fancy48Font") +FocusFontSmall = CreateFont("FocusFontSmall") +FriendsFont_11 = CreateFont("FriendsFont_11") +FriendsFont_Large = CreateFont("FriendsFont_Large") +FriendsFont_Normal = CreateFont("FriendsFont_Normal") +FriendsFont_Small = CreateFont("FriendsFont_Small") +FriendsFont_UserText = CreateFont("FriendsFont_UserText") +Game10Font_o1 = CreateFont("Game10Font_o1") +Game11Font = CreateFont("Game11Font") +Game11Font_o1 = CreateFont("Game11Font_o1") +Game11Font_Shadow = CreateFont("Game11Font_Shadow") +Game120Font = CreateFont("Game120Font") +Game12Font = CreateFont("Game12Font") +Game12Font_o1 = CreateFont("Game12Font_o1") +Game13Font = CreateFont("Game13Font") +Game13Font_o1 = CreateFont("Game13Font_o1") +Game13FontShadow = CreateFont("Game13FontShadow") +Game15Font = CreateFont("Game15Font") +Game15Font_o1 = CreateFont("Game15Font_o1") +Game16Font = CreateFont("Game16Font") +Game17Font_Shadow = CreateFont("Game17Font_Shadow") +Game18Font = CreateFont("Game18Font") +Game20Font = CreateFont("Game20Font") +Game24Font = CreateFont("Game24Font") +Game27Font = CreateFont("Game27Font") +Game30Font = CreateFont("Game30Font") +Game32Font = CreateFont("Game32Font") +Game32Font_Shadow2 = CreateFont("Game32Font_Shadow2") +Game36Font = CreateFont("Game36Font") +Game36Font_Shadow2 = CreateFont("Game36Font_Shadow2") +Game40Font = CreateFont("Game40Font") +Game40Font_Shadow2 = CreateFont("Game40Font_Shadow2") +Game42Font = CreateFont("Game42Font") +Game46Font = CreateFont("Game46Font") +Game46Font_Shadow2 = CreateFont("Game46Font_Shadow2") +Game48Font = CreateFont("Game48Font") +Game48FontShadow = CreateFont("Game48FontShadow") +Game52Font_Shadow2 = CreateFont("Game52Font_Shadow2") +Game58Font_Shadow2 = CreateFont("Game58Font_Shadow2") +Game60Font = CreateFont("Game60Font") +Game69Font_Shadow2 = CreateFont("Game69Font_Shadow2") +Game72Font = CreateFont("Game72Font") +Game72Font_Shadow = CreateFont("Game72Font_Shadow") +GameFont72Highlight = CreateFont("GameFont72Highlight") +GameFont72HighlightShadow = CreateFont("GameFont72HighlightShadow") +GameFont72Normal = CreateFont("GameFont72Normal") +GameFont72NormalShadow = CreateFont("GameFont72NormalShadow") +GameFont_Gigantic = CreateFont("GameFont_Gigantic") +GameFontBlack = CreateFont("GameFontBlack") +GameFontBlackMedium = CreateFont("GameFontBlackMedium") +GameFontBlackSmall = CreateFont("GameFontBlackSmall") +GameFontBlackSmall2 = CreateFont("GameFontBlackSmall2") +GameFontBlackTiny = CreateFont("GameFontBlackTiny") +GameFontBlackTiny2 = CreateFont("GameFontBlackTiny2") +GameFontDarkGraySmall = CreateFont("GameFontDarkGraySmall") +GameFontDisable = CreateFont("GameFontDisable") +GameFontDisableHuge = CreateFont("GameFontDisableHuge") +GameFontDisableLarge = CreateFont("GameFontDisableLarge") +GameFontDisableLeft = CreateFont("GameFontDisableLeft") +GameFontDisableMed2 = CreateFont("GameFontDisableMed2") +GameFontDisableMed3 = CreateFont("GameFontDisableMed3") +GameFontDisableOutline22 = CreateFont("GameFontDisableOutline22") +GameFontDisableSmall = CreateFont("GameFontDisableSmall") +GameFontDisableSmall2 = CreateFont("GameFontDisableSmall2") +GameFontDisableSmallLeft = CreateFont("GameFontDisableSmallLeft") +GameFontDisableTiny = CreateFont("GameFontDisableTiny") +GameFontDisableTiny2 = CreateFont("GameFontDisableTiny2") +GameFontGreen = CreateFont("GameFontGreen") +GameFontGreenLarge = CreateFont("GameFontGreenLarge") +GameFontGreenSmall = CreateFont("GameFontGreenSmall") +GameFontHighlight = CreateFont("GameFontHighlight") +GameFontHighlightCenter = CreateFont("GameFontHighlightCenter") +GameFontHighlightExtraSmall = CreateFont("GameFontHighlightExtraSmall") +GameFontHighlightExtraSmallLeft = CreateFont("GameFontHighlightExtraSmallLeft") +GameFontHighlightExtraSmallLeftTop = CreateFont("GameFontHighlightExtraSmallLeftTop") +GameFontHighlightHuge = CreateFont("GameFontHighlightHuge") +GameFontHighlightHuge2 = CreateFont("GameFontHighlightHuge2") +GameFontHighlightLarge = CreateFont("GameFontHighlightLarge") +GameFontHighlightLarge2 = CreateFont("GameFontHighlightLarge2") +GameFontHighlightLeft = CreateFont("GameFontHighlightLeft") +GameFontHighlightMed2 = CreateFont("GameFontHighlightMed2") +GameFontHighlightMedium = CreateFont("GameFontHighlightMedium") +GameFontHighlightOutline = CreateFont("GameFontHighlightOutline") +GameFontHighlightOutline22 = CreateFont("GameFontHighlightOutline22") +GameFontHighlightRight = CreateFont("GameFontHighlightRight") +GameFontHighlightShadowHuge2 = CreateFont("GameFontHighlightShadowHuge2") +GameFontHighlightShadowOutline22 = CreateFont("GameFontHighlightShadowOutline22") +GameFontHighlightSmall = CreateFont("GameFontHighlightSmall") +GameFontHighlightSmall2 = CreateFont("GameFontHighlightSmall2") +GameFontHighlightSmallLeft = CreateFont("GameFontHighlightSmallLeft") +GameFontHighlightSmallLeftTop = CreateFont("GameFontHighlightSmallLeftTop") +GameFontHighlightSmallOutline = CreateFont("GameFontHighlightSmallOutline") +GameFontHighlightSmallRight = CreateFont("GameFontHighlightSmallRight") +GameFontNormal = CreateFont("GameFontNormal") +GameFontNormal_NoShadow = CreateFont("GameFontNormal_NoShadow") +GameFontNormalCenter = CreateFont("GameFontNormalCenter") +GameFontNormalGraySmall = CreateFont("GameFontNormalGraySmall") +GameFontNormalHuge = CreateFont("GameFontNormalHuge") +GameFontNormalHuge2 = CreateFont("GameFontNormalHuge2") +GameFontNormalHuge3 = CreateFont("GameFontNormalHuge3") +GameFontNormalHuge3Outline = CreateFont("GameFontNormalHuge3Outline") +GameFontNormalHuge4 = CreateFont("GameFontNormalHuge4") +GameFontNormalHuge4Outline = CreateFont("GameFontNormalHuge4Outline") +GameFontNormalHugeBlack = CreateFont("GameFontNormalHugeBlack") +GameFontNormalHugeOutline = CreateFont("GameFontNormalHugeOutline") +GameFontNormalLarge = CreateFont("GameFontNormalLarge") +GameFontNormalLarge2 = CreateFont("GameFontNormalLarge2") +GameFontNormalLargeLeft = CreateFont("GameFontNormalLargeLeft") +GameFontNormalLargeLeftTop = CreateFont("GameFontNormalLargeLeftTop") +GameFontNormalLargeOutline = CreateFont("GameFontNormalLargeOutline") +GameFontNormalLeft = CreateFont("GameFontNormalLeft") +GameFontNormalLeftBottom = CreateFont("GameFontNormalLeftBottom") +GameFontNormalLeftGreen = CreateFont("GameFontNormalLeftGreen") +GameFontNormalLeftGrey = CreateFont("GameFontNormalLeftGrey") +GameFontNormalLeftLightGreen = CreateFont("GameFontNormalLeftLightGreen") +GameFontNormalLeftOrange = CreateFont("GameFontNormalLeftOrange") +GameFontNormalLeftRed = CreateFont("GameFontNormalLeftRed") +GameFontNormalLeftYellow = CreateFont("GameFontNormalLeftYellow") +GameFontNormalMed1 = CreateFont("GameFontNormalMed1") +GameFontNormalMed2 = CreateFont("GameFontNormalMed2") +GameFontNormalMed2Outline = CreateFont("GameFontNormalMed2Outline") +GameFontNormalMed3 = CreateFont("GameFontNormalMed3") +GameFontNormalMed3Outline = CreateFont("GameFontNormalMed3Outline") +GameFontNormalOutline = CreateFont("GameFontNormalOutline") +GameFontNormalOutline22 = CreateFont("GameFontNormalOutline22") +GameFontNormalRight = CreateFont("GameFontNormalRight") +GameFontNormalShadowHuge2 = CreateFont("GameFontNormalShadowHuge2") +GameFontNormalShadowOutline22 = CreateFont("GameFontNormalShadowOutline22") +GameFontNormalSmall = CreateFont("GameFontNormalSmall") +GameFontNormalSmall2 = CreateFont("GameFontNormalSmall2") +GameFontNormalSmallBattleNetBlueLeft = CreateFont("GameFontNormalSmallBattleNetBlueLeft") +GameFontNormalSmallLeft = CreateFont("GameFontNormalSmallLeft") +GameFontNormalTiny = CreateFont("GameFontNormalTiny") +GameFontNormalTiny2 = CreateFont("GameFontNormalTiny2") +GameFontNormalWTF2 = CreateFont("GameFontNormalWTF2") +GameFontNormalWTF2Outline = CreateFont("GameFontNormalWTF2Outline") +GameFontRed = CreateFont("GameFontRed") +GameFontRedLarge = CreateFont("GameFontRedLarge") +GameFontRedSmall = CreateFont("GameFontRedSmall") +GameFontWhite = CreateFont("GameFontWhite") +GameFontWhiteSmall = CreateFont("GameFontWhiteSmall") +GameFontWhiteTiny = CreateFont("GameFontWhiteTiny") +GameFontWhiteTiny2 = CreateFont("GameFontWhiteTiny2") +GameNormalNumberFont = CreateFont("GameNormalNumberFont") +GameTooltipHeader = CreateFont("GameTooltipHeader") +GameTooltipHeaderText = CreateFont("GameTooltipHeaderText") +GameTooltipText = CreateFont("GameTooltipText") +GameTooltipTextSmall = CreateFont("GameTooltipTextSmall") +IMEHighlight = CreateFont("IMEHighlight") +IMENormal = CreateFont("IMENormal") +InvoiceFont_Med = CreateFont("InvoiceFont_Med") +InvoiceFont_Small = CreateFont("InvoiceFont_Small") +InvoiceTextFontNormal = CreateFont("InvoiceTextFontNormal") +InvoiceTextFontSmall = CreateFont("InvoiceTextFontSmall") +ItemTextFontNormal = CreateFont("ItemTextFontNormal") +MailFont_Large = CreateFont("MailFont_Large") +MailTextFontNormal = CreateFont("MailTextFontNormal") +MissionCombatTextFontOutline = CreateFont("MissionCombatTextFontOutline") +MovieSubtitleFont = CreateFont("MovieSubtitleFont") +NewSubSpellFont = CreateFont("NewSubSpellFont") +Number11Font = CreateFont("Number11Font") +Number11FontWhite = CreateFont("Number11FontWhite") +Number12Font = CreateFont("Number12Font") +Number12Font_o1 = CreateFont("Number12Font_o1") +Number13Font = CreateFont("Number13Font") +Number13FontGray = CreateFont("Number13FontGray") +Number13FontRed = CreateFont("Number13FontRed") +Number13FontWhite = CreateFont("Number13FontWhite") +Number13FontYellow = CreateFont("Number13FontYellow") +Number14FontGray = CreateFont("Number14FontGray") +Number14FontGreen = CreateFont("Number14FontGreen") +Number14FontRed = CreateFont("Number14FontRed") +Number14FontWhite = CreateFont("Number14FontWhite") +Number15Font = CreateFont("Number15Font") +Number15FontWhite = CreateFont("Number15FontWhite") +Number16Font = CreateFont("Number16Font") +Number18Font = CreateFont("Number18Font") +Number18FontWhite = CreateFont("Number18FontWhite") +NumberFont_GameNormal = CreateFont("NumberFont_GameNormal") +NumberFont_Normal_Med = CreateFont("NumberFont_Normal_Med") +NumberFont_Outline_Huge = CreateFont("NumberFont_Outline_Huge") +NumberFont_Outline_Large = CreateFont("NumberFont_Outline_Large") +NumberFont_Outline_Med = CreateFont("NumberFont_Outline_Med") +NumberFont_OutlineThick_Mono_Small = CreateFont("NumberFont_OutlineThick_Mono_Small") +NumberFont_Shadow_Large = CreateFont("NumberFont_Shadow_Large") +NumberFont_Shadow_Med = CreateFont("NumberFont_Shadow_Med") +NumberFont_Shadow_Small = CreateFont("NumberFont_Shadow_Small") +NumberFont_Shadow_Tiny = CreateFont("NumberFont_Shadow_Tiny") +NumberFont_Small = CreateFont("NumberFont_Small") +NumberFontNormal = CreateFont("NumberFontNormal") +NumberFontNormalGray = CreateFont("NumberFontNormalGray") +NumberFontNormalHuge = CreateFont("NumberFontNormalHuge") +NumberFontNormalLarge = CreateFont("NumberFontNormalLarge") +NumberFontNormalLargeRight = CreateFont("NumberFontNormalLargeRight") +NumberFontNormalLargeRightGray = CreateFont("NumberFontNormalLargeRightGray") +NumberFontNormalLargeRightRed = CreateFont("NumberFontNormalLargeRightRed") +NumberFontNormalLargeRightYellow = CreateFont("NumberFontNormalLargeRightYellow") +NumberFontNormalLargeYellow = CreateFont("NumberFontNormalLargeYellow") +NumberFontNormalRight = CreateFont("NumberFontNormalRight") +NumberFontNormalRightGray = CreateFont("NumberFontNormalRightGray") +NumberFontNormalRightGreen = CreateFont("NumberFontNormalRightGreen") +NumberFontNormalRightRed = CreateFont("NumberFontNormalRightRed") +NumberFontNormalRightYellow = CreateFont("NumberFontNormalRightYellow") +NumberFontNormalSmall = CreateFont("NumberFontNormalSmall") +NumberFontNormalSmallGray = CreateFont("NumberFontNormalSmallGray") +NumberFontNormalYellow = CreateFont("NumberFontNormalYellow") +NumberFontSmallBattleNetBlueLeft = CreateFont("NumberFontSmallBattleNetBlueLeft") +NumberFontSmallWhiteLeft = CreateFont("NumberFontSmallWhiteLeft") +NumberFontSmallYellowLeft = CreateFont("NumberFontSmallYellowLeft") +ObjectiveFont = CreateFont("ObjectiveFont") +OptionsFontHighlight = CreateFont("OptionsFontHighlight") +OptionsFontHighlightSmall = CreateFont("OptionsFontHighlightSmall") +OptionsFontLarge = CreateFont("OptionsFontLarge") +OptionsFontLeft = CreateFont("OptionsFontLeft") +OptionsFontSmall = CreateFont("OptionsFontSmall") +OptionsFontSmallLeft = CreateFont("OptionsFontSmallLeft") +PriceFont = CreateFont("PriceFont") +PriceFontGray = CreateFont("PriceFontGray") +PriceFontGreen = CreateFont("PriceFontGreen") +PriceFontRed = CreateFont("PriceFontRed") +PriceFontWhite = CreateFont("PriceFontWhite") +PriceFontYellow = CreateFont("PriceFontYellow") +PVPInfoTextFont = CreateFont("PVPInfoTextFont") +QuestDifficulty_Difficult = CreateFont("QuestDifficulty_Difficult") +QuestDifficulty_Header = CreateFont("QuestDifficulty_Header") +QuestDifficulty_Impossible = CreateFont("QuestDifficulty_Impossible") +QuestDifficulty_Standard = CreateFont("QuestDifficulty_Standard") +QuestDifficulty_Trivial = CreateFont("QuestDifficulty_Trivial") +QuestDifficulty_VeryDifficult = CreateFont("QuestDifficulty_VeryDifficult") +QuestFont = CreateFont("QuestFont") +QuestFont_30 = CreateFont("QuestFont_30") +QuestFont_39 = CreateFont("QuestFont_39") +QuestFont_Enormous = CreateFont("QuestFont_Enormous") +QuestFont_Huge = CreateFont("QuestFont_Huge") +QuestFont_Large = CreateFont("QuestFont_Large") +QuestFont_Outline_Huge = CreateFont("QuestFont_Outline_Huge") +QuestFont_Shadow_Enormous = CreateFont("QuestFont_Shadow_Enormous") +QuestFont_Shadow_Huge = CreateFont("QuestFont_Shadow_Huge") +QuestFont_Shadow_Small = CreateFont("QuestFont_Shadow_Small") +QuestFont_Shadow_Super_Huge = CreateFont("QuestFont_Shadow_Super_Huge") +QuestFont_Super_Huge = CreateFont("QuestFont_Super_Huge") +QuestFont_Super_Huge_Outline = CreateFont("QuestFont_Super_Huge_Outline") +QuestFontHighlightHuge = CreateFont("QuestFontHighlightHuge") +QuestFontLeft = CreateFont("QuestFontLeft") +QuestFontNormalHuge = CreateFont("QuestFontNormalHuge") +QuestFontNormalLarge = CreateFont("QuestFontNormalLarge") +QuestFontNormalSmall = CreateFont("QuestFontNormalSmall") +QuestMapRewardsFont = CreateFont("QuestMapRewardsFont") +QuestTitleFont = CreateFont("QuestTitleFont") +QuestTitleFontBlackShadow = CreateFont("QuestTitleFontBlackShadow") +ReputationDetailFont = CreateFont("ReputationDetailFont") +SpellFont_Small = CreateFont("SpellFont_Small") +SplashHeaderFont = CreateFont("SplashHeaderFont") +SubSpellFont = CreateFont("SubSpellFont") +SubZoneTextFont = CreateFont("SubZoneTextFont") +System15Font = CreateFont("System15Font") +System_IME = CreateFont("System_IME") +SystemFont22_Outline = CreateFont("SystemFont22_Outline") +SystemFont22_Shadow_Outline = CreateFont("SystemFont22_Shadow_Outline") +SystemFont_Huge1 = CreateFont("SystemFont_Huge1") +SystemFont_Huge1_Outline = CreateFont("SystemFont_Huge1_Outline") +SystemFont_Huge2 = CreateFont("SystemFont_Huge2") +SystemFont_Huge4 = CreateFont("SystemFont_Huge4") +SystemFont_InverseShadow_Small = CreateFont("SystemFont_InverseShadow_Small") +SystemFont_Large = CreateFont("SystemFont_Large") +SystemFont_LargeNamePlate = CreateFont("SystemFont_LargeNamePlate") +SystemFont_LargeNamePlateFixed = CreateFont("SystemFont_LargeNamePlateFixed") +SystemFont_Med1 = CreateFont("SystemFont_Med1") +SystemFont_Med2 = CreateFont("SystemFont_Med2") +SystemFont_Med3 = CreateFont("SystemFont_Med3") +SystemFont_NamePlate = CreateFont("SystemFont_NamePlate") +SystemFont_NamePlateCastBar = CreateFont("SystemFont_NamePlateCastBar") +SystemFont_NamePlateFixed = CreateFont("SystemFont_NamePlateFixed") +SystemFont_Outline = CreateFont("SystemFont_Outline") +SystemFont_Outline_Small = CreateFont("SystemFont_Outline_Small") +SystemFont_Outline_WTF2 = CreateFont("SystemFont_Outline_WTF2") +SystemFont_OutlineThick_Huge2 = CreateFont("SystemFont_OutlineThick_Huge2") +SystemFont_OutlineThick_Huge4 = CreateFont("SystemFont_OutlineThick_Huge4") +SystemFont_OutlineThick_WTF = CreateFont("SystemFont_OutlineThick_WTF") +SystemFont_Shadow_Huge1 = CreateFont("SystemFont_Shadow_Huge1") +SystemFont_Shadow_Huge2 = CreateFont("SystemFont_Shadow_Huge2") +SystemFont_Shadow_Huge2_Outline = CreateFont("SystemFont_Shadow_Huge2_Outline") +SystemFont_Shadow_Huge3 = CreateFont("SystemFont_Shadow_Huge3") +SystemFont_Shadow_Huge4 = CreateFont("SystemFont_Shadow_Huge4") +SystemFont_Shadow_Huge4_Outline = CreateFont("SystemFont_Shadow_Huge4_Outline") +SystemFont_Shadow_Large = CreateFont("SystemFont_Shadow_Large") +SystemFont_Shadow_Large2 = CreateFont("SystemFont_Shadow_Large2") +SystemFont_Shadow_Large_Outline = CreateFont("SystemFont_Shadow_Large_Outline") +SystemFont_Shadow_Med1 = CreateFont("SystemFont_Shadow_Med1") +SystemFont_Shadow_Med1_Outline = CreateFont("SystemFont_Shadow_Med1_Outline") +SystemFont_Shadow_Med2 = CreateFont("SystemFont_Shadow_Med2") +SystemFont_Shadow_Med2_Outline = CreateFont("SystemFont_Shadow_Med2_Outline") +SystemFont_Shadow_Med3 = CreateFont("SystemFont_Shadow_Med3") +SystemFont_Shadow_Med3_Outline = CreateFont("SystemFont_Shadow_Med3_Outline") +SystemFont_Shadow_Outline_Huge3 = CreateFont("SystemFont_Shadow_Outline_Huge3") +SystemFont_Shadow_Small = CreateFont("SystemFont_Shadow_Small") +SystemFont_Shadow_Small2 = CreateFont("SystemFont_Shadow_Small2") +SystemFont_Small = CreateFont("SystemFont_Small") +SystemFont_Small2 = CreateFont("SystemFont_Small2") +SystemFont_Tiny = CreateFont("SystemFont_Tiny") +SystemFont_Tiny2 = CreateFont("SystemFont_Tiny2") +SystemFont_World = CreateFont("SystemFont_World") +SystemFont_World_ThickOutline = CreateFont("SystemFont_World_ThickOutline") +SystemFont_WTF2 = CreateFont("SystemFont_WTF2") +TextStatusBarText = CreateFont("TextStatusBarText") +TextStatusBarTextLarge = CreateFont("TextStatusBarTextLarge") +Tooltip_Med = CreateFont("Tooltip_Med") +Tooltip_Small = CreateFont("Tooltip_Small") +VehicleMenuBarStatusBarText = CreateFont("VehicleMenuBarStatusBarText") +WhiteNormalNumberFont = CreateFont("WhiteNormalNumberFont") +WorldMapTextFont = CreateFont("WorldMapTextFont") +ZoneTextFont = CreateFont("ZoneTextFont") diff --git a/docs/annotations/Annotations/Core/Widget/UIType/FrameType.lua b/docs/annotations/Annotations/Core/Widget/UIType/FrameType.lua new file mode 100644 index 0000000..1413c20 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/UIType/FrameType.lua @@ -0,0 +1,74 @@ +---@meta _ +---@alias FrameType +---|"Frame" +---|"ArchaeologyDigSiteFrame" +---|"Browser" +---|"Button" +---|"CheckButton" +---|"Checkout" +---|"CinematicModel" +---|"ColorSelect" +---|"Cooldown" +---|"DressUpModel" +---|"EditBox" +---|"FogOfWarFrame" +---|"GameTooltip" +---|"ItemButton" +---|"MessageFrame" +---|"Model" +---|"ModelScene" +---|"MovieFrame" +---|"OffScreenFrame" +---|"PlayerModel" +---|"QuestPOIFrame" +---|"ScenarioPOIFrame" +---|"ScrollFrame" +---|"ScrollingMessageFrame" +---|"SimpleHTML" +---|"Slider" +---|"StatusBar" +---|"TabardModel" +---|"UnitPositionFrame" +---|"EventFrame" Frame|EventFrameMixin + +---@alias AnimationType +---|"Alpha" +---|"Animation" +---|"FlipBook" +---|"LineScale" +---|"LineTranslation" +---|"Path" +---|"Rotation" +---|"Scale" +---|"Translation" +---|"VertexColor" + +---@alias ChatBubbleFrame Frame +---@alias CooldownFrame Cooldown +---@alias CScriptObject Object +---@alias ModelSceneFrame ModelScene +---@alias ModelSceneFrameActor ModelSceneActor +---@alias SimpleAnim Animation +---@alias SimpleAnimAlpha Alpha +---@alias SimpleAnimFlipBook FlipBook +---@alias SimpleAnimGroup AnimationGroup +---@alias SimpleAnimPath Path +---@alias SimpleAnimRotation Rotation +---@alias SimpleAnimScale Scale +---@alias SimpleAnimScaleLine LineScale +---@alias SimpleAnimTextureCoordTranslation TextureCoordTranslation +---@alias SimpleAnimTranslation Translation +---@alias SimpleAnimTranslationLine LineTranslation +---@alias SimpleAnimVertexColor VertexColor +---@alias SimpleCheckbox CheckButton +---@alias SimpleControlPoint ControlPoint +---@alias SimpleFont Font +---@alias SimpleFontString FontString +---@alias SimpleFrame Frame +---@alias SimpleLine Line +---@alias SimpleMaskTexture MaskTexture +---@alias SimplePathAnim Path +---@alias SimpleRegion Region +---@alias SimpleTexture Texture +---@alias SimpleWindow table +---@alias Tooltip GameTooltip diff --git a/docs/annotations/Annotations/Core/Widget/UIType/ScriptType.lua b/docs/annotations/Annotations/Core/Widget/UIType/ScriptType.lua new file mode 100644 index 0000000..05d9125 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/UIType/ScriptType.lua @@ -0,0 +1,101 @@ +---@meta _ +---@alias ScriptType string +---|"OnLoad" # ScriptObject +---|"OnUpdate" # ScriptObject +---@alias ScriptAnimation ScriptType | "OnFinished" | "OnPause" | "OnPlay" | "OnStop" +---@alias ScriptAnimationGroup ScriptType | "OnFinished" | "OnPause" | "OnPlay" | "OnStop" | "OnLoop" +---@alias ScriptFrame ScriptType +---|"OnAttributeChanged" # Frame +---|"OnChar" # Frame +---|"OnDisable" # Frame +---|"OnDragStart" # Frame +---|"OnDragStop" # Frame +---|"OnEnable" # Frame +---|"OnEnter" # Frame +---|"OnEvent" # Frame +---|"OnGamePadButtonDown" # Frame +---|"OnGamePadButtonUp" # Frame +---|"OnGamePadStick" # Frame +---|"OnHide" # Frame +---|"OnHyperlinkClick" # Frame +---|"OnHyperlinkEnter" # Frame +---|"OnHyperlinkLeave" # Frame +---|"OnKeyDown" # Frame +---|"OnKeyUp" # Frame +---|"OnLeave" # Frame +---|"OnMouseDown" # Frame +---|"OnMouseUp" # Frame +---|"OnMouseWheel" # Frame +---|"OnReceiveDrag" # Frame +---|"OnShow" # Frame +---|"OnSizeChanged" # Frame + +---@alias ScriptModel ScriptFrame +---|"OnAnimFinished" # Model +---|"OnAnimStarted" # Model +---|"OnModelLoaded" # Model +---@alias ScriptCinematicModel ScriptModel +---|"OnPanFinished" # CinematicModel +---@alias ScriptDressUpModel ScriptModel +---|"OnDressModel" # DressUpModel +---@alias ScriptModelSceneActor +---|"OnAnimFinished" # ModelSceneActor +---|"OnModelLoaded" # ModelSceneActor +---|"OnModelLoading" # ModelSceneActor +---@alias ScriptButton ScriptFrame +---|"OnClick" # Button +---|"OnDoubleClick" # Button +---|"PostClick" # Button +---|"PreClick" # Button +---@alias ScriptColorSelect ScriptFrame +---|"OnColorSelect" # ColorSelect +---@alias ScriptCooldown ScriptFrame +---|"OnCooldownDone" # Cooldown +---@alias ScriptFogOfWarFrame ScriptFrame +---|"OnUiMapChanged" # FogOfWarFrame +---@alias ScriptMovieFrame ScriptFrame +---|"OnMovieFinished" # MovieFrame +---|"OnMovieHideSubtitle" # MovieFrame +---|"OnMovieShowSubtitle" # MovieFrame +---@alias ScriptScrollFrame ScriptFrame +---|"OnHorizontalScroll" # ScrollFrame +---|"OnScrollRangeChanged" # ScrollFrame +---|"OnVerticalScroll" # ScrollFrame +---@alias ScriptSlider ScriptFrame +---|"OnMinMaxChanged" # Slider +---|"OnValueChanged" # Slider +---@alias ScriptStatusBar ScriptFrame +---|"OnMinMaxChanged" # StatusBar +---|"OnValueChanged" # StatusBar +---@alias ScriptGameTooltip ScriptFrame +---|"OnTooltipAddMoney" # GameTooltip +---|"OnTooltipCleared" # GameTooltip +---|"OnTooltipSetAchievement" # GameTooltip +---|"OnTooltipSetDefaultAnchor" # GameTooltip +---|"OnTooltipSetEquipmentSet" # GameTooltip +---|"OnTooltipSetFramestack" # GameTooltip +---|"OnTooltipSetItem" # GameTooltip +---|"OnTooltipSetQuest" # GameTooltip +---|"OnTooltipSetSpell" # GameTooltip +---|"OnTooltipSetUnit" # GameTooltip + +---@alias ScriptBrowser ScriptFrame | "OnEditFocusGained" | "OnEditFocusLost" | "OnEscapePressed" | "OnButtonUpdate" | "OnError" | "OnExternalLink" +---@alias ScriptCheckout ScriptFrame | "OnEditFocusGained" | "OnEditFocusLost" | "OnEscapePressed" | "OnButtonUpdate" | "OnError" | "OnExternalLink" | "OnRequestNewSize" +---@alias ScriptEditBox ScriptFrame +---|"OnArrowPressed" # EditBox +---|"OnCharComposition" # EditBox +---|"OnCursorChanged" # EditBox +---|"OnEditFocusGained" # EditBox +---|"OnEditFocusLost" # EditBox +---|"OnEnterPressed" # EditBox +---|"OnEscapePressed" # EditBox +---|"OnInputLanguageChanged" # EditBox +---|"OnSpacePressed" # EditBox +---|"OnTabPressed" # EditBox +---|"OnTextChanged" # EditBox +---|"OnTextSet" # EditBox + +---@alias LE_SCRIPT_BINDING_TYPE +---|"LE_SCRIPT_BINDING_TYPE_INTRINSIC_PRECALL" +---|"LE_SCRIPT_BINDING_TYPE_EXTRINSIC" +---|"LE_SCRIPT_BINDING_TYPE_INTRINSIC_POSTCALL" diff --git a/docs/annotations/Annotations/Core/Widget/UIType/Template.lua b/docs/annotations/Annotations/Core/Widget/UIType/Template.lua new file mode 100644 index 0000000..1442f23 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/UIType/Template.lua @@ -0,0 +1,41 @@ +---@meta _ +---@alias Template +---|"ActionButtonTemplate" +---|"AutoCompleteEditBoxTemplate" +---|"BackdropTemplate" +---|"BasicFrameTemplate" +---|"BasicFrameTemplateWithInset" +---|"ButtonFrameTemplate" +---|"CharacterFrameTabButtonTemplate" +---|"ChatConfigCheckButtonTemplate" +---|"CooldownFrameTemplate" +---|"DialogBorderDarkTemplate" +---|"DialogBorderOpaqueTemplate" +---|"FauxScrollFrameTemplate" +---|"GameMenuButtonTemplate" +---|"GameTooltipTemplate" +---|"HybridScrollBarTemplate" +---|"HybridScrollFrameTemplate" +---|"InputBoxTemplate" +---|"InsetFrameTemplate" +---|"InterfaceOptionsCheckButtonTemplate" +---|"OptionsBaseCheckButtonTemplate" +---|"OptionsFrameTabButtonTemplate" +---|"OptionsListButtonTemplate" +---|"OptionsSliderTemplate" +---|"SearchBoxTemplate" +---|"SecureActionButtonTemplate" +---|"SecureHandlerClickTemplate" +---|"SecureHandlerStateTemplate" +---|"SecureUnitButtonTemplate" +---|"UICheckButtonTemplate" +---|"UIDropDownMenuTemplate" +---|"UIMenuButtonStretchTemplate" +---|"UIPanelButtonTemplate" +---|"UIPanelDialogTemplate" +---|"UIPanelScrollBarTemplate" +---|"UIPanelScrollDownButtonTemplate" +---|"UIPanelScrollFrameTemplate" +---|"UIRadioButtonTemplate" +---|"WowScrollBox" +---|"WowScrollBoxList" diff --git a/docs/annotations/Annotations/Core/Widget/UIType/UIType.lua b/docs/annotations/Annotations/Core/Widget/UIType/UIType.lua new file mode 100644 index 0000000..efc22c5 --- /dev/null +++ b/docs/annotations/Annotations/Core/Widget/UIType/UIType.lua @@ -0,0 +1,153 @@ +---@meta _ +---@alias BlendMode +---|"DISABLE" +---|"BLEND" +---|"ALPHAKEY" +---|"ADD" +---|"MOD" + +---@alias CurveType +---|"NONE" +---|"SMOOTH" + +---@alias DrawLayer +---|"BACKGROUND" +---|"BORDER" +---|"ARTWORK" +---|"OVERLAY" +---|"HIGHLIGHT" + +---@alias FilterMode +---|"LINEAR" +---|"TRILINEAR" +---|"NEAREST" + +---@alias FontAlphabet +---|"roman" +---|"korean" +---|"simplifiedchinese" +---|"traditionalchinese" +---|"russian" + +---@alias FramePoint +---|"TOPLEFT" +---|"TOPRIGHT" +---|"BOTTOMLEFT" +---|"BOTTOMRIGHT" +---|"TOP" +---|"BOTTOM" +---|"LEFT" +---|"RIGHT" +---|"CENTER" + +---@alias FrameStrata +---|"PARENT" +---|"BACKGROUND" +---|"LOW" +---|"MEDIUM" +---|"HIGH" +---|"DIALOG" +---|"FULLSCREEN" +---|"FULLSCREEN_DIALOG" +---|"TOOLTIP" +---|"BLIZZARD" + +---@alias InsertMode +---|"TOP" +---|"BOTTOM" + +---@alias JustifyHorizontal +---|"LEFT" +---|"RIGHT" +---|"CENTER" + +---@alias JustifyVertical +---|"TOP" +---|"BOTTOM" +---|"MIDDLE" + +---@alias LoopType +---|"NONE" +---|"REPEAT" +---|"BOUNCE" + +---@alias mouseButton +---|"LeftButton" +---|"RightButton" +---|"MiddleButton" +---|"Button4" +---|"Button5" + +---@alias MouseButton mouseButton + +---@alias ClickButton +---|"AnyUp" +---|"AnyDown" +---|"LeftButtonUp" +---|"LeftButtonDown" +---|"RightButtonUp" +---|"RightButtonDown" +---|"MiddleButtonUp" +---|"MiddleButtonDown" +---|"Button4Up" +---|"Button4Down" +---|"Button5Up" +---|"Button5Down" + +---@alias Orientation +---|"HORIZONTAL" +---|"VERTICAL" + +---@alias SimpleButtonStateToken +---|"DISABLED" +---|"NORMAL" +---|"PUSHED" + +---@alias SmoothingType +---|"NONE" +---|"IN" +---|"OUT" +---|"IN_OUT" +---|"OUT_IN" + +---@alias StatusBarFillStyle +---|"STANDARD" +---|"STANDARD_NO_RANGE_FILL" +---|"CENTER" +---|"REVERSE" + +---@alias TBFFlags +---|"" +---|"MONOCHROME" +---|"OUTLINE" +---|"THICKOUTLINE" +---|"SLUG" + +--- `uiRect` cannot be annotated as a list of numbers +--- it's the same as Model:GetViewInsets/SetViewInsets params + +--------------- +-- custom types +--------------- + +---@alias TooltipAnchor +---|"ANCHOR_TOP" +---|"ANCHOR_RIGHT" +---|"ANCHOR_BOTTOM" +---|"ANCHOR_LEFT" +---|"ANCHOR_TOPRIGHT" +---|"ANCHOR_BOTTOMRIGHT" +---|"ANCHOR_TOPLEFT" +---|"ANCHOR_BOTTOMLEFT" +---|"ANCHOR_CURSOR" +---|"ANCHOR_CURSOR_RIGHT" +---|"ANCHOR_PRESERVE" +---|"ANCHOR_NONE" + +---@alias WrapMode +---|"CLAMP" +---|"REPEAT" +---|"CLAMPTOBLACK" +---|"CLAMPTOBLACKADDITIVE" +---|"CLAMPTOWHITE" +---|"MIRROR" diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/BaseAPIMixin.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/BaseAPIMixin.lua.annotated.lua new file mode 100644 index 0000000..ed67ebf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/BaseAPIMixin.lua.annotated.lua @@ -0,0 +1,108 @@ +BaseAPIMixin = {};--- @class BaseAPIMixin + +function BaseAPIMixin:GetType() + return assert(false); +end + +function BaseAPIMixin:GetPrettyType() + return self:GetType(); +end + +function BaseAPIMixin:GetLinkHexColor() + return "ffffff"; +end + +function BaseAPIMixin:GetName() + return self.Name; +end + +function BaseAPIMixin:GetFullName() + return self:GetName(); +end + +function BaseAPIMixin:GetParentName() + return ""; +end + +function BaseAPIMixin:GetLoweredParentName() + if not self.loweredParentName then + self.loweredParentName = self:GetParentName():lower(); + end + return self.loweredParentName; +end + +function BaseAPIMixin:GetLoweredName() + if not self.loweredName then + self.loweredName = self:GetName():lower(); + end + return self.loweredName; +end + +function BaseAPIMixin:GetClipboardString() + return self:GetFullName(); +end + +function BaseAPIMixin:GenerateAPILink() + return ("|cff%s|Hapi:%s:%s:%s|h%s|h|r"):format(self:GetLinkHexColor(), self:GetType(), self:GetName(), self:GetParentName(), self:GetFullName()); +end + +function BaseAPIMixin:GetSingleOutputLine() + return ("%s %s"):format(self:GetPrettyType(), self:GenerateAPILink()); +end + +function BaseAPIMixin:GetDetailedOutputLines() + return { self:GetSingleOutputLine() }; +end + +function BaseAPIMixin:MatchesSearchString(searchString) + return false; +end + +function BaseAPIMixin:MatchesName(name, parentName) + if name == self:GetName() then + return not parentName or parentName == self:GetParentName(); + end + return false; +end + +function BaseAPIMixin:MatchesNameCaseInsenstive(name, parentName) + if name == self:GetLoweredName() then + return not parentName or parentName == self:GetLoweredParentName(); + end + return false; +end + +function BaseAPIMixin:MatchesAnyAPI(apiTable, searchString) + if apiTable then + for i, apiInfo in ipairs(apiTable) do + if apiInfo:MatchesSearchString(searchString) then + return true; + end + end + end + return false; +end + +function BaseAPIMixin:MatchesAnyDocumentation(searchString) + if self.Documentation then + for i, documentation in ipairs(self.Documentation) do + if documentation:lower():match(searchString) then + return true; + end + end + end +end + +function BaseAPIMixin:AddDocumentationTags(lines) + if self.Documentation then + for i, documentation in ipairs(self.Documentation) do + table.insert(lines, APIDocumentation:GetIndentString() .. documentation); + end + end +end + +function BaseAPIMixin:AddSystemTag(lines) + if self.System then + table.insert(lines, APIDocumentation:GetIndentString() .. ("Part of the %s system"):format(self.System:GenerateAPILink())); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..445e167 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.lua.annotated.lua @@ -0,0 +1,399 @@ +APIDocumentationMixin = {};--- @class APIDocumentationMixin + +-- "public" +function APIDocumentationMixin:OnLoad() + self.tables = {}; + self.functions = {}; + self.systems = {}; + self.fields = {}; + self.events = {}; + self.callbacks = {}; + + self.Commands = { + Default = 1, + CopyAPI = 2, + OpenDump = 3, + }; + + if DEFAULT_CHAT_FRAME then + DEFAULT_CHAT_FRAME:SetMaxLines(2000); + end +end + +function APIDocumentationMixin:HandleSlashCommand(command) + local commands = { (" "):split(command) }; + + if commands[1] == "?" or commands[1] == "help" or commands[1] == "" then + self:OutputUsage(); + elseif commands[1] == "stats" then + self:OutputStats(); + elseif commands[1] == "system" then + if commands[2] == "list" then + self:OutputAllSystems(); + else + self:OutputUsage(); + end + elseif commands[1] == "s" or commands[1] == "search" then + self:OutputAllAPIMatches(unpack(commands, 2)); + elseif commands[1] then + self:TryHandlingSystemSearchCommand(unpack(commands)); + else + self:OutputUsage(); + end +end + +function APIDocumentationMixin:HandleAPILink(link, command) + local _, type, name, parentName = (":"):split(link); + local apiInfo = self:FindAPIByName(type, name, parentName); + if apiInfo then + if command == self.Commands.CopyAPI then + self:HandleCopyAPI(apiInfo); + elseif command == self.Commands.OpenDump then + self:HandleOpenDump(apiInfo); + else + self:HandleDefaultCommand(apiInfo); + end + end +end + +function APIDocumentationMixin:HandleDefaultCommand(apiInfo) + self:WriteLine(" "); + self:WriteAllLines(apiInfo:GetDetailedOutputLines()); +end + +function APIDocumentationMixin:HandleCopyAPI(apiInfo) + local clipboardString = apiInfo:GetClipboardString(); + CopyToClipboard(clipboardString); + self:WriteLineF("Copied to clipboard: %s", clipboardString); +end + +function APIDocumentationMixin:HandleOpenDump(apiInfo) + if apiInfo.Type == "Function" then + local dumpString; + local systemNamespace = apiInfo.System and apiInfo.System:GetNamespaceName() or nil; + if systemNamespace and systemNamespace ~= "" then + dumpString = ("/dump %s.%s()"):format(systemNamespace, apiInfo.Name); + else + dumpString = ("/dump %s()"):format(apiInfo.Name); + end + + local desiredCursorPosition = #dumpString - 1; + ChatFrameUtil.OpenChat(dumpString, nil, desiredCursorPosition); + else + self:WriteLine("Can only /dump functions"); + end +end + +function APIDocumentationMixin:FindAPIByName(apiType, name, parentName) + local apiTable = self:GetAPITableByTypeName(apiType); + if apiTable then + for i, apiInfo in ipairs(apiTable) do + if apiInfo:MatchesName(name, parentName) then + return apiInfo; + end + end + end + return nil; +end + +function APIDocumentationMixin:GetAPITableByTypeName(apiType) + if apiType == "function" then + return self.functions; + elseif apiType == "table" then + return self.tables; + elseif apiType == "system" then + return self.systems; + elseif apiType == "field" then + return self.fields; + elseif apiType == "event" then + return self.events; + elseif apiType == "callback" then + return self.callbacks; + end + return nil; +end + +function APIDocumentationMixin:OutputUsage() + self:WriteLine("Usage:"); + + self:WriteLine("Search for API"); + self:WriteLine(self:GetIndentString() .. "/api search "); + self:WriteLine(self:GetIndentString() .. "or"); + self:WriteLine(self:GetIndentString() .. "/api s "); + self:WriteLine(self:GetIndentString() .. "Example: /api search item"); + self:WriteLine(" "); + + self:WriteLine("List all systems"); + self:WriteLine(self:GetIndentString() .. "/api system list"); + self:WriteLine(" "); + + self:WriteLine("Search system for API"); + self:WriteLine(self:GetIndentString() .. "/api search "); + self:WriteLine(self:GetIndentString() .. "or"); + self:WriteLine(self:GetIndentString() .. "/api s "); + self:WriteLine(self:GetIndentString() .. "Example: /api artifactui search relic"); + self:WriteLine(" "); + + self:WriteLine("List all API in a system"); + self:WriteLine(self:GetIndentString() .. "/api list"); + self:WriteLine(self:GetIndentString() .. "Example: /api artifactui list"); + self:WriteLine(" "); + self:WriteLine("All searches support Lua patterns."); +end + +function APIDocumentationMixin:OutputStats() + self:WriteLine("Stats:"); + self:WriteLineF("Total systems: %d", #self.systems); + local totalFunctions = 0; + local totalEvents = 0; + local totalTables = 0; + + for i, systemInfo in ipairs(self.systems) do + totalFunctions = totalFunctions + systemInfo:GetNumFunctions(); + totalEvents = totalEvents + systemInfo:GetNumEvents(); + totalTables = totalTables + systemInfo:GetNumTables(); + end + + self:WriteLineF("Total functions: %d", totalFunctions); + self:WriteLineF("Total events: %d", totalEvents); + self:WriteLineF("Total tables: %d", totalTables); +end + +function APIDocumentationMixin:OutputAllSystems() + self:WriteLineF("All systems (%d):", #self.systems); + for i, systemInfo in ipairs(self.systems) do + self:WriteLine(systemInfo:GetSingleOutputLine()); + end +end + +function APIDocumentationMixin:TryHandlingSystemSearchCommand(systemName, subCommand, apiToSearchFor) + local system = self:FindSystemByName(systemName); + if system then + if subCommand == nil then + self:WriteLine(system:GetSingleOutputLine()); + elseif subCommand == "s" or subCommand == "search" and apiToSearchFor then + self:OutputAllSystemAPIMatches(system, apiToSearchFor); + elseif subCommand == "list" then + self:OutputAllSystemAPI(system); + else + self:OutputUsage(); + end + else + self:WriteLineF("No system found (%s)", tostring(systemName)); + end +end + +function APIDocumentationMixin:OutputAPIMatches(apiMatches, headerName) + if apiMatches and #apiMatches > 0 then + self:WriteLineF("Found %d %s", #apiMatches, headerName); + for i, api in ipairs(apiMatches) do + self:WriteLine(self:GetIndentString() .. api:GetSingleOutputLine()); + end + end +end + +function APIDocumentationMixin:OutputAllAPIMatches(apiToSearchFor) + if not apiToSearchFor or apiToSearchFor == "" then + self:OutputUsage(); + return; + end + self:WriteLine(" "); + + local apiMatches = self:FindAllAPIMatches(apiToSearchFor); + if apiMatches then + local total = #apiMatches.tables + #apiMatches.functions + #apiMatches.events + #apiMatches.systems + #apiMatches.callbacks; + assert(total > 0); + self:WriteLineF("Found %d API that matches %q", total, apiToSearchFor); + + self:OutputAPIMatches(apiMatches.systems, "system(s)"); + self:OutputAPIMatches(apiMatches.functions, "function(s)"); + self:OutputAPIMatches(apiMatches.events, "events(s)"); + self:OutputAPIMatches(apiMatches.tables, "table(s)"); + self:OutputAPIMatches(apiMatches.callbacks, "callback(s)"); + else + self:WriteLineF("No API found that matches %q", apiToSearchFor); + end +end + +function APIDocumentationMixin:OutputAllSystemAPIMatches(system, apiToSearchFor) + local apiMatches = system:FindAllAPIMatches(apiToSearchFor); + if apiMatches then + local total = #apiMatches.tables + #apiMatches.functions + #apiMatches.events; + assert(total > 0); + self:WriteLineF("Found %d API that matches %q", total, apiToSearchFor); + + self:OutputAPIMatches(apiMatches.functions, "function(s)"); + self:OutputAPIMatches(apiMatches.events, "events(s)"); + self:OutputAPIMatches(apiMatches.tables, "table(s)"); + else + self:WriteLineF("No API found that matches %q in %s", apiToSearchFor, system:GenerateAPILink()); + end +end + +function APIDocumentationMixin:OutputAllSystemAPI(system) + local apiMatches = system:ListAllAPI(); + if apiMatches then + self:WriteLineF("All API in %s", system:GenerateAPILink()); + + self:OutputAPIMatches(apiMatches.functions, "function(s)"); + self:OutputAPIMatches(apiMatches.events, "events(s)"); + self:OutputAPIMatches(apiMatches.tables, "table(s)"); + else + self:WriteLineF("No API found in %s", system:GenerateAPILink()); + end +end + +--[[static]] function APIDocumentationMixin:AddAllMatches(apiContainer, matchesContainer, apiToSearchFor) + for i, apiInfo in ipairs(apiContainer) do + if apiInfo:MatchesSearchString(apiToSearchFor) then + table.insert(matchesContainer, apiInfo); + end + end +end + +function APIDocumentationMixin:FindAllAPIMatches(apiToSearchFor) + apiToSearchFor = apiToSearchFor:lower(); + + local matches = { + tables = {}, + functions = {}, + events = {}, + systems = {}, + callbacks = {}, + }; + + self:AddAllMatches(self.tables, matches.tables, apiToSearchFor); + self:AddAllMatches(self.functions, matches.functions, apiToSearchFor); + self:AddAllMatches(self.systems, matches.systems, apiToSearchFor); + self:AddAllMatches(self.events, matches.events, apiToSearchFor); + self:AddAllMatches(self.callbacks, matches.callbacks, apiToSearchFor); + + -- Only return something if we matched anything + for name, subTable in pairs(matches) do + if #subTable > 0 then + return matches; + end + end + + return nil; +end + +function APIDocumentationMixin:FindSystemByName(systemName) + systemName = systemName:lower(); + for i, systemInfo in ipairs(self.systems) do + if systemInfo:MatchesNameCaseInsenstive(systemName) then + return systemInfo; + end + end + return nil; +end + +function APIDocumentationMixin:AddDocumentationTable(documentationInfo) + if documentationInfo.Name then + self:AddSystem(documentationInfo); + else + for i, tableInfo in ipairs(documentationInfo.Tables) do + self:AddTable(tableInfo); + end + end +end + +function APIDocumentationMixin:WriteLine(message) + if DEFAULT_CHAT_FRAME then + local info = ChatTypeInfo["SYSTEM"]; + DEFAULT_CHAT_FRAME:AddMessage(message, info.r, info.g, info.b, info.id); + else + print(message); + end +end + +function APIDocumentationMixin:WriteLineF(format, ...) + self:WriteLine(format:format(...)); +end + +function APIDocumentationMixin:WriteAllLines(lines) + for i, line in ipairs(lines) do + self:WriteLine(line); + end +end + +function APIDocumentationMixin:GetIndentString(numIndent) + return (" "):rep(numIndent or 1); +end + +-- "private" +function APIDocumentationMixin:AddTable(documentationInfo) + Mixin(documentationInfo, TablesAPIMixin); + + table.insert(self.tables, documentationInfo); + + if documentationInfo.Fields then + for i, field in ipairs(documentationInfo.Fields) do + field.Table = documentationInfo; + self:AddField(field); + end + end +end + +function APIDocumentationMixin:AddFunction(documentationInfo) + Mixin(documentationInfo, FunctionsAPIMixin); + + table.insert(self.functions, documentationInfo); + + if documentationInfo.Arguments then + for i, field in ipairs(documentationInfo.Arguments) do + field.Function = documentationInfo; + self:AddField(field); + end + end + + if documentationInfo.Returns then + for i, field in ipairs(documentationInfo.Returns) do + field.Function = documentationInfo; + self:AddField(field); + end + end +end + +function APIDocumentationMixin:AddEvent(documentationInfo) + Mixin(documentationInfo, EventsAPIMixin); + + table.insert(self.events, documentationInfo); + + if documentationInfo.Payload then + for i, field in ipairs(documentationInfo.Payload) do + field.Event = documentationInfo; + self:AddField(field); + end + end +end + +function APIDocumentationMixin:AddField(documentationInfo) + Mixin(documentationInfo, FieldsAPIMixin); + + table.insert(self.fields, documentationInfo); +end + +function APIDocumentationMixin:AddSystem(documentationInfo) + Mixin(documentationInfo, SystemsAPIMixin); + + table.insert(self.systems, documentationInfo); + + for i, functionInfo in ipairs(documentationInfo.Functions) do + functionInfo.System = documentationInfo; + self:AddFunction(functionInfo); + end + + for i, eventInfo in ipairs(documentationInfo.Events) do + eventInfo.System = documentationInfo; + self:AddEvent(eventInfo); + end + + for i, tableInfo in ipairs(documentationInfo.Tables) do + tableInfo.System = documentationInfo; + self:AddTable(tableInfo); + end +end + +APIDocumentation = CreateFromMixins(APIDocumentationMixin); +APIDocumentation:OnLoad(); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.toc new file mode 100644 index 0000000..35ebeac --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/Blizzard_APIDocumentation.toc @@ -0,0 +1,12 @@ +## Title: Blizzard API Documentation +## Author: Blizzard Entertainment +## LoadOnDemand: 1 +## AllowLoad: Both + +BaseAPIMixin.lua +FieldsAPIMixin.lua +FunctionsAPIMixin.lua +SystemsAPIMixin.lua +TablesAPIMixin.lua +EventsAPIMixin.lua +Blizzard_APIDocumentation.lua diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/EventsAPIMixin.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/EventsAPIMixin.lua.annotated.lua new file mode 100644 index 0000000..1ea057c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/EventsAPIMixin.lua.annotated.lua @@ -0,0 +1,90 @@ +EventsAPIMixin = CreateFromMixins(BaseAPIMixin);--- @class EventsAPIMixin : BaseAPIMixin + +function EventsAPIMixin:GetParentName() -- override + if self.System then + return self.System:GetName(); + end + + return ""; +end + +function EventsAPIMixin:GetType() -- override + return "event"; +end + +function EventsAPIMixin:GetLinkHexColor() + return "77ff22"; +end + +function EventsAPIMixin:GetClipboardString() + local lines = {}; + table.insert(lines, ([[if event == "%s" then]]):format(self.LiteralName)); + table.insert(lines, ("\tlocal %s = ...;"):format(self:GetPayloadString(false, false))); + table.insert(lines, "end"); + return table.concat(lines, "\r\n"); +end + +function EventsAPIMixin:GetFullName(decorateOptionals, includeColorCodes) -- override + if self.System then + return ("Event.%s.%s -> %s"):format(self.System:GetName(), self:GetName(), self:GetPayloadString(decorateOptionals, includeColorCodes)); + end + return ("Event.%s -> %s"):format(self:GetName(), self:GetPayloadString(decorateOptionals, includeColorCodes)); +end + +function EventsAPIMixin:MatchesSearchString(searchString) -- override + if self:GetLoweredName():match(searchString) then + return true; + end + + if self.System and self.System:GetLoweredName():match(searchString) then + return true; + end + + if self.LiteralName:lower():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + if self:MatchesAnyAPI(self.Payload, searchString) then + return true + end + + return false; +end + +function EventsAPIMixin:GetPayloadString(decorateOptionals, includeColorCodes) -- override + if self.Payload then + local values = {}; + for i, payloadInfo in ipairs(self.Payload) do + if includeColorCodes ~= false then + table.insert(values, ("%s|cff%s"):format(payloadInfo:GetPayloadString(decorateOptionals, includeColorCodes), self:GetLinkHexColor())); + else + table.insert(values, payloadInfo:GetPayloadString(decorateOptionals, includeColorCodes)); + end + end + return table.concat(values, ", "); + end + return ""; +end + +function EventsAPIMixin:GetDetailedOutputLines() -- override + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddSystemTag(lines); + self:AddDocumentationTags(lines); + + table.insert(lines, APIDocumentation:GetIndentString() .. "Literal Name: \"" .. self.LiteralName .. "\""); + + if self.Payload then + table.insert(lines, APIDocumentation:GetIndentString() .. "Payload"); + for i, payloadInfo in ipairs(self.Payload) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. ("%d. %s"):format(i, payloadInfo:GetSingleOutputLine())); + end + end + + return lines; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FieldsAPIMixin.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FieldsAPIMixin.lua.annotated.lua new file mode 100644 index 0000000..608d8d1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FieldsAPIMixin.lua.annotated.lua @@ -0,0 +1,85 @@ +FieldsAPIMixin = CreateFromMixins(BaseAPIMixin);--- @class FieldsAPIMixin : BaseAPIMixin + +function FieldsAPIMixin:GetParentName() + if self.Function then + return self.Function:GetName(); + end + + if self.Table then + return self.Table:GetName(); + end + return ""; +end + +function FieldsAPIMixin:GetType() + return "field"; +end + +function FieldsAPIMixin:GetLinkHexColor() + return "ffdd55"; +end + +function FieldsAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + return false; +end + +function FieldsAPIMixin:GetLuaType() + if self.InnerType then + local complexType = APIDocumentation:FindAPIByName("table", self.InnerType); + return ("%s of %s"):format(self.Type, complexType and complexType:GenerateAPILink() or self.InnerType) + end + + if self.EnumValue then + return self.EnumValue; + end + + local complexType = APIDocumentation:FindAPIByName("table", self.Type); + return complexType and complexType:GenerateAPILink() or self.Type; +end + +function FieldsAPIMixin:GetStrideIndex() + return self.StrideIndex; +end + +function FieldsAPIMixin:IsOptional() + return self.Default ~= nil or self.Nilable; +end + +function FieldsAPIMixin:GetSingleOutputLine() + local optionalString = ""; + if self:IsOptional() then + if self.Default ~= nil then + optionalString = ("(default:%s) "):format(tostring(self.Default)); + else + optionalString = "(optional) "; + end + end + if self.Documentation then + return ("%s%s %s - %s"):format(optionalString, self:GetLuaType(), self:GenerateAPILink(), table.concat(self.Documentation, " ")); + end + return ("%s%s %s"):format(optionalString, self:GetLuaType(), self:GenerateAPILink()); +end + +function FieldsAPIMixin:GetArgumentString(decorateOptionals, includeColorCodes) + local prefix = decorateOptionals ~= false and self:IsOptional() and "optional " or ""; + if includeColorCodes ~= false then + return ("|cff%s%s%s|r"):format(self:GetLinkHexColor(), prefix, self:GetName()); + end + return ("%s%s"):format(prefix, self:GetName()); +end + +function FieldsAPIMixin:GetReturnString(decorateOptionals, includeColorCodes) + return self:GetArgumentString(decorateOptionals, includeColorCodes); -- Nothing special currently +end + +function FieldsAPIMixin:GetPayloadString(decorateOptionals, includeColorCodes) + return self:GetReturnString(decorateOptionals, includeColorCodes); -- Nothing special currently +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FunctionsAPIMixin.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FunctionsAPIMixin.lua.annotated.lua new file mode 100644 index 0000000..66f2789 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/FunctionsAPIMixin.lua.annotated.lua @@ -0,0 +1,112 @@ +FunctionsAPIMixin = CreateFromMixins(BaseAPIMixin);--- @class FunctionsAPIMixin : BaseAPIMixin + +function FunctionsAPIMixin:GetParentName() + if self.System then + return self.System:GetName(); + end + + return ""; +end + +function FunctionsAPIMixin:GetType() + return "function"; +end + +function FunctionsAPIMixin:GetLinkHexColor() + return "55ddff"; +end + +function FunctionsAPIMixin:GetFullName(decorateOptionals, includeColorCodes) + if self.System and self.System:GetNamespaceName() ~= "" then + return ("%s.%s(%s)"):format(self.System:GetNamespaceName(), self:GetName(), self:GetArgumentString(decorateOptionals, includeColorCodes)); + end + return ("%s(%s)"):format(self:GetName(), self:GetArgumentString(decorateOptionals, includeColorCodes)); +end + +function FunctionsAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + if self:MatchesAnyAPI(self.Arguments, searchString) then + return true + end + + if self:MatchesAnyAPI(self.Returns, searchString) then + return true + end + + return false; +end + +function FunctionsAPIMixin:GetArgumentString(decorateOptionals, includeColorCodes) + if self.Arguments then + local values = {}; + for i, argumentInfo in ipairs(self.Arguments) do + if includeColorCodes ~= false then + table.insert(values, ("%s|cff%s"):format(argumentInfo:GetArgumentString(decorateOptionals, includeColorCodes), self:GetLinkHexColor())); + else + table.insert(values, argumentInfo:GetArgumentString(decorateOptionals, includeColorCodes)); + end + end + return table.concat(values, ", "); + end + return ""; +end + +function FunctionsAPIMixin:GetReturnString(decorateOptionals, includeColorCodes) + if self.Returns then + local values = {}; + for i, returnInfo in ipairs(self.Returns) do + if includeColorCodes ~= false then + table.insert(values, ("%s|cff%s"):format(returnInfo:GetReturnString(decorateOptionals, includeColorCodes), self:GetLinkHexColor())); + else + table.insert(values, returnInfo:GetReturnString(decorateOptionals, includeColorCodes)); + end + end + return table.concat(values, ", "); + end + return ""; +end + +function FunctionsAPIMixin:GetClipboardString() + if self.Returns then + return ("local %s = %s"):format(self:GetReturnString(false, false), self:GetFullName(false, false)); + end + return self:GetFullName(false, false); +end + +function FunctionsAPIMixin:GetDetailedOutputLines() + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddSystemTag(lines); + self:AddDocumentationTags(lines); + + if self.Arguments then + table.insert(lines, APIDocumentation:GetIndentString() .. "Arguments"); + for i, argumentInfo in ipairs(self.Arguments) do + if argumentInfo:GetStrideIndex() == 1 then + table.insert(lines, APIDocumentation:GetIndentString(2) .. "(Variable arguments)"); + end + + table.insert(lines, APIDocumentation:GetIndentString(2) .. ("%d. %s"):format(i, argumentInfo:GetSingleOutputLine())); + end + end + + if self.Returns then + table.insert(lines, APIDocumentation:GetIndentString() .. "Returns"); + for i, returnInfo in ipairs(self.Returns) do + if returnInfo:GetStrideIndex() == 1 then + table.insert(lines, APIDocumentation:GetIndentString(2) .. "(Variable returns)"); + end + table.insert(lines, APIDocumentation:GetIndentString(2) .. ("%d. %s"):format(i, returnInfo:GetSingleOutputLine())); + end + end + + return lines; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/SystemsAPIMixin.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/SystemsAPIMixin.lua.annotated.lua new file mode 100644 index 0000000..09febab --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/SystemsAPIMixin.lua.annotated.lua @@ -0,0 +1,142 @@ +SystemsAPIMixin = CreateFromMixins(BaseAPIMixin);--- @class SystemsAPIMixin : BaseAPIMixin + +function SystemsAPIMixin:GetType() + return "system"; +end + +function SystemsAPIMixin:GetLinkHexColor() + return "ff55dd"; +end + +function SystemsAPIMixin:GetNamespaceName() + return self.Namespace or ""; +end + +function SystemsAPIMixin:GetLoweredNamespaceName() + if not self.loweredNamespaceName then + self.loweredNamespaceName = self:GetNamespaceName():lower(); + end + return self.loweredNamespaceName; +end + +function SystemsAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + return false; +end + +function SystemsAPIMixin:GetSingleOutputLine() + if self.Namespace then + return ("%s %s (%s)"):format(self:GetPrettyType(), self:GenerateAPILink(), self.Namespace); + end + return BaseAPIMixin.GetSingleOutputLine(self); +end + +function SystemsAPIMixin:GetDetailedOutputLines() + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddDocumentationTags(lines); + + if self.Functions and #self.Functions > 0 then + table.insert(lines, APIDocumentation:GetIndentString() .. "Functions"); + for i, functionInfo in ipairs(self.Functions) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. functionInfo:GetSingleOutputLine()); + end + end + + if self.Events and #self.Events > 0 then + table.insert(lines, APIDocumentation:GetIndentString() .. "Events"); + for i, eventInfo in ipairs(self.Events) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. eventInfo:GetSingleOutputLine()); + end + end + + if self.Tables and #self.Tables > 0 then + table.insert(lines, APIDocumentation:GetIndentString() .. "Tables"); + for i, tableInfo in ipairs(self.Tables) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. tableInfo:GetSingleOutputLine()); + end + end + + return lines; +end + +function SystemsAPIMixin:MatchesName(name, parentName) + if BaseAPIMixin.MatchesName(self, name, parentName) then + return true; + end + + return name == self:GetNamespaceName(); +end + +function SystemsAPIMixin:MatchesNameCaseInsenstive(name, parentName) + if BaseAPIMixin.MatchesNameCaseInsenstive(self, name, parentName) then + return true; + end + + return name == self:GetLoweredNamespaceName(); +end + +function SystemsAPIMixin:FindAllAPIMatches(apiToSearchFor) + apiToSearchFor = apiToSearchFor:lower(); + + local matches = { + tables = {}, + functions = {}, + events = {}, + }; + + APIDocumentationMixin:AddAllMatches(self.Tables, matches.tables, apiToSearchFor); + APIDocumentationMixin:AddAllMatches(self.Functions, matches.functions, apiToSearchFor); + APIDocumentationMixin:AddAllMatches(self.Events, matches.events, apiToSearchFor); + + -- Only return something if we matched anything + for name, subTable in pairs(matches) do + if #subTable > 0 then + return matches; + end + end + + return nil; +end + +local function AddAll(apiContainer, matchesContainer) + if apiContainer then + for i, apiInfo in ipairs(apiContainer) do + table.insert(matchesContainer, apiInfo); + end + end +end + +function SystemsAPIMixin:ListAllAPI() + local allAPI = { + tables = {}, + functions = {}, + events = {}, + }; + + AddAll(self.Tables, allAPI.tables); + AddAll(self.Functions, allAPI.functions); + AddAll(self.Events, allAPI.events); + + return allAPI; +end + +function SystemsAPIMixin:GetNumTables() + return self.Tables and #self.Tables or 0; +end + +function SystemsAPIMixin:GetNumFunctions() + return self.Functions and #self.Functions or 0; +end + +function SystemsAPIMixin:GetNumEvents() + return self.Events and #self.Events or 0; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/TablesAPIMixin.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/TablesAPIMixin.lua.annotated.lua new file mode 100644 index 0000000..78318ff --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentation/TablesAPIMixin.lua.annotated.lua @@ -0,0 +1,69 @@ +TablesAPIMixin = CreateFromMixins(BaseAPIMixin);--- @class TablesAPIMixin : BaseAPIMixin + +function TablesAPIMixin:GetParentName() + if self.System then + return self.System:GetName(); + end + + return ""; +end + +function TablesAPIMixin:GetType() + return "table"; +end + +function TablesAPIMixin:GetPrettyType() + return self.Type:lower(); +end + +function TablesAPIMixin:GetLinkHexColor() + return "55ffdd"; +end + +function TablesAPIMixin:GetFullName() -- override + if self.Type == "Enumeration" then + return ("Enum.%s"):format(self:GetName()); + end + + return BaseAPIMixin.GetFullName(self); +end + +function TablesAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + if self:MatchesAnyAPI(self.Fields, searchString) then + return true + end + return false; +end + +function TablesAPIMixin:GetDetailedOutputLines() + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddSystemTag(lines); + self:AddDocumentationTags(lines); + + if self.Fields then + if self.Type == "Enumeration" then + table.insert(lines, APIDocumentation:GetIndentString() .. "Num Values: " .. self.NumValues); + table.insert(lines, APIDocumentation:GetIndentString() .. "Min Value: " .. self.MinValue); + table.insert(lines, APIDocumentation:GetIndentString() .. "Max Value: " .. self.MaxValue); + table.insert(lines, APIDocumentation:GetIndentString() .. "Values"); + else + table.insert(lines, APIDocumentation:GetIndentString() .. "Fields"); + end + + for i, fieldInfo in ipairs(self.Fields) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. fieldInfo:GetSingleOutputLine()); + end + end + + return lines; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AbbreviateConfigAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AbbreviateConfigAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1526fe2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AbbreviateConfigAPIDocumentation.lua.annotated.lua @@ -0,0 +1,43 @@ +local AbbreviateConfigAPI = +{ + Name = "AbbreviateConfigAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetAbbreviateNumberData", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "data", Type = "table", InnerType = "NumberAbbreviationBreakpoint", Nilable = false }, + }, + }, + { + Name = "SetAbbreviateNumberData", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "data", Type = "table", InnerType = "NumberAbbreviationBreakpoint", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AbbreviateConfigAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccessibilityOptionsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccessibilityOptionsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e65f419 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccessibilityOptionsDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local AccessibilityOptions = +{ + Name = "AccessibilityOptions", + Type = "System", + Namespace = "C_AccessibilityOptions", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AccessibilityOptions); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1f4ac6e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,274 @@ +local AccountConstants = +{ + Tables = + { + { + Name = "AccountData", + Type = "Enumeration", + NumValues = 20, + MinValue = 0, + MaxValue = 19, + Fields = + { + { Name = "Config", Type = "AccountData", EnumValue = 0 }, + { Name = "Config2", Type = "AccountData", EnumValue = 1 }, + { Name = "Bindings", Type = "AccountData", EnumValue = 2 }, + { Name = "Bindings2", Type = "AccountData", EnumValue = 3 }, + { Name = "Macros", Type = "AccountData", EnumValue = 4 }, + { Name = "Macros2", Type = "AccountData", EnumValue = 5 }, + { Name = "UILayout", Type = "AccountData", EnumValue = 6 }, + { Name = "ChatSettings", Type = "AccountData", EnumValue = 7 }, + { Name = "TtsSettings", Type = "AccountData", EnumValue = 8 }, + { Name = "TtsSettings2", Type = "AccountData", EnumValue = 9 }, + { Name = "FlaggedIDs", Type = "AccountData", EnumValue = 10 }, + { Name = "FlaggedIDs2", Type = "AccountData", EnumValue = 11 }, + { Name = "ClickBindings", Type = "AccountData", EnumValue = 12 }, + { Name = "UIEditModeAccount", Type = "AccountData", EnumValue = 13 }, + { Name = "UIEditModeChar", Type = "AccountData", EnumValue = 14 }, + { Name = "FrontendChatSettings", Type = "AccountData", EnumValue = 15 }, + { Name = "CharacterListOrder", Type = "AccountData", EnumValue = 16 }, + { Name = "CooldownManager", Type = "AccountData", EnumValue = 17 }, + { Name = "CooldownManager2", Type = "AccountData", EnumValue = 18 }, + { Name = "Shop2PendingOrders", Type = "AccountData", EnumValue = 19 }, + }, + }, + { + Name = "AccountDataUpdateStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Success", Type = "AccountDataUpdateStatus", EnumValue = 0 }, + { Name = "Failed", Type = "AccountDataUpdateStatus", EnumValue = 1 }, + { Name = "Corrupt", Type = "AccountDataUpdateStatus", EnumValue = 2 }, + { Name = "Toobig", Type = "AccountDataUpdateStatus", EnumValue = 3 }, + }, + }, + { + Name = "AccountExportResult", + Type = "Enumeration", + NumValues = 14, + MinValue = 0, + MaxValue = 13, + Fields = + { + { Name = "Success", Type = "AccountExportResult", EnumValue = 0 }, + { Name = "UnknownError", Type = "AccountExportResult", EnumValue = 1 }, + { Name = "Cancelled", Type = "AccountExportResult", EnumValue = 2 }, + { Name = "ShuttingDown", Type = "AccountExportResult", EnumValue = 3 }, + { Name = "TimedOut", Type = "AccountExportResult", EnumValue = 4 }, + { Name = "NoAccountFound", Type = "AccountExportResult", EnumValue = 5 }, + { Name = "RequestedInvalidCharacter", Type = "AccountExportResult", EnumValue = 6 }, + { Name = "RpcError", Type = "AccountExportResult", EnumValue = 7 }, + { Name = "FileInvalid", Type = "AccountExportResult", EnumValue = 8 }, + { Name = "FileWriteFailed", Type = "AccountExportResult", EnumValue = 9 }, + { Name = "Unavailable", Type = "AccountExportResult", EnumValue = 10 }, + { Name = "AlreadyInProgress", Type = "AccountExportResult", EnumValue = 11 }, + { Name = "FailedToLockAccount", Type = "AccountExportResult", EnumValue = 12 }, + { Name = "FailedToGenerateFile", Type = "AccountExportResult", EnumValue = 13 }, + }, + }, + { + Name = "AccountSequenceCacheType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Invalid", Type = "AccountSequenceCacheType", EnumValue = 0 }, + { Name = "Local", Type = "AccountSequenceCacheType", EnumValue = 1 }, + { Name = "HouseDecor", Type = "AccountSequenceCacheType", EnumValue = 2 }, + }, + }, + { + Name = "AccountTransType", + Type = "Enumeration", + NumValues = 67, + MinValue = 0, + MaxValue = 66, + Fields = + { + { Name = "ProxyForwarder", Type = "AccountTransType", EnumValue = 0 }, + { Name = "Purchase", Type = "AccountTransType", EnumValue = 1 }, + { Name = "Distribution", Type = "AccountTransType", EnumValue = 2 }, + { Name = "Battlepet", Type = "AccountTransType", EnumValue = 3 }, + { Name = "Achievements", Type = "AccountTransType", EnumValue = 4 }, + { Name = "Criteria", Type = "AccountTransType", EnumValue = 5 }, + { Name = "Mounts", Type = "AccountTransType", EnumValue = 6 }, + { Name = "Characters", Type = "AccountTransType", EnumValue = 7 }, + { Name = "Purchases", Type = "AccountTransType", EnumValue = 8 }, + { Name = "ArchivedPurchases", Type = "AccountTransType", EnumValue = 9 }, + { Name = "Distributions", Type = "AccountTransType", EnumValue = 10 }, + { Name = "CurrencyCaps", Type = "AccountTransType", EnumValue = 11 }, + { Name = "QuestLog", Type = "AccountTransType", EnumValue = 12 }, + { Name = "CriteriaNotif", Type = "AccountTransType", EnumValue = 13 }, + { Name = "Settings", Type = "AccountTransType", EnumValue = 14 }, + { Name = "FixedLicense", Type = "AccountTransType", EnumValue = 15 }, + { Name = "AddLicense", Type = "AccountTransType", EnumValue = 16 }, + { Name = "ItemCollections", Type = "AccountTransType", EnumValue = 17 }, + { Name = "AuctionableToken", Type = "AccountTransType", EnumValue = 18 }, + { Name = "ConsumableToken", Type = "AccountTransType", EnumValue = 19 }, + { Name = "VasTransaction", Type = "AccountTransType", EnumValue = 20 }, + { Name = "Productitem", Type = "AccountTransType", EnumValue = 21 }, + { Name = "TrialBoostHistory", Type = "AccountTransType", EnumValue = 22 }, + { Name = "TrialBoostHistories", Type = "AccountTransType", EnumValue = 23 }, + { Name = "QuestCriteria", Type = "AccountTransType", EnumValue = 24 }, + { Name = "BattlenetAccount", Type = "AccountTransType", EnumValue = 25 }, + { Name = "AccountCurrencies", Type = "AccountTransType", EnumValue = 26 }, + { Name = "RafRecruiterAcceptances", Type = "AccountTransType", EnumValue = 27 }, + { Name = "RafFriendMonth", Type = "AccountTransType", EnumValue = 28 }, + { Name = "RafReward", Type = "AccountTransType", EnumValue = 29 }, + { Name = "DynamicCriteria", Type = "AccountTransType", EnumValue = 30 }, + { Name = "RafActivity", Type = "AccountTransType", EnumValue = 31 }, + { Name = "CreateOrderInfo", Type = "AccountTransType", EnumValue = 32 }, + { Name = "ProxyHonorInitialConversion", Type = "AccountTransType", EnumValue = 33 }, + { Name = "ProxyCreateAccountHonor", Type = "AccountTransType", EnumValue = 34 }, + { Name = "ProxyValidateAccountHonor", Type = "AccountTransType", EnumValue = 35 }, + { Name = "ProxyGmSetHonor", Type = "AccountTransType", EnumValue = 36 }, + { Name = "ProxyGenerateBpayID", Type = "AccountTransType", EnumValue = 37 }, + { Name = "AccountNotifications", Type = "AccountTransType", EnumValue = 38 }, + { Name = "PerkItemHold", Type = "AccountTransType", EnumValue = 39 }, + { Name = "PerkPendingRewards", Type = "AccountTransType", EnumValue = 40 }, + { Name = "PerkPastRewards", Type = "AccountTransType", EnumValue = 41 }, + { Name = "PerkTransaction", Type = "AccountTransType", EnumValue = 42 }, + { Name = "OutstandingRpc", Type = "AccountTransType", EnumValue = 43 }, + { Name = "LoadWowlabs", Type = "AccountTransType", EnumValue = 44 }, + { Name = "UpgradeAccount", Type = "AccountTransType", EnumValue = 45 }, + { Name = "GetOrderStatusByPurchaseID", Type = "AccountTransType", EnumValue = 46 }, + { Name = "Items", Type = "AccountTransType", EnumValue = 47 }, + { Name = "BankTab", Type = "AccountTransType", EnumValue = 48 }, + { Name = "Factions", Type = "AccountTransType", EnumValue = 49 }, + { Name = "BitVectors", Type = "AccountTransType", EnumValue = 50 }, + { Name = "CombinedQuestLog", Type = "AccountTransType", EnumValue = 51 }, + { Name = "PlayerDataElements", Type = "AccountTransType", EnumValue = 52 }, + { Name = "CharacterDataMerge", Type = "AccountTransType", EnumValue = 53 }, + { Name = "AccountStore", Type = "AccountTransType", EnumValue = 54 }, + { Name = "WarbandGroups", Type = "AccountTransType", EnumValue = 55 }, + { Name = "Mapping", Type = "AccountTransType", EnumValue = 56 }, + { Name = "CharacterItems", Type = "AccountTransType", EnumValue = 57 }, + { Name = "CurrencyTransferLog", Type = "AccountTransType", EnumValue = 58 }, + { Name = "LgVendorPurchase", Type = "AccountTransType", EnumValue = 59 }, + { Name = "SaveWarbandGroups", Type = "AccountTransType", EnumValue = 60 }, + { Name = "Profile", Type = "AccountTransType", EnumValue = 61 }, + { Name = "WarbandSceneCollection", Type = "AccountTransType", EnumValue = 62 }, + { Name = "EventRecords", Type = "AccountTransType", EnumValue = 63 }, + { Name = "HousingItem", Type = "AccountTransType", EnumValue = 64 }, + { Name = "TransmogOutfitCollection", Type = "AccountTransType", EnumValue = 65 }, + { Name = "HouseInitiativeFavor", Type = "AccountTransType", EnumValue = 66 }, + }, + }, + { + Name = "BnetAccountFlag", + Type = "Enumeration", + NumValues = 21, + MinValue = 0, + MaxValue = 524288, + Fields = + { + { Name = "None", Type = "BnetAccountFlag", EnumValue = 0 }, + { Name = "BattlePetTrainer", Type = "BnetAccountFlag", EnumValue = 1 }, + { Name = "RafVeteranNotified", Type = "BnetAccountFlag", EnumValue = 2 }, + { Name = "TwitterLinked", Type = "BnetAccountFlag", EnumValue = 4 }, + { Name = "TwitterHasTempSecret", Type = "BnetAccountFlag", EnumValue = 8 }, + { Name = "Employee", Type = "BnetAccountFlag", EnumValue = 16 }, + { Name = "EmployeeFlagIsManual", Type = "BnetAccountFlag", EnumValue = 32 }, + { Name = "AccountQuestBitFixUp", Type = "BnetAccountFlag", EnumValue = 64 }, + { Name = "AchievementsToBi", Type = "BnetAccountFlag", EnumValue = 128 }, + { Name = "InvalidTransmogsFixUp", Type = "BnetAccountFlag", EnumValue = 256 }, + { Name = "InvalidTransmogsFixUp2", Type = "BnetAccountFlag", EnumValue = 512 }, + { Name = "GdprErased", Type = "BnetAccountFlag", EnumValue = 1024 }, + { Name = "DarkRealmLightCopy", Type = "BnetAccountFlag", EnumValue = 2048 }, + { Name = "QuestLogFlagsFixUp", Type = "BnetAccountFlag", EnumValue = 4096 }, + { Name = "WasSecured", Type = "BnetAccountFlag", EnumValue = 8192 }, + { Name = "LockedForExport", Type = "BnetAccountFlag", EnumValue = 16384 }, + { Name = "CanBuyAhGameTimeTokens", Type = "BnetAccountFlag", EnumValue = 32768 }, + { Name = "PetAchievementFixUp", Type = "BnetAccountFlag", EnumValue = 65536 }, + { Name = "IsLegacy", Type = "BnetAccountFlag", EnumValue = 131072 }, + { Name = "CataLegendaryMountChecked", Type = "BnetAccountFlag", EnumValue = 262144 }, + { Name = "CataLegendaryMountObtained", Type = "BnetAccountFlag", EnumValue = 524288 }, + }, + }, + { + Name = "ChallengeModeHistoryFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "ChallengeModeHistoryFlags", EnumValue = 0 }, + { Name = "ConfirmedLeaver", Type = "ChallengeModeHistoryFlags", EnumValue = 1 }, + }, + }, + { + Name = "ChallengeModeHistoryResult", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Successful", Type = "ChallengeModeHistoryResult", EnumValue = 0 }, + { Name = "Leaver", Type = "ChallengeModeHistoryResult", EnumValue = 1 }, + }, + }, + { + Name = "ChallengeModeHistoryStatus", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Normal", Type = "ChallengeModeHistoryStatus", EnumValue = 0 }, + { Name = "Leaver", Type = "ChallengeModeHistoryStatus", EnumValue = 1 }, + }, + }, + { + Name = "DisableAccountProfilesFlags", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 32, + Fields = + { + { Name = "None", Type = "DisableAccountProfilesFlags", EnumValue = 0 }, + { Name = "Document", Type = "DisableAccountProfilesFlags", EnumValue = 1 }, + { Name = "SharedCollections", Type = "DisableAccountProfilesFlags", EnumValue = 2 }, + { Name = "MountsCollections", Type = "DisableAccountProfilesFlags", EnumValue = 4 }, + { Name = "PetsCollections", Type = "DisableAccountProfilesFlags", EnumValue = 8 }, + { Name = "ItemsCollections", Type = "DisableAccountProfilesFlags", EnumValue = 16 }, + { Name = "DecorsCollections", Type = "DisableAccountProfilesFlags", EnumValue = 32 }, + }, + }, + { + Name = "ItemCollectionType", + Type = "Enumeration", + NumValues = 14, + MinValue = 0, + MaxValue = 13, + Fields = + { + { Name = "None", Type = "ItemCollectionType", EnumValue = 0 }, + { Name = "Toy", Type = "ItemCollectionType", EnumValue = 1 }, + { Name = "Heirloom", Type = "ItemCollectionType", EnumValue = 2 }, + { Name = "Transmog", Type = "ItemCollectionType", EnumValue = 3 }, + { Name = "TransmogSetFavorite", Type = "ItemCollectionType", EnumValue = 4 }, + { Name = "RuneforgeLegendaryAbility", Type = "ItemCollectionType", EnumValue = 5 }, + { Name = "TransmogIllusion", Type = "ItemCollectionType", EnumValue = 6 }, + { Name = "WarbandScene", Type = "ItemCollectionType", EnumValue = 7 }, + { Name = "Room", Type = "ItemCollectionType", EnumValue = 8 }, + { Name = "ExteriorFixture", Type = "ItemCollectionType", EnumValue = 9 }, + { Name = "RoomTheme", Type = "ItemCollectionType", EnumValue = 10 }, + { Name = "RoomMaterial", Type = "ItemCollectionType", EnumValue = 11 }, + { Name = "TransmogOutfit", Type = "ItemCollectionType", EnumValue = 12 }, + { Name = "HouseType", Type = "ItemCollectionType", EnumValue = 13 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AccountConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4f1be68 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountInfoDocumentation.lua.annotated.lua @@ -0,0 +1,66 @@ +local AccountInfo = +{ + Name = "AccountInfo", + Type = "System", + Namespace = "C_AccountInfo", + Environment = "All", + + Functions = + { + { + Name = "GetIDFromBattleNetAccountGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battleNetAccountGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "battleNetAccountID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsGUIDBattleNetAccountType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isBNet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGUIDRelatedToLocalAccount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isLocalUser", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AccountInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua.annotated.lua new file mode 100644 index 0000000..df378de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AccountStoreDocumentation.lua.annotated.lua @@ -0,0 +1,275 @@ +local AccountStore = +{ + Name = "AccountStore", + Type = "System", + Namespace = "C_AccountStore", + Environment = "All", + + Functions = + { + { + Name = "BeginPurchase", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "purchaseStarted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCategories", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "storeFrontID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categories", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AccountStoreCategoryInfo", Nilable = false }, + }, + }, + { + Name = "GetCategoryItems", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrencyAvailable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrencyIDForStore", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "storeFrontID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currencyID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrencyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AccountStoreCurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AccountStoreItemInfo", Nilable = true }, + }, + }, + { + Name = "GetStoreFrontState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "storeFrontID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "AccountStoreState", Nilable = false }, + }, + }, + { + Name = "RefundItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "refundStarted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestStoreFrontInfoUpdate", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "storeFrontID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AccountStoreCurrencyAvailableUpdated", + Type = "Event", + LiteralName = "ACCOUNT_STORE_CURRENCY_AVAILABLE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AccountStoreFrontUpdated", + Type = "Event", + LiteralName = "ACCOUNT_STORE_FRONT_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "storeFrontID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AccountStoreItemInfoUpdated", + Type = "Event", + LiteralName = "ACCOUNT_STORE_ITEM_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AccountStoreTransactionError", + Type = "Event", + LiteralName = "ACCOUNT_STORE_TRANSACTION_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "AccountStoreTransactionResult", Nilable = false }, + }, + }, + { + Name = "StoreFrontStateUpdated", + Type = "Event", + LiteralName = "STORE_FRONT_STATE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "storeFrontID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "AccountStoreCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "type", Type = "AccountStoreCategoryType", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "AccountStoreCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + { Name = "maxQuantity", Type = "number", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "AccountStoreItemInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "status", Type = "AccountStoreItemStatus", Nilable = false }, + { Name = "mode", Type = "AccountStoreItemMode", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "flags", Type = "AccountStoreItemFlag", Nilable = false }, + { Name = "customUIModelSceneID", Type = "number", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = true }, + { Name = "price", Type = "number", Nilable = false }, + { Name = "nonrefundable", Type = "bool", Nilable = false }, + { Name = "creatureDisplayID", Type = "number", Nilable = true }, + { Name = "transmogSetID", Type = "number", Nilable = true }, + { Name = "displayIcon", Type = "fileID", Nilable = true }, + { Name = "refundSecondsRemaining", Type = "time_t", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AccountStore); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ccfaba1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementInfoDocumentation.lua.annotated.lua @@ -0,0 +1,205 @@ +local AchievementInfo = +{ + Name = "AchievementInfo", + Type = "System", + Namespace = "C_AchievementInfo", + Environment = "All", + + Functions = + { + { + Name = "AreGuildAchievementsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRewardItemID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rewardItemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSupercedingAchievements", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "supercedingAchievements", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsGuildAchievement", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isGuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidAchievement", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isValidAchievement", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPortraitTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AchievementEarned", + Type = "Event", + LiteralName = "ACHIEVEMENT_EARNED", + SynchronousEvent = true, + Payload = + { + { Name = "achievementID", Type = "number", Nilable = false }, + { Name = "alreadyEarned", Type = "bool", Nilable = true }, + }, + }, + { + Name = "AchievementPlayerName", + Type = "Event", + LiteralName = "ACHIEVEMENT_PLAYER_NAME", + SynchronousEvent = true, + Payload = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AchievementSearchUpdated", + Type = "Event", + LiteralName = "ACHIEVEMENT_SEARCH_UPDATED", + SynchronousEvent = true, + }, + { + Name = "CriteriaComplete", + Type = "Event", + LiteralName = "CRITERIA_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "criteriaID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CriteriaEarned", + Type = "Event", + LiteralName = "CRITERIA_EARNED", + SynchronousEvent = true, + Payload = + { + { Name = "achievementID", Type = "number", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "achievementAlreadyEarnedOnAccount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CriteriaUpdate", + Type = "Event", + LiteralName = "CRITERIA_UPDATE", + SynchronousEvent = true, + }, + { + Name = "InspectAchievementReady", + Type = "Event", + LiteralName = "INSPECT_ACHIEVEMENT_READY", + SynchronousEvent = true, + Payload = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ReceivedAchievementList", + Type = "Event", + LiteralName = "RECEIVED_ACHIEVEMENT_LIST", + UniqueEvent = true, + }, + { + Name = "ReceivedAchievementMemberList", + Type = "Event", + LiteralName = "RECEIVED_ACHIEVEMENT_MEMBER_LIST", + SynchronousEvent = true, + Payload = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TrackedAchievementListChanged", + Type = "Event", + LiteralName = "TRACKED_ACHIEVEMENT_LIST_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "achievementID", Type = "number", Nilable = true }, + { Name = "added", Type = "bool", Nilable = true }, + }, + }, + { + Name = "TrackedAchievementUpdate", + Type = "Event", + LiteralName = "TRACKED_ACHIEVEMENT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "achievementID", Type = "number", Nilable = false }, + { Name = "criteriaID", Type = "number", Nilable = true }, + { Name = "elapsed", Type = "time_t", Nilable = true }, + { Name = "duration", Type = "number", Nilable = true }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AchievementInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4c4dd8b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AchievementTelemetryDocumentation.lua.annotated.lua @@ -0,0 +1,47 @@ +local AchievementTelemetry = +{ + Name = "AchievementTelemetry", + Type = "System", + Namespace = "C_AchievementTelemetry", + Environment = "All", + + Functions = + { + { + Name = "LinkAchievementInClub", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LinkAchievementInWhisper", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowAchievements", + Type = "Function", + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AchievementTelemetry); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..de613a8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarFrameDocumentation.lua.annotated.lua @@ -0,0 +1,1069 @@ +local ActionBarFrame = +{ + Name = "ActionBar", + Type = "System", + Namespace = "C_ActionBar", + Environment = "All", + + Functions = + { + { + Name = "EnableActionRangeCheck", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Used in conjunction with ActionRangeCheckUpdate to inform the UI when an action goes in or out of range with its current target." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false, Documentation = { "True if changes in range for the action should dispatch ActionRangeCheckUpdate. False if the action no longer needs the event." } }, + }, + }, + { + Name = "FindAssistedCombatActionButtons", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Returns the list of action bar slots that contain the Assisted Combat action spell." }, + + Returns = + { + { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "FindFlyoutActionButtons", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flyoutID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "FindPetActionButtons", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petActionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "FindSpellActionButtons", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns the list of action bar slots that contain a specified spell." }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false, Documentation = { "Expects a base spell, so if a spell is overridden the base ID should be provided." } }, + }, + + Returns = + { + { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ForceUpdateAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Force updates some internals for an action button slot." }, + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetActionAutocast", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "autocastAllowed", Type = "bool", Nilable = false }, + { Name = "autocastEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActionBarPage", + Type = "Function", + + Returns = + { + { Name = "currentPage", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetActionChargeDuration", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object describing the active recharge time for an action." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetActionCharges", + Type = "Function", + RequiresValidActionSlot = true, + SecretWhenActionCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "chargeInfo", Type = "ActionBarChargeInfo", Nilable = false }, + }, + }, + { + Name = "GetActionCooldown", + Type = "Function", + RequiresValidActionSlot = true, + SecretWhenActionCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "cooldownInfo", Type = "ActionBarCooldownInfo", Nilable = false }, + }, + }, + { + Name = "GetActionCooldownDuration", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object describing the active cooldown duration for an action." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetActionDisplayCount", + Type = "Function", + RequiresValidActionSlot = true, + SecretWhenActionCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Depending on the action type, return a string that is either the use count or number of charges. If value is beyond the display count parameter, returns the replacementString (defaults to '*')." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + { Name = "maxDisplayCount", Type = "number", Nilable = false, Default = 9999 }, + { Name = "replacementString", Type = "cstring", Nilable = false, Default = "*" }, + }, + + Returns = + { + { Name = "displayCount", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActionLossOfControlCooldown", + Type = "Function", + RequiresValidActionSlot = true, + SecretWhenActionCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActionLossOfControlCooldownDuration", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object describing the active loss of control cooldown duration for an action." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetActionText", + Type = "Function", + MayReturnNothing = true, + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActionTexture", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "textureFileID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetActionUseCount", + Type = "Function", + RequiresValidActionSlot = true, + SecretWhenActionCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBonusBarIndex", + Type = "Function", + + Returns = + { + { Name = "bonusBarIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetBonusBarIndexForSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "bonusBarIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetBonusBarOffset", + Type = "Function", + + Returns = + { + { Name = "bonusBarOffset", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExtraBarIndex", + Type = "Function", + + Returns = + { + { Name = "extraBarIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetItemActionOnEquipSpellID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "onEquipSpellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMultiCastBarIndex", + Type = "Function", + + Returns = + { + { Name = "multiCastBarIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetOverrideBarIndex", + Type = "Function", + + Returns = + { + { Name = "overrideBarIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetOverrideBarSkin", + Type = "Function", + + Returns = + { + { Name = "textureFileID", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "GetPetActionPetBarIndices", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petActionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetProfessionQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "quality", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetProfessionQualityInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingQualityInfo", Nilable = true }, + }, + }, + { + Name = "GetSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTempShapeshiftBarIndex", + Type = "Function", + + Returns = + { + { Name = "tempShapeshiftBarIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetVehicleBarIndex", + Type = "Function", + + Returns = + { + { Name = "vehicleBarIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "HasAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if an actionbar slot is populated with an action." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "hasAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasAssistedCombatActionButtons", + Type = "Function", + + Returns = + { + { Name = "hasButtons", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasBonusActionBar", + Type = "Function", + + Returns = + { + { Name = "hasBonusActionBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasExtraActionBar", + Type = "Function", + + Returns = + { + { Name = "hasExtraActionBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFlyoutActionButtons", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flyoutID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasFlyoutActionButtons", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasOverrideActionBar", + Type = "Function", + + Returns = + { + { Name = "hasOverrideActionBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPetActionButtons", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petActionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasPetActionButtons", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPetActionPetBarIndices", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petActionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasPetActionPetBarIndices", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasRangeRequirements", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "hasRangeRequirements", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSpellActionButtons", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasSpellActionButtons", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasTempShapeshiftActionBar", + Type = "Function", + + Returns = + { + { Name = "hasTempShapeshiftActionBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasVehicleActionBar", + Type = "Function", + + Returns = + { + { Name = "hasVehicleActionBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsActionInRange", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "isInRange", Type = "bool", Nilable = true, Documentation = { "If nil, range cannot be determined (eg. no target is available)." } }, + }, + }, + { + Name = "IsAssistedCombatAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the given action button contains the Assisted Combat action spell." }, + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isAssistedCombatAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAttackAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isAttackAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoCastPetAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoCastPetAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoRepeatAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoRepeatAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConsumableAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isConsumableAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrentAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isCurrentAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabledAutoCastPetAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isEnabledAutoCastPetAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isEquippedAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedGearOutfitAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isEquippedGearOutfitAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHarmfulAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + { Name = "useNeutral", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHelpfulAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + { Name = "useNeutral", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "isHelpful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInterruptAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the given action button contains a spell that can interrupt spellcasting." }, + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isInterruptAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isItemAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnBarOrSpecialBar", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isOnBarOrSpecialBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPossessBarVisible", + Type = "Function", + + Returns = + { + { Name = "isPossessBarVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStackableAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isStackableAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsableAction", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "isLackingResources", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PutActionInSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "RegisterActionUIButton", + Type = "Function", + RequiresValidActionSlot = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checkboxFrame", Type = "SimpleCheckbox", Nilable = false }, + { Name = "actionID", Type = "luaIndex", Nilable = false }, + { Name = "cooldownFrame", Type = "CooldownFrame", Nilable = false }, + }, + }, + { + Name = "SetActionBarPage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pageIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ShouldOverrideBarShowHealthBar", + Type = "Function", + + Returns = + { + { Name = "showHealthBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldOverrideBarShowManaBar", + Type = "Function", + + Returns = + { + { Name = "showManaBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ToggleAutoCastPetAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "UnregisterActionUIButton", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checkboxFrame", Type = "SimpleCheckbox", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActionRangeCheckUpdate", + Type = "Event", + LiteralName = "ACTION_RANGE_CHECK_UPDATE", + SynchronousEvent = true, + Documentation = { "Used in conjunction with EnableActionRangeCheck to inform the UI when an action goes in or out of range with its current target." }, + Payload = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + { Name = "isInRange", Type = "bool", Nilable = false, Documentation = { "Whether or not the current target is in range of the action. Should not be used if the 'checksRange' parameter is false." } }, + { Name = "checksRange", Type = "bool", Nilable = false, Documentation = { "Can be false if a range check was not made for any reason, for example there is not a current target." } }, + }, + }, + { + Name = "ActionUsableChanged", + Type = "Event", + LiteralName = "ACTION_USABLE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "changes", Type = "table", InnerType = "ActionUsableState", Nilable = false }, + }, + }, + { + Name = "ActionbarHidegrid", + Type = "Event", + LiteralName = "ACTIONBAR_HIDEGRID", + SynchronousEvent = true, + }, + { + Name = "ActionbarPageChanged", + Type = "Event", + LiteralName = "ACTIONBAR_PAGE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ActionbarShowBottomleft", + Type = "Event", + LiteralName = "ACTIONBAR_SHOW_BOTTOMLEFT", + SynchronousEvent = true, + }, + { + Name = "ActionbarShowgrid", + Type = "Event", + LiteralName = "ACTIONBAR_SHOWGRID", + SynchronousEvent = true, + }, + { + Name = "ActionbarSlotChanged", + Type = "Event", + LiteralName = "ACTIONBAR_SLOT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "ActionbarUpdateCooldown", + Type = "Event", + LiteralName = "ACTIONBAR_UPDATE_COOLDOWN", + UniqueEvent = true, + }, + { + Name = "ActionbarUpdateState", + Type = "Event", + LiteralName = "ACTIONBAR_UPDATE_STATE", + UniqueEvent = true, + }, + { + Name = "ActionbarUpdateUsable", + Type = "Event", + LiteralName = "ACTIONBAR_UPDATE_USABLE", + UniqueEvent = true, + }, + { + Name = "PetBarUpdate", + Type = "Event", + LiteralName = "PET_BAR_UPDATE", + SynchronousEvent = true, + }, + { + Name = "UpdateBonusActionbar", + Type = "Event", + LiteralName = "UPDATE_BONUS_ACTIONBAR", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "UpdateExtraActionbar", + Type = "Event", + LiteralName = "UPDATE_EXTRA_ACTIONBAR", + UniqueEvent = true, + }, + { + Name = "UpdateMultiCastActionbar", + Type = "Event", + LiteralName = "UPDATE_MULTI_CAST_ACTIONBAR", + UniqueEvent = true, + }, + { + Name = "UpdateOverrideActionbar", + Type = "Event", + LiteralName = "UPDATE_OVERRIDE_ACTIONBAR", + UniqueEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ActionBarFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dd70378 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionBarSharedDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local ActionBarShared = +{ + Tables = + { + { + Name = "ActionBarChargeInfo", + Type = "Structure", + Fields = + { + { Name = "currentCharges", Type = "number", Nilable = false, Documentation = { "Number of charges currently available" } }, + { Name = "maxCharges", Type = "number", Nilable = false, Documentation = { "Max number of charges that can be accumulated" } }, + { Name = "cooldownStartTime", Type = "number", Nilable = false, Documentation = { "If charge cooldown is active, time at which the most recent charge cooldown began; 0 if cooldown is not active" } }, + { Name = "cooldownDuration", Type = "number", Nilable = false, Documentation = { "Cooldown duration in seconds required to generate a charge" } }, + { Name = "chargeModRate", Type = "number", Nilable = false, Documentation = { "Rate at which cooldown UI should update" } }, + }, + }, + { + Name = "ActionBarCooldownInfo", + Type = "Structure", + Fields = + { + { Name = "startTime", Type = "number", Nilable = false, Documentation = { "If cooldown is active, time started; 0 if no cooldown; Current time if isEnabled is false" } }, + { Name = "duration", Type = "number", Nilable = false, Documentation = { "Cooldown duration in seconds if active; 0 if cooldown is inactive" } }, + { Name = "isEnabled", Type = "bool", Nilable = false, Documentation = { "False if cooldown is on hold (ex: some cooldowns only start after an active spell is cancelled); True otherwise" } }, + { Name = "modRate", Type = "number", Nilable = false, Documentation = { "Rate at which cooldown UI should update" } }, + { Name = "activeCategory", Type = "number", Nilable = true, Documentation = { "Indicates which category is responsible for determining the duration. A nil value indicates the duration was determined through some other logic, e.g. the spell is on hold." } }, + { Name = "timeUntilEndOfStartRecovery", Type = "number", Nilable = true, Documentation = { "When this is set it indicates that the spell is in recovery and this is how long it will be until that recovery period is finished" } }, + { Name = "isOnGCD", Type = "bool", Nilable = true, NeverSecret = true, Documentation = { "Whether or not this spell is considered to be on the global cooldown, do not trust this field unless responding to a SPELL_UPDATE_COOLDOWN event" } }, + }, + }, + { + Name = "ActionUsableState", + Type = "Structure", + Fields = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + { Name = "usable", Type = "bool", Nilable = false }, + { Name = "noMana", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ActionBarShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d120575 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ActionDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local Action = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Action); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..91e9672 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,43 @@ +local AddOnProfilerConstants = +{ + Tables = + { + { + Name = "AddOnPerformanceMessageType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "SpecificAddOnChatWarning", Type = "AddOnPerformanceMessageType", EnumValue = 0, Documentation = { "Warning in chat when an AddOn is close to exceeding thresholds." } }, + { Name = "SpecificAddOnErrorDialog", Type = "AddOnPerformanceMessageType", EnumValue = 1, Documentation = { "Error message modal dialog when an AddOn has exceeded thresholds." } }, + { Name = "OverallAddOnErrorDialog", Type = "AddOnPerformanceMessageType", EnumValue = 2, Documentation = { "Error message modal dialog when all AddOns combined have exceeded thresholds." } }, + }, + }, + { + Name = "AddOnProfilerMetric", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "SessionAverageTime", Type = "AddOnProfilerMetric", EnumValue = 0, Documentation = { "Average time since application startup" } }, + { Name = "RecentAverageTime", Type = "AddOnProfilerMetric", EnumValue = 1, Documentation = { "Average time over the last 60 ticks" } }, + { Name = "EncounterAverageTime", Type = "AddOnProfilerMetric", EnumValue = 2, Documentation = { "Average time over the duration of a boss encounter" } }, + { Name = "LastTime", Type = "AddOnProfilerMetric", EnumValue = 3, Documentation = { "Total time in the most recent tick" } }, + { Name = "PeakTime", Type = "AddOnProfilerMetric", EnumValue = 4, Documentation = { "Highest time recorded since application startup" } }, + { Name = "CountTimeOver1Ms", Type = "AddOnProfilerMetric", EnumValue = 5, Documentation = { "Number of ticks where time exceeded 1ms" } }, + { Name = "CountTimeOver5Ms", Type = "AddOnProfilerMetric", EnumValue = 6, Documentation = { "Number of ticks where time exceeded 5ms" } }, + { Name = "CountTimeOver10Ms", Type = "AddOnProfilerMetric", EnumValue = 7, Documentation = { "Number of ticks where time exceeded 10ms" } }, + { Name = "CountTimeOver50Ms", Type = "AddOnProfilerMetric", EnumValue = 8, Documentation = { "Number of ticks where time exceeded 50ms" } }, + { Name = "CountTimeOver100Ms", Type = "AddOnProfilerMetric", EnumValue = 9, Documentation = { "Number of ticks where time exceeded 100ms" } }, + { Name = "CountTimeOver500Ms", Type = "AddOnProfilerMetric", EnumValue = 10, Documentation = { "Number of ticks where time exceeded 500ms" } }, + { Name = "CountTimeOver1000Ms", Type = "AddOnProfilerMetric", EnumValue = 11, Documentation = { "Number of ticks where time exceeded 1000ms" } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AddOnProfilerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..da4da13 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnProfilerDocumentation.lua.annotated.lua @@ -0,0 +1,204 @@ +local AddOnProfiler = +{ + Name = "AddOnProfiler", + Type = "System", + Namespace = "C_AddOnProfiler", + Environment = "All", + + Functions = + { + { + Name = "AddMeasuredCallEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Adds a measured event to any ongoing measured calls. If no such calls are currently taking place, this function does nothing." }, + + Arguments = + { + { Name = "name", Type = "stringView", Nilable = false, Documentation = { "User-defined string describing the measured event. This should be kept under 48 bytes to avoid memory allocations." } }, + }, + }, + { + Name = "AddPerformanceMessageShown", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Internal API for telemetry." }, + + Arguments = + { + { Name = "msg", Type = "AddOnPerformanceMessage", Nilable = false }, + }, + }, + { + Name = "CheckForPerformanceMessage", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Optimized check for determining if AddOns are severely impacting UI performance." }, + + Returns = + { + { Name = "msg", Type = "AddOnPerformanceMessage", Nilable = false }, + }, + }, + { + Name = "GetAddOnMetric", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Gets an AddOn profiler value - all times returned are in milliseconds." }, + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "metric", Type = "AddOnProfilerMetric", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetApplicationMetric", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Overall profiling data for the entire application (not just the UI)" }, + + Arguments = + { + { Name = "metric", Type = "AddOnProfilerMetric", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOverallMetric", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Overall profiling data for all addons" }, + + Arguments = + { + { Name = "metric", Type = "AddOnProfilerMetric", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTicksPerSecond", + Type = "Function", + Documentation = { "Returns the number of profiling clock ticks that occur within a single real-time second." }, + + Returns = + { + { Name = "frequency", Type = "BigInteger", Nilable = false }, + }, + }, + { + Name = "GetTopKAddOnsForMetric", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Gets top K AddOns for a given metric." }, + + Arguments = + { + { Name = "metric", Type = "AddOnProfilerMetric", Nilable = false }, + { Name = "k", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "results", Type = "table", InnerType = "AddOnProfilerResult", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + Documentation = { "AddOn profiler will be enabled for all users, but this will return false if it ever isn't" }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MeasureCall", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Performs a profiled measurement of a single function call with any supplied arguments." }, + + Arguments = + { + { Name = "func", Type = "LuaValueVariant", Nilable = false }, + { Name = "arguments", Type = "LuaValueVariant", Nilable = false, NilableContents = true, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "results", Type = "AddOnProfilerCallResults", Nilable = false }, + { Name = "returns", Type = "LuaValueVariant", Nilable = false, NilableContents = true, StrideIndex = 1 }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "AddOnPerformanceMessage", + Type = "Structure", + Fields = + { + { Name = "type", Type = "AddOnPerformanceMessageType", Nilable = false }, + { Name = "metric", Type = "AddOnProfilerMetric", Nilable = false }, + { Name = "addOnName", Type = "string", Nilable = true }, + { Name = "metricValue", Type = "number", Nilable = false }, + { Name = "thresholdValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "AddOnProfilerCallEvent", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false, Documentation = { "User-defined string describing the measured event." } }, + { Name = "allocatedBytes", Type = "BigUInteger", Nilable = false, Documentation = { "Snapshot of the allocated byte count when this event was recorded." } }, + { Name = "deallocatedBytes", Type = "BigUInteger", Nilable = false, Documentation = { "Snapshot of the deallocated byte count when this event was recorded." } }, + { Name = "elapsedMilliseconds", Type = "number", Nilable = false, Documentation = { "Snapshot of the elapsed milliseconds when this event was recorded." } }, + { Name = "elapsedTicks", Type = "BigInteger", Nilable = false, Documentation = { "Snapshot of the elapsed tick count when this event was recorded." } }, + }, + }, + { + Name = "AddOnProfilerCallResults", + Type = "Structure", + Fields = + { + { Name = "elapsedMilliseconds", Type = "number", Nilable = false, Documentation = { "Total number of milliseconds spent executing the function." } }, + { Name = "elapsedTicks", Type = "BigInteger", Nilable = false, Documentation = { "Total number of profiling clock ticks spent executing the function." } }, + { Name = "allocatedBytes", Type = "BigUInteger", Nilable = false, Documentation = { "Total number of bytes allocated during call execution." } }, + { Name = "deallocatedBytes", Type = "BigUInteger", Nilable = false, Documentation = { "Total number of bytes deallocated during call execution." } }, + { Name = "events", Type = "table", InnerType = "AddOnProfilerCallEvent", Nilable = false, Documentation = { "Events recorded by any AddMeasuredCallEvent calls that took place during function execution." } }, + }, + }, + { + Name = "AddOnProfilerResult", + Type = "Structure", + Fields = + { + { Name = "addOnName", Type = "cstring", Nilable = false }, + { Name = "metricValue", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AddOnProfiler); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..915c388 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AddOnsDocumentation.lua.annotated.lua @@ -0,0 +1,475 @@ +local AddOns = +{ + Name = "AddOns", + Type = "System", + Namespace = "C_AddOns", + Environment = "All", + + Functions = + { + { + Name = "DisableAddOn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + { Name = "character", Type = "cstring", Nilable = false, Default = "0" }, + }, + }, + { + Name = "DisableAllAddOns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "character", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "DoesAddOnExist", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesAddOnHaveLoadError", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "hadError", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EnableAddOn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + { Name = "character", Type = "cstring", Nilable = false, Default = "0" }, + }, + }, + { + Name = "EnableAllAddOns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "character", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetAddOnDependencies", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "deps", Type = "cstring", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetAddOnEnableState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + { Name = "character", Type = "cstring", Nilable = false, Default = "0" }, + }, + + Returns = + { + { Name = "state", Type = "AddOnEnableState", Nilable = false }, + }, + }, + { + Name = "GetAddOnInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "title", Type = "cstring", Nilable = false }, + { Name = "notes", Type = "cstring", Nilable = false }, + { Name = "loadable", Type = "bool", Nilable = false }, + { Name = "reason", Type = "cstring", Nilable = false }, + { Name = "security", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetAddOnInterfaceVersion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "interfaceVersion", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAddOnLocalTable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the addon table (passed as the second argument of ... to files) for any addon that opts in through setting AllowAddOnTableAccess: 1 in the toc file. Insecure code cannot query addon tables from Blizzard addons." }, + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "table", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "GetAddOnMetadata", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + { Name = "variable", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetAddOnName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetAddOnNotes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "notes", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetAddOnOptionalDependencies", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "deps", Type = "cstring", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetAddOnSecurity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "security", Type = "AddOnSecurityStatus", Nilable = false }, + }, + }, + { + Name = "GetAddOnTitle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "title", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetNumAddOns", + Type = "Function", + + Returns = + { + { Name = "numAddOns", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScriptsDisallowedForBeta", + Type = "Function", + + Returns = + { + { Name = "disallowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAddOnDefaultEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "defaultEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAddOnLoadOnDemand", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "loadOnDemand", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAddOnLoadable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + { Name = "character", Type = "cstring", Nilable = false, Default = "0" }, + { Name = "demandLoaded", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "loadable", Type = "bool", Nilable = false }, + { Name = "reason", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsAddOnLoaded", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "loadedOrLoading", Type = "bool", Nilable = false }, + { Name = "loaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAddonVersionCheckEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LoadAddOn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "loaded", Type = "bool", Nilable = true }, + { Name = "value", Type = "string", Nilable = true }, + }, + }, + { + Name = "ResetAddOns", + Type = "Function", + }, + { + Name = "ResetDisabledAddOns", + Type = "Function", + }, + { + Name = "SaveAddOns", + Type = "Function", + }, + { + Name = "SetAddonVersionCheck", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AddonLoaded", + Type = "Event", + LiteralName = "ADDON_LOADED", + SynchronousEvent = true, + Payload = + { + { Name = "addOnName", Type = "cstring", Nilable = false }, + { Name = "containsBindings", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AddonsUnloading", + Type = "Event", + LiteralName = "ADDONS_UNLOADING", + SynchronousEvent = true, + Payload = + { + { Name = "closingClient", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SavedVariablesTooLarge", + Type = "Event", + LiteralName = "SAVED_VARIABLES_TOO_LARGE", + SynchronousEvent = true, + Payload = + { + { Name = "addOnName", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "AddOnEnableState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "AddOnEnableState", EnumValue = 0 }, + { Name = "Some", Type = "AddOnEnableState", EnumValue = 1 }, + { Name = "All", Type = "AddOnEnableState", EnumValue = 2 }, + }, + }, + { + Name = "AddOnSecurityStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Secure", Type = "AddOnSecurityStatus", EnumValue = 0 }, + { Name = "Insecure", Type = "AddOnSecurityStatus", EnumValue = 1 }, + { Name = "Banned", Type = "AddOnSecurityStatus", EnumValue = 2 }, + { Name = "NotAvailable", Type = "AddOnSecurityStatus", EnumValue = 3 }, + }, + }, + { + Name = "AddOnInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "title", Type = "cstring", Nilable = false }, + { Name = "notes", Type = "cstring", Nilable = false }, + { Name = "loadable", Type = "bool", Nilable = false }, + { Name = "reason", Type = "cstring", Nilable = false }, + { Name = "security", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "AddOnLoadableInfo", + Type = "Structure", + Fields = + { + { Name = "loadable", Type = "bool", Nilable = false }, + { Name = "reason", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AddOns); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureJournalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureJournalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e79e56b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureJournalDocumentation.lua.annotated.lua @@ -0,0 +1,120 @@ +local AdventureJournal = +{ + Name = "AdventureJournal", + Type = "System", + Namespace = "C_AdventureJournal", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "AjDungeonAction", + Type = "Event", + LiteralName = "AJ_DUNGEON_ACTION", + SynchronousEvent = true, + Payload = + { + { Name = "lfgDungeonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AjOpen", + Type = "Event", + LiteralName = "AJ_OPEN", + SynchronousEvent = true, + }, + { + Name = "AjOpenCollectionsAction", + Type = "Event", + LiteralName = "AJ_OPEN_COLLECTIONS_ACTION", + SynchronousEvent = true, + }, + { + Name = "AjPveLfgAction", + Type = "Event", + LiteralName = "AJ_PVE_LFG_ACTION", + SynchronousEvent = true, + }, + { + Name = "AjPvpAction", + Type = "Event", + LiteralName = "AJ_PVP_ACTION", + SynchronousEvent = true, + Payload = + { + { Name = "battleMasterListID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AjPvpLfgAction", + Type = "Event", + LiteralName = "AJ_PVP_LFG_ACTION", + SynchronousEvent = true, + }, + { + Name = "AjPvpRbgAction", + Type = "Event", + LiteralName = "AJ_PVP_RBG_ACTION", + SynchronousEvent = true, + }, + { + Name = "AjPvpSkirmishAction", + Type = "Event", + LiteralName = "AJ_PVP_SKIRMISH_ACTION", + SynchronousEvent = true, + }, + { + Name = "AjPvpSpecialBgAction", + Type = "Event", + LiteralName = "AJ_PVP_SPECIAL_BG_ACTION", + SynchronousEvent = true, + }, + { + Name = "AjQuestLogOpen", + Type = "Event", + LiteralName = "AJ_QUEST_LOG_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AjRaidAction", + Type = "Event", + LiteralName = "AJ_RAID_ACTION", + SynchronousEvent = true, + Payload = + { + { Name = "lfgDungeonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AjRefreshDisplay", + Type = "Event", + LiteralName = "AJ_REFRESH_DISPLAY", + SynchronousEvent = true, + Payload = + { + { Name = "newAdventureNotice", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AjRewardDataReceived", + Type = "Event", + LiteralName = "AJ_REWARD_DATA_RECEIVED", + UniqueEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AdventureJournal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7c0b096 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AdventureMapDocumentation.lua.annotated.lua @@ -0,0 +1,96 @@ +local AdventureMap = +{ + Name = "AdventureMap", + Type = "System", + Namespace = "C_AdventureMap", + Environment = "All", + + Functions = + { + { + Name = "GetAdventureMapTextureKit", + Type = "Function", + + Returns = + { + { Name = "adventureMapTextureKit", Type = "textureKit", Nilable = false }, + }, + }, + { + Name = "GetQuestPortraitInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AdventureMapQuestPortraitInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AdventureMapClose", + Type = "Event", + LiteralName = "ADVENTURE_MAP_CLOSE", + SynchronousEvent = true, + }, + { + Name = "AdventureMapOpen", + Type = "Event", + LiteralName = "ADVENTURE_MAP_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AdventureMapQuestUpdate", + Type = "Event", + LiteralName = "ADVENTURE_MAP_QUEST_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AdventureMapUpdateInsets", + Type = "Event", + LiteralName = "ADVENTURE_MAP_UPDATE_INSETS", + UniqueEvent = true, + }, + { + Name = "AdventureMapUpdatePois", + Type = "Event", + LiteralName = "ADVENTURE_MAP_UPDATE_POIS", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "AdventureMapQuestPortraitInfo", + Type = "Structure", + Fields = + { + { Name = "portraitDisplayID", Type = "number", Nilable = false }, + { Name = "mountPortraitDisplayID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "modelSceneID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AdventureMap); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3ea77ce --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AlliedRacesFrameDocumentation.lua.annotated.lua @@ -0,0 +1,97 @@ +local AlliedRacesFrame = +{ + Name = "AlliedRaces", + Type = "System", + Namespace = "C_AlliedRaces", + Environment = "All", + + Functions = + { + { + Name = "GetAllRacialAbilitiesFromID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "raceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "allDisplayInfo", Type = "table", InnerType = "AlliedRaceRacialAbility", Nilable = false }, + }, + }, + { + Name = "GetRaceInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "raceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AlliedRaceInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AlliedRaceClose", + Type = "Event", + LiteralName = "ALLIED_RACE_CLOSE", + SynchronousEvent = true, + }, + { + Name = "AlliedRaceOpen", + Type = "Event", + LiteralName = "ALLIED_RACE_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "raceID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "AlliedRaceInfo", + Type = "Structure", + Fields = + { + { Name = "raceID", Type = "number", Nilable = false }, + { Name = "maleModelID", Type = "number", Nilable = false }, + { Name = "femaleModelID", Type = "number", Nilable = false }, + { Name = "achievementIds", Type = "table", InnerType = "number", Nilable = false }, + { Name = "maleName", Type = "cstring", Nilable = false }, + { Name = "femaleName", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "raceFileString", Type = "cstring", Nilable = false }, + { Name = "crestAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "modelBackgroundAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "bannerColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "AlliedRaceRacialAbility", + Type = "Structure", + Fields = + { + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AlliedRacesFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..32cd7c6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AnimaDiversionUIDocumentation.lua.annotated.lua @@ -0,0 +1,149 @@ +local AnimaDiversionUI = +{ + Name = "AnimaDiversionInfo", + Type = "System", + Namespace = "C_AnimaDiversion", + Environment = "All", + + Functions = + { + { + Name = "CloseUI", + Type = "Function", + }, + { + Name = "GetAnimaDiversionNodes", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "animaNodes", Type = "table", InnerType = "AnimaDiversionNodeInfo", Nilable = false }, + }, + }, + { + Name = "GetOriginPosition", + Type = "Function", + + Returns = + { + { Name = "normalizedPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "GetReinforceProgress", + Type = "Function", + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTextureKit", + Type = "Function", + + Returns = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + }, + }, + { + Name = "OpenAnimaDiversionUI", + Type = "Function", + }, + { + Name = "SelectAnimaNode", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + { Name = "temporary", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AnimaDiversionClose", + Type = "Event", + LiteralName = "ANIMA_DIVERSION_CLOSE", + SynchronousEvent = true, + }, + { + Name = "AnimaDiversionOpen", + Type = "Event", + LiteralName = "ANIMA_DIVERSION_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "info", Type = "AnimaDiversionFrameInfo", Nilable = false }, + }, + }, + { + Name = "AnimaDiversionTalentUpdated", + Type = "Event", + LiteralName = "ANIMA_DIVERSION_TALENT_UPDATED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "AnimaDiversionNodeState", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Unavailable", Type = "AnimaDiversionNodeState", EnumValue = 0 }, + { Name = "Available", Type = "AnimaDiversionNodeState", EnumValue = 1 }, + { Name = "SelectedTemporary", Type = "AnimaDiversionNodeState", EnumValue = 2 }, + { Name = "SelectedPermanent", Type = "AnimaDiversionNodeState", EnumValue = 3 }, + { Name = "Cooldown", Type = "AnimaDiversionNodeState", EnumValue = 4 }, + }, + }, + { + Name = "AnimaDiversionCostInfo", + Type = "Structure", + Fields = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "AnimaDiversionFrameInfo", + Type = "Structure", + Fields = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AnimaDiversionNodeInfo", + Type = "Structure", + Fields = + { + { Name = "talentID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "costs", Type = "table", InnerType = "AnimaDiversionCostInfo", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "normalizedPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "state", Type = "AnimaDiversionNodeState", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AnimaDiversionUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a0f8a0e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AppearanceSourceDocumentation.lua.annotated.lua @@ -0,0 +1,33 @@ +local AppearanceSource = +{ + Tables = + { + { + Name = "AppearanceSourceInfo", + Type = "Structure", + Fields = + { + { Name = "visualID", Type = "number", Nilable = false }, + { Name = "sourceID", Type = "number", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemModID", Type = "number", Nilable = false }, + { Name = "invType", Type = "luaIndex", Nilable = false, Default = 0 }, + { Name = "categoryID", Type = "TransmogCollectionType", Nilable = false, Default = "None" }, + { Name = "playerCanCollect", Type = "bool", Nilable = false }, + { Name = "isValidSourceForPlayer", Type = "bool", Nilable = false }, + { Name = "canDisplayOnPlayer", Type = "bool", Nilable = false }, + { Name = "inventorySlot", Type = "number", Nilable = true }, + { Name = "sourceType", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "quality", Type = "number", Nilable = true }, + { Name = "useError", Type = "string", Nilable = true }, + { Name = "useErrorType", Type = "TransmogUseErrorType", Nilable = true }, + { Name = "meetsTransmogPlayerCondition", Type = "bool", Nilable = true }, + { Name = "isHideVisual", Type = "bool", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AppearanceSource); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4782a82 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArdenwealdGardeningDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local ArdenwealdGardening = +{ + Name = "ArdenwealdGardening", + Type = "System", + Namespace = "C_ArdenwealdGardening", + Environment = "All", + + Functions = + { + { + Name = "GetGardenData", + Type = "Function", + + Returns = + { + { Name = "data", Type = "ArdenwealdGardenData", Nilable = false }, + }, + }, + { + Name = "IsGardenAccessible", + Type = "Function", + + Returns = + { + { Name = "accessible", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "ArdenwealdGardenData", + Type = "Structure", + Fields = + { + { Name = "active", Type = "number", Nilable = false }, + { Name = "ready", Type = "number", Nilable = false }, + { Name = "remainingSeconds", Type = "time_t", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ArdenwealdGardening); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d451680 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AreaPoiInfoDocumentation.lua.annotated.lua @@ -0,0 +1,182 @@ +local AreaPoiInfo = +{ + Name = "AreaPoiInfo", + Type = "System", + Namespace = "C_AreaPoiInfo", + Environment = "All", + + Functions = + { + { + Name = "GetAreaPOIForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAreaPOIInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + { Name = "areaPoiID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "poiInfo", Type = "AreaPOIInfo", Nilable = false }, + }, + }, + { + Name = "GetAreaPOISecondsLeft", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the number of seconds until the POI expires." }, + + Arguments = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "secondsLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDelvesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns all area POIInfos flagged as delves for the given map." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetDragonridingRacesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns all area POIInfos flagged as dragonriding races for the given map." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetEventsForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns all area POIInfos flagged as events for the given map." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestHubsForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns all area POIInfos flagged as quest hubs for the given map." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsAreaPOITimed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + 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 }, + { Name = "hideTimerInTooltip", Type = "bool", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "AreaPoisUpdated", + Type = "Event", + LiteralName = "AREA_POIS_UPDATED", + UniqueEvent = true, + }, + }, + + 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 = "linkedUiMapID", Type = "number", Nilable = true }, + { Name = "textureIndex", Type = "number", Nilable = true }, + { Name = "tooltipWidgetSet", Type = "number", Nilable = true }, + { Name = "iconWidgetSet", Type = "number", Nilable = true }, + { Name = "atlasName", Type = "string", Nilable = true }, + { Name = "uiTextureKit", Type = "textureKit", 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 = "addPaddingAboveTooltipWidgets", Type = "bool", Nilable = true }, + { Name = "highlightWorldQuestsOnHover", Type = "bool", Nilable = false }, + { Name = "highlightVignettesOnHover", Type = "bool", Nilable = false }, + { Name = "isCurrentEvent", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AreaPoiInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArrowCalloutConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArrowCalloutConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1de49a7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArrowCalloutConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,37 @@ +local ArrowCalloutConstants = +{ + Tables = + { + { + Name = "ArrowCalloutDirection", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Up", Type = "ArrowCalloutDirection", EnumValue = 0 }, + { Name = "Down", Type = "ArrowCalloutDirection", EnumValue = 1 }, + { Name = "Left", Type = "ArrowCalloutDirection", EnumValue = 2 }, + { Name = "Right", Type = "ArrowCalloutDirection", EnumValue = 3 }, + }, + }, + { + Name = "ArrowCalloutType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "ArrowCalloutType", EnumValue = 0 }, + { Name = "Generic", Type = "ArrowCalloutType", EnumValue = 1 }, + { Name = "WorldLootObject", Type = "ArrowCalloutType", EnumValue = 2 }, + { Name = "Tutorial", Type = "ArrowCalloutType", EnumValue = 3 }, + { Name = "WidgetContainerNoBorder", Type = "ArrowCalloutType", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ArrowCalloutConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..98aba1b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ArtifactUIDocumentation.lua.annotated.lua @@ -0,0 +1,1015 @@ +local ArtifactUI = +{ + Name = "ArtifactUI", + Type = "System", + Namespace = "C_ArtifactUI", + Environment = "All", + + Functions = + { + { + Name = "AddPower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ApplyCursorRelicToSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CanApplyArtifactRelic", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicItemID", Type = "number", Nilable = false }, + { Name = "onlyUnlocked", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "canApply", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanApplyCursorRelicToSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canApply", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanApplyRelicItemIDToEquippedArtifactSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicItemID", Type = "number", Nilable = false }, + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canApply", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanApplyRelicItemIDToSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicItemID", Type = "number", Nilable = false }, + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canApply", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CheckRespecNPC", + Type = "Function", + + Returns = + { + { Name = "canRespec", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Clear", + Type = "Function", + }, + { + Name = "ClearForgeCamera", + Type = "Function", + }, + { + Name = "ConfirmRespec", + Type = "Function", + }, + { + Name = "DoesEquippedArtifactHaveAnyRelicsSlotted", + Type = "Function", + + Returns = + { + { Name = "hasAnyRelicsSlotted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAppearanceInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceSetIndex", Type = "number", Nilable = false }, + { Name = "appearanceIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceName", Type = "string", Nilable = false }, + { Name = "displayIndex", Type = "number", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "failureDescription", Type = "string", Nilable = true }, + { Name = "uiCameraID", Type = "number", Nilable = false }, + { Name = "altHandCameraID", Type = "number", Nilable = true }, + { Name = "swatchColorR", Type = "number", Nilable = false }, + { Name = "swatchColorG", Type = "number", Nilable = false }, + { Name = "swatchColorB", Type = "number", Nilable = false }, + { Name = "modelOpacity", Type = "number", Nilable = false }, + { Name = "modelSaturation", Type = "number", Nilable = false }, + { Name = "obtainable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAppearanceInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "artifactAppearanceSetID", Type = "number", Nilable = false }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceName", Type = "string", Nilable = false }, + { Name = "displayIndex", Type = "number", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "failureDescription", Type = "string", Nilable = true }, + { Name = "uiCameraID", Type = "number", Nilable = false }, + { Name = "altHandCameraID", Type = "number", Nilable = true }, + { Name = "swatchColorR", Type = "number", Nilable = false }, + { Name = "swatchColorG", Type = "number", Nilable = false }, + { Name = "swatchColorB", Type = "number", Nilable = false }, + { Name = "modelOpacity", Type = "number", Nilable = false }, + { Name = "modelSaturation", Type = "number", Nilable = false }, + { Name = "obtainable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAppearanceSetInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceSetIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "artifactAppearanceSetID", Type = "number", Nilable = false }, + { Name = "appearanceSetName", Type = "string", Nilable = false }, + { Name = "appearanceSetDescription", Type = "string", Nilable = false }, + { Name = "numAppearances", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArtifactArtInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "artifactArtInfo", Type = "ArtifactArtInfo", Nilable = false }, + }, + }, + { + Name = "GetArtifactInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "altItemID", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "pointsSpent", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "altItemAppearanceID", Type = "number", Nilable = true }, + { Name = "altOnTop", Type = "bool", Nilable = false }, + { Name = "tier", Type = "ArtifactTiers", Nilable = false }, + }, + }, + { + Name = "GetArtifactItemID", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArtifactTier", + Type = "Function", + + Returns = + { + { Name = "tier", Type = "ArtifactTiers", Nilable = true }, + }, + }, + { + Name = "GetArtifactXPRewardTargetInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "artifactCategoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetCostForPointAtRank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rank", Type = "number", Nilable = false }, + { Name = "tier", Type = "ArtifactTiers", Nilable = false }, + }, + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEquippedArtifactArtInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "artifactArtInfo", Type = "ArtifactArtInfo", Nilable = false }, + }, + }, + { + Name = "GetEquippedArtifactInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "altItemID", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "pointsSpent", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "altItemAppearanceID", Type = "number", Nilable = true }, + { Name = "altOnTop", Type = "bool", Nilable = false }, + { Name = "tier", Type = "ArtifactTiers", Nilable = false }, + }, + }, + { + Name = "GetEquippedArtifactItemID", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEquippedArtifactNumRelicSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "onlyUnlocked", Type = "bool", Nilable = false, Default = false, Documentation = { "If true then only the relic slots that are unlocked will be considered." } }, + }, + + Returns = + { + { Name = "numRelicSlots", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEquippedArtifactRelicInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "slotTypeName", Type = "cstring", Nilable = false, Documentation = { "Matches the socket identifiers used in the socketing system." } }, + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetEquippedRelicLockedReason", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "lockedReason", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetForgeRotation", + Type = "Function", + + Returns = + { + { Name = "forgeRotationX", Type = "number", Nilable = false }, + { Name = "forgeRotationY", Type = "number", Nilable = false }, + { Name = "forgeRotationZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemLevelIncreaseProvidedByRelic", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLinkOrID", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemIevelIncrease", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMetaPowerInfo", + Type = "Function", + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false, StrideIndex = 1 }, + { Name = "powerCost", Type = "number", Nilable = false, StrideIndex = 2 }, + { Name = "currentRank", Type = "number", Nilable = false, StrideIndex = 3 }, + }, + }, + { + Name = "GetNumAppearanceSets", + Type = "Function", + + Returns = + { + { Name = "numAppearanceSets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumObtainedArtifacts", + Type = "Function", + + Returns = + { + { Name = "numObtainedArtifacts", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumRelicSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "onlyUnlocked", Type = "bool", Nilable = false, Default = false, Documentation = { "If true then only the relic slots that are unlocked will be considered." } }, + }, + + Returns = + { + { Name = "numRelicSlots", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPointsRemaining", + Type = "Function", + + Returns = + { + { Name = "pointsRemaining", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerHyperlink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetPowerInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "powerInfo", Type = "ArtifactPowerInfo", Nilable = false }, + }, + }, + { + Name = "GetPowerLinks", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "linkingPowerID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetPowers", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "powerID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetPowersAffectedByRelic", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "powerIDs", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetPowersAffectedByRelicItemLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicItemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "powerIDs", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetPreviewAppearance", + Type = "Function", + + Returns = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRelicInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "slotTypeName", Type = "cstring", Nilable = false, Documentation = { "Matches the socket identifiers used in the socketing system." } }, + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRelicInfoByItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "slotTypeName", Type = "cstring", Nilable = false, Documentation = { "Matches the socket identifiers used in the socketing system." } }, + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRelicLockedReason", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "lockedReason", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetRelicSlotType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relicSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "slotTypeName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetRespecArtifactArtInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "artifactArtInfo", Type = "ArtifactArtInfo", Nilable = false }, + }, + }, + { + Name = "GetRespecArtifactInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "altItemID", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "pointsSpent", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "altItemAppearanceID", Type = "number", Nilable = true }, + { Name = "altOnTop", Type = "bool", Nilable = false }, + { Name = "tier", Type = "ArtifactTiers", Nilable = false }, + }, + }, + { + Name = "GetRespecCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotalPowerCost", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "startingTrait", Type = "luaIndex", Nilable = false }, + { Name = "numTraits", Type = "number", Nilable = false }, + { Name = "artifactTier", Type = "ArtifactTiers", Nilable = false }, + }, + + Returns = + { + { Name = "totalArtifactPowerCost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotalPurchasedRanks", + Type = "Function", + + Returns = + { + { Name = "totalPurchasedRanks", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsArtifactDisabled", + Type = "Function", + + Returns = + { + { Name = "artifactDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsArtifactItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isArtifact", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAtForge", + Type = "Function", + + Returns = + { + { Name = "isAtForge", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedArtifactDisabled", + Type = "Function", + + Returns = + { + { Name = "artifactDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedArtifactMaxed", + Type = "Function", + + Returns = + { + { Name = "artifactMaxed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMaxedByRulesOrEffect", + Type = "Function", + + Returns = + { + { Name = "isEffectivelyMaxed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPowerKnown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "known", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsViewedArtifactEquipped", + Type = "Function", + + Returns = + { + { Name = "isViewedArtifactEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetForgeCamera", + Type = "Function", + }, + { + Name = "SetForgeRotation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "forgeRotationX", Type = "number", Nilable = false }, + { Name = "forgeRotationY", Type = "number", Nilable = false }, + { Name = "forgeRotationZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPreviewAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Call without an argument to clear the preview." }, + + Arguments = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "ShouldSuppressForgeRotation", + Type = "Function", + + Returns = + { + { Name = "shouldSuppressForgeRotation", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ArtifactClose", + Type = "Event", + LiteralName = "ARTIFACT_CLOSE", + SynchronousEvent = true, + }, + { + Name = "ArtifactEndgameRefund", + Type = "Event", + LiteralName = "ARTIFACT_ENDGAME_REFUND", + SynchronousEvent = true, + Payload = + { + { Name = "numRefundedPowers", Type = "number", Nilable = false }, + { Name = "refundedTier", Type = "ArtifactTiers", Nilable = false }, + { Name = "bagOrSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "ArtifactRelicForgeClose", + Type = "Event", + LiteralName = "ARTIFACT_RELIC_FORGE_CLOSE", + SynchronousEvent = true, + }, + { + Name = "ArtifactRelicForgePreviewRelicChanged", + Type = "Event", + LiteralName = "ARTIFACT_RELIC_FORGE_PREVIEW_RELIC_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ArtifactRelicForgeUpdate", + Type = "Event", + LiteralName = "ARTIFACT_RELIC_FORGE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ArtifactRelicInfoReceived", + Type = "Event", + LiteralName = "ARTIFACT_RELIC_INFO_RECEIVED", + SynchronousEvent = true, + }, + { + Name = "ArtifactRespecPrompt", + Type = "Event", + LiteralName = "ARTIFACT_RESPEC_PROMPT", + SynchronousEvent = true, + }, + { + Name = "ArtifactTierChanged", + Type = "Event", + LiteralName = "ARTIFACT_TIER_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "newTier", Type = "luaIndex", Nilable = false }, + { Name = "bagOrSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "ArtifactUpdate", + Type = "Event", + LiteralName = "ARTIFACT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "newItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ArtifactXpUpdate", + Type = "Event", + LiteralName = "ARTIFACT_XP_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "ArtifactAppearanceInfo", + Type = "Structure", + Fields = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceName", Type = "string", Nilable = false }, + { Name = "displayIndex", Type = "number", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "failureDescription", Type = "string", Nilable = true }, + { Name = "uiCameraID", Type = "number", Nilable = false }, + { Name = "altHandCameraID", Type = "number", Nilable = true }, + { Name = "swatchColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "modelOpacity", Type = "number", Nilable = false }, + { Name = "modelSaturation", Type = "number", Nilable = false }, + { Name = "obtainable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ArtifactAppearanceSetInfo", + Type = "Structure", + Fields = + { + { Name = "artifactAppearanceSetID", Type = "number", Nilable = false }, + { Name = "appearanceSetName", Type = "string", Nilable = false }, + { Name = "appearanceSetDescription", Type = "string", Nilable = false }, + { Name = "numAppearances", Type = "number", Nilable = false }, + }, + }, + { + Name = "ArtifactArtInfo", + Type = "Structure", + Fields = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "titleName", Type = "string", Nilable = false }, + { Name = "titleColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "barConnectedColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "barDisconnectedColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false }, + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ArtifactInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "altItemID", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "pointsSpent", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "altItemAppearanceID", Type = "number", Nilable = true }, + { Name = "altOnTop", Type = "bool", Nilable = false }, + { Name = "tier", Type = "ArtifactTiers", Nilable = false }, + }, + }, + { + Name = "ArtifactMetaPowerInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "powerCost", Type = "number", Nilable = false }, + { Name = "currentRank", Type = "number", Nilable = false }, + }, + }, + { + Name = "ArtifactPowerInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "cost", Type = "number", Nilable = false }, + { Name = "currentRank", Type = "number", Nilable = false }, + { Name = "maxRank", Type = "number", Nilable = false }, + { Name = "bonusRanks", Type = "number", Nilable = false }, + { Name = "numMaxRankBonusFromTier", Type = "number", Nilable = false }, + { Name = "prereqsMet", Type = "bool", Nilable = false }, + { Name = "isStart", Type = "bool", Nilable = false }, + { Name = "isGoldMedal", Type = "bool", Nilable = false }, + { Name = "isFinal", Type = "bool", Nilable = false }, + { Name = "tier", Type = "luaIndex", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "offset", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + { Name = "linearIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "ArtifactRelicInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "slotTypeName", Type = "cstring", Nilable = false, Documentation = { "Matches the socket identifiers used in the socketing system." } }, + { Name = "link", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ArtifactUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0a1d576 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AssistedCombatDocumentation.lua.annotated.lua @@ -0,0 +1,70 @@ +local AssistedCombat = +{ + Name = "AssistedCombat", + Type = "System", + Namespace = "C_AssistedCombat", + Environment = "All", + + Functions = + { + { + Name = "GetActionSpell", + Type = "Function", + + Returns = + { + { Name = "spellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNextCastSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checkForVisibleButton", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRotationSpells", + Type = "Function", + + Returns = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AssistedCombatActionSpellCast", + Type = "Event", + LiteralName = "ASSISTED_COMBAT_ACTION_SPELL_CAST", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AssistedCombat); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AsyncAssistActionsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AsyncAssistActionsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6782af1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AsyncAssistActionsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,25 @@ +local AsyncAssistActionsConstants = +{ + Tables = + { + { + Name = "AssistActionType", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "None", Type = "AssistActionType", EnumValue = 0 }, + { Name = "LoungingPlayer", Type = "AssistActionType", EnumValue = 1 }, + { Name = "GraveMarker", Type = "AssistActionType", EnumValue = 2 }, + { Name = "PlacedVo", Type = "AssistActionType", EnumValue = 3 }, + { Name = "PlayerGuardian", Type = "AssistActionType", EnumValue = 4 }, + { Name = "PlayerSlayer", Type = "AssistActionType", EnumValue = 5 }, + { Name = "CapturedBuff", Type = "AssistActionType", EnumValue = 6 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AsyncAssistActionsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..492cf6a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,16 @@ +local AuctionHouseConstants = +{ + Tables = + { + { + Name = "AuctionConstants", + Type = "Constants", + Values = + { + { Name = "DEFAULT_AUCTION_PRICE_MULTIPLIER", Type = "number", Value = 1.5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AuctionHouseConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua.annotated.lua new file mode 100644 index 0000000..25bcb6f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseDocumentation.lua.annotated.lua @@ -0,0 +1,1715 @@ +local AuctionHouse = +{ + Name = "AuctionHouse", + Type = "System", + Namespace = "C_AuctionHouse", + Environment = "All", + + Functions = + { + { + Name = "CalculateCommodityDeposit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "duration", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "depositCost", Type = "number", Nilable = true }, + }, + }, + { + Name = "CalculateItemDeposit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "duration", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "depositCost", Type = "number", Nilable = true }, + }, + }, + { + Name = "CanCancelAuction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ownedAuctionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canCancelAuction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelAuction", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ownedAuctionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CancelCommoditiesPurchase", + Type = "Function", + }, + { + Name = "CancelSell", + Type = "Function", + }, + { + Name = "CloseAuctionHouse", + Type = "Function", + }, + { + Name = "ConfirmCommoditiesPurchase", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmPostCommodity", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "duration", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "unitPrice", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "ConfirmPostItem", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "duration", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "bid", Type = "BigUInteger", Nilable = true }, + { Name = "buyout", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "FavoritesAreAvailable", + Type = "Function", + + Returns = + { + { Name = "favoritesAreAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAuctionInfoByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "priceInfo", Type = "AuctionInfo", Nilable = true }, + }, + }, + { + Name = "GetAuctionItemSubClasses", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "subClasses", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAvailablePostCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "listCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBidInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bidIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "bid", Type = "BidInfo", Nilable = true }, + }, + }, + { + Name = "GetBidType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bidTypeIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "typeItemKey", Type = "ItemKey", Nilable = true }, + }, + }, + { + Name = "GetBids", + Type = "Function", + + Returns = + { + { Name = "bids", Type = "table", InnerType = "BidInfo", Nilable = false }, + }, + }, + { + Name = "GetBrowseResults", + Type = "Function", + + Returns = + { + { Name = "browseResults", Type = "table", InnerType = "BrowseResultInfo", Nilable = false }, + }, + }, + { + Name = "GetCancelCost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ownedAuctionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "cancelCost", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "GetCommoditySearchResultInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "commoditySearchResultIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "CommoditySearchResultInfo", Nilable = true }, + }, + }, + { + Name = "GetCommoditySearchResultsQuantity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "totalQuantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExtraBrowseInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "extraInfo", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFilterGroups", + Type = "Function", + + Returns = + { + { Name = "filterGroups", Type = "table", InnerType = "AuctionHouseFilterGroup", Nilable = false }, + }, + }, + { + Name = "GetItemCommodityStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isCommodity", Type = "ItemCommodityStatus", Nilable = false }, + }, + }, + { + Name = "GetItemKeyFromItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + }, + { + Name = "GetItemKeyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "restrictQualityToFilter", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "itemKeyInfo", Type = "ItemKeyInfo", Nilable = true }, + }, + }, + { + Name = "GetItemKeyRequiredLevel", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "requiredLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemSearchResultInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "itemSearchResultIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "ItemSearchResultInfo", Nilable = true }, + }, + }, + { + Name = "GetItemSearchResultsQuantity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "totalQuantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxBidItemBid", + Type = "Function", + + Returns = + { + { Name = "maxBid", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetMaxBidItemBuyout", + Type = "Function", + + Returns = + { + { Name = "maxBuyout", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetMaxCommoditySearchResultPrice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "maxUnitPrice", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetMaxItemSearchResultBid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "maxBid", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetMaxItemSearchResultBuyout", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "maxBuyout", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetMaxOwnedAuctionBid", + Type = "Function", + + Returns = + { + { Name = "maxBid", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetMaxOwnedAuctionBuyout", + Type = "Function", + + Returns = + { + { Name = "maxBuyout", Type = "BigUInteger", Nilable = true }, + }, + }, + { + Name = "GetNumBidTypes", + Type = "Function", + + Returns = + { + { Name = "numBidTypes", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBids", + Type = "Function", + + Returns = + { + { Name = "numBids", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumCommoditySearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numSearchResults", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumItemSearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "numItemSearchResults", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumOwnedAuctionTypes", + Type = "Function", + + Returns = + { + { Name = "numOwnedAuctionTypes", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumOwnedAuctions", + Type = "Function", + + Returns = + { + { Name = "numOwnedAuctions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumReplicateItems", + Type = "Function", + + Returns = + { + { Name = "numReplicateItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOwnedAuctionInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ownedAuctionIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "ownedAuction", Type = "OwnedAuctionInfo", Nilable = true }, + }, + }, + { + Name = "GetOwnedAuctionType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ownedAuctionTypeIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "typeItemKey", Type = "ItemKey", Nilable = true }, + }, + }, + { + Name = "GetOwnedAuctions", + Type = "Function", + + Returns = + { + { Name = "ownedAuctions", Type = "table", InnerType = "OwnedAuctionInfo", Nilable = false }, + }, + }, + { + Name = "GetQuoteDurationRemaining", + Type = "Function", + + Returns = + { + { Name = "quoteDurationSeconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetReplicateItemBattlePetInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "creatureID", Type = "number", Nilable = false }, + { Name = "displayID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetReplicateItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "texture", Type = "fileID", Nilable = true }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "qualityID", Type = "number", Nilable = false }, + { Name = "usable", Type = "bool", Nilable = true }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "levelType", Type = "string", Nilable = true }, + { Name = "minBid", Type = "BigUInteger", Nilable = false }, + { Name = "minIncrement", Type = "BigUInteger", Nilable = false }, + { Name = "buyoutPrice", Type = "BigUInteger", Nilable = false }, + { Name = "bidAmount", Type = "BigUInteger", Nilable = false }, + { Name = "highBidder", Type = "string", Nilable = true }, + { Name = "bidderFullName", Type = "string", Nilable = true }, + { Name = "owner", Type = "string", Nilable = true }, + { Name = "ownerFullName", Type = "string", Nilable = true }, + { Name = "saleStatus", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "hasAllInfo", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetReplicateItemLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetReplicateItemTimeLeft", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTimeLeftBandInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "timeLeftBand", Type = "AuctionHouseTimeLeftBand", Nilable = false }, + }, + + Returns = + { + { Name = "timeLeftMinSeconds", Type = "number", Nilable = false }, + { Name = "timeLeftMaxSeconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasFavorites", + Type = "Function", + + Returns = + { + { Name = "hasFavorites", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFullBidResults", + Type = "Function", + + Returns = + { + { Name = "hasFullBidResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFullBrowseResults", + Type = "Function", + + Returns = + { + { Name = "hasFullBrowseResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFullCommoditySearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasFullResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFullItemSearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "hasFullResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFullOwnedAuctionResults", + Type = "Function", + + Returns = + { + { Name = "hasFullOwnedAuctionResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasMaxFavorites", + Type = "Function", + + Returns = + { + { Name = "hasMaxFavorites", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "hasSearchResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFavoriteItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSellItemValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "displayError", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsThrottledMessageSystemReady", + Type = "Function", + + Returns = + { + { Name = "canSendThrottledMessage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MakeItemKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false, Default = 0 }, + { Name = "itemSuffix", Type = "number", Nilable = false, Default = 0 }, + { Name = "battlePetSpeciesID", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + }, + { + Name = "PlaceBid", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "auctionID", Type = "number", Nilable = false }, + { Name = "bidAmount", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "PostCommodity", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "duration", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "unitPrice", Type = "BigUInteger", Nilable = false }, + }, + + Returns = + { + { Name = "needsConfirmation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PostItem", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "duration", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "bid", Type = "BigUInteger", Nilable = true }, + { Name = "buyout", Type = "BigUInteger", Nilable = true }, + }, + + Returns = + { + { Name = "needsConfirmation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QueryBids", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + { Name = "auctionIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "QueryOwnedAuctions", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + }, + }, + { + Name = "RefreshCommoditySearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RefreshItemSearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "minLevelFilter", Type = "number", Nilable = true }, + { Name = "maxLevelFilter", Type = "number", Nilable = true }, + }, + }, + { + Name = "ReplicateItems", + Type = "Function", + Documentation = { "This function should be used in place of an 'allItem' QueryAuctionItems call to query the entire auction house." }, + }, + { + Name = "RequestMoreBrowseResults", + Type = "Function", + }, + { + Name = "RequestMoreCommoditySearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasFullResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestMoreItemSearchResults", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + + Returns = + { + { Name = "hasFullResults", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestOwnedAuctionBidderInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "bidderName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SearchForFavorites", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + }, + }, + { + Name = "SearchForItemKeys", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKeys", Type = "table", InnerType = "ItemKey", Nilable = false }, + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + }, + }, + { + Name = "SendBrowseQuery", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "query", Type = "AuctionHouseBrowseQuery", Nilable = false }, + }, + }, + { + Name = "SendSearchQuery", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search queries are restricted to 100 calls per minute. These should not be used to query the entire auction house. See ReplicateItems" }, + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + { Name = "separateOwnerItems", Type = "bool", Nilable = false }, + { Name = "minLevelFilter", Type = "number", Nilable = false, Default = 0 }, + { Name = "maxLevelFilter", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SendSellSearchQuery", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search queries are restricted to 100 calls per minute. These should not be used to query the entire auction house. See ReplicateItems. ItemKey should have its iLVL and suffix cleared before calling." }, + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + { Name = "separateOwnerItems", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFavoriteItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "setFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldAutoPopulatePrice", + Type = "Function", + + Returns = + { + { Name = "shouldAutoPopulatePrice", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartCommoditiesPurchase", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "SupportsCopperValues", + Type = "Function", + + Returns = + { + { Name = "supportsCopperValues", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AuctionCanceled", + Type = "Event", + LiteralName = "AUCTION_CANCELED", + SynchronousEvent = true, + Payload = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseAuctionCreated", + Type = "Event", + LiteralName = "AUCTION_HOUSE_AUCTION_CREATED", + SynchronousEvent = true, + Documentation = { "This signal is not used in the base UI but is included for AddOn ease-of-use." }, + Payload = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseAuctionsExpired", + Type = "Event", + LiteralName = "AUCTION_HOUSE_AUCTIONS_EXPIRED", + SynchronousEvent = true, + Payload = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseBrowseFailure", + Type = "Event", + LiteralName = "AUCTION_HOUSE_BROWSE_FAILURE", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseBrowseResultsAdded", + Type = "Event", + LiteralName = "AUCTION_HOUSE_BROWSE_RESULTS_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "addedBrowseResults", Type = "table", InnerType = "BrowseResultInfo", Nilable = false }, + }, + }, + { + Name = "AuctionHouseBrowseResultsUpdated", + Type = "Event", + LiteralName = "AUCTION_HOUSE_BROWSE_RESULTS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseClosed", + Type = "Event", + LiteralName = "AUCTION_HOUSE_CLOSED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseDisabled", + Type = "Event", + LiteralName = "AUCTION_HOUSE_DISABLED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseFavoritesUpdated", + Type = "Event", + LiteralName = "AUCTION_HOUSE_FAVORITES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseItemDeliveryDelayUpdate", + Type = "Event", + LiteralName = "AUCTION_HOUSE_ITEM_DELIVERY_DELAY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "purchasedItemDeliveryDelay", Type = "number", Nilable = false }, + { Name = "cancelledItemDeliveryDelay", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseNewBidReceived", + Type = "Event", + LiteralName = "AUCTION_HOUSE_NEW_BID_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseNewResultsReceived", + Type = "Event", + LiteralName = "AUCTION_HOUSE_NEW_RESULTS_RECEIVED", + SynchronousEvent = true, + Documentation = { "This signal is not used in the base UI but is included for AddOn ease-of-use. Payload is nil for browse queries." }, + Payload = + { + { Name = "itemKey", Type = "ItemKey", Nilable = true }, + }, + }, + { + Name = "AuctionHousePostError", + Type = "Event", + LiteralName = "AUCTION_HOUSE_POST_ERROR", + SynchronousEvent = true, + }, + { + Name = "AuctionHousePostWarning", + Type = "Event", + LiteralName = "AUCTION_HOUSE_POST_WARNING", + SynchronousEvent = true, + }, + { + Name = "AuctionHousePurchaseCompleted", + Type = "Event", + LiteralName = "AUCTION_HOUSE_PURCHASE_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "auctionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseScriptDeprecated", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SCRIPT_DEPRECATED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseShow", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SHOW", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseShowCommodityWonNotification", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SHOW_COMMODITY_WON_NOTIFICATION", + SynchronousEvent = true, + Payload = + { + { Name = "commodityName", Type = "string", Nilable = false }, + { Name = "commodityQuantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionHouseShowError", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SHOW_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "error", Type = "AuctionHouseError", Nilable = false }, + }, + }, + { + Name = "AuctionHouseShowFormattedNotification", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SHOW_FORMATTED_NOTIFICATION", + SynchronousEvent = true, + Payload = + { + { Name = "notification", Type = "AuctionHouseNotification", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "auctionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "AuctionHouseShowNotification", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SHOW_NOTIFICATION", + SynchronousEvent = true, + Payload = + { + { Name = "notification", Type = "AuctionHouseNotification", Nilable = false }, + }, + }, + { + Name = "AuctionHouseThrottledMessageDropped", + Type = "Event", + LiteralName = "AUCTION_HOUSE_THROTTLED_MESSAGE_DROPPED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseThrottledMessageQueued", + Type = "Event", + LiteralName = "AUCTION_HOUSE_THROTTLED_MESSAGE_QUEUED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseThrottledMessageResponseReceived", + Type = "Event", + LiteralName = "AUCTION_HOUSE_THROTTLED_MESSAGE_RESPONSE_RECEIVED", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseThrottledMessageSent", + Type = "Event", + LiteralName = "AUCTION_HOUSE_THROTTLED_MESSAGE_SENT", + SynchronousEvent = true, + }, + { + Name = "AuctionHouseThrottledSystemReady", + Type = "Event", + LiteralName = "AUCTION_HOUSE_THROTTLED_SYSTEM_READY", + SynchronousEvent = true, + }, + { + Name = "AuctionMultisellFailure", + Type = "Event", + LiteralName = "AUCTION_MULTISELL_FAILURE", + SynchronousEvent = true, + }, + { + Name = "AuctionMultisellStart", + Type = "Event", + LiteralName = "AUCTION_MULTISELL_START", + SynchronousEvent = true, + Payload = + { + { Name = "numRepetitions", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionMultisellUpdate", + Type = "Event", + LiteralName = "AUCTION_MULTISELL_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "createdCount", Type = "number", Nilable = false }, + { Name = "totalToCreate", Type = "number", Nilable = false }, + }, + }, + { + Name = "BidAdded", + Type = "Event", + LiteralName = "BID_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "bidID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BidsUpdated", + Type = "Event", + LiteralName = "BIDS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "CommodityPriceUnavailable", + Type = "Event", + LiteralName = "COMMODITY_PRICE_UNAVAILABLE", + SynchronousEvent = true, + }, + { + Name = "CommodityPriceUpdated", + Type = "Event", + LiteralName = "COMMODITY_PRICE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "updatedUnitPrice", Type = "BigUInteger", Nilable = false }, + { Name = "updatedTotalPrice", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CommodityPurchaseFailed", + Type = "Event", + LiteralName = "COMMODITY_PURCHASE_FAILED", + SynchronousEvent = true, + }, + { + Name = "CommodityPurchaseSucceeded", + Type = "Event", + LiteralName = "COMMODITY_PURCHASE_SUCCEEDED", + SynchronousEvent = true, + }, + { + Name = "CommodityPurchased", + Type = "Event", + LiteralName = "COMMODITY_PURCHASED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "CommoditySearchResultsAdded", + Type = "Event", + LiteralName = "COMMODITY_SEARCH_RESULTS_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CommoditySearchResultsReceived", + Type = "Event", + LiteralName = "COMMODITY_SEARCH_RESULTS_RECEIVED", + UniqueEvent = true, + }, + { + Name = "CommoditySearchResultsUpdated", + Type = "Event", + LiteralName = "COMMODITY_SEARCH_RESULTS_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ExtraBrowseInfoReceived", + Type = "Event", + LiteralName = "EXTRA_BROWSE_INFO_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemKeyItemInfoReceived", + Type = "Event", + LiteralName = "ITEM_KEY_ITEM_INFO_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemPurchased", + Type = "Event", + LiteralName = "ITEM_PURCHASED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemSearchResultsAdded", + Type = "Event", + LiteralName = "ITEM_SEARCH_RESULTS_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + }, + }, + { + Name = "ItemSearchResultsUpdated", + Type = "Event", + LiteralName = "ITEM_SEARCH_RESULTS_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "newAuctionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "OwnedAuctionBidderInfoReceived", + Type = "Event", + LiteralName = "OWNED_AUCTION_BIDDER_INFO_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "auctionID", Type = "number", Nilable = false }, + { Name = "bidderName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "OwnedAuctionsUpdated", + Type = "Event", + LiteralName = "OWNED_AUCTIONS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ReplicateItemListUpdate", + Type = "Event", + LiteralName = "REPLICATE_ITEM_LIST_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "AuctionHouseFilterCategory", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Uncategorized", Type = "AuctionHouseFilterCategory", EnumValue = 0 }, + { Name = "Equipment", Type = "AuctionHouseFilterCategory", EnumValue = 1 }, + { Name = "Rarity", Type = "AuctionHouseFilterCategory", EnumValue = 2 }, + }, + }, + { + Name = "AuctionStatus", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Active", Type = "AuctionStatus", EnumValue = 0 }, + { Name = "Sold", Type = "AuctionStatus", EnumValue = 1 }, + }, + }, + { + Name = "ItemCommodityStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Unknown", Type = "ItemCommodityStatus", EnumValue = 0 }, + { Name = "Item", Type = "ItemCommodityStatus", EnumValue = 1 }, + { Name = "Commodity", Type = "ItemCommodityStatus", EnumValue = 2 }, + }, + }, + { + Name = "AuctionHouseBrowseQuery", + Type = "Structure", + Fields = + { + { Name = "searchString", Type = "string", Nilable = false }, + { Name = "sorts", Type = "table", InnerType = "AuctionHouseSortType", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = true }, + { Name = "maxLevel", Type = "number", Nilable = true }, + { Name = "filters", Type = "table", InnerType = "AuctionHouseFilter", Nilable = true }, + { Name = "itemClassFilters", Type = "table", InnerType = "AuctionHouseItemClassFilter", Nilable = true }, + }, + }, + { + Name = "AuctionHouseFilterGroup", + Type = "Structure", + Fields = + { + { Name = "category", Type = "AuctionHouseFilterCategory", Nilable = false }, + { Name = "filters", Type = "table", InnerType = "AuctionHouseFilter", Nilable = false }, + }, + }, + { + Name = "AuctionHouseItemClassFilter", + Type = "Structure", + Fields = + { + { Name = "classID", Type = "number", Nilable = false }, + { Name = "subClassID", Type = "number", Nilable = true }, + { Name = "inventoryType", Type = "InventoryType", Nilable = true }, + }, + }, + { + Name = "AuctionHouseSortType", + Type = "Structure", + Fields = + { + { Name = "sortOrder", Type = "AuctionHouseSortOrder", Nilable = false }, + { Name = "reverseSort", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AuctionInfo", + Type = "Structure", + Fields = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "minBid", Type = "WOWMONEY", Nilable = true }, + { Name = "bidAmount", Type = "WOWMONEY", Nilable = true }, + { Name = "buyoutAmount", Type = "WOWMONEY", Nilable = true }, + { Name = "bidder", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "BidInfo", + Type = "Structure", + Fields = + { + { Name = "auctionID", Type = "number", Nilable = false }, + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "timeLeft", Type = "AuctionHouseTimeLeftBand", Nilable = false }, + { Name = "minBid", Type = "BigUInteger", Nilable = true }, + { Name = "bidAmount", Type = "BigUInteger", Nilable = true }, + { Name = "buyoutAmount", Type = "BigUInteger", Nilable = true }, + { Name = "bidder", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "BrowseResultInfo", + Type = "Structure", + Fields = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "appearanceLink", Type = "string", Nilable = true }, + { Name = "totalQuantity", Type = "number", Nilable = false }, + { Name = "minPrice", Type = "BigUInteger", Nilable = false }, + { Name = "containsOwnerItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CommoditySearchResultInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "unitPrice", Type = "BigUInteger", Nilable = false }, + { Name = "auctionID", Type = "number", Nilable = false }, + { Name = "owners", Type = "table", InnerType = "string", Nilable = false }, + { Name = "totalNumberOfOwners", Type = "number", Nilable = false }, + { Name = "timeLeftSeconds", Type = "number", Nilable = true }, + { Name = "numOwnerItems", Type = "number", Nilable = false }, + { Name = "containsOwnerItem", Type = "bool", Nilable = false }, + { Name = "containsAccountItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemKey", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false, Default = 0 }, + { Name = "itemSuffix", Type = "number", Nilable = false, Default = 0 }, + { Name = "battlePetSpeciesID", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "ItemKeyInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "battlePetSpeciesID", Type = "number", Nilable = false }, + { Name = "itemName", Type = "string", Nilable = false }, + { Name = "battlePetLink", Type = "string", Nilable = true }, + { Name = "appearanceLink", Type = "string", Nilable = true }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + { Name = "iconFileID", Type = "number", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "isCommodity", Type = "bool", Nilable = false }, + { Name = "isEquipment", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemSearchResultInfo", + Type = "Structure", + Fields = + { + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "owners", Type = "table", InnerType = "string", Nilable = false }, + { Name = "totalNumberOfOwners", Type = "number", Nilable = false }, + { Name = "timeLeft", Type = "AuctionHouseTimeLeftBand", Nilable = false }, + { Name = "auctionID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "containsOwnerItem", Type = "bool", Nilable = false }, + { Name = "containsAccountItem", Type = "bool", Nilable = false }, + { Name = "containsSocketedItem", Type = "bool", Nilable = false }, + { Name = "bidder", Type = "WOWGUID", Nilable = true }, + { Name = "minBid", Type = "BigUInteger", Nilable = true }, + { Name = "bidAmount", Type = "BigUInteger", Nilable = true }, + { Name = "buyoutAmount", Type = "BigUInteger", Nilable = true }, + { Name = "timeLeftSeconds", Type = "number", Nilable = true }, + }, + }, + { + Name = "OwnedAuctionInfo", + Type = "Structure", + Fields = + { + { Name = "auctionID", Type = "number", Nilable = false }, + { Name = "itemKey", Type = "ItemKey", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "status", Type = "AuctionStatus", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "timeLeftSeconds", Type = "number", Nilable = true }, + { Name = "timeLeft", Type = "AuctionHouseTimeLeftBand", Nilable = true }, + { Name = "bidAmount", Type = "BigUInteger", Nilable = true }, + { Name = "buyoutAmount", Type = "BigUInteger", Nilable = true }, + { Name = "bidder", Type = "string", Nilable = true }, + }, + }, + { + Name = "ReplicateItemInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "texture", Type = "fileID", Nilable = true }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "qualityID", Type = "number", Nilable = false }, + { Name = "usable", Type = "bool", Nilable = true }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "levelType", Type = "string", Nilable = true }, + { Name = "minBid", Type = "BigUInteger", Nilable = false }, + { Name = "minIncrement", Type = "BigUInteger", Nilable = false }, + { Name = "buyoutPrice", Type = "BigUInteger", Nilable = false }, + { Name = "bidAmount", Type = "BigUInteger", Nilable = false }, + { Name = "highBidder", Type = "string", Nilable = true }, + { Name = "bidderFullName", Type = "string", Nilable = true }, + { Name = "owner", Type = "string", Nilable = true }, + { Name = "ownerFullName", Type = "string", Nilable = true }, + { Name = "saleStatus", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "hasAllInfo", Type = "bool", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AuctionHouse); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseEnumsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseEnumsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a1d6a3c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AuctionHouseEnumsDocumentation.lua.annotated.lua @@ -0,0 +1,154 @@ +local AuctionHouseEnums = +{ + Tables = + { + { + Name = "AuctionHouseCommoditySortOrder", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "UnitPrice", Type = "AuctionHouseCommoditySortOrder", EnumValue = 0 }, + { Name = "Quantity", Type = "AuctionHouseCommoditySortOrder", EnumValue = 1 }, + }, + }, + { + Name = "AuctionHouseError", + Type = "Enumeration", + NumValues = 27, + MinValue = 0, + MaxValue = 26, + Fields = + { + { Name = "NotEnoughMoney", Type = "AuctionHouseError", EnumValue = 0 }, + { Name = "HigherBid", Type = "AuctionHouseError", EnumValue = 1 }, + { Name = "BidIncrement", Type = "AuctionHouseError", EnumValue = 2 }, + { Name = "BidOwn", Type = "AuctionHouseError", EnumValue = 3 }, + { Name = "ItemNotFound", Type = "AuctionHouseError", EnumValue = 4 }, + { Name = "RestrictedAccountTrial", Type = "AuctionHouseError", EnumValue = 5 }, + { Name = "HasRestriction", Type = "AuctionHouseError", EnumValue = 6 }, + { Name = "IsBusy", Type = "AuctionHouseError", EnumValue = 7 }, + { Name = "Unavailable", Type = "AuctionHouseError", EnumValue = 8 }, + { Name = "ItemHasQuote", Type = "AuctionHouseError", EnumValue = 9 }, + { Name = "DatabaseError", Type = "AuctionHouseError", EnumValue = 10 }, + { Name = "MinBid", Type = "AuctionHouseError", EnumValue = 11 }, + { Name = "NotEnoughItems", Type = "AuctionHouseError", EnumValue = 12 }, + { Name = "RepairItem", Type = "AuctionHouseError", EnumValue = 13 }, + { Name = "UsedCharges", Type = "AuctionHouseError", EnumValue = 14 }, + { Name = "QuestItem", Type = "AuctionHouseError", EnumValue = 15 }, + { Name = "BoundItem", Type = "AuctionHouseError", EnumValue = 16 }, + { Name = "ConjuredItem", Type = "AuctionHouseError", EnumValue = 17 }, + { Name = "LimitedDurationItem", Type = "AuctionHouseError", EnumValue = 18 }, + { Name = "IsBag", Type = "AuctionHouseError", EnumValue = 19 }, + { Name = "EquippedBag", Type = "AuctionHouseError", EnumValue = 20 }, + { Name = "WrappedItem", Type = "AuctionHouseError", EnumValue = 21 }, + { Name = "LootItem", Type = "AuctionHouseError", EnumValue = 22 }, + { Name = "DoubleBid", Type = "AuctionHouseError", EnumValue = 23 }, + { Name = "FavoritesMaxed", Type = "AuctionHouseError", EnumValue = 24 }, + { Name = "ItemNotAvailable", Type = "AuctionHouseError", EnumValue = 25 }, + { Name = "ItemBoundToAccountUntilEquip", Type = "AuctionHouseError", EnumValue = 26 }, + }, + }, + { + Name = "AuctionHouseExtraColumn", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "AuctionHouseExtraColumn", EnumValue = 0 }, + { Name = "Ilvl", Type = "AuctionHouseExtraColumn", EnumValue = 1 }, + { Name = "Slots", Type = "AuctionHouseExtraColumn", EnumValue = 2 }, + { Name = "Level", Type = "AuctionHouseExtraColumn", EnumValue = 3 }, + { Name = "Skill", Type = "AuctionHouseExtraColumn", EnumValue = 4 }, + }, + }, + { + Name = "AuctionHouseFilter", + Type = "Enumeration", + NumValues = 14, + MinValue = 0, + MaxValue = 13, + Fields = + { + { Name = "None", Type = "AuctionHouseFilter", EnumValue = 0 }, + { Name = "UncollectedOnly", Type = "AuctionHouseFilter", EnumValue = 1 }, + { Name = "UsableOnly", Type = "AuctionHouseFilter", EnumValue = 2 }, + { Name = "CurrentExpansionOnly", Type = "AuctionHouseFilter", EnumValue = 3 }, + { Name = "UpgradesOnly", Type = "AuctionHouseFilter", EnumValue = 4 }, + { Name = "ExactMatch", Type = "AuctionHouseFilter", EnumValue = 5 }, + { Name = "PoorQuality", Type = "AuctionHouseFilter", EnumValue = 6 }, + { Name = "CommonQuality", Type = "AuctionHouseFilter", EnumValue = 7 }, + { Name = "UncommonQuality", Type = "AuctionHouseFilter", EnumValue = 8 }, + { Name = "RareQuality", Type = "AuctionHouseFilter", EnumValue = 9 }, + { Name = "EpicQuality", Type = "AuctionHouseFilter", EnumValue = 10 }, + { Name = "LegendaryQuality", Type = "AuctionHouseFilter", EnumValue = 11 }, + { Name = "ArtifactQuality", Type = "AuctionHouseFilter", EnumValue = 12 }, + { Name = "LegendaryCraftedItemOnly", Type = "AuctionHouseFilter", EnumValue = 13 }, + }, + }, + { + Name = "AuctionHouseItemSortOrder", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Bid", Type = "AuctionHouseItemSortOrder", EnumValue = 0 }, + { Name = "Buyout", Type = "AuctionHouseItemSortOrder", EnumValue = 1 }, + }, + }, + { + Name = "AuctionHouseNotification", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "BidPlaced", Type = "AuctionHouseNotification", EnumValue = 0 }, + { Name = "AuctionRemoved", Type = "AuctionHouseNotification", EnumValue = 1 }, + { Name = "AuctionWon", Type = "AuctionHouseNotification", EnumValue = 2 }, + { Name = "AuctionOutbid", Type = "AuctionHouseNotification", EnumValue = 3 }, + { Name = "AuctionSold", Type = "AuctionHouseNotification", EnumValue = 4 }, + { Name = "AuctionExpired", Type = "AuctionHouseNotification", EnumValue = 5 }, + }, + }, + { + Name = "AuctionHouseSortOrder", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Price", Type = "AuctionHouseSortOrder", EnumValue = 0 }, + { Name = "Name", Type = "AuctionHouseSortOrder", EnumValue = 1 }, + { Name = "Level", Type = "AuctionHouseSortOrder", EnumValue = 2 }, + { Name = "Bid", Type = "AuctionHouseSortOrder", EnumValue = 3 }, + { Name = "Buyout", Type = "AuctionHouseSortOrder", EnumValue = 4 }, + { Name = "TimeRemaining", Type = "AuctionHouseSortOrder", EnumValue = 5 }, + }, + }, + { + Name = "AuctionHouseTimeLeftBand", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Short", Type = "AuctionHouseTimeLeftBand", EnumValue = 0 }, + { Name = "Medium", Type = "AuctionHouseTimeLeftBand", EnumValue = 1 }, + { Name = "Long", Type = "AuctionHouseTimeLeftBand", EnumValue = 2 }, + { Name = "VeryLong", Type = "AuctionHouseTimeLeftBand", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AuctionHouseEnums); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b427160 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local AzeriteConstants = +{ + Tables = + { + { + Name = "AzeriteEssenceSlot", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "MainSlot", Type = "AzeriteEssenceSlot", EnumValue = 0 }, + { Name = "PassiveOneSlot", Type = "AzeriteEssenceSlot", EnumValue = 1 }, + { Name = "PassiveTwoSlot", Type = "AzeriteEssenceSlot", EnumValue = 2 }, + { Name = "PassiveThreeSlot", Type = "AzeriteEssenceSlot", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AzeriteConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4f5b3c8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEmpoweredItemDocumentation.lua.annotated.lua @@ -0,0 +1,349 @@ +local AzeriteEmpoweredItem = +{ + Name = "AzeriteEmpoweredItem", + Type = "System", + Namespace = "C_AzeriteEmpoweredItem", + Environment = "All", + + Functions = + { + { + Name = "CanSelectPower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canSelect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConfirmAzeriteEmpoweredItemRespec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "GetAllTierInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "tierInfo", Type = "table", InnerType = "AzeriteEmpoweredItemTierInfo", Nilable = false }, + }, + }, + { + Name = "GetAllTierInfoByItemID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "classID", Type = "number", Nilable = true, Documentation = { "Specify a class ID to get tier information about that class, otherwise uses the player's class if left nil" } }, + }, + + Returns = + { + { Name = "tierInfo", Type = "table", InnerType = "AzeriteEmpoweredItemTierInfo", Nilable = false }, + }, + }, + { + Name = "GetAzeriteEmpoweredItemRespecCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "powerInfo", Type = "AzeriteEmpoweredItemPowerInfo", Nilable = false }, + }, + }, + { + Name = "GetPowerText", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = false }, + { Name = "level", Type = "AzeritePowerLevel", Nilable = false }, + }, + + Returns = + { + { Name = "powerText", Type = "AzeriteEmpoweredItemPowerText", Nilable = false }, + }, + }, + { + Name = "GetSpecsForPower", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specInfo", Type = "table", InnerType = "AzeriteSpecInfo", Nilable = false }, + }, + }, + { + Name = "HasAnyUnselectedPowers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "hasAnyUnselectedPowers", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasBeenViewed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "hasBeenViewed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeriteEmpoweredItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isAzeriteEmpoweredItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeriteEmpoweredItemByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isAzeriteEmpoweredItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeritePreviewSourceDisplayable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "classID", Type = "number", Nilable = true, Documentation = { "Specify a class ID to determine if its displayable for that class, otherwise uses the player's class if left nil" } }, + }, + + Returns = + { + { Name = "isAzeritePreviewSourceDisplayable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHeartOfAzerothEquipped", + Type = "Function", + + Returns = + { + { Name = "isHeartOfAzerothEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPowerAvailableForSpec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPowerAvailableForSpec", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPowerSelected", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isSelected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SelectPower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetHasBeenViewed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AzeriteEmpoweredItemEquippedStatusChanged", + Type = "Event", + LiteralName = "AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isHeartEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AzeriteEmpoweredItemSelectionUpdated", + Type = "Event", + LiteralName = "AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "AzeritePowerLevel", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Base", Type = "AzeritePowerLevel", EnumValue = 0 }, + { Name = "Upgraded", Type = "AzeritePowerLevel", EnumValue = 1 }, + { Name = "Downgraded", Type = "AzeritePowerLevel", EnumValue = 2 }, + }, + }, + { + Name = "AzeriteEmpoweredItemPowerInfo", + Type = "Structure", + Fields = + { + { Name = "azeritePowerID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteEmpoweredItemPowerText", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "AzeriteEmpoweredItemTierInfo", + Type = "Structure", + Fields = + { + { Name = "azeritePowerIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "unlockLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteSpecInfo", + Type = "Structure", + Fields = + { + { Name = "classID", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AzeriteEmpoweredItem); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ab30098 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteEssenceDocumentation.lua.annotated.lua @@ -0,0 +1,353 @@ +local AzeriteEssence = +{ + Name = "AzeriteEssence", + Type = "System", + Namespace = "C_AzeriteEssence", + Environment = "All", + + Functions = + { + { + Name = "ActivateEssence", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "essenceID", Type = "number", Nilable = false }, + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CanActivateEssence", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "essenceID", Type = "number", Nilable = false }, + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canActivate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanDeactivateEssence", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canDeactivate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanOpenUI", + Type = "Function", + + Returns = + { + { Name = "canOpen", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearPendingActivationEssence", + Type = "Function", + }, + { + Name = "CloseForge", + Type = "Function", + }, + { + Name = "GetEssenceHyperlink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "essenceID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetEssenceInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "essenceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AzeriteEssenceInfo", Nilable = false }, + }, + }, + { + Name = "GetEssences", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "essences", Type = "table", InnerType = "AzeriteEssenceInfo", Nilable = false }, + }, + }, + { + Name = "GetMilestoneEssence", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "essenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMilestoneInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AzeriteMilestoneInfo", Nilable = false }, + }, + }, + { + Name = "GetMilestoneSpell", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMilestones", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "milestones", Type = "table", InnerType = "AzeriteMilestoneInfo", Nilable = false }, + }, + }, + { + Name = "GetNumUnlockedEssences", + Type = "Function", + + Returns = + { + { Name = "numUnlockedEssences", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumUsableEssences", + Type = "Function", + + Returns = + { + { Name = "numUsableEssences", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPendingActivationEssence", + Type = "Function", + + Returns = + { + { Name = "essenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasNeverActivatedAnyEssences", + Type = "Function", + + Returns = + { + { Name = "hasNeverActivatedAnyEssences", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPendingActivationEssence", + Type = "Function", + + Returns = + { + { Name = "hasEssence", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAtForge", + Type = "Function", + + Returns = + { + { Name = "isAtForge", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPendingActivationEssence", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "essenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnlockMilestone", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AzeriteEssenceActivated", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_ACTIVATED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false }, + { Name = "essenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteEssenceActivationFailed", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_ACTIVATION_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false }, + { Name = "essenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteEssenceChanged", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "essenceID", Type = "number", Nilable = false }, + { Name = "newRank", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteEssenceForgeClose", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_FORGE_CLOSE", + SynchronousEvent = true, + }, + { + Name = "AzeriteEssenceForgeOpen", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_FORGE_OPEN", + SynchronousEvent = true, + }, + { + Name = "AzeriteEssenceMilestoneUnlocked", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_MILESTONE_UNLOCKED", + SynchronousEvent = true, + Payload = + { + { Name = "milestoneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteEssenceUpdate", + Type = "Event", + LiteralName = "AZERITE_ESSENCE_UPDATE", + UniqueEvent = true, + }, + { + Name = "PendingAzeriteEssenceChanged", + Type = "Event", + LiteralName = "PENDING_AZERITE_ESSENCE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "essenceID", Type = "number", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "AzeriteEssenceInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "valid", Type = "bool", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "AzeriteMilestoneInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "requiredLevel", Type = "number", Nilable = false }, + { Name = "canUnlock", Type = "bool", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "rank", Type = "number", Nilable = true }, + { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AzeriteEssence); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8ec268f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/AzeriteItemDocumentation.lua.annotated.lua @@ -0,0 +1,195 @@ +local AzeriteItem = +{ + Name = "AzeriteItem", + Type = "System", + Namespace = "C_AzeriteItem", + Environment = "All", + + Functions = + { + { + Name = "FindActiveAzeriteItem", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "activeAzeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "GetAzeriteItemXPInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "xp", Type = "number", Nilable = false }, + { Name = "totalLevelXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "powerLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnlimitedPowerLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "powerLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasActiveAzeriteItem", + Type = "Function", + + Returns = + { + { Name = "hasActiveAzeriteItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeriteItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isAzeriteItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeriteItemAtMaxLevel", + Type = "Function", + + Returns = + { + { Name = "isAtMax", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeriteItemByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isAzeriteItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAzeriteItemEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUnlimitedLevelingUnlocked", + Type = "Function", + + Returns = + { + { Name = "isUnlimitedLevelingUnlocked", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AzeriteItemEnabledStateChanged", + Type = "Event", + LiteralName = "AZERITE_ITEM_ENABLED_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AzeriteItemExperienceChanged", + Type = "Event", + LiteralName = "AZERITE_ITEM_EXPERIENCE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "oldExperienceAmount", Type = "number", Nilable = false }, + { Name = "newExperienceAmount", Type = "number", Nilable = false }, + }, + }, + { + Name = "AzeriteItemPowerLevelChanged", + Type = "Event", + LiteralName = "AZERITE_ITEM_POWER_LEVEL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "oldPowerLevel", Type = "number", Nilable = false }, + { Name = "newPowerLevel", Type = "number", Nilable = false }, + { Name = "unlockedEmpoweredItemsInfo", Type = "table", InnerType = "UnlockedAzeriteEmpoweredItems", Nilable = false }, + { Name = "azeriteItemID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "UnlockedAzeriteEmpoweredItems", + Type = "Structure", + Fields = + { + { Name = "unlockedItem", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "tierIndex", Type = "luaIndex", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AzeriteItem); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua.annotated.lua new file mode 100644 index 0000000..eabb29b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BNetOutageDocumentation.lua.annotated.lua @@ -0,0 +1,30 @@ +local BNetOutage = +{ + Name = "BNetOutage", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "ClearOutage", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "OutageDetected", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BNetOutage); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f6e2ea0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,66 @@ +local BagConstants = +{ + Tables = + { + { + Name = "BagFlag", + Type = "Enumeration", + NumValues = 28, + MinValue = 1, + MaxValue = 134217728, + Fields = + { + { Name = "DontFindStack", Type = "BagFlag", EnumValue = 1 }, + { Name = "AlreadyOwner", Type = "BagFlag", EnumValue = 2 }, + { Name = "AlreadyBound", Type = "BagFlag", EnumValue = 4 }, + { Name = "Swap", Type = "BagFlag", EnumValue = 8 }, + { Name = "BagIsEmpty", Type = "BagFlag", EnumValue = 16 }, + { Name = "LookInInventory", Type = "BagFlag", EnumValue = 32 }, + { Name = "IgnoreBoundItemCheck", Type = "BagFlag", EnumValue = 64 }, + { Name = "StackOnly", Type = "BagFlag", EnumValue = 128 }, + { Name = "RecurseQuivers", Type = "BagFlag", EnumValue = 256 }, + { Name = "IgnoreBankcheck", Type = "BagFlag", EnumValue = 512 }, + { Name = "AllowBagsInNonBagSlots", Type = "BagFlag", EnumValue = 1024 }, + { Name = "PreferQuivers", Type = "BagFlag", EnumValue = 2048 }, + { Name = "SwapBags", Type = "BagFlag", EnumValue = 4096 }, + { Name = "IgnoreExisting", Type = "BagFlag", EnumValue = 8192 }, + { Name = "AllowPartialStack", Type = "BagFlag", EnumValue = 16384 }, + { Name = "LookInCharacterBankOnly", Type = "BagFlag", EnumValue = 32768 }, + { Name = "AllowBuyback", Type = "BagFlag", EnumValue = 65536 }, + { Name = "IgnorePetBankcheck", Type = "BagFlag", EnumValue = 131072 }, + { Name = "PreferPriorityBags", Type = "BagFlag", EnumValue = 262144 }, + { Name = "PreferNeutralPriorityBags", Type = "BagFlag", EnumValue = 524288 }, + { Name = "AsymmetricSwap", Type = "BagFlag", EnumValue = 1048576 }, + { Name = "PreferReagentBags", Type = "BagFlag", EnumValue = 2097152 }, + { Name = "IgnoreSoulbound", Type = "BagFlag", EnumValue = 4194304 }, + { Name = "IgnoreReagentBags", Type = "BagFlag", EnumValue = 8388608 }, + { Name = "LookInAccountBankOnly", Type = "BagFlag", EnumValue = 16777216 }, + { Name = "HasRefund", Type = "BagFlag", EnumValue = 33554432 }, + { Name = "SkipValidCountCheck", Type = "BagFlag", EnumValue = 67108864 }, + { Name = "AllowSoulboundItemInAccountBank", Type = "BagFlag", EnumValue = 134217728 }, + }, + }, + { + Name = "BagSlotFlags", + Type = "Enumeration", + NumValues = 10, + MinValue = 1, + MaxValue = 512, + Fields = + { + { Name = "DisableAutoSort", Type = "BagSlotFlags", EnumValue = 1 }, + { Name = "ClassEquipment", Type = "BagSlotFlags", EnumValue = 2 }, + { Name = "ClassConsumables", Type = "BagSlotFlags", EnumValue = 4 }, + { Name = "ClassProfessionGoods", Type = "BagSlotFlags", EnumValue = 8 }, + { Name = "ClassJunk", Type = "BagSlotFlags", EnumValue = 16 }, + { Name = "ClassQuestItems", Type = "BagSlotFlags", EnumValue = 32 }, + { Name = "ExcludeJunkSell", Type = "BagSlotFlags", EnumValue = 64 }, + { Name = "ClassReagents", Type = "BagSlotFlags", EnumValue = 128 }, + { Name = "ExpansionCurrent", Type = "BagSlotFlags", EnumValue = 256 }, + { Name = "ExpansionLegacy", Type = "BagSlotFlags", EnumValue = 512 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BagConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagIndexConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagIndexConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..99756ba --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BagIndexConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,50 @@ +local BagIndexConstants = +{ + Name = "BagIndexConstants", + Type = "System", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + { + Name = "BagIndex", + Type = "Enumeration", + NumValues = 20, + MinValue = -3, + MaxValue = 16, + Fields = + { + { Name = "Accountbanktab", Type = "BagIndex", EnumValue = -3 }, + { Name = "Characterbanktab", Type = "BagIndex", EnumValue = -2 }, + { Name = "Keyring", Type = "BagIndex", EnumValue = -1 }, + { Name = "Backpack", Type = "BagIndex", EnumValue = 0 }, + { Name = "Bag_1", Type = "BagIndex", EnumValue = 1 }, + { Name = "Bag_2", Type = "BagIndex", EnumValue = 2 }, + { Name = "Bag_3", Type = "BagIndex", EnumValue = 3 }, + { Name = "Bag_4", Type = "BagIndex", EnumValue = 4 }, + { Name = "ReagentBag", Type = "BagIndex", EnumValue = 5 }, + { Name = "CharacterBankTab_1", Type = "BagIndex", EnumValue = 6 }, + { Name = "CharacterBankTab_2", Type = "BagIndex", EnumValue = 7 }, + { Name = "CharacterBankTab_3", Type = "BagIndex", EnumValue = 8 }, + { Name = "CharacterBankTab_4", Type = "BagIndex", EnumValue = 9 }, + { Name = "CharacterBankTab_5", Type = "BagIndex", EnumValue = 10 }, + { Name = "CharacterBankTab_6", Type = "BagIndex", EnumValue = 11 }, + { Name = "AccountBankTab_1", Type = "BagIndex", EnumValue = 12 }, + { Name = "AccountBankTab_2", Type = "BagIndex", EnumValue = 13 }, + { Name = "AccountBankTab_3", Type = "BagIndex", EnumValue = 14 }, + { Name = "AccountBankTab_4", Type = "BagIndex", EnumValue = 15 }, + { Name = "AccountBankTab_5", Type = "BagIndex", EnumValue = 16 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BagIndexConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BankDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BankDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6b0fcc5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BankDocumentation.lua.annotated.lua @@ -0,0 +1,428 @@ +local Bank = +{ + Name = "Bank", + Type = "System", + Namespace = "C_Bank", + Environment = "All", + + Functions = + { + { + Name = "AreAnyBankTypesViewable", + Type = "Function", + + Returns = + { + { Name = "areAnyBankTypesViewable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AutoDepositItemsIntoBank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + }, + { + Name = "CanDepositMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "canDepositMoney", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPurchaseBankTab", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "canPurchaseBankTab", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanUseBank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "canUseBank", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanViewBank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "canViewBank", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanWithdrawMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "canWithdrawMoney", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseBankFrame", + Type = "Function", + }, + { + Name = "DepositMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + }, + { + Name = "DoesBankTypeSupportAutoDeposit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "doesBankTypeSupportAutoDeposit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesBankTypeSupportMoneyTransfer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "doesBankTypeSupportMoneyTransfer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FetchBankLockedReason", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "reason", Type = "BankLockedReason", Nilable = true }, + }, + }, + { + Name = "FetchDepositedMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + }, + { + Name = "FetchNextPurchasableBankTabData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "nextPurchasableTabData", Type = "PurchasableBankTabData", Nilable = true }, + }, + }, + { + Name = "FetchNumPurchasedBankTabs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "numPurchasedBankTabs", Type = "number", Nilable = false }, + }, + }, + { + Name = "FetchPurchasedBankTabData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "purchasedBankTabData", Type = "table", InnerType = "BankTabData", Nilable = false }, + }, + }, + { + Name = "FetchPurchasedBankTabIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "purchasedBankTabIDs", Type = "table", InnerType = "BagIndex", Nilable = false }, + }, + }, + { + Name = "FetchViewableBankTypes", + Type = "Function", + + Returns = + { + { Name = "viewableBankTypes", Type = "table", InnerType = "BankType", Nilable = false }, + }, + }, + { + Name = "HasMaxBankTabs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + + Returns = + { + { Name = "hasMaxBankTabs", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemAllowedInBankType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isItemAllowedInBankType", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PurchaseBankTab", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + }, + { + Name = "UpdateBankTabSettings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + { Name = "tabID", Type = "BagIndex", Nilable = false }, + { Name = "tabName", Type = "cstring", Nilable = false }, + { Name = "tabIcon", Type = "cstring", Nilable = false }, + { Name = "depositFlags", Type = "BagSlotFlags", Nilable = false }, + }, + }, + { + Name = "WithdrawMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BankBagSlotFlagsUpdated", + Type = "Event", + LiteralName = "BANK_BAG_SLOT_FLAGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "BankTabSettingsUpdated", + Type = "Event", + LiteralName = "BANK_TAB_SETTINGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + }, + { + Name = "BankTabsChanged", + Type = "Event", + LiteralName = "BANK_TABS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + }, + { + Name = "BankframeClosed", + Type = "Event", + LiteralName = "BANKFRAME_CLOSED", + SynchronousEvent = true, + }, + { + Name = "BankframeOpened", + Type = "Event", + LiteralName = "BANKFRAME_OPENED", + SynchronousEvent = true, + }, + { + Name = "PlayerAccountBankTabSlotsChanged", + Type = "Event", + LiteralName = "PLAYER_ACCOUNT_BANK_TAB_SLOTS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerbankslotsChanged", + Type = "Event", + LiteralName = "PLAYERBANKSLOTS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "BankLockedReason", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "BankLockedReason", EnumValue = 0 }, + { Name = "NoAccountInventoryLock", Type = "BankLockedReason", EnumValue = 1 }, + { Name = "BankDisabled", Type = "BankLockedReason", EnumValue = 2 }, + { Name = "BankConversionFailed", Type = "BankLockedReason", EnumValue = 3 }, + }, + }, + { + Name = "BankTabData", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "bankType", Type = "BankType", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "depositFlags", Type = "BagSlotFlags", Nilable = false }, + { Name = "tabCleanupConfirmation", Type = "cstring", Nilable = false }, + { Name = "tabNameEditBoxHeader", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "PurchasableBankTabData", + Type = "Structure", + Fields = + { + { Name = "tabCost", Type = "BigUInteger", Nilable = false }, + { Name = "canAfford", Type = "bool", Nilable = false }, + { Name = "purchasePromptTitle", Type = "cstring", Nilable = false }, + { Name = "purchasePromptBody", Type = "cstring", Nilable = false }, + { Name = "purchasePromptConfirmation", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Bank); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8a694c9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopDocumentation.lua.annotated.lua @@ -0,0 +1,329 @@ +local BarberShop = +{ + Name = "BarberShop", + Type = "System", + Namespace = "C_BarberShop", + Environment = "All", + + Functions = + { + { + Name = "ApplyCustomizationChoices", + Type = "Function", + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Cancel", + Type = "Function", + }, + { + Name = "ClearPreviewChoices", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clearSavedChoices", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetAvailableCustomizations", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "categories", Type = "table", InnerType = "CharCustomizationCategory", Nilable = false }, + }, + }, + { + Name = "GetCurrentCameraZoom", + Type = "Function", + + Returns = + { + { Name = "zoomLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentCharacterData", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "characterData", Type = "PlayerInfoCharacterData", Nilable = false }, + }, + }, + { + Name = "GetCurrentCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetViewingChrModel", + Type = "Function", + + Returns = + { + { Name = "chrModelID", Type = "number", Nilable = true }, + }, + }, + { + Name = "HasAlteredForm", + Type = "Function", + + Returns = + { + { Name = "hasAlteredForm", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasAnyChanges", + Type = "Function", + + Returns = + { + { Name = "hasChanges", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasCustomizationFeature", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "featureMask", Type = "ChrModelFeatureFlags", Nilable = false }, + }, + + Returns = + { + { Name = "hasCustomizationFeature", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsViewingAlteredForm", + Type = "Function", + + Returns = + { + { Name = "isViewingAlteredForm", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MarkCustomizationChoiceAsSeen", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "choiceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MarkCustomizationOptionAsSeen", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PreviewCustomizationChoice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + { Name = "choiceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RandomizeCustomizationChoices", + Type = "Function", + }, + { + Name = "ResetCameraRotation", + Type = "Function", + }, + { + Name = "ResetCustomizationChoices", + Type = "Function", + }, + { + Name = "RotateCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "diffDegrees", Type = "number", Nilable = false }, + }, + }, + { + Name = "SaveSeenChoices", + Type = "Function", + }, + { + Name = "SetCameraDistanceOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offset", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraZoomLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomLevel", Type = "number", Nilable = false }, + { Name = "keepCustomZoom", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SetCustomizationChoice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + { Name = "choiceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetModelDressState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dressedState", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSelectedSex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sex", Type = "UnitSex", Nilable = false }, + }, + }, + { + Name = "SetViewingAlteredForm", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isViewingAlteredForm", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetViewingChrModel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chrModelID", Type = "number", Nilable = true }, + { Name = "spellShapeshiftFormID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetViewingShapeshiftForm", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "shapeshiftFormID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ZoomCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomAmount", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BarberShopAppearanceApplied", + Type = "Event", + LiteralName = "BARBER_SHOP_APPEARANCE_APPLIED", + UniqueEvent = true, + }, + { + Name = "BarberShopCameraValuesUpdated", + Type = "Event", + LiteralName = "BARBER_SHOP_CAMERA_VALUES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "BarberShopClose", + Type = "Event", + LiteralName = "BARBER_SHOP_CLOSE", + SynchronousEvent = true, + }, + { + Name = "BarberShopCostUpdate", + Type = "Event", + LiteralName = "BARBER_SHOP_COST_UPDATE", + SynchronousEvent = true, + }, + { + Name = "BarberShopForceCustomizationsUpdate", + Type = "Event", + LiteralName = "BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "BarberShopOpen", + Type = "Event", + LiteralName = "BARBER_SHOP_OPEN", + SynchronousEvent = true, + }, + { + Name = "BarberShopResult", + Type = "Event", + LiteralName = "BARBER_SHOP_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BarberShop); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f911377 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BarberShopInternalDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local BarberShopInternal = +{ + Name = "BarberShop", + Type = "System", + Namespace = "C_BarberShopInternal", + Environment = "All", + + Functions = + { + { + Name = "SetQAMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "qaModeEnabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BarberShopInternal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fced442 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BaseDocumentation.lua.annotated.lua @@ -0,0 +1,15 @@ +local Base = +{ + Tables = + { + { + Name = "ScriptObject", + Type = "Structure", + Fields = + { + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Base); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ee9a640 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattleNetDocumentation.lua.annotated.lua @@ -0,0 +1,268 @@ +local BattleNet = +{ + Name = "BattleNet", + Type = "System", + Namespace = "C_BattleNet", + Environment = "All", + + Functions = + { + { + Name = "BNCheckBattleTagInviteToRecentAlly", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recentAllyGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetAccountInfoByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true }, + }, + }, + { + Name = "GetAccountInfoByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "wowAccountGUID", Type = "WOWGUID", Nilable = true }, + }, + + Returns = + { + { Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true }, + }, + }, + { + Name = "GetFriendAccountInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + { Name = "wowAccountGUID", Type = "WOWGUID", Nilable = true }, + }, + + Returns = + { + { Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true }, + }, + }, + { + Name = "GetFriendGameAccountInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + { Name = "accountIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + }, + }, + { + Name = "GetFriendNumGameAccounts", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numGameAccounts", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGameAccountInfoByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + }, + }, + { + Name = "GetGameAccountInfoByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + }, + }, + { + Name = "InstallHighResTextures", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "SendGameData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameAccountID", Type = "number", Nilable = false }, + { Name = "prefix", Type = "stringView", Nilable = false }, + { Name = "data", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "SendAddonMessageResult", Nilable = false }, + }, + }, + { + Name = "SendWhisper", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bnetAccountID", Type = "number", Nilable = false }, + { Name = "text", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAFK", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isAFK", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetCustomMessage", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDND", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isDND", Type = "bool", Nilable = false, Default = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "BNetAccountInfo", + Type = "Structure", + Fields = + { + { Name = "bnetAccountID", Type = "number", Nilable = false }, + { Name = "accountName", Type = "string", Nilable = false }, + { Name = "battleTag", Type = "string", Nilable = false }, + { Name = "isFriend", Type = "bool", Nilable = false }, + { Name = "isBattleTagFriend", Type = "bool", Nilable = false }, + { Name = "lastOnlineTime", Type = "number", Nilable = false }, + { Name = "isAFK", Type = "bool", Nilable = false }, + { Name = "isDND", Type = "bool", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "appearOffline", Type = "bool", Nilable = false }, + { Name = "customMessage", Type = "string", Nilable = false }, + { Name = "customMessageTime", Type = "number", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + { Name = "rafLinkType", Type = "RafLinkType", Nilable = false }, + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = false }, + }, + }, + { + Name = "BNetGameAccountInfo", + Type = "Structure", + Fields = + { + { Name = "gameAccountID", Type = "number", Nilable = false }, + { Name = "clientProgram", Type = "string", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "isGameBusy", Type = "bool", Nilable = false }, + { Name = "isGameAFK", Type = "bool", Nilable = false }, + { Name = "wowProjectID", Type = "number", Nilable = true }, + { Name = "characterName", Type = "string", Nilable = true }, + { Name = "realmName", Type = "string", Nilable = true }, + { Name = "realmDisplayName", Type = "string", Nilable = true }, + { Name = "realmID", Type = "number", Nilable = true }, + { Name = "factionName", Type = "string", Nilable = true }, + { Name = "raceName", Type = "string", Nilable = true }, + { Name = "classID", Type = "number", Nilable = true }, + { Name = "className", Type = "string", Nilable = true }, + { Name = "areaName", Type = "string", Nilable = true }, + { Name = "characterLevel", Type = "number", Nilable = true }, + { Name = "richPresence", Type = "string", Nilable = true }, + { Name = "playerGuid", Type = "WOWGUID", Nilable = true }, + { Name = "canSummon", Type = "bool", Nilable = false }, + { Name = "hasFocus", Type = "bool", Nilable = false }, + { Name = "regionID", Type = "number", Nilable = false }, + { Name = "isInCurrentRegion", Type = "bool", Nilable = false }, + { Name = "timerunningSeasonID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BattleNet); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..54b493c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,398 @@ +local BattlePetConstants = +{ + Tables = + { + { + Name = "BattlePetAbilityFlag", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 32, + Fields = + { + { Name = "DisplayAsHostileDebuff", Type = "BattlePetAbilityFlag", EnumValue = 1 }, + { Name = "HideStrongWeakHints", Type = "BattlePetAbilityFlag", EnumValue = 2 }, + { Name = "Passive", Type = "BattlePetAbilityFlag", EnumValue = 4 }, + { Name = "ServerOnlyAura", Type = "BattlePetAbilityFlag", EnumValue = 8 }, + { Name = "ShowCast", Type = "BattlePetAbilityFlag", EnumValue = 16 }, + { Name = "StartOnCooldown", Type = "BattlePetAbilityFlag", EnumValue = 32 }, + }, + }, + { + Name = "BattlePetAbilitySlot", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "A", Type = "BattlePetAbilitySlot", EnumValue = 0 }, + { Name = "B", Type = "BattlePetAbilitySlot", EnumValue = 1 }, + { Name = "C", Type = "BattlePetAbilitySlot", EnumValue = 2 }, + }, + }, + { + Name = "BattlePetAbilityTargets", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "EnemyFrontPet", Type = "BattlePetAbilityTargets", EnumValue = 0 }, + { Name = "FriendlyFrontPet", Type = "BattlePetAbilityTargets", EnumValue = 1 }, + { Name = "Weather", Type = "BattlePetAbilityTargets", EnumValue = 2 }, + { Name = "EnemyPad", Type = "BattlePetAbilityTargets", EnumValue = 3 }, + { Name = "FriendlyPad", Type = "BattlePetAbilityTargets", EnumValue = 4 }, + { Name = "EnemyBackPet_1", Type = "BattlePetAbilityTargets", EnumValue = 5 }, + { Name = "EnemyBackPet_2", Type = "BattlePetAbilityTargets", EnumValue = 6 }, + { Name = "FriendlyBackPet_1", Type = "BattlePetAbilityTargets", EnumValue = 7 }, + { Name = "FriendlyBackPet_2", Type = "BattlePetAbilityTargets", EnumValue = 8 }, + { Name = "Caster", Type = "BattlePetAbilityTargets", EnumValue = 9 }, + { Name = "Owner", Type = "BattlePetAbilityTargets", EnumValue = 10 }, + { Name = "Specific", Type = "BattlePetAbilityTargets", EnumValue = 11 }, + { Name = "ProcTarget", Type = "BattlePetAbilityTargets", EnumValue = 12 }, + }, + }, + { + Name = "BattlePetAbilityTurnFlag", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 32, + Fields = + { + { Name = "CanProcFromProc", Type = "BattlePetAbilityTurnFlag", EnumValue = 1 }, + { Name = "TriggerBySelf", Type = "BattlePetAbilityTurnFlag", EnumValue = 2 }, + { Name = "TriggerByFriend", Type = "BattlePetAbilityTurnFlag", EnumValue = 4 }, + { Name = "TriggerByEnemy", Type = "BattlePetAbilityTurnFlag", EnumValue = 8 }, + { Name = "TriggerByWeather", Type = "BattlePetAbilityTurnFlag", EnumValue = 16 }, + { Name = "TriggerByAuraCaster", Type = "BattlePetAbilityTurnFlag", EnumValue = 32 }, + }, + }, + { + Name = "BattlePetAbilityTurnType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Normal", Type = "BattlePetAbilityTurnType", EnumValue = 0 }, + { Name = "TriggeredEffect", Type = "BattlePetAbilityTurnType", EnumValue = 1 }, + }, + }, + { + Name = "BattlePetAbilityType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Ability", Type = "BattlePetAbilityType", EnumValue = 0 }, + { Name = "Aura", Type = "BattlePetAbilityType", EnumValue = 1 }, + }, + }, + { + Name = "BattlePetAction", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "BattlePetAction", EnumValue = 0 }, + { Name = "Ability", Type = "BattlePetAction", EnumValue = 1 }, + { Name = "SwitchPet", Type = "BattlePetAction", EnumValue = 2 }, + { Name = "Trap", Type = "BattlePetAction", EnumValue = 3 }, + { Name = "Skip", Type = "BattlePetAction", EnumValue = 4 }, + }, + }, + { + Name = "BattlePetBreedQuality", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Poor", Type = "BattlePetBreedQuality", EnumValue = 0 }, + { Name = "Common", Type = "BattlePetBreedQuality", EnumValue = 1 }, + { Name = "Uncommon", Type = "BattlePetBreedQuality", EnumValue = 2 }, + { Name = "Rare", Type = "BattlePetBreedQuality", EnumValue = 3 }, + { Name = "Epic", Type = "BattlePetBreedQuality", EnumValue = 4 }, + { Name = "Legendary", Type = "BattlePetBreedQuality", EnumValue = 5 }, + }, + }, + { + Name = "BattlePetEffectFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "EnableAbilityPicker", Type = "BattlePetEffectFlags", EnumValue = 1 }, + { Name = "LuaNeedsAllPets", Type = "BattlePetEffectFlags", EnumValue = 2 }, + }, + }, + { + Name = "BattlePetEffectParamType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Int", Type = "BattlePetEffectParamType", EnumValue = 0 }, + { Name = "Ability", Type = "BattlePetEffectParamType", EnumValue = 1 }, + }, + }, + { + Name = "BattlePetEvent", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "OnAuraApplied", Type = "BattlePetEvent", EnumValue = 0 }, + { Name = "OnDamageTaken", Type = "BattlePetEvent", EnumValue = 1 }, + { Name = "OnDamageDealt", Type = "BattlePetEvent", EnumValue = 2 }, + { Name = "OnHealTaken", Type = "BattlePetEvent", EnumValue = 3 }, + { Name = "OnHealDealt", Type = "BattlePetEvent", EnumValue = 4 }, + { Name = "OnAuraRemoved", Type = "BattlePetEvent", EnumValue = 5 }, + { Name = "OnRoundStart", Type = "BattlePetEvent", EnumValue = 6 }, + { Name = "OnRoundEnd", Type = "BattlePetEvent", EnumValue = 7 }, + { Name = "OnTurn", Type = "BattlePetEvent", EnumValue = 8 }, + { Name = "OnAbility", Type = "BattlePetEvent", EnumValue = 9 }, + { Name = "OnSwapIn", Type = "BattlePetEvent", EnumValue = 10 }, + { Name = "OnSwapOut", Type = "BattlePetEvent", EnumValue = 11 }, + { Name = "PostAuraTicks", Type = "BattlePetEvent", EnumValue = 12 }, + }, + }, + { + Name = "BattlePetNpcEmote", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "BattleUnused", Type = "BattlePetNpcEmote", EnumValue = 0 }, + { Name = "BattleStart", Type = "BattlePetNpcEmote", EnumValue = 1 }, + { Name = "BattleWin", Type = "BattlePetNpcEmote", EnumValue = 2 }, + { Name = "BattleLose", Type = "BattlePetNpcEmote", EnumValue = 3 }, + { Name = "PetSwap", Type = "BattlePetNpcEmote", EnumValue = 4 }, + { Name = "PetKill", Type = "BattlePetNpcEmote", EnumValue = 5 }, + { Name = "PetDie", Type = "BattlePetNpcEmote", EnumValue = 6 }, + { Name = "PetAbility", Type = "BattlePetNpcEmote", EnumValue = 7 }, + }, + }, + { + Name = "BattlePetNpcTeamFlag", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "MatchPlayerHighPetLevel", Type = "BattlePetNpcTeamFlag", EnumValue = 1 }, + { Name = "NoPlayerXP", Type = "BattlePetNpcTeamFlag", EnumValue = 2 }, + }, + }, + { + Name = "BattlePetOwner", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Weather", Type = "BattlePetOwner", EnumValue = 0 }, + { Name = "Ally", Type = "BattlePetOwner", EnumValue = 1 }, + { Name = "Enemy", Type = "BattlePetOwner", EnumValue = 2 }, + }, + }, + { + Name = "BattlePetSources", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Drop", Type = "BattlePetSources", EnumValue = 0 }, + { Name = "Quest", Type = "BattlePetSources", EnumValue = 1 }, + { Name = "Vendor", Type = "BattlePetSources", EnumValue = 2 }, + { Name = "Profession", Type = "BattlePetSources", EnumValue = 3 }, + { Name = "WildPet", Type = "BattlePetSources", EnumValue = 4 }, + { Name = "Achievement", Type = "BattlePetSources", EnumValue = 5 }, + { Name = "WorldEvent", Type = "BattlePetSources", EnumValue = 6 }, + { Name = "Promotion", Type = "BattlePetSources", EnumValue = 7 }, + { Name = "Tcg", Type = "BattlePetSources", EnumValue = 8 }, + { Name = "PetStore", Type = "BattlePetSources", EnumValue = 9 }, + { Name = "Discovery", Type = "BattlePetSources", EnumValue = 10 }, + { Name = "TradingPost", Type = "BattlePetSources", EnumValue = 11 }, + }, + }, + { + Name = "BattlePetSpeciesFlags", + Type = "Enumeration", + NumValues = 17, + MinValue = 1, + MaxValue = 65536, + Fields = + { + { Name = "NoRename", Type = "BattlePetSpeciesFlags", EnumValue = 1 }, + { Name = "WellKnown", Type = "BattlePetSpeciesFlags", EnumValue = 2 }, + { Name = "NotAcccountwide", Type = "BattlePetSpeciesFlags", EnumValue = 4 }, + { Name = "Capturable", Type = "BattlePetSpeciesFlags", EnumValue = 8 }, + { Name = "NotTradable", Type = "BattlePetSpeciesFlags", EnumValue = 16 }, + { Name = "HideFromJournal", Type = "BattlePetSpeciesFlags", EnumValue = 32 }, + { Name = "LegacyAccountUnique", Type = "BattlePetSpeciesFlags", EnumValue = 64 }, + { Name = "CantBattle", Type = "BattlePetSpeciesFlags", EnumValue = 128 }, + { Name = "HordeOnly", Type = "BattlePetSpeciesFlags", EnumValue = 256 }, + { Name = "AllianceOnly", Type = "BattlePetSpeciesFlags", EnumValue = 512 }, + { Name = "Boss", Type = "BattlePetSpeciesFlags", EnumValue = 1024 }, + { Name = "RandomDisplay", Type = "BattlePetSpeciesFlags", EnumValue = 2048 }, + { Name = "NoLicenseRequired", Type = "BattlePetSpeciesFlags", EnumValue = 4096 }, + { Name = "AddsAllowedWithBoss", Type = "BattlePetSpeciesFlags", EnumValue = 8192 }, + { Name = "HideUntilLearned", Type = "BattlePetSpeciesFlags", EnumValue = 16384 }, + { Name = "MatchPlayerHighPetLevel", Type = "BattlePetSpeciesFlags", EnumValue = 32768 }, + { Name = "NoWildPetAddsAllowed", Type = "BattlePetSpeciesFlags", EnumValue = 65536 }, + }, + }, + { + Name = "BattlePetStateFlag", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 2048, + Fields = + { + { Name = "None", Type = "BattlePetStateFlag", EnumValue = 0 }, + { Name = "SwapOutLock", Type = "BattlePetStateFlag", EnumValue = 1 }, + { Name = "TurnLock", Type = "BattlePetStateFlag", EnumValue = 2 }, + { Name = "SpeedBonus", Type = "BattlePetStateFlag", EnumValue = 4 }, + { Name = "Client", Type = "BattlePetStateFlag", EnumValue = 8 }, + { Name = "MaxHealthBonus", Type = "BattlePetStateFlag", EnumValue = 16 }, + { Name = "Stamina", Type = "BattlePetStateFlag", EnumValue = 32 }, + { Name = "QualityDoesNotEffect", Type = "BattlePetStateFlag", EnumValue = 64 }, + { Name = "DynamicScaling", Type = "BattlePetStateFlag", EnumValue = 128 }, + { Name = "Power", Type = "BattlePetStateFlag", EnumValue = 256 }, + { Name = "SpeedMult", Type = "BattlePetStateFlag", EnumValue = 512 }, + { Name = "SwapInLock", Type = "BattlePetStateFlag", EnumValue = 1024 }, + { Name = "ServerOnly", Type = "BattlePetStateFlag", EnumValue = 2048 }, + }, + }, + { + Name = "BattlePetTypes", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "Humanoid", Type = "BattlePetTypes", EnumValue = 0 }, + { Name = "Dragonkin", Type = "BattlePetTypes", EnumValue = 1 }, + { Name = "Flying", Type = "BattlePetTypes", EnumValue = 2 }, + { Name = "Undead", Type = "BattlePetTypes", EnumValue = 3 }, + { Name = "Critter", Type = "BattlePetTypes", EnumValue = 4 }, + { Name = "Magic", Type = "BattlePetTypes", EnumValue = 5 }, + { Name = "Elemental", Type = "BattlePetTypes", EnumValue = 6 }, + { Name = "Beast", Type = "BattlePetTypes", EnumValue = 7 }, + { Name = "Aquatic", Type = "BattlePetTypes", EnumValue = 8 }, + { Name = "Mechanical", Type = "BattlePetTypes", EnumValue = 9 }, + }, + }, + { + Name = "BattlePetVisualFlag", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Test1", Type = "BattlePetVisualFlag", EnumValue = 1 }, + { Name = "Test2", Type = "BattlePetVisualFlag", EnumValue = 2 }, + { Name = "Test3", Type = "BattlePetVisualFlag", EnumValue = 4 }, + }, + }, + { + Name = "BattlePetVisualRange", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Melee", Type = "BattlePetVisualRange", EnumValue = 0 }, + { Name = "Ranged", Type = "BattlePetVisualRange", EnumValue = 1 }, + { Name = "InPlace", Type = "BattlePetVisualRange", EnumValue = 2 }, + { Name = "PointBlank", Type = "BattlePetVisualRange", EnumValue = 3 }, + { Name = "BehindMelee", Type = "BattlePetVisualRange", EnumValue = 4 }, + { Name = "BehindRanged", Type = "BattlePetVisualRange", EnumValue = 5 }, + }, + }, + { + Name = "BattlepetDbFlags", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 1024, + Fields = + { + { Name = "None", Type = "BattlepetDbFlags", EnumValue = 0 }, + { Name = "Favorite", Type = "BattlepetDbFlags", EnumValue = 1 }, + { Name = "Converted", Type = "BattlepetDbFlags", EnumValue = 2 }, + { Name = "Revoked", Type = "BattlepetDbFlags", EnumValue = 4 }, + { Name = "LockedForConvert", Type = "BattlepetDbFlags", EnumValue = 8 }, + { Name = "Ability0Selection", Type = "BattlepetDbFlags", EnumValue = 16 }, + { Name = "Ability1Selection", Type = "BattlepetDbFlags", EnumValue = 32 }, + { Name = "Ability2Selection", Type = "BattlepetDbFlags", EnumValue = 64 }, + { Name = "FanfareNeeded", Type = "BattlepetDbFlags", EnumValue = 128 }, + { Name = "DisplayOverridden", Type = "BattlepetDbFlags", EnumValue = 256 }, + { Name = "AcquiredViaLicense", Type = "BattlepetDbFlags", EnumValue = 512 }, + { Name = "TradingPost", Type = "BattlepetDbFlags", EnumValue = 1024 }, + { Name = "LockMask", Type = "BattlepetDbFlags", EnumValue = 12 }, + }, + }, + { + Name = "BattlepetDeletedReason", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Unknown", Type = "BattlepetDeletedReason", EnumValue = 0 }, + { Name = "PlayerReleased", Type = "BattlepetDeletedReason", EnumValue = 1 }, + { Name = "PlayerCaged", Type = "BattlepetDeletedReason", EnumValue = 2 }, + { Name = "Gm", Type = "BattlepetDeletedReason", EnumValue = 3 }, + { Name = "CageError", Type = "BattlepetDeletedReason", EnumValue = 4 }, + { Name = "DelJournal", Type = "BattlepetDeletedReason", EnumValue = 5 }, + { Name = "TradingPost", Type = "BattlepetDeletedReason", EnumValue = 6 }, + { Name = "AccountStore", Type = "BattlepetDeletedReason", EnumValue = 7 }, + }, + }, + { + Name = "BattlepetSlotLockCheat", + Type = "Enumeration", + NumValues = 5, + MinValue = -3, + MaxValue = 1, + Fields = + { + { Name = "Cheat_2_Locked", Type = "BattlepetSlotLockCheat", EnumValue = -3 }, + { Name = "Cheat_1_Locked", Type = "BattlepetSlotLockCheat", EnumValue = -2 }, + { Name = "Cheat_0_Locked", Type = "BattlepetSlotLockCheat", EnumValue = -1 }, + { Name = "CheatOff", Type = "BattlepetSlotLockCheat", EnumValue = 0 }, + { Name = "UnlockAll", Type = "BattlepetSlotLockCheat", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BattlePetConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2d1e55a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlePetDocumentation.lua.annotated.lua @@ -0,0 +1,260 @@ +local BattlePet = +{ + Name = "BattlePet", + Type = "System", + Namespace = "C_BattlePet", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "PetBattleAbilityChanged", + Type = "Event", + LiteralName = "PET_BATTLE_ABILITY_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "abilityID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleActionSelected", + Type = "Event", + LiteralName = "PET_BATTLE_ACTION_SELECTED", + SynchronousEvent = true, + }, + { + Name = "PetBattleAuraApplied", + Type = "Event", + LiteralName = "PET_BATTLE_AURA_APPLIED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleAuraCanceled", + Type = "Event", + LiteralName = "PET_BATTLE_AURA_CANCELED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleAuraChanged", + Type = "Event", + LiteralName = "PET_BATTLE_AURA_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleCaptured", + Type = "Event", + LiteralName = "PET_BATTLE_CAPTURED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleClose", + Type = "Event", + LiteralName = "PET_BATTLE_CLOSE", + SynchronousEvent = true, + }, + { + Name = "PetBattleFinalRound", + Type = "Event", + LiteralName = "PET_BATTLE_FINAL_ROUND", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleHealthChanged", + Type = "Event", + LiteralName = "PET_BATTLE_HEALTH_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "healthChange", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleLevelChanged", + Type = "Event", + LiteralName = "PET_BATTLE_LEVEL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "newLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleMaxHealthChanged", + Type = "Event", + LiteralName = "PET_BATTLE_MAX_HEALTH_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "healthChange", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattleOpeningDone", + Type = "Event", + LiteralName = "PET_BATTLE_OPENING_DONE", + SynchronousEvent = true, + }, + { + Name = "PetBattleOpeningStart", + Type = "Event", + LiteralName = "PET_BATTLE_OPENING_START", + SynchronousEvent = true, + }, + { + Name = "PetBattleOver", + Type = "Event", + LiteralName = "PET_BATTLE_OVER", + SynchronousEvent = true, + }, + { + Name = "PetBattleOverrideAbility", + Type = "Event", + LiteralName = "PET_BATTLE_OVERRIDE_ABILITY", + SynchronousEvent = true, + Payload = + { + { Name = "abilityIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattlePetChanged", + Type = "Event", + LiteralName = "PET_BATTLE_PET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattlePetRoundPlaybackComplete", + Type = "Event", + LiteralName = "PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "roundNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattlePetRoundResults", + Type = "Event", + LiteralName = "PET_BATTLE_PET_ROUND_RESULTS", + SynchronousEvent = true, + Payload = + { + { Name = "roundNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattlePetTypeChanged", + Type = "Event", + LiteralName = "PET_BATTLE_PET_TYPE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "stateValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetBattlePvpDuelRequestCancel", + Type = "Event", + LiteralName = "PET_BATTLE_PVP_DUEL_REQUEST_CANCEL", + SynchronousEvent = true, + }, + { + Name = "PetBattlePvpDuelRequested", + Type = "Event", + LiteralName = "PET_BATTLE_PVP_DUEL_REQUESTED", + SynchronousEvent = true, + Payload = + { + { Name = "fullName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "PetBattleQueueProposalAccepted", + Type = "Event", + LiteralName = "PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED", + SynchronousEvent = true, + }, + { + Name = "PetBattleQueueProposalDeclined", + Type = "Event", + LiteralName = "PET_BATTLE_QUEUE_PROPOSAL_DECLINED", + SynchronousEvent = true, + }, + { + Name = "PetBattleQueueProposeMatch", + Type = "Event", + LiteralName = "PET_BATTLE_QUEUE_PROPOSE_MATCH", + SynchronousEvent = true, + }, + { + Name = "PetBattleQueueStatus", + Type = "Event", + LiteralName = "PET_BATTLE_QUEUE_STATUS", + SynchronousEvent = true, + }, + { + Name = "PetBattleXpChanged", + Type = "Event", + LiteralName = "PET_BATTLE_XP_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "owner", Type = "number", Nilable = false }, + { Name = "petIndex", Type = "number", Nilable = false }, + { Name = "xpChange", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BattlePet); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlepayConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlepayConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0f032df --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BattlepayConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,239 @@ +local BattlepayConstants = +{ + Tables = + { + { + Name = "BulkPurchaseResult", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "ResultOk", Type = "BulkPurchaseResult", EnumValue = 0 }, + { Name = "ResultInProgress", Type = "BulkPurchaseResult", EnumValue = 1 }, + { Name = "ResultPartialSuccess", Type = "BulkPurchaseResult", EnumValue = 2 }, + { Name = "ResultFailed", Type = "BulkPurchaseResult", EnumValue = 3 }, + { Name = "ResultTooManyProducts", Type = "BulkPurchaseResult", EnumValue = 4 }, + { Name = "ResultSystemDisabled", Type = "BulkPurchaseResult", EnumValue = 5 }, + { Name = "ResultInsufficientFunds", Type = "BulkPurchaseResult", EnumValue = 6 }, + { Name = "ResultPurchaseTimeout", Type = "BulkPurchaseResult", EnumValue = 7 }, + }, + }, + { + Name = "BulkPurchaseStatus", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "PlacingOrders", Type = "BulkPurchaseStatus", EnumValue = 0 }, + { Name = "PurchasesPending", Type = "BulkPurchaseStatus", EnumValue = 1 }, + { Name = "FetchEntitlements", Type = "BulkPurchaseStatus", EnumValue = 2 }, + { Name = "Done", Type = "BulkPurchaseStatus", EnumValue = 3 }, + { Name = "Failed", Type = "BulkPurchaseStatus", EnumValue = 4 }, + }, + }, + { + Name = "BulkRefundResult", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "ResultOk", Type = "BulkRefundResult", EnumValue = 0 }, + { Name = "ResultFailed", Type = "BulkRefundResult", EnumValue = 1 }, + { Name = "ResultInvalidRequest", Type = "BulkRefundResult", EnumValue = 2 }, + { Name = "ResultRefundWindowExpired", Type = "BulkRefundResult", EnumValue = 3 }, + { Name = "ResultSystemDisabled", Type = "BulkRefundResult", EnumValue = 4 }, + { Name = "ResultTimeout", Type = "BulkRefundResult", EnumValue = 5 }, + }, + }, + { + Name = "CanRedeemTokenForBalanceResult", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Ok", Type = "CanRedeemTokenForBalanceResult", EnumValue = 0 }, + { Name = "FailureCap", Type = "CanRedeemTokenForBalanceResult", EnumValue = 1 }, + }, + }, + { + Name = "SimpleOrderStatus", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Invalid", Type = "SimpleOrderStatus", EnumValue = 0 }, + { Name = "Creating", Type = "SimpleOrderStatus", EnumValue = 1 }, + { Name = "InProgress", Type = "SimpleOrderStatus", EnumValue = 2 }, + { Name = "Success", Type = "SimpleOrderStatus", EnumValue = 3 }, + { Name = "Failed", Type = "SimpleOrderStatus", EnumValue = 4 }, + }, + }, + { + Name = "VasTransactionPurchaseResult", + Type = "Enumeration", + NumValues = 145, + MinValue = 0, + MaxValue = 20097, + Fields = + { + { Name = "None", Type = "VasTransactionPurchaseResult", EnumValue = 0 }, + { Name = "VasPurchaseDisabled", Type = "VasTransactionPurchaseResult", EnumValue = 1 }, + { Name = "NoneCharacter", Type = "VasTransactionPurchaseResult", EnumValue = 2 }, + { Name = "NoneProduct", Type = "VasTransactionPurchaseResult", EnumValue = 3 }, + { Name = "OnlyOneVasAtATime", Type = "VasTransactionPurchaseResult", EnumValue = 4 }, + { Name = "InvalidDestinationRealm", Type = "VasTransactionPurchaseResult", EnumValue = 5 }, + { Name = "InvalidDestinationAccount", Type = "VasTransactionPurchaseResult", EnumValue = 6 }, + { Name = "InvalidSourceAccount", Type = "VasTransactionPurchaseResult", EnumValue = 7 }, + { Name = "DisallowedSourceAccount", Type = "VasTransactionPurchaseResult", EnumValue = 8 }, + { Name = "DisallowedDestinationAccount", Type = "VasTransactionPurchaseResult", EnumValue = 9 }, + { Name = "UnknownError", Type = "VasTransactionPurchaseResult", EnumValue = 10 }, + { Name = "LowerBoxLevel", Type = "VasTransactionPurchaseResult", EnumValue = 11 }, + { Name = "InvalidDistribution", Type = "VasTransactionPurchaseResult", EnumValue = 12 }, + { Name = "InvalidBpayProductID", Type = "VasTransactionPurchaseResult", EnumValue = 13 }, + { Name = "InvalidBpayDeliverableID", Type = "VasTransactionPurchaseResult", EnumValue = 14 }, + { Name = "InvalidBpayProductType", Type = "VasTransactionPurchaseResult", EnumValue = 15 }, + { Name = "EndServerErrors", Type = "VasTransactionPurchaseResult", EnumValue = 16 }, + { Name = "BeginProxyErrors", Type = "VasTransactionPurchaseResult", EnumValue = 17 }, + { Name = "ProxyBadObjType", Type = "VasTransactionPurchaseResult", EnumValue = 18 }, + { Name = "ProxyObjNotInDb", Type = "VasTransactionPurchaseResult", EnumValue = 19 }, + { Name = "ProxyUniqueKey", Type = "VasTransactionPurchaseResult", EnumValue = 20 }, + { Name = "ProxyDbError", Type = "VasTransactionPurchaseResult", EnumValue = 21 }, + { Name = "ProxyDataInvalid", Type = "VasTransactionPurchaseResult", EnumValue = 22 }, + { Name = "ProxyLostProxyConnection", Type = "VasTransactionPurchaseResult", EnumValue = 23 }, + { Name = "ProxyLocksFailed", Type = "VasTransactionPurchaseResult", EnumValue = 24 }, + { Name = "ProxyMissingResultsPtr", Type = "VasTransactionPurchaseResult", EnumValue = 25 }, + { Name = "ProxyLockedForTransfer", Type = "VasTransactionPurchaseResult", EnumValue = 26 }, + { Name = "ProxyNoReturnValue", Type = "VasTransactionPurchaseResult", EnumValue = 27 }, + { Name = "ProxyDeleteNotSupported", Type = "VasTransactionPurchaseResult", EnumValue = 28 }, + { Name = "ProxyObjDropped", Type = "VasTransactionPurchaseResult", EnumValue = 29 }, + { Name = "ProxyCannotDeleteGuildLeader", Type = "VasTransactionPurchaseResult", EnumValue = 30 }, + { Name = "ProxyCannotDeleteArenaCaptain", Type = "VasTransactionPurchaseResult", EnumValue = 31 }, + { Name = "ProxyMoneyLimitExceeded", Type = "VasTransactionPurchaseResult", EnumValue = 32 }, + { Name = "ProxyBadRequestContained", Type = "VasTransactionPurchaseResult", EnumValue = 33 }, + { Name = "ProxyIsReadonly", Type = "VasTransactionPurchaseResult", EnumValue = 34 }, + { Name = "ProxyBadDbType", Type = "VasTransactionPurchaseResult", EnumValue = 35 }, + { Name = "ProxyOperationAlreadyInProgress", Type = "VasTransactionPurchaseResult", EnumValue = 36 }, + { Name = "ProxyExternalUpdateDetected", Type = "VasTransactionPurchaseResult", EnumValue = 37 }, + { Name = "ProxyCharacterLevelTooHigh", Type = "VasTransactionPurchaseResult", EnumValue = 38 }, + { Name = "ProxyCharacterTransferred", Type = "VasTransactionPurchaseResult", EnumValue = 39 }, + { Name = "ProxyCharacterTransferredNoBoostInProgress", Type = "VasTransactionPurchaseResult", EnumValue = 40 }, + { Name = "ProxyLockedForUpgrade", Type = "VasTransactionPurchaseResult", EnumValue = 41 }, + { Name = "ProxyLockedForToken", Type = "VasTransactionPurchaseResult", EnumValue = 42 }, + { Name = "ProxyLockedForVas", Type = "VasTransactionPurchaseResult", EnumValue = 43 }, + { Name = "ProxyGenericError", Type = "VasTransactionPurchaseResult", EnumValue = 44 }, + { Name = "ProxyCannotInsertNull", Type = "VasTransactionPurchaseResult", EnumValue = 45 }, + { Name = "ProxyCannotUndeleteTrialBoostCharacter", Type = "VasTransactionPurchaseResult", EnumValue = 46 }, + { Name = "ProxyPredicateFailed", Type = "VasTransactionPurchaseResult", EnumValue = 47 }, + { Name = "ProxyWeeklyRewardNotFound", Type = "VasTransactionPurchaseResult", EnumValue = 48 }, + { Name = "ProxyInsertRequestContainedNoData", Type = "VasTransactionPurchaseResult", EnumValue = 49 }, + { Name = "ProxyInvalidKey", Type = "VasTransactionPurchaseResult", EnumValue = 50 }, + { Name = "ProxyBindFailed", Type = "VasTransactionPurchaseResult", EnumValue = 51 }, + { Name = "ProxyTooManyRows", Type = "VasTransactionPurchaseResult", EnumValue = 52 }, + { Name = "ProxyCharacterHasWoWToken", Type = "VasTransactionPurchaseResult", EnumValue = 53 }, + { Name = "ProxyTooBusyBackOff", Type = "VasTransactionPurchaseResult", EnumValue = 54 }, + { Name = "ProxyAccountDataTooBig", Type = "VasTransactionPurchaseResult", EnumValue = 55 }, + { Name = "EndProxyErrors", Type = "VasTransactionPurchaseResult", EnumValue = 56 }, + { Name = "BeginDbErrors", Type = "VasTransactionPurchaseResult", EnumValue = 20010 }, + { Name = "DbRealmNotEligible", Type = "VasTransactionPurchaseResult", EnumValue = 20011 }, + { Name = "DbCannotMoveGuildmaster", Type = "VasTransactionPurchaseResult", EnumValue = 20012 }, + { Name = "DbMaxCharactersOnServer", Type = "VasTransactionPurchaseResult", EnumValue = 20013 }, + { Name = "DbNoMixedAlliance", Type = "VasTransactionPurchaseResult", EnumValue = 20014 }, + { Name = "DbDuplicateCharacterName", Type = "VasTransactionPurchaseResult", EnumValue = 20015 }, + { Name = "DbHasMail", Type = "VasTransactionPurchaseResult", EnumValue = 20016 }, + { Name = "DbAccountDoesNotOwnCharacter", Type = "VasTransactionPurchaseResult", EnumValue = 20017 }, + { Name = "DbMoveInProgress", Type = "VasTransactionPurchaseResult", EnumValue = 20018 }, + { Name = "DbCharacterDoesNotExist", Type = "VasTransactionPurchaseResult", EnumValue = 20019 }, + { Name = "DbNoCopiesAvailable", Type = "VasTransactionPurchaseResult", EnumValue = 20020 }, + { Name = "DbUnderMinLevelReq", Type = "VasTransactionPurchaseResult", EnumValue = 20021 }, + { Name = "DbIneligibleTargetRealm", Type = "VasTransactionPurchaseResult", EnumValue = 20022 }, + { Name = "DbTransferDateTooSoon", Type = "VasTransactionPurchaseResult", EnumValue = 20023 }, + { Name = "DbNewNameTooLong", Type = "VasTransactionPurchaseResult", EnumValue = 20024 }, + { Name = "DbCharNotLocked", Type = "VasTransactionPurchaseResult", EnumValue = 20025 }, + { Name = "DbCharLocked", Type = "VasTransactionPurchaseResult", EnumValue = 20026 }, + { Name = "DbAllianceNotEligible", Type = "VasTransactionPurchaseResult", EnumValue = 20027 }, + { Name = "DbBatchProcessingDisabled", Type = "VasTransactionPurchaseResult", EnumValue = 20028 }, + { Name = "DbNoneBatchQueueID", Type = "VasTransactionPurchaseResult", EnumValue = 20029 }, + { Name = "DbTransferNotFinalized", Type = "VasTransactionPurchaseResult", EnumValue = 20030 }, + { Name = "DbTransferNotCancellable", Type = "VasTransactionPurchaseResult", EnumValue = 20031 }, + { Name = "DbTooMuchMoneyForLevel", Type = "VasTransactionPurchaseResult", EnumValue = 20032 }, + { Name = "DbHasAuctions", Type = "VasTransactionPurchaseResult", EnumValue = 20033 }, + { Name = "DbLastSaveTooRecent", Type = "VasTransactionPurchaseResult", EnumValue = 20034 }, + { Name = "DbTransferNotLockable", Type = "VasTransactionPurchaseResult", EnumValue = 20035 }, + { Name = "DbTransferNotUnlockable", Type = "VasTransactionPurchaseResult", EnumValue = 20036 }, + { Name = "DbNoneRealmForEvent", Type = "VasTransactionPurchaseResult", EnumValue = 20037 }, + { Name = "DbEventRealmClosed", Type = "VasTransactionPurchaseResult", EnumValue = 20038 }, + { Name = "DbNoneTemplateForEvent", Type = "VasTransactionPurchaseResult", EnumValue = 20039 }, + { Name = "DbInventoryCorrupt", Type = "VasTransactionPurchaseResult", EnumValue = 20040 }, + { Name = "DbCouldNotObtainCharLock", Type = "VasTransactionPurchaseResult", EnumValue = 20041 }, + { Name = "DbNoneLockID", Type = "VasTransactionPurchaseResult", EnumValue = 20042 }, + { Name = "DbLockNotAcknowledged", Type = "VasTransactionPurchaseResult", EnumValue = 20043 }, + { Name = "DbLockAlreadyRequested", Type = "VasTransactionPurchaseResult", EnumValue = 20044 }, + { Name = "DbNoneSupportQueueID", Type = "VasTransactionPurchaseResult", EnumValue = 20045 }, + { Name = "DbNoneSupportActionID", Type = "VasTransactionPurchaseResult", EnumValue = 20046 }, + { Name = "DbNotRollbackable", Type = "VasTransactionPurchaseResult", EnumValue = 20047 }, + { Name = "DbNotMovebackable", Type = "VasTransactionPurchaseResult", EnumValue = 20048 }, + { Name = "DbRenameAlreadyRequested", Type = "VasTransactionPurchaseResult", EnumValue = 20049 }, + { Name = "DbReservationExpired", Type = "VasTransactionPurchaseResult", EnumValue = 20050 }, + { Name = "DbNameNotAvailable", Type = "VasTransactionPurchaseResult", EnumValue = 20051 }, + { Name = "DbLastRenameTooRecent", Type = "VasTransactionPurchaseResult", EnumValue = 20052 }, + { Name = "DbReservationDoesNotMatch", Type = "VasTransactionPurchaseResult", EnumValue = 20053 }, + { Name = "DbLastRequestTooSoon", Type = "VasTransactionPurchaseResult", EnumValue = 20054 }, + { Name = "DbAlreadyRenameFlagged", Type = "VasTransactionPurchaseResult", EnumValue = 20055 }, + { Name = "DbMultipleTransferCn", Type = "VasTransactionPurchaseResult", EnumValue = 20056 }, + { Name = "DbCustomizeAlreadyRequested", Type = "VasTransactionPurchaseResult", EnumValue = 20057 }, + { Name = "DbLastCustomizeTooSoon", Type = "VasTransactionPurchaseResult", EnumValue = 20058 }, + { Name = "DbWaitingForPayment", Type = "VasTransactionPurchaseResult", EnumValue = 20059 }, + { Name = "DbUnableToCustomize", Type = "VasTransactionPurchaseResult", EnumValue = 20060 }, + { Name = "DbFactionChangeTooSoon", Type = "VasTransactionPurchaseResult", EnumValue = 20061 }, + { Name = "DbRaceClassComboIneligible", Type = "VasTransactionPurchaseResult", EnumValue = 20062 }, + { Name = "DbDuplicateSupportRequest", Type = "VasTransactionPurchaseResult", EnumValue = 20063 }, + { Name = "DbCannotMoveArenaCaptn", Type = "VasTransactionPurchaseResult", EnumValue = 20064 }, + { Name = "DbNoCsiFound", Type = "VasTransactionPurchaseResult", EnumValue = 20065 }, + { Name = "DbPendingItemAudit", Type = "VasTransactionPurchaseResult", EnumValue = 20066 }, + { Name = "DbBatchStateInvalid", Type = "VasTransactionPurchaseResult", EnumValue = 20067 }, + { Name = "DbEventNotActive", Type = "VasTransactionPurchaseResult", EnumValue = 20068 }, + { Name = "DbGuildRankInsufficient", Type = "VasTransactionPurchaseResult", EnumValue = 20069 }, + { Name = "DbCharacterWithoutGuild", Type = "VasTransactionPurchaseResult", EnumValue = 20070 }, + { Name = "DbDeletedGuild", Type = "VasTransactionPurchaseResult", EnumValue = 20071 }, + { Name = "DbGmSenorityInsufficient", Type = "VasTransactionPurchaseResult", EnumValue = 20072 }, + { Name = "DbAuthenticatorInsufficient", Type = "VasTransactionPurchaseResult", EnumValue = 20073 }, + { Name = "DbGuildLevelInsufficient", Type = "VasTransactionPurchaseResult", EnumValue = 20074 }, + { Name = "DbRegionalDbNotFound", Type = "VasTransactionPurchaseResult", EnumValue = 20075 }, + { Name = "DbIneligibleMapID", Type = "VasTransactionPurchaseResult", EnumValue = 20076 }, + { Name = "DbBnetAccountNotProvided", Type = "VasTransactionPurchaseResult", EnumValue = 20077 }, + { Name = "DbBpayDeliveryPending", Type = "VasTransactionPurchaseResult", EnumValue = 20078 }, + { Name = "DbHasBpayToken", Type = "VasTransactionPurchaseResult", EnumValue = 20079 }, + { Name = "DbHasHeirloomItem", Type = "VasTransactionPurchaseResult", EnumValue = 20080 }, + { Name = "DbResultSourceAccountBanned", Type = "VasTransactionPurchaseResult", EnumValue = 20081 }, + { Name = "DbResultAccountRestricted", Type = "VasTransactionPurchaseResult", EnumValue = 20082 }, + { Name = "DbLastSaveTooDistant", Type = "VasTransactionPurchaseResult", EnumValue = 20083 }, + { Name = "DbCagedPetInInventory", Type = "VasTransactionPurchaseResult", EnumValue = 20084 }, + { Name = "DbOnBoostCooldown", Type = "VasTransactionPurchaseResult", EnumValue = 20085 }, + { Name = "DbNewLeaderInvalid", Type = "VasTransactionPurchaseResult", EnumValue = 20086 }, + { Name = "DbPvEPvPTransferNotAllowed", Type = "VasTransactionPurchaseResult", EnumValue = 20087 }, + { Name = "DbNeedsLevelSquish", Type = "VasTransactionPurchaseResult", EnumValue = 20088 }, + { Name = "DbHasUnclaimedCacheRewards", Type = "VasTransactionPurchaseResult", EnumValue = 20089 }, + { Name = "DbNeedsEraChoice", Type = "VasTransactionPurchaseResult", EnumValue = 20090 }, + { Name = "DbHasNewPlayerExperienceRestriction", Type = "VasTransactionPurchaseResult", EnumValue = 20091 }, + { Name = "DbHasCraftingOrders", Type = "VasTransactionPurchaseResult", EnumValue = 20092 }, + { Name = "DbNameChangeSkipped", Type = "VasTransactionPurchaseResult", EnumValue = 20093 }, + { Name = "DbInvalidName", Type = "VasTransactionPurchaseResult", EnumValue = 20094 }, + { Name = "DbBoostProcessingDisabled", Type = "VasTransactionPurchaseResult", EnumValue = 20095 }, + { Name = "DbHouseOwnerRestriction", Type = "VasTransactionPurchaseResult", EnumValue = 20096 }, + { Name = "EndDbErrors", Type = "VasTransactionPurchaseResult", EnumValue = 20097 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BattlepayConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4194035 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BehavioralMessagingDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local BehavioralMessaging = +{ + Name = "BehavioralMessaging", + Type = "System", + Namespace = "C_BehavioralMessaging", + Environment = "All", + + Functions = + { + { + Name = "SendNotificationReceipt", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dbId", Type = "NotificationDbId", Nilable = false }, + { Name = "openTimeSeconds", Type = "number", Nilable = false }, + { Name = "readTimeSeconds", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BehavioralNotification", + Type = "Event", + LiteralName = "BEHAVIORAL_NOTIFICATION", + SynchronousEvent = true, + Payload = + { + { Name = "notificationType", Type = "string", Nilable = false }, + { Name = "dbId", Type = "NotificationDbId", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BehavioralMessaging); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BlackMarketInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BlackMarketInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d00d337 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BlackMarketInfoDocumentation.lua.annotated.lua @@ -0,0 +1,78 @@ +local BlackMarketInfo = +{ + Name = "BlackMarketInfo", + Type = "System", + Namespace = "C_BlackMarketInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "BlackMarketBidResult", + Type = "Event", + LiteralName = "BLACK_MARKET_BID_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "marketID", Type = "number", Nilable = false }, + { Name = "resultCode", Type = "number", Nilable = false }, + }, + }, + { + Name = "BlackMarketClose", + Type = "Event", + LiteralName = "BLACK_MARKET_CLOSE", + SynchronousEvent = true, + }, + { + Name = "BlackMarketItemUpdate", + Type = "Event", + LiteralName = "BLACK_MARKET_ITEM_UPDATE", + SynchronousEvent = true, + }, + { + Name = "BlackMarketOpen", + Type = "Event", + LiteralName = "BLACK_MARKET_OPEN", + SynchronousEvent = true, + }, + { + Name = "BlackMarketOutbid", + Type = "Event", + LiteralName = "BLACK_MARKET_OUTBID", + SynchronousEvent = true, + Payload = + { + { Name = "marketID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BlackMarketUnavailable", + Type = "Event", + LiteralName = "BLACK_MARKET_UNAVAILABLE", + SynchronousEvent = true, + }, + { + Name = "BlackMarketWon", + Type = "Event", + LiteralName = "BLACK_MARKET_WON", + SynchronousEvent = true, + Payload = + { + { Name = "marketID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BlackMarketInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/Blizzard_APIDocumentationGenerated.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/Blizzard_APIDocumentationGenerated.toc new file mode 100644 index 0000000..8388f9d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/Blizzard_APIDocumentationGenerated.toc @@ -0,0 +1,583 @@ +## Title: Blizzard API Documentation Generated +## Author: Blizzard Entertainment +## LoadOnDemand: 1 +## AllowLoad: Both +## Dependencies: Blizzard_APIDocumentation + +# Start documentation files here +AbbreviateConfigAPIDocumentation.lua +AccessibilityOptionsDocumentation.lua +AccountInfoDocumentation.lua +AccountStoreDocumentation.lua +AchievementInfoDocumentation.lua +AchievementTelemetryDocumentation.lua +ActionBarFrameDocumentation.lua +AddOnProfilerDocumentation.lua +AddOnsDocumentation.lua +AdventureJournalDocumentation.lua +AdventureMapDocumentation.lua +AlliedRacesFrameDocumentation.lua +AnimaDiversionUIDocumentation.lua +ArdenwealdGardeningDocumentation.lua +AreaPoiInfoDocumentation.lua +ArtifactUIDocumentation.lua +AssistedCombatDocumentation.lua +AuctionHouseDocumentation.lua +AzeriteEmpoweredItemDocumentation.lua +AzeriteEssenceDocumentation.lua +AzeriteItemDocumentation.lua +BNetOutageDocumentation.lua +BagIndexConstantsDocumentation.lua +BankDocumentation.lua +BarberShopInternalDocumentation.lua +BarberShopDocumentation.lua +BattleNetDocumentation.lua +BattlePetDocumentation.lua +BehavioralMessagingDocumentation.lua +BlackMarketInfoDocumentation.lua +BrowserDocumentation.lua +BuildDocumentation.lua +CVarDocumentation.lua +CalendarDocumentation.lua +CameraDocumentation.lua +CatalogShopDocumentation.lua +ChallengeModeInfoDocumentation.lua +ChatBubblesDocumentation.lua +ChatInfoDocumentation.lua +ChromieTimeUIDocumentation.lua +CinematicDocumentation.lua +CinematicListDocumentation.lua +ClassColorDocumentation.lua +ClassTalentsDocumentation.lua +ClassTrialDocumentation.lua +ClickBindingsDocumentation.lua +ClientDocumentation.lua +ClientSceneDocumentation.lua +ClubDocumentation.lua +ClubFinderDocumentation.lua +ColorOverridesDocumentation.lua +ColorUtilDocumentation.lua +CombatAudioAlertDocumentation.lua +CombatLogDocumentation.lua +CombatLogInternalDocumentation.lua +CombatLogSecureDocumentation.lua +CombatTextDocumentation.lua +CommentatorFrameDocumentation.lua +CompactUnitFramesDocumentation.lua +ConfigurationWarningsDocumentation.lua +ConnectionDocumentation.lua +ConsoleDocumentation.lua +ConsoleScriptCollectionDocumentation.lua +ContainerDocumentation.lua +ContentTrackingDocumentation.lua +ContributionCollectorDocumentation.lua +CooldownViewerDocumentation.lua +CovenantsDocumentation.lua +CovenantCallingsDocumentation.lua +CovenantPreviewDocumentation.lua +CovenantSanctumDocumentation.lua +CraftingOrderUIDocumentation.lua +CreatureInfoDocumentation.lua +CurrencyInfoDocumentation.lua +CursorDocumentation.lua +CursorUtilDocumentation.lua +CurveUtilDocumentation.lua +DamageMeterDocumentation.lua +DateAndTimeDocumentation.lua +DeathAlertDocumentation.lua +DeathInfoDocumentation.lua +DeathRecapDocumentation.lua +DebugToggleDocumentation.lua +DelvesUIDocumentation.lua +DuelInfoDocumentation.lua +DurationUtilDocumentation.lua +DyeColorInfoDocumentation.lua +EditModeManagerDocumentation.lua +EncodingUtilDocumentation.lua +EncounterEventsDocumentation.lua +EncounterInfoDocumentation.lua +EncounterJournalDocumentation.lua +EncounterTimelineDocumentation.lua +EncounterWarningsDocumentation.lua +EndOfMatchUIDocumentation.lua +EquipmentManagerDocumentation.lua +EventSchedulerUIDocumentation.lua +EventUtilsDocumentation.lua +ExpansionDocumentation.lua +ExpansionInfoDocumentation.lua +ExpansionTrialDocumentation.lua +ExternalEventURLDocumentation.lua +FogOfWarDocumentation.lua +FontDocumentation.lua +FrameAPIArchaeologyDigsiteDocumentation.lua +FrameAPIBlobDocumentation.lua +FrameAPICharacterModelBaseDocumentation.lua +FrameAPICinematicModelDocumentation.lua +FrameAPICooldownDocumentation.lua +FrameAPIDressUpModelDocumentation.lua +FrameAPIFogOfWarFrameDocumentation.lua +FrameAPIModelSceneFrameDocumentation.lua +FrameAPIModelSceneFrameActorDocumentation.lua +FrameAPIModelSceneFrameActorBaseDocumentation.lua +FrameAPINamePlateDocumentation.lua +FrameAPIQuestPOIDocumentation.lua +FrameAPIScenarioPOIDocumentation.lua +FrameAPISimpleCheckoutDocumentation.lua +FrameAPITabardModelDocumentation.lua +FrameAPITabardModelBaseDocumentation.lua +FrameAPITooltipDocumentation.lua +FrameAPIUnitPositionFrameDocumentation.lua +FrameScriptDocumentation.lua +FriendListDocumentation.lua +GMTicketInfoDocumentation.lua +GameCursorDocumentation.lua +GameErrorDocumentation.lua +GamePadDocumentation.lua +GameRulesDocumentation.lua +GameUIDocumentation.lua +GarrisonInfoDocumentation.lua +UIGenericWidgetDisplayDocumentation.lua +GlueDocumentation.lua +GlyphInfoDocumentation.lua +GossipInfoDocumentation.lua +GuildBankDocumentation.lua +GuildInfoDocumentation.lua +HeirloomInfoDocumentation.lua +HouseEditorUIDocumentation.lua +HouseExteriorUIDocumentation.lua +HousingBasicModeUIDocumentation.lua +HousingCatalogSearcherAPIDocumentation.lua +HousingCatalogUIDocumentation.lua +HousingCleanupModeUIDocumentation.lua +HousingCustomizeModeUIDocumentation.lua +HousingDecorUIDocumentation.lua +HousingExpertModeUIDocumentation.lua +HousingFixturePointFrameAPIDocumentation.lua +HousingLayoutPinFrameAPIDocumentation.lua +HousingLayoutUIDocumentation.lua +HousingNeighborhoodUIDocumentation.lua +HousingPhotoSharingUIDocumentation.lua +HousingUIDocumentation.lua +ImmersiveInteractionManagerDocumentation.lua +InGameNavigationDocumentation.lua +IncomingSummonDocumentation.lua +InputDocumentation.lua +InstanceDocumentation.lua +InstanceEncounterDocumentation.lua +InstanceLeaverInfoDocumentation.lua +InterfaceFileManifestDocumentation.lua +InvasionInfoDocumentation.lua +IslandsInfoDocumentation.lua +IslandsQueueUIDocumentation.lua +ItemDocumentation.lua +ItemInteractionUIDocumentation.lua +ItemSocketInfoDocumentation.lua +ItemTextDocumentation.lua +ItemUpgradeDocumentation.lua +KeyBindingsDocumentation.lua +LFGInfoDocumentation.lua +LFGListInfoDocumentation.lua +LegendaryCraftingDocumentation.lua +LevelLinkDocumentation.lua +LevelSquishDocumentation.lua +LimitedInputDocumentation.lua +LiveEventDocumentation.lua +LoadingScreenDocumentation.lua +LobbyMatchmakerInfoDocumentation.lua +LocaleDocumentation.lua +LocalizationDocumentation.lua +LogDocumentation.lua +LootDocumentation.lua +LootHistoryDocumentation.lua +LootJournalDocumentation.lua +LoreTextDocumentation.lua +LossOfControlDocumentation.lua +LuaColorCurveObjectAPIDocumentation.lua +LuaCurveObjectAPIDocumentation.lua +LuaCurveObjectBaseAPIDocumentation.lua +LuaDurationObjectAPIDocumentation.lua +LuaTableUtilDocumentation.lua +MacOptionsDocumentation.lua +MailInfoDocumentation.lua +MajorFactionsDocumentation.lua +MapExplorationDocumentation.lua +MapDocumentation.lua +MerchantFrameDocumentation.lua +MinimapDocumentation.lua +MinimapFrameAPIDocumentation.lua +MirrorTimerDocumentation.lua +UIModelInfoDocumentation.lua +MountJournalDocumentation.lua +MovieDocumentation.lua +MythicPlusInfoDocumentation.lua +NamePlateDocumentation.lua +NamePlateManagerDocumentation.lua +NeighborhoodInitiativeDocumentation.lua +NewItemsDocumentation.lua +OsDocumentation.lua +PaperDollInfoDocumentation.lua +ParentalControlsDocumentation.lua +PartyInfoDocumentation.lua +PartyPoseUIDocumentation.lua +PerformanceDocumentation.lua +PerksActivitiesDocumentation.lua +PerksProgramDocumentation.lua +PetBattlesDocumentation.lua +PetInfoDocumentation.lua +PetJournalInfoDocumentation.lua +PingManagerDocumentation.lua +PingManagerSecureDocumentation.lua +PingPinFrameAPIDocumentation.lua +PlatformDocumentation.lua +PlayerChoiceDocumentation.lua +PlayerInfoDocumentation.lua +PlayerInteractionManagerDocumentation.lua +PlayerLocationDocumentation.lua +PlayerMentorshipDocumentation.lua +PlayerScriptDocumentation.lua +PonyDocumentation.lua +ProfessionSpecUIDocumentation.lua +PvpInfoDocumentation.lua +QuestHubInfoDocumentation.lua +QuestInfoSystemDocumentation.lua +QuestItemUseDocumentation.lua +QuestLineInfoDocumentation.lua +QuestLogDocumentation.lua +QuestOfferDocumentation.lua +QuestSessionDocumentation.lua +QuestTaskInfoDocumentation.lua +RaidLocksDocumentation.lua +RaidMarkersDocumentation.lua +RecentAlliesDocumentation.lua +RecruitAFriendDocumentation.lua +RemixArtifactUIDocumentation.lua +ReportSystemDocumentation.lua +ReputationInfoDocumentation.lua +ResearchInfoDocumentation.lua +RestrictedActionsDocumentation.lua +ScenarioInfoDocumentation.lua +ScrappingMachineUIDocumentation.lua +ScreenDocumentation.lua +ScriptWarningsDocumentation.lua +ScriptedAnimationsDocumentation.lua +SeasonInfoDocumentation.lua +SecretPredicateAPIDocumentation.lua +SecureTransferDocumentation.lua +SettingsUtilDocumentation.lua +SharedTraitsDocumentation.lua +SimpleAnimAPIDocumentation.lua +SimpleAnimAlphaAPIDocumentation.lua +SimpleAnimFlipBookAPIDocumentation.lua +SimpleAnimGroupAPIDocumentation.lua +SimpleAnimPathAPIDocumentation.lua +SimpleAnimRotationAPIDocumentation.lua +SimpleAnimScaleAPIDocumentation.lua +SimpleAnimScaleLineAPIDocumentation.lua +SimpleAnimTextureCoordTranslationAPIDocumentation.lua +SimpleAnimTranslationAPIDocumentation.lua +SimpleAnimTranslationLineAPIDocumentation.lua +SimpleAnimVertexColorAPIDocumentation.lua +SimpleAnimatableObjectAPIDocumentation.lua +SimpleBrowserAPIDocumentation.lua +SimpleButtonAPIDocumentation.lua +SimpleCheckboxAPIDocumentation.lua +SimpleColorSelectAPIDocumentation.lua +SimpleControlPointAPIDocumentation.lua +SimpleEditBoxAPIDocumentation.lua +SimpleFontAPIDocumentation.lua +SimpleFontStringAPIDocumentation.lua +SimpleFrameAPIDocumentation.lua +SimpleFrameScriptObjectAPIDocumentation.lua +SimpleHTMLAPIDocumentation.lua +SimpleLineAPIDocumentation.lua +SimpleMapSceneAPIDocumentation.lua +SimpleMaskTextureAPIDocumentation.lua +SimpleMessageFrameAPIDocumentation.lua +SimpleModelAPIDocumentation.lua +SimpleModelFFXAPIDocumentation.lua +SimpleMovieAPIDocumentation.lua +SimpleObjectAPIDocumentation.lua +SimpleOffScreenFrameAPIDocumentation.lua +SimpleRegionAPIDocumentation.lua +SimpleScriptRegionAPIDocumentation.lua +SimpleScriptRegionResizingAPIDocumentation.lua +SimpleScrollFrameAPIDocumentation.lua +SimpleSliderAPIDocumentation.lua +SimpleStatusBarAPIDocumentation.lua +SimpleTextureAPIDocumentation.lua +SimpleTextureBaseAPIDocumentation.lua +SkillInfoDocumentation.lua +SlashCommandDocumentation.lua +SocialQueueDocumentation.lua +SocialRestrictionsDocumentation.lua +SoulbindsDocumentation.lua +SoundDocumentation.lua +SpecializationInfoDocumentation.lua +SpecializationSharedDocumentation.lua +SpellDocumentation.lua +SpellActivationOverlayDocumentation.lua +SpellBookDocumentation.lua +SpellDiminishUIDocumentation.lua +SplashScreenDocumentation.lua +StableInfoDocumentation.lua +StorePublicUIDocumentation.lua +StreamingDocumentation.lua +StringUtilDocumentation.lua +SummonInfoDocumentation.lua +SuperTrackManagerDocumentation.lua +SystemDocumentation.lua +SystemTimeDocumentation.lua +TTSSettingsDocumentation.lua +TalkingHeadDocumentation.lua +TargetScriptDocumentation.lua +TaxiMapDocumentation.lua +TextureUtilsDocumentation.lua +ThreatDocumentation.lua +TimerunningUIDocumentation.lua +TitleDocumentation.lua +TooltipComparisonDocumentation.lua +TooltipInfoDocumentation.lua +TotemDocumentation.lua +ToyBoxInfoDocumentation.lua +TradeInfoDocumentation.lua +TradeSkillUIDocumentation.lua +TrainerDocumentation.lua +TraitConfigDocumentation.lua +TransmogOutfitInfoDocumentation.lua +TransmogDocumentation.lua +TransmogItemsDocumentation.lua +TransmogSetsDocumentation.lua +TutorialDocumentation.lua +UIManagerDocumentation.lua +UIActionDocumentation.lua +UIColorDocumentation.lua +UIEventToastManagerDocumentation.lua +UIFrameManagerDocumentation.lua +UIMacrosDocumentation.lua +UIModifiedInstanceDocumentation.lua +UISystemVisibilityManagerDocumentation.lua +UITimerDocumentation.lua +UIWidgetManagerDocumentation.lua +URLDocumentation.lua +UnitDocumentation.lua +UnitAuraDocumentation.lua +UnitHealPredictionCalculatorAPIDocumentation.lua +UnitRoleDocumentation.lua +UserFeedbackDocumentation.lua +VehicleDocumentation.lua +VideoDocumentation.lua +VignetteInfoDocumentation.lua +VoiceChatDocumentation.lua +WarCampaignDocumentation.lua +WarbandSceneInfoDocumentation.lua +WeeklyRewardsDocumentation.lua +WorldLootObjectDocumentation.lua +WorldSafeLocsUIInternalDocumentation.lua +WorldStateInfoDocumentation.lua +WowEntitlementInfoDocumentation.lua +WowSurveyDocumentation.lua +WowTokenUIDocumentation.lua +XMLUtilDocumentation.lua +ZoneAbilityDocumentation.lua +ZoneScriptDocumentation.lua +AccountConstantsDocumentation.lua +ActionDocumentation.lua +ActionBarSharedDocumentation.lua +AddOnProfilerConstantsDocumentation.lua +AppearanceSourceDocumentation.lua +ArrowCalloutConstantsDocumentation.lua +AsyncAssistActionsConstantsDocumentation.lua +AuctionHouseConstantsDocumentation.lua +AuctionHouseEnumsDocumentation.lua +AzeriteConstantsDocumentation.lua +BagConstantsDocumentation.lua +BaseDocumentation.lua +BattlePetConstantsDocumentation.lua +BattlepayConstantsDocumentation.lua +BountySharedDocumentation.lua +ButtonStateDocumentation.lua +CalendarConstantsDocumentation.lua +CameraConstantsDocumentation.lua +CatalogShopConstantsDocumentation.lua +CharacterCreationConstantsDocumentation.lua +CharacterCustomizationSharedDocumentation.lua +CharacterSelectionConstantsDocumentation.lua +CharacterServicesConstantsDocumentation.lua +ChatConstantsDocumentation.lua +CinematicConstantsDocumentation.lua +ClickBindingsConstantsDocumentation.lua +ClientSettingsDocumentation.lua +ClubSharedDocumentation.lua +ColorDocumentation.lua +ColorOverrideConstantsDocumentation.lua +CombatAudioAlertConstantsDocumentation.lua +CombatAudioAlertSharedDocumentation.lua +CombatLogConstantsDocumentation.lua +CombatLogSharedDocumentation.lua +CombatTextSharedDocumentation.lua +CommentatorSharedDocumentation.lua +ConfigurationWarningConstantsDocumentation.lua +ContentTrackingTypesDocumentation.lua +CooldownViewerConstantsDocumentation.lua +CovenantCallingsConstantsDocumentation.lua +CovenantSanctumConstantsDocumentation.lua +CovenantsConstantsDocumentation.lua +CraftingOrderUIConstantsDocumentation.lua +CraftingOrderUISharedDocumentation.lua +CurrencyConstantsDocumentation.lua +CurrencyConstants_MainlineDocumentation.lua +CursorConstDocumentation.lua +DamageConstantsDocumentation.lua +DamageMeterConstantsDocumentation.lua +DelvesConstantsDocumentation.lua +DungeonEncounterConstantsDocumentation.lua +DyeColorInfoSharedDocumentation.lua +EditModeManagerConstantsDocumentation.lua +EditModeManagerConstants_MainlineDocumentation.lua +EncodingUtilConstantsDocumentation.lua +EncounterEventsSharedDocumentation.lua +EncounterJournalConstantsDocumentation.lua +EncounterTimelineConstantsDocumentation.lua +EventSchedulerConstantsDocumentation.lua +ExpansionConstantsDocumentation.lua +ExpansionLevelConstantsDocumentation.lua +FrameAPIModelSceneFrameSharedDocumentation.lua +GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua +GARRISON_TYPEConstantsDocumentation.lua +GamePadConstDocumentation.lua +GameRulesConstantsDocumentation.lua +GarrisonConstantsDocumentation.lua +GarrisonSharedDocumentation.lua +GlyphConstantsDocumentation.lua +GossipConstantsDocumentation.lua +GroupFinderConstantsDocumentation.lua +GuildConstantsDocumentation.lua +GuildInfoSharedDocumentation.lua +HouseExteriorConstantsDocumentation.lua +HousingCatalogConstantsDocumentation.lua +HousingDecorSharedDocumentation.lua +HousingLayoutUITypesDocumentation.lua +HousingUISharedDocumentation.lua +ImageSharingConstantsDocumentation.lua +InputConstantsDocumentation.lua +ItemConstantsDocumentation.lua +ItemConstants_MainlineDocumentation.lua +ItemConstants_SharedDocumentation.lua +ItemQualitiesDocumentation.lua +ItemSharedDocumentation.lua +LFGConstantsDocumentation.lua +LegendaryCraftingTypesDocumentation.lua +LevelConstantsDocumentation.lua +LocalizationSharedDocumentation.lua +LogConstantsDocumentation.lua +LogicConstantsDocumentation.lua +LootConstantsDocumentation.lua +LuaCurveObjectConstantsDocumentation.lua +LuaDurationObjectSharedDocumentation.lua +MajorFactionsConstantsDocumentation.lua +MapConstantsDocumentation.lua +MatrixSharedDocumentation.lua +MinimapConstantsDocumentation.lua +ModelAnimationSharedDocumentation.lua +MoneyConstantsDocumentation.lua +MountConstantsDocumentation.lua +MythicPlusInfoSharedDocumentation.lua +NamePlateConstantsDocumentation.lua +NeighborhoodInitiativesConstantsDocumentation.lua +PVPMgrConstantsDocumentation.lua +PartyConstantsDocumentation.lua +PartyPoseUIConstantsDocumentation.lua +PerksVendorConstantsDocumentation.lua +PetBattleConstantsDocumentation.lua +PetConstantsDocumentation.lua +PetScalingConstantsDocumentation.lua +PingConstantsDocumentation.lua +PlayerDocumentation.lua +PlayerDataConstantsDocumentation.lua +PlayerHousingConstantsDocumentation.lua +PlayerInfoSharedDocumentation.lua +PlayerInteractionManagerConstantsDocumentation.lua +PlayerMentorshipConstantsDocumentation.lua +PowerTypeConstantsDocumentation.lua +ProceduralSpawnConstantsDocumentation.lua +ProfessionConstantsDocumentation.lua +ProfessionSpecConstantsDocumentation.lua +PvPFactionConstantsDocumentation.lua +PvpInfoConstantsDocumentation.lua +QuestConstantsDocumentation.lua +QuestConstants_MainlineDocumentation.lua +QuestInfoSharedDocumentation.lua +QuestRewardsDocumentation.lua +QuestSessionConstantsDocumentation.lua +QueueSpecificDocumentation.lua +RecentAlliesConstantsDocumentation.lua +RecruitAFriendSharedDocumentation.lua +RenownConstantsDocumentation.lua +ReportSystemConstantsDocumentation.lua +RestrictedActionsConstantsDocumentation.lua +RolodexConstantsDocumentation.lua +ScreenLocationConstantsDocumentation.lua +ScriptRegionSharedDocumentation.lua +SeasonsConstantsDocumentation.lua +SecretAspectConstantsDocumentation.lua +SecretPredicatesDocumentation.lua +SecretWrapperConstantsDocumentation.lua +SharedScriptObjectModelLightDocumentation.lua +SharedScriptObjectNamePlateFrameDocumentation.lua +SharedScriptObjectUnitPositionFrameDocumentation.lua +SharedTraitsEnumsDocumentation.lua +SimpleHTMLSharedDocumentation.lua +SimpleStatusBarConstantsDocumentation.lua +SocialConstantsDocumentation.lua +SoftTargetConstantsDocumentation.lua +SoulbindsConstantsDocumentation.lua +SpellBookConstantsDocumentation.lua +SpellConstantsDocumentation.lua +SpellDiminishConstantsDocumentation.lua +SpellIDDocumentation.lua +SpellSharedDocumentation.lua +SplashScreenConstantsDocumentation.lua +SummonConstantsDocumentation.lua +SuperTrackManagerSharedDocumentation.lua +TalentAndGlyphConstantsDocumentation.lua +TextureSharedDocumentation.lua +TimeDocumentation.lua +TimerConstantsDocumentation.lua +TimerunningConstantsDocumentation.lua +TooltipConstantsDocumentation.lua +TooltipInfoSharedDocumentation.lua +TradeSkillUITypesDocumentation.lua +TraitConstantsDocumentation.lua +TransformManipulatorConstantsDocumentation.lua +TransmogConstantsDocumentation.lua +TransmogOutfitConstantsDocumentation.lua +TransmogSharedDocumentation.lua +UIActionConstantsDocumentation.lua +UIButtonSharedDocumentation.lua +UICharacterClassConstantsDocumentation.lua +UIColorSharedDocumentation.lua +UICovenantDisplayInfoConstantsDocumentation.lua +UIEventToastConstantsDocumentation.lua +UIFileAssetSharedDocumentation.lua +UIMapPinSharedDocumentation.lua +UIModelInfoSharedDocumentation.lua +UISharedDocumentation.lua +UITextureAssetSharedDocumentation.lua +UITextureConstantsDocumentation.lua +UIWidgetManagerSharedDocumentation.lua +UiModelSceneConstantsDocumentation.lua +UiRpcRequestManagerConstantsDocumentation.lua +UnitAuraSharedDocumentation.lua +UnitConstantsDocumentation.lua +UnitHealPredictionCalculatorSharedDocumentation.lua +UnitSexConstantsDocumentation.lua +UnitSharedDocumentation.lua +ValidateNameConstantsDocumentation.lua +VectorSharedDocumentation.lua +VignetteConstantsDocumentation.lua +WarbandSceneInfoConstantsDocumentation.lua +WeeklyRewardsSharedDocumentation.lua +WorldElapsedTimerConstantsDocumentation.lua +WowCSConstantsDocumentation.lua +WowSurveyConstantsDocumentation.lua +# End documentation files here diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..40d5f20 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BountySharedDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local BountyShared = +{ + Tables = + { + { + Name = "BountyInfo", + Type = "Structure", + Fields = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "numObjectives", Type = "number", Nilable = false }, + { Name = "turninRequirementText", Type = "cstring", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BountyShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BrowserDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BrowserDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4c2802a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BrowserDocumentation.lua.annotated.lua @@ -0,0 +1,63 @@ +local Browser = +{ + Name = "Browser", + Type = "System", + Namespace = "C_Browser", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "SimpleBrowserPopup", + Type = "Event", + LiteralName = "SIMPLE_BROWSER_POPUP", + SynchronousEvent = true, + Payload = + { + { Name = "url", Type = "string", Nilable = false }, + }, + }, + { + Name = "SimpleBrowserSocialCallbackInvoked", + Type = "Event", + LiteralName = "SIMPLE_BROWSER_SOCIAL_CALLBACK_INVOKED", + UniqueEvent = true, + Payload = + { + { Name = "url", Type = "string", Nilable = false }, + }, + }, + { + Name = "SimpleBrowserWebError", + Type = "Event", + LiteralName = "SIMPLE_BROWSER_WEB_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "errorCode", Type = "number", Nilable = false }, + }, + }, + { + Name = "SimpleBrowserWebProxyFailed", + Type = "Event", + LiteralName = "SIMPLE_BROWSER_WEB_PROXY_FAILED", + SynchronousEvent = true, + }, + { + Name = "SimpleCheckoutClosed", + Type = "Event", + LiteralName = "SIMPLE_CHECKOUT_CLOSED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Browser); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ff02758 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/BuildDocumentation.lua.annotated.lua @@ -0,0 +1,125 @@ +local Build = +{ + Name = "Build", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetBuildInfo", + Type = "Function", + + Returns = + { + { Name = "buildVersion", Type = "cstring", Nilable = false }, + { Name = "buildNumber", Type = "cstring", Nilable = false }, + { Name = "buildDate", Type = "cstring", Nilable = false }, + { Name = "interfaceVersion", Type = "number", Nilable = false }, + { Name = "localizedVersion", Type = "cstring", Nilable = false }, + { Name = "buildInfo", Type = "string", Nilable = false }, + }, + }, + { + Name = "Is64BitClient", + Type = "Function", + + Returns = + { + { Name = "is64Bit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBetaBuild", + Type = "Function", + + Returns = + { + { Name = "isBetaBuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDebugBuild", + Type = "Function", + + Returns = + { + { Name = "isDebugBuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLinuxClient", + Type = "Function", + + Returns = + { + { Name = "isLinux", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMacClient", + Type = "Function", + + Returns = + { + { Name = "isMac", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPublicBuild", + Type = "Function", + + Returns = + { + { Name = "isPublicBuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPublicTestClient", + Type = "Function", + Documentation = { "Reflects the state of the OnlyBetaAndPTR TOC directive" }, + + Returns = + { + { Name = "isPublicTestClient", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTestBuild", + Type = "Function", + + Returns = + { + { Name = "isTestBuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWindowsClient", + Type = "Function", + + Returns = + { + { Name = "isWindows", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SupportsClipCursor", + Type = "Function", + + Returns = + { + { Name = "supportsClipCursor", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Build); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ButtonStateDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ButtonStateDocumentation.lua.annotated.lua new file mode 100644 index 0000000..32b1c8e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ButtonStateDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local ButtonState = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ButtonState); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e7274cc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CVarDocumentation.lua.annotated.lua @@ -0,0 +1,173 @@ +local CVar = +{ + Name = "CVarScripts", + Type = "System", + Namespace = "C_CVar", + Environment = "All", + + Functions = + { + { + Name = "GetCVar", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetCVarBitfield", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetCVarBool", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetCVarDefault", + Type = "Function", + RequiresValidAndPublicCVar = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "defaultValue", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetCVarInfo", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "cstring", Nilable = false }, + { Name = "defaultValue", Type = "cstring", Nilable = false }, + { Name = "isStoredServerAccount", Type = "bool", Nilable = false }, + { Name = "isStoredServerCharacter", Type = "bool", Nilable = false }, + { Name = "isLockedFromUser", Type = "bool", Nilable = false }, + { Name = "isSecure", Type = "bool", Nilable = false }, + { Name = "isReadOnly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterCVar", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "value", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "ResetTestCVars", + Type = "Function", + }, + { + Name = "SetCVar", + Type = "Function", + RequiresValidAndPublicCVar = true, + RequiresNonReadOnlyCVar = true, + RequiresNonSecureCVar = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "value", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCVarBitfield", + Type = "Function", + RequiresValidAndPublicCVar = true, + RequiresNonReadOnlyCVar = true, + RequiresNonSecureCVar = true, + RequiresIndexInRange = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "value", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "CVarInfo", + Type = "Structure", + Fields = + { + { Name = "value", Type = "cstring", Nilable = false }, + { Name = "defaultValue", Type = "cstring", Nilable = false }, + { Name = "isStoredServerAccount", Type = "bool", Nilable = false }, + { Name = "isStoredServerCharacter", Type = "bool", Nilable = false }, + { Name = "isLockedFromUser", Type = "bool", Nilable = false }, + { Name = "isSecure", Type = "bool", Nilable = false }, + { Name = "isReadOnly", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CVar); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3e2b7a7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,346 @@ +local CalendarConstants = +{ + Tables = + { + { + Name = "CalendarCommandType", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Create", Type = "CalendarCommandType", EnumValue = 0 }, + { Name = "Invite", Type = "CalendarCommandType", EnumValue = 1 }, + { Name = "Rsvp", Type = "CalendarCommandType", EnumValue = 2 }, + { Name = "RemoveInvite", Type = "CalendarCommandType", EnumValue = 3 }, + { Name = "RemoveEvent", Type = "CalendarCommandType", EnumValue = 4 }, + { Name = "Status", Type = "CalendarCommandType", EnumValue = 5 }, + { Name = "ModeratorStatus", Type = "CalendarCommandType", EnumValue = 6 }, + { Name = "GetCalendar", Type = "CalendarCommandType", EnumValue = 7 }, + { Name = "GetEvent", Type = "CalendarCommandType", EnumValue = 8 }, + { Name = "UpdateEvent", Type = "CalendarCommandType", EnumValue = 9 }, + { Name = "Complain", Type = "CalendarCommandType", EnumValue = 10 }, + { Name = "Notes", Type = "CalendarCommandType", EnumValue = 11 }, + }, + }, + { + Name = "CalendarErrorType", + Type = "Enumeration", + NumValues = 51, + MinValue = 0, + MaxValue = 50, + Fields = + { + { Name = "Success", Type = "CalendarErrorType", EnumValue = 0 }, + { Name = "CommunityEventsExceeded", Type = "CalendarErrorType", EnumValue = 1 }, + { Name = "EventsExceeded", Type = "CalendarErrorType", EnumValue = 2 }, + { Name = "SelfInvitesExceeded", Type = "CalendarErrorType", EnumValue = 3 }, + { Name = "OtherInvitesExceeded", Type = "CalendarErrorType", EnumValue = 4 }, + { Name = "NoPermission", Type = "CalendarErrorType", EnumValue = 5 }, + { Name = "EventInvalid", Type = "CalendarErrorType", EnumValue = 6 }, + { Name = "NotInvited", Type = "CalendarErrorType", EnumValue = 7 }, + { Name = "UnknownError", Type = "CalendarErrorType", EnumValue = 8 }, + { Name = "NotInGuild", Type = "CalendarErrorType", EnumValue = 9 }, + { Name = "NotInCommunity", Type = "CalendarErrorType", EnumValue = 10 }, + { Name = "TargetAlreadyInvited", Type = "CalendarErrorType", EnumValue = 11 }, + { Name = "NameNotFound", Type = "CalendarErrorType", EnumValue = 12 }, + { Name = "WrongFaction", Type = "CalendarErrorType", EnumValue = 13 }, + { Name = "Ignored", Type = "CalendarErrorType", EnumValue = 14 }, + { Name = "InvitesExceeded", Type = "CalendarErrorType", EnumValue = 15 }, + { Name = "InvalidMaxSize", Type = "CalendarErrorType", EnumValue = 16 }, + { Name = "InvalidDate", Type = "CalendarErrorType", EnumValue = 17 }, + { Name = "InvalidTime", Type = "CalendarErrorType", EnumValue = 18 }, + { Name = "NoInvites", Type = "CalendarErrorType", EnumValue = 19 }, + { Name = "NeedsTitle", Type = "CalendarErrorType", EnumValue = 20 }, + { Name = "EventPassed", Type = "CalendarErrorType", EnumValue = 21 }, + { Name = "EventLocked", Type = "CalendarErrorType", EnumValue = 22 }, + { Name = "DeleteCreatorFailed", Type = "CalendarErrorType", EnumValue = 23 }, + { Name = "DataAlreadySet", Type = "CalendarErrorType", EnumValue = 24 }, + { Name = "CalendarDisabled", Type = "CalendarErrorType", EnumValue = 25 }, + { Name = "RestrictedAccount", Type = "CalendarErrorType", EnumValue = 26 }, + { Name = "ArenaEventsExceeded", Type = "CalendarErrorType", EnumValue = 27 }, + { Name = "RestrictedLevel", Type = "CalendarErrorType", EnumValue = 28 }, + { Name = "Squelched", Type = "CalendarErrorType", EnumValue = 29 }, + { Name = "NoInvite", Type = "CalendarErrorType", EnumValue = 30 }, + { Name = "ComplaintDisabled", Type = "CalendarErrorType", EnumValue = 31 }, + { Name = "ComplaintSelf", Type = "CalendarErrorType", EnumValue = 32 }, + { Name = "ComplaintSameGuild", Type = "CalendarErrorType", EnumValue = 33 }, + { Name = "ComplaintGm", Type = "CalendarErrorType", EnumValue = 34 }, + { Name = "ComplaintLimit", Type = "CalendarErrorType", EnumValue = 35 }, + { Name = "ComplaintNotFound", Type = "CalendarErrorType", EnumValue = 36 }, + { Name = "EventWrongServer", Type = "CalendarErrorType", EnumValue = 37 }, + { Name = "NoCommunityInvites", Type = "CalendarErrorType", EnumValue = 38 }, + { Name = "InvalidSignup", Type = "CalendarErrorType", EnumValue = 39 }, + { Name = "NoModerator", Type = "CalendarErrorType", EnumValue = 40 }, + { Name = "ModeratorRestricted", Type = "CalendarErrorType", EnumValue = 41 }, + { Name = "InvalidNotes", Type = "CalendarErrorType", EnumValue = 42 }, + { Name = "InvalidTitle", Type = "CalendarErrorType", EnumValue = 43 }, + { Name = "InvalidDescription", Type = "CalendarErrorType", EnumValue = 44 }, + { Name = "InvalidClub", Type = "CalendarErrorType", EnumValue = 45 }, + { Name = "CreatorNotFound", Type = "CalendarErrorType", EnumValue = 46 }, + { Name = "EventThrottled", Type = "CalendarErrorType", EnumValue = 47 }, + { Name = "InviteThrottled", Type = "CalendarErrorType", EnumValue = 48 }, + { Name = "Internal", Type = "CalendarErrorType", EnumValue = 49 }, + { Name = "ComplaintAdded", Type = "CalendarErrorType", EnumValue = 50 }, + }, + }, + { + Name = "CalendarEventBits", + Type = "Enumeration", + NumValues = 15, + MinValue = 1, + MaxValue = 3788, + Fields = + { + { Name = "Player", Type = "CalendarEventBits", EnumValue = 1 }, + { Name = "GuildDeprecated", Type = "CalendarEventBits", EnumValue = 2 }, + { Name = "System", Type = "CalendarEventBits", EnumValue = 4 }, + { Name = "Holiday", Type = "CalendarEventBits", EnumValue = 8 }, + { Name = "Locked", Type = "CalendarEventBits", EnumValue = 16 }, + { Name = "AutoApprove", Type = "CalendarEventBits", EnumValue = 32 }, + { Name = "CommunityAnnouncement", Type = "CalendarEventBits", EnumValue = 64 }, + { Name = "RaidLockout", Type = "CalendarEventBits", EnumValue = 128 }, + { Name = "ArenaDeprecated", Type = "CalendarEventBits", EnumValue = 256 }, + { Name = "RaidResetDeprecated", Type = "CalendarEventBits", EnumValue = 512 }, + { Name = "CommunitySignup", Type = "CalendarEventBits", EnumValue = 1024 }, + { Name = "GuildSignup", Type = "CalendarEventBits", EnumValue = 2048 }, + { Name = "CommunityWide", Type = "CalendarEventBits", EnumValue = 3136 }, + { Name = "PlayerCreated", Type = "CalendarEventBits", EnumValue = 3395 }, + { Name = "CantComplain", Type = "CalendarEventBits", EnumValue = 3788 }, + }, + }, + { + Name = "CalendarEventRepeatOptions", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Never", Type = "CalendarEventRepeatOptions", EnumValue = 0 }, + { Name = "Weekly", Type = "CalendarEventRepeatOptions", EnumValue = 1 }, + { Name = "Biweekly", Type = "CalendarEventRepeatOptions", EnumValue = 2 }, + { Name = "Monthly", Type = "CalendarEventRepeatOptions", EnumValue = 3 }, + }, + }, + { + Name = "CalendarEventType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Raid", Type = "CalendarEventType", EnumValue = 0 }, + { Name = "Dungeon", Type = "CalendarEventType", EnumValue = 1 }, + { Name = "PvP", Type = "CalendarEventType", EnumValue = 2 }, + { Name = "Meeting", Type = "CalendarEventType", EnumValue = 3 }, + { Name = "Other", Type = "CalendarEventType", EnumValue = 4 }, + { Name = "HeroicDeprecated", Type = "CalendarEventType", EnumValue = 5 }, + }, + }, + { + Name = "CalendarFilterFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "WeeklyHoliday", Type = "CalendarFilterFlags", EnumValue = 1 }, + { Name = "Darkmoon", Type = "CalendarFilterFlags", EnumValue = 2 }, + { Name = "Battleground", Type = "CalendarFilterFlags", EnumValue = 4 }, + { Name = "RaidLockout", Type = "CalendarFilterFlags", EnumValue = 8 }, + { Name = "RaidReset", Type = "CalendarFilterFlags", EnumValue = 16 }, + }, + }, + { + Name = "CalendarGetEventType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Get", Type = "CalendarGetEventType", EnumValue = 0 }, + { Name = "Add", Type = "CalendarGetEventType", EnumValue = 1 }, + { Name = "Copy", Type = "CalendarGetEventType", EnumValue = 2 }, + }, + }, + { + Name = "CalendarHolidayFilterType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Weekly", Type = "CalendarHolidayFilterType", EnumValue = 0 }, + { Name = "Darkmoon", Type = "CalendarHolidayFilterType", EnumValue = 1 }, + { Name = "Battleground", Type = "CalendarHolidayFilterType", EnumValue = 2 }, + }, + }, + { + Name = "CalendarInviteBits", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "CalendarInviteBits", EnumValue = 0 }, + { Name = "PendingInvite", Type = "CalendarInviteBits", EnumValue = 1 }, + { Name = "Moderator", Type = "CalendarInviteBits", EnumValue = 2 }, + { Name = "Creator", Type = "CalendarInviteBits", EnumValue = 4 }, + { Name = "Signup", Type = "CalendarInviteBits", EnumValue = 8 }, + }, + }, + { + Name = "CalendarInviteSortType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Name", Type = "CalendarInviteSortType", EnumValue = 0 }, + { Name = "Level", Type = "CalendarInviteSortType", EnumValue = 1 }, + { Name = "Class", Type = "CalendarInviteSortType", EnumValue = 2 }, + { Name = "Status", Type = "CalendarInviteSortType", EnumValue = 3 }, + { Name = "Party", Type = "CalendarInviteSortType", EnumValue = 4 }, + { Name = "Notes", Type = "CalendarInviteSortType", EnumValue = 5 }, + }, + }, + { + Name = "CalendarInviteType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Normal", Type = "CalendarInviteType", EnumValue = 0 }, + { Name = "Signup", Type = "CalendarInviteType", EnumValue = 1 }, + }, + }, + { + Name = "CalendarModeratorStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "CalendarModeratorStatus", EnumValue = 0 }, + { Name = "Moderator", Type = "CalendarModeratorStatus", EnumValue = 1 }, + { Name = "Creator", Type = "CalendarModeratorStatus", EnumValue = 2 }, + }, + }, + { + Name = "CalendarStatus", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Invited", Type = "CalendarStatus", EnumValue = 0 }, + { Name = "Available", Type = "CalendarStatus", EnumValue = 1 }, + { Name = "Declined", Type = "CalendarStatus", EnumValue = 2 }, + { Name = "Confirmed", Type = "CalendarStatus", EnumValue = 3 }, + { Name = "Out", Type = "CalendarStatus", EnumValue = 4 }, + { Name = "Standby", Type = "CalendarStatus", EnumValue = 5 }, + { Name = "Signedup", Type = "CalendarStatus", EnumValue = 6 }, + { Name = "NotSignedup", Type = "CalendarStatus", EnumValue = 7 }, + { Name = "Tentative", Type = "CalendarStatus", EnumValue = 8 }, + }, + }, + { + Name = "CalendarTexturesType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Dungeons", Type = "CalendarTexturesType", EnumValue = 0 }, + { Name = "Raid", Type = "CalendarTexturesType", EnumValue = 1 }, + }, + }, + { + Name = "CalendarType", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Player", Type = "CalendarType", EnumValue = 0 }, + { Name = "Community", Type = "CalendarType", EnumValue = 1 }, + { Name = "RaidLockout", Type = "CalendarType", EnumValue = 2 }, + { Name = "RaidResetDeprecated", Type = "CalendarType", EnumValue = 3 }, + { Name = "Holiday", Type = "CalendarType", EnumValue = 4 }, + { Name = "HolidayWeekly", Type = "CalendarType", EnumValue = 5 }, + { Name = "HolidayDarkmoon", Type = "CalendarType", EnumValue = 6 }, + { Name = "HolidayBattleground", Type = "CalendarType", EnumValue = 7 }, + }, + }, + { + Name = "CalendarWebActionType", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Accept", Type = "CalendarWebActionType", EnumValue = 0 }, + { Name = "Decline", Type = "CalendarWebActionType", EnumValue = 1 }, + { Name = "Remove", Type = "CalendarWebActionType", EnumValue = 2 }, + { Name = "ReportSpam", Type = "CalendarWebActionType", EnumValue = 3 }, + { Name = "Signup", Type = "CalendarWebActionType", EnumValue = 4 }, + { Name = "Tentative", Type = "CalendarWebActionType", EnumValue = 5 }, + { Name = "TentativeSignup", Type = "CalendarWebActionType", EnumValue = 6 }, + }, + }, + { + Name = "HolidayCalendarFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "Alliance", Type = "HolidayCalendarFlags", EnumValue = 1 }, + { Name = "Horde", Type = "HolidayCalendarFlags", EnumValue = 2 }, + }, + }, + { + Name = "HolidayFlags", + Type = "Enumeration", + NumValues = 7, + MinValue = 1, + MaxValue = 64, + Fields = + { + { Name = "IsRegionwide", Type = "HolidayFlags", EnumValue = 1 }, + { Name = "DontShowInCalendar", Type = "HolidayFlags", EnumValue = 2 }, + { Name = "DontDisplayEnd", Type = "HolidayFlags", EnumValue = 4 }, + { Name = "DontDisplayBanner", Type = "HolidayFlags", EnumValue = 8 }, + { Name = "NotAvailableClientSide", Type = "HolidayFlags", EnumValue = 16 }, + { Name = "DurationUseMinutes", Type = "HolidayFlags", EnumValue = 32 }, + { Name = "BeginEventOnlyOnStageChange", Type = "HolidayFlags", EnumValue = 64 }, + }, + }, + { + Name = "CalendarGetEventTypeConstants", + Type = "Constants", + Values = + { + { Name = "DEFAULT_CALENDAR_GET_EVENT_TYPE", Type = "CalendarGetEventType", Value = Enum.CalendarGetEventType.Get }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CalendarConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b84ed47 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CalendarDocumentation.lua.annotated.lua @@ -0,0 +1,1183 @@ +local Calendar = +{ + Name = "Calendar", + Type = "System", + Namespace = "C_Calendar", + Environment = "All", + + Functions = + { + { + Name = "AddEvent", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "AreNamesReady", + Type = "Function", + + Returns = + { + { Name = "ready", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanAddEvent", + Type = "Function", + + Returns = + { + { Name = "canAddEvent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSendInvite", + Type = "Function", + + Returns = + { + { Name = "canSendInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseEvent", + Type = "Function", + }, + { + Name = "ContextMenuEventCanComplain", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canComplain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventCanEdit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventCanRemove", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canRemove", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventClipboard", + Type = "Function", + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventCopy", + Type = "Function", + }, + { + Name = "ContextMenuEventGetCalendarType", + Type = "Function", + + Returns = + { + { Name = "calendarType", Type = "string", Nilable = true }, + }, + }, + { + Name = "ContextMenuEventPaste", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventRemove", + Type = "Function", + }, + { + Name = "ContextMenuEventSignUp", + Type = "Function", + }, + { + Name = "ContextMenuGetEventIndex", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, + }, + }, + { + Name = "ContextMenuInviteAvailable", + Type = "Function", + }, + { + Name = "ContextMenuInviteDecline", + Type = "Function", + }, + { + Name = "ContextMenuInviteRemove", + Type = "Function", + }, + { + Name = "ContextMenuInviteTentative", + Type = "Function", + }, + { + Name = "ContextMenuSelectEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CreateCommunitySignUpEvent", + Type = "Function", + }, + { + Name = "CreateGuildAnnouncementEvent", + Type = "Function", + }, + { + Name = "CreateGuildSignUpEvent", + Type = "Function", + }, + { + Name = "CreatePlayerEvent", + Type = "Function", + }, + { + Name = "EventAvailable", + Type = "Function", + }, + { + Name = "EventCanEdit", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventClearAutoApprove", + Type = "Function", + }, + { + Name = "EventClearLocked", + Type = "Function", + }, + { + Name = "EventClearModerator", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventDecline", + Type = "Function", + }, + { + Name = "EventGetCalendarType", + Type = "Function", + + Returns = + { + { Name = "calendarType", Type = "string", Nilable = true }, + }, + }, + { + Name = "EventGetClubId", + Type = "Function", + + Returns = + { + { Name = "info", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "EventGetInvite", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CalendarEventInviteInfo", Nilable = false }, + }, + }, + { + Name = "EventGetInviteResponseTime", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "time", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "EventGetInviteSortCriterion", + Type = "Function", + + Returns = + { + { Name = "criterion", Type = "string", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventGetSelectedInvite", + Type = "Function", + + Returns = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "EventGetStatusOptions", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "options", Type = "table", InnerType = "CalendarEventStatusOption", Nilable = false }, + }, + }, + { + Name = "EventGetTextures", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + }, + + Returns = + { + { Name = "textures", Type = "table", InnerType = "CalendarEventTextureInfo", Nilable = false }, + }, + }, + { + Name = "EventGetTypes", + Type = "Function", + + Returns = + { + { Name = "types", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "EventGetTypesDisplayOrdered", + Type = "Function", + + Returns = + { + { Name = "infos", Type = "table", InnerType = "CalendarEventTypeDisplayInfo", Nilable = false }, + }, + }, + { + Name = "EventHasPendingInvite", + Type = "Function", + + Returns = + { + { Name = "hasPendingInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventHaveSettingsChanged", + Type = "Function", + + Returns = + { + { Name = "haveSettingsChanged", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventInvite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EventRemoveInvite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventRemoveInviteByGuid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "EventSelectInvite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventSetAutoApprove", + Type = "Function", + }, + { + Name = "EventSetClubId", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "EventSetDate", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "EventSetDescription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "description", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EventSetInviteStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "status", Type = "CalendarStatus", Nilable = false }, + }, + }, + { + Name = "EventSetLocked", + Type = "Function", + }, + { + Name = "EventSetModerator", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventSetTextureID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventSetTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "EventSetTitle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "title", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EventSetType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "typeIndex", Type = "CalendarEventType", Nilable = false }, + }, + }, + { + Name = "EventSignUp", + Type = "Function", + }, + { + Name = "EventSortInvites", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "criterion", Type = "cstring", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventTentative", + Type = "Function", + }, + { + Name = "GetClubCalendarEvents", + Type = "Function", + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "startTime", Type = "CalendarTime", Nilable = false }, + { Name = "endTime", Type = "CalendarTime", Nilable = false }, + }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "CalendarDayEvent", Nilable = false }, + }, + }, + { + Name = "GetDayEvent", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "event", Type = "CalendarDayEvent", Nilable = false }, + }, + }, + { + Name = "GetDefaultGuildFilter", + Type = "Function", + + Returns = + { + { Name = "info", Type = "CalendarGuildFilterInfo", Nilable = false }, + }, + }, + { + Name = "GetEventIndex", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, + }, + }, + { + Name = "GetEventIndexInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventID", Type = "CalendarEventID", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "monthDay", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "eventIndexInfo", Type = "CalendarEventIndexInfo", Nilable = true }, + }, + }, + { + Name = "GetEventInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "info", Type = "CalendarEventInfo", Nilable = false }, + }, + }, + { + Name = "GetFirstPendingInvite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "firstPendingInvite", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetGuildEventInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CalendarGuildEventInfo", Nilable = false }, + }, + }, + { + Name = "GetGuildEventSelectionInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, + }, + }, + { + Name = "GetHolidayInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "event", Type = "CalendarHolidayInfo", Nilable = false }, + }, + }, + { + Name = "GetMaxCreateDate", + Type = "Function", + + Returns = + { + { Name = "maxCreateDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "GetMinDate", + Type = "Function", + + Returns = + { + { Name = "minDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "GetMonthInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "monthInfo", Type = "CalendarMonthInfo", Nilable = false }, + }, + }, + { + Name = "GetNextClubId", + Type = "Function", + + Returns = + { + { Name = "clubId", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "GetNumDayEvents", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numDayEvents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGuildEvents", + Type = "Function", + + Returns = + { + { Name = "numGuildEvents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumInvites", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumPendingInvites", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRaidInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CalendarRaidInfo", Nilable = false }, + }, + }, + { + Name = "IsActionPending", + Type = "Function", + + Returns = + { + { Name = "actionPending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEventOpen", + Type = "Function", + + Returns = + { + { Name = "isOpen", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MassInviteCommunity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "maxRankOrder", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "MassInviteGuild", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "maxRankOrder", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "OpenCalendar", + Type = "Function", + }, + { + Name = "OpenEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveEvent", + Type = "Function", + }, + { + Name = "SetAbsMonth", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMonth", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetNextClubId", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "UpdateEvent", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + { + Name = "CalendarActionPending", + Type = "Event", + LiteralName = "CALENDAR_ACTION_PENDING", + SynchronousEvent = true, + Payload = + { + { Name = "pending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarCloseEvent", + Type = "Event", + LiteralName = "CALENDAR_CLOSE_EVENT", + SynchronousEvent = true, + }, + { + Name = "CalendarEventAlarm", + Type = "Event", + LiteralName = "CALENDAR_EVENT_ALARM", + SynchronousEvent = true, + Payload = + { + { Name = "title", Type = "cstring", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarNewEvent", + Type = "Event", + LiteralName = "CALENDAR_NEW_EVENT", + SynchronousEvent = true, + Payload = + { + { Name = "isCopy", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarOpenEvent", + Type = "Event", + LiteralName = "CALENDAR_OPEN_EVENT", + SynchronousEvent = true, + Payload = + { + { Name = "calendarType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "CalendarUpdateError", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "errorReason", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "CalendarUpdateErrorWithCount", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_ERROR_WITH_COUNT", + SynchronousEvent = true, + Payload = + { + { Name = "errorReason", Type = "cstring", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarUpdateErrorWithPlayerName", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME", + SynchronousEvent = true, + Payload = + { + { Name = "errorReason", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "CalendarUpdateEvent", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_EVENT", + SynchronousEvent = true, + }, + { + Name = "CalendarUpdateEventList", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_EVENT_LIST", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "CalendarUpdateGuildEvents", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_GUILD_EVENTS", + SynchronousEvent = true, + }, + { + Name = "CalendarUpdateInviteList", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_INVITE_LIST", + SynchronousEvent = true, + Payload = + { + { Name = "hasCompleteList", Type = "bool", Nilable = true }, + }, + }, + { + Name = "CalendarUpdatePendingInvites", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_PENDING_INVITES", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "CalendarDayEvent", + Type = "Structure", + Fields = + { + { Name = "eventID", Type = "CalendarEventID", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "isCustomTitle", Type = "bool", Nilable = false }, + { Name = "startTime", Type = "CalendarTime", Nilable = false }, + { Name = "endTime", Type = "CalendarTime", Nilable = false }, + { Name = "calendarType", Type = "cstring", Nilable = false }, + { Name = "sequenceType", Type = "cstring", Nilable = false }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + { Name = "iconTexture", Type = "fileID", Nilable = true }, + { Name = "modStatus", Type = "cstring", Nilable = false }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = false }, + { Name = "invitedBy", Type = "string", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, + { Name = "inviteType", Type = "CalendarInviteType", Nilable = false }, + { Name = "sequenceIndex", Type = "luaIndex", Nilable = false }, + { Name = "numSequenceDays", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "cstring", Nilable = false }, + { Name = "dontDisplayBanner", Type = "bool", Nilable = false }, + { Name = "dontDisplayEnd", Type = "bool", Nilable = false }, + { Name = "clubID", Type = "ClubId", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarEventIndexInfo", + Type = "Structure", + Fields = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CalendarEventInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "creator", Type = "string", Nilable = true }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + { Name = "repeatOption", Type = "CalendarEventRepeatOptions", Nilable = false }, + { Name = "maxSize", Type = "number", Nilable = false }, + { Name = "textureIndex", Type = "luaIndex", Nilable = true }, + { Name = "time", Type = "CalendarTime", Nilable = false }, + { Name = "lockoutTime", Type = "CalendarTime", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "isAutoApprove", Type = "bool", Nilable = false }, + { Name = "hasPendingInvite", Type = "bool", Nilable = false }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = true }, + { Name = "inviteType", Type = "CalendarInviteType", Nilable = true }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "communityName", Type = "string", Nilable = true }, + }, + }, + { + Name = "CalendarEventInviteInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "className", Type = "string", Nilable = true }, + { Name = "classFilename", Type = "string", Nilable = true }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = true }, + { Name = "modStatus", Type = "string", Nilable = true }, + { Name = "inviteIsMine", Type = "bool", Nilable = false }, + { Name = "type", Type = "CalendarInviteType", Nilable = false }, + { Name = "notes", Type = "string", Nilable = false }, + { Name = "classID", Type = "number", Nilable = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "CalendarEventStatusOption", + Type = "Structure", + Fields = + { + { Name = "status", Type = "CalendarStatus", Nilable = false }, + { Name = "statusString", Type = "string", Nilable = false }, + }, + }, + { + Name = "CalendarEventTextureInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "iconTexture", Type = "fileID", Nilable = false }, + { Name = "expansionLevel", Type = "number", Nilable = false }, + { Name = "difficultyId", Type = "number", Nilable = true }, + { Name = "mapId", Type = "number", Nilable = true }, + { Name = "isLfr", Type = "bool", Nilable = true }, + }, + }, + { + Name = "CalendarEventTypeDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "displayString", Type = "string", Nilable = false }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + }, + }, + { + Name = "CalendarGuildEventInfo", + Type = "Structure", + Fields = + { + { Name = "eventID", Type = "CalendarEventID", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "weekday", Type = "luaIndex", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = false }, + { Name = "clubID", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "CalendarGuildFilterInfo", + Type = "Structure", + Fields = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarHolidayInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "startTime", Type = "CalendarTime", Nilable = true }, + { Name = "endTime", Type = "CalendarTime", Nilable = true }, + }, + }, + { + Name = "CalendarMonthInfo", + Type = "Structure", + Fields = + { + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "numDays", Type = "number", Nilable = false }, + { Name = "firstWeekday", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CalendarRaidInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "raidID", Type = "number", Nilable = false }, + { Name = "time", Type = "CalendarTime", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Calendar); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..faaae9b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local CameraConstants = +{ + Tables = + { + { + Name = "CameraModeAspectRatio", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Default", Type = "CameraModeAspectRatio", EnumValue = 0 }, + { Name = "LegacyLetterbox", Type = "CameraModeAspectRatio", EnumValue = 1 }, + { Name = "HighDefinition_16_X_9", Type = "CameraModeAspectRatio", EnumValue = 2 }, + { Name = "Cinemascope_2_Dot_4_X_1", Type = "CameraModeAspectRatio", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CameraConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8acf85a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CameraDocumentation.lua.annotated.lua @@ -0,0 +1,55 @@ +local Camera = +{ + Name = "Camera", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetCameraFOVDefaults", + Type = "Function", + + Returns = + { + { Name = "fieldOfViewDegreesDefault", Type = "number", Nilable = false }, + { Name = "fieldOfViewDegreesPlayerMin", Type = "number", Nilable = false }, + { Name = "fieldOfViewDegreesPlayerMax", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUICameraInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiCameraID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "posX", Type = "number", Nilable = false }, + { Name = "posY", Type = "number", Nilable = false }, + { Name = "posZ", Type = "number", Nilable = false }, + { Name = "lookAtX", Type = "number", Nilable = false }, + { Name = "lookAtY", Type = "number", Nilable = false }, + { Name = "lookAtZ", Type = "number", Nilable = false }, + { Name = "animID", Type = "number", Nilable = false }, + { Name = "animVariation", Type = "number", Nilable = false }, + { Name = "animFrame", Type = "number", Nilable = false }, + { Name = "useModelCenter", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Camera); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2aff5b9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,17 @@ +local CatalogShopConstants = +{ + Tables = + { + { + Name = "CatalogShopVirtualCurrencyConstants", + Type = "Constants", + Values = + { + { Name = "HEARTHSTEEL_VC_CURRENCY_CODE", Type = "cstring", Value = XVV }, + { Name = "TRADERS_TENDER_VC_CURRENCY_CODE", Type = "cstring", Value = XWP }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CatalogShopConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua.annotated.lua new file mode 100644 index 0000000..42af452 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CatalogShopDocumentation.lua.annotated.lua @@ -0,0 +1,830 @@ +local CatalogShop = +{ + Name = "CatalogShop", + Type = "System", + Namespace = "C_CatalogShop", + Environment = "All", + + Functions = + { + { + Name = "BulkPurchaseProducts", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canPurchaseProducts", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BulkRefundDecors", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "CloseCatalogShopInteraction", + Type = "Function", + }, + { + Name = "ConfirmHousingPurchase", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "FindBestCurrencyProductForNeededAmount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vcCurrencyCode", Type = "string", Nilable = false }, + { Name = "amountNeeded", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "vcProductID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetAvailableCategoryIDs", + Type = "Function", + + Returns = + { + { Name = "categoryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAvailableTransmogRaceInfos", + Type = "Function", + + Returns = + { + { Name = "raceIDs", Type = "table", InnerType = "AvailableRaceInfo", Nilable = false }, + }, + }, + { + Name = "GetCatalogShopProductDisplayInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "catalogShopProductID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "item", Type = "CatalogShopProductDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetCategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categoryInfo", Type = "CatalogShopCategoryInfo", Nilable = false }, + }, + }, + { + Name = "GetCategorySectionInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "sectionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sectionInfo", Type = "CatalogShopSectionInfo", Nilable = false }, + }, + }, + { + Name = "GetFailureInfo", + Type = "Function", + + Returns = + { + { Name = "errorResultEnum", Type = "StoreError", Nilable = true }, + { Name = "errorResultRaw", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFirstCategoryByProductID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categoryInfo", Type = "CatalogShopCategoryInfo", Nilable = true }, + }, + }, + { + Name = "GetNewProducts", + Type = "Function", + + Returns = + { + { Name = "newProducts", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetProductAvailabilityTimeRemainingSecs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "catalogShopProductID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "timeRemainingSecs", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetProductIDsForBundle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bundleProductID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "childIDs", Type = "table", InnerType = "CatalogShopBundleChildInfo", Nilable = false }, + }, + }, + { + Name = "GetProductIDsForCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "productIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetProductIDsForCategorySection", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "sectionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "productIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetProductInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "productInfo", Type = "CatalogShopProductInfo", Nilable = true }, + }, + }, + { + Name = "GetProductSortOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "sectionID", Type = "number", Nilable = false }, + { Name = "productID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sortOrder", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRefundableDecors", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productIdFilterOpt", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "refundableDecorInfos", Type = "table", InnerType = "RefundableDecorInfo", Nilable = false }, + { Name = "minTimeRemainingSeconds", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetSectionIDsForCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sectionIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellVisualInfoForMount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellVisualID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellVisualInfo", Type = "CatalogShopSpellVisualInfo", Nilable = false }, + }, + }, + { + Name = "GetVCProductInfos", + Type = "Function", + + Returns = + { + { Name = "vcProductInfos", Type = "table", InnerType = "CatalogShopVCProductInfo", Nilable = false }, + }, + }, + { + Name = "GetVirtualCurrencyBalance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyCode", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "balance", Type = "string", Nilable = true }, + }, + }, + { + Name = "HasNewProducts", + Type = "Function", + + Returns = + { + { Name = "hasNewProducts", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsShop2Enabled", + Type = "Function", + + Returns = + { + { Name = "value", Type = "bool", Nilable = true }, + }, + }, + { + Name = "OnLegalDisclaimerClicked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "catalogShopProductID", Type = "number", Nilable = false }, + }, + }, + { + Name = "OnLegalPersonalizedOptOutClicked", + Type = "Function", + }, + { + Name = "OpenCatalogShopInteractionFromHouse", + Type = "Function", + + Returns = + { + { Name = "shoppingSessionUUIDStr", Type = "string", Nilable = false }, + }, + }, + { + Name = "OpenCatalogShopInteractionFromShop", + Type = "Function", + + Returns = + { + { Name = "shoppingSessionUUIDStr", Type = "string", Nilable = false }, + }, + }, + { + Name = "ProductDisplayedTelemetry", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryId", Type = "number", Nilable = false }, + { Name = "sectionId", Type = "number", Nilable = false }, + { Name = "catalogShopProductID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ProductSelectedTelemetry", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryId", Type = "number", Nilable = false }, + { Name = "sectionId", Type = "number", Nilable = false }, + { Name = "catalogShopProductID", Type = "number", Nilable = false }, + { Name = "wasCodeSelection", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PurchaseProduct", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canPurchase", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RefreshRefundableDecors", + Type = "Function", + }, + { + Name = "RefreshVirtualCurrencyBalance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyCode", Type = "string", Nilable = false }, + }, + }, + { + Name = "ShouldShowHousingWarning", + Type = "Function", + + Returns = + { + { Name = "shouldShowHousingWarning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartHousingVCPurchaseConfirmation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BulkPurchaseResultReceived", + Type = "Event", + LiteralName = "BULK_PURCHASE_RESULT_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "BulkPurchaseResult", Nilable = false }, + { Name = "productResults", Type = "table", InnerType = "BulkPurchaseIndividualProductResult", Nilable = false }, + { Name = "bestTopUpProductID", Type = "number", Nilable = true }, + { Name = "totalCost", Type = "number", Nilable = true }, + }, + }, + { + Name = "BulkRefundResultReceived", + Type = "Event", + LiteralName = "BULK_REFUND_RESULT_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "BulkRefundResult", Nilable = false }, + }, + }, + { + Name = "CatalogShopAddPendingProduct", + Type = "Event", + LiteralName = "CATALOG_SHOP_ADD_PENDING_PRODUCT", + SynchronousEvent = true, + Payload = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopDataRefresh", + Type = "Event", + LiteralName = "CATALOG_SHOP_DATA_REFRESH", + SynchronousEvent = true, + Payload = + { + { Name = "shoppingSessionUUIDStr", Type = "string", Nilable = true }, + }, + }, + { + Name = "CatalogShopDisabled", + Type = "Event", + LiteralName = "CATALOG_SHOP_DISABLED", + SynchronousEvent = true, + }, + { + Name = "CatalogShopFetchFailure", + Type = "Event", + LiteralName = "CATALOG_SHOP_FETCH_FAILURE", + SynchronousEvent = true, + Payload = + { + { Name = "shoppingSessionUUIDStr", Type = "string", Nilable = true }, + }, + }, + { + Name = "CatalogShopFetchSuccess", + Type = "Event", + LiteralName = "CATALOG_SHOP_FETCH_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "shoppingSessionUUIDStr", Type = "string", Nilable = true }, + }, + }, + { + Name = "CatalogShopOpenSimpleCheckout", + Type = "Event", + LiteralName = "CATALOG_SHOP_OPEN_SIMPLE_CHECKOUT", + SynchronousEvent = true, + Payload = + { + { Name = "checkoutID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopPmtImageDownloaded", + Type = "Event", + LiteralName = "CATALOG_SHOP_PMT_IMAGE_DOWNLOADED", + SynchronousEvent = true, + Payload = + { + { Name = "catalogProductID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopPurchaseSuccess", + Type = "Event", + LiteralName = "CATALOG_SHOP_PURCHASE_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopRebuildScrollBox", + Type = "Event", + LiteralName = "CATALOG_SHOP_REBUILD_SCROLL_BOX", + SynchronousEvent = true, + }, + { + Name = "CatalogShopRefundableDecorsUpdated", + Type = "Event", + LiteralName = "CATALOG_SHOP_REFUNDABLE_DECORS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "CatalogShopRemovePendingProduct", + Type = "Event", + LiteralName = "CATALOG_SHOP_REMOVE_PENDING_PRODUCT", + SynchronousEvent = true, + Payload = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopResultError", + Type = "Event", + LiteralName = "CATALOG_SHOP_RESULT_ERROR", + SynchronousEvent = true, + }, + { + Name = "CatalogShopSpecificProductRefresh", + Type = "Event", + LiteralName = "CATALOG_SHOP_SPECIFIC_PRODUCT_REFRESH", + SynchronousEvent = true, + Payload = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopVirtualCurrencyBalanceUpdate", + Type = "Event", + LiteralName = "CATALOG_SHOP_VIRTUAL_CURRENCY_BALANCE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "currencyCode", Type = "string", Nilable = false }, + { Name = "balance", Type = "string", Nilable = false }, + }, + }, + { + Name = "CatalogShopVirtualCurrencyBalanceUpdateFailure", + Type = "Event", + LiteralName = "CATALOG_SHOP_VIRTUAL_CURRENCY_BALANCE_UPDATE_FAILURE", + SynchronousEvent = true, + Payload = + { + { Name = "currencyCode", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetSeenProducts", + Type = "Event", + LiteralName = "SET_SEEN_PRODUCTS", + SynchronousEvent = true, + Payload = + { + { Name = "productIds", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "ShowNewProductNotification", + Type = "Event", + LiteralName = "SHOW_NEW_PRODUCT_NOTIFICATION", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "AvailableRaceInfo", + Type = "Structure", + Fields = + { + { Name = "raceID", Type = "number", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + }, + }, + { + Name = "BulkPurchaseIndividualProductResult", + Type = "Structure", + Fields = + { + { Name = "recordId", Type = "number", Nilable = false }, + { Name = "parentProductId", Type = "number", Nilable = true }, + { Name = "entitlementId", Type = "string", Nilable = false }, + { Name = "externalTransactionId", Type = "string", Nilable = false }, + { Name = "status", Type = "SimpleOrderStatus", Nilable = false }, + }, + }, + { + Name = "CatalogShopBundleChildInfo", + Type = "Structure", + Fields = + { + { Name = "childProductID", Type = "number", Nilable = false }, + { Name = "displayOrder", Type = "number", Nilable = false }, + { Name = "quantityInBundle", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + { Name = "iconTexture", Type = "string", Nilable = false }, + { Name = "linkTag", Type = "string", Nilable = false }, + { Name = "isDisabled", Type = "bool", Nilable = false }, + { Name = "showPersistentRefundButton", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CatalogShopProductDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "defaultPreviewModelSceneID", Type = "number", Nilable = false }, + { Name = "defaultCardModelSceneID", Type = "number", Nilable = false }, + { Name = "defaultWideCardModelSceneID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "overridePreviewModelSceneID", Type = "number", Nilable = true }, + { Name = "overrideCardModelSceneID", Type = "number", Nilable = true }, + { Name = "overrideWideCardModelSceneID", Type = "number", Nilable = true }, + { Name = "creatureDisplayInfoIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "spellVisualIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "mainHandItemModifiedAppearanceID", Type = "number", Nilable = true }, + { Name = "offHandItemModifiedAppearanceID", Type = "number", Nilable = true }, + { Name = "itemModifiedAppearanceIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "iconFileDataID", Type = "number", Nilable = true }, + { Name = "iconTextureKit", Type = "textureKit", Nilable = true }, + { Name = "productType", Type = "string", Nilable = true }, + { Name = "itemDescription", Type = "string", Nilable = true }, + { Name = "hasUnknownLicense", Type = "bool", Nilable = false }, + { Name = "productPMTURL", Type = "string", Nilable = true }, + { Name = "otherProductImageAtlasName", Type = "string", Nilable = true }, + { Name = "otherProductGameTitleBaseTag", Type = "string", Nilable = true }, + { Name = "otherProductGameType", Type = "string", Nilable = true }, + { Name = "customLoopingSoundStart", Type = "number", Nilable = true }, + { Name = "customLoopingSoundMiddle", Type = "number", Nilable = true }, + { Name = "customLoopingSoundEnd", Type = "number", Nilable = true }, + { Name = "specialActorID_1", Type = "string", Nilable = true }, + { Name = "specialActorID_2", Type = "string", Nilable = true }, + { Name = "specialActorID_3", Type = "string", Nilable = true }, + { Name = "specialActorID_4", Type = "string", Nilable = true }, + { Name = "specialActorID_5", Type = "string", Nilable = true }, + { Name = "gameFlavorID", Type = "number", Nilable = true }, + { Name = "decorFileDataID", Type = "number", Nilable = true }, + { Name = "quantity", Type = "number", Nilable = true }, + }, + }, + { + Name = "CatalogShopProductInfo", + Type = "Structure", + Fields = + { + { Name = "catalogShopProductID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "type", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "iconTexture", Type = "string", Nilable = false }, + { Name = "isFullyOwned", Type = "bool", Nilable = false }, + { Name = "isPurchasePending", Type = "bool", Nilable = false }, + { Name = "refundable", Type = "bool", Nilable = false }, + { Name = "price", Type = "string", Nilable = false }, + { Name = "originalPrice", Type = "string", Nilable = false }, + { Name = "discountPercentage", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "mountTypeName", Type = "string", Nilable = false }, + { Name = "speciesID", Type = "number", Nilable = false }, + { Name = "transmogSetID", Type = "number", Nilable = false }, + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + { Name = "subItems", Type = "table", InnerType = "CatalogShopSubItemInfo", Nilable = false }, + { Name = "subItemsLoaded", Type = "bool", Nilable = false }, + { Name = "backgroundTexture", Type = "string", Nilable = false }, + { Name = "foregroundTexture", Type = "string", Nilable = true }, + { Name = "smallCardBGTexture", Type = "string", Nilable = true }, + { Name = "smallCardFGTexture", Type = "string", Nilable = true }, + { Name = "wideCardBGTexture", Type = "string", Nilable = true }, + { Name = "wideCardFGTexture", Type = "string", Nilable = true }, + { Name = "previewIconTexture", Type = "string", Nilable = true }, + { Name = "optionalWideCardBackgroundTexture", Type = "string", Nilable = true }, + { Name = "isBundle", Type = "bool", Nilable = false }, + { Name = "bundleChildrenSize", Type = "number", Nilable = false }, + { Name = "licenseTermType", Type = "number", Nilable = false }, + { Name = "licenseTermDuration", Type = "number", Nilable = false }, + { Name = "virtualCurrencies", Type = "table", InnerType = "CatalogShopVirtualCurrency", Nilable = false }, + { Name = "isHidden", Type = "bool", Nilable = false }, + { Name = "hasPendingOrders", Type = "bool", Nilable = false }, + { Name = "numBundleDetailCards", Type = "number", Nilable = false }, + { Name = "isDynamicallyDiscounted", Type = "bool", Nilable = false }, + { Name = "shouldShowOriginalPrice", Type = "bool", Nilable = false }, + { Name = "wideCardBGOverrideProductURL", Type = "string", Nilable = true }, + { Name = "consumableQuantity", Type = "number", Nilable = true }, + { Name = "isVCProduct", Type = "bool", Nilable = false }, + { Name = "containsHousingItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CatalogShopSectionInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + { Name = "parentCatalogShopCategoryInfoID", Type = "number", Nilable = true }, + { Name = "cardType", Type = "string", Nilable = true }, + { Name = "scrollGridSize", Type = "number", Nilable = true }, + { Name = "shouldShowRecommendationOptOutDisclaimer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CatalogShopSpellVisualInfo", + Type = "Structure", + Fields = + { + { Name = "animID", Type = "number", Nilable = true }, + { Name = "spellVisualKitID", Type = "number", Nilable = true }, + }, + }, + { + Name = "CatalogShopSubItemInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "invType", Type = "string", Nilable = false }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + }, + { + Name = "CatalogShopVCProductInfo", + Type = "Structure", + Fields = + { + { Name = "vcProductID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CatalogShopVirtualCurrency", + Type = "Structure", + Fields = + { + { Name = "amount", Type = "number", Nilable = false }, + { Name = "currencyCode", Type = "string", Nilable = false }, + }, + }, + { + Name = "RefundableDecorInfo", + Type = "Structure", + Fields = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "timeRemainingSeconds", Type = "time_t", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "price", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CatalogShop); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..326fd24 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChallengeModeInfoDocumentation.lua.annotated.lua @@ -0,0 +1,536 @@ +local ChallengeModeInfo = +{ + Name = "ChallengeModeInfo", + Type = "System", + Namespace = "C_ChallengeMode", + Environment = "All", + + Functions = + { + { + Name = "CanUseKeystoneInCurrentMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearKeystone", + Type = "Function", + }, + { + Name = "CloseKeystoneFrame", + Type = "Function", + }, + { + Name = "GetActiveChallengeMapID", + Type = "Function", + + Returns = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetActiveKeystoneInfo", + Type = "Function", + + Returns = + { + { Name = "activeKeystoneLevel", Type = "number", Nilable = false }, + { Name = "activeAffixIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "wasActiveKeystoneCharged", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAffixInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "affixID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "filedataid", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetChallengeCompletionInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "ChallengeCompletionInfo", Nilable = false }, + }, + }, + { + Name = "GetDeathCount", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "numDeaths", Type = "number", Nilable = false }, + { Name = "timeLost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDungeonScoreRarityColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a color value from the passed in overall season M+ rating." }, + + Arguments = + { + { Name = "dungeonScore", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "scoreColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetGuildLeaders", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "topAttempt", Type = "table", InnerType = "ChallengeModeGuildTopAttempt", Nilable = false }, + }, + }, + { + Name = "GetKeystoneLevelRarityColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a color value from the passed in keystone level." }, + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "levelScore", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetLeaverPenaltyWarningTimeLeft", + Type = "Function", + Documentation = { "Returns how much time is left before player is automatically flagged as a leaver (and removed from the group) for exiting a restricted challenge mode instance" }, + + Returns = + { + { Name = "timeLeftSeconds", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetMapScoreInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "displayScores", Type = "table", InnerType = "MythicPlusRatingLinkInfo", Nilable = false }, + }, + }, + { + Name = "GetMapTable", + Type = "Function", + + Returns = + { + { Name = "mapChallengeModeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetMapUIInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "timeLimit", Type = "number", Nilable = false }, + { Name = "texture", Type = "number", Nilable = true }, + { Name = "backgroundTexture", Type = "number", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOverallDungeonScore", + Type = "Function", + Documentation = { "Gets the overall season mythic+ rating for the player." }, + + Returns = + { + { Name = "overallDungeonScore", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerLevelDamageHealthMod", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "damageMod", Type = "number", Nilable = false }, + { Name = "healthMod", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSlottedKeystoneInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + { Name = "affixIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "keystoneLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpecificDungeonOverallScoreRarityColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a color value from the passed in mythic+ rating from the combined affix scores for a specific dungeon" }, + + Arguments = + { + { Name = "specificDungeonOverallScore", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specificDungeonOverallScoreColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetSpecificDungeonScoreRarityColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a color value from the passed in mythic+ rating for a specific dungeon." }, + + Arguments = + { + { Name = "specificDungeonScore", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specificDungeonScoreColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetStartTime", + Type = "Function", + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasSlottedKeystone", + Type = "Function", + + Returns = + { + { Name = "hasSlottedKeystone", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChallengeModeActive", + Type = "Function", + + Returns = + { + { Name = "challengeModeActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChallengeModeResettable", + Type = "Function", + + Returns = + { + { Name = "canReset", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveKeystone", + Type = "Function", + + Returns = + { + { Name = "removalSuccessful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestLeaders", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "Reset", + Type = "Function", + }, + { + Name = "SlotKeystone", + Type = "Function", + }, + { + Name = "StartChallengeMode", + Type = "Function", + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ChallengeModeCompleted", + Type = "Event", + LiteralName = "CHALLENGE_MODE_COMPLETED", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeCompletedRewards", + Type = "Event", + LiteralName = "CHALLENGE_MODE_COMPLETED_REWARDS", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "medal", Type = "number", Nilable = false }, + { Name = "timeMS", Type = "number", Nilable = false }, + { Name = "money", Type = "number", Nilable = false }, + { Name = "rewards", Type = "table", InnerType = "ChallengeModeReward", Nilable = false }, + }, + }, + { + Name = "ChallengeModeDeathCountUpdated", + Type = "Event", + LiteralName = "CHALLENGE_MODE_DEATH_COUNT_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeKeystoneReceptableOpen", + Type = "Event", + LiteralName = "CHALLENGE_MODE_KEYSTONE_RECEPTABLE_OPEN", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeKeystoneSlotted", + Type = "Event", + LiteralName = "CHALLENGE_MODE_KEYSTONE_SLOTTED", + SynchronousEvent = true, + Payload = + { + { Name = "keystoneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChallengeModeLeaderboardResult", + Type = "Event", + LiteralName = "CHALLENGE_MODE_LEADERBOARD_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "challengeModeID", Type = "number", Nilable = false }, + { Name = "page", Type = "number", Nilable = false }, + { Name = "results", Type = "table", InnerType = "MythicPlusLeaderboardResult", Nilable = false }, + }, + }, + { + Name = "ChallengeModeLeadersUpdate", + Type = "Event", + LiteralName = "CHALLENGE_MODE_LEADERS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeLeaverTimerEnded", + Type = "Event", + LiteralName = "CHALLENGE_MODE_LEAVER_TIMER_ENDED", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeLeaverTimerStarted", + Type = "Event", + LiteralName = "CHALLENGE_MODE_LEAVER_TIMER_STARTED", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeMapsUpdate", + Type = "Event", + LiteralName = "CHALLENGE_MODE_MAPS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeMemberInfoUpdated", + Type = "Event", + LiteralName = "CHALLENGE_MODE_MEMBER_INFO_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ChallengeModeNewRecord", + Type = "Event", + LiteralName = "CHALLENGE_MODE_NEW_RECORD", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "timeMS", Type = "number", Nilable = false }, + { Name = "medal", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChallengeModeReset", + Type = "Event", + LiteralName = "CHALLENGE_MODE_RESET", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChallengeModeStart", + Type = "Event", + LiteralName = "CHALLENGE_MODE_START", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ChallengeCompletionInfo", + Type = "Structure", + Fields = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false, Default = 0 }, + { Name = "level", Type = "number", Nilable = false, Default = 0 }, + { Name = "time", Type = "number", Nilable = false, Default = 0 }, + { Name = "onTime", Type = "bool", Nilable = false, Default = false }, + { Name = "keystoneUpgradeLevels", Type = "number", Nilable = false, Default = 0 }, + { Name = "practiceRun", Type = "bool", Nilable = false, Default = false }, + { Name = "oldOverallDungeonScore", Type = "number", Nilable = true }, + { Name = "newOverallDungeonScore", Type = "number", Nilable = true }, + { Name = "isMapRecord", Type = "bool", Nilable = false, Default = false }, + { Name = "isAffixRecord", Type = "bool", Nilable = false, Default = false }, + { Name = "isEligibleForScore", Type = "bool", Nilable = false, Default = false }, + { Name = "members", Type = "table", InnerType = "ChallengeModeCompletionMemberInfo", Nilable = false }, + }, + }, + { + Name = "ChallengeModeBestTime", + Type = "Structure", + Fields = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + { Name = "durationMs", Type = "number", Nilable = false }, + { Name = "members", Type = "table", InnerType = "ChallengeModeBestTimeMember", Nilable = false }, + }, + }, + { + Name = "ChallengeModeBestTimeMember", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "cstring", Nilable = false }, + { Name = "className", Type = "cstring", Nilable = false }, + { Name = "specializationID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChallengeModeCompletionMemberInfo", + Type = "Structure", + Fields = + { + { Name = "memberGUID", Type = "WOWGUID", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChallengeModeGuildAttemptMember", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ChallengeModeGuildTopAttempt", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "cstring", Nilable = false }, + { Name = "keystoneLevel", Type = "number", Nilable = false }, + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + { Name = "isYou", Type = "bool", Nilable = false }, + { Name = "members", Type = "table", InnerType = "ChallengeModeGuildAttemptMember", Nilable = false }, + }, + }, + { + Name = "ChallengeModeReward", + Type = "Structure", + Fields = + { + { Name = "rewardID", Type = "number", Nilable = false }, + { Name = "displayInfoID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "isCurrency", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ChallengeModeInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCreationConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCreationConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..010f6a9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCreationConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,34 @@ +local CharacterCreationConstants = +{ + Tables = + { + { + Name = "CharCreateAnimTurnType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Normal", Type = "CharCreateAnimTurnType", EnumValue = 0 }, + { Name = "Torso", Type = "CharCreateAnimTurnType", EnumValue = 1 }, + }, + }, + { + Name = "CharSectionCondition", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "AlliedRace", Type = "CharSectionCondition", EnumValue = 0 }, + { Name = "HeritageArmor", Type = "CharSectionCondition", EnumValue = 1 }, + { Name = "ConditionalAppeareance", Type = "CharSectionCondition", EnumValue = 2 }, + { Name = "RaceClassCombo", Type = "CharSectionCondition", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CharacterCreationConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bf544c5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterCustomizationSharedDocumentation.lua.annotated.lua @@ -0,0 +1,145 @@ +local CharacterCustomizationShared = +{ + Tables = + { + { + Name = "CharCustomizationType", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Skin", Type = "CharCustomizationType", EnumValue = 0 }, + { Name = "Face", Type = "CharCustomizationType", EnumValue = 1 }, + { Name = "Hair", Type = "CharCustomizationType", EnumValue = 2 }, + { Name = "HairColor", Type = "CharCustomizationType", EnumValue = 3 }, + { Name = "FacialHair", Type = "CharCustomizationType", EnumValue = 4 }, + { Name = "CustomOptionTattoo", Type = "CharCustomizationType", EnumValue = 5 }, + { Name = "CustomOptionHorn", Type = "CharCustomizationType", EnumValue = 6 }, + { Name = "CustomOptionFacewear", Type = "CharCustomizationType", EnumValue = 7 }, + { Name = "CustomOptionTattooColor", Type = "CharCustomizationType", EnumValue = 8 }, + }, + }, + { + Name = "ChrCustomizationCategoryFlag", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "UndressModel", Type = "ChrCustomizationCategoryFlag", EnumValue = 1 }, + { Name = "Subcategory", Type = "ChrCustomizationCategoryFlag", EnumValue = 2 }, + }, + }, + { + Name = "ChrCustomizationOptionType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Dropdown", Type = "ChrCustomizationOptionType", EnumValue = 0 }, + { Name = "Checkbox", Type = "ChrCustomizationOptionType", EnumValue = 1 }, + { Name = "Slider", Type = "ChrCustomizationOptionType", EnumValue = 2 }, + }, + }, + { + Name = "ChrModelFeatureFlags", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 64, + Fields = + { + { Name = "None", Type = "ChrModelFeatureFlags", EnumValue = 0 }, + { Name = "Summons", Type = "ChrModelFeatureFlags", EnumValue = 1 }, + { Name = "Forms", Type = "ChrModelFeatureFlags", EnumValue = 2 }, + { Name = "Identity", Type = "ChrModelFeatureFlags", EnumValue = 4 }, + { Name = "Deprecated0", Type = "ChrModelFeatureFlags", EnumValue = 8 }, + { Name = "Mounts", Type = "ChrModelFeatureFlags", EnumValue = 16 }, + { Name = "HunterPets", Type = "ChrModelFeatureFlags", EnumValue = 32 }, + { Name = "Players", Type = "ChrModelFeatureFlags", EnumValue = 64 }, + }, + }, + { + Name = "NewCharGear", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Start", Type = "NewCharGear", EnumValue = 0 }, + { Name = "Preview", Type = "NewCharGear", EnumValue = 1 }, + }, + }, + { + Name = "CharCustomizationCategory", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "textureAtlas", Nilable = false }, + { Name = "selectedIcon", Type = "textureAtlas", Nilable = false }, + { Name = "undressModel", Type = "bool", Nilable = false }, + { Name = "subcategory", Type = "bool", Nilable = false }, + { Name = "cameraZoomLevel", Type = "number", Nilable = false }, + { Name = "cameraDistanceOffset", Type = "number", Nilable = false }, + { Name = "spellShapeshiftFormID", Type = "number", Nilable = true }, + { Name = "chrModelID", Type = "number", Nilable = true }, + { Name = "options", Type = "table", InnerType = "CharCustomizationOption", Nilable = false }, + { Name = "hasNewChoices", Type = "bool", Nilable = false }, + { Name = "needsNativeFormCategory", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CharCustomizationChoice", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "ineligibleChoice", Type = "bool", Nilable = false }, + { Name = "isNew", Type = "bool", Nilable = false }, + { Name = "swatchColor1", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + { Name = "swatchColor2", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + { Name = "soundKit", Type = "number", Nilable = true }, + { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "lockedText", Type = "string", Nilable = true }, + }, + }, + { + Name = "CharCustomizationConstants", + Type = "Constants", + Values = + { + { Name = "CHAR_CUSTOMIZE_CUSTOM_DISPLAY_OPTION_FIRST", Type = "CharCustomizationType", Value = CustomOptionTattoo }, + { Name = "CHAR_CUSTOMIZE_CUSTOM_DISPLAY_OPTION_LAST", Type = "CharCustomizationType", Value = CustomOptionTattooColor }, + { Name = "NUM_CUSTOM_DISPLAY", Type = "number", Value = Constants.CharCustomizationConstants.CHAR_CUSTOMIZE_CUSTOM_DISPLAY_OPTION_LAST - Constants.CharCustomizationConstants.CHAR_CUSTOMIZE_CUSTOM_DISPLAY_OPTION_FIRST + 1 }, + { Name = "NAME_RESERVATION_DAYS", Type = "number", Value = 30 }, + }, + }, + { + Name = "CharCustomizationOption", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "optionType", Type = "ChrCustomizationOptionType", Nilable = false }, + { Name = "choices", Type = "table", InnerType = "CharCustomizationChoice", Nilable = false }, + { Name = "currentChoiceIndex", Type = "luaIndex", Nilable = true }, + { Name = "hasNewChoices", Type = "bool", Nilable = false }, + { Name = "isSound", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CharacterCustomizationShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterSelectionConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterSelectionConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..10ecfa3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterSelectionConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,135 @@ +local CharacterSelectionConstants = +{ + Tables = + { + { + Name = "WarbandEventState", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "None", Type = "WarbandEventState", EnumValue = 0 }, + { Name = "DelayingEvent", Type = "WarbandEventState", EnumValue = 1 }, + { Name = "SheathingWeapon", Type = "WarbandEventState", EnumValue = 2 }, + { Name = "DelayingStandStateTransition", Type = "WarbandEventState", EnumValue = 3 }, + { Name = "StandStateTransitioning", Type = "WarbandEventState", EnumValue = 4 }, + { Name = "ShowingWeapon", Type = "WarbandEventState", EnumValue = 5 }, + { Name = "StandStateLooping", Type = "WarbandEventState", EnumValue = 6 }, + { Name = "NumWarbandEventStates", Type = "WarbandEventState", EnumValue = 7 }, + }, + }, + { + Name = "WarbandGroupFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "WarbandGroupFlags", EnumValue = 0 }, + { Name = "Collapsed", Type = "WarbandGroupFlags", EnumValue = 1 }, + }, + }, + { + Name = "WarbandPlacementDisplayInfoType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Model", Type = "WarbandPlacementDisplayInfoType", EnumValue = 0 }, + { Name = "Creature", Type = "WarbandPlacementDisplayInfoType", EnumValue = 1 }, + { Name = "Item", Type = "WarbandPlacementDisplayInfoType", EnumValue = 2 }, + }, + }, + { + Name = "WarbandSceneAnimationEvent", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "StartingPose", Type = "WarbandSceneAnimationEvent", EnumValue = 0 }, + { Name = "Idle", Type = "WarbandSceneAnimationEvent", EnumValue = 1 }, + { Name = "Mouseover", Type = "WarbandSceneAnimationEvent", EnumValue = 2 }, + { Name = "Select", Type = "WarbandSceneAnimationEvent", EnumValue = 3 }, + { Name = "Deselect", Type = "WarbandSceneAnimationEvent", EnumValue = 4 }, + { Name = "Insert", Type = "WarbandSceneAnimationEvent", EnumValue = 5 }, + { Name = "EnterWorld", Type = "WarbandSceneAnimationEvent", EnumValue = 6 }, + { Name = "Spin", Type = "WarbandSceneAnimationEvent", EnumValue = 7 }, + { Name = "Poke", Type = "WarbandSceneAnimationEvent", EnumValue = 8 }, + { Name = "Ffx", Type = "WarbandSceneAnimationEvent", EnumValue = 9 }, + }, + }, + { + Name = "WarbandSceneAnimationSheatheState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Maintain", Type = "WarbandSceneAnimationSheatheState", EnumValue = 0 }, + { Name = "SheatheWeapons", Type = "WarbandSceneAnimationSheatheState", EnumValue = 1 }, + { Name = "ShowWeapons", Type = "WarbandSceneAnimationSheatheState", EnumValue = 2 }, + }, + }, + { + Name = "WarbandSceneAnimationStandState", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Maintain", Type = "WarbandSceneAnimationStandState", EnumValue = 0 }, + { Name = "Stand", Type = "WarbandSceneAnimationStandState", EnumValue = 1 }, + { Name = "SitOnGround", Type = "WarbandSceneAnimationStandState", EnumValue = 2 }, + { Name = "Kneel", Type = "WarbandSceneAnimationStandState", EnumValue = 3 }, + { Name = "ReadyStance", Type = "WarbandSceneAnimationStandState", EnumValue = 4 }, + { Name = "SitOnChairLow", Type = "WarbandSceneAnimationStandState", EnumValue = 5 }, + { Name = "SitOnChairMedium", Type = "WarbandSceneAnimationStandState", EnumValue = 6 }, + { Name = "SitOnChairHigh", Type = "WarbandSceneAnimationStandState", EnumValue = 7 }, + { Name = "Sleep", Type = "WarbandSceneAnimationStandState", EnumValue = 8 }, + }, + }, + { + Name = "WarbandSceneAnimationStandStateFlags", + Type = "Enumeration", + NumValues = 9, + MinValue = 1, + MaxValue = 256, + Fields = + { + { Name = "Maintain", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 1 }, + { Name = "Stand", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 2 }, + { Name = "SitOnGround", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 4 }, + { Name = "Kneel", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 8 }, + { Name = "ReadyStance", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 16 }, + { Name = "SitOnChairLow", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 32 }, + { Name = "SitOnChairMedium", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 64 }, + { Name = "SitOnChairHigh", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 128 }, + { Name = "Sleep", Type = "WarbandSceneAnimationStandStateFlags", EnumValue = 256 }, + }, + }, + { + Name = "WarbandScenePlacementType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Character", Type = "WarbandScenePlacementType", EnumValue = 0 }, + { Name = "Pet", Type = "WarbandScenePlacementType", EnumValue = 1 }, + { Name = "Chair", Type = "WarbandScenePlacementType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CharacterSelectionConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterServicesConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterServicesConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f83fffb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CharacterServicesConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local CharacterServicesConstants = +{ + Tables = + { + { + Name = "CharacterServiceInfoFlag", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "RestrictToRecommendedSpecs", Type = "CharacterServiceInfoFlag", EnumValue = 1 }, + { Name = "AllowMaxLevelBoost", Type = "CharacterServiceInfoFlag", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CharacterServicesConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..703050b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatBubblesDocumentation.lua.annotated.lua @@ -0,0 +1,36 @@ +local ChatBubbles = +{ + Name = "ChatBubbles", + Type = "System", + Namespace = "C_ChatBubbles", + Environment = "All", + + Functions = + { + { + Name = "GetAllChatBubbles", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "includeForbidden", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "chatBubbles", Type = "table", InnerType = "ChatBubbleFrame", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ChatBubbles); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..28ddda5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,245 @@ +local ChatConstants = +{ + Tables = + { + { + Name = "ChannelPlayerFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "ChannelPlayerNone", Type = "ChannelPlayerFlags", EnumValue = 0 }, + { Name = "ChannelPlayerOwner", Type = "ChannelPlayerFlags", EnumValue = 1 }, + { Name = "ChannelPlayerModerator", Type = "ChannelPlayerFlags", EnumValue = 2 }, + { Name = "ChannelPlayerTextAllow", Type = "ChannelPlayerFlags", EnumValue = 4 }, + { Name = "ChannelPlayerHidden", Type = "ChannelPlayerFlags", EnumValue = 8 }, + }, + }, + { + Name = "ChatChannelRuleset", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "ChatChannelRuleset", EnumValue = 0 }, + { Name = "Mentor", Type = "ChatChannelRuleset", EnumValue = 1 }, + { Name = "Disabled", Type = "ChatChannelRuleset", EnumValue = 2 }, + { Name = "ChromieTimeCataclysm", Type = "ChatChannelRuleset", EnumValue = 3 }, + { Name = "ChromieTimeBuringCrusade", Type = "ChatChannelRuleset", EnumValue = 4 }, + { Name = "ChromieTimeWrath", Type = "ChatChannelRuleset", EnumValue = 5 }, + { Name = "ChromieTimeMists", Type = "ChatChannelRuleset", EnumValue = 6 }, + { Name = "ChromieTimeWoD", Type = "ChatChannelRuleset", EnumValue = 7 }, + { Name = "ChromieTimeLegion", Type = "ChatChannelRuleset", EnumValue = 8 }, + }, + }, + { + Name = "ChatChannelType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "ChatChannelType", EnumValue = 0 }, + { Name = "Custom", Type = "ChatChannelType", EnumValue = 1 }, + { Name = "PrivateParty", Type = "ChatChannelType", EnumValue = 2 }, + { Name = "PublicParty", Type = "ChatChannelType", EnumValue = 3 }, + { Name = "Communities", Type = "ChatChannelType", EnumValue = 4 }, + }, + }, + { + Name = "ChatMessagingLockdownReason", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "ActiveEncounter", Type = "ChatMessagingLockdownReason", EnumValue = 0, Documentation = { "Chat lockdown is active because the player is in an active and incomplete instance encounter." } }, + { Name = "ActiveMythicKeystoneOrChallengeMode", Type = "ChatMessagingLockdownReason", EnumValue = 1, Documentation = { "Chat lockdown is active because the player is in an active and incomplete Mythic Keystone or Challenge Mode map." } }, + { Name = "ActivePvPMatch", Type = "ChatMessagingLockdownReason", EnumValue = 2, Documentation = { "Chat lockdown is active because the player is in an active and incomplete PvP match." } }, + }, + }, + { + Name = "ChatToxityFilterOptOut", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4294967295, + Fields = + { + { Name = "FilterAll", Type = "ChatToxityFilterOptOut", EnumValue = 0 }, + { Name = "ExcludeFilterFriend", Type = "ChatToxityFilterOptOut", EnumValue = 1 }, + { Name = "ExcludeFilterGuild", Type = "ChatToxityFilterOptOut", EnumValue = 2 }, + { Name = "ExcludeFilterAll", Type = "ChatToxityFilterOptOut", EnumValue = 4294967295 }, + }, + }, + { + Name = "ChatWhisperTargetStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "CanWhisper", Type = "ChatWhisperTargetStatus", EnumValue = 0 }, + { Name = "CanWhisperGuild", Type = "ChatWhisperTargetStatus", EnumValue = 1 }, + { Name = "Offline", Type = "ChatWhisperTargetStatus", EnumValue = 2 }, + { Name = "WrongFaction", Type = "ChatWhisperTargetStatus", EnumValue = 3 }, + }, + }, + { + Name = "ExcludedCensorSources", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 255, + Fields = + { + { Name = "None", Type = "ExcludedCensorSources", EnumValue = 0 }, + { Name = "Friends", Type = "ExcludedCensorSources", EnumValue = 1 }, + { Name = "Guild", Type = "ExcludedCensorSources", EnumValue = 2 }, + { Name = "Reserve1", Type = "ExcludedCensorSources", EnumValue = 4 }, + { Name = "Reserve2", Type = "ExcludedCensorSources", EnumValue = 8 }, + { Name = "Reserve3", Type = "ExcludedCensorSources", EnumValue = 16 }, + { Name = "Reserve4", Type = "ExcludedCensorSources", EnumValue = 32 }, + { Name = "Reserve5", Type = "ExcludedCensorSources", EnumValue = 64 }, + { Name = "Reserve6", Type = "ExcludedCensorSources", EnumValue = 128 }, + { Name = "All", Type = "ExcludedCensorSources", EnumValue = 255 }, + }, + }, + { + Name = "LanguageFlag", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "IsExotic", Type = "LanguageFlag", EnumValue = 1 }, + { Name = "HiddenFromPlayer", Type = "LanguageFlag", EnumValue = 2 }, + { Name = "HideLanguageNameInChat", Type = "LanguageFlag", EnumValue = 4 }, + }, + }, + { + Name = "PermanentChatChannelType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "PermanentChatChannelType", EnumValue = 0 }, + { Name = "Zone", Type = "PermanentChatChannelType", EnumValue = 1 }, + { Name = "Communities", Type = "PermanentChatChannelType", EnumValue = 2 }, + { Name = "Custom", Type = "PermanentChatChannelType", EnumValue = 3 }, + }, + }, + { + Name = "RegisterAddonMessagePrefixResult", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Success", Type = "RegisterAddonMessagePrefixResult", EnumValue = 0 }, + { Name = "DuplicatePrefix", Type = "RegisterAddonMessagePrefixResult", EnumValue = 1 }, + { Name = "InvalidPrefix", Type = "RegisterAddonMessagePrefixResult", EnumValue = 2 }, + { Name = "MaxPrefixes", Type = "RegisterAddonMessagePrefixResult", EnumValue = 3 }, + }, + }, + { + Name = "SendAddonMessageResult", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "Success", Type = "SendAddonMessageResult", EnumValue = 0 }, + { Name = "InvalidPrefix", Type = "SendAddonMessageResult", EnumValue = 1 }, + { Name = "InvalidMessage", Type = "SendAddonMessageResult", EnumValue = 2 }, + { Name = "AddonMessageThrottle", Type = "SendAddonMessageResult", EnumValue = 3 }, + { Name = "InvalidChatType", Type = "SendAddonMessageResult", EnumValue = 4 }, + { Name = "NotInGroup", Type = "SendAddonMessageResult", EnumValue = 5 }, + { Name = "TargetRequired", Type = "SendAddonMessageResult", EnumValue = 6 }, + { Name = "InvalidChannel", Type = "SendAddonMessageResult", EnumValue = 7 }, + { Name = "ChannelThrottle", Type = "SendAddonMessageResult", EnumValue = 8 }, + { Name = "GeneralError", Type = "SendAddonMessageResult", EnumValue = 9 }, + { Name = "NotInGuild", Type = "SendAddonMessageResult", EnumValue = 10 }, + { Name = "AddOnMessageLockdown", Type = "SendAddonMessageResult", EnumValue = 11 }, + { Name = "TargetOffline", Type = "SendAddonMessageResult", EnumValue = 12 }, + }, + }, + { + Name = "TtsBoolSetting", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "PlaySoundSeparatingChatLineBreaks", Type = "TtsBoolSetting", EnumValue = 0 }, + { Name = "AddCharacterNameToSpeech", Type = "TtsBoolSetting", EnumValue = 1 }, + { Name = "PlayActivitySoundWhenNotFocused", Type = "TtsBoolSetting", EnumValue = 2 }, + { Name = "AlternateSystemVoice", Type = "TtsBoolSetting", EnumValue = 3 }, + { Name = "NarrateMyMessages", Type = "TtsBoolSetting", EnumValue = 4 }, + }, + }, + { + Name = "TtsVoiceType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Standard", Type = "TtsVoiceType", EnumValue = 0 }, + { Name = "Alternate", Type = "TtsVoiceType", EnumValue = 1 }, + }, + }, + { + Name = "ChatChannelInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "shortcut", Type = "cstring", Nilable = false }, + { Name = "localID", Type = "number", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + { Name = "zoneChannelID", Type = "number", Nilable = false }, + { Name = "channelType", Type = "PermanentChatChannelType", Nilable = false }, + }, + }, + { + Name = "ChatFrameConstants", + Type = "Constants", + Values = + { + { Name = "MaxChatWindows", Type = "number", Value = 10 }, + { Name = "MaxChatChannels", Type = "number", Value = 20 }, + { Name = "MaxCharacterNameBytes", Type = "number", Value = FULLNAME_MAX_CHAR }, + }, + }, + { + Name = "TTSConstants", + Type = "Constants", + Values = + { + { Name = "TTSRateMin", Type = "number", Value = -10 }, + { Name = "TTSRateMax", Type = "number", Value = 10 }, + { Name = "TTSRateDefault", Type = "number", Value = 0 }, + { Name = "TTSVolumeMin", Type = "number", Value = 0 }, + { Name = "TTSVolumeMax", Type = "number", Value = 100 }, + { Name = "TTSVolumeDefault", Type = "number", Value = 100 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ChatConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..99eba61 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChatInfoDocumentation.lua.annotated.lua @@ -0,0 +1,2767 @@ +local ChatInfo = +{ + Name = "ChatInfo", + Type = "System", + Namespace = "C_ChatInfo", + Environment = "All", + + Functions = + { + { + Name = "CanPlayerSpeakLanguage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "languageId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canSpeakLanguage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelEmote", + Type = "Function", + }, + { + Name = "DropCautionaryChatMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "confirmNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetChannelInfoFromIdentifier", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelIdentifier", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ChatChannelInfo", Nilable = true }, + }, + }, + { + Name = "GetChannelRosterInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelIndex", Type = "luaIndex", Nilable = false }, + { Name = "rosterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "owner", Type = "bool", Nilable = false }, + { Name = "moderator", Type = "bool", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetChannelRuleset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "ruleset", Type = "ChatChannelRuleset", Nilable = false }, + }, + }, + { + Name = "GetChannelRulesetForChannelID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "ruleset", Type = "ChatChannelRuleset", Nilable = false }, + }, + }, + { + Name = "GetChannelShortcut", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "shortcut", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetChannelShortcutForChannelID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "shortcut", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetChatLineSenderGUID", + Type = "Function", + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatLine", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetChatLineSenderName", + Type = "Function", + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatLine", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetChatLineText", + Type = "Function", + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatLine", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetChatTypeName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "typeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetClubStreamIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubID", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "ids", Type = "table", InnerType = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "GetColorForChatType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatType", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + }, + }, + { + Name = "GetGeneralChannelID", + Type = "Function", + + Returns = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGeneralChannelLocalID", + Type = "Function", + + Returns = + { + { Name = "localID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMentorChannelID", + Type = "Function", + + Returns = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumActiveChannels", + Type = "Function", + + Returns = + { + { Name = "numChannels", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumReservedChatWindows", + Type = "Function", + + Returns = + { + { Name = "numReserved", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRegisteredAddonMessagePrefixes", + Type = "Function", + + Returns = + { + { Name = "registeredPrefixes", Type = "table", InnerType = "cstring", Nilable = false }, + }, + }, + { + Name = "InChatMessagingLockdown", + Type = "Function", + Documentation = { "Returns true if API security restrictions regarding chat messaging are in effect." }, + + Returns = + { + { Name = "isRestricted", Type = "bool", Nilable = false }, + { Name = "lockdownReason", Type = "ChatMessagingLockdownReason", Nilable = true, Documentation = { "Optionally specified reason for the chat lockdown. Always nil if isRestricted is false, but should also be treated as potentially nil if true." } }, + }, + }, + { + Name = "IsAddonMessagePrefixRegistered", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isRegistered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChannelRegional", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isRegional", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChannelRegionalForChannelID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isRegional", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChatLineCensored", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatLine", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCensored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLoggingChat", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLoggingCombat", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "advanced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPartyChannelType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelType", Type = "ChatChannelType", Nilable = false }, + }, + + Returns = + { + { Name = "isPartyChannelType", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRegionalServiceAvailable", + Type = "Function", + + Returns = + { + { Name = "available", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTimerunningPlayer", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isTimerunning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidChatLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatLine", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidCombatFilterName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isApproved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PerformEmote", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "emoteName", Type = "cstring", Nilable = false }, + { Name = "targetName", Type = "cstring", Nilable = true }, + { Name = "suppressMoveError", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterAddonMessagePrefix", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Registers interest in addon messages with this prefix, cannot be an empty string." }, + + Arguments = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "RegisterAddonMessagePrefixResult", Nilable = false }, + }, + }, + { + Name = "ReplaceIconAndGroupExpressions", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "input", Type = "string", Nilable = false }, + { Name = "noIconReplacement", Type = "bool", Nilable = true }, + { Name = "noGroupReplacement", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "RequestCanLocalWhisperTarget", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "whisperTarget", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ResetDefaultZoneChannels", + Type = "Function", + }, + { + Name = "SendAddonMessage", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Sends a text payload to other clients specified by chatChannel and target which are registered to listen for prefix." }, + + Arguments = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + { Name = "message", Type = "cstring", Nilable = false }, + { Name = "chatType", Type = "cstring", Nilable = true, Documentation = { "ChatType, defaults to SLASH_CMD_PARTY." } }, + { Name = "target", Type = "cstring", Nilable = true, Documentation = { "Only applies for targeted channels" } }, + }, + + Returns = + { + { Name = "result", Type = "SendAddonMessageResult", Nilable = false }, + }, + }, + { + Name = "SendAddonMessageLogged", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Sends a text payload to other clients specified by chatChannel and target which are registered to listen for prefix. Intended for plain text payloads; logged and throttled." }, + + Arguments = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + { Name = "message", Type = "cstring", Nilable = false }, + { Name = "chatType", Type = "cstring", Nilable = true, Documentation = { "ChatType, defaults to SLASH_CMD_PARTY." } }, + { Name = "target", Type = "cstring", Nilable = true, Documentation = { "Only applies for targeted channels" } }, + }, + + Returns = + { + { Name = "result", Type = "SendAddonMessageResult", Nilable = true }, + }, + }, + { + Name = "SendCautionaryChatMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "confirmNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "SendChatMessage", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "message", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "chatType", Type = "SendChatMessageType", Nilable = true, NeverSecret = true, Documentation = { "Chat type string ('SAY', 'EMOTE', etc.). Defaults to 'SAY' if not specified." } }, + { Name = "languageID", Type = "number", Nilable = true, NeverSecret = true, Documentation = { "Language to send the message in." } }, + { Name = "target", Type = "cstring", Nilable = true, Documentation = { "Name of the player to send a message to. Only applies to chat types that support targeted messages." } }, + }, + }, + { + Name = "SwapChatChannelsByChannelIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "firstChannelIndex", Type = "luaIndex", Nilable = false }, + { Name = "secondChannelIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "UncensorChatLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatLine", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AlternativeDefaultLanguageChanged", + Type = "Event", + LiteralName = "ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "BnChatMsgAddon", + Type = "Event", + LiteralName = "BN_CHAT_MSG_ADDON", + SynchronousEvent = true, + Payload = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "channel", Type = "cstring", Nilable = false }, + { Name = "senderID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CanLocalWhisperTargetResponse", + Type = "Event", + LiteralName = "CAN_LOCAL_WHISPER_TARGET_RESPONSE", + UniqueEvent = true, + Payload = + { + { Name = "whisperTarget", Type = "WOWGUID", Nilable = false }, + { Name = "status", Type = "ChatWhisperTargetStatus", Nilable = false }, + }, + }, + { + Name = "CanPlayerSpeakLanguageChanged", + Type = "Event", + LiteralName = "CAN_PLAYER_SPEAK_LANGUAGE_CHANGED", + UniqueEvent = true, + Payload = + { + { Name = "languageId", Type = "number", Nilable = false }, + { Name = "canSpeakLanguage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CautionaryChannelMessage", + Type = "Event", + LiteralName = "CAUTIONARY_CHANNEL_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "confirmNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "CautionaryChatMessage", + Type = "Event", + LiteralName = "CAUTIONARY_CHAT_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "chatLineID", Type = "number", Nilable = false }, + { Name = "confirmNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelCountUpdate", + Type = "Event", + LiteralName = "CHANNEL_COUNT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "displayIndex", Type = "number", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelFlagsUpdated", + Type = "Event", + LiteralName = "CHANNEL_FLAGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "displayIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelInviteRequest", + Type = "Event", + LiteralName = "CHANNEL_INVITE_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "cstring", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ChannelLeft", + Type = "Event", + LiteralName = "CHANNEL_LEFT", + SynchronousEvent = true, + Payload = + { + { Name = "chatChannelID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ChannelPasswordRequest", + Type = "Event", + LiteralName = "CHANNEL_PASSWORD_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ChannelRosterUpdate", + Type = "Event", + LiteralName = "CHANNEL_ROSTER_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "displayIndex", Type = "number", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelUiUpdate", + Type = "Event", + LiteralName = "CHANNEL_UI_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ChatCombatMsgArenaPointsGain", + Type = "Event", + LiteralName = "CHAT_COMBAT_MSG_ARENA_POINTS_GAIN", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatLoggingChanged", + Type = "Event", + LiteralName = "CHAT_LOGGING_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "whichLog", Type = "number", Nilable = false }, + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatMsgAchievement", + Type = "Event", + LiteralName = "CHAT_MSG_ACHIEVEMENT", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgAddon", + Type = "Event", + LiteralName = "CHAT_MSG_ADDON", + SynchronousEvent = true, + Payload = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "channel", Type = "cstring", Nilable = false }, + { Name = "sender", Type = "cstring", Nilable = false }, + { Name = "target", Type = "cstring", Nilable = false }, + { Name = "zoneChannelID", Type = "number", Nilable = false }, + { Name = "localID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgAddonLogged", + Type = "Event", + LiteralName = "CHAT_MSG_ADDON_LOGGED", + SynchronousEvent = true, + Payload = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "channel", Type = "cstring", Nilable = false }, + { Name = "sender", Type = "cstring", Nilable = false }, + { Name = "target", Type = "cstring", Nilable = false }, + { Name = "zoneChannelID", Type = "number", Nilable = false }, + { Name = "localID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgAfk", + Type = "Event", + LiteralName = "CHAT_MSG_AFK", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBgSystemAlliance", + Type = "Event", + LiteralName = "CHAT_MSG_BG_SYSTEM_ALLIANCE", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBgSystemHorde", + Type = "Event", + LiteralName = "CHAT_MSG_BG_SYSTEM_HORDE", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBgSystemNeutral", + Type = "Event", + LiteralName = "CHAT_MSG_BG_SYSTEM_NEUTRAL", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBn", + Type = "Event", + LiteralName = "CHAT_MSG_BN", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnInlineToastAlert", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_ALERT", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnInlineToastBroadcast", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_BROADCAST", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnInlineToastBroadcastInform", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnInlineToastConversation", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_CONVERSATION", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_BN_WHISPER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnWhisperInform", + Type = "Event", + LiteralName = "CHAT_MSG_BN_WHISPER_INFORM", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgBnWhisperPlayerOffline", + Type = "Event", + LiteralName = "CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgChannel", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgChannelJoin", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_JOIN", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgChannelLeave", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_LEAVE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgChannelLeavePrevented", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_LEAVE_PREVENTED", + SynchronousEvent = true, + Payload = + { + { Name = "channelName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ChatMsgChannelList", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_LIST", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgChannelNotice", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_NOTICE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgChannelNoticeUser", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_NOTICE_USER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgCombatFactionChange", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_FACTION_CHANGE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgCombatHonorGain", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_HONOR_GAIN", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgCombatMiscInfo", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_MISC_INFO", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgCombatXpGain", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_XP_GAIN", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgCommunitiesChannel", + Type = "Event", + LiteralName = "CHAT_MSG_COMMUNITIES_CHANNEL", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgCurrency", + Type = "Event", + LiteralName = "CHAT_MSG_CURRENCY", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgDnd", + Type = "Event", + LiteralName = "CHAT_MSG_DND", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgEmote", + Type = "Event", + LiteralName = "CHAT_MSG_EMOTE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgFiltered", + Type = "Event", + LiteralName = "CHAT_MSG_FILTERED", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgGuild", + Type = "Event", + LiteralName = "CHAT_MSG_GUILD", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgGuildAchievement", + Type = "Event", + LiteralName = "CHAT_MSG_GUILD_ACHIEVEMENT", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgGuildItemLooted", + Type = "Event", + LiteralName = "CHAT_MSG_GUILD_ITEM_LOOTED", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgIgnored", + Type = "Event", + LiteralName = "CHAT_MSG_IGNORED", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgInstanceChat", + Type = "Event", + LiteralName = "CHAT_MSG_INSTANCE_CHAT", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgInstanceChatLeader", + Type = "Event", + LiteralName = "CHAT_MSG_INSTANCE_CHAT_LEADER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgLoot", + Type = "Event", + LiteralName = "CHAT_MSG_LOOT", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgMoney", + Type = "Event", + LiteralName = "CHAT_MSG_MONEY", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgMonsterEmote", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_EMOTE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgMonsterParty", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_PARTY", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgMonsterSay", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_SAY", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgMonsterWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_WHISPER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgMonsterYell", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_YELL", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgOfficer", + Type = "Event", + LiteralName = "CHAT_MSG_OFFICER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgOpening", + Type = "Event", + LiteralName = "CHAT_MSG_OPENING", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgParty", + Type = "Event", + LiteralName = "CHAT_MSG_PARTY", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgPartyLeader", + Type = "Event", + LiteralName = "CHAT_MSG_PARTY_LEADER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgPetBattleCombatLog", + Type = "Event", + LiteralName = "CHAT_MSG_PET_BATTLE_COMBAT_LOG", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgPetBattleInfo", + Type = "Event", + LiteralName = "CHAT_MSG_PET_BATTLE_INFO", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgPetInfo", + Type = "Event", + LiteralName = "CHAT_MSG_PET_INFO", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgPing", + Type = "Event", + LiteralName = "CHAT_MSG_PING", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgRaid", + Type = "Event", + LiteralName = "CHAT_MSG_RAID", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgRaidBossEmote", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_BOSS_EMOTE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgRaidBossWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_BOSS_WHISPER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgRaidLeader", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_LEADER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgRaidWarning", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_WARNING", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgRestricted", + Type = "Event", + LiteralName = "CHAT_MSG_RESTRICTED", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgSay", + Type = "Event", + LiteralName = "CHAT_MSG_SAY", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgSkill", + Type = "Event", + LiteralName = "CHAT_MSG_SKILL", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgSystem", + Type = "Event", + LiteralName = "CHAT_MSG_SYSTEM", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgTargeticons", + Type = "Event", + LiteralName = "CHAT_MSG_TARGETICONS", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgTextEmote", + Type = "Event", + LiteralName = "CHAT_MSG_TEXT_EMOTE", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgTradeskills", + Type = "Event", + LiteralName = "CHAT_MSG_TRADESKILLS", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgVoiceText", + Type = "Event", + LiteralName = "CHAT_MSG_VOICE_TEXT", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_WHISPER", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgWhisperInform", + Type = "Event", + LiteralName = "CHAT_MSG_WHISPER_INFORM", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatMsgYell", + Type = "Event", + LiteralName = "CHAT_MSG_YELL", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "ChatRegionalSendFailed", + Type = "Event", + LiteralName = "CHAT_REGIONAL_SEND_FAILED", + SynchronousEvent = true, + }, + { + Name = "ChatRegionalStatusChanged", + Type = "Event", + LiteralName = "CHAT_REGIONAL_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isServiceAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatServerDisconnected", + Type = "Event", + LiteralName = "CHAT_SERVER_DISCONNECTED", + SynchronousEvent = true, + Payload = + { + { Name = "isInitialMessage", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ChatServerReconnected", + Type = "Event", + LiteralName = "CHAT_SERVER_RECONNECTED", + SynchronousEvent = true, + }, + { + Name = "ClearBossEmotes", + Type = "Event", + LiteralName = "CLEAR_BOSS_EMOTES", + SynchronousEvent = true, + }, + { + Name = "DailyResetInstanceWelcome", + Type = "Event", + LiteralName = "DAILY_RESET_INSTANCE_WELCOME", + SynchronousEvent = true, + Payload = + { + { Name = "mapname", Type = "cstring", Nilable = false }, + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "InstanceResetWarning", + Type = "Event", + LiteralName = "INSTANCE_RESET_WARNING", + SynchronousEvent = true, + Payload = + { + { Name = "warningMessage", Type = "cstring", Nilable = false }, + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "LanguageListChanged", + Type = "Event", + LiteralName = "LANGUAGE_LIST_CHANGED", + SynchronousEvent = true, + }, + { + Name = "NotifyChatSuppressed", + Type = "Event", + LiteralName = "NOTIFY_CHAT_SUPPRESSED", + SynchronousEvent = true, + }, + { + Name = "QuestBossEmote", + Type = "Event", + LiteralName = "QUEST_BOSS_EMOTE", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "displayTime", Type = "number", Nilable = false }, + { Name = "enableBossEmoteWarningSound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RaidBossEmote", + Type = "Event", + LiteralName = "RAID_BOSS_EMOTE", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "displayTime", Type = "number", Nilable = false }, + { Name = "enableBossEmoteWarningSound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RaidBossWhisper", + Type = "Event", + LiteralName = "RAID_BOSS_WHISPER", + SynchronousEvent = true, + Payload = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "displayTime", Type = "number", Nilable = false }, + { Name = "enableBossEmoteWarningSound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RaidInstanceWelcome", + Type = "Event", + LiteralName = "RAID_INSTANCE_WELCOME", + SynchronousEvent = true, + Payload = + { + { Name = "mapname", Type = "cstring", Nilable = false }, + { Name = "timeLeft", Type = "number", Nilable = false }, + { Name = "locked", Type = "number", Nilable = false }, + { Name = "extended", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateChatColor", + Type = "Event", + LiteralName = "UPDATE_CHAT_COLOR", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "r", Type = "number", Nilable = false }, + { Name = "g", Type = "number", Nilable = false }, + { Name = "b", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateChatColorNameByClass", + Type = "Event", + LiteralName = "UPDATE_CHAT_COLOR_NAME_BY_CLASS", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "colorNameByClass", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UpdateChatWindows", + Type = "Event", + LiteralName = "UPDATE_CHAT_WINDOWS", + SynchronousEvent = true, + }, + { + Name = "UpdateFloatingChatWindows", + Type = "Event", + LiteralName = "UPDATE_FLOATING_CHAT_WINDOWS", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "AddonMessageParams", + Type = "Structure", + Fields = + { + { Name = "prefix", Type = "cstring", Nilable = false }, + { Name = "message", Type = "cstring", Nilable = false }, + { Name = "chatType", Type = "cstring", Nilable = true, Documentation = { "ChatType, defaults to SLASH_CMD_PARTY." } }, + { Name = "target", Type = "cstring", Nilable = true, Documentation = { "Only applies for targeted channels" } }, + }, + }, + { + Name = "ChatMessageEventParams", + Type = "Structure", + Fields = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = false }, + { Name = "languageName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "channelName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "playerName2", Type = "cstring", Nilable = false }, + { Name = "specialFlags", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "zoneChannelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelBaseName", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "languageID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "lineID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "bnSenderID", Type = "number", Nilable = false }, + { Name = "isMobile", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isSubtitle", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "suppressRaidIcons", Type = "bool", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "SendChatMessageParams", + Type = "Structure", + Fields = + { + { Name = "message", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "chatType", Type = "SendChatMessageType", Nilable = true, NeverSecret = true, Documentation = { "Chat type string ('SAY', 'EMOTE', etc.). Defaults to 'SAY' if not specified." } }, + { Name = "languageID", Type = "number", Nilable = true, NeverSecret = true, Documentation = { "Language to send the message in." } }, + { Name = "target", Type = "cstring", Nilable = true, Documentation = { "Name of the player to send a message to. Only applies to chat types that support targeted messages." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ChatInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..736b33f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ChromieTimeUIDocumentation.lua.annotated.lua @@ -0,0 +1,75 @@ +local ChromieTimeUI = +{ + Name = "ChromieTimeInfo", + Type = "System", + Namespace = "C_ChromieTime", + Environment = "All", + + Functions = + { + { + Name = "CloseUI", + Type = "Function", + }, + { + Name = "GetChromieTimeExpansionOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "expansionRecID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ChromieTimeExpansionInfo", Nilable = true }, + }, + }, + { + Name = "GetChromieTimeExpansionOptions", + Type = "Function", + + Returns = + { + { Name = "expansionOptions", Type = "table", InnerType = "ChromieTimeExpansionInfo", Nilable = false }, + }, + }, + { + Name = "SelectChromieTimeOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chromieTimeExpansionInfoId", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "ChromieTimeExpansionInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "mapAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "previewAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "alreadyOn", Type = "bool", Nilable = false }, + { Name = "recommended", Type = "bool", Nilable = false }, + { Name = "sortPriority", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ChromieTimeUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..57fd251 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local CinematicConstants = +{ + Tables = + { + { + Name = "CinematicType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "GlueMovie", Type = "CinematicType", EnumValue = 0 }, + { Name = "GameMovie", Type = "CinematicType", EnumValue = 1 }, + { Name = "GameClientScene", Type = "CinematicType", EnumValue = 2 }, + { Name = "GameCinematicSequence", Type = "CinematicType", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CinematicConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua.annotated.lua new file mode 100644 index 0000000..60cdd71 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicDocumentation.lua.annotated.lua @@ -0,0 +1,121 @@ +local Cinematic = +{ + Name = "Cinematic", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CinematicFinished", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieType", Type = "CinematicType", Nilable = false }, + { Name = "userCanceled", Type = "bool", Nilable = false, Default = false }, + { Name = "didError", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "CinematicStarted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieType", Type = "CinematicType", Nilable = false }, + { Name = "movieID", Type = "number", Nilable = false }, + { Name = "canCancel", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "InCinematic", + Type = "Function", + + Returns = + { + { Name = "inCinematic", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MouseOverrideCinematicDisable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "doOverride", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "OpeningCinematic", + Type = "Function", + }, + { + Name = "StopCinematic", + Type = "Function", + }, + }, + + Events = + { + { + Name = "CinematicStart", + Type = "Event", + LiteralName = "CINEMATIC_START", + SynchronousEvent = true, + Payload = + { + { Name = "canBeCancelled", Type = "bool", Nilable = false }, + { Name = "forcedAspectRatio", Type = "CameraModeAspectRatio", Nilable = false }, + }, + }, + { + Name = "CinematicStop", + Type = "Event", + LiteralName = "CINEMATIC_STOP", + SynchronousEvent = true, + }, + { + Name = "HideSubtitle", + Type = "Event", + LiteralName = "HIDE_SUBTITLE", + SynchronousEvent = true, + }, + { + Name = "PlayMovie", + Type = "Event", + LiteralName = "PLAY_MOVIE", + SynchronousEvent = true, + Payload = + { + { Name = "movieID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowSubtitle", + Type = "Event", + LiteralName = "SHOW_SUBTITLE", + SynchronousEvent = true, + Payload = + { + { Name = "subtitle", Type = "cstring", Nilable = false }, + { Name = "sender", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "StopMovie", + Type = "Event", + LiteralName = "STOP_MOVIE", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Cinematic); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b66e9c4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CinematicListDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local CinematicList = +{ + Name = "CinematicList", + Type = "System", + Namespace = "C_CinematicList", + Environment = "All", + + Functions = + { + { + Name = "GetUICinematicList", + Type = "Function", + + Returns = + { + { Name = "cinematics", Type = "table", InnerType = "UICinematic", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "UICinematic", + Type = "Structure", + Fields = + { + { Name = "expansion", Type = "number", Nilable = false }, + { Name = "movieIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "buttonUpAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "buttonDownAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "title", Type = "string", Nilable = true }, + { Name = "disableAutoPlay", Type = "bool", Nilable = false }, + { Name = "orderID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CinematicList); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..57b67fc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassColorDocumentation.lua.annotated.lua @@ -0,0 +1,37 @@ +local ClassColor = +{ + Name = "ClassColor", + Type = "System", + Namespace = "C_ClassColor", + Environment = "All", + + Functions = + { + { + Name = "GetClassColor", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "className", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "classColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ClassColor); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d3674a1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTalentsDocumentation.lua.annotated.lua @@ -0,0 +1,433 @@ +local ClassTalents = +{ + Name = "ClassTalents", + Type = "System", + Namespace = "C_ClassTalents", + Environment = "All", + + Functions = + { + { + Name = "CanChangeTalents", + Type = "Function", + Documentation = { "Returns true only if the player has staged changes and can commit their talents in their current state." }, + + Returns = + { + { Name = "canChange", Type = "bool", Nilable = false }, + { Name = "canAdd", Type = "bool", Nilable = false }, + { Name = "changeError", Type = "string", Nilable = true }, + }, + }, + { + Name = "CanCreateNewConfig", + Type = "Function", + + Returns = + { + { Name = "canCreate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanEditTalents", + Type = "Function", + Documentation = { "Returns true if the player could switch talents if they staged a proper loadout." }, + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + { Name = "changeError", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "CommitConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "savedConfigID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeleteConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActiveConfigID", + Type = "Function", + + Returns = + { + { Name = "activeConfigID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetActiveHeroTalentSpec", + Type = "Function", + Documentation = { "Returns the SubTreeID of the player's active Hero Talent Specialization SubTree." }, + + Returns = + { + { Name = "heroSpecID", Type = "number", Nilable = true, Documentation = { "SubTreeID of the player's active Hero Talent Specialization or nil if no Specialization is active." } }, + }, + }, + { + Name = "GetConfigIDsBySpecID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "configIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetHasStarterBuild", + Type = "Function", + + Returns = + { + { Name = "hasStarterBuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetHeroTalentSpecsForClassSpec", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the SubTreeIDs of the Hero Talent Specializations available to a Class Specialization and config; Returns nothing if none available" }, + + Arguments = + { + { Name = "configID", Type = "number", Nilable = true, Documentation = { "If not supplied, defaults to the player's active config" } }, + { Name = "classSpecID", Type = "number", Nilable = true, Documentation = { "If not supplied, defaults to the player's active spec" } }, + }, + + Returns = + { + { Name = "subTreeIDs", Type = "table", InnerType = "number", Nilable = true, Documentation = { "SubTreeIDs of each Hero Talent Specialization" } }, + { Name = "requiredPlayerLevel", Type = "number", Nilable = true, Documentation = { "The player level at which one of the Hero Talent Specializations can be activated" } }, + }, + }, + { + Name = "GetLastSelectedSavedConfigID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNextStarterBuildPurchase", + Type = "Function", + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = true }, + { Name = "entryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetStarterBuildActive", + Type = "Function", + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTraitTreeForSpec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "treeID", Type = "number", Nilable = true }, + }, + }, + { + Name = "HasUnspentHeroTalentPoints", + Type = "Function", + Documentation = { "Returns whether the player has any unspent talent points in their active hero talent tree. If hasUnspentPoints is true, numHeroPoints will be greater than zero." }, + + Returns = + { + { Name = "hasUnspentPoints", Type = "bool", Nilable = false }, + { Name = "numHeroPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasUnspentTalentPoints", + Type = "Function", + Documentation = { "Returns whether the player has any unspent talent points in their class or spec talent trees. If hasUnspentPoints is true, the number of unspent points for at least one of the trees will be greater than zero. Hero talent points are not included by this function." }, + + Returns = + { + { Name = "hasUnspentPoints", Type = "bool", Nilable = false }, + { Name = "numClassPoints", Type = "number", Nilable = false }, + { Name = "numSpecPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "ImportLoadout", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "entries", Type = "table", InnerType = "ImportLoadoutEntryInfo", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "importString", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "importError", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "InitializeViewLoadout", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsConfigPopulated", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "New configs may or may not be populated and ready to load immediately after creation. Avoid calling for configs intentionally created empty." }, + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPopulated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LoadConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "autoApply", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "LoadConfigResult", Nilable = false }, + { Name = "changeError", Type = "string", Nilable = true }, + { Name = "newLearnedNodeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RenameConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestNewConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SaveConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetStarterBuildActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "LoadConfigResult", Nilable = false }, + }, + }, + { + Name = "SetUsesSharedActionBars", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "usesShared", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UpdateLastSelectedSavedConfigID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ViewLoadout", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "entries", Type = "table", InnerType = "ImportLoadoutEntryInfo", Nilable = false }, + { Name = "importString", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActiveCombatConfigChanged", + Type = "Event", + LiteralName = "ACTIVE_COMBAT_CONFIG_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SelectedLoadoutChanged", + Type = "Event", + LiteralName = "SELECTED_LOADOUT_CHANGED", + SynchronousEvent = true, + }, + { + Name = "SpecializationChangeCastFailed", + Type = "Event", + LiteralName = "SPECIALIZATION_CHANGE_CAST_FAILED", + SynchronousEvent = true, + }, + { + Name = "StarterBuildActivationFailed", + Type = "Event", + LiteralName = "STARTER_BUILD_ACTIVATION_FAILED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "LoadConfigResult", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Error", Type = "LoadConfigResult", EnumValue = 0 }, + { Name = "NoChangesNecessary", Type = "LoadConfigResult", EnumValue = 1 }, + { Name = "LoadInProgress", Type = "LoadConfigResult", EnumValue = 2 }, + { Name = "Ready", Type = "LoadConfigResult", EnumValue = 3 }, + }, + }, + { + Name = "ImportLoadoutEntryInfo", + Type = "Structure", + Fields = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "ranksGranted", Type = "number", Nilable = false }, + { Name = "ranksPurchased", Type = "number", Nilable = false }, + { Name = "selectionEntryID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ClassTalents); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTrialDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTrialDocumentation.lua.annotated.lua new file mode 100644 index 0000000..291a5de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClassTrialDocumentation.lua.annotated.lua @@ -0,0 +1,33 @@ +local ClassTrial = +{ + Name = "ClassTrial", + Type = "System", + Namespace = "C_ClassTrial", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "ClassTrialTimerStart", + Type = "Event", + LiteralName = "CLASS_TRIAL_TIMER_START", + SynchronousEvent = true, + }, + { + Name = "ClassTrialUpgradeComplete", + Type = "Event", + LiteralName = "CLASS_TRIAL_UPGRADE_COMPLETE", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ClassTrial); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9ade4d3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local ClickBindingsConstants = +{ + Tables = + { + { + Name = "ClickBindingInteraction", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "Target", Type = "ClickBindingInteraction", EnumValue = 1 }, + { Name = "OpenContextMenu", Type = "ClickBindingInteraction", EnumValue = 2 }, + }, + }, + { + Name = "ClickBindingType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "ClickBindingType", EnumValue = 0 }, + { Name = "Spell", Type = "ClickBindingType", EnumValue = 1 }, + { Name = "Macro", Type = "ClickBindingType", EnumValue = 2 }, + { Name = "Interaction", Type = "ClickBindingType", EnumValue = 3 }, + { Name = "PetAction", Type = "ClickBindingType", EnumValue = 4 }, + }, + }, + { + Name = "ClickBindingInfo", + Type = "Structure", + Fields = + { + { Name = "type", Type = "ClickBindingType", Nilable = false }, + { Name = "actionID", Type = "number", Nilable = false, Documentation = { "Base spellID for spell, macro index for macro, ClickBindingInteraction for interaction, spellID for PetAction" } }, + { Name = "button", Type = "cstring", Nilable = false }, + { Name = "modifiers", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ClickBindingsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ee21ebd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClickBindingsDocumentation.lua.annotated.lua @@ -0,0 +1,153 @@ +local ClickBindings = +{ + Name = "ClickBindings", + Type = "System", + Namespace = "C_ClickBindings", + Environment = "All", + + Functions = + { + { + Name = "CanSpellBeClickBound", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false, Documentation = { "Base spellID for spell, spellID for PetAction" } }, + }, + + Returns = + { + { Name = "canBeBound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ExecuteBinding", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetToken", Type = "cstring", Nilable = false }, + { Name = "button", Type = "cstring", Nilable = false }, + { Name = "modifiers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBindingType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "button", Type = "cstring", Nilable = false }, + { Name = "modifiers", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "ClickBindingType", Nilable = false }, + }, + }, + { + Name = "GetEffectiveInteractionButton", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "button", Type = "cstring", Nilable = false }, + { Name = "modifiers", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "effectiveButton", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetProfileInfo", + Type = "Function", + + Returns = + { + { Name = "infoVec", Type = "table", InnerType = "ClickBindingInfo", Nilable = false }, + }, + }, + { + Name = "GetStringFromModifiers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "modifiers", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "modifierString", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTutorialShown", + Type = "Function", + + Returns = + { + { Name = "tutorialShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MakeModifiers", + Type = "Function", + + Returns = + { + { Name = "modifiers", Type = "number", Nilable = false }, + }, + }, + { + Name = "ResetCurrentProfile", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "SetProfileByInfo", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "infoVec", Type = "table", InnerType = "ClickBindingInfo", Nilable = false }, + }, + }, + { + Name = "SetTutorialShown", + Type = "Function", + }, + }, + + Events = + { + { + Name = "ClickbindingsSetHighlightsShown", + Type = "Event", + LiteralName = "CLICKBINDINGS_SET_HIGHLIGHTS_SHOWN", + SynchronousEvent = true, + Payload = + { + { Name = "showHighlights", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ClickBindings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ee86b25 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientDocumentation.lua.annotated.lua @@ -0,0 +1,104 @@ +local Client = +{ + Name = "Client", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "FlashClientIcon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "briefly", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetBillingTimeRested", + Type = "Function", + + Returns = + { + { Name = "billingTimeRested", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFileIDFromPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filePath", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "fileID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetFramerate", + Type = "Function", + + Returns = + { + { Name = "framerate", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsCpuBound", + Type = "Function", + + Returns = + { + { Name = "isCpuBound", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ReportBug", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "description", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ReportSuggestion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "description", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RestartGx", + Type = "Function", + }, + { + Name = "Screenshot", + Type = "Function", + }, + { + Name = "UpdateWindow", + Type = "Function", + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Client); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSceneDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSceneDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9c90a2f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSceneDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local ClientScene = +{ + Name = "ClientScene", + Type = "System", + Namespace = "C_ClientScene", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "ClientSceneClosed", + Type = "Event", + LiteralName = "CLIENT_SCENE_CLOSED", + SynchronousEvent = true, + }, + { + Name = "ClientSceneOpened", + Type = "Event", + LiteralName = "CLIENT_SCENE_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "sceneType", Type = "ClientSceneType", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ClientSceneType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "DefaultSceneType", Type = "ClientSceneType", EnumValue = 0 }, + { Name = "MinigameSceneType", Type = "ClientSceneType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ClientScene); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSettingsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSettingsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ecba780 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClientSettingsDocumentation.lua.annotated.lua @@ -0,0 +1,27 @@ +local ClientSettings = +{ + Tables = + { + { + Name = "ClientSettingsConfigFlag", + Type = "Enumeration", + NumValues = 9, + MinValue = 1, + MaxValue = 256, + Fields = + { + { Name = "ClientSettingsConfigDebug", Type = "ClientSettingsConfigFlag", EnumValue = 1 }, + { Name = "ClientSettingsConfigInternal", Type = "ClientSettingsConfigFlag", EnumValue = 2 }, + { Name = "ClientSettingsConfigPerf", Type = "ClientSettingsConfigFlag", EnumValue = 4 }, + { Name = "ClientSettingsConfigGm", Type = "ClientSettingsConfigFlag", EnumValue = 8 }, + { Name = "ClientSettingsConfigTest", Type = "ClientSettingsConfigFlag", EnumValue = 16 }, + { Name = "ClientSettingsConfigTestRetail", Type = "ClientSettingsConfigFlag", EnumValue = 32 }, + { Name = "ClientSettingsConfigBeta", Type = "ClientSettingsConfigFlag", EnumValue = 64 }, + { Name = "ClientSettingsConfigBetaRetail", Type = "ClientSettingsConfigFlag", EnumValue = 128 }, + { Name = "ClientSettingsConfigRetail", Type = "ClientSettingsConfigFlag", EnumValue = 256 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ClientSettings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9529e8f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubDocumentation.lua.annotated.lua @@ -0,0 +1,1972 @@ +local Club = +{ + Name = "Club", + Type = "System", + Namespace = "C_Club", + Environment = "All", + + Functions = + { + { + Name = "AcceptInvitation", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "AddClubStreamChatChannel", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "AdvanceStreamViewMarker", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "AreMembersReady", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "membersReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AssignMemberRole", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + { Name = "roleId", Type = "ClubRoleIdentifier", Nilable = false }, + }, + }, + { + Name = "CanResolvePlayerLocationFromClubMessageData", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "epoch", Type = "BigUInteger", Nilable = false }, + { Name = "position", Type = "BigUInteger", Nilable = false }, + }, + + Returns = + { + { Name = "canResolve", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearAutoAdvanceStreamViewMarker", + Type = "Function", + RequiresClubsInitialized = true, + }, + { + Name = "ClearClubPresenceSubscription", + Type = "Function", + RequiresClubsInitialized = true, + }, + { + Name = "CompareBattleNetDisplayName", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "lhsMemberId", Type = "number", Nilable = false }, + { Name = "rhsMemberId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "comparison", Type = "number", Nilable = false }, + }, + }, + { + Name = "CreateClub", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "shortName", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "clubType", Type = "ClubType", Nilable = false, Documentation = { "Valid types are BattleNet or Character" } }, + { Name = "avatarId", Type = "number", Nilable = false }, + { Name = "isCrossFaction", Type = "bool", Nilable = true }, + }, + }, + { + Name = "CreateStream", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check the canCreateStream privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "subject", Type = "string", Nilable = false }, + { Name = "leadersAndModeratorsOnly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CreateTicket", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check canCreateTicket privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "allowedRedeemCount", Type = "number", Nilable = true, Documentation = { "Number of uses. nil means unlimited" } }, + { Name = "duration", Type = "number", Nilable = true, Documentation = { "Duration in seconds. nil never expires" } }, + { Name = "defaultStreamId", Type = "ClubStreamId", Nilable = true }, + { Name = "isCrossFaction", Type = "bool", Nilable = true }, + }, + }, + { + Name = "DeclineInvitation", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "DestroyClub", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check the canDestroy privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "DestroyMessage", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + }, + }, + { + Name = "DestroyStream", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check canDestroyStream privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "DestroyTicket", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check canDestroyTicket privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "ticketId", Type = "string", Nilable = false }, + }, + }, + { + Name = "DoesAnyCommunityHaveUnreadMessages", + Type = "Function", + RequiresClubsInitialized = true, + + Returns = + { + { Name = "hasUnreadMessages", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesCommunityHaveMembersOfTheOppositeFaction", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "hasMembersOfOppositeFaction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EditClub", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "nil arguments will not change existing club data" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "shortName", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = true }, + { Name = "avatarId", Type = "number", Nilable = true }, + { Name = "broadcast", Type = "string", Nilable = true }, + { Name = "crossFaction", Type = "bool", Nilable = true }, + }, + }, + { + Name = "EditMessage", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "EditStream", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check the canSetStreamName, canSetStreamSubject, canSetStreamAccess privileges. nil arguments will not change existing stream data." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "subject", Type = "string", Nilable = true }, + { Name = "leadersAndModeratorsOnly", Type = "bool", Nilable = true }, + }, + }, + { + Name = "Flush", + Type = "Function", + RequiresClubsInitialized = true, + }, + { + Name = "FocusCommunityStreams", + Type = "Function", + RequiresClubsInitialized = true, + }, + { + Name = "FocusMembers", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "FocusStream", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + + Returns = + { + { Name = "focused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAssignableRoles", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "assignableRoles", Type = "table", InnerType = "ClubRoleIdentifier", Nilable = false }, + }, + }, + { + Name = "GetAvatarIdList", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "listen for AVATAR_LIST_UPDATED event. This can happen if we haven't downloaded the battle.net avatar list yet" }, + + Arguments = + { + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + + Returns = + { + { Name = "avatarIds", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetClubCapacity", + Type = "Function", + RequiresClubsInitialized = true, + + Returns = + { + { Name = "capacity", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetClubInfo", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ClubInfo", Nilable = true }, + }, + }, + { + Name = "GetClubLimits", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + + Returns = + { + { Name = "clubLimits", Type = "ClubLimits", Nilable = false }, + }, + }, + { + Name = "GetClubMembers", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = true }, + }, + + Returns = + { + { Name = "members", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetClubPrivileges", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "The privileges for the logged in user for this club" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "privilegeInfo", Type = "ClubPrivilegeInfo", Nilable = false }, + }, + }, + { + Name = "GetClubStreamNotificationSettings", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "settings", Type = "table", InnerType = "ClubStreamNotificationSetting", Nilable = false }, + }, + }, + { + Name = "GetCommunityNameResultText", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "result", Type = "ValidateNameResult", Nilable = false }, + }, + + Returns = + { + { Name = "errorCode", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetGuildClubId", + Type = "Function", + RequiresClubsInitialized = true, + + Returns = + { + { Name = "guildClubId", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "GetInfoFromLastCommunityChatLine", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + + Returns = + { + { Name = "messageInfo", Type = "ClubMessageInfo", Nilable = false }, + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + }, + { + Name = "GetInvitationCandidates", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs" }, + + Arguments = + { + { Name = "filter", Type = "string", Nilable = true }, + { Name = "maxResults", Type = "number", Nilable = true }, + { Name = "cursorPosition", Type = "number", Nilable = true }, + { Name = "allowFullMatch", Type = "bool", Nilable = true }, + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "candidates", Type = "table", InnerType = "ClubInvitationCandidateInfo", Nilable = false }, + }, + }, + { + Name = "GetInvitationInfo", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get info about a specific club the active player has been invited to." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "invitation", Type = "ClubSelfInvitationInfo", Nilable = true }, + }, + }, + { + Name = "GetInvitationsForClub", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get the pending invitations for this club. Call RequestInvitationsForClub() to retrieve invitations from server." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "invitations", Type = "table", InnerType = "ClubInvitationInfo", Nilable = false }, + }, + }, + { + Name = "GetInvitationsForSelf", + Type = "Function", + RequiresClubsInitialized = true, + Documentation = { "These are the clubs the active player has been invited to." }, + + Returns = + { + { Name = "invitations", Type = "table", InnerType = "ClubSelfInvitationInfo", Nilable = false }, + }, + }, + { + Name = "GetLastTicketResponse", + Type = "Function", + MayReturnNothing = true, + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ticket", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "error", Type = "ClubErrorType", Nilable = false }, + { Name = "info", Type = "ClubInfo", Nilable = true }, + { Name = "showError", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMemberInfo", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ClubMemberInfo", Nilable = true }, + }, + }, + { + Name = "GetMemberInfoForSelf", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Info for the logged in user for this club" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ClubMemberInfo", Nilable = true }, + }, + }, + { + Name = "GetMessageInfo", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get info about a particular message." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "message", Type = "ClubMessageInfo", Nilable = true }, + }, + }, + { + Name = "GetMessageRanges", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get the ranges of the messages currently downloaded." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + + Returns = + { + { Name = "ranges", Type = "table", InnerType = "ClubMessageRange", Nilable = false }, + }, + }, + { + Name = "GetMessagesBefore", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get downloaded messages before (and including) the specified messageId limited by count. These are filtered by ignored players" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "newest", Type = "ClubMessageIdentifier", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "messages", Type = "table", InnerType = "ClubMessageInfo", Nilable = false }, + }, + }, + { + Name = "GetMessagesInRange", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get downloaded messages in the given range. These are filtered by ignored players" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "oldest", Type = "ClubMessageIdentifier", Nilable = false }, + { Name = "newest", Type = "ClubMessageIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "messages", Type = "table", InnerType = "ClubMessageInfo", Nilable = false }, + }, + }, + { + Name = "GetStreamInfo", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + + Returns = + { + { Name = "streamInfo", Type = "ClubStreamInfo", Nilable = true }, + }, + }, + { + Name = "GetStreamViewMarker", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + + Returns = + { + { Name = "lastReadTime", Type = "BigUInteger", Nilable = true, Documentation = { "nil if stream view is at current" } }, + }, + }, + { + Name = "GetStreams", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "streams", Type = "table", InnerType = "ClubStreamInfo", Nilable = false }, + }, + }, + { + Name = "GetSubscribedClubs", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + + Returns = + { + { Name = "clubs", Type = "table", InnerType = "ClubInfo", Nilable = false }, + }, + }, + { + Name = "GetTickets", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get the existing tickets for this club. Call RequestTickets() to retrieve tickets from server." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "tickets", Type = "table", InnerType = "ClubTicketInfo", Nilable = false }, + }, + }, + { + Name = "IsAccountMuted", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "accountMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBeginningOfStream", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the given message is the first message in the stream, taking into account ignored messages" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isBeginningOfStream", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + RequiresClubsInitialized = true, + + Returns = + { + { Name = "clubsEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRestricted", + Type = "Function", + RequiresClubsInitialized = true, + + Returns = + { + { Name = "restrictionReason", Type = "ClubRestrictionReason", Nilable = false }, + }, + }, + { + Name = "IsSubscribedToStream", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + + Returns = + { + { Name = "subscribed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KickMember", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check kickableRoleIds privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "LeaveClub", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "RedeemTicket", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ticketId", Type = "string", Nilable = false }, + }, + }, + { + Name = "RequestInvitationsForClub", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Request invitations for this club from server. Check canGetInvitation privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "RequestMoreMessagesBefore", + Type = "Function", + SecretInChatMessagingLockdown = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Call this when the user scrolls near the top of the message view, and more need to be displayed. The history will be downloaded backwards (newest to oldest)." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = true }, + { Name = "count", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "alreadyHasMessages", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestTicket", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ticketId", Type = "string", Nilable = false }, + }, + }, + { + Name = "RequestTickets", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Request tickets from server. Check canGetTicket privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "RevokeInvitation", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check canRevokeOwnInvitation or canRevokeOtherInvitation" }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "SendBattleTagFriendRequest", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guildClubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "SendCharacterInvitation", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "character", Type = "string", Nilable = false }, + }, + }, + { + Name = "SendInvitation", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check the canSendInvitation privilege." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "SendMessage", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetAutoAdvanceStreamViewMarker", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only one stream can be set for auto-advance at a time. Focused streams will have their view times advanced automatically." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "SetAvatarTexture", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + { Name = "avatarId", Type = "number", Nilable = false }, + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + }, + { + Name = "SetClubMemberNote", + Type = "Function", + HasRestrictions = true, + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check the canSetOwnMemberNote and canSetOtherMemberNote privileges." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetClubPresenceSubscription", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "You can only be subscribed to 0 or 1 clubs for presence. Subscribing to a new club automatically unsuscribes you to existing subscription." }, + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "SetClubStreamNotificationSettings", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "settings", Type = "table", InnerType = "ClubStreamNotificationSetting", Nilable = false }, + }, + }, + { + Name = "SetCommunityID", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "communityID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "SetFavorite", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSocialQueueingEnabled", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldAllowClubType", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + + Returns = + { + { Name = "clubTypeIsAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnfocusAllStreams", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unsubscribe", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnfocusMembers", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "UnfocusStream", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "ValidateText", + Type = "Function", + RequiresClubsInitialized = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubType", Type = "ClubType", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "clubFieldType", Type = "ClubFieldType", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "ValidateNameResult", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AvatarListUpdated", + Type = "Event", + LiteralName = "AVATAR_LIST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + }, + { + Name = "ClubAdded", + Type = "Event", + LiteralName = "CLUB_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubError", + Type = "Event", + LiteralName = "CLUB_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "action", Type = "ClubActionType", Nilable = false }, + { Name = "error", Type = "ClubErrorType", Nilable = false }, + { Name = "clubType", Type = "ClubType", Nilable = false }, + }, + }, + { + Name = "ClubInvitationAddedForSelf", + Type = "Event", + LiteralName = "CLUB_INVITATION_ADDED_FOR_SELF", + SynchronousEvent = true, + Payload = + { + { Name = "invitation", Type = "ClubSelfInvitationInfo", Nilable = false }, + }, + }, + { + Name = "ClubInvitationRemovedForSelf", + Type = "Event", + LiteralName = "CLUB_INVITATION_REMOVED_FOR_SELF", + SynchronousEvent = true, + Payload = + { + { Name = "invitationId", Type = "ClubInvitationId", Nilable = false }, + }, + }, + { + Name = "ClubInvitationsReceivedForClub", + Type = "Event", + LiteralName = "CLUB_INVITATIONS_RECEIVED_FOR_CLUB", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubMemberAdded", + Type = "Event", + LiteralName = "CLUB_MEMBER_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubMemberPresenceUpdated", + Type = "Event", + LiteralName = "CLUB_MEMBER_PRESENCE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + { Name = "presence", Type = "ClubMemberPresence", Nilable = false }, + }, + }, + { + Name = "ClubMemberRemoved", + Type = "Event", + LiteralName = "CLUB_MEMBER_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubMemberRoleUpdated", + Type = "Event", + LiteralName = "CLUB_MEMBER_ROLE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + { Name = "roleId", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubMemberUpdated", + Type = "Event", + LiteralName = "CLUB_MEMBER_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "memberId", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubMembersUpdated", + Type = "Event", + LiteralName = "CLUB_MEMBERS_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubMessageAdded", + Type = "Event", + LiteralName = "CLUB_MESSAGE_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + }, + }, + { + Name = "ClubMessageHistoryReceived", + Type = "Event", + LiteralName = "CLUB_MESSAGE_HISTORY_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "downloadedRange", Type = "ClubMessageRange", Nilable = false, Documentation = { "Range of history messages received." } }, + { Name = "contiguousRange", Type = "ClubMessageRange", Nilable = false, Documentation = { "Range of contiguous messages that the received messages are in." } }, + }, + }, + { + Name = "ClubMessageUpdated", + Type = "Event", + LiteralName = "CLUB_MESSAGE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + }, + }, + { + Name = "ClubRemoved", + Type = "Event", + LiteralName = "CLUB_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubRemovedMessage", + Type = "Event", + LiteralName = "CLUB_REMOVED_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "clubName", Type = "string", Nilable = false }, + { Name = "clubRemovedReason", Type = "ClubRemovedReason", Nilable = false }, + }, + }, + { + Name = "ClubSelfMemberRoleUpdated", + Type = "Event", + LiteralName = "CLUB_SELF_MEMBER_ROLE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "roleId", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubStreamAdded", + Type = "Event", + LiteralName = "CLUB_STREAM_ADDED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "ClubStreamRemoved", + Type = "Event", + LiteralName = "CLUB_STREAM_REMOVED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "ClubStreamSubscribed", + Type = "Event", + LiteralName = "CLUB_STREAM_SUBSCRIBED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "ClubStreamUnsubscribed", + Type = "Event", + LiteralName = "CLUB_STREAM_UNSUBSCRIBED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "ClubStreamUpdated", + Type = "Event", + LiteralName = "CLUB_STREAM_UPDATED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "ClubStreamsLoaded", + Type = "Event", + LiteralName = "CLUB_STREAMS_LOADED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubTicketCreated", + Type = "Event", + LiteralName = "CLUB_TICKET_CREATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "ticketInfo", Type = "ClubTicketInfo", Nilable = false }, + }, + }, + { + Name = "ClubTicketReceived", + Type = "Event", + LiteralName = "CLUB_TICKET_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "ticket", Type = "string", Nilable = false }, + }, + }, + { + Name = "ClubTicketsReceived", + Type = "Event", + LiteralName = "CLUB_TICKETS_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubUpdated", + Type = "Event", + LiteralName = "CLUB_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "InitialClubsLoaded", + Type = "Event", + LiteralName = "INITIAL_CLUBS_LOADED", + SynchronousEvent = true, + }, + { + Name = "StreamViewMarkerUpdated", + Type = "Event", + LiteralName = "STREAM_VIEW_MARKER_UPDATED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "lastReadTime", Type = "BigUInteger", Nilable = true, Documentation = { "nil if stream view is at current" } }, + }, + }, + }, + + Tables = + { + { + Name = "ClubActionType", + Type = "Enumeration", + NumValues = 27, + MinValue = 0, + MaxValue = 26, + Fields = + { + { Name = "ErrorClubActionSubscribe", Type = "ClubActionType", EnumValue = 0 }, + { Name = "ErrorClubActionCreate", Type = "ClubActionType", EnumValue = 1 }, + { Name = "ErrorClubActionEdit", Type = "ClubActionType", EnumValue = 2 }, + { Name = "ErrorClubActionDestroy", Type = "ClubActionType", EnumValue = 3 }, + { Name = "ErrorClubActionLeave", Type = "ClubActionType", EnumValue = 4 }, + { Name = "ErrorClubActionCreateTicket", Type = "ClubActionType", EnumValue = 5 }, + { Name = "ErrorClubActionDestroyTicket", Type = "ClubActionType", EnumValue = 6 }, + { Name = "ErrorClubActionRedeemTicket", Type = "ClubActionType", EnumValue = 7 }, + { Name = "ErrorClubActionGetTicket", Type = "ClubActionType", EnumValue = 8 }, + { Name = "ErrorClubActionGetTickets", Type = "ClubActionType", EnumValue = 9 }, + { Name = "ErrorClubActionGetBans", Type = "ClubActionType", EnumValue = 10 }, + { Name = "ErrorClubActionGetInvitations", Type = "ClubActionType", EnumValue = 11 }, + { Name = "ErrorClubActionRevokeInvitation", Type = "ClubActionType", EnumValue = 12 }, + { Name = "ErrorClubActionAcceptInvitation", Type = "ClubActionType", EnumValue = 13 }, + { Name = "ErrorClubActionDeclineInvitation", Type = "ClubActionType", EnumValue = 14 }, + { Name = "ErrorClubActionCreateStream", Type = "ClubActionType", EnumValue = 15 }, + { Name = "ErrorClubActionEditStream", Type = "ClubActionType", EnumValue = 16 }, + { Name = "ErrorClubActionDestroyStream", Type = "ClubActionType", EnumValue = 17 }, + { Name = "ErrorClubActionInviteMember", Type = "ClubActionType", EnumValue = 18 }, + { Name = "ErrorClubActionEditMember", Type = "ClubActionType", EnumValue = 19 }, + { Name = "ErrorClubActionEditMemberNote", Type = "ClubActionType", EnumValue = 20 }, + { Name = "ErrorClubActionKickMember", Type = "ClubActionType", EnumValue = 21 }, + { Name = "ErrorClubActionAddBan", Type = "ClubActionType", EnumValue = 22 }, + { Name = "ErrorClubActionRemoveBan", Type = "ClubActionType", EnumValue = 23 }, + { Name = "ErrorClubActionCreateMessage", Type = "ClubActionType", EnumValue = 24 }, + { Name = "ErrorClubActionEditMessage", Type = "ClubActionType", EnumValue = 25 }, + { Name = "ErrorClubActionDestroyMessage", Type = "ClubActionType", EnumValue = 26 }, + }, + }, + { + Name = "ClubErrorType", + Type = "Enumeration", + NumValues = 42, + MinValue = 0, + MaxValue = 41, + Fields = + { + { Name = "ErrorCommunitiesNone", Type = "ClubErrorType", EnumValue = 0 }, + { Name = "ErrorCommunitiesUnknown", Type = "ClubErrorType", EnumValue = 1 }, + { Name = "ErrorCommunitiesNeutralFaction", Type = "ClubErrorType", EnumValue = 2 }, + { Name = "ErrorCommunitiesUnknownRealm", Type = "ClubErrorType", EnumValue = 3 }, + { Name = "ErrorCommunitiesBadTarget", Type = "ClubErrorType", EnumValue = 4 }, + { Name = "ErrorCommunitiesWrongFaction", Type = "ClubErrorType", EnumValue = 5 }, + { Name = "ErrorCommunitiesRestricted", Type = "ClubErrorType", EnumValue = 6 }, + { Name = "ErrorCommunitiesIgnored", Type = "ClubErrorType", EnumValue = 7 }, + { Name = "ErrorCommunitiesGuild", Type = "ClubErrorType", EnumValue = 8 }, + { Name = "ErrorCommunitiesWrongRegion", Type = "ClubErrorType", EnumValue = 9 }, + { Name = "ErrorCommunitiesUnknownTicket", Type = "ClubErrorType", EnumValue = 10 }, + { Name = "ErrorCommunitiesMissingShortName", Type = "ClubErrorType", EnumValue = 11 }, + { Name = "ErrorCommunitiesProfanity", Type = "ClubErrorType", EnumValue = 12 }, + { Name = "ErrorCommunitiesTrial", Type = "ClubErrorType", EnumValue = 13 }, + { Name = "ErrorCommunitiesVeteranTrial", Type = "ClubErrorType", EnumValue = 14 }, + { Name = "ErrorCommunitiesChatMute", Type = "ClubErrorType", EnumValue = 15 }, + { Name = "ErrorClubFull", Type = "ClubErrorType", EnumValue = 16 }, + { Name = "ErrorClubNoClub", Type = "ClubErrorType", EnumValue = 17 }, + { Name = "ErrorClubNotMember", Type = "ClubErrorType", EnumValue = 18 }, + { Name = "ErrorClubAlreadyMember", Type = "ClubErrorType", EnumValue = 19 }, + { Name = "ErrorClubNoSuchMember", Type = "ClubErrorType", EnumValue = 20 }, + { Name = "ErrorClubNoSuchInvitation", Type = "ClubErrorType", EnumValue = 21 }, + { Name = "ErrorClubInvitationAlreadyExists", Type = "ClubErrorType", EnumValue = 22 }, + { Name = "ErrorClubInvalidRoleID", Type = "ClubErrorType", EnumValue = 23 }, + { Name = "ErrorClubInsufficientPrivileges", Type = "ClubErrorType", EnumValue = 24 }, + { Name = "ErrorClubTooManyClubsJoined", Type = "ClubErrorType", EnumValue = 25 }, + { Name = "ErrorClubVoiceFull", Type = "ClubErrorType", EnumValue = 26 }, + { Name = "ErrorClubStreamNoStream", Type = "ClubErrorType", EnumValue = 27 }, + { Name = "ErrorClubStreamInvalidName", Type = "ClubErrorType", EnumValue = 28 }, + { Name = "ErrorClubStreamCountAtMin", Type = "ClubErrorType", EnumValue = 29 }, + { Name = "ErrorClubStreamCountAtMax", Type = "ClubErrorType", EnumValue = 30 }, + { Name = "ErrorClubMemberHasRequiredRole", Type = "ClubErrorType", EnumValue = 31 }, + { Name = "ErrorClubSentInvitationCountAtMax", Type = "ClubErrorType", EnumValue = 32 }, + { Name = "ErrorClubReceivedInvitationCountAtMax", Type = "ClubErrorType", EnumValue = 33 }, + { Name = "ErrorClubTargetIsBanned", Type = "ClubErrorType", EnumValue = 34 }, + { Name = "ErrorClubBanAlreadyExists", Type = "ClubErrorType", EnumValue = 35 }, + { Name = "ErrorClubBanCountAtMax", Type = "ClubErrorType", EnumValue = 36 }, + { Name = "ErrorClubTicketCountAtMax", Type = "ClubErrorType", EnumValue = 37 }, + { Name = "ErrorClubTicketNoSuchTicket", Type = "ClubErrorType", EnumValue = 38 }, + { Name = "ErrorClubTicketHasConsumedAllowedRedeemCount", Type = "ClubErrorType", EnumValue = 39 }, + { Name = "ErrorClubDoesntAllowCrossFaction", Type = "ClubErrorType", EnumValue = 40 }, + { Name = "ErrorClubEditHasCrossFactionMembers", Type = "ClubErrorType", EnumValue = 41 }, + }, + }, + { + Name = "ClubFieldType", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "ClubName", Type = "ClubFieldType", EnumValue = 0 }, + { Name = "ClubShortName", Type = "ClubFieldType", EnumValue = 1 }, + { Name = "ClubDescription", Type = "ClubFieldType", EnumValue = 2 }, + { Name = "ClubBroadcast", Type = "ClubFieldType", EnumValue = 3 }, + { Name = "ClubStreamName", Type = "ClubFieldType", EnumValue = 4 }, + { Name = "ClubStreamSubject", Type = "ClubFieldType", EnumValue = 5 }, + { Name = "NumTypes", Type = "ClubFieldType", EnumValue = 6 }, + }, + }, + { + Name = "ClubInvitationCandidateStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Available", Type = "ClubInvitationCandidateStatus", EnumValue = 0 }, + { Name = "InvitePending", Type = "ClubInvitationCandidateStatus", EnumValue = 1 }, + { Name = "AlreadyMember", Type = "ClubInvitationCandidateStatus", EnumValue = 2 }, + }, + }, + { + Name = "ClubMemberPresence", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Unknown", Type = "ClubMemberPresence", EnumValue = 0 }, + { Name = "Online", Type = "ClubMemberPresence", EnumValue = 1 }, + { Name = "OnlineMobile", Type = "ClubMemberPresence", EnumValue = 2 }, + { Name = "Offline", Type = "ClubMemberPresence", EnumValue = 3 }, + { Name = "Away", Type = "ClubMemberPresence", EnumValue = 4 }, + { Name = "Busy", Type = "ClubMemberPresence", EnumValue = 5 }, + }, + }, + { + Name = "ClubRemovedReason", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "ClubRemovedReason", EnumValue = 0 }, + { Name = "Banned", Type = "ClubRemovedReason", EnumValue = 1 }, + { Name = "Removed", Type = "ClubRemovedReason", EnumValue = 2 }, + { Name = "ClubDestroyed", Type = "ClubRemovedReason", EnumValue = 3 }, + }, + }, + { + Name = "ClubRestrictionReason", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "ClubRestrictionReason", EnumValue = 0 }, + { Name = "Unavailable", Type = "ClubRestrictionReason", EnumValue = 1 }, + }, + }, + { + Name = "ClubStreamNotificationFilter", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "ClubStreamNotificationFilter", EnumValue = 0 }, + { Name = "Mention", Type = "ClubStreamNotificationFilter", EnumValue = 1 }, + { Name = "All", Type = "ClubStreamNotificationFilter", EnumValue = 2 }, + }, + }, + { + Name = "ClubStreamType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "General", Type = "ClubStreamType", EnumValue = 0 }, + { Name = "Guild", Type = "ClubStreamType", EnumValue = 1 }, + { Name = "Officer", Type = "ClubStreamType", EnumValue = 2 }, + { Name = "Other", Type = "ClubStreamType", EnumValue = 3 }, + }, + }, + { + Name = "ClubType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "BattleNet", Type = "ClubType", EnumValue = 0 }, + { Name = "Character", Type = "ClubType", EnumValue = 1 }, + { Name = "Guild", Type = "ClubType", EnumValue = 2 }, + { Name = "Other", Type = "ClubType", EnumValue = 3 }, + }, + }, + { + Name = "ClubInfo", + Type = "Structure", + Fields = + { + { Name = "clubId", Type = "ClubId", Nilable = false, NeverSecret = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "shortName", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "broadcast", Type = "string", Nilable = false }, + { Name = "clubType", Type = "ClubType", Nilable = false, NeverSecret = true }, + { Name = "avatarId", Type = "number", Nilable = false }, + { Name = "memberCount", Type = "number", Nilable = true, NeverSecret = true }, + { Name = "favoriteTimeStamp", Type = "BigUInteger", Nilable = true }, + { Name = "joinTime", Type = "BigUInteger", Nilable = true }, + { Name = "socialQueueingEnabled", Type = "bool", Nilable = true }, + { Name = "crossFaction", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ClubInvitationCandidateInfo", + Type = "Structure", + Fields = + { + { Name = "memberId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "priority", Type = "luaIndex", Nilable = false }, + { Name = "status", Type = "ClubInvitationCandidateStatus", Nilable = false }, + }, + }, + { + Name = "ClubInvitationInfo", + Type = "Structure", + Fields = + { + { Name = "invitationId", Type = "ClubInvitationId", Nilable = false }, + { Name = "isMyInvitation", Type = "bool", Nilable = false }, + { Name = "invitee", Type = "ClubMemberInfo", Nilable = false }, + }, + }, + { + Name = "ClubLimits", + Type = "Structure", + Fields = + { + { Name = "maximumNumberOfStreams", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubMemberInfo", + Type = "Structure", + Fields = + { + { Name = "isSelf", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "memberId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = true, Documentation = { "name may be encoded as a Kstring" } }, + { Name = "role", Type = "ClubRoleIdentifier", Nilable = true }, + { Name = "presence", Type = "ClubMemberPresence", Nilable = false }, + { Name = "clubType", Type = "ClubType", Nilable = true }, + { Name = "guid", Type = "WOWGUID", Nilable = true }, + { Name = "bnetAccountId", Type = "number", Nilable = true }, + { Name = "memberNote", Type = "string", Nilable = true }, + { Name = "officerNote", Type = "string", Nilable = true }, + { Name = "classID", Type = "number", Nilable = true }, + { Name = "race", Type = "number", Nilable = true }, + { Name = "level", Type = "number", Nilable = true }, + { Name = "zone", Type = "string", Nilable = true }, + { Name = "achievementPoints", Type = "number", Nilable = true }, + { Name = "profession1ID", Type = "number", Nilable = true }, + { Name = "profession1Rank", Type = "number", Nilable = true }, + { Name = "profession1Name", Type = "string", Nilable = true }, + { Name = "profession2ID", Type = "number", Nilable = true }, + { Name = "profession2Rank", Type = "number", Nilable = true }, + { Name = "profession2Name", Type = "string", Nilable = true }, + { Name = "lastOnlineYear", Type = "number", Nilable = true }, + { Name = "lastOnlineMonth", Type = "number", Nilable = true }, + { Name = "lastOnlineDay", Type = "number", Nilable = true }, + { Name = "lastOnlineHour", Type = "number", Nilable = true }, + { Name = "guildRank", Type = "string", Nilable = true }, + { Name = "guildRankOrder", Type = "luaIndex", Nilable = true }, + { Name = "isRemoteChat", Type = "bool", Nilable = true }, + { Name = "overallDungeonScore", Type = "number", Nilable = true }, + { Name = "faction", Type = "PvPFaction", Nilable = true, NeverSecret = true }, + { Name = "timerunningSeasonID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ClubMessageIdentifier", + Type = "Structure", + Fields = + { + { Name = "epoch", Type = "BigUInteger", Nilable = false, Documentation = { "number of microseconds since the UNIX epoch." } }, + { Name = "position", Type = "BigUInteger", Nilable = false, Documentation = { "sort order for messages at the same time" } }, + }, + }, + { + Name = "ClubMessageInfo", + Type = "Structure", + Fields = + { + { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, + { Name = "content", Type = "kstringClubMessage", Nilable = false }, + { Name = "author", Type = "ClubMemberInfo", Nilable = false }, + { Name = "destroyer", Type = "ClubMemberInfo", Nilable = true, Documentation = { "May be nil even if the message has been destroyed" } }, + { Name = "destroyed", Type = "bool", Nilable = false }, + { Name = "edited", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClubMessageRange", + Type = "Structure", + Fields = + { + { Name = "oldestMessageId", Type = "ClubMessageIdentifier", Nilable = false }, + { Name = "newestMessageId", Type = "ClubMessageIdentifier", Nilable = false }, + }, + }, + { + Name = "ClubPrivilegeInfo", + Type = "Structure", + Fields = + { + { Name = "canDestroy", Type = "bool", Nilable = false }, + { Name = "canSetAttribute", Type = "bool", Nilable = false }, + { Name = "canSetName", Type = "bool", Nilable = false }, + { Name = "canSetDescription", Type = "bool", Nilable = false }, + { Name = "canSetAvatar", Type = "bool", Nilable = false }, + { Name = "canSetBroadcast", Type = "bool", Nilable = false }, + { Name = "canSetPrivacyLevel", Type = "bool", Nilable = false }, + { Name = "canSetOwnMemberAttribute", Type = "bool", Nilable = false }, + { Name = "canSetOtherMemberAttribute", Type = "bool", Nilable = false }, + { Name = "canSetOwnMemberNote", Type = "bool", Nilable = false }, + { Name = "canSetOtherMemberNote", Type = "bool", Nilable = false }, + { Name = "canSetOwnVoiceState", Type = "bool", Nilable = false }, + { Name = "canSetOwnPresenceLevel", Type = "bool", Nilable = false }, + { Name = "canUseVoice", Type = "bool", Nilable = false }, + { Name = "canVoiceMuteMemberForAll", Type = "bool", Nilable = false }, + { Name = "canGetInvitation", Type = "bool", Nilable = false }, + { Name = "canSendInvitation", Type = "bool", Nilable = false }, + { Name = "canSendGuestInvitation", Type = "bool", Nilable = false }, + { Name = "canRevokeOwnInvitation", Type = "bool", Nilable = false }, + { Name = "canRevokeOtherInvitation", Type = "bool", Nilable = false }, + { Name = "canGetBan", Type = "bool", Nilable = false }, + { Name = "canGetSuggestion", Type = "bool", Nilable = false }, + { Name = "canSuggestMember", Type = "bool", Nilable = false }, + { Name = "canGetTicket", Type = "bool", Nilable = false }, + { Name = "canCreateTicket", Type = "bool", Nilable = false }, + { Name = "canDestroyTicket", Type = "bool", Nilable = false }, + { Name = "canAddBan", Type = "bool", Nilable = false }, + { Name = "canRemoveBan", Type = "bool", Nilable = false }, + { Name = "canCreateStream", Type = "bool", Nilable = false }, + { Name = "canDestroyStream", Type = "bool", Nilable = false }, + { Name = "canSetStreamPosition", Type = "bool", Nilable = false }, + { Name = "canSetStreamAttribute", Type = "bool", Nilable = false }, + { Name = "canSetStreamName", Type = "bool", Nilable = false }, + { Name = "canSetStreamSubject", Type = "bool", Nilable = false }, + { Name = "canSetStreamAccess", Type = "bool", Nilable = false }, + { Name = "canSetStreamVoiceLevel", Type = "bool", Nilable = false }, + { Name = "canCreateMessage", Type = "bool", Nilable = false }, + { Name = "canDestroyOwnMessage", Type = "bool", Nilable = false }, + { Name = "canDestroyOtherMessage", Type = "bool", Nilable = false }, + { Name = "canEditOwnMessage", Type = "bool", Nilable = false }, + { Name = "canPinMessage", Type = "bool", Nilable = false }, + { Name = "kickableRoleIds", Type = "table", InnerType = "number", Nilable = false, Documentation = { "Roles that can be kicked and banned" } }, + }, + }, + { + Name = "ClubRoleInfo", + Type = "Structure", + Fields = + { + { Name = "roleId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "required", Type = "bool", Nilable = false, Documentation = { "At least one user must be in this role" } }, + { Name = "unique", Type = "bool", Nilable = false, Documentation = { "At most one user can be in this role" } }, + }, + }, + { + Name = "ClubSelfInvitationInfo", + Type = "Structure", + Fields = + { + { Name = "invitationId", Type = "ClubInvitationId", Nilable = false }, + { Name = "club", Type = "ClubInfo", Nilable = false }, + { Name = "inviter", Type = "ClubMemberInfo", Nilable = false }, + { Name = "leaders", Type = "table", InnerType = "ClubMemberInfo", Nilable = false }, + }, + }, + { + Name = "ClubStreamInfo", + Type = "Structure", + Fields = + { + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "subject", Type = "string", Nilable = false }, + { Name = "leadersAndModeratorsOnly", Type = "bool", Nilable = false }, + { Name = "streamType", Type = "ClubStreamType", Nilable = false, NeverSecret = true }, + { Name = "creationTime", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "ClubStreamNotificationSetting", + Type = "Structure", + Fields = + { + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + { Name = "filter", Type = "ClubStreamNotificationFilter", Nilable = false }, + }, + }, + { + Name = "ClubTicketInfo", + Type = "Structure", + Fields = + { + { Name = "ticketId", Type = "string", Nilable = false }, + { Name = "allowedRedeemCount", Type = "number", Nilable = false }, + { Name = "currentRedeemCount", Type = "number", Nilable = false }, + { Name = "creationTime", Type = "BigUInteger", Nilable = false, Documentation = { "Creation time in microseconds since the UNIX epoch." } }, + { Name = "expirationTime", Type = "BigUInteger", Nilable = false, Documentation = { "Expiration time in microseconds since the UNIX epoch." } }, + { Name = "defaultStreamId", Type = "ClubStreamId", Nilable = true }, + { Name = "creator", Type = "ClubMemberInfo", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Club); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua.annotated.lua new file mode 100644 index 0000000..95360c8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubFinderDocumentation.lua.annotated.lua @@ -0,0 +1,989 @@ +local ClubFinder = +{ + Name = "ClubFinderInfo", + Type = "System", + Namespace = "C_ClubFinder", + Environment = "All", + + Functions = + { + { + Name = "ApplicantAcceptClubInvite", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ApplicantDeclineClubInvite", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "CancelMembershipRequest", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "CheckAllPlayerApplicantSettings", + Type = "Function", + }, + { + Name = "ClearAllFinderCache", + Type = "Function", + }, + { + Name = "ClearClubApplicantsCache", + Type = "Function", + }, + { + Name = "ClearClubFinderPostingsCache", + Type = "Function", + }, + { + Name = "DoesPlayerBelongToClubFromClubGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "belongsToClub", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetClubFinderDisableReason", + Type = "Function", + + Returns = + { + { Name = "disableReason", Type = "ClubFinderDisableReason", Nilable = true }, + }, + }, + { + Name = "GetClubRecruitmentSettings", + Type = "Function", + + Returns = + { + { Name = "settings", Type = "ClubSettingsInfo", Nilable = false }, + }, + }, + { + Name = "GetClubTypeFromFinderGUID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "clubType", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + { + Name = "GetFocusIndexFromFlag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flags", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerApplicantLocaleFlags", + Type = "Function", + + Returns = + { + { Name = "localeFlags", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerApplicantSettings", + Type = "Function", + + Returns = + { + { Name = "settings", Type = "ClubSettingsInfo", Nilable = false }, + }, + }, + { + Name = "GetPlayerClubApplicationStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "clubStatus", Type = "PlayerClubRequestStatus", Nilable = false }, + }, + }, + { + Name = "GetPlayerSettingsFocusFlagsSelectedCount", + Type = "Function", + + Returns = + { + { Name = "focusCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPostingIDFromClubFinderGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "postingID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRecruitingClubInfoFromClubID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "clubInfo", Type = "RecruitingClubInfo", Nilable = true }, + }, + }, + { + Name = "GetRecruitingClubInfoFromFinderGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "clubInfo", Type = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "GetStatusOfPostingFromClubId", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "postingID", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "postingFlags", Type = "table", InnerType = "ClubFinderClubPostingStatusFlags", Nilable = false }, + }, + }, + { + Name = "GetTotalMatchingCommunityListSize", + Type = "Function", + + Returns = + { + { Name = "totalSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotalMatchingGuildListSize", + Type = "Function", + + Returns = + { + { Name = "totalSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasAlreadyAppliedToLinkedPosting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "hasAlreadyApplied", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPostingBeenDelisted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "postingID", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "postingDelisted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCommunityFinderEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsListingEnabledFromFlags", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flags", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isListed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPostingBanned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "postingID", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "postingBanned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidSearchString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isApproved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LookupClubPostingFromClubFinderGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "isLinkedPosting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerGetClubInvitationList", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "inviteList", Type = "table", InnerType = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "PlayerRequestPendingClubsList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + { + Name = "PlayerReturnPendingCommunitiesList", + Type = "Function", + + Returns = + { + { Name = "info", Type = "table", InnerType = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "PlayerReturnPendingGuildsList", + Type = "Function", + + Returns = + { + { Name = "info", Type = "table", InnerType = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "PostClub", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "itemLevelRequirement", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "avatarId", Type = "number", Nilable = false }, + { Name = "specs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + { Name = "crossFaction", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "succesful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestApplicantList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + { + Name = "RequestClubsList", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guildListRequested", Type = "bool", Nilable = false }, + { Name = "searchString", Type = "string", Nilable = false }, + { Name = "specIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RequestMembershipToClub", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "comment", Type = "string", Nilable = false }, + { Name = "specIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RequestNextCommunityPage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "startingIndex", Type = "number", Nilable = false }, + { Name = "pageSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestNextGuildPage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "startingIndex", Type = "number", Nilable = false }, + { Name = "pageSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestPostingInformationFromClubId", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestSubscribedClubPostingIDs", + Type = "Function", + }, + { + Name = "ResetClubPostingMapCache", + Type = "Function", + }, + { + Name = "RespondToApplicant", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "shouldAccept", Type = "bool", Nilable = false }, + { Name = "requestType", Type = "ClubFinderRequestType", Nilable = false }, + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "forceAccept", Type = "bool", Nilable = false }, + { Name = "reported", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ReturnClubApplicantList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "table", InnerType = "ClubFinderApplicantInfo", Nilable = false }, + }, + }, + { + Name = "ReturnMatchingCommunityList", + Type = "Function", + + Returns = + { + { Name = "recruitingClubs", Type = "table", InnerType = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "ReturnMatchingGuildList", + Type = "Function", + + Returns = + { + { Name = "recruitingClubs", Type = "table", InnerType = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "ReturnPendingClubApplicantList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "table", InnerType = "ClubFinderApplicantInfo", Nilable = false }, + }, + }, + { + Name = "SendChatWhisper", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "applicantType", Type = "ClubFinderRequestType", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetAllRecruitmentSettings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPlayerApplicantLocaleFlags", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "localeFlags", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPlayerApplicantSettings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRecruitmentLocale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "locale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetRecruitmentSettings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowClubFinder", + Type = "Function", + + Returns = + { + { Name = "shouldShow", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ClubFinderApplicantInviteRecieved", + Type = "Event", + LiteralName = "CLUB_FINDER_APPLICANT_INVITE_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "clubFinderGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ClubFinderApplicationsUpdated", + Type = "Event", + LiteralName = "CLUB_FINDER_APPLICATIONS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + { Name = "clubFinderGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ClubFinderCanWhisperApplicant", + Type = "Event", + LiteralName = "CLUB_FINDER_CAN_WHISPER_APPLICANT", + SynchronousEvent = true, + Payload = + { + { Name = "applicant", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ClubFinderClubListReturned", + Type = "Event", + LiteralName = "CLUB_FINDER_CLUB_LIST_RETURNED", + SynchronousEvent = true, + Documentation = { "Signals when we recieve club data that can be used" }, + Payload = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + { + Name = "ClubFinderClubReported", + Type = "Event", + LiteralName = "CLUB_FINDER_CLUB_REPORTED", + SynchronousEvent = true, + Documentation = { "Sends an update to the UI about a reported guild or community." }, + Payload = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ClubFinderCommunityOfflineJoin", + Type = "Event", + LiteralName = "CLUB_FINDER_COMMUNITY_OFFLINE_JOIN", + SynchronousEvent = true, + Documentation = { "Signals to the UI that you (the player) have joined a community offline." }, + Payload = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "ClubFinderEnabledOrDisabled", + Type = "Event", + LiteralName = "CLUB_FINDER_ENABLED_OR_DISABLED", + SynchronousEvent = true, + Documentation = { "Sends an update to the UI that the club finder feature has been enabled or disabled." }, + }, + { + Name = "ClubFinderGuildRealmNameUpdated", + Type = "Event", + LiteralName = "CLUB_FINDER_GUILD_REALM_NAME_UPDATED", + SynchronousEvent = true, + Documentation = { "Sends an update to the UI if the realm name of a guild was found asynchronously." }, + Payload = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = false }, + }, + }, + { + Name = "ClubFinderLinkedClubReturned", + Type = "Event", + LiteralName = "CLUB_FINDER_LINKED_CLUB_RETURNED", + SynchronousEvent = true, + Documentation = { "When a player clicks a club link, this returns that information back about the club they clicked on" }, + Payload = + { + { Name = "clubInfo", Type = "RecruitingClubInfo", Nilable = false }, + }, + }, + { + Name = "ClubFinderMembershipListChanged", + Type = "Event", + LiteralName = "CLUB_FINDER_MEMBERSHIP_LIST_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ClubFinderPlayerPendingListRecieved", + Type = "Event", + LiteralName = "CLUB_FINDER_PLAYER_PENDING_LIST_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + { + Name = "ClubFinderPostUpdated", + Type = "Event", + LiteralName = "CLUB_FINDER_POST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "clubFinderGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ClubFinderRecruitListChanged", + Type = "Event", + LiteralName = "CLUB_FINDER_RECRUIT_LIST_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ClubFinderRecruitmentPostReturned", + Type = "Event", + LiteralName = "CLUB_FINDER_RECRUITMENT_POST_RETURNED", + SynchronousEvent = true, + Documentation = { "Signals when our recruitment post we just requested is returned back to us" }, + Payload = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + { + Name = "ClubFinderRecruitsUpdated", + Type = "Event", + LiteralName = "CLUB_FINDER_RECRUITS_UPDATED", + SynchronousEvent = true, + Documentation = { "Signals when we recieve the recruits list" }, + Payload = + { + { Name = "type", Type = "ClubFinderRequestType", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ClubFinderApplicationUpdateType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "ClubFinderApplicationUpdateType", EnumValue = 0 }, + { Name = "AcceptInvite", Type = "ClubFinderApplicationUpdateType", EnumValue = 1 }, + { Name = "DeclineInvite", Type = "ClubFinderApplicationUpdateType", EnumValue = 2 }, + { Name = "Cancel", Type = "ClubFinderApplicationUpdateType", EnumValue = 3 }, + }, + }, + { + Name = "ClubFinderClubPostingStatusFlags", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 0 }, + { Name = "NeedsCacheUpdate", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 1 }, + { Name = "ForceDescriptionChange", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 2 }, + { Name = "ForceNameChange", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 3 }, + { Name = "UnderReview", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 4 }, + { Name = "Banned", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 5 }, + { Name = "FakePost", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 6 }, + { Name = "PendingDelete", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 7 }, + { Name = "PostDelisted", Type = "ClubFinderClubPostingStatusFlags", EnumValue = 8 }, + }, + }, + { + Name = "ClubFinderDisableReason", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Muted", Type = "ClubFinderDisableReason", EnumValue = 0 }, + { Name = "Silenced", Type = "ClubFinderDisableReason", EnumValue = 1 }, + { Name = "VeteranTrial", Type = "ClubFinderDisableReason", EnumValue = 2 }, + }, + }, + { + Name = "ClubFinderPostingReportType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "PostersName", Type = "ClubFinderPostingReportType", EnumValue = 0 }, + { Name = "ClubName", Type = "ClubFinderPostingReportType", EnumValue = 1 }, + { Name = "PostingDescription", Type = "ClubFinderPostingReportType", EnumValue = 2 }, + { Name = "ApplicantsName", Type = "ClubFinderPostingReportType", EnumValue = 3 }, + { Name = "JoinNote", Type = "ClubFinderPostingReportType", EnumValue = 4 }, + }, + }, + { + Name = "ClubFinderRequestType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "ClubFinderRequestType", EnumValue = 0 }, + { Name = "Guild", Type = "ClubFinderRequestType", EnumValue = 1 }, + { Name = "Community", Type = "ClubFinderRequestType", EnumValue = 2 }, + { Name = "All", Type = "ClubFinderRequestType", EnumValue = 3 }, + }, + }, + { + Name = "ClubFinderSettingFlags", + Type = "Enumeration", + NumValues = 26, + MinValue = 0, + MaxValue = 25, + Fields = + { + { Name = "None", Type = "ClubFinderSettingFlags", EnumValue = 0 }, + { Name = "Dungeons", Type = "ClubFinderSettingFlags", EnumValue = 1 }, + { Name = "Raids", Type = "ClubFinderSettingFlags", EnumValue = 2 }, + { Name = "PvP", Type = "ClubFinderSettingFlags", EnumValue = 3 }, + { Name = "RP", Type = "ClubFinderSettingFlags", EnumValue = 4 }, + { Name = "Social", Type = "ClubFinderSettingFlags", EnumValue = 5 }, + { Name = "Small", Type = "ClubFinderSettingFlags", EnumValue = 6 }, + { Name = "Medium", Type = "ClubFinderSettingFlags", EnumValue = 7 }, + { Name = "Large", Type = "ClubFinderSettingFlags", EnumValue = 8 }, + { Name = "Tank", Type = "ClubFinderSettingFlags", EnumValue = 9 }, + { Name = "Healer", Type = "ClubFinderSettingFlags", EnumValue = 10 }, + { Name = "Damage", Type = "ClubFinderSettingFlags", EnumValue = 11 }, + { Name = "EnableListing", Type = "ClubFinderSettingFlags", EnumValue = 12 }, + { Name = "MaxLevelOnly", Type = "ClubFinderSettingFlags", EnumValue = 13 }, + { Name = "AutoAccept", Type = "ClubFinderSettingFlags", EnumValue = 14 }, + { Name = "FactionHorde", Type = "ClubFinderSettingFlags", EnumValue = 15 }, + { Name = "FactionAlliance", Type = "ClubFinderSettingFlags", EnumValue = 16 }, + { Name = "FactionNeutral", Type = "ClubFinderSettingFlags", EnumValue = 17 }, + { Name = "SortRelevance", Type = "ClubFinderSettingFlags", EnumValue = 18 }, + { Name = "SortMemberCount", Type = "ClubFinderSettingFlags", EnumValue = 19 }, + { Name = "SortNewest", Type = "ClubFinderSettingFlags", EnumValue = 20 }, + { Name = "LanguageReserved1", Type = "ClubFinderSettingFlags", EnumValue = 21 }, + { Name = "LanguageReserved2", Type = "ClubFinderSettingFlags", EnumValue = 22 }, + { Name = "LanguageReserved3", Type = "ClubFinderSettingFlags", EnumValue = 23 }, + { Name = "LanguageReserved4", Type = "ClubFinderSettingFlags", EnumValue = 24 }, + { Name = "LanguageReserved5", Type = "ClubFinderSettingFlags", EnumValue = 25 }, + }, + }, + { + Name = "PlayerClubRequestStatus", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "None", Type = "PlayerClubRequestStatus", EnumValue = 0 }, + { Name = "Pending", Type = "PlayerClubRequestStatus", EnumValue = 1 }, + { Name = "AutoApproved", Type = "PlayerClubRequestStatus", EnumValue = 2 }, + { Name = "Declined", Type = "PlayerClubRequestStatus", EnumValue = 3 }, + { Name = "Approved", Type = "PlayerClubRequestStatus", EnumValue = 4 }, + { Name = "Joined", Type = "PlayerClubRequestStatus", EnumValue = 5 }, + { Name = "JoinedAnother", Type = "PlayerClubRequestStatus", EnumValue = 6 }, + { Name = "Canceled", Type = "PlayerClubRequestStatus", EnumValue = 7 }, + }, + }, + { + Name = "ClubFinderApplicantInfo", + Type = "Structure", + Fields = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "closed", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "ilvl", Type = "number", Nilable = false }, + { Name = "specIds", Type = "table", InnerType = "number", Nilable = false }, + { Name = "requestStatus", Type = "PlayerClubRequestStatus", Nilable = false }, + { Name = "lookupSuccess", Type = "bool", Nilable = false }, + { Name = "lastUpdatedTime", Type = "BigInteger", Nilable = false }, + { Name = "faction", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClubSettingsInfo", + Type = "Structure", + Fields = + { + { Name = "playStyleDungeon", Type = "bool", Nilable = false }, + { Name = "playStyleRaids", Type = "bool", Nilable = false }, + { Name = "playStylePvp", Type = "bool", Nilable = false }, + { Name = "playStyleRP", Type = "bool", Nilable = false }, + { Name = "playStyleSocial", Type = "bool", Nilable = false }, + { Name = "roleTank", Type = "bool", Nilable = false }, + { Name = "roleHealer", Type = "bool", Nilable = false }, + { Name = "roleDps", Type = "bool", Nilable = false }, + { Name = "sizeSmall", Type = "bool", Nilable = false }, + { Name = "sizeMedium", Type = "bool", Nilable = false }, + { Name = "sizeLarge", Type = "bool", Nilable = false }, + { Name = "maxLevelOnly", Type = "bool", Nilable = false }, + { Name = "enableListing", Type = "bool", Nilable = false }, + { Name = "sortRelevance", Type = "bool", Nilable = false }, + { Name = "sortMembers", Type = "bool", Nilable = false }, + { Name = "sortNewest", Type = "bool", Nilable = false }, + { Name = "autoAccept", Type = "bool", Nilable = false }, + { Name = "crossFaction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RecruitingClubInfo", + Type = "Structure", + Fields = + { + { Name = "clubFinderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "numActiveMembers", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "comment", Type = "string", Nilable = false }, + { Name = "guildLeader", Type = "string", Nilable = false }, + { Name = "isGuild", Type = "bool", Nilable = false }, + { Name = "emblemInfo", Type = "number", Nilable = false }, + { Name = "tabardInfo", Type = "GuildTabardInfo", Nilable = true }, + { Name = "recruitingSpecIds", Type = "table", InnerType = "number", Nilable = false }, + { Name = "recruitmentFlags", Type = "number", Nilable = false }, + { Name = "localeSet", Type = "bool", Nilable = false }, + { Name = "recruitmentLocale", Type = "number", Nilable = false }, + { Name = "minILvl", Type = "number", Nilable = false }, + { Name = "cached", Type = "number", Nilable = false }, + { Name = "cacheRequested", Type = "number", Nilable = false }, + { Name = "lastPosterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "lastUpdatedTime", Type = "BigInteger", Nilable = false }, + { Name = "isCrossFaction", Type = "bool", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ClubFinder); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fce5ca1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ClubSharedDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local ClubShared = +{ + Tables = + { + { + Name = "ClubRoleIdentifier", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Owner", Type = "ClubRoleIdentifier", EnumValue = 1 }, + { Name = "Leader", Type = "ClubRoleIdentifier", EnumValue = 2 }, + { Name = "Moderator", Type = "ClubRoleIdentifier", EnumValue = 3 }, + { Name = "Member", Type = "ClubRoleIdentifier", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ClubShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..85a87d5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local Color = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Color); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverrideConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverrideConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..46aecf6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverrideConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,26 @@ +local ColorOverrideConstants = +{ + Tables = + { + { + Name = "ColorOverride", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "ItemQualityPoor", Type = "ColorOverride", EnumValue = 0 }, + { Name = "ItemQualityCommon", Type = "ColorOverride", EnumValue = 1 }, + { Name = "ItemQualityUncommon", Type = "ColorOverride", EnumValue = 2 }, + { Name = "ItemQualityRare", Type = "ColorOverride", EnumValue = 3 }, + { Name = "ItemQualityEpic", Type = "ColorOverride", EnumValue = 4 }, + { Name = "ItemQualityLegendary", Type = "ColorOverride", EnumValue = 5 }, + { Name = "ItemQualityArtifact", Type = "ColorOverride", EnumValue = 6 }, + { Name = "ItemQualityAccount", Type = "ColorOverride", EnumValue = 7 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ColorOverrideConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0ba587e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorOverridesDocumentation.lua.annotated.lua @@ -0,0 +1,117 @@ +local ColorOverrides = +{ + Name = "ColorOverrides", + Type = "System", + Namespace = "C_ColorOverrides", + Environment = "All", + + Functions = + { + { + Name = "ClearColorOverrides", + Type = "Function", + }, + { + Name = "GetColorForQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetColorOverrideInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "overrideType", Type = "ColorOverride", Nilable = false }, + }, + + Returns = + { + { Name = "overrideInfo", Type = "ColorOverrideInfo", Nilable = true }, + }, + }, + { + Name = "GetDefaultColorForQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "RemoveColorOverride", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "overrideType", Type = "ColorOverride", Nilable = false }, + }, + }, + { + Name = "SetColorOverride", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "overrideType", Type = "ColorOverride", Nilable = false }, + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ColorOverrideUpdated", + Type = "Event", + LiteralName = "COLOR_OVERRIDE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "overrideType", Type = "ColorOverride", Nilable = false }, + }, + }, + { + Name = "ColorOverridesReset", + Type = "Event", + LiteralName = "COLOR_OVERRIDES_RESET", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "ColorOverrideInfo", + Type = "Structure", + Fields = + { + { Name = "overrideType", Type = "ColorOverride", Nilable = false }, + { Name = "overrideColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "overrideColorString", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ColorOverrides); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4abe9df --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ColorUtilDocumentation.lua.annotated.lua @@ -0,0 +1,151 @@ +local ColorUtil = +{ + Name = "ColorUtil", + Type = "System", + Namespace = "C_ColorUtil", + Environment = "All", + + Functions = + { + { + Name = "ConvertHSLToHSV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Converts an unpacked HSL color to HSV." }, + + Arguments = + { + { Name = "hslH", Type = "number", Nilable = false }, + { Name = "hslS", Type = "number", Nilable = false }, + { Name = "hslL", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hsvH", Type = "number", Nilable = false }, + { Name = "hsvS", Type = "number", Nilable = false }, + { Name = "hsvV", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConvertHSVToHSL", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Converts an unpacked HSV color to HSL." }, + + Arguments = + { + { Name = "hsvH", Type = "number", Nilable = false }, + { Name = "hsvS", Type = "number", Nilable = false }, + { Name = "hsvV", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hslH", Type = "number", Nilable = false }, + { Name = "hslS", Type = "number", Nilable = false }, + { Name = "hslL", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConvertHSVToRGB", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Converts an unpacked HSV color to RGB." }, + + Arguments = + { + { Name = "hsvH", Type = "number", Nilable = false }, + { Name = "hsvS", Type = "number", Nilable = false }, + { Name = "hsvV", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rgbR", Type = "number", Nilable = false }, + { Name = "rgbG", Type = "number", Nilable = false }, + { Name = "rgbB", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConvertRGBToHSV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Converts an unpacked RGB color to HSV. For achromatic inputs, the returned hue will be -1." }, + + Arguments = + { + { Name = "rgbR", Type = "number", Nilable = false }, + { Name = "rgbG", Type = "number", Nilable = false }, + { Name = "rgbB", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hsvH", Type = "number", Nilable = false }, + { Name = "hsvS", Type = "number", Nilable = false }, + { Name = "hsvV", Type = "number", Nilable = false }, + }, + }, + { + Name = "GenerateTextColorCode", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Generates a hex color code suitable for use in text color code markup." }, + + Arguments = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false, Documentation = { "Color to generate a hex color code from." } }, + }, + + Returns = + { + { Name = "textColorCode", Type = "string", Nilable = false, Documentation = { "Hex representation of the color formatted as an 8-byte ARGB string, with alpha forced to 255." } }, + }, + }, + { + Name = "WrapTextInColor", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Wraps a given string with color code markup." }, + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false, Documentation = { "Text to be wrapped in color markup." } }, + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false, Documentation = { "Color to apply to the text." } }, + }, + + Returns = + { + { Name = "coloredText", Type = "string", Nilable = false, Documentation = { "The input text wrapped in '|c' and '|r' quoted code sequences for the supplied color." } }, + }, + }, + { + Name = "WrapTextInColorCode", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Wraps a given string with color code markup." }, + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false, Documentation = { "Text to be wrapped in color markup." } }, + { Name = "textColorCode", Type = "cstring", Nilable = false, Documentation = { "Color to apply to the text, formatted as an 8-byte ARGB string as returned by GenerateTextColorCode." } }, + }, + + Returns = + { + { Name = "coloredText", Type = "string", Nilable = false, Documentation = { "The input text wrapped in '|c' and '|r' quoted code sequences for the supplied color." } }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ColorUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..db345ba --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,54 @@ +local CombatAudioAlertConstants = +{ + Tables = + { + { + Name = "CAAConstants", + Type = "Constants", + Values = + { + { Name = "CAAEnabledDefault", Type = "bool", Value = false }, + { Name = "CAAVoiceDefault", Type = "number", Value = 0 }, + { Name = "CAASayCombatStartDefault", Type = "bool", Value = true }, + { Name = "CAASayCombatEndDefault", Type = "bool", Value = true }, + { Name = "CAAPlayerHealthPercentDefault", Type = "number", Value = 0 }, + { Name = "CAAPlayerHealthFormatDefault", Type = "number", Value = 1 }, + { Name = "CAATargetNameDefault", Type = "bool", Value = true }, + { Name = "CAATargetHealthPercentDefault", Type = "number", Value = 2 }, + { Name = "CAATargetHealthFormatDefault", Type = "number", Value = 3 }, + { Name = "CAATargetDeathBehaviorDefault", Type = "number", Value = 0 }, + { Name = "CAASayIfTargetedDefault", Type = "number", Value = 1 }, + { Name = "CAAPartyHealthPercentDefault", Type = "number", Value = 0 }, + { Name = "CAAPlayerCastModeDefault", Type = "number", Value = 0 }, + { Name = "CAAPlayerCastFormatDefault", Type = "number", Value = 4 }, + { Name = "CAATargetCastModeDefault", Type = "number", Value = 0 }, + { Name = "CAATargetCastFormatDefault", Type = "number", Value = 0 }, + { Name = "CAAInterruptCastDefault", Type = "number", Value = 0 }, + { Name = "CAAInterruptCastSuccessDefault", Type = "number", Value = 0 }, + { Name = "CAASayYourDebuffsDefault", Type = "bool", Value = true }, + { Name = "CAASayYourDebuffsFormatDefault", Type = "number", Value = 0 }, + { Name = "CAASayYourDebuffsMinDurationDefault", Type = "number", Value = 1.5 }, + { Name = "CAASayYourDebuffsMinDurationMin", Type = "number", Value = 0 }, + { Name = "CAASayYourDebuffsMinDurationMax", Type = "number", Value = 5 }, + { Name = "CAASayYourDebuffsMinDurationStep", Type = "number", Value = 0.5 }, + { Name = "CAADebuffSelfAlertDefault", Type = "number", Value = 0 }, + { Name = "CAAPlayerResourcePercentDefault", Type = "number", Value = 0 }, + { Name = "CAAPlayerResourceFormatDefault", Type = "number", Value = 1 }, + { Name = "CAAMinCastTimeMin", Type = "number", Value = 0 }, + { Name = "CAAMinCastTimeMax", Type = "number", Value = 5 }, + { Name = "CAAMinCastTimeDefault", Type = "number", Value = 1.5 }, + { Name = "CAAMinCastTimeStep", Type = "number", Value = 0.5 }, + { Name = "CAAThrottleMin", Type = "number", Value = 0 }, + { Name = "CAAThrottleMax", Type = "number", Value = 5 }, + { Name = "CAAThrottleDefault", Type = "number", Value = 0 }, + { Name = "CAAThrottleStep", Type = "number", Value = 0.5 }, + { Name = "CAAFrequencyMin", Type = "number", Value = -10 }, + { Name = "CAAFrequencyMax", Type = "number", Value = 10 }, + { Name = "CAAFrequencyDefault", Type = "number", Value = 0 }, + { Name = "CAASampleTextThrottleTime", Type = "number", Value = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CombatAudioAlertConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua.annotated.lua new file mode 100644 index 0000000..aa1e2bb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertDocumentation.lua.annotated.lua @@ -0,0 +1,223 @@ +local CombatAudioAlert = +{ + Name = "CombatAudioAlert", + Type = "System", + Namespace = "C_CombatAudioAlert", + Environment = "All", + + Functions = + { + { + Name = "GetCategoryVoice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "CombatAudioAlertCategory", Nilable = false }, + }, + + Returns = + { + { Name = "voice", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCategoryVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "CombatAudioAlertCategory", Nilable = false }, + }, + + Returns = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFormatSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "CombatAudioAlertUnit", Nilable = false }, + { Name = "alertType", Type = "CombatAudioAlertType", Nilable = false }, + }, + + Returns = + { + { Name = "formatVal", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpeakerSpeed", + Type = "Function", + + Returns = + { + { Name = "speed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpecSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setting", Type = "CombatAudioAlertSpecSetting", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetThrottle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "throttleType", Type = "CombatAudioAlertThrottle", Nilable = false }, + }, + + Returns = + { + { Name = "throttle", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCategoryVoice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "CombatAudioAlertCategory", Nilable = false }, + { Name = "newVal", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCategoryVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "CombatAudioAlertCategory", Nilable = false }, + { Name = "newVal", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFormatSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "CombatAudioAlertUnit", Nilable = false }, + { Name = "alertType", Type = "CombatAudioAlertType", Nilable = false }, + { Name = "newVal", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSpeakerSpeed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "newVal", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSpecSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setting", Type = "CombatAudioAlertSpecSetting", Nilable = false }, + { Name = "newVal", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetThrottle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "throttleType", Type = "CombatAudioAlertThrottle", Nilable = false }, + { Name = "newVal", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpeakText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "category", Type = "CombatAudioAlertCategory", Nilable = false }, + { Name = "allowOverlap", Type = "bool", Nilable = false, Default = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CombatAudioAlert); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..127e5ff --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatAudioAlertSharedDocumentation.lua.annotated.lua @@ -0,0 +1,270 @@ +local CombatAudioAlertShared = +{ + Tables = + { + { + Name = "CombatAudioAlertCastState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Off", Type = "CombatAudioAlertCastState", EnumValue = 0 }, + { Name = "OnCastStart", Type = "CombatAudioAlertCastState", EnumValue = 1 }, + { Name = "OnCastEnd", Type = "CombatAudioAlertCastState", EnumValue = 2 }, + }, + }, + { + Name = "CombatAudioAlertCategory", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "General", Type = "CombatAudioAlertCategory", EnumValue = 0 }, + { Name = "PlayerHealth", Type = "CombatAudioAlertCategory", EnumValue = 1 }, + { Name = "TargetHealth", Type = "CombatAudioAlertCategory", EnumValue = 2 }, + { Name = "PlayerCast", Type = "CombatAudioAlertCategory", EnumValue = 3 }, + { Name = "TargetCast", Type = "CombatAudioAlertCategory", EnumValue = 4 }, + { Name = "PlayerResource1", Type = "CombatAudioAlertCategory", EnumValue = 5 }, + { Name = "PlayerResource2", Type = "CombatAudioAlertCategory", EnumValue = 6 }, + { Name = "PartyHealth", Type = "CombatAudioAlertCategory", EnumValue = 7 }, + { Name = "PlayerDebuffs", Type = "CombatAudioAlertCategory", EnumValue = 8 }, + }, + }, + { + Name = "CombatAudioAlertDebuffSelfAlertValues", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Off", Type = "CombatAudioAlertDebuffSelfAlertValues", EnumValue = 0 }, + { Name = "DispelType", Type = "CombatAudioAlertDebuffSelfAlertValues", EnumValue = 1 }, + }, + }, + { + Name = "CombatAudioAlertPartyPercentValues", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "Off", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 0 }, + { Name = "Under100Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 1 }, + { Name = "Under90Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 2 }, + { Name = "Under80Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 3 }, + { Name = "Under70Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 4 }, + { Name = "Under60Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 5 }, + { Name = "Under50Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 6 }, + { Name = "Under40Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 7 }, + { Name = "Under30Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 8 }, + { Name = "Under20Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 9 }, + { Name = "Under10Percent", Type = "CombatAudioAlertPartyPercentValues", EnumValue = 10 }, + }, + }, + { + Name = "CombatAudioAlertPercentValues", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Off", Type = "CombatAudioAlertPercentValues", EnumValue = 0 }, + { Name = "Every10Percent", Type = "CombatAudioAlertPercentValues", EnumValue = 1 }, + { Name = "Every20Percent", Type = "CombatAudioAlertPercentValues", EnumValue = 2 }, + { Name = "Every30Percent", Type = "CombatAudioAlertPercentValues", EnumValue = 3 }, + { Name = "Every40Percent", Type = "CombatAudioAlertPercentValues", EnumValue = 4 }, + { Name = "Every50Percent", Type = "CombatAudioAlertPercentValues", EnumValue = 5 }, + }, + }, + { + Name = "CombatAudioAlertPlayerCastFormatValues", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "CastingSpellname", Type = "CombatAudioAlertPlayerCastFormatValues", EnumValue = 0 }, + { Name = "CastSpellname", Type = "CombatAudioAlertPlayerCastFormatValues", EnumValue = 1 }, + { Name = "Casting", Type = "CombatAudioAlertPlayerCastFormatValues", EnumValue = 2 }, + { Name = "Cast", Type = "CombatAudioAlertPlayerCastFormatValues", EnumValue = 3 }, + { Name = "Spellname", Type = "CombatAudioAlertPlayerCastFormatValues", EnumValue = 4 }, + }, + }, + { + Name = "CombatAudioAlertPlayerDebuffFormatValues", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Full", Type = "CombatAudioAlertPlayerDebuffFormatValues", EnumValue = 0 }, + { Name = "NoSpellname", Type = "CombatAudioAlertPlayerDebuffFormatValues", EnumValue = 1 }, + }, + }, + { + Name = "CombatAudioAlertPlayerHealthFormatValues", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "HealthFull", Type = "CombatAudioAlertPlayerHealthFormatValues", EnumValue = 0 }, + { Name = "HealthNoPercent", Type = "CombatAudioAlertPlayerHealthFormatValues", EnumValue = 1 }, + { Name = "HealthNoPercentDiv10", Type = "CombatAudioAlertPlayerHealthFormatValues", EnumValue = 2 }, + { Name = "NoHealthFull", Type = "CombatAudioAlertPlayerHealthFormatValues", EnumValue = 3 }, + { Name = "NoHealthNoPercent", Type = "CombatAudioAlertPlayerHealthFormatValues", EnumValue = 4 }, + { Name = "NoHealthNoPercentDiv10", Type = "CombatAudioAlertPlayerHealthFormatValues", EnumValue = 5 }, + }, + }, + { + Name = "CombatAudioAlertPlayerResourceFormatValues", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "ResourceFull", Type = "CombatAudioAlertPlayerResourceFormatValues", EnumValue = 0 }, + { Name = "ResourceNoPercent", Type = "CombatAudioAlertPlayerResourceFormatValues", EnumValue = 1 }, + { Name = "ResourceNoPercentDiv10", Type = "CombatAudioAlertPlayerResourceFormatValues", EnumValue = 2 }, + { Name = "NoResourceFull", Type = "CombatAudioAlertPlayerResourceFormatValues", EnumValue = 3 }, + { Name = "NoResourceNoPercent", Type = "CombatAudioAlertPlayerResourceFormatValues", EnumValue = 4 }, + { Name = "NoResourceNoPercentDiv10", Type = "CombatAudioAlertPlayerResourceFormatValues", EnumValue = 5 }, + }, + }, + { + Name = "CombatAudioAlertSayIfTargetedType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "CombatAudioAlertSayIfTargetedType", EnumValue = 0 }, + { Name = "Aggro", Type = "CombatAudioAlertSayIfTargetedType", EnumValue = 1 }, + { Name = "Targeted", Type = "CombatAudioAlertSayIfTargetedType", EnumValue = 2 }, + { Name = "TargetedBy", Type = "CombatAudioAlertSayIfTargetedType", EnumValue = 3 }, + }, + }, + { + Name = "CombatAudioAlertSpecSetting", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Resource1Percent", Type = "CombatAudioAlertSpecSetting", EnumValue = 0 }, + { Name = "Resource1Format", Type = "CombatAudioAlertSpecSetting", EnumValue = 1 }, + { Name = "Resource1Voice", Type = "CombatAudioAlertSpecSetting", EnumValue = 2 }, + { Name = "Resource1Volume", Type = "CombatAudioAlertSpecSetting", EnumValue = 3 }, + { Name = "Resource2Percent", Type = "CombatAudioAlertSpecSetting", EnumValue = 4 }, + { Name = "Resource2Format", Type = "CombatAudioAlertSpecSetting", EnumValue = 5 }, + { Name = "Resource2Voice", Type = "CombatAudioAlertSpecSetting", EnumValue = 6 }, + { Name = "Resource2Volume", Type = "CombatAudioAlertSpecSetting", EnumValue = 7 }, + { Name = "SayIfTargeted", Type = "CombatAudioAlertSpecSetting", EnumValue = 8 }, + }, + }, + { + Name = "CombatAudioAlertTargetCastFormatValues", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "TargetCastingSpellname", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 0 }, + { Name = "TargetCastSpellname", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 1 }, + { Name = "CastingSpellname", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 2 }, + { Name = "CastSpellname", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 3 }, + { Name = "Casting", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 4 }, + { Name = "Cast", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 5 }, + { Name = "Spellname", Type = "CombatAudioAlertTargetCastFormatValues", EnumValue = 6 }, + }, + }, + { + Name = "CombatAudioAlertTargetDeathBehavior", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Default", Type = "CombatAudioAlertTargetDeathBehavior", EnumValue = 0 }, + { Name = "SayTargetDead", Type = "CombatAudioAlertTargetDeathBehavior", EnumValue = 1 }, + }, + }, + { + Name = "CombatAudioAlertTargetHealthFormatValues", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "NoHealthFull", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 0 }, + { Name = "NoHealthNoPercent", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 1 }, + { Name = "NoHealthNoPercentDiv10", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 2 }, + { Name = "HealthFull", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 3 }, + { Name = "HealthNoPercent", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 4 }, + { Name = "HealthNoPercentDiv10", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 5 }, + { Name = "TargetFull", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 6 }, + { Name = "TargetNoPercent", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 7 }, + { Name = "TargetNoPercentDiv10", Type = "CombatAudioAlertTargetHealthFormatValues", EnumValue = 8 }, + }, + }, + { + Name = "CombatAudioAlertThrottle", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Sample", Type = "CombatAudioAlertThrottle", EnumValue = 0 }, + { Name = "PlayerHealth", Type = "CombatAudioAlertThrottle", EnumValue = 1 }, + { Name = "TargetHealth", Type = "CombatAudioAlertThrottle", EnumValue = 2 }, + { Name = "PlayerCast", Type = "CombatAudioAlertThrottle", EnumValue = 3 }, + { Name = "TargetCast", Type = "CombatAudioAlertThrottle", EnumValue = 4 }, + { Name = "PlayerResource1", Type = "CombatAudioAlertThrottle", EnumValue = 5 }, + { Name = "PlayerResource2", Type = "CombatAudioAlertThrottle", EnumValue = 6 }, + }, + }, + { + Name = "CombatAudioAlertType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Health", Type = "CombatAudioAlertType", EnumValue = 0 }, + { Name = "Cast", Type = "CombatAudioAlertType", EnumValue = 1 }, + }, + }, + { + Name = "CombatAudioAlertUnit", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Player", Type = "CombatAudioAlertUnit", EnumValue = 0 }, + { Name = "Target", Type = "CombatAudioAlertUnit", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CombatAudioAlertShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c5c3b5c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,87 @@ +local CombatLogConstants = +{ + Tables = + { + { + Name = "CombatLogObject", + Type = "Enumeration", + NumValues = 20, + MinValue = 0, + MaxValue = 2147483648, + Fields = + { + { Name = "Empty", Type = "CombatLogObject", EnumValue = 0 }, + { Name = "AffiliationMine", Type = "CombatLogObject", EnumValue = 1 }, + { Name = "AffiliationParty", Type = "CombatLogObject", EnumValue = 2 }, + { Name = "AffiliationRaid", Type = "CombatLogObject", EnumValue = 4 }, + { Name = "AffiliationOutsider", Type = "CombatLogObject", EnumValue = 8 }, + { Name = "ReactionFriendly", Type = "CombatLogObject", EnumValue = 16 }, + { Name = "ReactionNeutral", Type = "CombatLogObject", EnumValue = 32 }, + { Name = "ReactionHostile", Type = "CombatLogObject", EnumValue = 64 }, + { Name = "ControlPlayer", Type = "CombatLogObject", EnumValue = 256 }, + { Name = "ControlNpc", Type = "CombatLogObject", EnumValue = 512 }, + { Name = "TypePlayer", Type = "CombatLogObject", EnumValue = 1024 }, + { Name = "TypeNpc", Type = "CombatLogObject", EnumValue = 2048 }, + { Name = "TypePet", Type = "CombatLogObject", EnumValue = 4096 }, + { Name = "TypeGuardian", Type = "CombatLogObject", EnumValue = 8192 }, + { Name = "TypeObject", Type = "CombatLogObject", EnumValue = 16384 }, + { Name = "Target", Type = "CombatLogObject", EnumValue = 65536 }, + { Name = "Focus", Type = "CombatLogObject", EnumValue = 131072 }, + { Name = "Maintank", Type = "CombatLogObject", EnumValue = 262144 }, + { Name = "Mainassist", Type = "CombatLogObject", EnumValue = 524288 }, + { Name = "None", Type = "CombatLogObject", EnumValue = 2147483648 }, + }, + }, + { + Name = "CombatLogObjectTarget", + Type = "Enumeration", + NumValues = 9, + MinValue = 1, + MaxValue = 2147483648, + Fields = + { + { Name = "Raidtarget1", Type = "CombatLogObjectTarget", EnumValue = 1 }, + { Name = "Raidtarget2", Type = "CombatLogObjectTarget", EnumValue = 2 }, + { Name = "Raidtarget3", Type = "CombatLogObjectTarget", EnumValue = 4 }, + { Name = "Raidtarget4", Type = "CombatLogObjectTarget", EnumValue = 8 }, + { Name = "Raidtarget5", Type = "CombatLogObjectTarget", EnumValue = 16 }, + { Name = "Raidtarget6", Type = "CombatLogObjectTarget", EnumValue = 32 }, + { Name = "Raidtarget7", Type = "CombatLogObjectTarget", EnumValue = 64 }, + { Name = "Raidtarget8", Type = "CombatLogObjectTarget", EnumValue = 128 }, + { Name = "RaidNone", Type = "CombatLogObjectTarget", EnumValue = 2147483648 }, + }, + }, + { + Name = "CombatLogMessageLimits", + Type = "Constants", + Values = + { + { Name = "CombatLogDefaultMessageLimit", Type = "number", Value = 300 }, + { Name = "CombatLogMaximumMessageLimit", Type = "number", Value = 1000 }, + }, + }, + { + Name = "CombatLogObjectMasks", + Type = "Constants", + Values = + { + { Name = "COMBATLOG_OBJECT_AFFILIATION_MASK", Type = "CombatLogObject", Value = 15 }, + { Name = "COMBATLOG_OBJECT_REACTION_MASK", Type = "CombatLogObject", Value = 240 }, + { Name = "COMBATLOG_OBJECT_CONTROL_MASK", Type = "CombatLogObject", Value = 768 }, + { Name = "COMBATLOG_OBJECT_TYPE_MASK", Type = "CombatLogObject", Value = 64512 }, + { Name = "COMBATLOG_OBJECT_SPECIAL_MASK", Type = "CombatLogObject", Value = 4294901760 }, + }, + }, + { + Name = "CombatLogObjectTargetMasks", + Type = "Constants", + Values = + { + { Name = "COMBATLOG_OBJECT_RAID_TARGET_MASK", Type = "CombatLogObjectTarget", Value = 255 }, + { Name = "COMBATLOG_OBJECT_RAID_MASK", Type = "CombatLogObjectTarget", Value = 4294967295 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CombatLogConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a303f76 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogDocumentation.lua.annotated.lua @@ -0,0 +1,154 @@ +local CombatLog = +{ + Name = "CombatLog", + Type = "System", + Namespace = "C_CombatLog", + Environment = "All", + + Functions = + { + { + Name = "ApplyFilterSettings", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterSettings", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "AreFilteredEventsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearEntries", + Type = "Function", + }, + { + Name = "DoesObjectMatchFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mask", Type = "CombatLogObject", Nilable = false }, + { Name = "flags", Type = "CombatLogObject", Nilable = false }, + }, + + Returns = + { + { Name = "matches", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetEntryRetentionTime", + Type = "Function", + + Returns = + { + { Name = "retentionTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMessageLimit", + Type = "Function", + + Returns = + { + { Name = "messageLimit", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsCombatLogRestricted", + Type = "Function", + + Returns = + { + { Name = "restricted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RefilterEntries", + Type = "Function", + }, + { + Name = "SetEntryRetentionTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "retentionTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFilteredEventsEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMessageLimit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "messageLimit", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CombatLogEntriesCleared", + Type = "Event", + LiteralName = "COMBAT_LOG_ENTRIES_CLEARED", + SynchronousEvent = true, + }, + { + Name = "CombatLogEvent", + Type = "Event", + LiteralName = "COMBAT_LOG_EVENT", + HasRestrictions = true, + SynchronousEvent = true, + CallbackEvent = true, + }, + { + Name = "CombatLogEventUnfiltered", + Type = "Event", + LiteralName = "COMBAT_LOG_EVENT_UNFILTERED", + HasRestrictions = true, + SynchronousEvent = true, + CallbackEvent = true, + }, + { + Name = "CombatLogMessageLimitChanged", + Type = "Event", + LiteralName = "COMBAT_LOG_MESSAGE_LIMIT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "messageLimit", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CombatLog); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..70da211 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogInternalDocumentation.lua.annotated.lua @@ -0,0 +1,36 @@ +local CombatLogInternal = +{ + Name = "CombatLogInternal", + Type = "System", + Namespace = "C_CombatLogInternal", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentEventInfo", + Type = "Function", + + Returns = + { + }, + }, + }, + + Events = + { + { + Name = "CombatLogEventInternalUnfiltered", + Type = "Event", + LiteralName = "COMBAT_LOG_EVENT_INTERNAL_UNFILTERED", + SynchronousEvent = true, + CallbackEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CombatLogInternal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua.annotated.lua new file mode 100644 index 0000000..09467b1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSecureDocumentation.lua.annotated.lua @@ -0,0 +1,154 @@ +local CombatLogSecure = +{ + Name = "CombatLogSecure", + Type = "System", + Namespace = "C_CombatLogSecure", + Environment = "SecureOnly", + + Functions = + { + { + Name = "AddEventFilter", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "ClearEventFilters", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "CreateCombatLogMessage", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "order", Type = "CombatLogMessageOrder", Nilable = false }, + }, + }, + { + Name = "GetCurrentEntryInfo", + Type = "Function", + HasRestrictions = true, + + Returns = + { + }, + }, + { + Name = "GetCurrentEventInfo", + Type = "Function", + HasRestrictions = true, + + Returns = + { + }, + }, + { + Name = "GetEntryCount", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreFilter", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "SeekToNewestEntry", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreFilter", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "isValidEntry", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SeekToPreviousEntry", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreFilter", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "isValidEntry", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowCurrentEntry", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "shouldShow", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CombatLogApplyFilterSettings", + Type = "Event", + LiteralName = "COMBAT_LOG_APPLY_FILTER_SETTINGS", + HasRestrictions = true, + CallbackEvent = true, + Payload = + { + { Name = "filterSettings", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "CombatLogMessage", + Type = "Event", + LiteralName = "COMBAT_LOG_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "message", Type = "string", Nilable = false, Documentation = { "A preformatted combat log message protected by a |K string wrapper." } }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "order", Type = "CombatLogMessageOrder", Nilable = false }, + }, + }, + { + Name = "CombatLogRefilterEntries", + Type = "Event", + LiteralName = "COMBAT_LOG_REFILTER_ENTRIES", + HasRestrictions = true, + CallbackEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CombatLogSecure); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8cb004b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatLogSharedDocumentation.lua.annotated.lua @@ -0,0 +1,27 @@ +local CombatLogShared = +{ + Tables = + { + { + Name = "CombatLogMessageOrder", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Newest", Type = "CombatLogMessageOrder", EnumValue = 0 }, + { Name = "Oldest", Type = "CombatLogMessageOrder", EnumValue = 1 }, + }, + }, + { + Name = "CombatLogEventInfo", + Type = "Structure", + Fields = + { + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CombatLogShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c4eb270 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextDocumentation.lua.annotated.lua @@ -0,0 +1,59 @@ +local CombatText = +{ + Name = "CombatText", + Type = "System", + Namespace = "C_CombatText", + Environment = "All", + + Functions = + { + { + Name = "GetActiveUnit", + Type = "Function", + + Returns = + { + { Name = "unitTarget", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetCurrentEventInfo", + Type = "Function", + SecretReturns = true, + + Returns = + { + }, + }, + { + Name = "SetActiveUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CombatTextUpdate", + Type = "Event", + LiteralName = "COMBAT_TEXT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "combatTextType", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CombatText); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1dcb8d2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CombatTextSharedDocumentation.lua.annotated.lua @@ -0,0 +1,15 @@ +local CombatTextShared = +{ + Tables = + { + { + Name = "CombatTextEventInfo", + Type = "Structure", + Fields = + { + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CombatTextShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d2657cd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorFrameDocumentation.lua.annotated.lua @@ -0,0 +1,1849 @@ +local CommentatorFrame = +{ + Name = "CommentatorFrame", + Type = "System", + Namespace = "C_Commentator", + Environment = "All", + + Functions = + { + { + Name = "AddPlayerOverrideName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "overrideName", Type = "string", Nilable = false }, + }, + }, + { + Name = "AddTrackedDefensiveAuras", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "AddTrackedOffensiveAuras", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "AreTeamsSwapped", + Type = "Function", + + Returns = + { + { Name = "teamsAreSwapped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AssignPlayerToTeam", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "teamName", Type = "string", Nilable = false }, + }, + }, + { + Name = "AssignPlayersToTeam", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerName", Type = "table", InnerType = "string", Nilable = false }, + { Name = "teamName", Type = "string", Nilable = false }, + }, + }, + { + Name = "AssignPlayersToTeamInCurrentInstance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "teamName", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanUseCommentatorCheats", + Type = "Function", + + Returns = + { + { Name = "canUseCommentatorCheats", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearCameraTarget", + Type = "Function", + RequiresActiveCommentator = true, + }, + { + Name = "ClearFollowTarget", + Type = "Function", + RequiresActiveCommentator = true, + }, + { + Name = "ClearLookAtTarget", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lookAtIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "EnterInstance", + Type = "Function", + RequiresCommentator = true, + }, + { + Name = "ExitInstance", + Type = "Function", + RequiresCommentator = true, + }, + { + Name = "FindSpectatedUnit", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FindTeamNameInCurrentInstance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "teamName", Type = "string", Nilable = true }, + }, + }, + { + Name = "FindTeamNameInDirectory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerNames", Type = "table", InnerType = "string", Nilable = false }, + }, + + Returns = + { + { Name = "teamName", Type = "string", Nilable = true }, + }, + }, + { + Name = "FlushCommentatorHistory", + Type = "Function", + }, + { + Name = "FollowPlayer", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "forceInstantTransition", Type = "bool", Nilable = true }, + }, + }, + { + Name = "FollowUnit", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "token", Type = "string", Nilable = false }, + }, + }, + { + Name = "ForceFollowTransition", + Type = "Function", + RequiresActiveCommentator = true, + }, + { + Name = "GetAdditionalCameraWeight", + Type = "Function", + RequiresActiveCommentator = true, + + Returns = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetAdditionalCameraWeightByToken", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAllPlayerOverrideNames", + Type = "Function", + RequiresActiveCommentator = true, + + Returns = + { + { Name = "nameEntries", Type = "table", InnerType = "NameOverrideEntry", Nilable = false }, + }, + }, + { + Name = "GetCamera", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + + Returns = + { + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + { Name = "zPos", Type = "number", Nilable = false }, + { Name = "yaw", Type = "number", Nilable = false }, + { Name = "pitch", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + { Name = "fov", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraCollision", + Type = "Function", + + Returns = + { + { Name = "isColliding", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCameraPosition", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + + Returns = + { + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + { Name = "zPos", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCombatEventInfo", + Type = "Function", + RequiresActiveCommentator = true, + + Returns = + { + }, + }, + { + Name = "GetCommentatorHistory", + Type = "Function", + + Returns = + { + { Name = "history", Type = "CommentatorHistory", Nilable = false }, + }, + }, + { + Name = "GetCurrentMapID", + Type = "Function", + RequiresCommentator = true, + + Returns = + { + { Name = "mapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetDampeningPercent", + Type = "Function", + + Returns = + { + { Name = "percentage", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDistanceBeforeForcedHorizontalConvergence", + Type = "Function", + + Returns = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDurationToForceHorizontalConvergence", + Type = "Function", + + Returns = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExcludeDistance", + Type = "Function", + + Returns = + { + { Name = "excludeDistance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHardlockWeight", + Type = "Function", + + Returns = + { + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHorizontalAngleThresholdToSmooth", + Type = "Function", + + Returns = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIndirectSpellID", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackedSpellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "indirectSpellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceInfo", + Type = "Function", + MayReturnNothing = true, + RequiresCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapIndex", Type = "luaIndex", Nilable = false }, + { Name = "instanceIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "mapName", Type = "string", Nilable = true }, + { Name = "status", Type = "number", Nilable = false }, + { Name = "instanceIDLow", Type = "number", Nilable = false }, + { Name = "instanceIDHigh", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLookAtLerpAmount", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapInfo", + Type = "Function", + MayReturnNothing = true, + RequiresCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "teamSize", Type = "number", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "numInstances", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMatchDuration", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetMaxNumPlayersPerTeam", + Type = "Function", + + Returns = + { + { Name = "maxNumPlayersPerTeam", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxNumTeams", + Type = "Function", + + Returns = + { + { Name = "maxNumTeams", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMode", + Type = "Function", + + Returns = + { + { Name = "commentatorMode", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMsToHoldForHorizontalMovement", + Type = "Function", + + Returns = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMsToHoldForVerticalMovement", + Type = "Function", + + Returns = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMsToSmoothHorizontalChange", + Type = "Function", + + Returns = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMsToSmoothVerticalChange", + Type = "Function", + + Returns = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMaps", + Type = "Function", + + Returns = + { + { Name = "numMaps", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumPlayers", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numPlayers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOrCreateSeries", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamName1", Type = "string", Nilable = false }, + { Name = "teamName2", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "CommentatorSeries", Nilable = false }, + }, + }, + { + Name = "GetPlayerAuraInfo", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerAuraInfoByUnit", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "token", Type = "UnitToken", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerCooldownInfo", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerCooldownInfoByUnit", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerCrowdControlInfo", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "expiration", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerCrowdControlInfoByUnit", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "token", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "expiration", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerData", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CommentatorPlayerData", Nilable = true }, + }, + }, + { + Name = "GetPlayerFlagInfo", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "hasFlag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerFlagInfoByUnit", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "hasFlag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerItemCooldownInfo", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerItemCooldownInfoByUnit", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerOverrideName", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "originalName", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "overrideName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPlayerSpellCharges", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "charges", Type = "number", Nilable = false }, + { Name = "maxCharges", Type = "number", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerSpellChargesByUnit", + Type = "Function", + MayReturnNothing = true, + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "charges", Type = "number", Nilable = false }, + { Name = "maxCharges", Type = "number", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPositionLerpAmount", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSmoothFollowTransitioning", + Type = "Function", + RequiresActiveCommentator = true, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSoftlockWeight", + Type = "Function", + + Returns = + { + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpeedFactor", + Type = "Function", + + Returns = + { + { Name = "factor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStartLocation", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pos", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + }, + }, + { + Name = "GetTeamColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetTeamColorByUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetTimeLeftInMatch", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetTrackedSpellID", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "indirectSpellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "trackedSpellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrackedSpells", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "category", Type = "TrackedSpellCategory", Nilable = false }, + }, + + Returns = + { + { Name = "spells", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetTrackedSpellsByUnit", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "category", Type = "TrackedSpellCategory", Nilable = false }, + }, + + Returns = + { + { Name = "spells", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetUnitData", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "CommentatorUnitData", Nilable = false }, + }, + }, + { + Name = "GetWargameInfo", + Type = "Function", + MayReturnNothing = true, + RequiresCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "listID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "minPlayers", Type = "number", Nilable = false }, + { Name = "maxPlayers", Type = "number", Nilable = false }, + { Name = "isArena", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasTrackedAuras", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "token", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "hasOffensiveAura", Type = "bool", Nilable = false }, + { Name = "hasDefensiveAura", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSmartCameraLocked", + Type = "Function", + + Returns = + { + { Name = "isSmartCameraLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpectating", + Type = "Function", + + Returns = + { + { Name = "isSpectating", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackedDefensiveAura", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isDefensiveTrigger", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackedOffensiveAura", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isOffensiveTrigger", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackedSpell", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "category", Type = "TrackedSpellCategory", Nilable = false }, + }, + + Returns = + { + { Name = "isTracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackedSpellByUnit", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "category", Type = "TrackedSpellCategory", Nilable = false }, + }, + + Returns = + { + { Name = "isTracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingSmartCamera", + Type = "Function", + + Returns = + { + { Name = "isUsingSmartCamera", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LookAtPlayer", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "lookAtIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "RemoveAllOverrideNames", + Type = "Function", + }, + { + Name = "RemovePlayerOverrideName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "originalPlayerName", Type = "string", Nilable = false }, + }, + }, + { + Name = "RequestPlayerCooldownInfo", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ResetFoVTarget", + Type = "Function", + }, + { + Name = "ResetSeriesScores", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamName1", Type = "string", Nilable = false }, + { Name = "teamName2", Type = "string", Nilable = false }, + }, + }, + { + Name = "ResetSettings", + Type = "Function", + }, + { + Name = "ResetTrackedAuras", + Type = "Function", + RequiresActiveCommentator = true, + }, + { + Name = "SetAdditionalCameraWeight", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamIndex", Type = "luaIndex", Nilable = false }, + { Name = "playerIndex", Type = "luaIndex", Nilable = false }, + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetAdditionalCameraWeightByToken", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetBlocklistedAuras", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetBlocklistedCooldowns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetBlocklistedItemCooldowns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetCamera", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + { Name = "zPos", Type = "number", Nilable = false }, + { Name = "yaw", Type = "number", Nilable = false }, + { Name = "pitch", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + { Name = "fov", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraCollision", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "collide", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCameraPosition", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + { Name = "zPos", Type = "number", Nilable = false }, + { Name = "snapToLocation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCheatsEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enableCheats", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCommentatorHistory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "history", Type = "CommentatorHistory", Nilable = false }, + }, + }, + { + Name = "SetDistanceBeforeForcedHorizontalConvergence", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetDurationToForceHorizontalConvergence", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetExcludeDistance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "excludeDistance", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFollowCameraSpeeds", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "elasticSpeed", Type = "number", Nilable = false }, + { Name = "minSpeed", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetHardlockWeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetHorizontalAngleThresholdToSmooth", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLookAtLerpAmount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMapAndInstanceIndex", + Type = "Function", + RequiresCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapIndex", Type = "luaIndex", Nilable = false }, + { Name = "instanceIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetMouseDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMoveSpeed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "newSpeed", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMsToHoldForHorizontalMovement", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMsToHoldForVerticalMovement", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMsToSmoothHorizontalChange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMsToSmoothVerticalChange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ms", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPositionLerpAmount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetRequestedDebuffCooldowns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetRequestedDefensiveCooldowns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetRequestedItemCooldowns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetRequestedOffensiveCooldowns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetSeriesScore", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamName1", Type = "string", Nilable = false }, + { Name = "teamName2", Type = "string", Nilable = false }, + { Name = "scoringTeamName", Type = "string", Nilable = false }, + { Name = "score", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSeriesScores", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamName1", Type = "string", Nilable = false }, + { Name = "teamName2", Type = "string", Nilable = false }, + { Name = "score1", Type = "number", Nilable = false }, + { Name = "score2", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSmartCameraLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSmoothFollowTransitioning", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSoftlockWeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "weight", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpeedFactor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factor", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTargetHeightOffset", + Type = "Function", + RequiresActiveCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offset", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetUseSmartCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "useSmartCamera", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SnapCameraLookAtPoint", + Type = "Function", + RequiresActiveCommentator = true, + }, + { + Name = "SpellUsesItemCharges", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellUsesItemCharges", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartWargame", + Type = "Function", + RequiresCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "listID", Type = "number", Nilable = false }, + { Name = "teamSize", Type = "number", Nilable = false }, + { Name = "tournamentRules", Type = "bool", Nilable = false }, + { Name = "teamOneCaptain", Type = "string", Nilable = false }, + { Name = "teamTwoCaptain", Type = "string", Nilable = false }, + }, + }, + { + Name = "SwapTeamSides", + Type = "Function", + }, + { + Name = "ToggleCheats", + Type = "Function", + }, + { + Name = "UpdateMapInfo", + Type = "Function", + RequiresCommentator = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetPlayer", Type = "string", Nilable = true }, + }, + }, + { + Name = "UpdatePlayerInfo", + Type = "Function", + RequiresCommentator = true, + }, + { + Name = "ZoomIn", + Type = "Function", + }, + { + Name = "ZoomIn_Position", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomAmount", Type = "number", Nilable = true }, + }, + }, + { + Name = "ZoomOut", + Type = "Function", + }, + { + Name = "ZoomOut_Position", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomAmount", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "CommentatorCombatEvent", + Type = "Event", + LiteralName = "COMMENTATOR_COMBAT_EVENT", + SynchronousEvent = true, + }, + { + Name = "CommentatorEnterWorld", + Type = "Event", + LiteralName = "COMMENTATOR_ENTER_WORLD", + SynchronousEvent = true, + }, + { + Name = "CommentatorHistoryFlushed", + Type = "Event", + LiteralName = "COMMENTATOR_HISTORY_FLUSHED", + SynchronousEvent = true, + }, + { + Name = "CommentatorImmediateFovUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_IMMEDIATE_FOV_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "fov", Type = "number", Nilable = false }, + }, + }, + { + Name = "CommentatorMapUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_MAP_UPDATE", + SynchronousEvent = true, + }, + { + Name = "CommentatorPlayerNameOverrideUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "nameToOverride", Type = "cstring", Nilable = false }, + { Name = "overrideName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "CommentatorPlayerUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_PLAYER_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "CommentatorResetSettings", + Type = "Event", + LiteralName = "COMMENTATOR_RESET_SETTINGS", + SynchronousEvent = true, + }, + { + Name = "CommentatorTeamNameUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_TEAM_NAME_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "teamName", Type = "string", Nilable = false }, + }, + }, + { + Name = "CommentatorTeamsSwapped", + Type = "Event", + LiteralName = "COMMENTATOR_TEAMS_SWAPPED", + SynchronousEvent = true, + Payload = + { + { Name = "swapped", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CommentatorHistory", + Type = "Structure", + Fields = + { + { Name = "series", Type = "table", InnerType = "CommentatorSeries", Nilable = false }, + { Name = "teamDirectory", Type = "table", InnerType = "CommentatorTeamDirectoryEntry", Nilable = false }, + { Name = "overrideNameDirectory", Type = "table", InnerType = "CommentatorOverrideNameEntry", Nilable = false }, + }, + }, + { + Name = "CommentatorOverrideNameEntry", + Type = "Structure", + Fields = + { + { Name = "originalName", Type = "string", Nilable = false }, + { Name = "newName", Type = "string", Nilable = false }, + }, + }, + { + Name = "CommentatorPlayerData", + Type = "Structure", + Fields = + { + { Name = "unitToken", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "faction", Type = "number", Nilable = false }, + { Name = "specialization", Type = "number", Nilable = false }, + { Name = "damageDone", Type = "number", Nilable = false }, + { Name = "damageTaken", Type = "number", Nilable = false }, + { Name = "healingDone", Type = "number", Nilable = false }, + { Name = "healingTaken", Type = "number", Nilable = false }, + { Name = "kills", Type = "number", Nilable = false }, + { Name = "deaths", Type = "number", Nilable = false }, + { Name = "soloShuffleRoundWins", Type = "number", Nilable = false }, + { Name = "soloShuffleRoundLosses", Type = "number", Nilable = false }, + }, + }, + { + Name = "CommentatorSeries", + Type = "Structure", + Fields = + { + { Name = "teams", Type = "table", InnerType = "CommentatorSeriesTeam", Nilable = false }, + }, + }, + { + Name = "CommentatorSeriesTeam", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "score", Type = "number", Nilable = false }, + }, + }, + { + Name = "CommentatorTeamDirectoryEntry", + Type = "Structure", + Fields = + { + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "teamName", Type = "string", Nilable = false }, + }, + }, + { + Name = "CommentatorTrackedItemCooldown", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "category", Type = "TrackedSpellCategory", Nilable = false }, + }, + }, + { + Name = "CommentatorUnitData", + Type = "Structure", + Fields = + { + { Name = "healthMax", Type = "number", Nilable = false }, + { Name = "health", Type = "number", Nilable = false }, + { Name = "absorbTotal", Type = "number", Nilable = false }, + { Name = "isDeadOrGhost", Type = "bool", Nilable = false }, + { Name = "isFeignDeath", Type = "bool", Nilable = false }, + { Name = "powerTypeToken", Type = "string", Nilable = false }, + { Name = "power", Type = "number", Nilable = false }, + { Name = "powerMax", Type = "number", Nilable = false }, + }, + }, + { + Name = "NameOverrideEntry", + Type = "Structure", + Fields = + { + { Name = "originalName", Type = "string", Nilable = false }, + { Name = "overrideName", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CommentatorFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..409f5e3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CommentatorSharedDocumentation.lua.annotated.lua @@ -0,0 +1,23 @@ +local CommentatorShared = +{ + Tables = + { + { + Name = "TrackedSpellCategory", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "TrackedSpellCategory", EnumValue = 0 }, + { Name = "Offensive", Type = "TrackedSpellCategory", EnumValue = 1 }, + { Name = "Defensive", Type = "TrackedSpellCategory", EnumValue = 2 }, + { Name = "Debuff", Type = "TrackedSpellCategory", EnumValue = 3 }, + { Name = "RacialAbility", Type = "TrackedSpellCategory", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CommentatorShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CompactUnitFramesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CompactUnitFramesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4cb41b9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CompactUnitFramesDocumentation.lua.annotated.lua @@ -0,0 +1,27 @@ +local CompactUnitFrames = +{ + Name = "CompactUnitFrames", + Type = "System", + Namespace = "C_CompactUnitFrames", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "CompactUnitFrameProfilesLoaded", + Type = "Event", + LiteralName = "COMPACT_UNIT_FRAME_PROFILES_LOADED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CompactUnitFrames); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..91ec949 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,26 @@ +local ConfigurationWarningConstants = +{ + Tables = + { + { + Name = "ConfigurationWarning", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "ShaderModelWillBeOutdated", Type = "ConfigurationWarning", EnumValue = 0 }, + { Name = "ShaderModelIsOutdated", Type = "ConfigurationWarning", EnumValue = 1 }, + { Name = "ConsoleDeviceSseOutdated", Type = "ConfigurationWarning", EnumValue = 2 }, + { Name = "DriverBlocklisted", Type = "ConfigurationWarning", EnumValue = 3 }, + { Name = "DriverOutOfDate", Type = "ConfigurationWarning", EnumValue = 4 }, + { Name = "DeviceBlocklisted", Type = "ConfigurationWarning", EnumValue = 5 }, + { Name = "GraphicsApiWillBeOutdated", Type = "ConfigurationWarning", EnumValue = 6 }, + { Name = "OsBitsWillBeOutdated", Type = "ConfigurationWarning", EnumValue = 7 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ConfigurationWarningConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..91cb781 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConfigurationWarningsDocumentation.lua.annotated.lua @@ -0,0 +1,77 @@ +local ConfigurationWarnings = +{ + Name = "ConfigurationWarnings", + Type = "System", + Namespace = "C_ConfigurationWarnings", + Environment = "All", + + Functions = + { + { + Name = "GetConfigurationWarningSeen", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configurationWarning", Type = "ConfigurationWarning", Nilable = false }, + }, + + Returns = + { + { Name = "hasSeenConfigurationWarning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetConfigurationWarningString", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configurationWarning", Type = "ConfigurationWarning", Nilable = false }, + }, + + Returns = + { + { Name = "configurationWarningString", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetConfigurationWarnings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "includeSeenWarnings", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "configurationWarnings", Type = "table", InnerType = "ConfigurationWarning", Nilable = false }, + }, + }, + { + Name = "SetConfigurationWarningSeen", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configurationWarning", Type = "ConfigurationWarning", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ConfigurationWarnings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua.annotated.lua new file mode 100644 index 0000000..28faa29 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConnectionDocumentation.lua.annotated.lua @@ -0,0 +1,105 @@ +local Connection = +{ + Name = "ConnectionScript", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CancelLogout", + Type = "Function", + }, + { + Name = "ForceLogout", + Type = "Function", + }, + { + Name = "ForceQuit", + Type = "Function", + }, + { + Name = "GetNativeRealmID", + Type = "Function", + + Returns = + { + { Name = "nativeRealmID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNetIpTypes", + Type = "Function", + + Returns = + { + { Name = "ipTypes", Type = "ConnectionIptype", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetNetStats", + Type = "Function", + + Returns = + { + { Name = "in", Type = "number", Nilable = false }, + { Name = "out", Type = "number", Nilable = false }, + { Name = "latencyList", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetRealmID", + Type = "Function", + + Returns = + { + { Name = "realmID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRealmName", + Type = "Function", + + Returns = + { + { Name = "realmName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsOnTournamentRealm", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Logout", + Type = "Function", + }, + { + Name = "Quit", + Type = "Function", + }, + { + Name = "SelectedRealmName", + Type = "Function", + + Returns = + { + { Name = "selectedRealmName", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Connection); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua.annotated.lua new file mode 100644 index 0000000..70f4926 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleDocumentation.lua.annotated.lua @@ -0,0 +1,271 @@ +local Console = +{ + Name = "Console", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CalculateStringEditDistance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "firstString", Type = "stringView", Nilable = false }, + { Name = "secondString", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConsoleEcho", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "command", Type = "cstring", Nilable = false }, + { Name = "addToHistory", Type = "bool", Nilable = false, Default = false }, + { Name = "prefix", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConsoleExec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "command", Type = "cstring", Nilable = false }, + { Name = "addToHistory", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConsoleGetAllCommands", + Type = "Function", + + Returns = + { + { Name = "commands", Type = "table", InnerType = "ConsoleCommandInfo", Nilable = false }, + }, + }, + { + Name = "ConsoleGetColorFromType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorType", Type = "ConsoleColorType", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "ConsoleGetFontHeight", + Type = "Function", + + Returns = + { + { Name = "fontHeightInPixels", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConsoleIsActive", + Type = "Function", + + Returns = + { + { Name = "consoleIsActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConsolePrintAllMatchingCommands", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "partialCommandText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ConsoleSetFontHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontHeightInPixels", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetConsoleKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "keystring", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ConsoleClear", + Type = "Event", + LiteralName = "CONSOLE_CLEAR", + UniqueEvent = true, + }, + { + Name = "ConsoleColorsChanged", + Type = "Event", + LiteralName = "CONSOLE_COLORS_CHANGED", + UniqueEvent = true, + }, + { + Name = "ConsoleFontSizeChanged", + Type = "Event", + LiteralName = "CONSOLE_FONT_SIZE_CHANGED", + UniqueEvent = true, + }, + { + Name = "ConsoleLog", + Type = "Event", + LiteralName = "CONSOLE_LOG", + SynchronousEvent = true, + Payload = + { + { Name = "message", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ConsoleMessage", + Type = "Event", + LiteralName = "CONSOLE_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "message", Type = "cstring", Nilable = false }, + { Name = "colorType", Type = "number", Nilable = false }, + }, + }, + { + Name = "CvarUpdate", + Type = "Event", + LiteralName = "CVAR_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "value", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ToggleConsole", + Type = "Event", + LiteralName = "TOGGLE_CONSOLE", + SynchronousEvent = true, + Payload = + { + { Name = "showConsole", Type = "bool", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "ConsoleCategory", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "Debug", Type = "ConsoleCategory", EnumValue = 0 }, + { Name = "Graphics", Type = "ConsoleCategory", EnumValue = 1 }, + { Name = "Console", Type = "ConsoleCategory", EnumValue = 2 }, + { Name = "Combat", Type = "ConsoleCategory", EnumValue = 3 }, + { Name = "Game", Type = "ConsoleCategory", EnumValue = 4 }, + { Name = "Default", Type = "ConsoleCategory", EnumValue = 5 }, + { Name = "Net", Type = "ConsoleCategory", EnumValue = 6 }, + { Name = "Sound", Type = "ConsoleCategory", EnumValue = 7 }, + { Name = "Gm", Type = "ConsoleCategory", EnumValue = 8 }, + { Name = "Reveal", Type = "ConsoleCategory", EnumValue = 9 }, + { Name = "None", Type = "ConsoleCategory", EnumValue = 10 }, + }, + }, + { + Name = "ConsoleColorType", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "DefaultColor", Type = "ConsoleColorType", EnumValue = 0 }, + { Name = "InputColor", Type = "ConsoleColorType", EnumValue = 1 }, + { Name = "EchoColor", Type = "ConsoleColorType", EnumValue = 2 }, + { Name = "ErrorColor", Type = "ConsoleColorType", EnumValue = 3 }, + { Name = "WarningColor", Type = "ConsoleColorType", EnumValue = 4 }, + { Name = "GlobalColor", Type = "ConsoleColorType", EnumValue = 5 }, + { Name = "AdminColor", Type = "ConsoleColorType", EnumValue = 6 }, + { Name = "HighlightColor", Type = "ConsoleColorType", EnumValue = 7 }, + { Name = "BackgroundColor", Type = "ConsoleColorType", EnumValue = 8 }, + { Name = "ClickbufferColor", Type = "ConsoleColorType", EnumValue = 9 }, + { Name = "PrivateColor", Type = "ConsoleColorType", EnumValue = 10 }, + { Name = "DefaultGreen", Type = "ConsoleColorType", EnumValue = 11 }, + }, + }, + { + Name = "ConsoleCommandType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Cvar", Type = "ConsoleCommandType", EnumValue = 0 }, + { Name = "Command", Type = "ConsoleCommandType", EnumValue = 1 }, + { Name = "Macro", Type = "ConsoleCommandType", EnumValue = 2 }, + { Name = "Script", Type = "ConsoleCommandType", EnumValue = 3 }, + }, + }, + { + Name = "ConsoleCommandInfo", + Type = "Structure", + Fields = + { + { Name = "command", Type = "cstring", Nilable = false }, + { Name = "help", Type = "cstring", Nilable = false }, + { Name = "category", Type = "ConsoleCategory", Nilable = false }, + { Name = "commandType", Type = "ConsoleCommandType", Nilable = false }, + { Name = "scriptContents", Type = "cstring", Nilable = false }, + { Name = "scriptParameters", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Console); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cb9a5bb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ConsoleScriptCollectionDocumentation.lua.annotated.lua @@ -0,0 +1,121 @@ +local ConsoleScriptCollection = +{ + Name = "ConsoleScriptCollection", + Type = "System", + Namespace = "C_ConsoleScriptCollection", + Environment = "All", + + Functions = + { + { + Name = "GetCollectionDataByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "collectionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "ConsoleScriptCollectionData", Nilable = true }, + }, + }, + { + Name = "GetCollectionDataByTag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "collectionTag", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "ConsoleScriptCollectionData", Nilable = true }, + }, + }, + { + Name = "GetElements", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "collectionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "elementIDs", Type = "table", InnerType = "ConsoleScriptCollectionElementData", Nilable = false }, + }, + }, + { + Name = "GetScriptData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "consoleScriptID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "ConsoleScriptData", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "ConsoleScriptCollectionData", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ConsoleScriptCollectionElementData", + Type = "Structure", + Fields = + { + { Name = "collectionID", Type = "number", Nilable = true }, + { Name = "consoleScriptID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ConsoleScriptData", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "help", Type = "cstring", Nilable = false }, + { Name = "script", Type = "cstring", Nilable = false }, + { Name = "params", Type = "cstring", Nilable = false }, + { Name = "isLuaScript", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConsoleScriptParameter", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ConsoleScriptCollection); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..96f6ca3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContainerDocumentation.lua.annotated.lua @@ -0,0 +1,820 @@ +local Container = +{ + Name = "Container", + Type = "System", + Namespace = "C_Container", + Environment = "All", + + Functions = + { + { + Name = "ContainerIDToInventoryID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerID", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inventoryID", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ContainerRefundItemPurchase", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetBackpackAutosortDisabled", + Type = "Function", + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBackpackSellJunkDisabled", + Type = "Function", + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBagName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetBagSlotFlag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "flag", Type = "BagSlotFlags", Nilable = false }, + }, + + Returns = + { + { Name = "isSet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBankAutosortDisabled", + Type = "Function", + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetContainerFreeSlots", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "freeSlots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetContainerItemCooldown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemDurability", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "durability", Type = "number", Nilable = false }, + { Name = "maxDurability", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemEquipmentSetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inSet", Type = "bool", Nilable = false }, + { Name = "setList", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetContainerItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "containerID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "containerInfo", Type = "ContainerItemInfo", Nilable = false }, + }, + }, + { + Name = "GetContainerItemLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseCurrency", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "itemIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "currencyInfo", Type = "ItemPurchaseCurrency", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ItemPurchaseInfo", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "itemIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "itemInfo", Type = "ItemPurchaseItem", Nilable = false }, + }, + }, + { + Name = "GetContainerItemQuestInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questInfo", Type = "ItemQuestInfo", Nilable = false }, + }, + }, + { + Name = "GetContainerNumFreeSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numFreeSlots", Type = "number", Nilable = false }, + { Name = "bagFamily", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetContainerNumSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numSlots", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInsertItemsLeftToRight", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemCooldown", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxArenaCurrency", + Type = "Function", + + Returns = + { + { Name = "maxCurrency", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSortBagsRightToLeft", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasContainerItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "hasItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBattlePayItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isBattlePayItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsContainerFiltered", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isFiltered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupContainerItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "PlayerHasHearthstone", + Type = "Function", + + Returns = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetBackpackAutosortDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "disable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBackpackSellJunkDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "disable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBagPortraitTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + }, + }, + { + Name = "SetBagSlotFlag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "flag", Type = "BagSlotFlags", Nilable = false }, + { Name = "isSet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBankAutosortDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "disable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetInsertItemsLeftToRight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetItemSearch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetSortBagsRightToLeft", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowContainerSellCursor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SocketContainerItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SortAccountBankBags", + Type = "Function", + }, + { + Name = "SortBags", + Type = "Function", + }, + { + Name = "SortBank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bankType", Type = "BankType", Nilable = false }, + }, + }, + { + Name = "SortBankBags", + Type = "Function", + }, + { + Name = "SplitContainerItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "UseContainerItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "unitToken", Type = "UnitToken", Nilable = true }, + { Name = "bankType", Type = "BankType", Nilable = true }, + { Name = "reagentBankOpen", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "UseHearthstone", + Type = "Function", + + Returns = + { + { Name = "used", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BagClosed", + Type = "Event", + LiteralName = "BAG_CLOSED", + SynchronousEvent = true, + Payload = + { + { Name = "bagID", Type = "BagIndex", Nilable = false }, + }, + }, + { + Name = "BagContainerUpdate", + Type = "Event", + LiteralName = "BAG_CONTAINER_UPDATE", + SynchronousEvent = true, + }, + { + Name = "BagNewItemsUpdated", + Type = "Event", + LiteralName = "BAG_NEW_ITEMS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "BagOpen", + Type = "Event", + LiteralName = "BAG_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "bagID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BagOverflowWithFullInventory", + Type = "Event", + LiteralName = "BAG_OVERFLOW_WITH_FULL_INVENTORY", + SynchronousEvent = true, + }, + { + Name = "BagSlotFlagsUpdated", + Type = "Event", + LiteralName = "BAG_SLOT_FLAGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "BagUpdate", + Type = "Event", + LiteralName = "BAG_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "bagID", Type = "BagIndex", Nilable = false }, + }, + }, + { + Name = "BagUpdateCooldown", + Type = "Event", + LiteralName = "BAG_UPDATE_COOLDOWN", + UniqueEvent = true, + }, + { + Name = "BagUpdateDelayed", + Type = "Event", + LiteralName = "BAG_UPDATE_DELAYED", + UniqueEvent = true, + }, + { + Name = "EquipBindRefundableConfirm", + Type = "Event", + LiteralName = "EQUIP_BIND_REFUNDABLE_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "EquipBindTradeableConfirm", + Type = "Event", + LiteralName = "EQUIP_BIND_TRADEABLE_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "ExpandBagBarChanged", + Type = "Event", + LiteralName = "EXPAND_BAG_BAR_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "expandBagBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InventorySearchUpdate", + Type = "Event", + LiteralName = "INVENTORY_SEARCH_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ItemLockChanged", + Type = "Event", + LiteralName = "ITEM_LOCK_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "bagOrSlotIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "ItemLocked", + Type = "Event", + LiteralName = "ITEM_LOCKED", + SynchronousEvent = true, + Payload = + { + { Name = "bagOrSlotIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "ItemUnlocked", + Type = "Event", + LiteralName = "ITEM_UNLOCKED", + SynchronousEvent = true, + Payload = + { + { Name = "bagOrSlotIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "UseCombinedBagsChanged", + Type = "Event", + LiteralName = "USE_COMBINED_BAGS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "useCombinedBags", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ContainerItemInfo", + Type = "Structure", + Fields = + { + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "stackCount", Type = "number", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "quality", Type = "ItemQuality", Nilable = true }, + { Name = "isReadable", Type = "bool", Nilable = false }, + { Name = "hasLoot", Type = "bool", Nilable = false }, + { Name = "hyperlink", Type = "string", Nilable = false }, + { Name = "isFiltered", Type = "bool", Nilable = false }, + { Name = "hasNoValue", Type = "bool", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "isBound", Type = "bool", Nilable = false }, + { Name = "itemName", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemPurchaseCurrency", + Type = "Structure", + Fields = + { + { Name = "iconFileID", Type = "number", Nilable = true }, + { Name = "currencyCount", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ItemPurchaseInfo", + Type = "Structure", + Fields = + { + { Name = "money", Type = "WOWMONEY", Nilable = false }, + { Name = "itemCount", Type = "number", Nilable = false }, + { Name = "refundSeconds", Type = "time_t", Nilable = false }, + { Name = "currencyCount", Type = "number", Nilable = false }, + { Name = "hasEnchants", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemPurchaseItem", + Type = "Structure", + Fields = + { + { Name = "iconFileID", Type = "number", Nilable = true }, + { Name = "itemCount", Type = "number", Nilable = false }, + { Name = "hyperlink", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemQuestInfo", + Type = "Structure", + Fields = + { + { Name = "isQuestItem", Type = "bool", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Container); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ece103b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingDocumentation.lua.annotated.lua @@ -0,0 +1,354 @@ +local ContentTracking = +{ + Name = "ContentTracking", + Type = "System", + Namespace = "C_ContentTracking", + Environment = "All", + + Functions = + { + { + Name = "GetBestMapForTrackable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + { Name = "ignoreWaypoint", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "ContentTrackingResult", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCollectableSourceTrackingEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCollectableSourceTypes", + Type = "Function", + + Returns = + { + { Name = "collectableSourceTypes", Type = "table", InnerType = "ContentTrackingType", Nilable = false }, + }, + }, + { + Name = "GetCurrentTrackingTarget", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false }, + { Name = "targetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEncounterTrackingInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "journalEncounterID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "trackingInfo", Type = "EncounterTrackingInfo", Nilable = false }, + }, + }, + { + Name = "GetNextWaypointForTrackable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "ContentTrackingResult", Nilable = false }, + { Name = "mapInfo", Type = "ContentTrackingMapInfo", Nilable = true }, + }, + }, + { + Name = "GetObjectiveText", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false }, + { Name = "targetID", Type = "number", Nilable = false }, + { Name = "includeHyperlinks", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "objectiveText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTitle", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTrackablesOnMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "ContentTrackingResult", Nilable = false }, + { Name = "trackableMapInfos", Type = "table", InnerType = "ContentTrackingMapInfo", Nilable = false }, + }, + }, + { + Name = "GetTrackedIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + }, + + Returns = + { + { Name = "entryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetVendorTrackingInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "collectableEntryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "vendorTrackingInfo", Type = "VendorTrackingInfo", Nilable = false }, + }, + }, + { + Name = "GetWaypointText", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "waypointText", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsNavigable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If successful, returns if the trackable is either on your current map, or if we're able to determine a route to that map from your location via waypoints." }, + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "ContentTrackingResult", Nilable = false }, + { Name = "isNavigable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTrackable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTracking", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartTracking", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "error", Type = "ContentTrackingError", Nilable = true }, + }, + }, + { + Name = "StopTracking", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "stopType", Type = "ContentTrackingStopType", Nilable = false }, + }, + }, + { + Name = "ToggleTracking", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "stopType", Type = "ContentTrackingStopType", Nilable = false }, + }, + + Returns = + { + { Name = "error", Type = "ContentTrackingError", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "ContentTrackingIsEnabledUpdate", + Type = "Event", + LiteralName = "CONTENT_TRACKING_IS_ENABLED_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContentTrackingListUpdate", + Type = "Event", + LiteralName = "CONTENT_TRACKING_LIST_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ContentTrackingUpdate", + Type = "Event", + LiteralName = "CONTENT_TRACKING_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "isTracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TrackableInfoUpdate", + Type = "Event", + LiteralName = "TRACKABLE_INFO_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "ContentTrackingType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "TrackingTargetInfoUpdate", + Type = "Event", + LiteralName = "TRACKING_TARGET_INFO_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false }, + { Name = "targetID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ContentTracking); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..038e30e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContentTrackingTypesDocumentation.lua.annotated.lua @@ -0,0 +1,125 @@ +local ContentTrackingTypes = +{ + Tables = + { + { + Name = "ContentTrackingError", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Untrackable", Type = "ContentTrackingError", EnumValue = 0 }, + { Name = "MaxTracked", Type = "ContentTrackingError", EnumValue = 1 }, + { Name = "AlreadyTracked", Type = "ContentTrackingError", EnumValue = 2 }, + }, + }, + { + Name = "ContentTrackingResult", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Success", Type = "ContentTrackingResult", EnumValue = 0 }, + { Name = "DataPending", Type = "ContentTrackingResult", EnumValue = 1 }, + { Name = "Failure", Type = "ContentTrackingResult", EnumValue = 2 }, + }, + }, + { + Name = "ContentTrackingStopType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Invalidated", Type = "ContentTrackingStopType", EnumValue = 0 }, + { Name = "Collected", Type = "ContentTrackingStopType", EnumValue = 1 }, + { Name = "Manual", Type = "ContentTrackingStopType", EnumValue = 2 }, + }, + }, + { + Name = "ContentTrackingTargetType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "JournalEncounter", Type = "ContentTrackingTargetType", EnumValue = 0 }, + { Name = "Vendor", Type = "ContentTrackingTargetType", EnumValue = 1 }, + { Name = "Achievement", Type = "ContentTrackingTargetType", EnumValue = 2 }, + { Name = "Profession", Type = "ContentTrackingTargetType", EnumValue = 3 }, + { Name = "Quest", Type = "ContentTrackingTargetType", EnumValue = 4 }, + }, + }, + { + Name = "ContentTrackingType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Appearance", Type = "ContentTrackingType", EnumValue = 0 }, + { Name = "Mount", Type = "ContentTrackingType", EnumValue = 1 }, + { Name = "Achievement", Type = "ContentTrackingType", EnumValue = 2 }, + { Name = "Decor", Type = "ContentTrackingType", EnumValue = 3 }, + }, + }, + { + Name = "ContentTrackingConsts", + Type = "Constants", + Values = + { + { Name = "MaxTrackedCollectableSources", Type = "number", Value = 15 }, + { Name = "MaxTrackedAchievements", Type = "number", Value = 10 }, + }, + }, + { + Name = "ContentTrackingMapInfo", + Type = "Structure", + Fields = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + { Name = "targetType", Type = "ContentTrackingTargetType", Nilable = false }, + { Name = "targetID", Type = "number", Nilable = false }, + { Name = "waypointText", Type = "string", Nilable = false }, + }, + }, + { + Name = "EncounterTrackingInfo", + Type = "Structure", + Fields = + { + { Name = "encounterName", Type = "cstring", Nilable = false }, + { Name = "journalEncounterID", Type = "number", Nilable = true }, + { Name = "journalInstanceID", Type = "number", Nilable = true }, + { Name = "instanceName", Type = "cstring", Nilable = false }, + { Name = "subText", Type = "cstring", Nilable = true }, + { Name = "difficultyID", Type = "number", Nilable = true }, + { Name = "lfgDungeonID", Type = "number", Nilable = true }, + { Name = "groupFinderActivityID", Type = "number", Nilable = true }, + }, + }, + { + Name = "VendorTrackingInfo", + Type = "Structure", + Fields = + { + { Name = "creatureName", Type = "cstring", Nilable = false }, + { Name = "zoneName", Type = "string", Nilable = true }, + { Name = "currencyType", Type = "number", Nilable = true }, + { Name = "cost", Type = "BigUInteger", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ContentTrackingTypes); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dff9800 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ContributionCollectorDocumentation.lua.annotated.lua @@ -0,0 +1,362 @@ +local ContributionCollector = +{ + Name = "ContributionCollector", + Type = "System", + Namespace = "C_ContributionCollector", + Environment = "All", + + Functions = + { + { + Name = "Close", + Type = "Function", + }, + { + Name = "Contribute", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActive", + Type = "Function", + + Returns = + { + { Name = "contributionID", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetAtlases", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "atlasName", Type = "table", InnerType = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetBuffs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetContributionAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + { Name = "contributionState", Type = "ContributionState", Nilable = false }, + }, + + Returns = + { + { Name = "appearance", Type = "ContributionAppearance", Nilable = true }, + }, + }, + { + Name = "GetContributionCollectorsForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "contributionCollectors", Type = "table", InnerType = "ContributionMapInfo", Nilable = false }, + }, + }, + { + Name = "GetContributionResult", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "ContributionResult", Nilable = false }, + }, + }, + { + Name = "GetDescription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + { + Name = "GetManagedContributionsForCreatureID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "contributionID", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + { + Name = "GetOrderIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "orderIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRequiredContributionCurrency", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currencyID", Type = "number", Nilable = false, Default = 0 }, + { Name = "currencyAmount", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetRequiredContributionItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false, Default = 0 }, + { Name = "itemCount", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetRewardQuestID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "contributionState", Type = "ContributionState", Nilable = false, Default = "None" }, + { Name = "contributionPercentageComplete", Type = "number", Nilable = false }, + { Name = "timeOfNextStateChange", Type = "time_t", Nilable = true }, + { Name = "startTime", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "HasPendingContribution", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasPending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAwaitingRewardQuestData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "awaitingData", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ContributionChanged", + Type = "Event", + LiteralName = "CONTRIBUTION_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "state", Type = "ContributionState", Nilable = false }, + { Name = "result", Type = "ContributionResult", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "contributionID", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "ContributionCollectorPending", + Type = "Event", + LiteralName = "CONTRIBUTION_COLLECTOR_PENDING", + SynchronousEvent = true, + Payload = + { + { Name = "contributionID", Type = "number", Nilable = false }, + { Name = "isPending", Type = "bool", Nilable = false }, + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "ContributionCollectorUpdate", + Type = "Event", + LiteralName = "CONTRIBUTION_COLLECTOR_UPDATE", + UniqueEvent = true, + }, + { + Name = "ContributionCollectorUpdateSingle", + Type = "Event", + LiteralName = "CONTRIBUTION_COLLECTOR_UPDATE_SINGLE", + SynchronousEvent = true, + Payload = + { + { Name = "contributionID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ContributionResult", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Success", Type = "ContributionResult", EnumValue = 0 }, + { Name = "MustBeNearNpc", Type = "ContributionResult", EnumValue = 1 }, + { Name = "IncorrectState", Type = "ContributionResult", EnumValue = 2 }, + { Name = "InvalidID", Type = "ContributionResult", EnumValue = 3 }, + { Name = "QuestDataMissing", Type = "ContributionResult", EnumValue = 4 }, + { Name = "FailedConditionCheck", Type = "ContributionResult", EnumValue = 5 }, + { Name = "UnableToCompleteTurnIn", Type = "ContributionResult", EnumValue = 6 }, + { Name = "InternalError", Type = "ContributionResult", EnumValue = 7 }, + }, + }, + { + Name = "ContributionAppearance", + Type = "Structure", + Fields = + { + { Name = "stateName", Type = "cstring", Nilable = false }, + { Name = "stateColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "tooltipLine", Type = "cstring", Nilable = false }, + { Name = "tooltipUseTimeRemaining", Type = "bool", Nilable = false }, + { Name = "statusBarAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "borderAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "bannerAtlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "ContributionMapInfo", + Type = "Structure", + Fields = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "atlasName", Type = "string", Nilable = false }, + { Name = "collectorCreatureID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ContributionCollector); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bf50ea2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,96 @@ +local CooldownViewerConstants = +{ + Tables = + { + { + Name = "CooldownSetLinkedSpellFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "UseAsTooltip", Type = "CooldownSetLinkedSpellFlags", EnumValue = 1 }, + }, + }, + { + Name = "CooldownSetSpellFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "HideAura", Type = "CooldownSetSpellFlags", EnumValue = 1 }, + { Name = "HideByDefault", Type = "CooldownSetSpellFlags", EnumValue = 2 }, + }, + }, + { + Name = "CooldownViewerAddAlertStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Success", Type = "CooldownViewerAddAlertStatus", EnumValue = 0 }, + { Name = "InvalidAlertType", Type = "CooldownViewerAddAlertStatus", EnumValue = 1 }, + { Name = "InvalidEventType", Type = "CooldownViewerAddAlertStatus", EnumValue = 2 }, + { Name = "DuplicateAlert", Type = "CooldownViewerAddAlertStatus", EnumValue = 3 }, + }, + }, + { + Name = "CooldownViewerAlertEventType", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 6, + Fields = + { + { Name = "Available", Type = "CooldownViewerAlertEventType", EnumValue = 1 }, + { Name = "PandemicTime", Type = "CooldownViewerAlertEventType", EnumValue = 2 }, + { Name = "OnCooldown", Type = "CooldownViewerAlertEventType", EnumValue = 3 }, + { Name = "ChargeGained", Type = "CooldownViewerAlertEventType", EnumValue = 4 }, + { Name = "OnAuraApplied", Type = "CooldownViewerAlertEventType", EnumValue = 5 }, + { Name = "OnAuraRemoved", Type = "CooldownViewerAlertEventType", EnumValue = 6 }, + }, + }, + { + Name = "CooldownViewerAlertType", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "Sound", Type = "CooldownViewerAlertType", EnumValue = 1 }, + { Name = "Visual", Type = "CooldownViewerAlertType", EnumValue = 2 }, + }, + }, + { + Name = "CooldownViewerCategory", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Essential", Type = "CooldownViewerCategory", EnumValue = 0 }, + { Name = "Utility", Type = "CooldownViewerCategory", EnumValue = 1 }, + { Name = "TrackedBuff", Type = "CooldownViewerCategory", EnumValue = 2 }, + { Name = "TrackedBar", Type = "CooldownViewerCategory", EnumValue = 3 }, + }, + }, + { + Name = "CooldownViewerUIConstants", + Type = "Constants", + Values = + { + { Name = "COOLDOWN_VIEWER_LINKED_SPELLS_SIZE", Type = "number", Value = 4 }, + { Name = "COOLDOWN_VIEWER_CATEGORY_SET_SIZE", Type = "number", Value = 16 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CooldownViewerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a549860 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CooldownViewerDocumentation.lua.annotated.lua @@ -0,0 +1,138 @@ +local CooldownViewer = +{ + Name = "CooldownViewer", + Type = "System", + Namespace = "C_CooldownViewer", + Environment = "All", + + Functions = + { + { + Name = "GetCooldownViewerCategorySet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "CooldownViewerCategory", Nilable = false }, + { Name = "allowUnlearned", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "cooldownIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCooldownViewerCooldownInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cooldownID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "cooldownInfo", Type = "CooldownViewerCooldown", Nilable = false }, + }, + }, + { + Name = "GetLayoutData", + Type = "Function", + + Returns = + { + { Name = "data", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetValidAlertTypes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cooldownID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "validAlertTypes", Type = "table", InnerType = "CooldownViewerAlertEventType", Nilable = false }, + }, + }, + { + Name = "IsCooldownViewerAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetLayoutData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "data", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CooldownViewerDataLoaded", + Type = "Event", + LiteralName = "COOLDOWN_VIEWER_DATA_LOADED", + SynchronousEvent = true, + }, + { + Name = "CooldownViewerSpellOverrideUpdated", + Type = "Event", + LiteralName = "COOLDOWN_VIEWER_SPELL_OVERRIDE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "baseSpellID", Type = "number", Nilable = false, Documentation = { "The base spell that is either being overridden or losing its override spell." } }, + { Name = "overrideSpellID", Type = "number", Nilable = true, Documentation = { "The spell overriding the base spell. A nil value indicates that the override spell is being removed from the base spell." } }, + }, + }, + { + Name = "CooldownViewerTableHotfixed", + Type = "Event", + LiteralName = "COOLDOWN_VIEWER_TABLE_HOTFIXED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "CooldownViewerCooldown", + Type = "Structure", + Fields = + { + { Name = "cooldownID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "overrideSpellID", Type = "number", Nilable = true }, + { Name = "overrideTooltipSpellID", Type = "number", Nilable = true }, + { Name = "linkedSpellIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "selfAura", Type = "bool", Nilable = false }, + { Name = "hasAura", Type = "bool", Nilable = false }, + { Name = "charges", Type = "bool", Nilable = false }, + { Name = "isKnown", Type = "bool", Nilable = false }, + { Name = "flags", Type = "CooldownSetSpellFlags", Nilable = false }, + { Name = "category", Type = "CooldownViewerCategory", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CooldownViewer); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..96e03d1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,29 @@ +local CovenantCallingsConstants = +{ + Tables = + { + { + Name = "CallingStates", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "QuestOffer", Type = "CallingStates", EnumValue = 0 }, + { Name = "QuestActive", Type = "CallingStates", EnumValue = 1 }, + { Name = "QuestCompleted", Type = "CallingStates", EnumValue = 2 }, + }, + }, + { + Name = "Callings", + Type = "Constants", + Values = + { + { Name = "MaxCallings", Type = "number", Value = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CovenantCallingsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2658694 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantCallingsDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local CovenantCallings = +{ + Name = "CovenantCallings", + Type = "System", + Namespace = "C_CovenantCallings", + Environment = "All", + + Functions = + { + { + Name = "AreCallingsUnlocked", + Type = "Function", + + Returns = + { + { Name = "unlocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestCallings", + Type = "Function", + }, + }, + + Events = + { + { + Name = "CovenantCallingsUpdated", + Type = "Event", + LiteralName = "COVENANT_CALLINGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "callings", Type = "table", InnerType = "BountyInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CovenantCallings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f5cb6cf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantPreviewDocumentation.lua.annotated.lua @@ -0,0 +1,106 @@ +local CovenantPreview = +{ + Name = "CovenantPreview", + Type = "System", + Namespace = "C_CovenantPreview", + Environment = "All", + + Functions = + { + { + Name = "CloseFromUI", + Type = "Function", + }, + { + Name = "GetCovenantInfoForPlayerChoiceResponseID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerChoiceResponseID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "previewInfo", Type = "CovenantPreviewInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CovenantPreviewClose", + Type = "Event", + LiteralName = "COVENANT_PREVIEW_CLOSE", + SynchronousEvent = true, + }, + { + Name = "CovenantPreviewOpen", + Type = "Event", + LiteralName = "COVENANT_PREVIEW_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "previewInfo", Type = "CovenantPreviewInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CovenantAbilityInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "type", Type = "CovenantAbilityType", Nilable = false }, + }, + }, + { + Name = "CovenantFeatureInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "number", Nilable = false }, + }, + }, + { + Name = "CovenantPreviewInfo", + Type = "Structure", + Fields = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "transmogSetID", Type = "number", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "covenantName", Type = "string", Nilable = false }, + { Name = "covenantZone", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "covenantCrest", Type = "textureAtlas", Nilable = false }, + { Name = "covenantAbilities", Type = "table", InnerType = "CovenantAbilityInfo", Nilable = false }, + { Name = "fromPlayerChoice", Type = "bool", Nilable = false }, + { Name = "covenantSoulbinds", Type = "table", InnerType = "CovenantSoulbindInfo", Nilable = false }, + { Name = "featureInfo", Type = "CovenantFeatureInfo", Nilable = false }, + }, + }, + { + Name = "CovenantSoulbindInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "sortOrder", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CovenantPreview); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3000a42 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local CovenantSanctumConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CovenantSanctumConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5056331 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantSanctumDocumentation.lua.annotated.lua @@ -0,0 +1,222 @@ +local CovenantSanctum = +{ + Name = "CovenantSanctumUI", + Type = "System", + Namespace = "C_CovenantSanctumUI", + Environment = "All", + + Functions = + { + { + Name = "CanAccessReservoir", + Type = "Function", + + Returns = + { + { Name = "canAccess", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanDepositAnima", + Type = "Function", + + Returns = + { + { Name = "canDeposit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DepositAnima", + Type = "Function", + }, + { + Name = "EndInteraction", + Type = "Function", + }, + { + Name = "GetAnimaInfo", + Type = "Function", + + Returns = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "maxDisplayableValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentTalentTreeID", + Type = "Function", + + Returns = + { + { Name = "currentTalentTreeID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFeatures", + Type = "Function", + + Returns = + { + { Name = "features", Type = "table", InnerType = "CovenantSanctumFeatureInfo", Nilable = false }, + }, + }, + { + Name = "GetRenownLevel", + Type = "Function", + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRenownLevels", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "covenantID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "levels", Type = "table", InnerType = "CovenantSanctumRenownLevelInfo", Nilable = false }, + }, + }, + { + Name = "GetRenownRewardsForLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "covenantID", Type = "number", Nilable = false }, + { Name = "renownLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rewards", Type = "table", InnerType = "CovenantSanctumRenownRewardInfo", Nilable = false }, + }, + }, + { + Name = "GetSanctumType", + Type = "Function", + + Returns = + { + { Name = "sanctumType", Type = "GarrTalentFeatureSubtype", Nilable = true }, + }, + }, + { + Name = "GetSoulCurrencies", + Type = "Function", + + Returns = + { + { Name = "currencyIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "HasMaximumRenown", + Type = "Function", + + Returns = + { + { Name = "hasMaxRenown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInRenownCatchUpMode", + Type = "Function", + + Returns = + { + { Name = "isInCatchUpMode", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWeeklyRenownCapped", + Type = "Function", + + Returns = + { + { Name = "isWeeklyCapped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestCatchUpState", + Type = "Function", + }, + }, + + Events = + { + { + Name = "CovenantRenownCatchUpStateUpdate", + Type = "Event", + LiteralName = "COVENANT_RENOWN_CATCH_UP_STATE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "CovenantSanctumRenownLevelChanged", + Type = "Event", + LiteralName = "COVENANT_SANCTUM_RENOWN_LEVEL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "newRenownLevel", Type = "number", Nilable = false }, + { Name = "oldRenownLevel", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CovenantSanctumFeatureInfo", + Type = "Structure", + Fields = + { + { Name = "garrTalentTreeID", Type = "number", Nilable = false }, + { Name = "featureType", Type = "number", Nilable = false }, + { Name = "uiOrder", Type = "number", Nilable = false }, + }, + }, + { + Name = "CovenantSanctumRenownLevelInfo", + Type = "Structure", + Fields = + { + { Name = "level", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + { Name = "isMilestone", Type = "bool", Nilable = false }, + { Name = "isCapstone", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CovenantSanctumRenownRewardInfo", + Type = "Structure", + Fields = + { + { Name = "uiOrder", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "mountID", Type = "number", Nilable = true }, + { Name = "transmogID", Type = "number", Nilable = true }, + { Name = "transmogSetID", Type = "number", Nilable = true }, + { Name = "titleMaskID", Type = "number", Nilable = true }, + { Name = "garrFollowerID", Type = "number", Nilable = true }, + { Name = "transmogIllusionSourceID", Type = "number", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "description", Type = "cstring", Nilable = true }, + { Name = "toastDescription", Type = "cstring", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CovenantSanctum); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..504b02f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local CovenantsConstants = +{ + Tables = + { + { + Name = "CovenantAbilityType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Class", Type = "CovenantAbilityType", EnumValue = 0 }, + { Name = "Signature", Type = "CovenantAbilityType", EnumValue = 1 }, + { Name = "Soulbind", Type = "CovenantAbilityType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CovenantsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..86a6637 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CovenantsDocumentation.lua.annotated.lua @@ -0,0 +1,86 @@ +local Covenants = +{ + Name = "Covenant", + Type = "System", + Namespace = "C_Covenants", + Environment = "All", + + Functions = + { + { + Name = "GetActiveCovenantID", + Type = "Function", + + Returns = + { + { Name = "covenantID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCovenantData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "covenantID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "CovenantData", Nilable = true }, + }, + }, + { + Name = "GetCovenantIDs", + Type = "Function", + + Returns = + { + { Name = "covenantID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CovenantChosen", + Type = "Event", + LiteralName = "COVENANT_CHOSEN", + SynchronousEvent = true, + Payload = + { + { Name = "covenantID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CovenantData", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "celebrationSoundKit", Type = "number", Nilable = false }, + { Name = "animaChannelSelectSoundKit", Type = "number", Nilable = false }, + { Name = "animaChannelActiveSoundKit", Type = "number", Nilable = false }, + { Name = "animaGemsFullSoundKit", Type = "number", Nilable = false }, + { Name = "animaNewGemSoundKit", Type = "number", Nilable = false }, + { Name = "animaReinforceSelectSoundKit", Type = "number", Nilable = false }, + { Name = "upgradeTabSelectSoundKitID", Type = "number", Nilable = false }, + { Name = "reservoirFullSoundKitID", Type = "number", Nilable = false }, + { Name = "beginResearchSoundKitID", Type = "number", Nilable = false }, + { Name = "renownFanfareSoundKitID", Type = "number", Nilable = false }, + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "soulbindIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Covenants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fd2cc4a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,43 @@ +local CraftingOrderUIConstants = +{ + Tables = + { + { + Name = "CraftingOrderCustomerCategoryType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Primary", Type = "CraftingOrderCustomerCategoryType", EnumValue = 0 }, + { Name = "Secondary", Type = "CraftingOrderCustomerCategoryType", EnumValue = 1 }, + { Name = "Tertiary", Type = "CraftingOrderCustomerCategoryType", EnumValue = 2 }, + }, + }, + { + Name = "CraftingOrderReagentsType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "All", Type = "CraftingOrderReagentsType", EnumValue = 0 }, + { Name = "Some", Type = "CraftingOrderReagentsType", EnumValue = 1 }, + { Name = "None", Type = "CraftingOrderReagentsType", EnumValue = 2 }, + }, + }, + { + Name = "CraftingOrderConsts", + Type = "Constants", + Values = + { + { Name = "MAX_CRAFTING_ORDER_FAVORITE_RECIPES", Type = "number", Value = 100 }, + { Name = "NPC_CRAFTING_ORDER_NUM_SUPPORTED_REWARDS", Type = "number", Value = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CraftingOrderUIConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5f508e2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUIDocumentation.lua.annotated.lua @@ -0,0 +1,610 @@ +local CraftingOrderUI = +{ + Name = "CraftingOrderUI", + Type = "System", + Namespace = "C_CraftingOrders", + Environment = "All", + + Functions = + { + { + Name = "AreOrderNotesDisabled", + Type = "Function", + + Returns = + { + { Name = "areNotesDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalculateCraftingOrderPostingFee", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "orderType", Type = "CraftingOrderType", Nilable = false }, + { Name = "orderDuration", Type = "CraftingOrderDuration", Nilable = false }, + }, + + Returns = + { + { Name = "deposit", Type = "WOWMONEY", Nilable = false }, + }, + }, + { + Name = "CanOrderSkillAbility", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canOrder", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "ClaimOrder", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "profession", Type = "Profession", Nilable = false }, + }, + }, + { + Name = "CloseCrafterCraftingOrders", + Type = "Function", + }, + { + Name = "CloseCustomerCraftingOrders", + Type = "Function", + }, + { + Name = "FulfillOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "crafterNote", Type = "string", Nilable = false }, + { Name = "profession", Type = "Profession", Nilable = false }, + }, + }, + { + Name = "GetClaimedOrder", + Type = "Function", + + Returns = + { + { Name = "order", Type = "CraftingOrderInfo", Nilable = true }, + }, + }, + { + Name = "GetCrafterBuckets", + Type = "Function", + + Returns = + { + { Name = "buckets", Type = "table", InnerType = "CraftingOrderBucketInfo", Nilable = false }, + }, + }, + { + Name = "GetCrafterOrders", + Type = "Function", + + Returns = + { + { Name = "orders", Type = "table", InnerType = "CraftingOrderInfo", Nilable = false }, + }, + }, + { + Name = "GetCraftingOrderTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "GetCustomerCategories", + Type = "Function", + + Returns = + { + { Name = "categories", Type = "table", InnerType = "CraftingOrderCustomerCategory", Nilable = false }, + }, + }, + { + Name = "GetCustomerOptions", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "params", Type = "CraftingOrderCustomerSearchParams", Nilable = false }, + }, + + Returns = + { + { Name = "results", Type = "CraftingOrderCustomerSearchResults", Nilable = false }, + }, + }, + { + Name = "GetCustomerOrders", + Type = "Function", + + Returns = + { + { Name = "customerOrders", Type = "table", InnerType = "CraftingOrderInfo", Nilable = false }, + }, + }, + { + Name = "GetDefaultOrdersSkillLine", + Type = "Function", + + Returns = + { + { Name = "skillLineID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMyOrders", + Type = "Function", + + Returns = + { + { Name = "myOrders", Type = "table", InnerType = "CraftingOrderInfo", Nilable = false }, + }, + }, + { + Name = "GetNumFavoriteCustomerOptions", + Type = "Function", + + Returns = + { + { Name = "numFavorites", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "GetOrderClaimInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "profession", Type = "Profession", Nilable = false }, + }, + + Returns = + { + { Name = "claimInfo", Type = "CraftingOrderClaimsRemainingInfo", Nilable = false }, + }, + }, + { + Name = "GetPersonalOrdersInfo", + Type = "Function", + + Returns = + { + { Name = "infos", Type = "table", InnerType = "CraftingOrderPersonalOrdersInfo", Nilable = false }, + }, + }, + { + Name = "HasFavoriteCustomerOptions", + Type = "Function", + + Returns = + { + { Name = "hasFavorites", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCustomerOptionFavorited", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "favorited", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ListMyOrders", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "request", Type = "CraftingOrderRequestMyOrdersInfo", Nilable = false }, + }, + }, + { + Name = "OpenCrafterCraftingOrders", + Type = "Function", + }, + { + Name = "OpenCustomerCraftingOrders", + Type = "Function", + }, + { + Name = "OrderCanBeRecrafted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + + Returns = + { + { Name = "recraftable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ParseCustomerOptions", + Type = "Function", + }, + { + Name = "PlaceNewOrder", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderInfo", Type = "NewCraftingOrderInfo", Nilable = false }, + }, + }, + { + Name = "RejectOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "crafterNote", Type = "string", Nilable = false }, + { Name = "profession", Type = "Profession", Nilable = false }, + }, + }, + { + Name = "ReleaseOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "profession", Type = "Profession", Nilable = false }, + }, + }, + { + Name = "RequestCrafterOrders", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "request", Type = "CraftingOrderRequestInfo", Nilable = false }, + }, + }, + { + Name = "RequestCustomerOrders", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "request", Type = "CraftingOrderRequestInfo", Nilable = false }, + }, + }, + { + Name = "SetCustomerOptionFavorited", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "favorited", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowCraftingOrderTab", + Type = "Function", + + Returns = + { + { Name = "showTab", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SkillLineHasOrders", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasOrders", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UpdateIgnoreList", + Type = "Function", + }, + }, + + Events = + { + { + Name = "CraftingHouseDisabled", + Type = "Event", + LiteralName = "CRAFTING_HOUSE_DISABLED", + SynchronousEvent = true, + }, + { + Name = "CraftingordersCanRequest", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CAN_REQUEST", + SynchronousEvent = true, + }, + { + Name = "CraftingordersClaimOrderResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CLAIM_ORDER_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersClaimedOrderAdded", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CLAIMED_ORDER_ADDED", + SynchronousEvent = true, + }, + { + Name = "CraftingordersClaimedOrderRemoved", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CLAIMED_ORDER_REMOVED", + SynchronousEvent = true, + }, + { + Name = "CraftingordersClaimedOrderUpdated", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CLAIMED_ORDER_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersCraftOrderResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CRAFT_ORDER_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersCustomerFavoritesChanged", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CUSTOMER_FAVORITES_CHANGED", + SynchronousEvent = true, + }, + { + Name = "CraftingordersCustomerOptionsParsed", + Type = "Event", + LiteralName = "CRAFTINGORDERS_CUSTOMER_OPTIONS_PARSED", + SynchronousEvent = true, + }, + { + Name = "CraftingordersDisplayCrafterFulfilledMsg", + Type = "Event", + LiteralName = "CRAFTINGORDERS_DISPLAY_CRAFTER_FULFILLED_MSG", + SynchronousEvent = true, + Payload = + { + { Name = "orderTypeString", Type = "cstring", Nilable = false }, + { Name = "itemNameString", Type = "cstring", Nilable = false }, + { Name = "playerNameString", Type = "cstring", Nilable = false }, + { Name = "tipAmount", Type = "WOWMONEY", Nilable = false }, + { Name = "quantityCrafted", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingordersFulfillOrderResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_FULFILL_ORDER_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersHideCrafter", + Type = "Event", + LiteralName = "CRAFTINGORDERS_HIDE_CRAFTER", + SynchronousEvent = true, + }, + { + Name = "CraftingordersHideCustomer", + Type = "Event", + LiteralName = "CRAFTINGORDERS_HIDE_CUSTOMER", + SynchronousEvent = true, + }, + { + Name = "CraftingordersOrderCancelResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_ORDER_CANCEL_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + }, + }, + { + Name = "CraftingordersOrderPlacementResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_ORDER_PLACEMENT_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + }, + }, + { + Name = "CraftingordersRejectOrderResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_REJECT_ORDER_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersReleaseOrderResponse", + Type = "Event", + LiteralName = "CRAFTINGORDERS_RELEASE_ORDER_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersShowCrafter", + Type = "Event", + LiteralName = "CRAFTINGORDERS_SHOW_CRAFTER", + SynchronousEvent = true, + }, + { + Name = "CraftingordersShowCustomer", + Type = "Event", + LiteralName = "CRAFTINGORDERS_SHOW_CUSTOMER", + SynchronousEvent = true, + }, + { + Name = "CraftingordersUnexpectedError", + Type = "Event", + LiteralName = "CRAFTINGORDERS_UNEXPECTED_ERROR", + SynchronousEvent = true, + }, + { + Name = "CraftingordersUpdateCustomerName", + Type = "Event", + LiteralName = "CRAFTINGORDERS_UPDATE_CUSTOMER_NAME", + SynchronousEvent = true, + Payload = + { + { Name = "customerName", Type = "cstring", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "CraftingordersUpdateOrderCount", + Type = "Event", + LiteralName = "CRAFTINGORDERS_UPDATE_ORDER_COUNT", + SynchronousEvent = true, + Payload = + { + { Name = "orderType", Type = "CraftingOrderType", Nilable = false }, + { Name = "numOrders", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingordersUpdatePersonalOrderCounts", + Type = "Event", + LiteralName = "CRAFTINGORDERS_UPDATE_PERSONAL_ORDER_COUNTS", + SynchronousEvent = true, + }, + { + Name = "CraftingordersUpdateRewards", + Type = "Event", + LiteralName = "CRAFTINGORDERS_UPDATE_REWARDS", + SynchronousEvent = true, + Payload = + { + { Name = "npcOrderRewards", Type = "table", InnerType = "CraftingOrderRewardInfo", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CraftingOrderRequestInfo", + Type = "Structure", + Fields = + { + { Name = "orderType", Type = "CraftingOrderType", Nilable = false }, + { Name = "selectedSkillLineAbility", Type = "number", Nilable = true }, + { Name = "searchFavorites", Type = "bool", Nilable = false }, + { Name = "initialNonPublicSearch", Type = "bool", Nilable = false }, + { Name = "primarySort", Type = "CraftingOrderSortInfo", Nilable = false }, + { Name = "secondarySort", Type = "CraftingOrderSortInfo", Nilable = false }, + { Name = "forCrafter", Type = "bool", Nilable = false }, + { Name = "offset", Type = "number", Nilable = false }, + { Name = "callback", Type = "CraftingOrderRequestCallback", Nilable = false }, + { Name = "profession", Type = "Profession", Nilable = true }, + }, + }, + { + Name = "CraftingOrderRequestMyOrdersInfo", + Type = "Structure", + Fields = + { + { Name = "primarySort", Type = "CraftingOrderSortInfo", Nilable = false }, + { Name = "secondarySort", Type = "CraftingOrderSortInfo", Nilable = false }, + { Name = "offset", Type = "number", Nilable = false }, + { Name = "callback", Type = "CraftingOrderRequestMyOrdersCallback", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CraftingOrderUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..272f296 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CraftingOrderUISharedDocumentation.lua.annotated.lua @@ -0,0 +1,244 @@ +local CraftingOrderUIShared = +{ + Tables = + { + { + Name = "CraftingOrderBucketInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "tipAmountAvg", Type = "WOWMONEY", Nilable = false }, + { Name = "tipAmountMax", Type = "WOWMONEY", Nilable = false }, + { Name = "numAvailable", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingOrderClaimsRemainingInfo", + Type = "Structure", + Fields = + { + { Name = "claimsRemaining", Type = "number", Nilable = false, Default = 0 }, + { Name = "secondsToRecharge", Type = "number", Nilable = true }, + }, + }, + { + Name = "CraftingOrderCustomerCategory", + Type = "Structure", + Fields = + { + { Name = "categoryName", Type = "string", Nilable = false }, + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "uiSortOrder", Type = "number", Nilable = false }, + { Name = "primaryCategorySortOrder", Type = "number", Nilable = true }, + { Name = "secondaryCategorySortOrder", Type = "number", Nilable = true }, + { Name = "type", Type = "CraftingOrderCustomerCategoryType", Nilable = false }, + }, + }, + { + Name = "CraftingOrderCustomerCategoryFilters", + Type = "Structure", + Fields = + { + { Name = "primaryCategoryID", Type = "number", Nilable = true }, + { Name = "secondaryCategoryID", Type = "number", Nilable = true }, + { Name = "tertiaryCategoryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "CraftingOrderCustomerOptionInfo", + Type = "Structure", + Fields = + { + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "professionID", Type = "number", Nilable = false }, + { Name = "skillUpSkillLineID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemName", Type = "string", Nilable = false }, + { Name = "primaryCategoryID", Type = "number", Nilable = false }, + { Name = "iLvlMin", Type = "number", Nilable = false }, + { Name = "iLvlMax", Type = "number", Nilable = true }, + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "bindOnPickup", Type = "bool", Nilable = false }, + { Name = "qualityIlvlBonuses", Type = "table", InnerType = "number", Nilable = true }, + { Name = "craftingQualityIDs", Type = "table", InnerType = "number", Nilable = true }, + { Name = "quality", Type = "ItemQuality", Nilable = true }, + { Name = "slots", Type = "number", Nilable = true }, + { Name = "level", Type = "number", Nilable = true }, + { Name = "skill", Type = "number", Nilable = true }, + { Name = "secondaryCategoryID", Type = "number", Nilable = true }, + { Name = "tertiaryCategoryID", Type = "number", Nilable = true }, + { Name = "expansionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "CraftingOrderCustomerSearchParams", + Type = "Structure", + Fields = + { + { Name = "categoryFilters", Type = "CraftingOrderCustomerCategoryFilters", Nilable = false }, + { Name = "searchText", Type = "string", Nilable = true }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "uncollectedOnly", Type = "bool", Nilable = false }, + { Name = "usableOnly", Type = "bool", Nilable = false }, + { Name = "upgradesOnly", Type = "bool", Nilable = false }, + { Name = "currentExpansionOnly", Type = "bool", Nilable = false }, + { Name = "includePoor", Type = "bool", Nilable = false }, + { Name = "includeCommon", Type = "bool", Nilable = false }, + { Name = "includeUncommon", Type = "bool", Nilable = false }, + { Name = "includeRare", Type = "bool", Nilable = false }, + { Name = "includeEpic", Type = "bool", Nilable = false }, + { Name = "includeLegendary", Type = "bool", Nilable = false }, + { Name = "includeArtifact", Type = "bool", Nilable = false }, + { Name = "isFavoritesSearch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CraftingOrderCustomerSearchResults", + Type = "Structure", + Fields = + { + { Name = "options", Type = "table", InnerType = "CraftingOrderCustomerOptionInfo", Nilable = false }, + { Name = "extraColumnType", Type = "AuctionHouseExtraColumn", Nilable = true }, + }, + }, + { + Name = "CraftingOrderInfo", + Type = "Structure", + Fields = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "orderType", Type = "CraftingOrderType", Nilable = false }, + { Name = "orderState", Type = "CraftingOrderState", Nilable = false }, + { Name = "expirationTime", Type = "time_t", Nilable = false }, + { Name = "claimEndTime", Type = "time_t", Nilable = false }, + { Name = "minQuality", Type = "number", Nilable = false }, + { Name = "tipAmount", Type = "WOWMONEY", Nilable = false }, + { Name = "consortiumCut", Type = "WOWMONEY", Nilable = false }, + { Name = "isRecraft", Type = "bool", Nilable = false }, + { Name = "isFulfillable", Type = "bool", Nilable = false }, + { Name = "reagentState", Type = "CraftingOrderReagentsType", Nilable = false }, + { Name = "customerGuid", Type = "WOWGUID", Nilable = true }, + { Name = "customerName", Type = "string", Nilable = true }, + { Name = "crafterGuid", Type = "WOWGUID", Nilable = true }, + { Name = "crafterName", Type = "string", Nilable = true }, + { Name = "npcCustomerCreatureID", Type = "number", Nilable = true }, + { Name = "customerNotes", Type = "string", Nilable = false }, + { Name = "reagents", Type = "table", InnerType = "CraftingOrderReagentInfo", Nilable = false }, + { Name = "outputItemHyperlink", Type = "string", Nilable = true }, + { Name = "outputItemGUID", Type = "WOWGUID", Nilable = true }, + { Name = "recraftItemHyperlink", Type = "string", Nilable = true }, + { Name = "npcOrderRewards", Type = "table", InnerType = "CraftingOrderRewardInfo", Nilable = false }, + { Name = "npcCraftingOrderSetID", Type = "number", Nilable = false }, + { Name = "npcTreasureID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingOrderMailInfo", + Type = "Structure", + Fields = + { + { Name = "reason", Type = "RcoCloseReason", Nilable = false }, + { Name = "recipeName", Type = "string", Nilable = false }, + { Name = "commissionPaid", Type = "WOWMONEY", Nilable = true }, + { Name = "crafterNote", Type = "string", Nilable = true }, + { Name = "crafterGUID", Type = "WOWGUID", Nilable = true }, + { Name = "crafterName", Type = "string", Nilable = true }, + { Name = "customerGUID", Type = "WOWGUID", Nilable = true }, + { Name = "customerName", Type = "string", Nilable = true }, + }, + }, + { + Name = "CraftingOrderPersonalOrdersInfo", + Type = "Structure", + Fields = + { + { Name = "profession", Type = "Profession", Nilable = false }, + { Name = "numPersonalOrders", Type = "number", Nilable = false }, + { Name = "professionName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "CraftingOrderReagentInfo", + Type = "Structure", + Fields = + { + { Name = "reagentInfo", Type = "CraftingReagentInfo", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "source", Type = "CraftingOrderReagentSource", Nilable = false }, + { Name = "isBasicReagent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CraftingOrderRewardInfo", + Type = "Structure", + Fields = + { + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "currencyType", Type = "number", Nilable = true }, + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingOrderSortInfo", + Type = "Structure", + Fields = + { + { Name = "sortType", Type = "CraftingOrderSortType", Nilable = false }, + { Name = "reversed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NewCraftingOrderInfo", + Type = "Structure", + Fields = + { + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "orderType", Type = "CraftingOrderType", Nilable = false }, + { Name = "orderDuration", Type = "CraftingOrderDuration", Nilable = false }, + { Name = "tipAmount", Type = "WOWMONEY", Nilable = false }, + { Name = "customerNotes", Type = "string", Nilable = false }, + { Name = "reagentInfos", Type = "table", InnerType = "RegularReagentInfo", Nilable = false }, + { Name = "craftingReagentItems", Type = "table", InnerType = "CraftingReagentInfo", Nilable = false }, + { Name = "minCraftingQualityID", Type = "number", Nilable = true }, + { Name = "orderTarget", Type = "string", Nilable = true }, + { Name = "recraftItem", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "CraftingOrderRequestCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "orderType", Type = "CraftingOrderType", Nilable = false }, + { Name = "displayBuckets", Type = "bool", Nilable = false }, + { Name = "expectMoreRows", Type = "bool", Nilable = false }, + { Name = "offset", Type = "number", Nilable = false }, + { Name = "isSorted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CraftingOrderRequestMyOrdersCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "result", Type = "CraftingOrderResult", Nilable = false }, + { Name = "expectMoreRows", Type = "bool", Nilable = false }, + { Name = "offset", Type = "number", Nilable = false }, + { Name = "isSorted", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CraftingOrderUIShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..efbaa50 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CreatureInfoDocumentation.lua.annotated.lua @@ -0,0 +1,177 @@ +local CreatureInfo = +{ + Name = "CreatureInfo", + Type = "System", + Namespace = "C_CreatureInfo", + Environment = "All", + + Functions = + { + { + Name = "GetClassInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "classInfo", Type = "ClassInfo", Nilable = true }, + }, + }, + { + Name = "GetCreatureFamilyIDs", + Type = "Function", + + Returns = + { + { Name = "creatureFamilyIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCreatureFamilyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureFamilyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "creatureFamilyInfo", Type = "CreatureFamilyInfo", Nilable = true }, + }, + }, + { + Name = "GetCreatureID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "creatureID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCreatureTypeIDs", + Type = "Function", + + Returns = + { + { Name = "creatureTypeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCreatureTypeInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureTypeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "creatureTypeInfo", Type = "CreatureTypeInfo", Nilable = true }, + }, + }, + { + Name = "GetFactionInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "raceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "factionInfo", Type = "FactionInfo", Nilable = true }, + }, + }, + { + Name = "GetRaceInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "raceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "raceInfo", Type = "RaceInfo", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "ClassInfo", + Type = "Structure", + Fields = + { + { Name = "className", Type = "string", Nilable = false }, + { Name = "classFile", Type = "string", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CreatureFamilyInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "iconFile", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "CreatureTypeInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "FactionInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "groupTag", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RaceInfo", + Type = "Structure", + Fields = + { + { Name = "raceName", Type = "string", Nilable = false }, + { Name = "clientFileString", Type = "string", Nilable = false }, + { Name = "raceID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CreatureInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..56cab36 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,213 @@ +local CurrencyConstants = +{ + Tables = + { + { + Name = "AccountCurrencyTransferResult", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "Success", Type = "AccountCurrencyTransferResult", EnumValue = 0 }, + { Name = "InvalidCharacter", Type = "AccountCurrencyTransferResult", EnumValue = 1 }, + { Name = "CharacterLoggedIn", Type = "AccountCurrencyTransferResult", EnumValue = 2 }, + { Name = "InsufficientCurrency", Type = "AccountCurrencyTransferResult", EnumValue = 3 }, + { Name = "MaxQuantity", Type = "AccountCurrencyTransferResult", EnumValue = 4 }, + { Name = "InvalidCurrency", Type = "AccountCurrencyTransferResult", EnumValue = 5 }, + { Name = "NoValidSourceCharacter", Type = "AccountCurrencyTransferResult", EnumValue = 6 }, + { Name = "ServerError", Type = "AccountCurrencyTransferResult", EnumValue = 7 }, + { Name = "CannotUseCurrency", Type = "AccountCurrencyTransferResult", EnumValue = 8 }, + { Name = "TransactionInProgress", Type = "AccountCurrencyTransferResult", EnumValue = 9 }, + { Name = "CurrencyTransferDisabled", Type = "AccountCurrencyTransferResult", EnumValue = 10 }, + }, + }, + { + Name = "CurrencyFilterType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "CurrencyFilterType", EnumValue = 0 }, + { Name = "DiscoveredOnly", Type = "CurrencyFilterType", EnumValue = 1 }, + { Name = "DiscoveredAndAllAccountTransferable", Type = "CurrencyFilterType", EnumValue = 2 }, + }, + }, + { + Name = "CurrencyFlags", + Type = "Enumeration", + NumValues = 32, + MinValue = 1, + MaxValue = 2147483648, + Fields = + { + { Name = "CurrencyTradable", Type = "CurrencyFlags", EnumValue = 1 }, + { Name = "CurrencyAppearsInLootWindow", Type = "CurrencyFlags", EnumValue = 2 }, + { Name = "CurrencyComputedWeeklyMaximum", Type = "CurrencyFlags", EnumValue = 4 }, + { Name = "Currency_100_Scaler", Type = "CurrencyFlags", EnumValue = 8 }, + { Name = "CurrencyNoLowLevelDrop", Type = "CurrencyFlags", EnumValue = 16 }, + { Name = "CurrencyIgnoreMaxQtyOnLoad", Type = "CurrencyFlags", EnumValue = 32 }, + { Name = "CurrencyLogOnWorldChange", Type = "CurrencyFlags", EnumValue = 64 }, + { Name = "CurrencyTrackQuantity", Type = "CurrencyFlags", EnumValue = 128 }, + { Name = "CurrencyResetTrackedQuantity", Type = "CurrencyFlags", EnumValue = 256 }, + { Name = "CurrencyUpdateVersionIgnoreMax", Type = "CurrencyFlags", EnumValue = 512 }, + { Name = "CurrencySuppressChatMessageOnVersionChange", Type = "CurrencyFlags", EnumValue = 1024 }, + { Name = "CurrencySingleDropInLoot", Type = "CurrencyFlags", EnumValue = 2048 }, + { Name = "CurrencyHasWeeklyCatchup", Type = "CurrencyFlags", EnumValue = 4096 }, + { Name = "CurrencyDoNotCompressChat", Type = "CurrencyFlags", EnumValue = 8192 }, + { Name = "CurrencyDoNotLogAcquisitionToBi", Type = "CurrencyFlags", EnumValue = 16384 }, + { Name = "CurrencyNoRaidDrop", Type = "CurrencyFlags", EnumValue = 32768 }, + { Name = "CurrencyNotPersistent", Type = "CurrencyFlags", EnumValue = 65536 }, + { Name = "CurrencyDeprecated", Type = "CurrencyFlags", EnumValue = 131072 }, + { Name = "CurrencyDynamicMaximum", Type = "CurrencyFlags", EnumValue = 262144 }, + { Name = "CurrencySuppressChatMessages", Type = "CurrencyFlags", EnumValue = 524288 }, + { Name = "CurrencyDoNotToast", Type = "CurrencyFlags", EnumValue = 1048576 }, + { Name = "CurrencyDestroyExtraOnLoot", Type = "CurrencyFlags", EnumValue = 2097152 }, + { Name = "CurrencyDontShowTotalInTooltip", Type = "CurrencyFlags", EnumValue = 4194304 }, + { Name = "CurrencyDontCoalesceInLootWindow", Type = "CurrencyFlags", EnumValue = 8388608 }, + { Name = "CurrencyAccountWide", Type = "CurrencyFlags", EnumValue = 16777216 }, + { Name = "CurrencyAllowOverflowMailer", Type = "CurrencyFlags", EnumValue = 33554432 }, + { Name = "CurrencyHideAsReward", Type = "CurrencyFlags", EnumValue = 67108864 }, + { Name = "CurrencyHasWarmodeBonus", Type = "CurrencyFlags", EnumValue = 134217728 }, + { Name = "CurrencyIsAllianceOnly", Type = "CurrencyFlags", EnumValue = 268435456 }, + { Name = "CurrencyIsHordeOnly", Type = "CurrencyFlags", EnumValue = 536870912 }, + { Name = "CurrencyLimitWarmodeBonusOncePerTooltip", Type = "CurrencyFlags", EnumValue = 1073741824 }, + { Name = "CurrencyUsesLedgerBalance", Type = "CurrencyFlags", EnumValue = 2147483648 }, + }, + }, + { + Name = "CurrencyFlagsB", + Type = "Enumeration", + NumValues = 11, + MinValue = 1, + MaxValue = 1024, + Fields = + { + { Name = "CurrencyBUseTotalEarnedForEarned", Type = "CurrencyFlagsB", EnumValue = 1 }, + { Name = "CurrencyBShowQuestXPGainInTooltip", Type = "CurrencyFlagsB", EnumValue = 2 }, + { Name = "CurrencyBNoNotificationMailOnOfflineProgress", Type = "CurrencyFlagsB", EnumValue = 4 }, + { Name = "CurrencyBBattlenetVirtualCurrency", Type = "CurrencyFlagsB", EnumValue = 8 }, + { Name = "FutureCurrencyFlag", Type = "CurrencyFlagsB", EnumValue = 16 }, + { Name = "CurrencyBDontDisplayIfZero", Type = "CurrencyFlagsB", EnumValue = 32 }, + { Name = "CurrencyBScaleMaxQuantityBySeasonWeeks", Type = "CurrencyFlagsB", EnumValue = 64 }, + { Name = "CurrencyBScaleMaxQuantityByWeeksSinceStart", Type = "CurrencyFlagsB", EnumValue = 128 }, + { Name = "CurrencyBForceMaxQuantityOnConversion", Type = "CurrencyFlagsB", EnumValue = 256 }, + { Name = "CurrencyBUnearnableBeforeMaxQuantityStart", Type = "CurrencyFlagsB", EnumValue = 512 }, + { Name = "CurrencyBAllowReductionByResourcefulness", Type = "CurrencyFlagsB", EnumValue = 1024 }, + }, + }, + { + Name = "CurrencyGainFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "CurrencyGainFlags", EnumValue = 0 }, + { Name = "BonusAward", Type = "CurrencyGainFlags", EnumValue = 1 }, + { Name = "DroppedFromDeath", Type = "CurrencyGainFlags", EnumValue = 2 }, + { Name = "FromAccountServer", Type = "CurrencyGainFlags", EnumValue = 4 }, + { Name = "Autotracking", Type = "CurrencyGainFlags", EnumValue = 8 }, + }, + }, + { + Name = "CurrencyTokenCategoryFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "FlagSortLast", Type = "CurrencyTokenCategoryFlags", EnumValue = 1 }, + { Name = "FlagPlayerItemAssignment", Type = "CurrencyTokenCategoryFlags", EnumValue = 2 }, + { Name = "Hidden", Type = "CurrencyTokenCategoryFlags", EnumValue = 4 }, + { Name = "Virtual", Type = "CurrencyTokenCategoryFlags", EnumValue = 8 }, + { Name = "StartsCollapsed", Type = "CurrencyTokenCategoryFlags", EnumValue = 16 }, + }, + }, + { + Name = "LinkedCurrencyFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "IgnoreAdd", Type = "LinkedCurrencyFlags", EnumValue = 1 }, + { Name = "IgnoreSubtract", Type = "LinkedCurrencyFlags", EnumValue = 2 }, + { Name = "SuppressChatLog", Type = "LinkedCurrencyFlags", EnumValue = 4 }, + { Name = "AddIgnoresMax", Type = "LinkedCurrencyFlags", EnumValue = 8 }, + }, + }, + { + Name = "PlayerCurrencyFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "Incremented", Type = "PlayerCurrencyFlags", EnumValue = 1 }, + { Name = "Loading", Type = "PlayerCurrencyFlags", EnumValue = 2 }, + }, + }, + { + Name = "PlayerCurrencyFlagsDbFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "IgnoreMaxQtyOnload", Type = "PlayerCurrencyFlagsDbFlags", EnumValue = 1 }, + { Name = "Reuse1", Type = "PlayerCurrencyFlagsDbFlags", EnumValue = 2 }, + { Name = "InBackpack", Type = "PlayerCurrencyFlagsDbFlags", EnumValue = 4 }, + { Name = "UnusedInUI", Type = "PlayerCurrencyFlagsDbFlags", EnumValue = 8 }, + { Name = "Reuse2", Type = "PlayerCurrencyFlagsDbFlags", EnumValue = 16 }, + }, + }, + { + Name = "CurrencyConsts", + Type = "Constants", + Values = + { + { Name = "PLAYER_CURRENCY_CLIENT_FLAGS", Type = "PlayerCurrencyFlagsDbFlags", Value = Enum.PlayerCurrencyFlagsDbFlags.InBackpack + Enum.PlayerCurrencyFlagsDbFlags.UnusedInUI }, + { Name = "MAX_CURRENCY_QUANTITY", Type = "number", Value = 100000000 }, + { Name = "CONQUEST_ARENA_AND_BG_META_CURRENCY_ID", Type = "number", Value = 483 }, + { Name = "CONQUEST_RATED_BG_META_CURRENCY_ID", Type = "number", Value = 484 }, + { Name = "CONQUEST_ASHRAN_META_CURRENCY_ID", Type = "number", Value = 692 }, + { Name = "ACCOUNT_WIDE_HONOR_CURRENCY_ID", Type = "number", Value = 1585 }, + { Name = "ACCOUNT_WIDE_HONOR_LEVEL_CURRENCY_ID", Type = "number", Value = 1586 }, + { Name = "CONQUEST_CURRENCY_ID", Type = "number", Value = 1602 }, + { Name = "CONQUEST_POINTS_CURRENCY_ID", Type = "number", Value = 390 }, + { Name = "CONQUEST_ARENA_META_CURRENCY_ID", Type = "number", Value = 483 }, + { Name = "CONQUEST_BG_META_CURRENCY_ID", Type = "number", Value = 484 }, + { Name = "HONOR_CURRENCY_ID", Type = "number", Value = 1792 }, + { Name = "ARTIFACT_KNOWLEDGE_CURRENCY_ID", Type = "number", Value = 1171 }, + { Name = "WAR_RESOURCES_CURRENCY_ID", Type = "number", Value = 1560 }, + { Name = "ECHOES_OF_NYALOTHA_CURRENCY_ID", Type = "number", Value = 1803 }, + { Name = "DRAGON_ISLES_SUPPLIES_CURRENCY_ID", Type = "number", Value = 2003 }, + { Name = "QUESTIONMARK_INV_ICON", Type = "number", Value = 134400 }, + { Name = "PVP_CURRENCY_CONQUEST_ALLIANCE_INV_ICON", Type = "number", Value = 463448 }, + { Name = "PVP_CURRENCY_CONQUEST_HORDE_INV_ICON", Type = "number", Value = 463449 }, + { Name = "PVP_CURRENCY_HONOR_ALLIANCE_INV_ICON", Type = "number", Value = 463450 }, + { Name = "PVP_CURRENCY_HONOR_HORDE_INV_ICON", Type = "number", Value = 463451 }, + { Name = "CURRENCY_ID_RENOWN", Type = "number", Value = 1822 }, + { Name = "CURRENCY_ID_RENOWN_KYRIAN", Type = "number", Value = 1829 }, + { Name = "CURRENCY_ID_RENOWN_VENTHYR", Type = "number", Value = 1830 }, + { Name = "CURRENCY_ID_RENOWN_NIGHT_FAE", Type = "number", Value = 1831 }, + { Name = "CURRENCY_ID_RENOWN_NECROLORD", Type = "number", Value = 1832 }, + { Name = "CURRENCY_ID_WILLING_SOUL", Type = "number", Value = 1810 }, + { Name = "CURRENCY_ID_RESERVOIR_ANIMA", Type = "number", Value = 1813 }, + { Name = "CURRENCY_ID_PERKS_PROGRAM_DISPLAY_INFO", Type = "number", Value = 2032 }, + { Name = "CURRENCY_WALLET_TYPE_WOWMONEY", Type = "number", Value = 0 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CurrencyConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstants_MainlineDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstants_MainlineDocumentation.lua.annotated.lua new file mode 100644 index 0000000..990a2cc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyConstants_MainlineDocumentation.lua.annotated.lua @@ -0,0 +1,113 @@ +local CurrencyConstants_Mainline = +{ + Tables = + { + { + Name = "CurrencyDestroyReason", + Type = "Enumeration", + NumValues = 17, + MinValue = 0, + MaxValue = 16, + Fields = + { + { Name = "Cheat", Type = "CurrencyDestroyReason", EnumValue = 0 }, + { Name = "Spell", Type = "CurrencyDestroyReason", EnumValue = 1 }, + { Name = "VersionUpdate", Type = "CurrencyDestroyReason", EnumValue = 2 }, + { Name = "QuestTurnin", Type = "CurrencyDestroyReason", EnumValue = 3 }, + { Name = "Vendor", Type = "CurrencyDestroyReason", EnumValue = 4 }, + { Name = "Trade", Type = "CurrencyDestroyReason", EnumValue = 5 }, + { Name = "Capped", Type = "CurrencyDestroyReason", EnumValue = 6 }, + { Name = "Garrison", Type = "CurrencyDestroyReason", EnumValue = 7 }, + { Name = "DroppedToCorpse", Type = "CurrencyDestroyReason", EnumValue = 8 }, + { Name = "BonusRoll", Type = "CurrencyDestroyReason", EnumValue = 9 }, + { Name = "FactionConversion", Type = "CurrencyDestroyReason", EnumValue = 10 }, + { Name = "FulfillCraftingOrder", Type = "CurrencyDestroyReason", EnumValue = 11 }, + { Name = "Script", Type = "CurrencyDestroyReason", EnumValue = 12 }, + { Name = "ConcentrationCast", Type = "CurrencyDestroyReason", EnumValue = 13 }, + { Name = "AccountTransfer", Type = "CurrencyDestroyReason", EnumValue = 14 }, + { Name = "HonorLoss", Type = "CurrencyDestroyReason", EnumValue = 15 }, + { Name = "CraftingOrderReagent", Type = "CurrencyDestroyReason", EnumValue = 16 }, + }, + }, + { + Name = "CurrencySource", + Type = "Enumeration", + NumValues = 68, + MinValue = 0, + MaxValue = 67, + Fields = + { + { Name = "ConvertOldItem", Type = "CurrencySource", EnumValue = 0 }, + { Name = "ConvertOldPvPCurrency", Type = "CurrencySource", EnumValue = 1 }, + { Name = "ItemRefund", Type = "CurrencySource", EnumValue = 2 }, + { Name = "QuestReward", Type = "CurrencySource", EnumValue = 3 }, + { Name = "Cheat", Type = "CurrencySource", EnumValue = 4 }, + { Name = "Vendor", Type = "CurrencySource", EnumValue = 5 }, + { Name = "PvPKillCredit", Type = "CurrencySource", EnumValue = 6 }, + { Name = "PvPMetaCredit", Type = "CurrencySource", EnumValue = 7 }, + { Name = "PvPScriptedAward", Type = "CurrencySource", EnumValue = 8 }, + { Name = "Loot", Type = "CurrencySource", EnumValue = 9 }, + { Name = "UpdatingVersion", Type = "CurrencySource", EnumValue = 10 }, + { Name = "LFGReward", Type = "CurrencySource", EnumValue = 11 }, + { Name = "Trade", Type = "CurrencySource", EnumValue = 12 }, + { Name = "Spell", Type = "CurrencySource", EnumValue = 13 }, + { Name = "ItemDeletion", Type = "CurrencySource", EnumValue = 14 }, + { Name = "RatedBattleground", Type = "CurrencySource", EnumValue = 15 }, + { Name = "RandomBattleground", Type = "CurrencySource", EnumValue = 16 }, + { Name = "Arena", Type = "CurrencySource", EnumValue = 17 }, + { Name = "ExceededMaxQty", Type = "CurrencySource", EnumValue = 18 }, + { Name = "PvPCompletionBonus", Type = "CurrencySource", EnumValue = 19 }, + { Name = "Script", Type = "CurrencySource", EnumValue = 20 }, + { Name = "GuildBankWithdrawal", Type = "CurrencySource", EnumValue = 21 }, + { Name = "Pushloot", Type = "CurrencySource", EnumValue = 22 }, + { Name = "GarrisonBuilding", Type = "CurrencySource", EnumValue = 23 }, + { Name = "PvPDrop", Type = "CurrencySource", EnumValue = 24 }, + { Name = "GarrisonFollowerActivation", Type = "CurrencySource", EnumValue = 25 }, + { Name = "GarrisonBuildingRefund", Type = "CurrencySource", EnumValue = 26 }, + { Name = "GarrisonMissionReward", Type = "CurrencySource", EnumValue = 27 }, + { Name = "GarrisonResourceOverTime", Type = "CurrencySource", EnumValue = 28 }, + { Name = "CurrencyWalletClaim", Type = "CurrencySource", EnumValue = 29 }, + { Name = "GarrisonTalent", Type = "CurrencySource", EnumValue = 30 }, + { Name = "GarrisonWorldQuestBonus", Type = "CurrencySource", EnumValue = 31 }, + { Name = "PvPHonorReward", Type = "CurrencySource", EnumValue = 32 }, + { Name = "BonusRoll", Type = "CurrencySource", EnumValue = 33 }, + { Name = "AzeriteRespec", Type = "CurrencySource", EnumValue = 34 }, + { Name = "WorldQuestReward", Type = "CurrencySource", EnumValue = 35 }, + { Name = "WorldQuestRewardIgnoreCapsDeprecated", Type = "CurrencySource", EnumValue = 36 }, + { Name = "FactionConversion", Type = "CurrencySource", EnumValue = 37 }, + { Name = "DailyQuestReward", Type = "CurrencySource", EnumValue = 38 }, + { Name = "DailyQuestWarModeReward", Type = "CurrencySource", EnumValue = 39 }, + { Name = "WeeklyQuestReward", Type = "CurrencySource", EnumValue = 40 }, + { Name = "WeeklyQuestWarModeReward", Type = "CurrencySource", EnumValue = 41 }, + { Name = "AccountCopy", Type = "CurrencySource", EnumValue = 42 }, + { Name = "WeeklyRewardChest", Type = "CurrencySource", EnumValue = 43 }, + { Name = "GarrisonTalentTreeReset", Type = "CurrencySource", EnumValue = 44 }, + { Name = "DailyReset", Type = "CurrencySource", EnumValue = 45 }, + { Name = "AddConduitToCollection", Type = "CurrencySource", EnumValue = 46 }, + { Name = "Barbershop", Type = "CurrencySource", EnumValue = 47 }, + { Name = "ConvertItemsToCurrencyValue", Type = "CurrencySource", EnumValue = 48 }, + { Name = "PvPTeamContribution", Type = "CurrencySource", EnumValue = 49 }, + { Name = "Transmogrify", Type = "CurrencySource", EnumValue = 50 }, + { Name = "AuctionDeposit", Type = "CurrencySource", EnumValue = 51 }, + { Name = "PlayerTrait", Type = "CurrencySource", EnumValue = 52 }, + { Name = "PhBuffer_53", Type = "CurrencySource", EnumValue = 53 }, + { Name = "PhBuffer_54", Type = "CurrencySource", EnumValue = 54 }, + { Name = "RenownRepGain", Type = "CurrencySource", EnumValue = 55 }, + { Name = "CraftingOrder", Type = "CurrencySource", EnumValue = 56 }, + { Name = "CatalystBalancing", Type = "CurrencySource", EnumValue = 57 }, + { Name = "CatalystCraft", Type = "CurrencySource", EnumValue = 58 }, + { Name = "ProfessionInitialAward", Type = "CurrencySource", EnumValue = 59 }, + { Name = "PlayerTraitRefund", Type = "CurrencySource", EnumValue = 60 }, + { Name = "AccountHwmUpdate", Type = "CurrencySource", EnumValue = 61 }, + { Name = "ConvertItemsToCurrencyAndReputation", Type = "CurrencySource", EnumValue = 62 }, + { Name = "PhBuffer_63", Type = "CurrencySource", EnumValue = 63 }, + { Name = "SpellSkipLinkedCurrency", Type = "CurrencySource", EnumValue = 64 }, + { Name = "AccountTransfer", Type = "CurrencySource", EnumValue = 65 }, + { Name = "RenownRepGainInitialVisibility", Type = "CurrencySource", EnumValue = 66 }, + { Name = "InitiativeReward", Type = "CurrencySource", EnumValue = 67 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CurrencyConstants_Mainline); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..60412ee --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurrencyInfoDocumentation.lua.annotated.lua @@ -0,0 +1,742 @@ +local CurrencyInfo = +{ + Name = "CurrencySystem", + Type = "System", + Namespace = "C_CurrencyInfo", + Environment = "All", + + Functions = + { + { + Name = "CanTransferCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canTransferCurrency", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "AccountCurrencyTransferResult", Nilable = true }, + }, + }, + { + Name = "DoesCurrentFilterRequireAccountCurrencyData", + Type = "Function", + + Returns = + { + { Name = "doesCurrentFilterRequireAccountCurrencyData", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesWarModeBonusApply", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "warModeApplies", Type = "bool", Nilable = true }, + { Name = "limitOncePerTooltip", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ExpandCurrencyList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "expand", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FetchCurrencyDataFromAccountCharacters", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "accountCurrencyData", Type = "table", InnerType = "CharacterCurrencyData", Nilable = false }, + }, + }, + { + Name = "FetchCurrencyTransferTransactions", + Type = "Function", + + Returns = + { + { Name = "currencyTransferTransactions", Type = "table", InnerType = "CurrencyTransferTransaction", Nilable = false }, + }, + }, + { + Name = "GetAzeriteCurrencyID", + Type = "Function", + + Returns = + { + { Name = "azeriteCurrencyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBackpackCurrencyInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "BackpackCurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetBasicCurrencyInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyType", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "info", Type = "CurrencyDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetCoinIcon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetCoinText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + { Name = "separator", Type = "cstring", Nilable = false, Default = ", " }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCoinTextureString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + { Name = "fontHeight", Type = "number", Nilable = false, Default = 14 }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCostToTransferCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "totalQuantityConsumed", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrencyContainerInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyType", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CurrencyDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetCurrencyDescription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCurrencyFilter", + Type = "Function", + + Returns = + { + { Name = "filterType", Type = "CurrencyFilterType", Nilable = false }, + }, + }, + { + Name = "GetCurrencyIDFromLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyLink", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrencyInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetCurrencyInfoFromLink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "link", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetCurrencyLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCurrencyListInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetCurrencyListLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCurrencyListSize", + Type = "Function", + + Returns = + { + { Name = "currencyListSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDragonIslesSuppliesCurrencyID", + Type = "Function", + + Returns = + { + { Name = "dragonIslesSuppliesCurrencyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFactionGrantedByCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Gets the faction ID for currency that is immediately converted into reputation with that faction instead." }, + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "factionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMaxTransferableAmountFromQuantity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "requestedQuantity", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "maxTransferableAmount", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPlayerCurrencyCategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "includeAccountWide", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "info", Type = "PlayerCurrencyCategoryInfo", Nilable = false }, + }, + }, + { + Name = "GetWarResourcesCurrencyID", + Type = "Function", + + Returns = + { + { Name = "warResourceCurrencyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsAccountCharacterCurrencyDataReady", + Type = "Function", + + Returns = + { + { Name = "isReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAccountTransferableCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAccountTransferableCurrency", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAccountWideCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAccountWideCurrency", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrencyContainer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCurrencyContainer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrencyTransferInProgress", + Type = "Function", + + Returns = + { + { Name = "currencyTransferInProgress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrencyTransferTransactionDataReady", + Type = "Function", + + Returns = + { + { Name = "isReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerHasMaxQuantity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasMaxQuantity", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerHasMaxWeeklyQuantity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasMaxWeeklyQuantity", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestCurrencyDataForAccountCharacters", + Type = "Function", + }, + { + Name = "RequestCurrencyFromAccountCharacter", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceCharacterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCurrencyBackpack", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "backpack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCurrencyBackpackByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyType", Type = "number", Nilable = false }, + { Name = "backpack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCurrencyFilter", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterType", Type = "CurrencyFilterType", Nilable = false }, + }, + }, + { + Name = "SetCurrencyUnused", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "unused", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AccountCharacterCurrencyDataReceived", + Type = "Event", + LiteralName = "ACCOUNT_CHARACTER_CURRENCY_DATA_RECEIVED", + SynchronousEvent = true, + }, + { + Name = "AccountMoney", + Type = "Event", + LiteralName = "ACCOUNT_MONEY", + SynchronousEvent = true, + }, + { + Name = "CurrencyDisplayUpdate", + Type = "Event", + LiteralName = "CURRENCY_DISPLAY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "currencyType", Type = "number", Nilable = true }, + { Name = "quantity", Type = "number", Nilable = true }, + { Name = "quantityChange", Type = "number", Nilable = true }, + { Name = "quantityGainSource", Type = "number", Nilable = true }, + { Name = "destroyReason", Type = "number", Nilable = true }, + }, + }, + { + Name = "CurrencyTransferFailed", + Type = "Event", + LiteralName = "CURRENCY_TRANSFER_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "failureReason", Type = "AccountCurrencyTransferResult", Nilable = false }, + }, + }, + { + Name = "CurrencyTransferInitiated", + Type = "Event", + LiteralName = "CURRENCY_TRANSFER_INITIATED", + SynchronousEvent = true, + }, + { + Name = "CurrencyTransferLogUpdate", + Type = "Event", + LiteralName = "CURRENCY_TRANSFER_LOG_UPDATE", + SynchronousEvent = true, + }, + { + Name = "CurrencyTransferSuccess", + Type = "Event", + LiteralName = "CURRENCY_TRANSFER_SUCCESS", + SynchronousEvent = true, + }, + { + Name = "PlayerMoney", + Type = "Event", + LiteralName = "PLAYER_MONEY", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "BackpackCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "currencyTypesID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CharacterCurrencyData", + Type = "Structure", + Fields = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "characterName", Type = "string", Nilable = false }, + { Name = "fullCharacterName", Type = "string", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "CurrencyDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "displayAmount", Type = "number", Nilable = false }, + { Name = "actualAmount", Type = "number", Nilable = false }, + }, + }, + { + Name = "CurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "isHeaderExpanded", Type = "bool", Nilable = false }, + { Name = "currencyListDepth", Type = "number", Nilable = false }, + { Name = "isTypeUnused", Type = "bool", Nilable = false }, + { Name = "isShowInBackpack", Type = "bool", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "trackedQuantity", Type = "number", Nilable = false }, + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "maxQuantity", Type = "number", Nilable = false }, + { Name = "canEarnPerWeek", Type = "bool", Nilable = false }, + { Name = "quantityEarnedThisWeek", Type = "number", Nilable = false }, + { Name = "isTradeable", Type = "bool", Nilable = false }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + { Name = "maxWeeklyQuantity", Type = "number", Nilable = false }, + { Name = "totalEarned", Type = "number", Nilable = false }, + { Name = "discovered", Type = "bool", Nilable = false }, + { Name = "useTotalEarnedForMaxQty", Type = "bool", Nilable = false }, + { Name = "isAccountWide", Type = "bool", Nilable = false }, + { Name = "isAccountTransferable", Type = "bool", Nilable = false }, + { Name = "transferPercentage", Type = "number", Nilable = true }, + { Name = "rechargingCycleDurationMS", Type = "number", Nilable = false }, + { Name = "rechargingAmountPerCycle", Type = "number", Nilable = false }, + }, + }, + { + Name = "CurrencyTransferTransaction", + Type = "Structure", + Fields = + { + { Name = "sourceCharacterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "sourceCharacterName", Type = "string", Nilable = false, Default = "" }, + { Name = "fullSourceCharacterName", Type = "string", Nilable = false, Default = "" }, + { Name = "destinationCharacterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "destinationCharacterName", Type = "string", Nilable = false, Default = "" }, + { Name = "fullDestinationCharacterName", Type = "string", Nilable = false, Default = "" }, + { Name = "currencyType", Type = "number", Nilable = false }, + { Name = "quantityTransferred", Type = "number", Nilable = false }, + { Name = "totalQuantityConsumed", Type = "number", Nilable = false }, + { Name = "timestamp", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "PlayerCurrencyCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "categoryName", Type = "cstring", Nilable = false }, + { Name = "currencyTypes", Type = "table", InnerType = "number", Nilable = false }, + { Name = "childCategories", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CurrencyInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorConstDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorConstDocumentation.lua.annotated.lua new file mode 100644 index 0000000..39eee2b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorConstDocumentation.lua.annotated.lua @@ -0,0 +1,168 @@ +local CursorConst = +{ + Tables = + { + { + Name = "CursorStyle", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Mouse", Type = "CursorStyle", EnumValue = 0 }, + { Name = "Crosshair", Type = "CursorStyle", EnumValue = 1 }, + }, + }, + { + Name = "Cursormode", + Type = "Enumeration", + NumValues = 92, + MinValue = 0, + MaxValue = 91, + Fields = + { + { Name = "NoCursor", Type = "Cursormode", EnumValue = 0 }, + { Name = "PointCursor", Type = "Cursormode", EnumValue = 1 }, + { Name = "CastCursor", Type = "Cursormode", EnumValue = 2 }, + { Name = "BuyCursor", Type = "Cursormode", EnumValue = 3 }, + { Name = "AttackCursor", Type = "Cursormode", EnumValue = 4 }, + { Name = "InteractCursor", Type = "Cursormode", EnumValue = 5 }, + { Name = "SpeakCursor", Type = "Cursormode", EnumValue = 6 }, + { Name = "InspectCursor", Type = "Cursormode", EnumValue = 7 }, + { Name = "PickupCursor", Type = "Cursormode", EnumValue = 8 }, + { Name = "TaxiCursor", Type = "Cursormode", EnumValue = 9 }, + { Name = "TrainerCursor", Type = "Cursormode", EnumValue = 10 }, + { Name = "MineCursor", Type = "Cursormode", EnumValue = 11 }, + { Name = "SkinCursor", Type = "Cursormode", EnumValue = 12 }, + { Name = "GatherCursor", Type = "Cursormode", EnumValue = 13 }, + { Name = "LockCursor", Type = "Cursormode", EnumValue = 14 }, + { Name = "MailCursor", Type = "Cursormode", EnumValue = 15 }, + { Name = "LootAllCursor", Type = "Cursormode", EnumValue = 16 }, + { Name = "RepairCursor", Type = "Cursormode", EnumValue = 17 }, + { Name = "RepairnpcCursor", Type = "Cursormode", EnumValue = 18 }, + { Name = "ItemCursor", Type = "Cursormode", EnumValue = 19 }, + { Name = "SkinHordeCursor", Type = "Cursormode", EnumValue = 20 }, + { Name = "SkinAllianceCursor", Type = "Cursormode", EnumValue = 21 }, + { Name = "InnkeeperCursor", Type = "Cursormode", EnumValue = 22 }, + { Name = "CampaignQuestCursor", Type = "Cursormode", EnumValue = 23 }, + { Name = "CampaignQuestTurninCursor", Type = "Cursormode", EnumValue = 24 }, + { Name = "QuestCursor", Type = "Cursormode", EnumValue = 25 }, + { Name = "QuestRepeatableCursor", Type = "Cursormode", EnumValue = 26 }, + { Name = "QuestTurninCursor", Type = "Cursormode", EnumValue = 27 }, + { Name = "QuestLegendaryCursor", Type = "Cursormode", EnumValue = 28 }, + { Name = "QuestLegendaryTurninCursor", Type = "Cursormode", EnumValue = 29 }, + { Name = "QuestImportantCursor", Type = "Cursormode", EnumValue = 30 }, + { Name = "QuestImportantTurninCursor", Type = "Cursormode", EnumValue = 31 }, + { Name = "QuestMetaCursor", Type = "Cursormode", EnumValue = 32 }, + { Name = "QuestMetaTurninCursor", Type = "Cursormode", EnumValue = 33 }, + { Name = "QuestRecurringCursor", Type = "Cursormode", EnumValue = 34 }, + { Name = "QuestRecurringTurninCursor", Type = "Cursormode", EnumValue = 35 }, + { Name = "VehicleCursor", Type = "Cursormode", EnumValue = 36 }, + { Name = "MapPinCursor", Type = "Cursormode", EnumValue = 37 }, + { Name = "PingCursor", Type = "Cursormode", EnumValue = 38 }, + { Name = "EnchantCursor", Type = "Cursormode", EnumValue = 39 }, + { Name = "StablemasterCursor", Type = "Cursormode", EnumValue = 40 }, + { Name = "PaletteCursor", Type = "Cursormode", EnumValue = 41 }, + { Name = "BroomCursor", Type = "Cursormode", EnumValue = 42 }, + { Name = "HoldingHandCursor", Type = "Cursormode", EnumValue = 43 }, + { Name = "GrabbingHandCursor", Type = "Cursormode", EnumValue = 44 }, + { Name = "UIMoveCursor", Type = "Cursormode", EnumValue = 45 }, + { Name = "UIResizeCursor", Type = "Cursormode", EnumValue = 46 }, + { Name = "PointErrorCursor", Type = "Cursormode", EnumValue = 47 }, + { Name = "CastErrorCursor", Type = "Cursormode", EnumValue = 48 }, + { Name = "BuyErrorCursor", Type = "Cursormode", EnumValue = 49 }, + { Name = "AttackErrorCursor", Type = "Cursormode", EnumValue = 50 }, + { Name = "InteractErrorCursor", Type = "Cursormode", EnumValue = 51 }, + { Name = "SpeakErrorCursor", Type = "Cursormode", EnumValue = 52 }, + { Name = "InspectErrorCursor", Type = "Cursormode", EnumValue = 53 }, + { Name = "PickupErrorCursor", Type = "Cursormode", EnumValue = 54 }, + { Name = "TaxiErrorCursor", Type = "Cursormode", EnumValue = 55 }, + { Name = "TrainerErrorCursor", Type = "Cursormode", EnumValue = 56 }, + { Name = "MineErrorCursor", Type = "Cursormode", EnumValue = 57 }, + { Name = "SkinErrorCursor", Type = "Cursormode", EnumValue = 58 }, + { Name = "GatherErrorCursor", Type = "Cursormode", EnumValue = 59 }, + { Name = "LockErrorCursor", Type = "Cursormode", EnumValue = 60 }, + { Name = "MailErrorCursor", Type = "Cursormode", EnumValue = 61 }, + { Name = "LootAllErrorCursor", Type = "Cursormode", EnumValue = 62 }, + { Name = "RepairErrorCursor", Type = "Cursormode", EnumValue = 63 }, + { Name = "RepairnpcErrorCursor", Type = "Cursormode", EnumValue = 64 }, + { Name = "ItemErrorCursor", Type = "Cursormode", EnumValue = 65 }, + { Name = "SkinHordeErrorCursor", Type = "Cursormode", EnumValue = 66 }, + { Name = "SkinAllianceErrorCursor", Type = "Cursormode", EnumValue = 67 }, + { Name = "InnkeeperErrorCursor", Type = "Cursormode", EnumValue = 68 }, + { Name = "CampaignQuestErrorCursor", Type = "Cursormode", EnumValue = 69 }, + { Name = "CampaignQuestTurninErrorCursor", Type = "Cursormode", EnumValue = 70 }, + { Name = "QuestErrorCursor", Type = "Cursormode", EnumValue = 71 }, + { Name = "QuestRepeatableErrorCursor", Type = "Cursormode", EnumValue = 72 }, + { Name = "QuestTurninErrorCursor", Type = "Cursormode", EnumValue = 73 }, + { Name = "QuestLegendaryErrorCursor", Type = "Cursormode", EnumValue = 74 }, + { Name = "QuestLegendaryTurninErrorCursor", Type = "Cursormode", EnumValue = 75 }, + { Name = "QuestImportantErrorCursor", Type = "Cursormode", EnumValue = 76 }, + { Name = "QuestImportantTurninErrorCursor", Type = "Cursormode", EnumValue = 77 }, + { Name = "QuestMetaErrorCursor", Type = "Cursormode", EnumValue = 78 }, + { Name = "QuestMetaTurninErrorCursor", Type = "Cursormode", EnumValue = 79 }, + { Name = "QuestRecurringErrorCursor", Type = "Cursormode", EnumValue = 80 }, + { Name = "QuestRecurringTurninErrorCursor", Type = "Cursormode", EnumValue = 81 }, + { Name = "VehicleErrorCursor", Type = "Cursormode", EnumValue = 82 }, + { Name = "MapPinErrorCursor", Type = "Cursormode", EnumValue = 83 }, + { Name = "PingErrorCursor", Type = "Cursormode", EnumValue = 84 }, + { Name = "EnchantErrorCursor", Type = "Cursormode", EnumValue = 85 }, + { Name = "StablemasterErrorCursor", Type = "Cursormode", EnumValue = 86 }, + { Name = "PaletteErrorCursor", Type = "Cursormode", EnumValue = 87 }, + { Name = "BroomErrorCursor", Type = "Cursormode", EnumValue = 88 }, + { Name = "HoldingHandErrorCursor", Type = "Cursormode", EnumValue = 89 }, + { Name = "GrabbingHandErrorCursor", Type = "Cursormode", EnumValue = 90 }, + { Name = "CustomCursor", Type = "Cursormode", EnumValue = 91 }, + }, + }, + { + Name = "UICursorType", + Type = "Enumeration", + NumValues = 22, + MinValue = 0, + MaxValue = 21, + Fields = + { + { Name = "Default", Type = "UICursorType", EnumValue = 0 }, + { Name = "Item", Type = "UICursorType", EnumValue = 1 }, + { Name = "Money", Type = "UICursorType", EnumValue = 2 }, + { Name = "Spell", Type = "UICursorType", EnumValue = 3 }, + { Name = "PetAction", Type = "UICursorType", EnumValue = 4 }, + { Name = "Merchant", Type = "UICursorType", EnumValue = 5 }, + { Name = "ActionBar", Type = "UICursorType", EnumValue = 6 }, + { Name = "Macro", Type = "UICursorType", EnumValue = 7 }, + { Name = "AmmoObsolete", Type = "UICursorType", EnumValue = 8 }, + { Name = "Pet", Type = "UICursorType", EnumValue = 9 }, + { Name = "GuildBank", Type = "UICursorType", EnumValue = 10 }, + { Name = "GuildBankMoney", Type = "UICursorType", EnumValue = 11 }, + { Name = "EquipmentSet", Type = "UICursorType", EnumValue = 12 }, + { Name = "Currency", Type = "UICursorType", EnumValue = 13 }, + { Name = "Flyout", Type = "UICursorType", EnumValue = 14 }, + { Name = "VoidItem", Type = "UICursorType", EnumValue = 15 }, + { Name = "BattlePet", Type = "UICursorType", EnumValue = 16 }, + { Name = "Mount", Type = "UICursorType", EnumValue = 17 }, + { Name = "Toy", Type = "UICursorType", EnumValue = 18 }, + { Name = "ConduitCollectionItem", Type = "UICursorType", EnumValue = 19 }, + { Name = "PerksProgramVendorItem", Type = "UICursorType", EnumValue = 20 }, + { Name = "Outfit", Type = "UICursorType", EnumValue = 21 }, + }, + }, + { + Name = "WorldCursorAnchorType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "WorldCursorAnchorType", EnumValue = 0 }, + { Name = "Default", Type = "WorldCursorAnchorType", EnumValue = 1 }, + { Name = "Cursor", Type = "WorldCursorAnchorType", EnumValue = 2 }, + { Name = "Nameplate", Type = "WorldCursorAnchorType", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CursorConst); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ace6e54 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorDocumentation.lua.annotated.lua @@ -0,0 +1,67 @@ +local Cursor = +{ + Name = "Cursor", + Type = "System", + Namespace = "C_Cursor", + Environment = "All", + + Functions = + { + { + Name = "GetCursorItem", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BattlePetCursorClear", + Type = "Event", + LiteralName = "BATTLE_PET_CURSOR_CLEAR", + SynchronousEvent = true, + }, + { + Name = "CursorChanged", + Type = "Event", + LiteralName = "CURSOR_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isDefault", Type = "bool", Nilable = false }, + { Name = "newCursorType", Type = "UICursorType", Nilable = false }, + { Name = "oldCursorType", Type = "UICursorType", Nilable = false }, + { Name = "oldCursorVirtualID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MountCursorClear", + Type = "Event", + LiteralName = "MOUNT_CURSOR_CLEAR", + SynchronousEvent = true, + }, + { + Name = "WorldCursorTooltipUpdate", + Type = "Event", + LiteralName = "WORLD_CURSOR_TOOLTIP_UPDATE", + SynchronousEvent = true, + Documentation = { "Sends an update when the mouse enters or leaves something in-world (object, unit, etc) that should display a tooltip" }, + Payload = + { + { Name = "anchorType", Type = "WorldCursorAnchorType", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Cursor); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0b373f0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CursorUtilDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local CursorUtil = +{ + Name = "CursorUtil", + Type = "System", + Namespace = "C_CursorUtil", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CursorUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..16175b1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/CurveUtilDocumentation.lua.annotated.lua @@ -0,0 +1,93 @@ +local CurveUtil = +{ + Name = "CurveUtil", + Type = "System", + Namespace = "C_CurveUtil", + Environment = "All", + + Functions = + { + { + Name = "CreateColorCurve", + Type = "Function", + Documentation = { "Returns a new color curve object with no assigned points." }, + + Returns = + { + { Name = "curve", Type = "LuaColorCurveObject", Nilable = false }, + }, + }, + { + Name = "CreateCurve", + Type = "Function", + Documentation = { "Returns a new curve object with no assigned points." }, + + Returns = + { + { Name = "curve", Type = "LuaCurveObject", Nilable = false }, + }, + }, + { + Name = "EvaluateColorFromBoolean", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Evaluates a potentially-secret boolean value and returns a color." }, + + Arguments = + { + { Name = "boolean", Type = "bool", Nilable = false }, + { Name = "valueIfTrue", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + { Name = "valueIfFalse", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "EvaluateColorValueFromBoolean", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Evaluates a potentially-secret boolean value and returns a single color component (eg. alpha)." }, + + Arguments = + { + { Name = "boolean", Type = "bool", Nilable = false }, + { Name = "valueIfTrue", Type = "SingleColorValue", Nilable = false }, + { Name = "valueIfFalse", Type = "SingleColorValue", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "EvaluateGameCurve", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "curveID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "y", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(CurveUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ece42a4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,138 @@ +local DamageConstants = +{ + Tables = + { + { + Name = "Causeofdeath", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "None", Type = "Causeofdeath", EnumValue = 0 }, + { Name = "PlayerPvP", Type = "Causeofdeath", EnumValue = 1 }, + { Name = "PlayerDuel", Type = "Causeofdeath", EnumValue = 2 }, + { Name = "Creature", Type = "Causeofdeath", EnumValue = 3 }, + { Name = "Falling", Type = "Causeofdeath", EnumValue = 4 }, + { Name = "Drowning", Type = "Causeofdeath", EnumValue = 5 }, + { Name = "Fatigue", Type = "Causeofdeath", EnumValue = 6 }, + { Name = "Slime", Type = "Causeofdeath", EnumValue = 7 }, + { Name = "Lava", Type = "Causeofdeath", EnumValue = 8 }, + { Name = "Fire", Type = "Causeofdeath", EnumValue = 9 }, + }, + }, + { + Name = "CauseofdeathFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "NoneNeeded", Type = "CauseofdeathFlags", EnumValue = 0 }, + { Name = "PlayerNameNeeded", Type = "CauseofdeathFlags", EnumValue = 1 }, + { Name = "CreatureNameNeeded", Type = "CauseofdeathFlags", EnumValue = 2 }, + { Name = "ZoneNameNeeded", Type = "CauseofdeathFlags", EnumValue = 4 }, + }, + }, + { + Name = "Damageclass", + Type = "Enumeration", + NumValues = 46, + MinValue = 0, + MaxValue = 127, + Fields = + { + { Name = "Physical", Type = "Damageclass", EnumValue = 0 }, + { Name = "Holy", Type = "Damageclass", EnumValue = 1 }, + { Name = "Fire", Type = "Damageclass", EnumValue = 2 }, + { Name = "Nature", Type = "Damageclass", EnumValue = 3 }, + { Name = "Frost", Type = "Damageclass", EnumValue = 4 }, + { Name = "Shadow", Type = "Damageclass", EnumValue = 5 }, + { Name = "Arcane", Type = "Damageclass", EnumValue = 6 }, + { Name = "FirstResist", Type = "Damageclass", EnumValue = 2 }, + { Name = "LastResist", Type = "Damageclass", EnumValue = 6 }, + { Name = "MaskNone", Type = "Damageclass", EnumValue = 0 }, + { Name = "MaskPhysical", Type = "Damageclass", EnumValue = 1 }, + { Name = "MaskHoly", Type = "Damageclass", EnumValue = 2 }, + { Name = "MaskFire", Type = "Damageclass", EnumValue = 4 }, + { Name = "MaskNature", Type = "Damageclass", EnumValue = 8 }, + { Name = "MaskFrost", Type = "Damageclass", EnumValue = 16 }, + { Name = "MaskShadow", Type = "Damageclass", EnumValue = 32 }, + { Name = "MaskArcane", Type = "Damageclass", EnumValue = 64 }, + { Name = "AllPhysical", Type = "Damageclass", EnumValue = 1 }, + { Name = "AllMagical", Type = "Damageclass", EnumValue = 126 }, + { Name = "All", Type = "Damageclass", EnumValue = 127 }, + { Name = "MaskFlamestrike", Type = "Damageclass", EnumValue = 5 }, + { Name = "MaskFroststrike", Type = "Damageclass", EnumValue = 17 }, + { Name = "MaskSpellstrike", Type = "Damageclass", EnumValue = 65 }, + { Name = "MaskShadowstrike", Type = "Damageclass", EnumValue = 33 }, + { Name = "MaskStormstrike", Type = "Damageclass", EnumValue = 9 }, + { Name = "MaskHolystrike", Type = "Damageclass", EnumValue = 3 }, + { Name = "MaskFrostfire", Type = "Damageclass", EnumValue = 20 }, + { Name = "MaskSpellfire", Type = "Damageclass", EnumValue = 68 }, + { Name = "MaskFirestorm", Type = "Damageclass", EnumValue = 12 }, + { Name = "MaskShadowflame", Type = "Damageclass", EnumValue = 36 }, + { Name = "MaskHolyfire", Type = "Damageclass", EnumValue = 6 }, + { Name = "MaskSpellfrost", Type = "Damageclass", EnumValue = 80 }, + { Name = "MaskFroststorm", Type = "Damageclass", EnumValue = 24 }, + { Name = "MaskShadowfrost", Type = "Damageclass", EnumValue = 48 }, + { Name = "MaskHolyfrost", Type = "Damageclass", EnumValue = 18 }, + { Name = "MaskSpellstorm", Type = "Damageclass", EnumValue = 72 }, + { Name = "MaskSpellshadow", Type = "Damageclass", EnumValue = 96 }, + { Name = "MaskDivine", Type = "Damageclass", EnumValue = 66 }, + { Name = "MaskShadowstorm", Type = "Damageclass", EnumValue = 40 }, + { Name = "MaskHolystorm", Type = "Damageclass", EnumValue = 10 }, + { Name = "MaskTwilight", Type = "Damageclass", EnumValue = 34 }, + { Name = "MaskElemental", Type = "Damageclass", EnumValue = 28 }, + { Name = "MaskChromatic", Type = "Damageclass", EnumValue = 62 }, + { Name = "MaskMagical", Type = "Damageclass", EnumValue = 126 }, + { Name = "MaskChaos", Type = "Damageclass", EnumValue = 124 }, + { Name = "MaskCosmic", Type = "Damageclass", EnumValue = 106 }, + }, + }, + { + Name = "DamageclassType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Physical", Type = "DamageclassType", EnumValue = 0 }, + { Name = "Magical", Type = "DamageclassType", EnumValue = 1 }, + }, + }, + { + Name = "EnvironmentalDamageFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "OneTime", Type = "EnvironmentalDamageFlags", EnumValue = 1 }, + { Name = "DmgIsPct", Type = "EnvironmentalDamageFlags", EnumValue = 2 }, + }, + }, + { + Name = "Environmentaldamagetype", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Fatigue", Type = "Environmentaldamagetype", EnumValue = 0 }, + { Name = "Drowning", Type = "Environmentaldamagetype", EnumValue = 1 }, + { Name = "Falling", Type = "Environmentaldamagetype", EnumValue = 2 }, + { Name = "Lava", Type = "Environmentaldamagetype", EnumValue = 3 }, + { Name = "Slime", Type = "Environmentaldamagetype", EnumValue = 4 }, + { Name = "Fire", Type = "Environmentaldamagetype", EnumValue = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DamageConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ddd0c18 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,104 @@ +local DamageMeterConstants = +{ + Tables = + { + { + Name = "DamageMeterCombineSessionType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "DamageMeterCombineSessionType", EnumValue = 0 }, + { Name = "ChallengeMode", Type = "DamageMeterCombineSessionType", EnumValue = 1 }, + { Name = "Arena", Type = "DamageMeterCombineSessionType", EnumValue = 2 }, + }, + }, + { + Name = "DamageMeterOverrideType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Ignore", Type = "DamageMeterOverrideType", EnumValue = 0 }, + { Name = "AllowFriendlyFire", Type = "DamageMeterOverrideType", EnumValue = 1 }, + { Name = "RedirectSourceToOwner", Type = "DamageMeterOverrideType", EnumValue = 2 }, + { Name = "RedirectSourceToAuraCaster", Type = "DamageMeterOverrideType", EnumValue = 3 }, + { Name = "IgnoreForAbsorbSpell", Type = "DamageMeterOverrideType", EnumValue = 4 }, + }, + }, + { + Name = "DamageMeterSessionType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Overall", Type = "DamageMeterSessionType", EnumValue = 0 }, + { Name = "Current", Type = "DamageMeterSessionType", EnumValue = 1 }, + { Name = "Expired", Type = "DamageMeterSessionType", EnumValue = 2 }, + }, + }, + { + Name = "DamageMeterSpellDetailsDisplayType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "SpellCasted", Type = "DamageMeterSpellDetailsDisplayType", EnumValue = 0 }, + { Name = "UnitSpecificSpellCasted", Type = "DamageMeterSpellDetailsDisplayType", EnumValue = 1 }, + { Name = "SpellAffected", Type = "DamageMeterSpellDetailsDisplayType", EnumValue = 2 }, + { Name = "Deaths", Type = "DamageMeterSpellDetailsDisplayType", EnumValue = 3 }, + { Name = "EnemyDamageTaken", Type = "DamageMeterSpellDetailsDisplayType", EnumValue = 4 }, + }, + }, + { + Name = "DamageMeterStorageType", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Damage", Type = "DamageMeterStorageType", EnumValue = 0 }, + { Name = "HealingAndAbsorbs", Type = "DamageMeterStorageType", EnumValue = 1 }, + { Name = "Absorbs", Type = "DamageMeterStorageType", EnumValue = 2 }, + { Name = "Interrupts", Type = "DamageMeterStorageType", EnumValue = 3 }, + { Name = "Dispels", Type = "DamageMeterStorageType", EnumValue = 4 }, + { Name = "DamageTaken", Type = "DamageMeterStorageType", EnumValue = 5 }, + { Name = "AvoidableDamageTaken", Type = "DamageMeterStorageType", EnumValue = 6 }, + { Name = "Deaths", Type = "DamageMeterStorageType", EnumValue = 7 }, + { Name = "EnemyDamageTaken", Type = "DamageMeterStorageType", EnumValue = 8 }, + }, + }, + { + Name = "DamageMeterType", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "DamageDone", Type = "DamageMeterType", EnumValue = 0 }, + { Name = "Dps", Type = "DamageMeterType", EnumValue = 1 }, + { Name = "HealingDone", Type = "DamageMeterType", EnumValue = 2 }, + { Name = "Hps", Type = "DamageMeterType", EnumValue = 3 }, + { Name = "Absorbs", Type = "DamageMeterType", EnumValue = 4 }, + { Name = "Interrupts", Type = "DamageMeterType", EnumValue = 5 }, + { Name = "Dispels", Type = "DamageMeterType", EnumValue = 6 }, + { Name = "DamageTaken", Type = "DamageMeterType", EnumValue = 7 }, + { Name = "AvoidableDamageTaken", Type = "DamageMeterType", EnumValue = 8 }, + { Name = "Deaths", Type = "DamageMeterType", EnumValue = 9 }, + { Name = "EnemyDamageTaken", Type = "DamageMeterType", EnumValue = 10 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DamageMeterConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4ce7482 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DamageMeterDocumentation.lua.annotated.lua @@ -0,0 +1,246 @@ +local DamageMeter = +{ + Name = "DamageMeter", + Type = "System", + Namespace = "C_DamageMeter", + Environment = "All", + + Functions = + { + { + Name = "GetAvailableCombatSessions", + Type = "Function", + Documentation = { "Returns a list of combat sessions currently being tracked." }, + + Returns = + { + { Name = "availableSessions", Type = "table", InnerType = "DamageMeterAvailableCombatSession", Nilable = false }, + }, + }, + { + Name = "GetCombatSessionFromID", + Type = "Function", + SecretWhenInCombat = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the data for the player's combat session with the specified ID." }, + + Arguments = + { + { Name = "sessionID", Type = "number", Nilable = false }, + { Name = "type", Type = "DamageMeterType", Nilable = false }, + }, + + Returns = + { + { Name = "session", Type = "DamageMeterCombatSession", Nilable = false }, + }, + }, + { + Name = "GetCombatSessionFromType", + Type = "Function", + SecretWhenInCombat = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the data for the player's current combat session." }, + + Arguments = + { + { Name = "sessionType", Type = "DamageMeterSessionType", Nilable = false }, + { Name = "type", Type = "DamageMeterType", Nilable = false }, + }, + + Returns = + { + { Name = "session", Type = "DamageMeterCombatSession", Nilable = false }, + }, + }, + { + Name = "GetCombatSessionSourceFromID", + Type = "Function", + SecretWhenInCombat = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the data for a single source (unit) in the player's current combat session with the specified ID." }, + + Arguments = + { + { Name = "sessionID", Type = "number", Nilable = false }, + { Name = "type", Type = "DamageMeterType", Nilable = false }, + { Name = "sourceGUID", Type = "WOWGUID", Nilable = true }, + { Name = "sourceCreatureID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "sessionSource", Type = "DamageMeterCombatSessionSource", Nilable = false }, + }, + }, + { + Name = "GetCombatSessionSourceFromType", + Type = "Function", + SecretWhenInCombat = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the data for a single source (unit) in the player's current combat session." }, + + Arguments = + { + { Name = "sessionType", Type = "DamageMeterSessionType", Nilable = false }, + { Name = "type", Type = "DamageMeterType", Nilable = false }, + { Name = "sourceGUID", Type = "WOWGUID", Nilable = true }, + { Name = "sourceCreatureID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "sessionSource", Type = "DamageMeterCombatSessionSource", Nilable = false }, + }, + }, + { + Name = "GetSessionDurationSeconds", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the amount of time a combat session has lasted" }, + + Arguments = + { + { Name = "sessionType", Type = "DamageMeterSessionType", Nilable = false }, + }, + + Returns = + { + { Name = "durationSeconds", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsDamageMeterAvailable", + Type = "Function", + Documentation = { "Returns whether the player can enable and use the Damage Meter." }, + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "ResetAllCombatSessions", + Type = "Function", + Documentation = { "Clears the data for all the player's combat sessions." }, + }, + }, + + Events = + { + { + Name = "DamageMeterCombatSessionUpdated", + Type = "Event", + LiteralName = "DAMAGE_METER_COMBAT_SESSION_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "type", Type = "DamageMeterType", Nilable = false }, + { Name = "sessionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DamageMeterCurrentSessionUpdated", + Type = "Event", + LiteralName = "DAMAGE_METER_CURRENT_SESSION_UPDATED", + UniqueEvent = true, + }, + { + Name = "DamageMeterReset", + Type = "Event", + LiteralName = "DAMAGE_METER_RESET", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "DamageMeterAvailableCombatSession", + Type = "Structure", + Documentation = { "Data for a combat session currently being tracked." }, + Fields = + { + { Name = "sessionID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "durationSeconds", Type = "number", Nilable = true }, + }, + }, + { + Name = "DamageMeterCombatSession", + Type = "Structure", + Documentation = { "Aggregated data for all sources (units) in a damage meter combat session." }, + Fields = + { + { Name = "combatSources", Type = "table", InnerType = "DamageMeterCombatSource", Nilable = false }, + { Name = "maxAmount", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalAmount", Type = "number", Nilable = false, Default = 0 }, + { Name = "durationSeconds", Type = "number", Nilable = true }, + }, + }, + { + Name = "DamageMeterCombatSessionSource", + Type = "Structure", + Documentation = { "Data for a single source (unit) in a combat session." }, + Fields = + { + { Name = "combatSpells", Type = "table", InnerType = "DamageMeterCombatSpell", Nilable = false }, + { Name = "maxAmount", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalAmount", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "DamageMeterCombatSource", + Type = "Structure", + Documentation = { "Aggregated data for a single source (unit) in a damage meter combat session." }, + Fields = + { + { Name = "sourceGUID", Type = "WOWGUID", Nilable = true }, + { Name = "sourceCreatureID", Type = "number", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = false, ConditionalSecret = true }, + { Name = "classFilename", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "specIconID", Type = "fileID", Nilable = false, NeverSecret = true }, + { Name = "totalAmount", Type = "number", Nilable = false }, + { Name = "amountPerSecond", Type = "number", Nilable = false }, + { Name = "isLocalPlayer", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "deathRecapID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "deathTimeSeconds", Type = "number", Nilable = false }, + { Name = "classification", Type = "cstring", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "DamageMeterCombatSpell", + Type = "Structure", + Documentation = { "Aggregated data for all spells of the same ID cast by a single source (unit) in a combat session." }, + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "totalAmount", Type = "number", Nilable = false }, + { Name = "amountPerSecond", Type = "number", Nilable = false }, + { Name = "creatureName", Type = "cstring", Nilable = false }, + { Name = "overkillAmount", Type = "number", Nilable = false }, + { Name = "isAvoidable", Type = "bool", Nilable = false }, + { Name = "isDeadly", Type = "bool", Nilable = false }, + { Name = "combatSpellDetails", Type = "DamageMeterCombatSpellUnitDetails", Nilable = false }, + }, + }, + { + Name = "DamageMeterCombatSpellUnitDetails", + Type = "Structure", + Documentation = { "Amount for a single target for all casts of the same spellID by a single source (unit) in a combat session." }, + Fields = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + { Name = "unitClassFilename", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "classification", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "isMob", Type = "bool", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + { Name = "specIconID", Type = "fileID", Nilable = false, NeverSecret = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DamageMeter); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bd09a73 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DateAndTimeDocumentation.lua.annotated.lua @@ -0,0 +1,158 @@ +local DateAndTime = +{ + Name = "DateAndTime", + Type = "System", + Namespace = "C_DateAndTime", + Environment = "All", + + Functions = + { + { + Name = "AdjustTimeByDays", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "date", Type = "CalendarTime", Nilable = false }, + { Name = "days", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "newDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "AdjustTimeByMinutes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "date", Type = "CalendarTime", Nilable = false }, + { Name = "minutes", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "newDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "AdjustTimeByMonths", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "date", Type = "CalendarTime", Nilable = false }, + { Name = "months", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "newDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "CompareCalendarTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lhsCalendarTime", Type = "CalendarTime", Nilable = false }, + { Name = "rhsCalendarTime", Type = "CalendarTime", Nilable = false }, + }, + + Returns = + { + { Name = "comparison", Type = "number", Nilable = false, Documentation = { "-1 if rhsCalendarTime < lhsCalendarTime, 0 if rhsCalendarTime == lhsCalendarTime, 1 if rhsCalendarTime > lhsCalendarTime" } }, + }, + }, + { + Name = "GetCalendarTimeFromEpoch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "epoch", Type = "BigUInteger", Nilable = false }, + }, + + Returns = + { + { Name = "date", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "GetCurrentCalendarTime", + Type = "Function", + + Returns = + { + { Name = "date", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "GetSecondsUntilDailyReset", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetSecondsUntilWeeklyReset", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetServerTimeLocal", + Type = "Function", + + Returns = + { + { Name = "serverTimeLocal", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetWeeklyResetStartTime", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "time_t", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "TimeEventFlag", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "GlueScreenShortcut", Type = "TimeEventFlag", EnumValue = 1 }, + { Name = "WeeklyReset", Type = "TimeEventFlag", EnumValue = 2 }, + { Name = "GlobalLaunch", Type = "TimeEventFlag", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DateAndTime); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathAlertDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathAlertDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0c385c6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathAlertDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local DeathAlert = +{ + Name = "DeathAlert", + Type = "System", + Namespace = "C_DeathAlert", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "HardcoreDeaths", + Type = "Event", + LiteralName = "HARDCORE_DEATHS", + SynchronousEvent = true, + Payload = + { + { Name = "memberName", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(DeathAlert); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e305ef8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathInfoDocumentation.lua.annotated.lua @@ -0,0 +1,221 @@ +local DeathInfo = +{ + Name = "DeathInfo", + Type = "System", + Namespace = "C_DeathInfo", + Environment = "All", + + Functions = + { + { + Name = "GetCorpseMapPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "GetDeathReleasePosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "GetGraveyardsForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "graveyards", Type = "table", InnerType = "GraveyardMapInfo", Nilable = false }, + }, + }, + { + Name = "GetSelfResurrectOptions", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "options", Type = "table", InnerType = "SelfResurrectOption", Nilable = false }, + }, + }, + { + Name = "UseSelfResurrectOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionType", Type = "SelfResurrectOptionType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AreaSpiritHealerInRange", + Type = "Event", + LiteralName = "AREA_SPIRIT_HEALER_IN_RANGE", + SynchronousEvent = true, + }, + { + Name = "AreaSpiritHealerOutOfRange", + Type = "Event", + LiteralName = "AREA_SPIRIT_HEALER_OUT_OF_RANGE", + SynchronousEvent = true, + }, + { + Name = "CemeteryPreferenceUpdated", + Type = "Event", + LiteralName = "CEMETERY_PREFERENCE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ConfirmXpLoss", + Type = "Event", + LiteralName = "CONFIRM_XP_LOSS", + SynchronousEvent = true, + }, + { + Name = "CorpseInInstance", + Type = "Event", + LiteralName = "CORPSE_IN_INSTANCE", + SynchronousEvent = true, + }, + { + Name = "CorpseInRange", + Type = "Event", + LiteralName = "CORPSE_IN_RANGE", + SynchronousEvent = true, + }, + { + Name = "CorpseOutOfRange", + Type = "Event", + LiteralName = "CORPSE_OUT_OF_RANGE", + SynchronousEvent = true, + }, + { + Name = "PlayerAlive", + Type = "Event", + LiteralName = "PLAYER_ALIVE", + SynchronousEvent = true, + }, + { + Name = "PlayerDead", + Type = "Event", + LiteralName = "PLAYER_DEAD", + SynchronousEvent = true, + }, + { + Name = "PlayerSkinned", + Type = "Event", + LiteralName = "PLAYER_SKINNED", + SynchronousEvent = true, + Payload = + { + { Name = "hasFreeRepop", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerUnghost", + Type = "Event", + LiteralName = "PLAYER_UNGHOST", + SynchronousEvent = true, + }, + { + Name = "RequestCemeteryListResponse", + Type = "Event", + LiteralName = "REQUEST_CEMETERY_LIST_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "isGossipTriggered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResurrectRequest", + Type = "Event", + LiteralName = "RESURRECT_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "inviter", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SelfResSpellChanged", + Type = "Event", + LiteralName = "SELF_RES_SPELL_CHANGED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "SelfResurrectOptionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Spell", Type = "SelfResurrectOptionType", EnumValue = 0 }, + { Name = "Item", Type = "SelfResurrectOptionType", EnumValue = 1 }, + }, + }, + { + Name = "GraveyardMapInfo", + Type = "Structure", + Fields = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "textureIndex", Type = "number", Nilable = false }, + { Name = "graveyardID", Type = "number", Nilable = false }, + { Name = "isGraveyardSelectable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SelfResurrectOption", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "optionType", Type = "SelfResurrectOptionType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "isLimited", Type = "bool", Nilable = false }, + { Name = "priority", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DeathInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua.annotated.lua new file mode 100644 index 0000000..18863a7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DeathRecapDocumentation.lua.annotated.lua @@ -0,0 +1,89 @@ +local DeathRecap = +{ + Name = "DeathRecap", + Type = "System", + Namespace = "C_DeathRecap", + Environment = "All", + + Functions = + { + { + Name = "GetRecapEvents", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "DeathRecapEventInfo", Nilable = false }, + }, + }, + { + Name = "GetRecapLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRecapMaxHealth", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the max health for the unit that died in the provided death recap." }, + + Arguments = + { + { Name = "recapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "maxHealth", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasRecapEvents", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "hasEvents", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "DeathRecapEventInfo", + Type = "Structure", + Fields = + { + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DeathRecap); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f196ac6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DebugToggleDocumentation.lua.annotated.lua @@ -0,0 +1,52 @@ +local DebugToggle = +{ + Name = "DebugToggle", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "ToggleAnimKitDisplay", + Type = "Function", + }, + { + Name = "ToggleCollision", + Type = "Function", + }, + { + Name = "ToggleCollisionDisplay", + Type = "Function", + }, + { + Name = "ToggleDebugAIDisplay", + Type = "Function", + }, + { + Name = "ToggleGravity", + Type = "Function", + }, + { + Name = "TogglePlayerBounds", + Type = "Function", + }, + { + Name = "TogglePortals", + Type = "Function", + }, + { + Name = "ToggleTris", + Type = "Function", + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(DebugToggle); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c1d77ce --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,69 @@ +local DelvesConstants = +{ + Tables = + { + { + Name = "CompanionConfigSlotTypes", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Role", Type = "CompanionConfigSlotTypes", EnumValue = 0 }, + { Name = "Utility", Type = "CompanionConfigSlotTypes", EnumValue = 1 }, + { Name = "Combat", Type = "CompanionConfigSlotTypes", EnumValue = 2 }, + }, + }, + { + Name = "CurioRarity", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Common", Type = "CurioRarity", EnumValue = 1 }, + { Name = "Uncommon", Type = "CurioRarity", EnumValue = 2 }, + { Name = "Rare", Type = "CurioRarity", EnumValue = 3 }, + { Name = "Epic", Type = "CurioRarity", EnumValue = 4 }, + }, + }, + { + Name = "PlayerCompanionInfoFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "IgnoreSeasonInScenarios", Type = "PlayerCompanionInfoFlags", EnumValue = 1 }, + }, + }, + { + Name = "DelveAssistActionData", + Type = "Structure", + Fields = + { + { Name = "assistedPlayer", Type = "string", Nilable = false }, + { Name = "mapName", Type = "cstring", Nilable = true }, + { Name = "creatureName", Type = "cstring", Nilable = true }, + { Name = "receivedSpellID", Type = "number", Nilable = true }, + { Name = "assistAction", Type = "AssistActionType", Nilable = false }, + }, + }, + { + Name = "DelvesConsts", + Type = "Constants", + Values = + { + { Name = "DELVES_MIN_PLAYER_LEVEL_CONTENT_TUNING_ID", Type = "number", Value = 2677 }, + { Name = "DELVES_NORMAL_KEY_CURRENCY_ID", Type = "number", Value = 3028 }, + { Name = "DELVES_COMPANION_INFO_SELECTION_CHARACTER_DATA_ELEMENT_ID", Type = "number", Value = 13 }, + { Name = "DELVES_COMPANION_TOOLTIP_WIDGET_SET_ID", Type = "number", Value = 1331 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DelvesConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9008c0e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DelvesUIDocumentation.lua.annotated.lua @@ -0,0 +1,406 @@ +local DelvesUI = +{ + Name = "DelvesUI", + Type = "System", + Namespace = "C_DelvesUI", + Environment = "All", + + Functions = + { + { + Name = "GetCompanionInfoForActivePlayer", + Type = "Function", + + Returns = + { + { Name = "playerCompanionInfoID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCreatureDisplayInfoForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "creatureDisplayInfoID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurioLink", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Given the spell ID for an owned curio and its rarity, return a spell link style hyperlink for the curio spell, since they aren't items when learned" }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "rarity", Type = "CurioRarity", Nilable = false }, + }, + + Returns = + { + { Name = "curioLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCurioNodeForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "curioType", Type = "CurioType", Nilable = false }, + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurioRarityByTraitCondAccountElementID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "traitCondAccountElementID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rarity", Type = "CurioRarity", Nilable = false }, + }, + }, + { + Name = "GetCurrentDelvesSeasonNumber", + Type = "Function", + + Returns = + { + { Name = "seasonNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDelvesAffixSpellsForSeason", + Type = "Function", + + Returns = + { + { Name = "affixSpellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetDelvesFactionForSeason", + Type = "Function", + + Returns = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDelvesMinRequiredLevel", + Type = "Function", + Documentation = { "Players must be at or above the min level + offset to enter Delves. This function returns that min level." }, + + Returns = + { + { Name = "minRequiredLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFactionForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLockedTextForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetModelSceneForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "modelSceneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerCompanionPDEID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "pdeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRoleNodeForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRoleSubtreeForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roleType", Type = "CompanionRoleType", Nilable = false }, + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "subTreeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTieredEntrancePDEID", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "pdeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTraitTreeForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "companionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnseenCuriosBySlotType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotType", Type = "CompanionConfigSlotTypes", Nilable = false }, + { Name = "ownedCurioNodeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + + Returns = + { + { Name = "unseenCurioNodeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "HasActiveDelve", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEligibleForActiveDelveRewards", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTraitTreeForCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "traitTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isForCompanion", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestPartyEligibilityForDelveTiers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Queries private party members to see what level they have unlocked for the Delve. Ineligible members are added to the tooltip of dropdown entries." }, + + Arguments = + { + { Name = "gossipOption", Type = "number", Nilable = false }, + }, + }, + { + Name = "SaveSeenCuriosBySlotType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotType", Type = "CompanionConfigSlotTypes", Nilable = false }, + { Name = "ownedCurioNodeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActiveDelveDataUpdate", + Type = "Event", + LiteralName = "ACTIVE_DELVE_DATA_UPDATE", + SynchronousEvent = true, + Documentation = { "Signaled when SpellScript calls change the data for players/parties owning a delve or when the delve is shut down." }, + }, + { + Name = "DelveAssistAction", + Type = "Event", + LiteralName = "DELVE_ASSIST_ACTION", + SynchronousEvent = true, + Documentation = { "Signaled when an assist action occurs in a delve." }, + Payload = + { + { Name = "data", Type = "DelveAssistActionData", Nilable = false }, + }, + }, + { + Name = "DelvesAccountDataElementChanged", + Type = "Event", + LiteralName = "DELVES_ACCOUNT_DATA_ELEMENT_CHANGED", + SynchronousEvent = true, + Documentation = { "Signaled when player account data element(s) have changed. This drives curio ranks, and the UI should update when this is sent." }, + }, + { + Name = "PartyEligibilityForDelveTiersChanged", + Type = "Event", + LiteralName = "PARTY_ELIGIBILITY_FOR_DELVE_TIERS_CHANGED", + SynchronousEvent = true, + Documentation = { "Signaled when responses come in from RequestPartyEligibilityForDelveTiers." }, + Payload = + { + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "maxEligibleLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowDelvesCompanionConfigurationUI", + Type = "Event", + LiteralName = "SHOW_DELVES_COMPANION_CONFIGURATION_UI", + SynchronousEvent = true, + Documentation = { "Signaled when SpellScript indicates that a curio has been learned or upgraded. Will show the companion config UI." }, + }, + { + Name = "WalkInDataUpdate", + Type = "Event", + LiteralName = "WALK_IN_DATA_UPDATE", + SynchronousEvent = true, + Documentation = { "Signaled when the player or a private party member join a new walk-in instance or when the instance is shut down." }, + }, + }, + + Tables = + { + { + Name = "CompanionRoleType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Dps", Type = "CompanionRoleType", EnumValue = 0 }, + { Name = "Heal", Type = "CompanionRoleType", EnumValue = 1 }, + { Name = "Tank", Type = "CompanionRoleType", EnumValue = 2 }, + }, + }, + { + Name = "CurioType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Combat", Type = "CurioType", EnumValue = 0 }, + { Name = "Utility", Type = "CurioType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DelvesUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DuelInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DuelInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6843af1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DuelInfoDocumentation.lua.annotated.lua @@ -0,0 +1,59 @@ +local DuelInfo = +{ + Name = "DuelInfo", + Type = "System", + Namespace = "C_DuelInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "DuelFinished", + Type = "Event", + LiteralName = "DUEL_FINISHED", + SynchronousEvent = true, + }, + { + Name = "DuelInbounds", + Type = "Event", + LiteralName = "DUEL_INBOUNDS", + SynchronousEvent = true, + }, + { + Name = "DuelOutofbounds", + Type = "Event", + LiteralName = "DUEL_OUTOFBOUNDS", + SynchronousEvent = true, + }, + { + Name = "DuelRequested", + Type = "Event", + LiteralName = "DUEL_REQUESTED", + SynchronousEvent = true, + Payload = + { + { Name = "playerName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "DuelToTheDeathRequested", + Type = "Event", + LiteralName = "DUEL_TO_THE_DEATH_REQUESTED", + SynchronousEvent = true, + Payload = + { + { Name = "playerName", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(DuelInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DungeonEncounterConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DungeonEncounterConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3aa8927 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DungeonEncounterConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,114 @@ +local DungeonEncounterConstants = +{ + Tables = + { + { + Name = "DungeonEncounterFlags", + Type = "Enumeration", + NumValues = 10, + MinValue = 1, + MaxValue = 512, + Fields = + { + { Name = "StickyNews", Type = "DungeonEncounterFlags", EnumValue = 1 }, + { Name = "GuildNews", Type = "DungeonEncounterFlags", EnumValue = 2 }, + { Name = "RaidLockPlayers", Type = "DungeonEncounterFlags", EnumValue = 4 }, + { Name = "AutoEnd", Type = "DungeonEncounterFlags", EnumValue = 8 }, + { Name = "Cosmetic", Type = "DungeonEncounterFlags", EnumValue = 16 }, + { Name = "Unused", Type = "DungeonEncounterFlags", EnumValue = 32 }, + { Name = "HideUntilCompleted", Type = "DungeonEncounterFlags", EnumValue = 64 }, + { Name = "NoAutoStart", Type = "DungeonEncounterFlags", EnumValue = 128 }, + { Name = "IgnoreSpawnLimit", Type = "DungeonEncounterFlags", EnumValue = 256 }, + { Name = "DisableEncounterEvents", Type = "DungeonEncounterFlags", EnumValue = 512 }, + }, + }, + { + Name = "DungeonEncounterTriggerType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Invalid", Type = "DungeonEncounterTriggerType", EnumValue = 0 }, + { Name = "OnStart", Type = "DungeonEncounterTriggerType", EnumValue = 1 }, + { Name = "OnComplete", Type = "DungeonEncounterTriggerType", EnumValue = 2 }, + { Name = "OnEnd", Type = "DungeonEncounterTriggerType", EnumValue = 3 }, + { Name = "PreviouslyCompleted", Type = "DungeonEncounterTriggerType", EnumValue = 4 }, + }, + }, + { + Name = "DungeonEncounterXCreatureFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "BossCreature", Type = "DungeonEncounterXCreatureFlags", EnumValue = 1 }, + { Name = "DropLootImmediately", Type = "DungeonEncounterXCreatureFlags", EnumValue = 2 }, + { Name = "DoNotDespawnOnSuccess", Type = "DungeonEncounterXCreatureFlags", EnumValue = 4 }, + }, + }, + { + Name = "EncounterEventCastState", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "Casting", Type = "EncounterEventCastState", EnumValue = 1 }, + { Name = "NotCasting", Type = "EncounterEventCastState", EnumValue = 2 }, + { Name = "Expired", Type = "EncounterEventCastState", EnumValue = 3 }, + }, + }, + { + Name = "EncounterEventFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "Disabled", Type = "EncounterEventFlags", EnumValue = 1 }, + { Name = "IgnoreCastConsume", Type = "EncounterEventFlags", EnumValue = 2 }, + }, + }, + { + Name = "EncounterEventIconmask", + Type = "Enumeration", + NumValues = 10, + MinValue = 1, + MaxValue = 512, + Fields = + { + { Name = "DeadlyEffect", Type = "EncounterEventIconmask", EnumValue = 1 }, + { Name = "EnrageEffect", Type = "EncounterEventIconmask", EnumValue = 2 }, + { Name = "BleedEffect", Type = "EncounterEventIconmask", EnumValue = 4 }, + { Name = "MagicEffect", Type = "EncounterEventIconmask", EnumValue = 8 }, + { Name = "DiseaseEffect", Type = "EncounterEventIconmask", EnumValue = 16 }, + { Name = "CurseEffect", Type = "EncounterEventIconmask", EnumValue = 32 }, + { Name = "PoisonEffect", Type = "EncounterEventIconmask", EnumValue = 64 }, + { Name = "TankRole", Type = "EncounterEventIconmask", EnumValue = 128 }, + { Name = "HealerRole", Type = "EncounterEventIconmask", EnumValue = 256 }, + { Name = "DpsRole", Type = "EncounterEventIconmask", EnumValue = 512 }, + }, + }, + { + Name = "EncounterEventSeverity", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Low", Type = "EncounterEventSeverity", EnumValue = 0 }, + { Name = "Medium", Type = "EncounterEventSeverity", EnumValue = 1 }, + { Name = "High", Type = "EncounterEventSeverity", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DungeonEncounterConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e19fdf1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DurationUtilDocumentation.lua.annotated.lua @@ -0,0 +1,41 @@ +local DurationUtil = +{ + Name = "DurationUtil", + Type = "System", + Namespace = "C_DurationUtil", + Environment = "All", + + Functions = + { + { + Name = "CreateDuration", + Type = "Function", + Documentation = { "Creates a zero duration container that can represent a time span." }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetCurrentTime", + Type = "Function", + Documentation = { "Returns the current time used by duration objects. Equivalent to GetTime() in public builds." }, + + Returns = + { + { Name = "currentTime", Type = "FrameTime", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(DurationUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..28a0922 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoDocumentation.lua.annotated.lua @@ -0,0 +1,157 @@ +local DyeColorInfo = +{ + Name = "DyeColorInfo", + Type = "System", + Namespace = "C_DyeColor", + Environment = "All", + + Functions = + { + { + Name = "GetAllDyeColorCategories", + Type = "Function", + + Returns = + { + { Name = "dyeColorCategoryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAllDyeColors", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ownedColorsOnly", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "dyeColorIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetDyeColorCategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dyeColorCategoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dyeColorCategoryInfo", Type = "DyeColorCategoryDisplayInfo", Nilable = true }, + }, + }, + { + Name = "GetDyeColorForItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLinkOrID", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "dyeColorID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetDyeColorForItemLocation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "dyeColorID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetDyeColorInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dyeColorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dyeColorInfo", Type = "DyeColorDisplayInfo", Nilable = true }, + }, + }, + { + Name = "GetDyeColorsInCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dyeColorCategory", Type = "number", Nilable = false }, + { Name = "ownedColorsOnly", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "dyeColorIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsDyeColorOwned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "True if the player owns any of the consumable item used to apply the specified dye" }, + + Arguments = + { + { Name = "dyeColorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isOwned", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "DyeColorCategoryUpdated", + Type = "Event", + LiteralName = "DYE_COLOR_CATEGORY_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "dyeColorCategoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DyeColorUpdated", + Type = "Event", + LiteralName = "DYE_COLOR_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "dyeColorID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(DyeColorInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..303af7f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/DyeColorInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,32 @@ +local DyeColorInfoShared = +{ + Tables = + { + { + Name = "DyeColorCategoryDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "DyeColorDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "dyeColorCategoryID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "sortOrder", Type = "number", Nilable = false }, + { Name = "swatchColorStart", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "swatchColorEnd", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true, Documentation = { "The consumable item used to apply this Dye Color; May be nil if dye color does not have an associated item" } }, + { Name = "numOwned", Type = "number", Nilable = false, Documentation = { "The number of this dye's consumable item owned by the player; Includes both held and banked items; Will be 0 if dye has no associated item" } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(DyeColorInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..266e260 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,879 @@ +local EditModeManagerConstants = +{ + Tables = + { + { + Name = "ActionBarOrientation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horizontal", Type = "ActionBarOrientation", EnumValue = 0 }, + { Name = "Vertical", Type = "ActionBarOrientation", EnumValue = 1 }, + }, + }, + { + Name = "ActionBarVisibleSetting", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Always", Type = "ActionBarVisibleSetting", EnumValue = 0 }, + { Name = "InCombat", Type = "ActionBarVisibleSetting", EnumValue = 1 }, + { Name = "OutOfCombat", Type = "ActionBarVisibleSetting", EnumValue = 2 }, + { Name = "Hidden", Type = "ActionBarVisibleSetting", EnumValue = 3 }, + }, + }, + { + Name = "AuraFrameIconDirection", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Down", Type = "AuraFrameIconDirection", EnumValue = 0 }, + { Name = "Up", Type = "AuraFrameIconDirection", EnumValue = 1 }, + { Name = "Left", Type = "AuraFrameIconDirection", EnumValue = 0 }, + { Name = "Right", Type = "AuraFrameIconDirection", EnumValue = 1 }, + }, + }, + { + Name = "AuraFrameIconWrap", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Down", Type = "AuraFrameIconWrap", EnumValue = 0 }, + { Name = "Up", Type = "AuraFrameIconWrap", EnumValue = 1 }, + { Name = "Left", Type = "AuraFrameIconWrap", EnumValue = 0 }, + { Name = "Right", Type = "AuraFrameIconWrap", EnumValue = 1 }, + }, + }, + { + Name = "AuraFrameOrientation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horizontal", Type = "AuraFrameOrientation", EnumValue = 0 }, + { Name = "Vertical", Type = "AuraFrameOrientation", EnumValue = 1 }, + }, + }, + { + Name = "AuraFrameVisibleSetting", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Always", Type = "AuraFrameVisibleSetting", EnumValue = 0 }, + { Name = "InCombat", Type = "AuraFrameVisibleSetting", EnumValue = 1 }, + { Name = "Hidden", Type = "AuraFrameVisibleSetting", EnumValue = 2 }, + }, + }, + { + Name = "BagsDirection", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Left", Type = "BagsDirection", EnumValue = 0 }, + { Name = "Right", Type = "BagsDirection", EnumValue = 1 }, + { Name = "Up", Type = "BagsDirection", EnumValue = 0 }, + { Name = "Down", Type = "BagsDirection", EnumValue = 1 }, + }, + }, + { + Name = "BagsOrientation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horizontal", Type = "BagsOrientation", EnumValue = 0 }, + { Name = "Vertical", Type = "BagsOrientation", EnumValue = 1 }, + }, + }, + { + Name = "CooldownViewerBarContent", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "IconAndName", Type = "CooldownViewerBarContent", EnumValue = 0 }, + { Name = "IconOnly", Type = "CooldownViewerBarContent", EnumValue = 1 }, + { Name = "NameOnly", Type = "CooldownViewerBarContent", EnumValue = 2 }, + }, + }, + { + Name = "CooldownViewerIconDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Left", Type = "CooldownViewerIconDirection", EnumValue = 0 }, + { Name = "Right", Type = "CooldownViewerIconDirection", EnumValue = 1 }, + }, + }, + { + Name = "CooldownViewerOrientation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horizontal", Type = "CooldownViewerOrientation", EnumValue = 0 }, + { Name = "Vertical", Type = "CooldownViewerOrientation", EnumValue = 1 }, + }, + }, + { + Name = "CooldownViewerVisibleSetting", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Always", Type = "CooldownViewerVisibleSetting", EnumValue = 0 }, + { Name = "InCombat", Type = "CooldownViewerVisibleSetting", EnumValue = 1 }, + { Name = "Hidden", Type = "CooldownViewerVisibleSetting", EnumValue = 2 }, + }, + }, + { + Name = "DamageMeterNumbers", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Minimal", Type = "DamageMeterNumbers", EnumValue = 0 }, + { Name = "Compact", Type = "DamageMeterNumbers", EnumValue = 1 }, + { Name = "Complete", Type = "DamageMeterNumbers", EnumValue = 2 }, + }, + }, + { + Name = "DamageMeterStyle", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Default", Type = "DamageMeterStyle", EnumValue = 0 }, + { Name = "Thin", Type = "DamageMeterStyle", EnumValue = 1 }, + { Name = "Bordered", Type = "DamageMeterStyle", EnumValue = 2 }, + { Name = "FullBackground", Type = "DamageMeterStyle", EnumValue = 3 }, + }, + }, + { + Name = "DamageMeterVisibility", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Always", Type = "DamageMeterVisibility", EnumValue = 0 }, + { Name = "InCombat", Type = "DamageMeterVisibility", EnumValue = 1 }, + { Name = "Hidden", Type = "DamageMeterVisibility", EnumValue = 2 }, + }, + }, + { + Name = "EditModeAccountSetting", + Type = "Enumeration", + NumValues = 33, + MinValue = 0, + MaxValue = 32, + Fields = + { + { Name = "ShowGrid", Type = "EditModeAccountSetting", EnumValue = 0 }, + { Name = "GridSpacing", Type = "EditModeAccountSetting", EnumValue = 1 }, + { Name = "SettingsExpanded", Type = "EditModeAccountSetting", EnumValue = 2 }, + { Name = "ShowTargetAndFocus", Type = "EditModeAccountSetting", EnumValue = 3 }, + { Name = "ShowStanceBar", Type = "EditModeAccountSetting", EnumValue = 4 }, + { Name = "ShowPetActionBar", Type = "EditModeAccountSetting", EnumValue = 5 }, + { Name = "ShowPossessActionBar", Type = "EditModeAccountSetting", EnumValue = 6 }, + { Name = "ShowCastBar", Type = "EditModeAccountSetting", EnumValue = 7 }, + { Name = "ShowEncounterBar", Type = "EditModeAccountSetting", EnumValue = 8 }, + { Name = "ShowExtraAbilities", Type = "EditModeAccountSetting", EnumValue = 9 }, + { Name = "ShowBuffsAndDebuffs", Type = "EditModeAccountSetting", EnumValue = 10 }, + { Name = "DeprecatedShowDebuffFrame", Type = "EditModeAccountSetting", EnumValue = 11 }, + { Name = "ShowPartyFrames", Type = "EditModeAccountSetting", EnumValue = 12 }, + { Name = "ShowRaidFrames", Type = "EditModeAccountSetting", EnumValue = 13 }, + { Name = "ShowTalkingHeadFrame", Type = "EditModeAccountSetting", EnumValue = 14 }, + { Name = "ShowVehicleLeaveButton", Type = "EditModeAccountSetting", EnumValue = 15 }, + { Name = "ShowBossFrames", Type = "EditModeAccountSetting", EnumValue = 16 }, + { Name = "ShowArenaFrames", Type = "EditModeAccountSetting", EnumValue = 17 }, + { Name = "ShowLootFrame", Type = "EditModeAccountSetting", EnumValue = 18 }, + { Name = "ShowHudTooltip", Type = "EditModeAccountSetting", EnumValue = 19 }, + { Name = "ShowStatusTrackingBar2", Type = "EditModeAccountSetting", EnumValue = 20 }, + { Name = "ShowDurabilityFrame", Type = "EditModeAccountSetting", EnumValue = 21 }, + { Name = "EnableSnap", Type = "EditModeAccountSetting", EnumValue = 22 }, + { Name = "EnableAdvancedOptions", Type = "EditModeAccountSetting", EnumValue = 23 }, + { Name = "ShowPetFrame", Type = "EditModeAccountSetting", EnumValue = 24 }, + { Name = "ShowTimerBars", Type = "EditModeAccountSetting", EnumValue = 25 }, + { Name = "ShowVehicleSeatIndicator", Type = "EditModeAccountSetting", EnumValue = 26 }, + { Name = "ShowArchaeologyBar", Type = "EditModeAccountSetting", EnumValue = 27 }, + { Name = "ShowCooldownViewer", Type = "EditModeAccountSetting", EnumValue = 28 }, + { Name = "ShowPersonalResourceDisplay", Type = "EditModeAccountSetting", EnumValue = 29 }, + { Name = "ShowEncounterEvents", Type = "EditModeAccountSetting", EnumValue = 30 }, + { Name = "ShowDamageMeter", Type = "EditModeAccountSetting", EnumValue = 31 }, + { Name = "ShowExternalDefensives", Type = "EditModeAccountSetting", EnumValue = 32 }, + }, + }, + { + Name = "EditModeActionBarSetting", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "Orientation", Type = "EditModeActionBarSetting", EnumValue = 0 }, + { Name = "NumRows", Type = "EditModeActionBarSetting", EnumValue = 1 }, + { Name = "NumIcons", Type = "EditModeActionBarSetting", EnumValue = 2 }, + { Name = "IconSize", Type = "EditModeActionBarSetting", EnumValue = 3 }, + { Name = "IconPadding", Type = "EditModeActionBarSetting", EnumValue = 4 }, + { Name = "VisibleSetting", Type = "EditModeActionBarSetting", EnumValue = 5 }, + { Name = "HideBarArt", Type = "EditModeActionBarSetting", EnumValue = 6 }, + { Name = "DeprecatedSnapToSide", Type = "EditModeActionBarSetting", EnumValue = 7 }, + { Name = "HideBarScrolling", Type = "EditModeActionBarSetting", EnumValue = 8 }, + { Name = "AlwaysShowButtons", Type = "EditModeActionBarSetting", EnumValue = 9 }, + }, + }, + { + Name = "EditModeActionBarSystemIndices", + Type = "Enumeration", + NumValues = 11, + MinValue = 1, + MaxValue = 13, + Fields = + { + { Name = "MainBar", Type = "EditModeActionBarSystemIndices", EnumValue = 1 }, + { Name = "Bar2", Type = "EditModeActionBarSystemIndices", EnumValue = 2 }, + { Name = "Bar3", Type = "EditModeActionBarSystemIndices", EnumValue = 3 }, + { Name = "RightBar1", Type = "EditModeActionBarSystemIndices", EnumValue = 4 }, + { Name = "RightBar2", Type = "EditModeActionBarSystemIndices", EnumValue = 5 }, + { Name = "ExtraBar1", Type = "EditModeActionBarSystemIndices", EnumValue = 6 }, + { Name = "ExtraBar2", Type = "EditModeActionBarSystemIndices", EnumValue = 7 }, + { Name = "ExtraBar3", Type = "EditModeActionBarSystemIndices", EnumValue = 8 }, + { Name = "StanceBar", Type = "EditModeActionBarSystemIndices", EnumValue = 11 }, + { Name = "PetActionBar", Type = "EditModeActionBarSystemIndices", EnumValue = 12 }, + { Name = "PossessActionBar", Type = "EditModeActionBarSystemIndices", EnumValue = 13 }, + }, + }, + { + Name = "EditModeArchaeologyBarSetting", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "Size", Type = "EditModeArchaeologyBarSetting", EnumValue = 0 }, + }, + }, + { + Name = "EditModeAuraFrameSetting", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "Orientation", Type = "EditModeAuraFrameSetting", EnumValue = 0 }, + { Name = "IconWrap", Type = "EditModeAuraFrameSetting", EnumValue = 1 }, + { Name = "IconDirection", Type = "EditModeAuraFrameSetting", EnumValue = 2 }, + { Name = "IconLimitBuffFrame", Type = "EditModeAuraFrameSetting", EnumValue = 3 }, + { Name = "IconLimitDebuffFrame", Type = "EditModeAuraFrameSetting", EnumValue = 4 }, + { Name = "IconSize", Type = "EditModeAuraFrameSetting", EnumValue = 5 }, + { Name = "IconPadding", Type = "EditModeAuraFrameSetting", EnumValue = 6 }, + { Name = "DeprecatedShowFull", Type = "EditModeAuraFrameSetting", EnumValue = 7 }, + { Name = "VisibleSetting", Type = "EditModeAuraFrameSetting", EnumValue = 8 }, + { Name = "Opacity", Type = "EditModeAuraFrameSetting", EnumValue = 9 }, + { Name = "ShowDispelType", Type = "EditModeAuraFrameSetting", EnumValue = 10 }, + }, + }, + { + Name = "EditModeAuraFrameSystemIndices", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "BuffFrame", Type = "EditModeAuraFrameSystemIndices", EnumValue = 1 }, + { Name = "DebuffFrame", Type = "EditModeAuraFrameSystemIndices", EnumValue = 2 }, + { Name = "ExternalDefensivesFrame", Type = "EditModeAuraFrameSystemIndices", EnumValue = 3 }, + }, + }, + { + Name = "EditModeBagsSetting", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Orientation", Type = "EditModeBagsSetting", EnumValue = 0 }, + { Name = "Direction", Type = "EditModeBagsSetting", EnumValue = 1 }, + { Name = "Size", Type = "EditModeBagsSetting", EnumValue = 2 }, + { Name = "BagSlotPadding", Type = "EditModeBagsSetting", EnumValue = 3 }, + }, + }, + { + Name = "EditModeCastBarSetting", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "BarSize", Type = "EditModeCastBarSetting", EnumValue = 0 }, + { Name = "LockToPlayerFrame", Type = "EditModeCastBarSetting", EnumValue = 1 }, + { Name = "ShowCastTime", Type = "EditModeCastBarSetting", EnumValue = 2 }, + }, + }, + { + Name = "EditModeChatFrameSetting", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "WidthHundreds", Type = "EditModeChatFrameSetting", EnumValue = 0 }, + { Name = "WidthTensAndOnes", Type = "EditModeChatFrameSetting", EnumValue = 1 }, + { Name = "HeightHundreds", Type = "EditModeChatFrameSetting", EnumValue = 2 }, + { Name = "HeightTensAndOnes", Type = "EditModeChatFrameSetting", EnumValue = 3 }, + }, + }, + { + Name = "EditModeCooldownViewerSetting", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Orientation", Type = "EditModeCooldownViewerSetting", EnumValue = 0 }, + { Name = "IconLimit", Type = "EditModeCooldownViewerSetting", EnumValue = 1 }, + { Name = "IconDirection", Type = "EditModeCooldownViewerSetting", EnumValue = 2 }, + { Name = "IconSize", Type = "EditModeCooldownViewerSetting", EnumValue = 3 }, + { Name = "IconPadding", Type = "EditModeCooldownViewerSetting", EnumValue = 4 }, + { Name = "Opacity", Type = "EditModeCooldownViewerSetting", EnumValue = 5 }, + { Name = "VisibleSetting", Type = "EditModeCooldownViewerSetting", EnumValue = 6 }, + { Name = "BarContent", Type = "EditModeCooldownViewerSetting", EnumValue = 7 }, + { Name = "HideWhenInactive", Type = "EditModeCooldownViewerSetting", EnumValue = 8 }, + { Name = "ShowTimer", Type = "EditModeCooldownViewerSetting", EnumValue = 9 }, + { Name = "ShowTooltips", Type = "EditModeCooldownViewerSetting", EnumValue = 10 }, + { Name = "BarWidthScale", Type = "EditModeCooldownViewerSetting", EnumValue = 11 }, + }, + }, + { + Name = "EditModeCooldownViewerSystemIndices", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Essential", Type = "EditModeCooldownViewerSystemIndices", EnumValue = 1 }, + { Name = "Utility", Type = "EditModeCooldownViewerSystemIndices", EnumValue = 2 }, + { Name = "BuffIcon", Type = "EditModeCooldownViewerSystemIndices", EnumValue = 3 }, + { Name = "BuffBar", Type = "EditModeCooldownViewerSystemIndices", EnumValue = 4 }, + }, + }, + { + Name = "EditModeDamageMeterSetting", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "Visibility", Type = "EditModeDamageMeterSetting", EnumValue = 0 }, + { Name = "Style", Type = "EditModeDamageMeterSetting", EnumValue = 1 }, + { Name = "Numbers", Type = "EditModeDamageMeterSetting", EnumValue = 2 }, + { Name = "FrameWidth", Type = "EditModeDamageMeterSetting", EnumValue = 3 }, + { Name = "FrameHeight", Type = "EditModeDamageMeterSetting", EnumValue = 4 }, + { Name = "Padding", Type = "EditModeDamageMeterSetting", EnumValue = 5 }, + { Name = "Transparency", Type = "EditModeDamageMeterSetting", EnumValue = 6 }, + { Name = "ObsoleteReuse1", Type = "EditModeDamageMeterSetting", EnumValue = 7 }, + { Name = "ShowSpecIcon", Type = "EditModeDamageMeterSetting", EnumValue = 8 }, + { Name = "ShowClassColor", Type = "EditModeDamageMeterSetting", EnumValue = 9 }, + { Name = "BarHeight", Type = "EditModeDamageMeterSetting", EnumValue = 10 }, + { Name = "TextSize", Type = "EditModeDamageMeterSetting", EnumValue = 11 }, + { Name = "BackgroundTransparency", Type = "EditModeDamageMeterSetting", EnumValue = 12 }, + }, + }, + { + Name = "EditModeDurabilityFrameSetting", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "Size", Type = "EditModeDurabilityFrameSetting", EnumValue = 0 }, + }, + }, + { + Name = "EditModeEncounterEventsSetting", + Type = "Enumeration", + NumValues = 14, + MinValue = 0, + MaxValue = 13, + Fields = + { + { Name = "Orientation", Type = "EditModeEncounterEventsSetting", EnumValue = 0 }, + { Name = "IconDirection", Type = "EditModeEncounterEventsSetting", EnumValue = 1 }, + { Name = "ShowSpellName", Type = "EditModeEncounterEventsSetting", EnumValue = 2 }, + { Name = "IconSize", Type = "EditModeEncounterEventsSetting", EnumValue = 3 }, + { Name = "OverallSize", Type = "EditModeEncounterEventsSetting", EnumValue = 4 }, + { Name = "BackgroundTransparency", Type = "EditModeEncounterEventsSetting", EnumValue = 5 }, + { Name = "Transparency", Type = "EditModeEncounterEventsSetting", EnumValue = 6 }, + { Name = "Visibility", Type = "EditModeEncounterEventsSetting", EnumValue = 7 }, + { Name = "TooltipAnchor", Type = "EditModeEncounterEventsSetting", EnumValue = 8 }, + { Name = "ShowTimer", Type = "EditModeEncounterEventsSetting", EnumValue = 9 }, + { Name = "ViewType", Type = "EditModeEncounterEventsSetting", EnumValue = 10 }, + { Name = "FlipHorizontally", Type = "EditModeEncounterEventsSetting", EnumValue = 11 }, + { Name = "BarWidth", Type = "EditModeEncounterEventsSetting", EnumValue = 12 }, + { Name = "Padding", Type = "EditModeEncounterEventsSetting", EnumValue = 13 }, + }, + }, + { + Name = "EditModeEncounterEventsSystemIndices", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Timeline", Type = "EditModeEncounterEventsSystemIndices", EnumValue = 1 }, + { Name = "CriticalWarnings", Type = "EditModeEncounterEventsSystemIndices", EnumValue = 2 }, + { Name = "MediumWarnings", Type = "EditModeEncounterEventsSystemIndices", EnumValue = 3 }, + { Name = "NormalWarnings", Type = "EditModeEncounterEventsSystemIndices", EnumValue = 4 }, + }, + }, + { + Name = "EditModeLayoutType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Preset", Type = "EditModeLayoutType", EnumValue = 0 }, + { Name = "Account", Type = "EditModeLayoutType", EnumValue = 1 }, + { Name = "Character", Type = "EditModeLayoutType", EnumValue = 2 }, + { Name = "Override", Type = "EditModeLayoutType", EnumValue = 3 }, + }, + }, + { + Name = "EditModeMicroMenuSetting", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Orientation", Type = "EditModeMicroMenuSetting", EnumValue = 0 }, + { Name = "Order", Type = "EditModeMicroMenuSetting", EnumValue = 1 }, + { Name = "Size", Type = "EditModeMicroMenuSetting", EnumValue = 2 }, + { Name = "EyeSize", Type = "EditModeMicroMenuSetting", EnumValue = 3 }, + }, + }, + { + Name = "EditModeMinimapSetting", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "HeaderUnderneath", Type = "EditModeMinimapSetting", EnumValue = 0 }, + { Name = "RotateMinimap", Type = "EditModeMinimapSetting", EnumValue = 1 }, + { Name = "Size", Type = "EditModeMinimapSetting", EnumValue = 2 }, + }, + }, + { + Name = "EditModeObjectiveTrackerSetting", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Height", Type = "EditModeObjectiveTrackerSetting", EnumValue = 0 }, + { Name = "Opacity", Type = "EditModeObjectiveTrackerSetting", EnumValue = 1 }, + { Name = "TextSize", Type = "EditModeObjectiveTrackerSetting", EnumValue = 2 }, + }, + }, + { + Name = "EditModePersonalResourceDisplaySetting", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "HideHealthAndPower", Type = "EditModePersonalResourceDisplaySetting", EnumValue = 0 }, + { Name = "OnlyShowInCombat", Type = "EditModePersonalResourceDisplaySetting", EnumValue = 1 }, + }, + }, + { + Name = "EditModePresetLayouts", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Modern", Type = "EditModePresetLayouts", EnumValue = 0 }, + { Name = "Classic", Type = "EditModePresetLayouts", EnumValue = 1 }, + }, + }, + { + Name = "EditModeSettingDisplayType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Dropdown", Type = "EditModeSettingDisplayType", EnumValue = 0 }, + { Name = "Checkbox", Type = "EditModeSettingDisplayType", EnumValue = 1 }, + { Name = "Slider", Type = "EditModeSettingDisplayType", EnumValue = 2 }, + }, + }, + { + Name = "EditModeStatusTrackingBarSetting", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Height", Type = "EditModeStatusTrackingBarSetting", EnumValue = 0 }, + { Name = "Width", Type = "EditModeStatusTrackingBarSetting", EnumValue = 1 }, + { Name = "TextSize", Type = "EditModeStatusTrackingBarSetting", EnumValue = 2 }, + }, + }, + { + Name = "EditModeStatusTrackingBarSystemIndices", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "StatusTrackingBar1", Type = "EditModeStatusTrackingBarSystemIndices", EnumValue = 1 }, + { Name = "StatusTrackingBar2", Type = "EditModeStatusTrackingBarSystemIndices", EnumValue = 2 }, + }, + }, + { + Name = "EditModeSystem", + Type = "Enumeration", + NumValues = 24, + MinValue = 0, + MaxValue = 23, + Fields = + { + { Name = "ActionBar", Type = "EditModeSystem", EnumValue = 0 }, + { Name = "CastBar", Type = "EditModeSystem", EnumValue = 1 }, + { Name = "Minimap", Type = "EditModeSystem", EnumValue = 2 }, + { Name = "UnitFrame", Type = "EditModeSystem", EnumValue = 3 }, + { Name = "EncounterBar", Type = "EditModeSystem", EnumValue = 4 }, + { Name = "ExtraAbilities", Type = "EditModeSystem", EnumValue = 5 }, + { Name = "AuraFrame", Type = "EditModeSystem", EnumValue = 6 }, + { Name = "TalkingHeadFrame", Type = "EditModeSystem", EnumValue = 7 }, + { Name = "ChatFrame", Type = "EditModeSystem", EnumValue = 8 }, + { Name = "VehicleLeaveButton", Type = "EditModeSystem", EnumValue = 9 }, + { Name = "LootFrame", Type = "EditModeSystem", EnumValue = 10 }, + { Name = "HudTooltip", Type = "EditModeSystem", EnumValue = 11 }, + { Name = "ObjectiveTracker", Type = "EditModeSystem", EnumValue = 12 }, + { Name = "MicroMenu", Type = "EditModeSystem", EnumValue = 13 }, + { Name = "Bags", Type = "EditModeSystem", EnumValue = 14 }, + { Name = "StatusTrackingBar", Type = "EditModeSystem", EnumValue = 15 }, + { Name = "DurabilityFrame", Type = "EditModeSystem", EnumValue = 16 }, + { Name = "TimerBars", Type = "EditModeSystem", EnumValue = 17 }, + { Name = "VehicleSeatIndicator", Type = "EditModeSystem", EnumValue = 18 }, + { Name = "ArchaeologyBar", Type = "EditModeSystem", EnumValue = 19 }, + { Name = "CooldownViewer", Type = "EditModeSystem", EnumValue = 20 }, + { Name = "PersonalResourceDisplay", Type = "EditModeSystem", EnumValue = 21 }, + { Name = "EncounterEvents", Type = "EditModeSystem", EnumValue = 22 }, + { Name = "DamageMeter", Type = "EditModeSystem", EnumValue = 23 }, + }, + }, + { + Name = "EditModeTimerBarsSetting", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "Size", Type = "EditModeTimerBarsSetting", EnumValue = 0 }, + }, + }, + { + Name = "EditModeUnitFrameSetting", + Type = "Enumeration", + NumValues = 21, + MinValue = 0, + MaxValue = 20, + Fields = + { + { Name = "HidePortrait", Type = "EditModeUnitFrameSetting", EnumValue = 0 }, + { Name = "CastBarUnderneath", Type = "EditModeUnitFrameSetting", EnumValue = 1 }, + { Name = "BuffsOnTop", Type = "EditModeUnitFrameSetting", EnumValue = 2 }, + { Name = "UseLargerFrame", Type = "EditModeUnitFrameSetting", EnumValue = 3 }, + { Name = "UseRaidStylePartyFrames", Type = "EditModeUnitFrameSetting", EnumValue = 4 }, + { Name = "ShowPartyFrameBackground", Type = "EditModeUnitFrameSetting", EnumValue = 5 }, + { Name = "UseHorizontalGroups", Type = "EditModeUnitFrameSetting", EnumValue = 6 }, + { Name = "CastBarOnSide", Type = "EditModeUnitFrameSetting", EnumValue = 7 }, + { Name = "ShowCastTime", Type = "EditModeUnitFrameSetting", EnumValue = 8 }, + { Name = "ViewRaidSize", Type = "EditModeUnitFrameSetting", EnumValue = 9 }, + { Name = "FrameWidth", Type = "EditModeUnitFrameSetting", EnumValue = 10 }, + { Name = "FrameHeight", Type = "EditModeUnitFrameSetting", EnumValue = 11 }, + { Name = "DisplayBorder", Type = "EditModeUnitFrameSetting", EnumValue = 12 }, + { Name = "RaidGroupDisplayType", Type = "EditModeUnitFrameSetting", EnumValue = 13 }, + { Name = "SortPlayersBy", Type = "EditModeUnitFrameSetting", EnumValue = 14 }, + { Name = "RowSize", Type = "EditModeUnitFrameSetting", EnumValue = 15 }, + { Name = "FrameSize", Type = "EditModeUnitFrameSetting", EnumValue = 16 }, + { Name = "ViewArenaSize", Type = "EditModeUnitFrameSetting", EnumValue = 17 }, + { Name = "AuraOrganizationType", Type = "EditModeUnitFrameSetting", EnumValue = 18 }, + { Name = "IconSize", Type = "EditModeUnitFrameSetting", EnumValue = 19 }, + { Name = "Opacity", Type = "EditModeUnitFrameSetting", EnumValue = 20 }, + }, + }, + { + Name = "EditModeUnitFrameSystemIndices", + Type = "Enumeration", + NumValues = 8, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "Player", Type = "EditModeUnitFrameSystemIndices", EnumValue = 1 }, + { Name = "Target", Type = "EditModeUnitFrameSystemIndices", EnumValue = 2 }, + { Name = "Focus", Type = "EditModeUnitFrameSystemIndices", EnumValue = 3 }, + { Name = "Party", Type = "EditModeUnitFrameSystemIndices", EnumValue = 4 }, + { Name = "Raid", Type = "EditModeUnitFrameSystemIndices", EnumValue = 5 }, + { Name = "Boss", Type = "EditModeUnitFrameSystemIndices", EnumValue = 6 }, + { Name = "Arena", Type = "EditModeUnitFrameSystemIndices", EnumValue = 7 }, + { Name = "Pet", Type = "EditModeUnitFrameSystemIndices", EnumValue = 8 }, + }, + }, + { + Name = "EditModeVehicleSeatIndicatorSetting", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "Size", Type = "EditModeVehicleSeatIndicatorSetting", EnumValue = 0 }, + }, + }, + { + Name = "EncounterEventsIconDirection", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Left", Type = "EncounterEventsIconDirection", EnumValue = 0 }, + { Name = "Right", Type = "EncounterEventsIconDirection", EnumValue = 1 }, + { Name = "Top", Type = "EncounterEventsIconDirection", EnumValue = 0 }, + { Name = "Bottom", Type = "EncounterEventsIconDirection", EnumValue = 1 }, + }, + }, + { + Name = "EncounterEventsOrientation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horizontal", Type = "EncounterEventsOrientation", EnumValue = 0 }, + { Name = "Vertical", Type = "EncounterEventsOrientation", EnumValue = 1 }, + }, + }, + { + Name = "EncounterEventsTooltipAnchor", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Hidden", Type = "EncounterEventsTooltipAnchor", EnumValue = 0 }, + { Name = "Default", Type = "EncounterEventsTooltipAnchor", EnumValue = 1 }, + { Name = "Cursor", Type = "EncounterEventsTooltipAnchor", EnumValue = 2 }, + }, + }, + { + Name = "EncounterEventsViewType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Timeline", Type = "EncounterEventsViewType", EnumValue = 0 }, + { Name = "Bars", Type = "EncounterEventsViewType", EnumValue = 1 }, + }, + }, + { + Name = "EncounterEventsVisibility", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Always", Type = "EncounterEventsVisibility", EnumValue = 0 }, + { Name = "InEncounter", Type = "EncounterEventsVisibility", EnumValue = 1 }, + { Name = "DeprecatedHidden", Type = "EncounterEventsVisibility", EnumValue = 2 }, + }, + }, + { + Name = "MicroMenuOrder", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Default", Type = "MicroMenuOrder", EnumValue = 0 }, + { Name = "Reverse", Type = "MicroMenuOrder", EnumValue = 1 }, + }, + }, + { + Name = "MicroMenuOrientation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horizontal", Type = "MicroMenuOrientation", EnumValue = 0 }, + { Name = "Vertical", Type = "MicroMenuOrientation", EnumValue = 1 }, + }, + }, + { + Name = "RaidAuraOrganizationType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Legacy", Type = "RaidAuraOrganizationType", EnumValue = 0 }, + { Name = "BuffsTopDebuffsBottom", Type = "RaidAuraOrganizationType", EnumValue = 1 }, + { Name = "BuffsRightDebuffsLeft", Type = "RaidAuraOrganizationType", EnumValue = 2 }, + }, + }, + { + Name = "RaidDispelDisplayType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Disabled", Type = "RaidDispelDisplayType", EnumValue = 0 }, + { Name = "DispellableByMe", Type = "RaidDispelDisplayType", EnumValue = 1 }, + { Name = "DisplayAll", Type = "RaidDispelDisplayType", EnumValue = 2 }, + }, + }, + { + Name = "RaidGroupDisplayType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "SeparateGroupsVertical", Type = "RaidGroupDisplayType", EnumValue = 0 }, + { Name = "SeparateGroupsHorizontal", Type = "RaidGroupDisplayType", EnumValue = 1 }, + { Name = "CombineGroupsVertical", Type = "RaidGroupDisplayType", EnumValue = 2 }, + { Name = "CombineGroupsHorizontal", Type = "RaidGroupDisplayType", EnumValue = 3 }, + }, + }, + { + Name = "SortPlayersBy", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Role", Type = "SortPlayersBy", EnumValue = 0 }, + { Name = "Group", Type = "SortPlayersBy", EnumValue = 1 }, + { Name = "Alphabetical", Type = "SortPlayersBy", EnumValue = 2 }, + }, + }, + { + Name = "ViewArenaSize", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Two", Type = "ViewArenaSize", EnumValue = 0 }, + { Name = "Three", Type = "ViewArenaSize", EnumValue = 1 }, + }, + }, + { + Name = "ViewRaidSize", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Ten", Type = "ViewRaidSize", EnumValue = 0 }, + { Name = "TwentyFive", Type = "ViewRaidSize", EnumValue = 1 }, + { Name = "Forty", Type = "ViewRaidSize", EnumValue = 2 }, + }, + }, + { + Name = "EditModeConsts", + Type = "Constants", + Values = + { + { Name = "EditModeDefaultGridSpacing", Type = "number", Value = 100 }, + { Name = "EditModeMinGridSpacing", Type = "number", Value = 20 }, + { Name = "EditModeMaxGridSpacing", Type = "number", Value = 300 }, + { Name = "EditModeMaxLayoutsPerType", Type = "number", Value = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EditModeManagerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstants_MainlineDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstants_MainlineDocumentation.lua.annotated.lua new file mode 100644 index 0000000..99b1406 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerConstants_MainlineDocumentation.lua.annotated.lua @@ -0,0 +1,16 @@ +local EditModeManagerConstants_Mainline = +{ + Tables = + { + { + Name = "EditModeLayoutConsts", + Type = "Constants", + Values = + { + { Name = "EditModeDefaultLayout", Type = "EditModePresetLayouts", Value = Enum.EditModePresetLayouts.Modern }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EditModeManagerConstants_Mainline); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1e2a735 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EditModeManagerDocumentation.lua.annotated.lua @@ -0,0 +1,206 @@ +local EditModeManager = +{ + Name = "EditModeManager", + Type = "System", + Namespace = "C_EditMode", + Environment = "All", + + Functions = + { + { + Name = "ConvertLayoutInfoToString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layoutInfo", Type = "EditModeLayoutInfo", Nilable = false }, + }, + + Returns = + { + { Name = "layoutInfoAsString", Type = "string", Nilable = false }, + }, + }, + { + Name = "ConvertStringToLayoutInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layoutInfoAsString", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "layoutInfo", Type = "EditModeLayoutInfo", Nilable = false }, + }, + }, + { + Name = "GetAccountSettings", + Type = "Function", + + Returns = + { + { Name = "accountSettings", Type = "table", InnerType = "EditModeSettingInfo", Nilable = false }, + }, + }, + { + Name = "GetLayouts", + Type = "Function", + + Returns = + { + { Name = "layoutInfo", Type = "EditModeLayouts", Nilable = false }, + }, + }, + { + Name = "IsValidLayoutName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isApproved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnEditModeExit", + Type = "Function", + }, + { + Name = "OnLayoutAdded", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "addedLayoutIndex", Type = "luaIndex", Nilable = false }, + { Name = "activateNewLayout", Type = "bool", Nilable = false }, + { Name = "isLayoutImported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnLayoutDeleted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deletedLayoutIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SaveLayouts", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "saveInfo", Type = "EditModeLayouts", Nilable = false }, + }, + }, + { + Name = "SetAccountSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setting", Type = "EditModeAccountSetting", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetActiveLayout", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activeLayout", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "EditModeLayoutsUpdated", + Type = "Event", + LiteralName = "EDIT_MODE_LAYOUTS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "layoutInfo", Type = "EditModeLayouts", Nilable = false }, + { Name = "reconcileLayouts", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "EditModeAnchorInfo", + Type = "Structure", + Fields = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "string", Nilable = false }, + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "EditModeLayoutInfo", + Type = "Structure", + Fields = + { + { Name = "layoutName", Type = "string", Nilable = false }, + { Name = "layoutType", Type = "EditModeLayoutType", Nilable = false }, + { Name = "systems", Type = "table", InnerType = "EditModeSystemInfo", Nilable = false }, + }, + }, + { + Name = "EditModeLayouts", + Type = "Structure", + Fields = + { + { Name = "layouts", Type = "table", InnerType = "EditModeLayoutInfo", Nilable = false }, + { Name = "activeLayout", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EditModeSettingInfo", + Type = "Structure", + Fields = + { + { Name = "setting", Type = "number", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "EditModeSystemInfo", + Type = "Structure", + Fields = + { + { Name = "system", Type = "EditModeSystem", Nilable = false }, + { Name = "systemIndex", Type = "luaIndex", Nilable = true }, + { Name = "anchorInfo", Type = "EditModeAnchorInfo", Nilable = false }, + { Name = "anchorInfo2", Type = "EditModeAnchorInfo", Nilable = true }, + { Name = "settings", Type = "table", InnerType = "EditModeSettingInfo", Nilable = false }, + { Name = "isInDefaultPosition", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EditModeManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9baa978 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,17 @@ +local EncodingUtilConstants = +{ + Tables = + { + { + Name = "EncodingLimits", + Type = "Constants", + Values = + { + { Name = "EncodingDecompressSizeLimit", Type = "size", Value = 104857600 }, + { Name = "EncodingStackSizeLimit", Type = "number", Value = 100 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncodingUtilConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b0dcba8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncodingUtilDocumentation.lua.annotated.lua @@ -0,0 +1,238 @@ +local EncodingUtil = +{ + Name = "EncodingUtil", + Type = "System", + Namespace = "C_EncodingUtil", + Environment = "All", + + Functions = + { + { + Name = "CompressString", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "stringView", Nilable = false }, + { Name = "method", Type = "CompressionMethod", Nilable = false, Default = "Deflate" }, + { Name = "level", Type = "CompressionLevel", Nilable = false, Default = "Default" }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "DecodeBase64", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "stringView", Nilable = false }, + { Name = "variant", Type = "Base64Variant", Nilable = false, Default = "Standard" }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "DecodeHex", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "DecompressString", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "stringView", Nilable = false }, + { Name = "method", Type = "CompressionMethod", Nilable = false, Default = "Deflate" }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "DeserializeCBOR", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "LuaValueVariant", Nilable = true }, + }, + }, + { + Name = "DeserializeJSON", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "LuaValueVariant", Nilable = true }, + }, + }, + { + Name = "EncodeBase64", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "stringView", Nilable = false }, + { Name = "variant", Type = "Base64Variant", Nilable = false, Default = "Standard" }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "EncodeHex", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "SerializeCBOR", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "value", Type = "LuaValueVariant", Nilable = true }, + { Name = "options", Type = "CBORSerializationOptions", Nilable = true }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + { + Name = "SerializeJSON", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "value", Type = "LuaValueVariant", Nilable = true }, + { Name = "options", Type = "JSONSerializationOptions", Nilable = true }, + }, + + Returns = + { + { Name = "output", Type = "string", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "Base64Variant", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Standard", Type = "Base64Variant", EnumValue = 0, Documentation = { "Encodes with the alphabet defined in RFC 4648 (with potential padding bytes)" } }, + { Name = "StandardUrlSafe", Type = "Base64Variant", EnumValue = 1, Documentation = { "Encodes with the 'URL and Filename Safe' alphabet from RFC 4648 (with potential padding bytes)" } }, + }, + }, + { + Name = "CompressionLevel", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Default", Type = "CompressionLevel", EnumValue = 0 }, + { Name = "OptimizeForSpeed", Type = "CompressionLevel", EnumValue = 1 }, + { Name = "OptimizeForSize", Type = "CompressionLevel", EnumValue = 2 }, + }, + }, + { + Name = "CompressionMethod", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Deflate", Type = "CompressionMethod", EnumValue = 0 }, + { Name = "Zlib", Type = "CompressionMethod", EnumValue = 1 }, + { Name = "Gzip", Type = "CompressionMethod", EnumValue = 2 }, + }, + }, + { + Name = "CBORSerializationOptions", + Type = "Structure", + Fields = + { + { Name = "ignoreSerializationErrors", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, attempt to ignore errors from unsupported values and instead replace them where applicable with 'undefined' CBOR items." } }, + }, + }, + { + Name = "JSONSerializationOptions", + Type = "Structure", + Fields = + { + { Name = "ignoreSerializationErrors", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, attempt to ignore errors from unsupported values and instead replace them where applicable with 'null' JSON values." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncodingUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8d5e5fc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsDocumentation.lua.annotated.lua @@ -0,0 +1,140 @@ +local EncounterEvents = +{ + Name = "EncounterEvents", + Type = "System", + Namespace = "C_EncounterEvents", + Environment = "All", + + Functions = + { + { + Name = "GetEventColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns any custom color override applied for an encounter event." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + }, + }, + { + Name = "GetEventInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns information about an encounter event." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "encounterEventInfo", Type = "EncounterEventInfo", Nilable = false }, + }, + }, + { + Name = "GetEventList", + Type = "Function", + Documentation = { "Returns a list of all encounter event IDs." }, + + Returns = + { + { Name = "encounterEventIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetEventSound", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns information on a custom sound file to be played when an encounter event trigger occurs." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + { Name = "trigger", Type = "EncounterEventSoundTrigger", Nilable = false }, + }, + + Returns = + { + { Name = "sound", Type = "EncounterEventSoundInfo", Nilable = false }, + }, + }, + { + Name = "HasEventInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if an encounter event record with a specified ID exists." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayEventSound", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Plays any registered custom sound file for a given encounter event trigger." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + { Name = "trigger", Type = "EncounterEventSoundTrigger", Nilable = false }, + }, + + Returns = + { + { Name = "handle", Type = "SoundHandle", Nilable = false }, + }, + }, + { + Name = "SetEventColor", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Sets a custom color override for an encounter event. This can be used to colorize text or timer bars individually." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + }, + }, + { + Name = "SetEventSound", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Sets a custom sound file to be played when an encounter event trigger occurs." }, + + Arguments = + { + { Name = "encounterEventID", Type = "number", Nilable = false }, + { Name = "trigger", Type = "EncounterEventSoundTrigger", Nilable = false }, + { Name = "sound", Type = "EncounterEventSoundInfo", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterEvents); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2682054 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterEventsSharedDocumentation.lua.annotated.lua @@ -0,0 +1,45 @@ +local EncounterEventsShared = +{ + Tables = + { + { + Name = "EncounterEventSoundTrigger", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "OnTextWarningShown", Type = "EncounterEventSoundTrigger", EnumValue = 0, Documentation = { "Trigger to be activated when an text warning is initially shown for an encounter event." } }, + { Name = "OnTimelineEventFinished", Type = "EncounterEventSoundTrigger", EnumValue = 1, Documentation = { "Trigger to be activated when an encounter event on the timeline transitions to a finished (ie. casted, or resolved) state." } }, + { Name = "OnTimelineEventHighlight", Type = "EncounterEventSoundTrigger", EnumValue = 2, Documentation = { "Trigger to be activated when an encounter event reaches its 'highlight' duration on the timeline (typically, ~5s before the cast is due)." } }, + }, + }, + { + Name = "EncounterEventInfo", + Type = "Structure", + Fields = + { + { Name = "encounterEventID", Type = "number", Nilable = false, Documentation = { "ID of the encounter event record." } }, + { Name = "enabled", Type = "bool", Nilable = false, Documentation = { "If true, this event should be displayed on boss ability HUD elements." } }, + { Name = "spellID", Type = "number", Nilable = false, Documentation = { "Spell ID that triggers this event. A single spell may be used by multiple encounter events." } }, + { Name = "iconFileID", Type = "number", Nilable = false, Documentation = { "Icon file ID for the event. Typically the same as the spell icon, but may be overridden." } }, + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false, Documentation = { "Severity level of this event." } }, + { Name = "icons", Type = "EncounterEventIconmask", Nilable = false, Documentation = { "Bitmask of spell support icons to show for this event." } }, + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true, Documentation = { "Color associated with this event. At present, only set if an override has been applied via the SetEventColor function." } }, + }, + }, + { + Name = "EncounterEventSoundInfo", + Type = "Structure", + Fields = + { + { Name = "file", Type = "FileAsset", Nilable = false, Documentation = { "Sound file to be played when triggered." } }, + { Name = "channel", Type = "UISoundSubType", Nilable = false, Default = "g_defaultSI3UISoundSubTypeForLua", Documentation = { "Sound channel to play this file on." } }, + { Name = "volume", Type = "number", Nilable = false, Default = 1, Documentation = { "Volume scalar for the sound file." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterEventsShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f3ce484 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterInfoDocumentation.lua.annotated.lua @@ -0,0 +1,101 @@ +local EncounterInfo = +{ + Name = "EncounterInfo", + Type = "System", + Namespace = "C_EncounterInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "BossKill", + Type = "Event", + LiteralName = "BOSS_KILL", + SynchronousEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "encounterName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "DisableLowLevelRaid", + Type = "Event", + LiteralName = "DISABLE_LOW_LEVEL_RAID", + SynchronousEvent = true, + }, + { + Name = "EnableLowLevelRaid", + Type = "Event", + LiteralName = "ENABLE_LOW_LEVEL_RAID", + SynchronousEvent = true, + }, + { + Name = "EncounterEnd", + Type = "Event", + LiteralName = "ENCOUNTER_END", + SynchronousEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "encounterName", Type = "cstring", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "groupSize", Type = "number", Nilable = false }, + { Name = "success", Type = "number", Nilable = false }, + }, + }, + { + Name = "EncounterStart", + Type = "Event", + LiteralName = "ENCOUNTER_START", + SynchronousEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "encounterName", Type = "cstring", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "groupSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "InstanceLockStart", + Type = "Event", + LiteralName = "INSTANCE_LOCK_START", + SynchronousEvent = true, + }, + { + Name = "InstanceLockStop", + Type = "Event", + LiteralName = "INSTANCE_LOCK_STOP", + SynchronousEvent = true, + }, + { + Name = "InstanceLockWarning", + Type = "Event", + LiteralName = "INSTANCE_LOCK_WARNING", + SynchronousEvent = true, + }, + { + Name = "RaidTargetUpdate", + Type = "Event", + LiteralName = "RAID_TARGET_UPDATE", + SynchronousEvent = true, + }, + { + Name = "UpdateInstanceInfo", + Type = "Event", + LiteralName = "UPDATE_INSTANCE_INFO", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..12e986d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,128 @@ +local EncounterJournalConstants = +{ + Tables = + { + { + Name = "JournalEncounterFlags", + Type = "Enumeration", + NumValues = 7, + MinValue = 1, + MaxValue = 64, + Fields = + { + { Name = "Obsolete", Type = "JournalEncounterFlags", EnumValue = 1 }, + { Name = "LimitDifficulties", Type = "JournalEncounterFlags", EnumValue = 2 }, + { Name = "AllianceOnly", Type = "JournalEncounterFlags", EnumValue = 4 }, + { Name = "HordeOnly", Type = "JournalEncounterFlags", EnumValue = 8 }, + { Name = "NoMap", Type = "JournalEncounterFlags", EnumValue = 16 }, + { Name = "InternalOnly", Type = "JournalEncounterFlags", EnumValue = 32 }, + { Name = "DoNotDisplayEncounter", Type = "JournalEncounterFlags", EnumValue = 64 }, + }, + }, + { + Name = "JournalEncounterIconFlags", + Type = "Enumeration", + NumValues = 14, + MinValue = 1, + MaxValue = 8192, + Fields = + { + { Name = "Tank", Type = "JournalEncounterIconFlags", EnumValue = 1 }, + { Name = "Dps", Type = "JournalEncounterIconFlags", EnumValue = 2 }, + { Name = "Healer", Type = "JournalEncounterIconFlags", EnumValue = 4 }, + { Name = "Heroic", Type = "JournalEncounterIconFlags", EnumValue = 8 }, + { Name = "Deadly", Type = "JournalEncounterIconFlags", EnumValue = 16 }, + { Name = "Important", Type = "JournalEncounterIconFlags", EnumValue = 32 }, + { Name = "Interruptible", Type = "JournalEncounterIconFlags", EnumValue = 64 }, + { Name = "Magic", Type = "JournalEncounterIconFlags", EnumValue = 128 }, + { Name = "Curse", Type = "JournalEncounterIconFlags", EnumValue = 256 }, + { Name = "Poison", Type = "JournalEncounterIconFlags", EnumValue = 512 }, + { Name = "Disease", Type = "JournalEncounterIconFlags", EnumValue = 1024 }, + { Name = "Enrage", Type = "JournalEncounterIconFlags", EnumValue = 2048 }, + { Name = "Mythic", Type = "JournalEncounterIconFlags", EnumValue = 4096 }, + { Name = "Bleed", Type = "JournalEncounterIconFlags", EnumValue = 8192 }, + }, + }, + { + Name = "JournalEncounterItemFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "Obsolete", Type = "JournalEncounterItemFlags", EnumValue = 1 }, + { Name = "LimitDifficulties", Type = "JournalEncounterItemFlags", EnumValue = 2 }, + { Name = "DisplayAsPerPlayerLoot", Type = "JournalEncounterItemFlags", EnumValue = 4 }, + { Name = "DisplayAsVeryRare", Type = "JournalEncounterItemFlags", EnumValue = 8 }, + { Name = "DisplayAsExtremelyRare", Type = "JournalEncounterItemFlags", EnumValue = 16 }, + }, + }, + { + Name = "JournalEncounterLocFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "Primary", Type = "JournalEncounterLocFlags", EnumValue = 1 }, + }, + }, + { + Name = "JournalEncounterSecTypes", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Generic", Type = "JournalEncounterSecTypes", EnumValue = 0 }, + { Name = "Creature", Type = "JournalEncounterSecTypes", EnumValue = 1 }, + { Name = "Ability", Type = "JournalEncounterSecTypes", EnumValue = 2 }, + { Name = "Overview", Type = "JournalEncounterSecTypes", EnumValue = 3 }, + }, + }, + { + Name = "JournalEncounterSectionFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "StartExpanded", Type = "JournalEncounterSectionFlags", EnumValue = 1 }, + { Name = "LimitDifficulties", Type = "JournalEncounterSectionFlags", EnumValue = 2 }, + }, + }, + { + Name = "JournalInstanceFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Timewalker", Type = "JournalInstanceFlags", EnumValue = 1 }, + { Name = "HideUserSelectableDifficulty", Type = "JournalInstanceFlags", EnumValue = 2 }, + { Name = "DoNotDisplayInstance", Type = "JournalInstanceFlags", EnumValue = 4 }, + }, + }, + { + Name = "JournalLinkTypes", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Instance", Type = "JournalLinkTypes", EnumValue = 0 }, + { Name = "Encounter", Type = "JournalLinkTypes", EnumValue = 1 }, + { Name = "Section", Type = "JournalLinkTypes", EnumValue = 2 }, + { Name = "Tier", Type = "JournalLinkTypes", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterJournalConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e662ce2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterJournalDocumentation.lua.annotated.lua @@ -0,0 +1,373 @@ +local EncounterJournal = +{ + Name = "EncounterJournal", + Type = "System", + Namespace = "C_EncounterJournal", + Environment = "All", + + Functions = + { + { + Name = "GetDungeonEntrancesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dungeonEntrances", Type = "table", InnerType = "DungeonEntranceMapInfo", Nilable = false }, + }, + }, + { + Name = "GetEncounterJournalLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "linkType", Type = "JournalLinkTypes", Nilable = false }, + { Name = "ID", Type = "number", Nilable = false }, + { Name = "displayText", Type = "string", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetEncountersOnMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "encounters", Type = "table", InnerType = "EncounterJournalMapEncounterInfo", Nilable = false }, + }, + }, + { + Name = "GetInstanceForGameMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "GameMap as opposed to UIMap since we use a mapID not a uiMapID." }, + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "journalInstanceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetLootInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemInfo", Type = "EncounterJournalItemInfo", Nilable = false }, + }, + }, + { + Name = "GetLootInfoByIndex", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "encounterIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "itemInfo", Type = "EncounterJournalItemInfo", Nilable = false }, + }, + }, + { + Name = "GetSectionIconFlags", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Represents the icon indices for this EJ section. An icon index can be used to arrive at texture coordinates for specific encounter types, e.g.: EncounterJournal_SetFlagIcon" }, + + Arguments = + { + { Name = "sectionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "iconFlags", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetSectionInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sectionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "EncounterJournalSectionInfo", Nilable = false }, + }, + }, + { + Name = "GetSlotFilter", + Type = "Function", + + Returns = + { + { Name = "filter", Type = "ItemSlotFilterType", Nilable = false }, + }, + }, + { + Name = "InitalizeSelectedTier", + Type = "Function", + }, + { + Name = "InstanceHasLoot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "instanceID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "hasLoot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEncounterComplete", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "journalEncounterID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isEncounterComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnClose", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "OnOpen", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "ResetSlotFilter", + Type = "Function", + }, + { + Name = "SetPreviewMythicPlusLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPreviewPvpTier", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tier", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSlotFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterSlot", Type = "ItemSlotFilterType", Nilable = false }, + }, + }, + { + Name = "SetTab", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tabIdx", Type = "number", Nilable = false }, + }, + }, + { + Name = "StartArathiRPE", + Type = "Function", + }, + }, + + Events = + { + { + Name = "EjDifficultyUpdate", + Type = "Event", + LiteralName = "EJ_DIFFICULTY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "EjLootDataRecieved", + Type = "Event", + LiteralName = "EJ_LOOT_DATA_RECIEVED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ShowJourneysUI", + Type = "Event", + LiteralName = "SHOW_JOURNEYS_UI", + SynchronousEvent = true, + Documentation = { "Signaled when the UI needs to display the journeys dashboard at a specific faction." }, + Payload = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ItemSlotFilterType", + Type = "Enumeration", + NumValues = 16, + MinValue = 0, + MaxValue = 15, + Fields = + { + { Name = "Head", Type = "ItemSlotFilterType", EnumValue = 0 }, + { Name = "Neck", Type = "ItemSlotFilterType", EnumValue = 1 }, + { Name = "Shoulder", Type = "ItemSlotFilterType", EnumValue = 2 }, + { Name = "Cloak", Type = "ItemSlotFilterType", EnumValue = 3 }, + { Name = "Chest", Type = "ItemSlotFilterType", EnumValue = 4 }, + { Name = "Wrist", Type = "ItemSlotFilterType", EnumValue = 5 }, + { Name = "Hand", Type = "ItemSlotFilterType", EnumValue = 6 }, + { Name = "Waist", Type = "ItemSlotFilterType", EnumValue = 7 }, + { Name = "Legs", Type = "ItemSlotFilterType", EnumValue = 8 }, + { Name = "Feet", Type = "ItemSlotFilterType", EnumValue = 9 }, + { Name = "MainHand", Type = "ItemSlotFilterType", EnumValue = 10 }, + { Name = "OffHand", Type = "ItemSlotFilterType", EnumValue = 11 }, + { Name = "Finger", Type = "ItemSlotFilterType", EnumValue = 12 }, + { Name = "Trinket", Type = "ItemSlotFilterType", EnumValue = 13 }, + { Name = "Other", Type = "ItemSlotFilterType", EnumValue = 14 }, + { Name = "NoFilter", Type = "ItemSlotFilterType", EnumValue = 15 }, + }, + }, + { + Name = "DungeonEntranceMapInfo", + 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 = false }, + { Name = "atlasName", Type = "string", Nilable = false }, + { Name = "journalInstanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "EncounterJournalItemInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "encounterID", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "itemQuality", Type = "string", Nilable = true }, + { Name = "filterType", Type = "ItemSlotFilterType", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "slot", Type = "string", Nilable = true }, + { Name = "armorType", Type = "string", Nilable = true }, + { Name = "link", Type = "string", Nilable = true }, + { Name = "handError", Type = "bool", Nilable = true }, + { Name = "weaponTypeError", Type = "bool", Nilable = true }, + { Name = "displayAsPerPlayerLoot", Type = "bool", Nilable = true }, + { Name = "displayAsVeryRare", Type = "bool", Nilable = true }, + { Name = "displayAsExtremelyRare", Type = "bool", Nilable = true }, + { Name = "displaySeasonID", Type = "number", Nilable = true }, + }, + }, + { + Name = "EncounterJournalMapEncounterInfo", + Type = "Structure", + Fields = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "mapX", Type = "number", Nilable = false }, + { Name = "mapY", Type = "number", Nilable = false }, + }, + }, + { + Name = "EncounterJournalSectionInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "title", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = true }, + { Name = "headerType", Type = "number", Nilable = false }, + { Name = "abilityIcon", Type = "fileID", Nilable = false }, + { Name = "creatureDisplayID", Type = "number", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false }, + { Name = "siblingSectionID", Type = "number", Nilable = true }, + { Name = "firstChildSectionID", Type = "number", Nilable = true }, + { Name = "filteredByDifficulty", Type = "bool", Nilable = false }, + { Name = "link", Type = "string", Nilable = false }, + { Name = "startsOpen", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterJournal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d445518 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,135 @@ +local EncounterTimelineConstants = +{ + Tables = + { + { + Name = "EncounterTimelineEventSortDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Descending", Type = "EncounterTimelineEventSortDirection", EnumValue = 0, Documentation = { "Events are sorted in descending order (longest time remaining to shortest)." } }, + { Name = "Ascending", Type = "EncounterTimelineEventSortDirection", EnumValue = 1, Documentation = { "Events are sorted in ascending order (shortest time remaining to longest)." } }, + }, + }, + { + Name = "EncounterTimelineEventSource", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Documentation = { "Enumeration of all encounter timeline event sources." }, + Fields = + { + { Name = "Encounter", Type = "EncounterTimelineEventSource", EnumValue = 0, Documentation = { "Source used for events added by an instance encounter." } }, + { Name = "Script", Type = "EncounterTimelineEventSource", EnumValue = 1, Documentation = { "Source used for events added by Lua scripting APIs. This is used to apply API restrictions; the Pause/Cancel/ResumeScriptEvent functions only work on Script events." } }, + { Name = "EditMode", Type = "EncounterTimelineEventSource", EnumValue = 2, Documentation = { "Source used for events added by the AddEditModeEvents script API." } }, + }, + }, + { + Name = "EncounterTimelineEventState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Documentation = { "Enumeration of all encounter timeline event states." }, + Fields = + { + { Name = "Active", Type = "EncounterTimelineEventState", EnumValue = 0 }, + { Name = "Paused", Type = "EncounterTimelineEventState", EnumValue = 1 }, + { Name = "Finished", Type = "EncounterTimelineEventState", EnumValue = 2 }, + { Name = "Canceled", Type = "EncounterTimelineEventState", EnumValue = 3 }, + }, + }, + { + Name = "EncounterTimelineIconSet", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 6, + Fields = + { + { Name = "TankAlert", Type = "EncounterTimelineIconSet", EnumValue = 1 }, + { Name = "HealerAlert", Type = "EncounterTimelineIconSet", EnumValue = 2 }, + { Name = "DamageAlert", Type = "EncounterTimelineIconSet", EnumValue = 3 }, + { Name = "Deadly", Type = "EncounterTimelineIconSet", EnumValue = 4 }, + { Name = "Dispel", Type = "EncounterTimelineIconSet", EnumValue = 5 }, + { Name = "Enrage", Type = "EncounterTimelineIconSet", EnumValue = 6 }, + }, + }, + { + Name = "EncounterTimelineTrack", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Documentation = { "Enumeration of all encounter timeline tracks., Tracks are not permitted to overlap (but may have a zero duration span), and are contiguously ordered from shortest maximum duration to longest." }, + Fields = + { + { Name = "Queued", Type = "EncounterTimelineTrack", EnumValue = 0 }, + { Name = "Short", Type = "EncounterTimelineTrack", EnumValue = 1, Documentation = { "This track always has a zero minimum duration." } }, + { Name = "Medium", Type = "EncounterTimelineTrack", EnumValue = 2 }, + { Name = "Long", Type = "EncounterTimelineTrack", EnumValue = 3 }, + { Name = "Indeterminate", Type = "EncounterTimelineTrack", EnumValue = 4, Documentation = { "This track is used as a placeholder for events whose position is not calculated and shouldn't appear on the timeline." } }, + }, + }, + { + Name = "EncounterTimelineTrackType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Documentation = { "Enumeration of all encounter timeline track types. Track types infer behavioral aspects of the track, for example whether or not we associate sort orders to events in the track." }, + Fields = + { + { Name = "Hidden", Type = "EncounterTimelineTrackType", EnumValue = 0 }, + { Name = "Sorted", Type = "EncounterTimelineTrackType", EnumValue = 1 }, + { Name = "Linear", Type = "EncounterTimelineTrackType", EnumValue = 2 }, + }, + }, + { + Name = "EncounterTimelineViewType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Documentation = { "Enumeration of view types for the timeline., View types control layout parameters for the timeline such as maximum track durations and event counts, and optimize event processing for expected display behaviors." }, + Fields = + { + { Name = "None", Type = "EncounterTimelineViewType", EnumValue = 0, Documentation = { "Configures the view for an empty timeline display. This mode is recommended for user addons that take full control of the timeline display." } }, + { Name = "Timeline", Type = "EncounterTimelineViewType", EnumValue = 1, Documentation = { "Configures the view for a linear timeline display." } }, + { Name = "Bars", Type = "EncounterTimelineViewType", EnumValue = 2, Documentation = { "Configures the view for a sorted timer bar display." } }, + }, + }, + { + Name = "EncounterTimelineEventConstants", + Type = "Constants", + Values = + { + { Name = "ENCOUNTER_TIMELINE_INVALID_EVENT", Type = "number", Value = 0, Documentation = { "Constant used for invalid event IDs. Script APIs are guaranteed to always return nil data if supplied this ID, and events will never be added to the timeline with this ID." } }, + { Name = "ENCOUNTER_TIMELINE_RESERVED_EVENT_COUNT", Type = "number", Value = 40, Documentation = { "Minimum size of internal arrays that are preallocated for event storage." } }, + }, + }, + { + Name = "EncounterTimelineIconMasks", + Type = "Constants", + Values = + { + { Name = "EncounterTimelineTankAlertIcons", Type = "EncounterEventIconmask", Value = 128 }, + { Name = "EncounterTimelineHealerAlertIcons", Type = "EncounterEventIconmask", Value = 256 }, + { Name = "EncounterTimelineDamageAlertIcons", Type = "EncounterEventIconmask", Value = 512 }, + { Name = "EncounterTimelineDeadlyIcons", Type = "EncounterEventIconmask", Value = 1 }, + { Name = "EncounterTimelineDispelIcons", Type = "EncounterEventIconmask", Value = 124 }, + { Name = "EncounterTimelineEnrageIcons", Type = "EncounterEventIconmask", Value = 2 }, + { Name = "EncounterTimelineAllIcons", Type = "EncounterEventIconmask", Value = 1023 }, + { Name = "EncounterTimelineRoleIcons", Type = "EncounterEventIconmask", Value = 896 }, + { Name = "EncounterTimelineOtherIcons", Type = "EncounterEventIconmask", Value = 127 }, + { Name = "EncounterTimelineNoIcons", Type = "EncounterEventIconmask", Value = 0 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterTimelineConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua.annotated.lua new file mode 100644 index 0000000..718940b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterTimelineDocumentation.lua.annotated.lua @@ -0,0 +1,605 @@ +local EncounterTimeline = +{ + Name = "EncounterTimeline", + Type = "System", + Namespace = "C_EncounterTimeline", + Environment = "All", + + Functions = + { + { + Name = "AddEditModeEvents", + Type = "Function", + Documentation = { "Adds a predefined set of events to the timeline for display in Edit Mode." }, + + Returns = + { + { Name = "loopTimerDuration", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "AddScriptEvent", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Adds a custom event to the timeline." }, + + Arguments = + { + { Name = "eventInfo", Type = "EncounterTimelineScriptEventRequest", Nilable = false }, + }, + + Returns = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "CancelAllScriptEvents", + Type = "Function", + Documentation = { "Cancels all custom timeline events, removing them from the timeline." }, + }, + { + Name = "CancelEditModeEvents", + Type = "Function", + Documentation = { "Removes all Edit Mode events from the timeline." }, + }, + { + Name = "CancelScriptEvent", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Cancels a custom timeline event, removing it from the timeline." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "FinishScriptEvent", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Finishes a custom timeline event, removing it from the timeline." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "GetCurrentTime", + Type = "Function", + Documentation = { "Returns the current timestamp used for rendering the timeline display." }, + + Returns = + { + { Name = "currentTime", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetEventCountBySource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the number of present events in the timeline by their source type." }, + + Arguments = + { + { Name = "source", Type = "EncounterTimelineEventSource", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEventHighlightTime", + Type = "Function", + Documentation = { "Returns the duration at which timeline events will be highlighted for imminency." }, + + Returns = + { + { Name = "highlightTime", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetEventInfo", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretWhenEncounterEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Returns information about a timeline event. This data is generally expected to be static for the lifetime of an event." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "EncounterTimelineEventInfo", Nilable = false }, + }, + }, + { + Name = "GetEventList", + Type = "Function", + Documentation = { "Returns an unsorted list of event IDs present in the timeline." }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "GetEventState", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Returns the current state of a timeline event." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "EncounterTimelineEventState", Nilable = false }, + }, + }, + { + Name = "GetEventTimeElapsed", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Returns the elapsed duration of a timeline event." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "timeElapsed", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetEventTimeRemaining", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Returns the remaining duration of a timeline event." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "timeRemaining", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetEventTimer", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Returns a Duration object that tracks the elapsed duration of a timeline event. This object tracks the range [0, duration] of the event and automatically pauses its progression based on event state." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = true }, + }, + }, + { + Name = "GetEventTrack", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Returns information about the position of an event on the timeline." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "track", Type = "EncounterTimelineTrack", Nilable = false }, + { Name = "trackSortIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetSortedEventList", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Returns a sorted list of event IDs present in the timeline from shortest to longest remaining durations, meeting the requirements of the specified filters." }, + + Arguments = + { + { Name = "maxEventCount", Type = "number", Nilable = true, Documentation = { "Maximum number of sorted events to return." } }, + { Name = "maxEventDuration", Type = "DurationSeconds", Nilable = true, Documentation = { "Maximum duration of sorted events to return." } }, + { Name = "excludeTerminalStates", Type = "bool", Nilable = false, Default = true, Documentation = { "If false, include events that are terminal states such as Canceled or Finished." } }, + { Name = "excludeHiddenEvents", Type = "bool", Nilable = false, Default = true, Documentation = { "If false, include events that should be hidden by user configuration, such as events on long tracks when the user has opted to not show long countdowns." } }, + }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "GetTrackInfo", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Returns information for a single timeline track." }, + + Arguments = + { + { Name = "track", Type = "EncounterTimelineTrack", Nilable = false }, + }, + + Returns = + { + { Name = "trackInfo", Type = "EncounterTimelineTrackInfo", Nilable = false }, + }, + }, + { + Name = "GetTrackList", + Type = "Function", + Documentation = { "Returns information about all timeline tracks." }, + + Returns = + { + { Name = "tracks", Type = "table", InnerType = "EncounterTimelineTrackInfo", Nilable = false }, + }, + }, + { + Name = "GetTrackMaxEventDuration", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Returns the maximum permitted event duration on a single timeline track." }, + + Arguments = + { + { Name = "track", Type = "EncounterTimelineTrack", Nilable = false }, + }, + + Returns = + { + { Name = "maxEventDuration", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetTrackType", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Returns the type of a single timeline track." }, + + Arguments = + { + { Name = "track", Type = "EncounterTimelineTrack", Nilable = false }, + }, + + Returns = + { + { Name = "trackType", Type = "EncounterTimelineTrackType", Nilable = false }, + }, + }, + { + Name = "GetViewType", + Type = "Function", + Documentation = { "Returns the current view type of the timeline." }, + + Returns = + { + { Name = "viewType", Type = "EncounterTimelineViewType", Nilable = false }, + }, + }, + { + Name = "HasActiveEvents", + Type = "Function", + Documentation = { "Returns true if the timeline contains any events in the active state." }, + + Returns = + { + { Name = "hasActiveEvents", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasAnyEvents", + Type = "Function", + Documentation = { "Returns true if the timeline contains any events in any state." }, + + Returns = + { + { Name = "hasAnyEvents", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPausedEvents", + Type = "Function", + Documentation = { "Returns true if the timeline contains any events in the paused state." }, + + Returns = + { + { Name = "hasPausedEvents", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasVisibleEvents", + Type = "Function", + Documentation = { "Returns true if the timeline contains any events that are on visible tracks." }, + + Returns = + { + { Name = "hasVisibleEvents", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEventBlocked", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Returns true if the event is in a 'blocked' state, where the cast for this event may not occur due to encounter conditions not being met." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + + Returns = + { + { Name = "blocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFeatureAvailable", + Type = "Function", + Documentation = { "Returns true if the encounter timeline feature is available on this client." }, + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFeatureEnabled", + Type = "Function", + Documentation = { "Returns true if the encounter timeline feature has been enabled by the player. This function will always return false if the feature is not available." }, + + Returns = + { + { Name = "isAvailableAndEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PauseScriptEvent", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Pauses a custom timeline event, hiding it from the timeline. A paused event can later be resumed to show it again, or canceled." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "ResumeScriptEvent", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "NotAllowed", + Documentation = { "Resumes a custom timeline event, showing it on the timeline again if it is currently paused." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "SetEventIconTextures", + Type = "Function", + RequiresValidTimelineEvent = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Updates a given vector of texture objects to reference art assets for icons associated with an event." }, + + Arguments = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + { Name = "includeIcons", Type = "EncounterEventIconmask", Nilable = false, Documentation = { "Mask to apply to candidate icons. Any icon bits not present in this set will not be assigned to textures." } }, + { Name = "textures", Type = "table", InnerType = "SimpleTexture", Nilable = false, Documentation = { "Array of texture objects to update. This will change the assigned atlases and alpha values of the region, applying secret aspects to protect the data." } }, + }, + }, + { + Name = "SetViewType", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the view type for the timeline. This adjusts track layouts to be more appropriate for a specific mode and optimizes event processing." }, + + Arguments = + { + { Name = "viewType", Type = "EncounterTimelineViewType", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "EncounterTimelineEventAdded", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_EVENT_ADDED", + SecretWhenEncounterEvent = true, + SynchronousEvent = true, + Documentation = { "Fired when an event has been added to the timeline." }, + Payload = + { + { Name = "eventInfo", Type = "EncounterTimelineEventInfo", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineEventBlockStateChanged", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_EVENT_BLOCK_STATE_CHANGED", + UniqueEvent = true, + Documentation = { "Fired when an event has transitioned into or out of a 'blocked' status." }, + Payload = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineEventHighlight", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_EVENT_HIGHLIGHT", + UniqueEvent = true, + Documentation = { "Fired when an event has met a condition that should trigger its highlight glow animation." }, + Payload = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineEventRemoved", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_EVENT_REMOVED", + UniqueEvent = true, + Documentation = { "Fired when an event has been removed from the timeline. This is guaranteed to fire after an event has transitioned to a 'final' state such as Canceled or Finished, and will be delayed at least one game tick to allow for API queries to still access event data in OnUpdate scripts. This is fired post-removal of the event, and so queries using the supplied event ID will return nil." }, + Payload = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineEventStateChanged", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_EVENT_STATE_CHANGED", + UniqueEvent = true, + Documentation = { "Fired when an event has changed state." }, + Payload = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineEventTrackChanged", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_EVENT_TRACK_CHANGED", + UniqueEvent = true, + Documentation = { "Fired when an event has changed track, or has been re-ordered within its existing track." }, + Payload = + { + { Name = "eventID", Type = "EncounterTimelineEventID", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineLayoutUpdated", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_LAYOUT_UPDATED", + SynchronousEvent = true, + Documentation = { "Fired when the layout of tracks on the timeline has been updated. This can include changes to the minimum or maximum durations of tracks." }, + }, + { + Name = "EncounterTimelineStateUpdated", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_STATE_UPDATED", + UniqueEvent = true, + Documentation = { "Signaled when conditions controlling the visibility of the encounter timeline are updated." }, + }, + { + Name = "EncounterTimelineViewActivated", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_VIEW_ACTIVATED", + SynchronousEvent = true, + Documentation = { "Fired when a new timeline view is being activated. This is fired after a full layout and timeline data update, allowing the UI to immediately query the API and get usable results." }, + Payload = + { + { Name = "viewType", Type = "EncounterTimelineViewType", Nilable = false }, + }, + }, + { + Name = "EncounterTimelineViewDeactivated", + Type = "Event", + LiteralName = "ENCOUNTER_TIMELINE_VIEW_DEACTIVATED", + SynchronousEvent = true, + Documentation = { "Fired when the current timeline view is being deactivated. The UI should clear all stored timeline event data and release all frames back to pools during this event." }, + Payload = + { + { Name = "viewType", Type = "EncounterTimelineViewType", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "EncounterTimelineEventFilter", + Type = "Structure", + Fields = + { + { Name = "maxEventCount", Type = "number", Nilable = true, Documentation = { "Maximum number of sorted events to return." } }, + { Name = "maxEventDuration", Type = "DurationSeconds", Nilable = true, Documentation = { "Maximum duration of sorted events to return." } }, + { Name = "excludeTerminalStates", Type = "bool", Nilable = false, Default = true, Documentation = { "If false, include events that are terminal states such as Canceled or Finished." } }, + { Name = "excludeHiddenEvents", Type = "bool", Nilable = false, Default = true, Documentation = { "If false, include events that should be hidden by user configuration, such as events on long tracks when the user has opted to not show long countdowns." } }, + }, + }, + { + Name = "EncounterTimelineEventInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "EncounterTimelineEventID", Nilable = false, NeverSecret = true, Documentation = { "Instance ID for this event." } }, + { Name = "source", Type = "EncounterTimelineEventSource", Nilable = false, NeverSecret = true, Documentation = { "Source that this event came from." } }, + { Name = "spellName", Type = "string", Nilable = false, Documentation = { "Spell name associated with this event. For script events, this may instead be the contents of the 'overrideName' field if it wasn't empty." } }, + { Name = "spellID", Type = "number", Nilable = false, Documentation = { "Spell ID associated with this event." } }, + { Name = "iconFileID", Type = "fileID", Nilable = false, Documentation = { "Icon file ID associated with this event." } }, + { Name = "duration", Type = "DurationSeconds", Nilable = false, NeverSecret = true, Documentation = { "Base duration of this event at the point that it was queued onto the timeline." } }, + { Name = "maxQueueDuration", Type = "DurationSeconds", Nilable = false, NeverSecret = true, Documentation = { "Hold duration for this event after it reaches the end of the timeline. During this period, the event will sit in the queued track of the timeline until manually finished or this added duration expires." } }, + { Name = "icons", Type = "EncounterEventIconmask", Nilable = false, Documentation = { "Bitmask of active icon states for this event." } }, + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false, Documentation = { "Severity of this event." } }, + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false, Documentation = { "Color to use for displaying this event. May be overridden by C_EncounterEvents APIs, else will default to an appropriate color for the current view mode." } }, + { Name = "isApproximate", Type = "bool", Nilable = false, Documentation = { "If true, this event is an approximation and may not occur exactly when the timeline suggests it will." } }, + }, + }, + { + Name = "EncounterTimelineScriptEventRequest", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "maxQueueDuration", Type = "DurationSeconds", Nilable = false, Default = 0 }, + { Name = "overrideName", Type = "stringView", Nilable = false, Default = "" }, + { Name = "icons", Type = "EncounterEventIconmask", Nilable = true }, + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false, Default = "Medium" }, + { Name = "paused", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "EncounterTimelineTrackInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "EncounterTimelineTrack", Nilable = false }, + { Name = "type", Type = "EncounterTimelineTrackType", Nilable = false }, + { Name = "minimumDuration", Type = "DurationSeconds", Nilable = true, Documentation = { "The exclusive lower bound of durations for events on this track. If zero, this should be treated as an inclusive lower bound. This bound is ignored by the timeline sequence in circumstances where an adjacent Sorted track would exceed its maximum event count, requiring events be pushed 'to the left' by one track." } }, + { Name = "maximumDuration", Type = "DurationSeconds", Nilable = true, Documentation = { "The inclusive upper bound of durations for events on this track." } }, + { Name = "minimumEventIntroDuration", Type = "DurationSeconds", Nilable = true, Documentation = { "Lower duration bound for events that want to transition onto this track from an Indeterminate position. Events below this duration are artificially kept in the indeterminate track state until they can transition into a later track in the timeline sequence." } }, + { Name = "minimumEventGapDuration", Type = "DurationSeconds", Nilable = true, Documentation = { "Minimum duration gap that must exist between two sequential candidate events for this track. If two event durations have a distance under this figure, the later of the two events will be artifically kept in the indeterminate track state until it can transition into a later track in the timeline sequence." } }, + { Name = "maximumEventCount", Type = "number", Nilable = true, Documentation = { "The maximum number of events permitted within this track. This only applies to Sorted tracks." } }, + { Name = "sortDirection", Type = "EncounterTimelineEventSortDirection", Nilable = true, Documentation = { "Sort ordering for events within this track. This only applies to Sorted tracks." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterTimeline); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..435bed8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EncounterWarningsDocumentation.lua.annotated.lua @@ -0,0 +1,173 @@ +local EncounterWarnings = +{ + Name = "EncounterWarnings", + Type = "System", + Namespace = "C_EncounterWarnings", + Environment = "All", + + Functions = + { + { + Name = "GetColorForSeverity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetEditModeWarningInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false }, + }, + + Returns = + { + { Name = "warningInfo", Type = "EncounterWarningInfo", Nilable = false }, + }, + }, + { + Name = "GetPlayCustomSoundsWhenHidden", + Type = "Function", + Documentation = { "Returns true if custom sound alerts are allowed to play for hidden warning messages." }, + + Returns = + { + { Name = "play", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSoundKitForSeverity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false }, + }, + + Returns = + { + { Name = "soundKitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWarningsShown", + Type = "Function", + Documentation = { "Returns true if text messages for encounter events are allowed to be shown." }, + + Returns = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFeatureAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFeatureEnabled", + Type = "Function", + + Returns = + { + { Name = "isAvailableAndEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlaySound", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false }, + }, + + Returns = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPlayCustomSoundsWhenHidden", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Controls whether custom sound alerts for encounter events are allowed to play for warning messages that are hidden." }, + + Arguments = + { + { Name = "play", Type = "bool", Nilable = false, Documentation = { "If true, allow playing custom sound alerts. Note that sound alerts will not be played if the encounter warnings feature has been disabled." } }, + }, + }, + { + Name = "SetWarningsShown", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Controls whether text messages for encounter events are allowed to be shown." }, + + Arguments = + { + { Name = "shown", Type = "bool", Nilable = false, Documentation = { "If false, hides all warning messages in the default UI." } }, + }, + }, + }, + + Events = + { + { + Name = "EncounterWarning", + Type = "Event", + LiteralName = "ENCOUNTER_WARNING", + SynchronousEvent = true, + Payload = + { + { Name = "encounterWarningInfo", Type = "EncounterWarningInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "EncounterWarningInfo", + Type = "Structure", + Fields = + { + { Name = "text", Type = "cstring", Nilable = false, SecretValue = true }, + { Name = "casterGUID", Type = "WOWGUID", Nilable = false, SecretValue = true }, + { Name = "casterName", Type = "cstring", Nilable = false, SecretValue = true }, + { Name = "targetGUID", Type = "WOWGUID", Nilable = false, SecretValue = true }, + { Name = "targetName", Type = "cstring", Nilable = false, SecretValue = true }, + { Name = "iconFileID", Type = "number", Nilable = false, SecretValue = true }, + { Name = "tooltipSpellID", Type = "number", Nilable = false, SecretValue = true }, + { Name = "isDeadly", Type = "bool", Nilable = false, SecretValue = true }, + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false, SecretValue = true }, + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "severity", Type = "EncounterEventSeverity", Nilable = false }, + { Name = "shouldPlaySound", Type = "bool", Nilable = false }, + { Name = "shouldShowChatMessage", Type = "bool", Nilable = false }, + { Name = "shouldShowWarning", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EncounterWarnings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..689a831 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EndOfMatchUIDocumentation.lua.annotated.lua @@ -0,0 +1,80 @@ +local EndOfMatchUI = +{ + Name = "EndOfMatchUI", + Type = "System", + Namespace = "C_EndOfMatchUI", + Environment = "All", + + Functions = + { + { + Name = "GetEndOfMatchDetails", + Type = "Function", + + Returns = + { + { Name = "matchDetails", Type = "MatchDetails", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "ShowEndOfMatchUI", + Type = "Event", + LiteralName = "SHOW_END_OF_MATCH_UI", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "EndOfMatchType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "EndOfMatchType", EnumValue = 0 }, + { Name = "Plunderstorm", Type = "EndOfMatchType", EnumValue = 1 }, + }, + }, + { + Name = "MatchDetailType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Placement", Type = "MatchDetailType", EnumValue = 0 }, + { Name = "Kills", Type = "MatchDetailType", EnumValue = 1 }, + { Name = "PlunderAcquired", Type = "MatchDetailType", EnumValue = 2 }, + }, + }, + { + Name = "MatchDetail", + Type = "Structure", + Fields = + { + { Name = "type", Type = "MatchDetailType", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "MatchDetails", + Type = "Structure", + Fields = + { + { Name = "matchType", Type = "EndOfMatchType", Nilable = false }, + { Name = "matchEnded", Type = "bool", Nilable = false }, + { Name = "detailsList", Type = "table", InnerType = "MatchDetail", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EndOfMatchUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fe8ca9f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EquipmentManagerDocumentation.lua.annotated.lua @@ -0,0 +1,341 @@ +local EquipmentManager = +{ + Name = "EquipmentSet", + Type = "System", + Namespace = "C_EquipmentSet", + Environment = "All", + + Functions = + { + { + Name = "AssignSpecToEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "specIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CanUseEquipmentSets", + Type = "Function", + + Returns = + { + { Name = "canUseEquipmentSets", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearIgnoredSlotsForSave", + Type = "Function", + }, + { + Name = "CreateEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetName", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "DeleteEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "EquipmentSetContainsLockedItems", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasLockedItems", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetEquipmentSetAssignedSpec", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetEquipmentSetForSpec", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEquipmentSetID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEquipmentSetIDs", + Type = "Function", + + Returns = + { + { Name = "equipmentSetIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetEquipmentSetInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconFileID", Type = "number", Nilable = false }, + { Name = "setID", Type = "number", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "numEquipped", Type = "number", Nilable = false }, + { Name = "numInInventory", Type = "number", Nilable = false }, + { Name = "numLost", Type = "number", Nilable = false }, + { Name = "numIgnored", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIgnoredSlots", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slotIgnored", Type = "table", InnerType = "bool", Nilable = false, NilableContents = true }, + }, + }, + { + Name = "GetItemIDs", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false, NilableContents = true }, + }, + }, + { + Name = "GetItemLocations", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "locations", Type = "table", InnerType = "number", Nilable = false, NilableContents = true }, + }, + }, + { + Name = "GetNumEquipmentSets", + Type = "Function", + + Returns = + { + { Name = "numEquipmentSets", Type = "number", Nilable = false }, + }, + }, + { + Name = "IgnoreSlotForSave", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "IsSlotIgnoredForSave", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isSlotIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ModifyEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "newName", Type = "cstring", Nilable = false }, + { Name = "newIcon", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "PickupEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SaveEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "icon", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "UnassignEquipmentSetSpec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnignoreSlotForSave", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "UseEquipmentSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "setWasEquipped", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "EquipmentSetsChanged", + Type = "Event", + LiteralName = "EQUIPMENT_SETS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "EquipmentSwapFinished", + Type = "Event", + LiteralName = "EQUIPMENT_SWAP_FINISHED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "bool", Nilable = false }, + { Name = "setID", Type = "number", Nilable = true }, + }, + }, + { + Name = "EquipmentSwapPending", + Type = "Event", + LiteralName = "EQUIPMENT_SWAP_PENDING", + SynchronousEvent = true, + }, + { + Name = "TransmogCustomSetsChanged", + Type = "Event", + LiteralName = "TRANSMOG_CUSTOM_SETS_CHANGED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(EquipmentManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ba88943 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,19 @@ +local EventSchedulerConstants = +{ + Tables = + { + { + Name = "EventScheduler", + Type = "Constants", + Values = + { + { Name = "SCHEDULED_EVENT_REMINDER_WARNING_SECONDS", Type = "number", Value = 300 }, + { Name = "SCHEDULED_EVENT_FUTURE_LIMIT", Type = "number", Value = 12 }, + { Name = "SCHEDULED_EVENT_REMINDER_DEAD_SECONDS", Type = "number", Value = 10 }, + { Name = "SCHEDULED_EVENT_PAST_LIMIT_SECONDS", Type = "number", Value = 3600 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EventSchedulerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6bf1ea7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventSchedulerUIDocumentation.lua.annotated.lua @@ -0,0 +1,186 @@ +local EventSchedulerUI = +{ + Name = "EventSchedulerUI", + Type = "System", + Namespace = "C_EventScheduler", + Environment = "All", + + Functions = + { + { + Name = "CanShowEvents", + Type = "Function", + Documentation = { "Returns true if there are any events eligible to show for the player." }, + + Returns = + { + { Name = "canShow", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearReminder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Clears reminder on a scheduled event. Must use endTime to identify which specific instance in the case of repeating ones." }, + + Arguments = + { + { Name = "eventKey", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActiveContinentName", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Returns the name of the continent with current events" }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetEventUiMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Will try to figure out a UiMap for an areaPOI." }, + + Arguments = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetEventZoneName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Will try to figure out a map zone name for an areaPOI" }, + + Arguments = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetOngoingEvents", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Will request data from the server on a throttle" }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "OngoingEventInfo", Nilable = false }, + }, + }, + { + Name = "GetScheduledEvents", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Will request data from the server on a throttle" }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "ScheduledEventInfo", Nilable = false }, + }, + }, + { + Name = "HasData", + Type = "Function", + Documentation = { "True if the server sent a list, even if the list had 0 events." }, + + Returns = + { + { Name = "hasData", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSavedReminders", + Type = "Function", + Documentation = { "Returns whether there are any event reminders saved. Can include reminders that have expired since set and haven't gotten removed yet. Has to be called after cvars are loaded." }, + + Returns = + { + { Name = "hasSavedReminders", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestEvents", + Type = "Function", + Documentation = { "Requests events from the server, subject to throttle" }, + }, + { + Name = "SetReminder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Sets reminder on a scheduled event. Must use endTime to identify which specific instance in the case of repeating ones." }, + + Arguments = + { + { Name = "eventKey", Type = "string", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "EventSchedulerUpdate", + Type = "Event", + LiteralName = "EVENT_SCHEDULER_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "EventDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "hideTimeLeft", Type = "bool", Nilable = false, Default = false }, + { Name = "hideDescription", Type = "bool", Nilable = false, Default = false }, + { Name = "overrideAtlas", Type = "textureAtlas", Nilable = true }, + { Name = "overrideTooltipWidgetSetID", Type = "number", Nilable = true }, + }, + }, + { + Name = "OngoingEventInfo", + Type = "Structure", + Fields = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "rewardsClaimed", Type = "bool", Nilable = false, Default = false }, + { Name = "displayInfo", Type = "EventDisplayInfo", Nilable = false }, + }, + }, + { + Name = "ScheduledEventInfo", + Type = "Structure", + Fields = + { + { Name = "eventKey", Type = "string", Nilable = false }, + { Name = "eventID", Type = "number", Nilable = false }, + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "endTime", Type = "time_t", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "hasReminder", Type = "bool", Nilable = false, Default = false }, + { Name = "rewardsClaimed", Type = "bool", Nilable = false, Default = false }, + { Name = "displayInfo", Type = "EventDisplayInfo", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(EventSchedulerUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..16880b6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/EventUtilsDocumentation.lua.annotated.lua @@ -0,0 +1,51 @@ +local EventUtils = +{ + Name = "EventUtils", + Type = "System", + Namespace = "C_EventUtils", + Environment = "All", + + Functions = + { + { + Name = "IsCallbackEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "isCallbackEvent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEventValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(EventUtils); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2161da3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local ExpansionConstants = +{ + Tables = + { + { + Name = "ReleaseType", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "Original", Type = "ReleaseType", EnumValue = 1 }, + { Name = "Classic", Type = "ReleaseType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ExpansionConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua.annotated.lua new file mode 100644 index 0000000..01b62af --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionDocumentation.lua.annotated.lua @@ -0,0 +1,324 @@ +local Expansion = +{ + Name = "Expansion", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CanUpgradeToCurrentExpansion", + Type = "Function", + + Returns = + { + { Name = "canUpgradeExpansion", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesCurrentLocaleSellExpansionLevels", + Type = "Function", + + Returns = + { + { Name = "regionSellsExpansions", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAccountExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetClientDisplayExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentRegionName", + Type = "Function", + + Returns = + { + { Name = "regionName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetExpansionDisplayInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + { Name = "desiredReleaseType", Type = "ReleaseType", Nilable = true }, + }, + + Returns = + { + { Name = "info", Type = "ExpansionDisplayInfo", Nilable = true }, + }, + }, + { + Name = "GetExpansionForLevel", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExpansionTrialInfo", + Type = "Function", + + Returns = + { + { Name = "isExpansionTrialAccount", Type = "bool", Nilable = false }, + { Name = "expansionTrialRemainingSeconds", Type = "time_t", Nilable = true }, + }, + }, + { + Name = "GetMaxLevelForExpansionLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Maps an expansion level to a maximum character level for that expansion." }, + + Arguments = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxLevelForLatestExpansion", + Type = "Function", + + Returns = + { + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxLevelForPlayerExpansion", + Type = "Function", + + Returns = + { + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaximumExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMinimumExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumExpansions", + Type = "Function", + + Returns = + { + { Name = "numExpansions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetServerExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "serverExpansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUpgradeExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "upgradeExpansionLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsDemonHunterAvailable", + Type = "Function", + + Returns = + { + { Name = "available", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsExpansionTrial", + Type = "Function", + + Returns = + { + { Name = "isExpansionTrialAccount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrialAccount", + Type = "Function", + + Returns = + { + { Name = "isTrialAccount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVeteranTrialAccount", + Type = "Function", + + Returns = + { + { Name = "isVeteranTrialAccount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SendSubscriptionInterstitialResponse", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "response", Type = "SubscriptionInterstitialResponseType", Nilable = false }, + }, + }, + { + Name = "ShouldShowExpansionUpgradeBanner", + Type = "Function", + + Returns = + { + { Name = "showUpgradeBanner", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "MaxExpansionLevelUpdated", + Type = "Event", + LiteralName = "MAX_EXPANSION_LEVEL_UPDATED", + SynchronousEvent = true, + }, + { + Name = "MinExpansionLevelUpdated", + Type = "Event", + LiteralName = "MIN_EXPANSION_LEVEL_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ShowSubscriptionInterstitial", + Type = "Event", + LiteralName = "SHOW_SUBSCRIPTION_INTERSTITIAL", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "SubscriptionInterstitialType", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "SubscriptionInterstitialResponseType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Clicked", Type = "SubscriptionInterstitialResponseType", EnumValue = 0 }, + { Name = "Closed", Type = "SubscriptionInterstitialResponseType", EnumValue = 1 }, + { Name = "WebRedirect", Type = "SubscriptionInterstitialResponseType", EnumValue = 2 }, + }, + }, + { + Name = "SubscriptionInterstitialType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Standard", Type = "SubscriptionInterstitialType", EnumValue = 0 }, + { Name = "LeftNpeArea", Type = "SubscriptionInterstitialType", EnumValue = 1 }, + { Name = "MaxLevel", Type = "SubscriptionInterstitialType", EnumValue = 2 }, + }, + }, + { + Name = "ExpansionDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "logo", Type = "fileID", Nilable = false }, + { Name = "banner", Type = "textureAtlas", Nilable = false }, + { Name = "features", Type = "table", InnerType = "ExpansionDisplayInfoFeature", Nilable = false }, + { Name = "highResBackgroundID", Type = "fileID", Nilable = false }, + { Name = "lowResBackgroundID", Type = "fileID", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "glueAmbianceSoundKit", Type = "number", Nilable = true }, + { Name = "glueMusicSoundKit", Type = "number", Nilable = true }, + { Name = "glueCreditsSoundKit", Type = "number", Nilable = true }, + }, + }, + { + Name = "ExpansionDisplayInfoFeature", + Type = "Structure", + Fields = + { + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Expansion); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f55c1a8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionInfoDocumentation.lua.annotated.lua @@ -0,0 +1,59 @@ +local ExpansionInfo = +{ + Name = "ExpansionInfo", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "ClassicExpansionAtLeast", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAtLeast", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClassicExpansionAtMost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAtMost", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetClassicExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ExpansionInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionLevelConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionLevelConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d1ae374 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionLevelConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local ExpansionLevelConstants = +{ + Tables = + { + { + Name = "ExpansionLevel", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "None", Type = "ExpansionLevel", EnumValue = 0 }, + { Name = "BurningCrusade", Type = "ExpansionLevel", EnumValue = 1 }, + { Name = "Northrend", Type = "ExpansionLevel", EnumValue = 2 }, + { Name = "Cataclysm", Type = "ExpansionLevel", EnumValue = 3 }, + { Name = "MistsOfPandaria", Type = "ExpansionLevel", EnumValue = 4 }, + { Name = "Draenor", Type = "ExpansionLevel", EnumValue = 5 }, + { Name = "Legion", Type = "ExpansionLevel", EnumValue = 6 }, + { Name = "BattleForAzeroth", Type = "ExpansionLevel", EnumValue = 7 }, + { Name = "Shadowlands", Type = "ExpansionLevel", EnumValue = 8 }, + { Name = "Dragonflight", Type = "ExpansionLevel", EnumValue = 9 }, + { Name = "WarWithin", Type = "ExpansionLevel", EnumValue = 10 }, + { Name = "Midnight", Type = "ExpansionLevel", EnumValue = 11 }, + { Name = "LastTitan", Type = "ExpansionLevel", EnumValue = 12 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ExpansionLevelConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua.annotated.lua new file mode 100644 index 0000000..625a100 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExpansionTrialDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local ExpansionTrial = +{ + Name = "ExpansionTrial", + Type = "System", + Namespace = "C_ExpansionTrial", + Environment = "All", + + Functions = + { + { + Name = "OnTrialLevelUpDialogClicked", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "OnTrialLevelUpDialogShown", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ExpansionTrial); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7845986 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ExternalEventURLDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local ExternalEventURL = +{ + Name = "ExternalEventURL", + Type = "System", + Namespace = "C_ExternalEventURL", + Environment = "All", + + Functions = + { + { + Name = "HasURL", + Type = "Function", + + Returns = + { + { Name = "hasURL", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNew", + Type = "Function", + + Returns = + { + { Name = "isNew", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LaunchURL", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ExternalEventURL); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua.annotated.lua new file mode 100644 index 0000000..21a733e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FogOfWarDocumentation.lua.annotated.lua @@ -0,0 +1,68 @@ +local FogOfWar = +{ + Name = "FogOfWar", + Type = "System", + Namespace = "C_FogOfWar", + Environment = "All", + + Functions = + { + { + Name = "GetFogOfWarForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "fogOfWarID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFogOfWarInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fogOfWarID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "fogOfWarInfo", Type = "FogOfWarInfo", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "FogOfWarUpdated", + Type = "Event", + LiteralName = "FOG_OF_WAR_UPDATED", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "FogOfWarInfo", + Type = "Structure", + Fields = + { + { Name = "fogOfWarID", Type = "number", Nilable = false }, + { Name = "backgroundAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "maskAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "maskScalar", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(FogOfWar); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FontDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FontDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d7f68de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FontDocumentation.lua.annotated.lua @@ -0,0 +1,94 @@ +local Font = +{ + Name = "Font", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CreateFontFamily", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "members", Type = "table", InnerType = "CreateFontFamilyMemberInfo", Nilable = false }, + }, + + Returns = + { + { Name = "fontFamily", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetFontInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontObject", Type = "SimpleFont", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "FontScriptInfo", Nilable = true }, + }, + }, + { + Name = "GetFonts", + Type = "Function", + + Returns = + { + { Name = "fontNames", Type = "table", InnerType = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "CreateFontFamilyMemberInfo", + Type = "Structure", + Fields = + { + { Name = "alphabet", Type = "FontAlphabet", Nilable = false }, + { Name = "file", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "FontScriptInfo", + Type = "Structure", + Fields = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + { Name = "outline", Type = "cstring", Nilable = false }, + { Name = "shadow", Type = "FontScriptShadowInfo", Nilable = true }, + { Name = "fontObject", Type = "SimpleFont", Nilable = false }, + { Name = "canBeUserScaled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FontScriptShadowInfo", + Type = "Structure", + Fields = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Font); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIArchaeologyDigsiteDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIArchaeologyDigsiteDocumentation.lua.annotated.lua new file mode 100644 index 0000000..79d9ca7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIArchaeologyDigsiteDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local FrameAPIArchaeologyDigsite = +{ + Name = "FrameAPIArchaeologyDigSiteFrame", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIArchaeologyDigsite); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIBlobDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIBlobDocumentation.lua.annotated.lua new file mode 100644 index 0000000..32cc5da --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIBlobDocumentation.lua.annotated.lua @@ -0,0 +1,160 @@ +local FrameAPIBlob = +{ + Name = "FrameAPIBlob", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "DrawAll", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "DrawBlob", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "draw", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "DrawNone", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "EnableMerging", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "EnableSmoothing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetMapID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetBorderAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetBorderScalar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetBorderTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + }, + }, + { + Name = "SetFillAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFillTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + }, + }, + { + Name = "SetMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMergeThreshold", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "threshold", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetNumSplinePoints", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "numSplinePoints", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIBlob); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICharacterModelBaseDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICharacterModelBaseDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5926a3a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICharacterModelBaseDocumentation.lua.annotated.lua @@ -0,0 +1,283 @@ +local FrameAPICharacterModelBase = +{ + Name = "FrameAPICharacterModelBase", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ApplySpellVisualKit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + { Name = "oneShot", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "CanSetUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "FreezeAnimation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "anim", Type = "AnimationDataEnum", Nilable = false }, + { Name = "variation", Type = "number", Nilable = false }, + { Name = "frame", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDisplayInfo", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "displayID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDoBlend", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "doBlend", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetKeepModelOnHide", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "keepModelOnHide", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasAnimation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "anim", Type = "AnimationDataEnum", Nilable = false }, + }, + + Returns = + { + { Name = "hasAnimation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayAnimKit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "animKit", Type = "number", Nilable = false }, + { Name = "loop", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "RefreshCamera", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "RefreshUnit", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetAnimation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "anim", Type = "AnimationDataEnum", Nilable = false }, + { Name = "variation", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetBarberShopAlternateForm", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetCamDistanceScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCreature", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureID", Type = "number", Nilable = false }, + { Name = "displayID", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetDisplayInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "displayID", Type = "number", Nilable = false }, + { Name = "mountDisplayID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetDoBlend", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "doBlend", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = true }, + { Name = "itemVisualID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetItemAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "itemVisualID", Type = "number", Nilable = true }, + { Name = "itemSubclass", Type = "ItemWeaponSubclass", Nilable = true }, + }, + }, + { + Name = "SetKeepModelOnHide", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "keepModelOnHide", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPortraitZoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoom", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetRotation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + { Name = "animate", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "blend", Type = "bool", Nilable = false, Default = true }, + { Name = "useNativeForm", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StopAnimKit", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ZeroCachedCenterXY", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPICharacterModelBase); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICinematicModelDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICinematicModelDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5f3c9d4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICinematicModelDocumentation.lua.annotated.lua @@ -0,0 +1,205 @@ +local FrameAPICinematicModel = +{ + Name = "FrameAPICinematicModel", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "EquipItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "InitializeCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scaleFactor", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "InitializePanCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scaleFactor", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "RefreshCamera", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetAnimOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offset", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraTarget", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCreatureData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFacingLeft", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isFacingLeft", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetFadeTimes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fadeInSeconds", Type = "number", Nilable = false }, + { Name = "fadeOutSeconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetHeightFactor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factor", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetJumpInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "jumpLength", Type = "number", Nilable = false }, + { Name = "jumpHeight", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPanDistance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpellVisualKit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "visualKitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTargetDistance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "StartPan", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "panType", Type = "luaIndex", Nilable = false }, + { Name = "durationSeconds", Type = "number", Nilable = false }, + { Name = "doFade", Type = "bool", Nilable = false, Default = false }, + { Name = "visKitID", Type = "number", Nilable = false, Default = 0 }, + { Name = "startPositionScale", Type = "number", Nilable = false, Default = 0 }, + { Name = "speedMultiplier", Type = "number", Nilable = false, Default = 1 }, + }, + }, + { + Name = "StopPan", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "UnequipItems", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPICinematicModel); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICooldownDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICooldownDocumentation.lua.annotated.lua new file mode 100644 index 0000000..38a2c8d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPICooldownDocumentation.lua.annotated.lua @@ -0,0 +1,513 @@ +local FrameAPICooldown = +{ + Name = "FrameAPICooldown", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "Clear", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetCooldownDisplayDuration", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Cooldown }, + Documentation = { "The returned duration unit is milliseconds, unaffected by modRate." }, + + Arguments = + { + }, + + Returns = + { + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCooldownDuration", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Cooldown }, + Documentation = { "The returned duration unit is milliseconds and is multiplied by the modRate." }, + + Arguments = + { + }, + + Returns = + { + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCooldownTimes", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Cooldown }, + + Arguments = + { + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCountdownFontString", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "countdownString", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "GetDrawBling", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.CooldownStyle }, + + Arguments = + { + }, + + Returns = + { + { Name = "drawBling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDrawEdge", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.CooldownStyle }, + + Arguments = + { + }, + + Returns = + { + { Name = "drawEdge", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDrawSwipe", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.CooldownStyle }, + + Arguments = + { + }, + + Returns = + { + { Name = "drawSwipe", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetEdgeScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "edgeScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHideCountdownNumbers", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hideNumbers", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMinimumCountdownDuration", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "milliseconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetReverse", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRotation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "rotationRadians", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUseAuraDisplayTime", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "useAuraDisplayTime", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPaused", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isPaused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Pause", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Resume", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetBlingTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "FileAsset", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCooldown", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Cooldown }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "start", Type = "DurationSeconds", Nilable = false }, + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, + }, + }, + { + Name = "SetCooldownDuration", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Cooldown }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, + }, + }, + { + Name = "SetCooldownFromDurationObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + { Name = "clearIfZero", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetCooldownFromExpirationTime", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Cooldown }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "expirationTime", Type = "DurationSeconds", Nilable = false }, + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, + }, + }, + { + Name = "SetCooldownUNIX", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Cooldown }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, + }, + }, + { + Name = "SetCountdownAbbrevThreshold", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCountdownFont", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetDrawBling", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.CooldownStyle }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "drawBling", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetDrawEdge", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.CooldownStyle }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "drawEdge", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetDrawSwipe", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.CooldownStyle }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "drawSwipe", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetEdgeColor", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.CooldownStyle }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetEdgeScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetEdgeTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "FileAsset", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetHideCountdownNumbers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "hideNumbers", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetMinimumCountdownDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Controls the minimum duration above which countdown text will be shown. This is applied based upon the total duration of the cooldown, not the remaining duration as it ticks down." }, + + Arguments = + { + { Name = "milliseconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPaused", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "paused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetReverse", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetRotation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rotationRadians", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSwipeColor", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.CooldownStyle }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetSwipeTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "FileAsset", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTexCoordRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "low", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "high", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "SetUseAuraDisplayTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Aura durations are displayed slightly differently than cooldown durations. Setting this to true will adjust the display logic to stay in sync with aura timers." }, + + Arguments = + { + { Name = "useAuraDisplayTime", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetUseCircularEdge", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "useCircularEdge", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPICooldown); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIDressUpModelDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIDressUpModelDocumentation.lua.annotated.lua new file mode 100644 index 0000000..774518e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIDressUpModelDocumentation.lua.annotated.lua @@ -0,0 +1,268 @@ +local FrameAPIDressUpModel = +{ + Name = "FrameAPIDressUpModel", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "Dress", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetAutoDress", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemTransmogInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "itemTransmogInfo", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = false }, + }, + }, + { + Name = "GetItemTransmogInfoList", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "infoList", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + }, + { + Name = "GetObeyHideInTransmogFlag", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSheathed", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "sheathed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetUseTransmogChoices", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetUseTransmogSkin", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGeoReady", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "ready", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSlotAllowed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSlotVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "visible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAutoDress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetItemTransmogInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemTransmogInfo", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = false }, + { Name = "inventorySlot", Type = "luaIndex", Nilable = true }, + { Name = "ignoreChildItems", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "ItemTryOnReason", Nilable = false }, + }, + }, + { + Name = "SetObeyHideInTransmogFlag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetSheathed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sheathed", Type = "bool", Nilable = false, Default = false }, + { Name = "hideWeapons", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetUseTransmogChoices", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetUseTransmogSkin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TryOn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "linkOrItemModifiedAppearanceID", Type = "IDOrLink", Nilable = false }, + { Name = "handSlotName", Type = "cstring", Nilable = true }, + { Name = "spellEnchantID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "ItemTryOnReason", Nilable = true }, + }, + }, + { + Name = "Undress", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "UndressSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlot", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIDressUpModel); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIFogOfWarFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIFogOfWarFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4535829 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIFogOfWarFrameDocumentation.lua.annotated.lua @@ -0,0 +1,160 @@ +local FrameAPIFogOfWarFrame = +{ + Name = "FrameAPIFogOfWarFrame", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetFogOfWarBackgroundAtlas", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetFogOfWarBackgroundTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "asset", Type = "FileAsset", Nilable = true }, + }, + }, + { + Name = "GetFogOfWarMaskAtlas", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetFogOfWarMaskTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "asset", Type = "FileAsset", Nilable = true }, + }, + }, + { + Name = "GetMaskScalar", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUiMapID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFogOfWarBackgroundAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "SetFogOfWarBackgroundTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + { Name = "horizontalTile", Type = "bool", Nilable = false }, + { Name = "verticalTile", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFogOfWarMaskAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "SetFogOfWarMaskTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + }, + }, + { + Name = "SetMaskScalar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetUiMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIFogOfWarFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorBaseDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorBaseDocumentation.lua.annotated.lua new file mode 100644 index 0000000..aa29b88 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorBaseDocumentation.lua.annotated.lua @@ -0,0 +1,623 @@ +local FrameAPIModelSceneFrameActorBase = +{ + Name = "FrameAPIModelSceneFrameActorBase", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearModel", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetActiveBoundingBox", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "boxBottom", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + { Name = "boxTop", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + }, + }, + { + Name = "GetAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAnimation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "animation", Type = "AnimationDataEnum", Nilable = false }, + }, + }, + { + Name = "GetAnimationBlendOperation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "blendOp", Type = "ModelBlendOperation", Nilable = false }, + }, + }, + { + Name = "GetAnimationVariation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "variation", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDesaturation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxBoundingBox", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "boxBottom", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + { Name = "boxTop", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + }, + }, + { + Name = "GetModelFileID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetModelPath", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "path", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetModelUnitGUID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "guid", Type = "WOWGUID", Nilable = false, ConditionalSecret = true }, + }, + }, + { + Name = "GetParticleOverrideScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scale", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPitch", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "pitch", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRoll", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "roll", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellVisualKit", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetYaw", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "yaw", Type = "number", Nilable = false }, + }, + }, + { + Name = "Hide", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "IsLoaded", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPreferringModelCollisionBounds", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "preferringCollisionBounds", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsShown", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingCenterForOrigin", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "x", Type = "bool", Nilable = false }, + { Name = "y", Type = "bool", Nilable = false }, + { Name = "z", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVisible", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayAnimationKit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "animationKit", Type = "number", Nilable = false }, + { Name = "isLooping", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetAnimation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "animation", Type = "AnimationDataEnum", Nilable = false }, + { Name = "variation", Type = "number", Nilable = true }, + { Name = "animSpeed", Type = "number", Nilable = false, Default = 1 }, + { Name = "animOffsetSeconds", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetAnimationBlendOperation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "blendOp", Type = "ModelBlendOperation", Nilable = false }, + }, + }, + { + Name = "SetDesaturation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetGradientMask", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gradientIndex0", Type = "number", Nilable = false }, + { Name = "gradientIndex1", Type = "number", Nilable = false }, + { Name = "gradientIndex2", Type = "number", Nilable = false }, + { Name = "gradientIndex3", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetModelByCreatureDisplayID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureDisplayID", Type = "number", Nilable = false }, + { Name = "useActivePlayerCustomizations", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetModelByFileID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + { Name = "useMips", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetModelByPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + { Name = "useMips", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetModelByUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "sheatheWeapons", Type = "bool", Nilable = false, Default = false }, + { Name = "autoDress", Type = "bool", Nilable = false, Default = true }, + { Name = "hideWeapons", Type = "bool", Nilable = false, Default = false }, + { Name = "usePlayerNativeForm", Type = "bool", Nilable = false, Default = true }, + { Name = "holdBowString", Type = "bool", Nilable = false, Default = false }, + { Name = "customRaceID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetParticleOverrideScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetPitch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pitch", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPlayerModelFromGlues", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterIndex", Type = "number", Nilable = true }, + { Name = "sheatheWeapons", Type = "bool", Nilable = false, Default = false }, + { Name = "autoDress", Type = "bool", Nilable = false, Default = true }, + { Name = "hideWeapons", Type = "bool", Nilable = false, Default = false }, + { Name = "usePlayerNativeForm", Type = "bool", Nilable = false, Default = true }, + { Name = "customRaceID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPreferModelCollisionBounds", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If true, will try to use the collision bounds of models for sizing and centering. Will fall back to default model bounds if set to False, or if collision bounds are unavailable." }, + + Arguments = + { + { Name = "preferCollisionBounds", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRoll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roll", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetSpellVisualKit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellVisualKitID", Type = "number", Nilable = false, Default = 0 }, + { Name = "oneShot", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetUseCenterForOrigin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "bool", Nilable = false, Default = false }, + { Name = "y", Type = "bool", Nilable = false, Default = false }, + { Name = "z", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetYaw", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "yaw", Type = "number", Nilable = false }, + }, + }, + { + Name = "Show", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "StopAnimationKit", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "TryOn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLinkOrItemModifiedAppearanceID", Type = "cstring", Nilable = false }, + { Name = "handSlotName", Type = "cstring", Nilable = true }, + { Name = "spellEnchantmentID", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "reason", Type = "ItemTryOnReason", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIModelSceneFrameActorBase); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6728388 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameActorDocumentation.lua.annotated.lua @@ -0,0 +1,386 @@ +local FrameAPIModelSceneFrameActor = +{ + Name = "FrameAPIModelSceneFrameActor", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AttachToMount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rider", Type = "ModelSceneFrameActor", Nilable = false }, + { Name = "animation", Type = "AnimationDataEnum", Nilable = false }, + { Name = "spellKitVisualID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalculateMountScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rider", Type = "ModelSceneFrameActor", Nilable = false }, + }, + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "DetachFromMount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rider", Type = "ModelSceneFrameActor", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Dress", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "DressPlayerSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "invSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetAutoDress", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "autoDress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemTransmogInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlots", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemTransmogInfo", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = true }, + }, + }, + { + Name = "GetItemTransmogInfoList", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "infoList", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + }, + { + Name = "GetObeyHideInTransmogFlag", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "obey", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPaused", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "paused", Type = "bool", Nilable = false }, + { Name = "globalPaused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSheathed", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "sheathed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetUseTransmogChoices", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "use", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetUseTransmogSkin", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "use", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGeoReady", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSlotAllowed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlots", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSlotVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlots", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "visible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReleaseFrontEndCharacterDisplays", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetNextHandSlot", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetAutoDress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "autoDress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFrontEndLobbyModelFromDefaultCharacterDisplay", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetItemTransmogInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "transmogInfo", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = false }, + { Name = "inventorySlots", Type = "number", Nilable = true }, + { Name = "ignoreChildItems", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "ItemTryOnReason", Nilable = false }, + }, + }, + { + Name = "SetModelByHyperlink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetObeyHideInTransmogFlag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "obey", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPaused", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "paused", Type = "bool", Nilable = false }, + { Name = "affectsGlobalPause", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetSheathed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sheathed", Type = "bool", Nilable = false }, + { Name = "hidden", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetUseTransmogChoices", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "use", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetUseTransmogSkin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "use", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Undress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "includeWeapons", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "UndressSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlots", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIModelSceneFrameActor); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..066027f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameDocumentation.lua.annotated.lua @@ -0,0 +1,606 @@ +local FrameAPIModelSceneFrame = +{ + Name = "FrameAPIModelSceneFrame", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearFog", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "CreateActor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "template", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetActorAtIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetAllowOverlappedModels", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "allowOverlappedModels", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCameraFarClip", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "farClip", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraFieldOfView", + Type = "Function", + Documentation = { "Field of view in radians" }, + + Arguments = + { + }, + + Returns = + { + { Name = "fov", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraForward", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "forwardX", Type = "number", Nilable = false }, + { Name = "forwardY", Type = "number", Nilable = false }, + { Name = "forwardZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraNearClip", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "nearClip", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraPosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraRight", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "rightX", Type = "number", Nilable = false }, + { Name = "rightY", Type = "number", Nilable = false }, + { Name = "rightZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraUp", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "upX", Type = "number", Nilable = false }, + { Name = "upY", Type = "number", Nilable = false }, + { Name = "upZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDrawLayer", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + { Name = "sublevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFogColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFogFar", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "far", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFogNear", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "near", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLightAmbientColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLightDiffuseColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLightDirection", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "directionX", Type = "number", Nilable = false }, + { Name = "directionY", Type = "number", Nilable = false }, + { Name = "directionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLightPosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLightType", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "lightType", Type = "ModelLightType", Nilable = true }, + }, + }, + { + Name = "GetNumActors", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "numActors", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetViewInsets", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "insets", Type = "uiRect", Nilable = false }, + }, + }, + { + Name = "GetViewTranslation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "translationX", Type = "number", Nilable = false }, + { Name = "translationY", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsLightVisible", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Project3DPointTo2D", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pointX", Type = "number", Nilable = false }, + { Name = "pointY", Type = "number", Nilable = false }, + { Name = "pointZ", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "point2DX", Type = "number", Nilable = false }, + { Name = "point2DY", Type = "number", Nilable = false }, + { Name = "depth", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetAllowOverlappedModels", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allowOverlappedModels", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCameraFarClip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "farClip", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraFieldOfView", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Field of view in radians" }, + + Arguments = + { + { Name = "fov", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraNearClip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nearClip", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraOrientationByAxisVectors", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "forwardX", Type = "number", Nilable = false }, + { Name = "forwardY", Type = "number", Nilable = false }, + { Name = "forwardZ", Type = "number", Nilable = false }, + { Name = "rightX", Type = "number", Nilable = false }, + { Name = "rightY", Type = "number", Nilable = false }, + { Name = "rightZ", Type = "number", Nilable = false }, + { Name = "upX", Type = "number", Nilable = false }, + { Name = "upY", Type = "number", Nilable = false }, + { Name = "upZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraOrientationByYawPitchRoll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "yaw", Type = "number", Nilable = false }, + { Name = "pitch", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetDesaturation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetDrawLayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + }, + }, + { + Name = "SetFogColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFogFar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "far", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFogNear", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "near", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLightAmbientColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLightDiffuseColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLightDirection", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "directionX", Type = "number", Nilable = false }, + { Name = "directionY", Type = "number", Nilable = false }, + { Name = "directionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLightPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLightType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lightType", Type = "ModelLightType", Nilable = false }, + }, + }, + { + Name = "SetLightVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "visible", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetPaused", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "paused", Type = "bool", Nilable = false }, + { Name = "affectsGlobalPause", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetViewInsets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "insets", Type = "uiRect", Nilable = false }, + }, + }, + { + Name = "SetViewTranslation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "translationX", Type = "number", Nilable = false }, + { Name = "translationY", Type = "number", Nilable = false }, + }, + }, + { + Name = "TakeActor", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIModelSceneFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..024d90c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIModelSceneFrameSharedDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local FrameAPIModelSceneFrameShared = +{ + Tables = + { + { + Name = "ModelLightType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Directional", Type = "ModelLightType", EnumValue = 0 }, + { Name = "Point", Type = "ModelLightType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIModelSceneFrameShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPINamePlateDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPINamePlateDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7aa9f1c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPINamePlateDocumentation.lua.annotated.lua @@ -0,0 +1,30 @@ +local FrameAPINamePlate = +{ + Name = "FrameAPINamePlate", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "SetStackingBoundsFrame", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "frame", Type = "SimpleFrame", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPINamePlate); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIQuestPOIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIQuestPOIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..331f665 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIQuestPOIDocumentation.lua.annotated.lua @@ -0,0 +1,65 @@ +local FrameAPIQuestPOI = +{ + Name = "FrameAPIQuestPOI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetNumTooltips", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "numObjectives", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTooltipIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "objectiveIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateMouseOverTooltip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + { Name = "numObjectives", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIQuestPOI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIScenarioPOIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIScenarioPOIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..eee5942 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIScenarioPOIDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local FrameAPIScenarioPOI = +{ + Name = "FrameAPIScenarioPOI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetScenarioTooltipText", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "tooltipText", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "UpdateMouseOverTooltip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasTooltip", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIScenarioPOI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPISimpleCheckoutDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPISimpleCheckoutDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0af9816 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPISimpleCheckoutDocumentation.lua.annotated.lua @@ -0,0 +1,97 @@ +local FrameAPISimpleCheckout = +{ + Name = "FrameAPISimpleCheckout", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CancelOpenCheckout", + Type = "Function", + HasRestrictions = true, + + Arguments = + { + }, + }, + { + Name = "ClearFocus", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "CloseCheckout", + Type = "Function", + HasRestrictions = true, + + Arguments = + { + }, + }, + { + Name = "CopyExternalLink", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "OpenCheckout", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checkoutID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "wasOpened", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpenExternalLink", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetFocus", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetZoom", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomLevel", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPISimpleCheckout); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelBaseDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelBaseDocumentation.lua.annotated.lua new file mode 100644 index 0000000..da6ab23 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelBaseDocumentation.lua.annotated.lua @@ -0,0 +1,93 @@ +local FrameAPITabardModelBase = +{ + Name = "FrameAPITabardModelBase", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CanSaveTabardNow", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "canSave", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CycleVariation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "variationIndex", Type = "luaIndex", Nilable = false }, + { Name = "delta", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLowerEmblemTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetUpperEmblemTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "InitializeTabardColors", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "IsGuildTabard", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isGuildTabard", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Save", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPITabardModelBase); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cbd60bd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITabardModelDocumentation.lua.annotated.lua @@ -0,0 +1,98 @@ +local FrameAPITabardModel = +{ + Name = "FrameAPITabardModel", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetLowerBackgroundFileName", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetLowerBorderFile", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetLowerEmblemFile", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetUpperBackgroundFileName", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetUpperBorderFile", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetUpperEmblemFile", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "file", Type = "fileID", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPITabardModel); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITooltipDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITooltipDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6b06893 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPITooltipDocumentation.lua.annotated.lua @@ -0,0 +1,133 @@ +local FrameAPITooltip = +{ + Name = "FrameAPITooltip", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearPadding", + Type = "Function", + Documentation = { "Set all padding values to 0.0 and remove the Padding SecretAspect." }, + + Arguments = + { + }, + }, + { + Name = "GetLeftLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "line", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "leftFontString", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "GetMinimumWidth", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.MinimumWidth }, + + Arguments = + { + }, + + Returns = + { + { Name = "width", Type = "number", Nilable = false }, + { Name = "forced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPadding", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Padding }, + + Arguments = + { + }, + + Returns = + { + { Name = "right", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + { Name = "left", Type = "number", Nilable = false }, + { Name = "top", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRightLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "line", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "rightFontString", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "SetMinimumWidth", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.MinimumWidth }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "width", Type = "number", Nilable = false }, + { Name = "force", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetPadding", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Padding }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "right", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + { Name = "left", Type = "number", Nilable = true }, + { Name = "top", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "alpha", Type = "number", Nilable = true }, + { Name = "wrap", Type = "bool", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPITooltip); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIUnitPositionFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIUnitPositionFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b49d77a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameAPIUnitPositionFrameDocumentation.lua.annotated.lua @@ -0,0 +1,160 @@ +local FrameAPIUnitPositionFrame = +{ + Name = "FrameAPIUnitPositionFrame", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitTokenString", Type = "cstring", Nilable = false }, + { Name = "asset", Type = "TextureAssetDisk", Nilable = false }, + { Name = "width", Type = "uiUnit", Nilable = true }, + { Name = "height", Type = "uiUnit", Nilable = true }, + { Name = "r", Type = "number", Nilable = true }, + { Name = "g", Type = "number", Nilable = true }, + { Name = "b", Type = "number", Nilable = true }, + { Name = "a", Type = "number", Nilable = true }, + { Name = "sublayer", Type = "number", Nilable = true }, + { Name = "showFacing", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ClearUnits", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "FinalizeUnits", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetMouseOverUnits", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "units", Type = "string", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetPlayerPingScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUiMapID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPlayerPingScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPlayerPingTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureType", Type = "PingTextureType", Nilable = false }, + { Name = "asset", Type = "FileAsset", Nilable = false }, + { Name = "width", Type = "uiUnit", Nilable = false, Default = 0 }, + { Name = "height", Type = "uiUnit", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetUiMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetUnitColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "string", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "StartPlayerPing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "duration", Type = "number", Nilable = false, Default = 0 }, + { Name = "fadeDuration", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "StopPlayerPing", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIUnitPositionFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f399b92 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FrameScriptDocumentation.lua.annotated.lua @@ -0,0 +1,509 @@ +local FrameScript = +{ + Name = "FrameScript", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "AddSourceLocationExclude", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fileName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "canaccessallvalues", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the immediate calling function has appropriate permissions to access and operate on all supplied values." }, + + Arguments = + { + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "canAccessAllValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "canaccesssecrets", + Type = "Function", + SecureHooksAllowed = false, + Documentation = { "Returns true if the immediate calling function has appropriate permissions to access or operate on secret values." }, + + Returns = + { + { Name = "canAccessSecrets", Type = "bool", Nilable = false }, + }, + }, + { + Name = "canaccesstable", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the immediate calling function has appropriate permissions to index secret tables. This will return false if the caller cannot access the table value itself, or if access to the table contents is disallowed by taint." }, + + Arguments = + { + { Name = "table", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "canAccessTable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "canaccessvalue", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the immediate calling function has appropriate permissions to access and operate on a specific value." }, + + Arguments = + { + { Name = "value", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "canAccessValue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CreateFromMixins", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mixins", Type = "LuaValueVariant", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "object", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "CreateSecureDelegate", + Type = "Function", + SecureHooksAllowed = false, + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "luaFunction", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "secureDelegateFunction", Type = "LuaValueReference", Nilable = false }, + }, + }, + { + Name = "CreateWindow", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "popupStyle", Type = "bool", Nilable = false, Default = true }, + { Name = "topMost", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "window", Type = "SimpleWindow", Nilable = true }, + }, + }, + { + Name = "dropsecretaccess", + Type = "Function", + SecureHooksAllowed = false, + Documentation = { "Removes the ability for the immediate calling function to access secret values." }, + }, + { + Name = "dumpobject", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Invokes the '__dump' metamethod on any value (if present), returning its result." }, + + Arguments = + { + { Name = "value", Type = "LuaValueReference", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "LuaValueReference", Nilable = true }, + }, + }, + { + Name = "GetCallstackHeight", + Type = "Function", + + Returns = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentEventID", + Type = "Function", + + Returns = + { + { Name = "eventID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetErrorCallstackHeight", + Type = "Function", + + Returns = + { + { Name = "height", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetEventTime", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventProfileIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "totalElapsedTime", Type = "number", Nilable = false }, + { Name = "numExecutedHandlers", Type = "number", Nilable = false }, + { Name = "slowestHandlerName", Type = "cstring", Nilable = false }, + { Name = "slowestHandlerTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSourceLocation", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "location", Type = "string", Nilable = false }, + }, + }, + { + Name = "hasanysecretvalues", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a supplied value is a secret value." }, + + Arguments = + { + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "isAnyValueSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "issecrettable", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a supplied value is a secret table. This function will return true if the table value itself is secret, or if flags on the table are set such that accesses of the table would produce secrets." }, + + Arguments = + { + { Name = "table", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "isSecretOrContentsSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "issecretvalue", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a supplied value is a secret value." }, + + Arguments = + { + { Name = "value", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "isSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "mapvalues", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Applies a given function over all supplied values individually, replacing the value with the result of the call." }, + + Arguments = + { + { Name = "func", Type = "LuaValueReference", Nilable = false }, + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "mapped", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "Mixin", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "object", Type = "LuaValueVariant", Nilable = false }, + { Name = "mixins", Type = "LuaValueVariant", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "outObject", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "RegisterEventCallback", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "callback", Type = "EventCallbackType", Nilable = false }, + }, + }, + { + Name = "RegisterUnitEventCallback", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "callback", Type = "EventCallbackType", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "RunScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "scrubsecretvalues", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a transformed list of values with inputs that are secret values replaced by nil values." }, + + Arguments = + { + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "scrubbed", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "scrub", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a transformed list of values with inputs that are either secret or are not string, number, or boolean type replaced by nil values." }, + + Arguments = + { + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "scrubbed", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "secretunwrap", + Type = "Function", + SecureHooksAllowed = false, + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Unwraps all supplied secrets, converting them back to regular values." }, + + Arguments = + { + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "unwrapped", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "secretwrap", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Converts all supplied values to secret values, preventing most operations on them from occurring on tainted code paths." }, + + Arguments = + { + { Name = "values", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "wrapped", Type = "LuaValueReference", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "securecallmethod", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Invokes a named method on an object with a secure call barrier that prevents errors or taint from function lookup and execution from propagating to the caller." }, + + Arguments = + { + { Name = "object", Type = "LuaValueReference", Nilable = false, Documentation = { "The table on which to look up the named method from. Lookup of the method uses raw access and ignores any associated metatable." } }, + { Name = "method", Type = "cstring", Nilable = false, Documentation = { "The name of a method to retrieve." } }, + { Name = "arguments", Type = "LuaValueReference", Nilable = false, StrideIndex = 1, Documentation = { "Arguments to supply to the method. The initial 'object' parameter is always supplied as the first argument, followed by these values." } }, + }, + + Returns = + { + { Name = "results", Type = "LuaValueReference", Nilable = false, StrideIndex = 1, Documentation = { "Results from the executed function. If an error occurred, this result list will be empty." } }, + }, + }, + { + Name = "SetErrorCallstackHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "height", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetTableSecurityOption", + Type = "Function", + SecureHooksAllowed = false, + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "table", Type = "LuaValueVariant", Nilable = false }, + { Name = "option", Type = "TableSecurityOption", Nilable = false }, + }, + }, + { + Name = "UnregisterEventCallback", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "callback", Type = "EventCallbackType", Nilable = false }, + }, + }, + { + Name = "UnregisterUnitEventCallback", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "callback", Type = "EventCallbackType", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "debugprofilestart", + Type = "Function", + Documentation = { "Starts a timer for profiling. The final time can be obtained by calling debugprofilestop." }, + }, + { + Name = "debugprofilestop", + Type = "Function", + Documentation = { "Returns the time in milliseconds since the last debugprofilestart call." }, + + Returns = + { + { Name = "elapsedMilliseconds", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "TableSecurityOption", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "DisallowTaintedAccess", Type = "TableSecurityOption", EnumValue = 0 }, + { Name = "DisallowSecretKeys", Type = "TableSecurityOption", EnumValue = 1 }, + { Name = "SecretWrapContents", Type = "TableSecurityOption", EnumValue = 2 }, + }, + }, + { + Name = "EventCallbackType", + Type = "CallbackType", + }, + }, +}; + +APIDocumentation:AddDocumentationTable(FrameScript); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua.annotated.lua new file mode 100644 index 0000000..71eed1f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/FriendListDocumentation.lua.annotated.lua @@ -0,0 +1,637 @@ +local FriendList = +{ + Name = "FriendList", + Type = "System", + Namespace = "C_FriendList", + Environment = "All", + + Functions = + { + { + Name = "AddFriend", + Type = "Function", + HasRestrictions = true, + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "notes", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "AddIgnore", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "added", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AddOrDelIgnore", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "AddOrRemoveFriend", + Type = "Function", + HasRestrictions = true, + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "notes", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "DelIgnore", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "removed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DelIgnoreByIndex", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetFriendInfo", + Type = "Function", + MayReturnNothing = true, + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "FriendInfo", Nilable = false }, + }, + }, + { + Name = "GetFriendInfoByIndex", + Type = "Function", + MayReturnNothing = true, + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "FriendInfo", Nilable = false }, + }, + }, + { + Name = "GetIgnoreName", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetNumFriends", + Type = "Function", + RequiresFriendList = true, + + Returns = + { + { Name = "numFriends", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumIgnores", + Type = "Function", + RequiresFriendList = true, + + Returns = + { + { Name = "numIgnores", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumOnlineFriends", + Type = "Function", + RequiresFriendList = true, + + Returns = + { + { Name = "numOnline", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumWhoResults", + Type = "Function", + RequiresFriendList = true, + + Returns = + { + { Name = "numWhos", Type = "number", Nilable = false }, + { Name = "totalNumWhos", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedFriend", + Type = "Function", + RequiresFriendList = true, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetSelectedIgnore", + Type = "Function", + RequiresFriendList = true, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetWhoInfo", + Type = "Function", + MayReturnNothing = true, + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "WhoInfo", Nilable = false }, + }, + }, + { + Name = "IsFriend", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isFriend", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnored", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "token", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnoredByGuid", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnIgnoredList", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "token", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveFriend", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "removed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveFriendByIndex", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SendWho", + Type = "Function", + HasRestrictions = true, + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filter", Type = "cstring", Nilable = false }, + { Name = "origin", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetFriendNotes", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "notes", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "found", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFriendNotesByIndex", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "notes", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetSelectedFriend", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetSelectedIgnore", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetWhoToUi", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "whoToUi", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowFriends", + Type = "Function", + RequiresFriendList = true, + }, + { + Name = "SortWho", + Type = "Function", + RequiresFriendList = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sorting", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BattletagInviteShow", + Type = "Event", + LiteralName = "BATTLETAG_INVITE_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "BnBlockFailedTooMany", + Type = "Event", + LiteralName = "BN_BLOCK_FAILED_TOO_MANY", + SynchronousEvent = true, + Payload = + { + { Name = "blockType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "BnBlockListUpdated", + Type = "Event", + LiteralName = "BN_BLOCK_LIST_UPDATED", + SynchronousEvent = true, + }, + { + Name = "BnChatWhisperUndeliverable", + Type = "Event", + LiteralName = "BN_CHAT_WHISPER_UNDELIVERABLE", + SynchronousEvent = true, + Payload = + { + { Name = "senderID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BnConnected", + Type = "Event", + LiteralName = "BN_CONNECTED", + SynchronousEvent = true, + Payload = + { + { Name = "suppressNotification", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "BnCustomMessageChanged", + Type = "Event", + LiteralName = "BN_CUSTOM_MESSAGE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "id", Type = "number", Nilable = true }, + }, + }, + { + Name = "BnCustomMessageLoaded", + Type = "Event", + LiteralName = "BN_CUSTOM_MESSAGE_LOADED", + SynchronousEvent = true, + }, + { + Name = "BnDisconnected", + Type = "Event", + LiteralName = "BN_DISCONNECTED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "bool", Nilable = false }, + { Name = "suppressNotification", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "BnFriendAccountOffline", + Type = "Event", + LiteralName = "BN_FRIEND_ACCOUNT_OFFLINE", + SynchronousEvent = true, + Payload = + { + { Name = "friendId", Type = "number", Nilable = false }, + { Name = "isCompanionApp", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "BnFriendAccountOnline", + Type = "Event", + LiteralName = "BN_FRIEND_ACCOUNT_ONLINE", + SynchronousEvent = true, + Payload = + { + { Name = "friendId", Type = "number", Nilable = false }, + { Name = "isCompanionApp", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "BnFriendInfoChanged", + Type = "Event", + LiteralName = "BN_FRIEND_INFO_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "BnFriendInviteAdded", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "accountID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BnFriendInviteListInitialized", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_LIST_INITIALIZED", + SynchronousEvent = true, + Payload = + { + { Name = "listSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "BnFriendInviteRemoved", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_REMOVED", + SynchronousEvent = true, + }, + { + Name = "BnFriendListSizeChanged", + Type = "Event", + LiteralName = "BN_FRIEND_LIST_SIZE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "accountID", Type = "number", Nilable = true }, + }, + }, + { + Name = "BnInfoChanged", + Type = "Event", + LiteralName = "BN_INFO_CHANGED", + SynchronousEvent = true, + }, + { + Name = "BnRequestFofSucceeded", + Type = "Event", + LiteralName = "BN_REQUEST_FOF_SUCCEEDED", + SynchronousEvent = true, + }, + { + Name = "FriendlistUpdate", + Type = "Event", + LiteralName = "FRIENDLIST_UPDATE", + SynchronousEvent = true, + }, + { + Name = "IgnorelistUpdate", + Type = "Event", + LiteralName = "IGNORELIST_UPDATE", + SynchronousEvent = true, + }, + { + Name = "MutelistUpdate", + Type = "Event", + LiteralName = "MUTELIST_UPDATE", + SynchronousEvent = true, + }, + { + Name = "NewMatchmakingPartyInvite", + Type = "Event", + LiteralName = "NEW_MATCHMAKING_PARTY_INVITE", + SynchronousEvent = true, + }, + { + Name = "RejectedMatchmakingPartyInvite", + Type = "Event", + LiteralName = "REJECTED_MATCHMAKING_PARTY_INVITE", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "WhoListUpdate", + Type = "Event", + LiteralName = "WHO_LIST_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "FriendInfo", + Type = "Structure", + Fields = + { + { Name = "connected", Type = "bool", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "className", Type = "string", Nilable = true }, + { Name = "area", Type = "string", Nilable = true }, + { Name = "notes", Type = "string", Nilable = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "dnd", Type = "bool", Nilable = false }, + { Name = "afk", Type = "bool", Nilable = false }, + { Name = "rafLinkType", Type = "RafLinkType", Nilable = false }, + }, + }, + { + Name = "WhoInfo", + Type = "Structure", + Fields = + { + { Name = "fullName", Type = "string", Nilable = false }, + { Name = "fullGuildName", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "raceStr", Type = "string", Nilable = false }, + { Name = "classStr", Type = "string", Nilable = false }, + { Name = "area", Type = "string", Nilable = false }, + { Name = "filename", Type = "string", Nilable = true }, + { Name = "gender", Type = "number", Nilable = false }, + { Name = "timerunningSeasonID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(FriendList); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f1a6fa4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,23 @@ +local GARRISON_FOLLOWER_TYPEConstants = +{ + Tables = + { + { + Name = "GarrisonFollowerType", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 123, + Fields = + { + { Name = "FollowerType_6_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 1 }, + { Name = "FollowerType_6_0_Boat", Type = "GarrisonFollowerType", EnumValue = 2 }, + { Name = "FollowerType_7_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 4 }, + { Name = "FollowerType_8_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 22 }, + { Name = "FollowerType_9_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 123 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GARRISON_FOLLOWER_TYPEConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_TYPEConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_TYPEConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..61bd3ed --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GARRISON_TYPEConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local GARRISON_TYPEConstants = +{ + Tables = + { + { + Name = "GarrisonType", + Type = "Enumeration", + NumValues = 4, + MinValue = 2, + MaxValue = 111, + Fields = + { + { Name = "Type_6_0_Garrison", Type = "GarrisonType", EnumValue = 2 }, + { Name = "Type_7_0_Garrison", Type = "GarrisonType", EnumValue = 3 }, + { Name = "Type_8_0_Garrison", Type = "GarrisonType", EnumValue = 9 }, + { Name = "Type_9_0_Garrison", Type = "GarrisonType", EnumValue = 111 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GARRISON_TYPEConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GMTicketInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GMTicketInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f0f2354 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GMTicketInfoDocumentation.lua.annotated.lua @@ -0,0 +1,89 @@ +local GMTicketInfo = +{ + Name = "GMTicketInfo", + Type = "System", + Namespace = "C_GMTicketInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "GmPlayerInfo", + Type = "Event", + LiteralName = "GM_PLAYER_INFO", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "info", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ItemRestorationButtonStatus", + Type = "Event", + LiteralName = "ITEM_RESTORATION_BUTTON_STATUS", + SynchronousEvent = true, + }, + { + Name = "PetitionClosed", + Type = "Event", + LiteralName = "PETITION_CLOSED", + SynchronousEvent = true, + }, + { + Name = "PetitionShow", + Type = "Event", + LiteralName = "PETITION_SHOW", + SynchronousEvent = true, + }, + { + Name = "PlayerReportSubmitted", + Type = "Event", + LiteralName = "PLAYER_REPORT_SUBMITTED", + SynchronousEvent = true, + Payload = + { + { Name = "invitedByGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "QuickTicketSystemStatus", + Type = "Event", + LiteralName = "QUICK_TICKET_SYSTEM_STATUS", + SynchronousEvent = true, + }, + { + Name = "QuickTicketThrottleChanged", + Type = "Event", + LiteralName = "QUICK_TICKET_THROTTLE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "UpdateWebTicket", + Type = "Event", + LiteralName = "UPDATE_WEB_TICKET", + SynchronousEvent = true, + Payload = + { + { Name = "hasTicket", Type = "bool", Nilable = false }, + { Name = "numTickets", Type = "number", Nilable = true }, + { Name = "ticketStatus", Type = "number", Nilable = true }, + { Name = "caseIndex", Type = "number", Nilable = true }, + { Name = "waitTimeMinutes", Type = "number", Nilable = true }, + { Name = "waitMessage", Type = "cstring", Nilable = true }, + { Name = "caseTitle", Type = "cstring", Nilable = true }, + { Name = "caseDescription", Type = "cstring", Nilable = true }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GMTicketInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9f234bb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameCursorDocumentation.lua.annotated.lua @@ -0,0 +1,177 @@ +local GameCursor = +{ + Name = "GameCursor", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "ClearCursor", + Type = "Function", + }, + { + Name = "ClearCursorHoveredItem", + Type = "Function", + }, + { + Name = "CursorHasItem", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasMacro", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasMoney", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasSpell", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeleteCursorItem", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "DropCursorMoney", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "EquipCursorItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetCursorInfo", + Type = "Function", + }, + { + Name = "GetCursorMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "PickupPlayerMoney", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + }, + { + Name = "ResetCursor", + Type = "Function", + }, + { + Name = "SellCursorItem", + Type = "Function", + }, + { + Name = "SetCursor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCursorByMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mode", Type = "Cursormode", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCursorHoveredItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "SetCursorHoveredItemTradeItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCursorVirtualItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "cursorType", Type = "UICursorType", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GameCursor); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9685cb9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameErrorDocumentation.lua.annotated.lua @@ -0,0 +1,42 @@ +local GameError = +{ + Name = "GameError", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetGameMessageInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameErrorIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "errorName", Type = "cstring", Nilable = false }, + { Name = "soundKitID", Type = "number", Nilable = true }, + { Name = "voiceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "NotWhileDeadError", + Type = "Function", + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GameError); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadConstDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadConstDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7fb5d54 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadConstDocumentation.lua.annotated.lua @@ -0,0 +1,24 @@ +local GamePadConst = +{ + Tables = + { + { + Name = "GamePadPowerLevel", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Critical", Type = "GamePadPowerLevel", EnumValue = 0 }, + { Name = "Low", Type = "GamePadPowerLevel", EnumValue = 1 }, + { Name = "Medium", Type = "GamePadPowerLevel", EnumValue = 2 }, + { Name = "High", Type = "GamePadPowerLevel", EnumValue = 3 }, + { Name = "Wired", Type = "GamePadPowerLevel", EnumValue = 4 }, + { Name = "Unknown", Type = "GamePadPowerLevel", EnumValue = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GamePadConst); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f0f0470 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GamePadDocumentation.lua.annotated.lua @@ -0,0 +1,435 @@ +local GamePad = +{ + Name = "GamePad", + Type = "System", + Namespace = "C_GamePad", + Environment = "All", + + Functions = + { + { + Name = "AddSDLMapping", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "platform", Type = "ClientPlatformType", Nilable = false }, + { Name = "mapping", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ApplyConfigs", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "AxisIndexToConfigName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "axisIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "ButtonBindingToIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bindingName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "buttonIndex", Type = "number", Nilable = true }, + }, + }, + { + Name = "ButtonIndexToBinding", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "buttonIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "bindingName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "ButtonIndexToConfigName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "buttonIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "ClearLedColor", + Type = "Function", + }, + { + Name = "DeleteConfig", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "GamePadConfigID", Nilable = false }, + }, + }, + { + Name = "GetActiveDeviceID", + Type = "Function", + + Returns = + { + { Name = "deviceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAllConfigIDs", + Type = "Function", + + Returns = + { + { Name = "configIDs", Type = "table", InnerType = "GamePadConfigID", Nilable = false }, + }, + }, + { + Name = "GetAllDeviceIDs", + Type = "Function", + + Returns = + { + { Name = "deviceIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCombinedDeviceID", + Type = "Function", + + Returns = + { + { Name = "deviceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "GamePadConfigID", Nilable = false }, + }, + + Returns = + { + { Name = "config", Type = "GamePadConfig", Nilable = true }, + }, + }, + { + Name = "GetDeviceMappedState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deviceID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "state", Type = "GamePadMappedState", Nilable = true }, + }, + }, + { + Name = "GetDeviceRawState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deviceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rawState", Type = "GamePadRawState", Nilable = true }, + }, + }, + { + Name = "GetLedColor", + Type = "Function", + + Returns = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetPowerLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deviceID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "powerLevel", Type = "GamePadPowerLevel", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetConfig", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "config", Type = "GamePadConfig", Nilable = false }, + }, + }, + { + Name = "SetLedColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "SetVibration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vibrationType", Type = "cstring", Nilable = false }, + { Name = "intensity", Type = "number", Nilable = false }, + }, + }, + { + Name = "StickIndexToConfigName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "stickIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "StopVibration", + Type = "Function", + }, + }, + + Events = + { + { + Name = "GamePadActiveChanged", + Type = "Event", + LiteralName = "GAME_PAD_ACTIVE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GamePadConfigsChanged", + Type = "Event", + LiteralName = "GAME_PAD_CONFIGS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "GamePadConnected", + Type = "Event", + LiteralName = "GAME_PAD_CONNECTED", + SynchronousEvent = true, + }, + { + Name = "GamePadDisconnected", + Type = "Event", + LiteralName = "GAME_PAD_DISCONNECTED", + SynchronousEvent = true, + }, + { + Name = "GamePadPowerChanged", + Type = "Event", + LiteralName = "GAME_PAD_POWER_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "powerLevel", Type = "GamePadPowerLevel", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "GamePadAxisConfig", + Type = "Structure", + Fields = + { + { Name = "axis", Type = "string", Nilable = false }, + { Name = "shift", Type = "number", Nilable = true }, + { Name = "scale", Type = "number", Nilable = true }, + { Name = "deadzone", Type = "number", Nilable = true }, + { Name = "buttonThreshold", Type = "number", Nilable = true }, + { Name = "buttonPos", Type = "string", Nilable = true }, + { Name = "buttonNeg", Type = "string", Nilable = true }, + { Name = "comment", Type = "string", Nilable = true }, + }, + }, + { + Name = "GamePadConfig", + Type = "Structure", + Fields = + { + { Name = "comment", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "configID", Type = "GamePadConfigID", Nilable = false }, + { Name = "labelStyle", Type = "string", Nilable = true }, + { Name = "rawButtonMappings", Type = "table", InnerType = "GamePadRawButtonMapping", Nilable = false }, + { Name = "rawAxisMappings", Type = "table", InnerType = "GamePadRawAxisMapping", Nilable = false }, + { Name = "axisConfigs", Type = "table", InnerType = "GamePadAxisConfig", Nilable = false }, + { Name = "stickConfigs", Type = "table", InnerType = "GamePadStickConfig", Nilable = false }, + }, + }, + { + Name = "GamePadConfigID", + Type = "Structure", + Fields = + { + { Name = "vendorID", Type = "number", Nilable = true }, + { Name = "productID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GamePadMappedState", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "labelStyle", Type = "string", Nilable = false }, + { Name = "buttonCount", Type = "number", Nilable = false }, + { Name = "axisCount", Type = "number", Nilable = false }, + { Name = "stickCount", Type = "number", Nilable = false }, + { Name = "buttons", Type = "table", InnerType = "bool", Nilable = false }, + { Name = "axes", Type = "table", InnerType = "number", Nilable = false }, + { Name = "sticks", Type = "table", InnerType = "GamePadStick", Nilable = false }, + }, + }, + { + Name = "GamePadRawAxisMapping", + Type = "Structure", + Fields = + { + { Name = "rawIndex", Type = "number", Nilable = false }, + { Name = "axis", Type = "string", Nilable = true }, + { Name = "comment", Type = "string", Nilable = true }, + }, + }, + { + Name = "GamePadRawButtonMapping", + Type = "Structure", + Fields = + { + { Name = "rawIndex", Type = "number", Nilable = false }, + { Name = "button", Type = "string", Nilable = true }, + { Name = "axis", Type = "string", Nilable = true }, + { Name = "axisValue", Type = "number", Nilable = true }, + { Name = "comment", Type = "string", Nilable = true }, + }, + }, + { + Name = "GamePadRawState", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "vendorID", Type = "number", Nilable = false }, + { Name = "productID", Type = "number", Nilable = false }, + { Name = "rawButtonCount", Type = "number", Nilable = false }, + { Name = "rawAxisCount", Type = "number", Nilable = false }, + { Name = "rawButtons", Type = "table", InnerType = "bool", Nilable = false }, + { Name = "rawAxes", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GamePadStick", + Type = "Structure", + Fields = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "len", Type = "number", Nilable = false }, + }, + }, + { + Name = "GamePadStickConfig", + Type = "Structure", + Fields = + { + { Name = "stick", Type = "string", Nilable = false }, + { Name = "axisX", Type = "string", Nilable = true }, + { Name = "axisY", Type = "string", Nilable = true }, + { Name = "deadzone", Type = "number", Nilable = true }, + { Name = "deadzoneX", Type = "number", Nilable = true }, + { Name = "deadzoneY", Type = "number", Nilable = true }, + { Name = "comment", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GamePad); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e9acb73 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local GameRulesConstants = +{ + Tables = + { + { + Name = "EventRealmQueues", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "EventRealmQueues", EnumValue = 0 }, + { Name = "PlunderstormSolo", Type = "EventRealmQueues", EnumValue = 1 }, + { Name = "PlunderstormDuo", Type = "EventRealmQueues", EnumValue = 2 }, + { Name = "PlunderstormTrio", Type = "EventRealmQueues", EnumValue = 4 }, + { Name = "PlunderstormTraining", Type = "EventRealmQueues", EnumValue = 8 }, + }, + }, + { + Name = "GameRuleFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "GameRuleFlags", EnumValue = 0 }, + { Name = "AllowClient", Type = "GameRuleFlags", EnumValue = 1 }, + { Name = "RequiresDefault", Type = "GameRuleFlags", EnumValue = 2 }, + }, + }, + { + Name = "GameRuleType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Int", Type = "GameRuleType", EnumValue = 0 }, + { Name = "Float", Type = "GameRuleType", EnumValue = 1 }, + { Name = "Bool", Type = "GameRuleType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GameRulesConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..aa08ece --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameRulesDocumentation.lua.annotated.lua @@ -0,0 +1,335 @@ +local GameRules = +{ + Name = "GameRules", + Type = "System", + Namespace = "C_GameRules", + Environment = "All", + + Functions = + { + { + Name = "AutoConnectToGameModeRealm", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DoesGameModeHavePromo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasPromo", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActiveGameMode", + Type = "Function", + + Returns = + { + { Name = "gameMode", Type = "GameMode", Nilable = false }, + }, + }, + { + Name = "GetCurrentEventRealmQueues", + Type = "Function", + + Returns = + { + { Name = "eventRealmQueues", Type = "EventRealmQueues", Nilable = false }, + }, + }, + { + Name = "GetCurrentGameModeDisplayInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "GameModeDisplayInfo", Nilable = true }, + }, + }, + { + Name = "GetCurrentGameModeRecordID", + Type = "Function", + + Returns = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDisplayedGameModeRecordIDAtIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "displayIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGameModeDisplayInfoByRecordID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "GameModeDisplayInfo", Nilable = true }, + }, + }, + { + Name = "GetGameModeGlueScreenName", + Type = "Function", + + Returns = + { + { Name = "screenName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetGameModePromoGlobalString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "promoGlobalString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetGameRuleAsFloat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the numeric value specified in the Game Rule, multiplied by 0.1 for every decimal place requested" }, + + Arguments = + { + { Name = "gameRule", Type = "GameRule", Nilable = false }, + { Name = "decimalPlaces", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGameRuleAsFrameStrata", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the value specified in the Game Rule converted to a frame strata" }, + + Arguments = + { + { Name = "gameRule", Type = "GameRule", Nilable = false }, + }, + + Returns = + { + { Name = "frameStrata", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetNumDisplayedGameModes", + Type = "Function", + + Returns = + { + { Name = "numDisplayedGameModes", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsCharacterlessLoginActive", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsClassAllowedForGameMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGameModeEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGameRuleActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameRule", Type = "GameRule", Nilable = false }, + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMultiActionBarVisibilityForced", + Type = "Function", + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPersonalResourceDisplayEnabled", + Type = "Function", + Documentation = { "Checks the game rule as well as nameplateShowSelf" }, + + Returns = + { + { Name = "isPersonalResourceDisplayEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlunderstorm", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStandard", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWoWHack", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActiveGameModeUpdated", + Type = "Event", + LiteralName = "ACTIVE_GAME_MODE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "gameMode", Type = "GameMode", Nilable = false }, + }, + }, + { + Name = "AvailableGameModesUpdated", + Type = "Event", + LiteralName = "AVAILABLE_GAME_MODES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "EventRealmQueuesUpdated", + Type = "Event", + LiteralName = "EVENT_REALM_QUEUES_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "eventRealmQueues", Type = "EventRealmQueues", Nilable = false }, + }, + }, + { + Name = "GameModeDisplayInfoUpdated", + Type = "Event", + LiteralName = "GAME_MODE_DISPLAY_INFO_UPDATED", + SynchronousEvent = true, + }, + { + Name = "GameModeDisplayModeToggleDisabled", + Type = "Event", + LiteralName = "GAME_MODE_DISPLAY_MODE_TOGGLE_DISABLED", + SynchronousEvent = true, + Payload = + { + { Name = "gameModeRecordID", Type = "number", Nilable = false }, + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "GameModeDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "logo", Type = "fileID", Nilable = false }, + { Name = "logoHeight", Type = "number", Nilable = false }, + { Name = "logoVerticalOffset", Type = "number", Nilable = false }, + { Name = "logoShrunkenHeight", Type = "number", Nilable = false }, + { Name = "logoUsesDarkBackdrop", Type = "bool", Nilable = false }, + { Name = "characterCreateExtraHeight", Type = "number", Nilable = false }, + { Name = "characterCreateOuterBorder", Type = "fileID", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GameRules); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ac2f5b2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GameUIDocumentation.lua.annotated.lua @@ -0,0 +1,40 @@ +local GameUI = +{ + Name = "GameUI", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "SetInWorldUIVisibility", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "visible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetUIVisibility", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "visible", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GameUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..452b1be --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,376 @@ +local GarrisonConstants = +{ + Tables = + { + { + Name = "ContributionAppearanceFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "TooltipUseTimeRemaining", Type = "ContributionAppearanceFlags", EnumValue = 0 }, + }, + }, + { + Name = "ContributionState", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "ContributionState", EnumValue = 0 }, + { Name = "Building", Type = "ContributionState", EnumValue = 1 }, + { Name = "Active", Type = "ContributionState", EnumValue = 2 }, + { Name = "UnderAttack", Type = "ContributionState", EnumValue = 3 }, + { Name = "Destroyed", Type = "ContributionState", EnumValue = 4 }, + }, + }, + { + Name = "CovenantSkill", + Type = "Enumeration", + NumValues = 4, + MinValue = 2730, + MaxValue = 2733, + Fields = + { + { Name = "Kyrian", Type = "CovenantSkill", EnumValue = 2730 }, + { Name = "Venthyr", Type = "CovenantSkill", EnumValue = 2731 }, + { Name = "NightFae", Type = "CovenantSkill", EnumValue = 2732 }, + { Name = "Necrolord", Type = "CovenantSkill", EnumValue = 2733 }, + }, + }, + { + Name = "CovenantType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "CovenantType", EnumValue = 0 }, + { Name = "Kyrian", Type = "CovenantType", EnumValue = 1 }, + { Name = "Venthyr", Type = "CovenantType", EnumValue = 2 }, + { Name = "NightFae", Type = "CovenantType", EnumValue = 3 }, + { Name = "Necrolord", Type = "CovenantType", EnumValue = 4 }, + }, + }, + { + Name = "FollowerAbilityCastResult", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "Success", Type = "FollowerAbilityCastResult", EnumValue = 0 }, + { Name = "Failure", Type = "FollowerAbilityCastResult", EnumValue = 1 }, + { Name = "NoPendingCast", Type = "FollowerAbilityCastResult", EnumValue = 2 }, + { Name = "InvalidTarget", Type = "FollowerAbilityCastResult", EnumValue = 3 }, + { Name = "InvalidFollowerSpell", Type = "FollowerAbilityCastResult", EnumValue = 4 }, + { Name = "RerollNotAllowed", Type = "FollowerAbilityCastResult", EnumValue = 5 }, + { Name = "SingleMissionDuration", Type = "FollowerAbilityCastResult", EnumValue = 6 }, + { Name = "MustTargetFollower", Type = "FollowerAbilityCastResult", EnumValue = 7 }, + { Name = "MustTargetTrait", Type = "FollowerAbilityCastResult", EnumValue = 8 }, + { Name = "InvalidFollowerType", Type = "FollowerAbilityCastResult", EnumValue = 9 }, + { Name = "MustBeUnique", Type = "FollowerAbilityCastResult", EnumValue = 10 }, + { Name = "CannotTargetLimitedUseFollower", Type = "FollowerAbilityCastResult", EnumValue = 11 }, + { Name = "MustTargetLimitedUseFollower", Type = "FollowerAbilityCastResult", EnumValue = 12 }, + { Name = "AlreadyAtMaxDurability", Type = "FollowerAbilityCastResult", EnumValue = 13 }, + { Name = "CannotTargetNonAutoMissionFollower", Type = "FollowerAbilityCastResult", EnumValue = 14 }, + }, + }, + { + Name = "GarrAutoBoardIndex", + Type = "Enumeration", + NumValues = 14, + MinValue = -1, + MaxValue = 12, + Fields = + { + { Name = "None", Type = "GarrAutoBoardIndex", EnumValue = -1 }, + { Name = "AllyLeftBack", Type = "GarrAutoBoardIndex", EnumValue = 0 }, + { Name = "AllyRightBack", Type = "GarrAutoBoardIndex", EnumValue = 1 }, + { Name = "AllyLeftFront", Type = "GarrAutoBoardIndex", EnumValue = 2 }, + { Name = "AllyCenterFront", Type = "GarrAutoBoardIndex", EnumValue = 3 }, + { Name = "AllyRightFront", Type = "GarrAutoBoardIndex", EnumValue = 4 }, + { Name = "EnemyLeftFront", Type = "GarrAutoBoardIndex", EnumValue = 5 }, + { Name = "EnemyCenterLeftFront", Type = "GarrAutoBoardIndex", EnumValue = 6 }, + { Name = "EnemyCenterRightFront", Type = "GarrAutoBoardIndex", EnumValue = 7 }, + { Name = "EnemyRightFront", Type = "GarrAutoBoardIndex", EnumValue = 8 }, + { Name = "EnemyLeftBack", Type = "GarrAutoBoardIndex", EnumValue = 9 }, + { Name = "EnemyCenterLeftBack", Type = "GarrAutoBoardIndex", EnumValue = 10 }, + { Name = "EnemyCenterRightBack", Type = "GarrAutoBoardIndex", EnumValue = 11 }, + { Name = "EnemyRightBack", Type = "GarrAutoBoardIndex", EnumValue = 12 }, + }, + }, + { + Name = "GarrAutoCombatSpellTutorialFlag", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "GarrAutoCombatSpellTutorialFlag", EnumValue = 0 }, + { Name = "Single", Type = "GarrAutoCombatSpellTutorialFlag", EnumValue = 1 }, + { Name = "Column", Type = "GarrAutoCombatSpellTutorialFlag", EnumValue = 2 }, + { Name = "Row", Type = "GarrAutoCombatSpellTutorialFlag", EnumValue = 3 }, + { Name = "All", Type = "GarrAutoCombatSpellTutorialFlag", EnumValue = 4 }, + }, + }, + { + Name = "GarrAutoCombatTutorial", + Type = "Enumeration", + NumValues = 11, + MinValue = 1, + MaxValue = 1024, + Fields = + { + { Name = "SelectMission", Type = "GarrAutoCombatTutorial", EnumValue = 1 }, + { Name = "PlaceCompanion", Type = "GarrAutoCombatTutorial", EnumValue = 2 }, + { Name = "HealCompanion", Type = "GarrAutoCombatTutorial", EnumValue = 4 }, + { Name = "LevelHeal", Type = "GarrAutoCombatTutorial", EnumValue = 8 }, + { Name = "BeneficialEffect", Type = "GarrAutoCombatTutorial", EnumValue = 16 }, + { Name = "AttackSingle", Type = "GarrAutoCombatTutorial", EnumValue = 32 }, + { Name = "AttackColumn", Type = "GarrAutoCombatTutorial", EnumValue = 64 }, + { Name = "AttackRow", Type = "GarrAutoCombatTutorial", EnumValue = 128 }, + { Name = "AttackAll", Type = "GarrAutoCombatTutorial", EnumValue = 256 }, + { Name = "TroopTutorial", Type = "GarrAutoCombatTutorial", EnumValue = 512 }, + { Name = "EnvironmentalEffect", Type = "GarrAutoCombatTutorial", EnumValue = 1024 }, + }, + }, + { + Name = "GarrAutoCombatantRole", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "GarrAutoCombatantRole", EnumValue = 0 }, + { Name = "Melee", Type = "GarrAutoCombatantRole", EnumValue = 1 }, + { Name = "RangedPhysical", Type = "GarrAutoCombatantRole", EnumValue = 2 }, + { Name = "RangedMagic", Type = "GarrAutoCombatantRole", EnumValue = 3 }, + { Name = "HealSupport", Type = "GarrAutoCombatantRole", EnumValue = 4 }, + { Name = "Tank", Type = "GarrAutoCombatantRole", EnumValue = 5 }, + }, + }, + { + Name = "GarrAutoEventFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "GarrAutoEventFlags", EnumValue = 0 }, + { Name = "AutoAttack", Type = "GarrAutoEventFlags", EnumValue = 1 }, + { Name = "Passive", Type = "GarrAutoEventFlags", EnumValue = 2 }, + { Name = "Environment", Type = "GarrAutoEventFlags", EnumValue = 4 }, + }, + }, + { + Name = "GarrAutoMissionEventType", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "MeleeDamage", Type = "GarrAutoMissionEventType", EnumValue = 0 }, + { Name = "RangeDamage", Type = "GarrAutoMissionEventType", EnumValue = 1 }, + { Name = "SpellMeleeDamage", Type = "GarrAutoMissionEventType", EnumValue = 2 }, + { Name = "SpellRangeDamage", Type = "GarrAutoMissionEventType", EnumValue = 3 }, + { Name = "Heal", Type = "GarrAutoMissionEventType", EnumValue = 4 }, + { Name = "PeriodicDamage", Type = "GarrAutoMissionEventType", EnumValue = 5 }, + { Name = "PeriodicHeal", Type = "GarrAutoMissionEventType", EnumValue = 6 }, + { Name = "ApplyAura", Type = "GarrAutoMissionEventType", EnumValue = 7 }, + { Name = "RemoveAura", Type = "GarrAutoMissionEventType", EnumValue = 8 }, + { Name = "Died", Type = "GarrAutoMissionEventType", EnumValue = 9 }, + }, + }, + { + Name = "GarrAutoPreviewTargetType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "GarrAutoPreviewTargetType", EnumValue = 0 }, + { Name = "Damage", Type = "GarrAutoPreviewTargetType", EnumValue = 1 }, + { Name = "Heal", Type = "GarrAutoPreviewTargetType", EnumValue = 2 }, + { Name = "Buff", Type = "GarrAutoPreviewTargetType", EnumValue = 4 }, + { Name = "Debuff", Type = "GarrAutoPreviewTargetType", EnumValue = 8 }, + }, + }, + { + Name = "GarrFollowerMissionCompleteState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Alive", Type = "GarrFollowerMissionCompleteState", EnumValue = 0 }, + { Name = "KilledByMissionFailure", Type = "GarrFollowerMissionCompleteState", EnumValue = 1 }, + { Name = "SavedByPreventDeath", Type = "GarrFollowerMissionCompleteState", EnumValue = 2 }, + { Name = "OutOfDurability", Type = "GarrFollowerMissionCompleteState", EnumValue = 3 }, + }, + }, + { + Name = "GarrFollowerQuality", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "None", Type = "GarrFollowerQuality", EnumValue = 0 }, + { Name = "Common", Type = "GarrFollowerQuality", EnumValue = 1 }, + { Name = "Uncommon", Type = "GarrFollowerQuality", EnumValue = 2 }, + { Name = "Rare", Type = "GarrFollowerQuality", EnumValue = 3 }, + { Name = "Epic", Type = "GarrFollowerQuality", EnumValue = 4 }, + { Name = "Legendary", Type = "GarrFollowerQuality", EnumValue = 5 }, + { Name = "Title", Type = "GarrFollowerQuality", EnumValue = 6 }, + }, + }, + { + Name = "GarrTalentCostType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Initial", Type = "GarrTalentCostType", EnumValue = 0 }, + { Name = "Respec", Type = "GarrTalentCostType", EnumValue = 1 }, + { Name = "MakePermanent", Type = "GarrTalentCostType", EnumValue = 2 }, + { Name = "TreeReset", Type = "GarrTalentCostType", EnumValue = 3 }, + }, + }, + { + Name = "GarrTalentFeatureSubtype", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Generic", Type = "GarrTalentFeatureSubtype", EnumValue = 0 }, + { Name = "Bastion", Type = "GarrTalentFeatureSubtype", EnumValue = 1 }, + { Name = "Revendreth", Type = "GarrTalentFeatureSubtype", EnumValue = 2 }, + { Name = "Ardenweald", Type = "GarrTalentFeatureSubtype", EnumValue = 3 }, + { Name = "Maldraxxus", Type = "GarrTalentFeatureSubtype", EnumValue = 4 }, + }, + }, + { + Name = "GarrTalentFeatureType", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Generic", Type = "GarrTalentFeatureType", EnumValue = 0 }, + { Name = "AnimaDiversion", Type = "GarrTalentFeatureType", EnumValue = 1 }, + { Name = "TravelPortals", Type = "GarrTalentFeatureType", EnumValue = 2 }, + { Name = "Adventures", Type = "GarrTalentFeatureType", EnumValue = 3 }, + { Name = "ReservoirUpgrades", Type = "GarrTalentFeatureType", EnumValue = 4 }, + { Name = "SanctumUnique", Type = "GarrTalentFeatureType", EnumValue = 5 }, + { Name = "SoulBinds", Type = "GarrTalentFeatureType", EnumValue = 6 }, + { Name = "AnimaDiversionMap", Type = "GarrTalentFeatureType", EnumValue = 7 }, + { Name = "Cyphers", Type = "GarrTalentFeatureType", EnumValue = 8 }, + }, + }, + { + Name = "GarrTalentResearchCostSource", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Talent", Type = "GarrTalentResearchCostSource", EnumValue = 0 }, + { Name = "Tree", Type = "GarrTalentResearchCostSource", EnumValue = 1 }, + }, + }, + { + Name = "GarrTalentSocketType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "GarrTalentSocketType", EnumValue = 0 }, + { Name = "Spell", Type = "GarrTalentSocketType", EnumValue = 1 }, + { Name = "Conduit", Type = "GarrTalentSocketType", EnumValue = 2 }, + }, + }, + { + Name = "GarrTalentTreeType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Tiers", Type = "GarrTalentTreeType", EnumValue = 0 }, + { Name = "Classic", Type = "GarrTalentTreeType", EnumValue = 1 }, + }, + }, + { + Name = "GarrTalentType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Standard", Type = "GarrTalentType", EnumValue = 0 }, + { Name = "Minor", Type = "GarrTalentType", EnumValue = 1 }, + { Name = "Major", Type = "GarrTalentType", EnumValue = 2 }, + { Name = "Socket", Type = "GarrTalentType", EnumValue = 3 }, + }, + }, + { + Name = "GarrTalentUI", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Generic", Type = "GarrTalentUI", EnumValue = 0 }, + { Name = "CovenantSanctum", Type = "GarrTalentUI", EnumValue = 1 }, + { Name = "SoulBinds", Type = "GarrTalentUI", EnumValue = 2 }, + { Name = "AnimaDiversionMap", Type = "GarrTalentUI", EnumValue = 3 }, + }, + }, + { + Name = "GarrisonTalentAvailability", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Available", Type = "GarrisonTalentAvailability", EnumValue = 0 }, + { Name = "Unavailable", Type = "GarrisonTalentAvailability", EnumValue = 1 }, + { Name = "UnavailableAnotherIsResearching", Type = "GarrisonTalentAvailability", EnumValue = 2 }, + { Name = "UnavailableNotEnoughResources", Type = "GarrisonTalentAvailability", EnumValue = 3 }, + { Name = "UnavailableNotEnoughGold", Type = "GarrisonTalentAvailability", EnumValue = 4 }, + { Name = "UnavailableTierUnavailable", Type = "GarrisonTalentAvailability", EnumValue = 5 }, + { Name = "UnavailablePlayerCondition", Type = "GarrisonTalentAvailability", EnumValue = 6 }, + { Name = "UnavailableAlreadyHave", Type = "GarrisonTalentAvailability", EnumValue = 7 }, + { Name = "UnavailableRequiresPrerequisiteTalent", Type = "GarrisonTalentAvailability", EnumValue = 8 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GarrisonConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dfa4ba1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonInfoDocumentation.lua.annotated.lua @@ -0,0 +1,1460 @@ +local GarrisonInfo = +{ + Name = "GarrisonInfo", + Type = "System", + Namespace = "C_Garrison", + Environment = "All", + + Functions = + { + { + Name = "AddFollowerToMission", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "boardIndex", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "followerAdded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAutoCombatDamageClassValues", + Type = "Function", + + Returns = + { + { Name = "damageClassStrings", Type = "table", InnerType = "AutoCombatDamageClassString", Nilable = false }, + }, + }, + { + Name = "GetAutoMissionBoardState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "targetInfo", Type = "table", InnerType = "AutoMissionTargetingInfo", Nilable = false }, + }, + }, + { + Name = "GetAutoMissionEnvironmentEffect", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "autoMissionEnvEffect", Type = "AutoMissionEnvironmentEffect", Nilable = true }, + }, + }, + { + Name = "GetAutoMissionTargetingInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "casterBoardIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "targetInfo", Type = "table", InnerType = "AutoMissionTargetingInfo", Nilable = false }, + }, + }, + { + Name = "GetAutoMissionTargetingInfoForSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "autoCombatSpellID", Type = "number", Nilable = false }, + { Name = "casterBoardIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "targetInfo", Type = "table", InnerType = "AutoMissionTargetingInfo", Nilable = false }, + }, + }, + { + Name = "GetAutoTroops", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "followerType", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "autoTroopInfo", Type = "table", InnerType = "AutoCombatTroopInfo", Nilable = false }, + }, + }, + { + Name = "GetCombatLogSpellInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "autoCombatSpellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellInfo", Type = "AutoCombatSpellInfo", Nilable = true }, + }, + }, + { + Name = "GetCurrentCypherEquipmentLevel", + Type = "Function", + + Returns = + { + { Name = "equipmentLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentGarrTalentTreeFriendshipFactionID", + Type = "Function", + + Returns = + { + { Name = "currentGarrTalentTreeFriendshipFactionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrentGarrTalentTreeID", + Type = "Function", + + Returns = + { + { Name = "currentGarrTalentTreeID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCyphersToNextEquipmentLevel", + Type = "Function", + + Returns = + { + { Name = "cyphersToNext", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFollowerAutoCombatSpells", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrFollowerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "followerLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "autoCombatSpells", Type = "table", InnerType = "AutoCombatSpellInfo", Nilable = false }, + { Name = "autoCombatAutoAttack", Type = "AutoCombatSpellInfo", Nilable = true }, + }, + }, + { + Name = "GetFollowerAutoCombatStats", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrFollowerID", Type = "GarrisonFollower", Nilable = false }, + }, + + Returns = + { + { Name = "autoCombatInfo", Type = "FollowerAutoCombatStatsInfo", Nilable = true }, + }, + }, + { + Name = "GetFollowerMissionCompleteInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + }, + + Returns = + { + { Name = "followerMissionCompleteInfo", Type = "FollowerMissionCompleteInfo", Nilable = false }, + }, + }, + { + Name = "GetGarrisonPlotsInstancesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "garrisonPlotInstances", Type = "table", InnerType = "GarrisonPlotInstanceMapInfo", Nilable = false }, + }, + }, + { + Name = "GetGarrisonTalentTreeCurrencyTypes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrTalentTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "garrTalentTreeCurrencyType", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetGarrisonTalentTreeType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrTalentTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "garrTalentTreeType", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxCypherEquipmentLevel", + Type = "Function", + + Returns = + { + { Name = "maxEquipmentLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMissionCompleteEncounters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "encounters", Type = "table", InnerType = "GarrisonEnemyEncounterInfo", Nilable = false }, + }, + }, + { + Name = "GetMissionDeploymentInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "missionDeploymentInfo", Type = "MissionDeploymentInfo", Nilable = false }, + }, + }, + { + Name = "GetMissionEncounterIconInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "missionEncounterIconInfo", Type = "MissionEncounterIconInfo", Nilable = false }, + }, + }, + { + Name = "GetTalentInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "GarrisonTalentInfo", Nilable = false }, + }, + }, + { + Name = "GetTalentPointsSpentInTalentTree", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrTalentTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "talentPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTalentTreeIDsByClassID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrType", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "treeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetTalentTreeInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "GarrisonTalentTreeInfo", Nilable = false }, + }, + }, + { + Name = "GetTalentTreeResetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrTalentTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "goldCost", Type = "number", Nilable = false }, + { Name = "currencyCosts", Type = "table", InnerType = "GarrisonTalentCurrencyCostInfo", Nilable = false }, + }, + }, + { + Name = "GetTalentTreeTalentPointResearchInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrTalentID", Type = "number", Nilable = false }, + { Name = "researchRank", Type = "number", Nilable = false }, + { Name = "garrTalentTreeID", Type = "number", Nilable = false }, + { Name = "talentPointIndex", Type = "number", Nilable = false }, + { Name = "isRespec", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "goldCost", Type = "number", Nilable = false }, + { Name = "currencyCosts", Type = "table", InnerType = "GarrisonTalentCurrencyCostInfo", Nilable = false }, + { Name = "durationSecs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTalentUnlockWorldQuest", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "worldQuestID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasAdventures", + Type = "Function", + + Returns = + { + { Name = "hasAdventures", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAtGarrisonMissionNPC", + Type = "Function", + + Returns = + { + { Name = "atGarrisonMissionNPC", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnvironmentCountered", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "environmentCountered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFollowerOnCompletedMission", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + }, + + Returns = + { + { Name = "followerOnCompletedMission", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLandingPageMinimapButtonVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrType", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isLandingPageMinimapButtonVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTalentConditionMet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isMet", Type = "bool", Nilable = false }, + { Name = "failureString", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "RegenerateCombatLog", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveFollowerFromMission", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "boardIndex", Type = "number", Nilable = true }, + }, + }, + { + Name = "RushHealAllFollowers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "followerType", Type = "number", Nilable = false }, + }, + }, + { + Name = "RushHealFollower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "garrFollowerID", Type = "GarrisonFollower", Nilable = false }, + }, + }, + { + Name = "SetAutoCombatSpellFastForward", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "GarrisonArchitectClosed", + Type = "Event", + LiteralName = "GARRISON_ARCHITECT_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GarrisonArchitectOpened", + Type = "Event", + LiteralName = "GARRISON_ARCHITECT_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonBuildingActivatable", + Type = "Event", + LiteralName = "GARRISON_BUILDING_ACTIVATABLE", + SynchronousEvent = true, + Payload = + { + { Name = "buildingName", Type = "cstring", Nilable = false }, + { Name = "garrisonType", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonBuildingActivated", + Type = "Event", + LiteralName = "GARRISON_BUILDING_ACTIVATED", + SynchronousEvent = true, + Payload = + { + { Name = "garrisonPlotInstanceID", Type = "number", Nilable = false }, + { Name = "garrisonBuildingID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonBuildingError", + Type = "Event", + LiteralName = "GARRISON_BUILDING_ERROR", + SynchronousEvent = true, + }, + { + Name = "GarrisonBuildingListUpdate", + Type = "Event", + LiteralName = "GARRISON_BUILDING_LIST_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonBuildingPlaced", + Type = "Event", + LiteralName = "GARRISON_BUILDING_PLACED", + SynchronousEvent = true, + Payload = + { + { Name = "garrisonPlotInstanceID", Type = "number", Nilable = false }, + { Name = "newPlacement", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonBuildingRemoved", + Type = "Event", + LiteralName = "GARRISON_BUILDING_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "garrPlotInstanceID", Type = "number", Nilable = false }, + { Name = "garrBuildingID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonBuildingUpdate", + Type = "Event", + LiteralName = "GARRISON_BUILDING_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "garrisonBuildingID", Type = "number", Nilable = false }, + { Name = "garrPlotInstanceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GarrisonFollowerAdded", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "followerDbID", Type = "GarrisonFollower", Nilable = false }, + { Name = "followerName", Type = "cstring", Nilable = false }, + { Name = "followerClassName", Type = "cstring", Nilable = false }, + { Name = "followerLevel", Type = "number", Nilable = false }, + { Name = "followerQuality", Type = "number", Nilable = false }, + { Name = "isUpgraded", Type = "bool", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerCategoriesUpdated", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_CATEGORIES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "GarrisonFollowerDurabilityChanged", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_DURABILITY_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "garrFollowerTypeID", Type = "number", Nilable = false }, + { Name = "followerDbID", Type = "GarrisonFollower", Nilable = false }, + { Name = "followerDurability", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerHealed", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_HEALED", + SynchronousEvent = true, + Payload = + { + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerListUpdate", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_LIST_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerRemoved", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerUpgraded", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_UPGRADED", + SynchronousEvent = true, + Payload = + { + { Name = "followerDbID", Type = "GarrisonFollower", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerXpChanged", + Type = "Event", + LiteralName = "GARRISON_FOLLOWER_XP_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "garrFollowerTypeID", Type = "number", Nilable = false }, + { Name = "followerDbID", Type = "GarrisonFollower", Nilable = false }, + { Name = "xpChange", Type = "number", Nilable = false }, + { Name = "oldFollowerXp", Type = "number", Nilable = false }, + { Name = "oldFollowerLevel", Type = "number", Nilable = false }, + { Name = "oldFollowerQuality", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonHideLandingPage", + Type = "Event", + LiteralName = "GARRISON_HIDE_LANDING_PAGE", + SynchronousEvent = true, + }, + { + Name = "GarrisonInvasionAvailable", + Type = "Event", + LiteralName = "GARRISON_INVASION_AVAILABLE", + SynchronousEvent = true, + }, + { + Name = "GarrisonInvasionUnavailable", + Type = "Event", + LiteralName = "GARRISON_INVASION_UNAVAILABLE", + SynchronousEvent = true, + }, + { + Name = "GarrisonLandingpageShipments", + Type = "Event", + LiteralName = "GARRISON_LANDINGPAGE_SHIPMENTS", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "GarrisonMissionAreaBonusAdded", + Type = "Event", + LiteralName = "GARRISON_MISSION_AREA_BONUS_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "garrisonMissonBonusAbilityID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionBonusRollComplete", + Type = "Event", + LiteralName = "GARRISON_MISSION_BONUS_ROLL_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionCompleteResponse", + Type = "Event", + LiteralName = "GARRISON_MISSION_COMPLETE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "canComplete", Type = "bool", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + { Name = "bonusRollSuccess", Type = "bool", Nilable = false }, + { Name = "followerDeaths", Type = "table", InnerType = "GarrisonFollowerDeathInfo", Nilable = false }, + { Name = "autoCombatResult", Type = "AutoCombatResult", Nilable = true }, + }, + }, + { + Name = "GarrisonMissionFinished", + Type = "Event", + LiteralName = "GARRISON_MISSION_FINISHED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + { Name = "missionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionListUpdate", + Type = "Event", + LiteralName = "GARRISON_MISSION_LIST_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "garrFollowerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionNpcClosed", + Type = "Event", + LiteralName = "GARRISON_MISSION_NPC_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GarrisonMissionNpcOpened", + Type = "Event", + LiteralName = "GARRISON_MISSION_NPC_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionRewardInfo", + Type = "Event", + LiteralName = "GARRISON_MISSION_REWARD_INFO", + SynchronousEvent = true, + Payload = + { + { Name = "missionID", Type = "number", Nilable = false }, + { Name = "followerDbID", Type = "GarrisonFollower", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionStarted", + Type = "Event", + LiteralName = "GARRISON_MISSION_STARTED", + SynchronousEvent = true, + Payload = + { + { Name = "garrFollowerTypeID", Type = "number", Nilable = false }, + { Name = "missionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonMonumentCloseUi", + Type = "Event", + LiteralName = "GARRISON_MONUMENT_CLOSE_UI", + SynchronousEvent = true, + }, + { + Name = "GarrisonMonumentListLoaded", + Type = "Event", + LiteralName = "GARRISON_MONUMENT_LIST_LOADED", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonMonumentReplaced", + Type = "Event", + LiteralName = "GARRISON_MONUMENT_REPLACED", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonMonumentSelectedTrophyIdLoaded", + Type = "Event", + LiteralName = "GARRISON_MONUMENT_SELECTED_TROPHY_ID_LOADED", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonMonumentShowUi", + Type = "Event", + LiteralName = "GARRISON_MONUMENT_SHOW_UI", + SynchronousEvent = true, + }, + { + Name = "GarrisonRandomMissionAdded", + Type = "Event", + LiteralName = "GARRISON_RANDOM_MISSION_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + { Name = "missionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonRecallPortalLastUsedTime", + Type = "Event", + LiteralName = "GARRISON_RECALL_PORTAL_LAST_USED_TIME", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "recallPortalLastUsedTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonRecallPortalUsed", + Type = "Event", + LiteralName = "GARRISON_RECALL_PORTAL_USED", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonRecruitFollowerResult", + Type = "Event", + LiteralName = "GARRISON_RECRUIT_FOLLOWER_RESULT", + SynchronousEvent = true, + }, + { + Name = "GarrisonRecruitmentFollowersGenerated", + Type = "Event", + LiteralName = "GARRISON_RECRUITMENT_FOLLOWERS_GENERATED", + SynchronousEvent = true, + }, + { + Name = "GarrisonRecruitmentNpcClosed", + Type = "Event", + LiteralName = "GARRISON_RECRUITMENT_NPC_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GarrisonRecruitmentNpcOpened", + Type = "Event", + LiteralName = "GARRISON_RECRUITMENT_NPC_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonRecruitmentReady", + Type = "Event", + LiteralName = "GARRISON_RECRUITMENT_READY", + SynchronousEvent = true, + }, + { + Name = "GarrisonShipmentReceived", + Type = "Event", + LiteralName = "GARRISON_SHIPMENT_RECEIVED", + UniqueEvent = true, + }, + { + Name = "GarrisonShipyardNpcClosed", + Type = "Event", + LiteralName = "GARRISON_SHIPYARD_NPC_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GarrisonShipyardNpcOpened", + Type = "Event", + LiteralName = "GARRISON_SHIPYARD_NPC_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "followerTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonShowLandingPage", + Type = "Event", + LiteralName = "GARRISON_SHOW_LANDING_PAGE", + SynchronousEvent = true, + }, + { + Name = "GarrisonSpecGroupUpdated", + Type = "Event", + LiteralName = "GARRISON_SPEC_GROUP_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "garrTypeID", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonSpecGroupsCleared", + Type = "Event", + LiteralName = "GARRISON_SPEC_GROUPS_CLEARED", + SynchronousEvent = true, + Payload = + { + { Name = "garrTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentComplete", + Type = "Event", + LiteralName = "GARRISON_TALENT_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "garrTypeID", Type = "number", Nilable = false }, + { Name = "doAlert", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentEventUpdate", + Type = "Event", + LiteralName = "GARRISON_TALENT_EVENT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "eventType", Type = "number", Nilable = false }, + { Name = "eventID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentNpcClosed", + Type = "Event", + LiteralName = "GARRISON_TALENT_NPC_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GarrisonTalentNpcOpened", + Type = "Event", + LiteralName = "GARRISON_TALENT_NPC_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "garrisonTypeID", Type = "number", Nilable = false }, + { Name = "garrisonTalentTreeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentResearchStarted", + Type = "Event", + LiteralName = "GARRISON_TALENT_RESEARCH_STARTED", + SynchronousEvent = true, + Payload = + { + { Name = "garrTypeID", Type = "number", Nilable = false }, + { Name = "garrisonTalentTreeID", Type = "number", Nilable = false }, + { Name = "garrTalentID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentUnlocksResult", + Type = "Event", + LiteralName = "GARRISON_TALENT_UNLOCKS_RESULT", + SynchronousEvent = true, + }, + { + Name = "GarrisonTalentUpdate", + Type = "Event", + LiteralName = "GARRISON_TALENT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "garrTypeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTradeskillNpcClosed", + Type = "Event", + LiteralName = "GARRISON_TRADESKILL_NPC_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GarrisonUpdate", + Type = "Event", + LiteralName = "GARRISON_UPDATE", + SynchronousEvent = true, + }, + { + Name = "GarrisonUpgradeableResult", + Type = "Event", + LiteralName = "GARRISON_UPGRADEABLE_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "garrisonUpgradeable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonUsePartyGarrisonChanged", + Type = "Event", + LiteralName = "GARRISON_USE_PARTY_GARRISON_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ShipmentCrafterClosed", + Type = "Event", + LiteralName = "SHIPMENT_CRAFTER_CLOSED", + SynchronousEvent = true, + }, + { + Name = "ShipmentCrafterInfo", + Type = "Event", + LiteralName = "SHIPMENT_CRAFTER_INFO", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "number", Nilable = false }, + { Name = "shipmentCount", Type = "number", Nilable = false }, + { Name = "maxShipments", Type = "number", Nilable = false }, + { Name = "ownedShipments", Type = "number", Nilable = false }, + { Name = "plotInstanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShipmentCrafterOpened", + Type = "Event", + LiteralName = "SHIPMENT_CRAFTER_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "charShipmentContainerID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShipmentCrafterReagentUpdate", + Type = "Event", + LiteralName = "SHIPMENT_CRAFTER_REAGENT_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ShipmentUpdate", + Type = "Event", + LiteralName = "SHIPMENT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "shipmentStarted", Type = "bool", Nilable = true }, + { Name = "hasAttachedFollower", Type = "bool", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "AutoCombatDamageClassString", + Type = "Structure", + Fields = + { + { Name = "damageClassValue", Type = "number", Nilable = false }, + { Name = "locString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "AutoCombatResult", + Type = "Structure", + Fields = + { + { Name = "winner", Type = "bool", Nilable = false }, + { Name = "combatLog", Type = "table", InnerType = "AutoMissionRound", Nilable = false }, + }, + }, + { + Name = "AutoCombatSpellInfo", + Type = "Structure", + Fields = + { + { Name = "autoCombatSpellID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "cooldown", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "schoolMask", Type = "number", Nilable = false }, + { Name = "previewMask", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "spellTutorialFlag", Type = "number", Nilable = false }, + { Name = "hasThornsEffect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AutoCombatTroopInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "garrFollowerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "followerTypeID", Type = "number", Nilable = false }, + { Name = "displayIDs", Type = "table", InnerType = "FollowerDisplayID", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "levelXP", Type = "number", Nilable = false }, + { Name = "maxXP", Type = "number", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "displayScale", Type = "number", Nilable = true }, + { Name = "displayHeight", Type = "number", Nilable = true }, + { Name = "classSpec", Type = "number", Nilable = true }, + { Name = "className", Type = "string", Nilable = true }, + { Name = "flavorText", Type = "string", Nilable = true }, + { Name = "classAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "portraitIconID", Type = "fileID", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "isTroop", Type = "bool", Nilable = false }, + { Name = "raceID", Type = "number", Nilable = false }, + { Name = "health", Type = "number", Nilable = false }, + { Name = "maxHealth", Type = "number", Nilable = false }, + { Name = "role", Type = "number", Nilable = false }, + { Name = "isAutoTroop", Type = "bool", Nilable = false }, + { Name = "isSoulbind", Type = "bool", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "autoCombatStats", Type = "FollowerAutoCombatStatsInfo", Nilable = false }, + }, + }, + { + Name = "AutoMissionCombatEventInfo", + Type = "Structure", + Fields = + { + { Name = "boardIndex", Type = "number", Nilable = false }, + { Name = "oldHealth", Type = "number", Nilable = false }, + { Name = "newHealth", Type = "number", Nilable = false }, + { Name = "maxHealth", Type = "number", Nilable = false }, + { Name = "points", Type = "number", Nilable = true }, + }, + }, + { + Name = "AutoMissionEnvironmentEffect", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "autoCombatSpellInfo", Type = "AutoCombatSpellInfo", Nilable = false }, + }, + }, + { + Name = "AutoMissionEvent", + Type = "Structure", + Fields = + { + { Name = "type", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "schoolMask", Type = "number", Nilable = false }, + { Name = "effectIndex", Type = "number", Nilable = false }, + { Name = "casterBoardIndex", Type = "number", Nilable = false }, + { Name = "auraType", Type = "number", Nilable = false }, + { Name = "targetInfo", Type = "table", InnerType = "AutoMissionCombatEventInfo", Nilable = false }, + }, + }, + { + Name = "AutoMissionRound", + Type = "Structure", + Fields = + { + { Name = "events", Type = "table", InnerType = "AutoMissionEvent", Nilable = false }, + }, + }, + { + Name = "AutoMissionTargetingInfo", + Type = "Structure", + Fields = + { + { Name = "targetIndex", Type = "number", Nilable = false }, + { Name = "previewType", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "effectIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "FollowerAutoCombatStatsInfo", + Type = "Structure", + Fields = + { + { Name = "currentHealth", Type = "number", Nilable = false }, + { Name = "maxHealth", Type = "number", Nilable = false }, + { Name = "attack", Type = "number", Nilable = false }, + { Name = "healingTimestamp", Type = "time_t", Nilable = false }, + { Name = "healCost", Type = "number", Nilable = false }, + { Name = "minutesHealingRemaining", Type = "number", Nilable = false }, + }, + }, + { + Name = "FollowerDisplayID", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "followerPageScale", Type = "number", Nilable = false }, + { Name = "showWeapon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FollowerMissionCompleteInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "displayIDs", Type = "table", InnerType = "FollowerDisplayID", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "currentXP", Type = "number", Nilable = false }, + { Name = "maxXP", Type = "number", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "movementType", Type = "number", Nilable = true }, + { Name = "impactDelay", Type = "number", Nilable = true }, + { Name = "castID", Type = "number", Nilable = true }, + { Name = "castSoundID", Type = "number", Nilable = true }, + { Name = "impactID", Type = "number", Nilable = true }, + { Name = "impactSoundID", Type = "number", Nilable = true }, + { Name = "targetImpactID", Type = "number", Nilable = true }, + { Name = "targetImpactSoundID", Type = "number", Nilable = true }, + { Name = "className", Type = "string", Nilable = true }, + { Name = "classAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "portraitIconID", Type = "fileID", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "isTroop", Type = "bool", Nilable = false }, + { Name = "boardIndex", Type = "number", Nilable = false }, + { Name = "health", Type = "number", Nilable = false }, + { Name = "maxHealth", Type = "number", Nilable = false }, + { Name = "role", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonAbilityCounterInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "factor", Type = "number", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GarrisonAbilityInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isTrait", Type = "bool", Nilable = false }, + { Name = "isSpecialization", Type = "bool", Nilable = false }, + { Name = "temporary", Type = "bool", Nilable = false }, + { Name = "category", Type = "string", Nilable = true }, + { Name = "counters", Type = "table", InnerType = "GarrisonAbilityCounterInfo", Nilable = false }, + { Name = "isEmptySlot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonEnemyEncounterInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "displayID", Type = "fileID", Nilable = false }, + { Name = "portraitFileDataID", Type = "fileID", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + { Name = "mechanics", Type = "table", InnerType = "GarrisonMechanicInfo", Nilable = false }, + { Name = "autoCombatSpells", Type = "table", InnerType = "AutoCombatSpellInfo", Nilable = false }, + { Name = "autoCombatAutoAttack", Type = "AutoCombatSpellInfo", Nilable = true }, + { Name = "role", Type = "number", Nilable = false }, + { Name = "health", Type = "number", Nilable = false }, + { Name = "maxHealth", Type = "number", Nilable = false }, + { Name = "attack", Type = "number", Nilable = false }, + { Name = "boardIndex", Type = "number", Nilable = false }, + { Name = "isElite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerDeathInfo", + Type = "Structure", + Fields = + { + { Name = "followerID", Type = "GarrisonFollower", Nilable = false }, + { Name = "state", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GarrisonMechanicInfo", + Type = "Structure", + Fields = + { + { Name = "mechanicTypeID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "factor", Type = "number", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "ability", Type = "GarrisonAbilityInfo", Nilable = true }, + }, + }, + { + Name = "GarrisonPlotInstanceMapInfo", + Type = "Structure", + Fields = + { + { Name = "buildingPlotInstanceID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "atlasName", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "MissionDeploymentInfo", + Type = "Structure", + Fields = + { + { Name = "location", Type = "cstring", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "environment", Type = "string", Nilable = true }, + { Name = "environmentDesc", Type = "string", Nilable = true }, + { Name = "environmentTexture", Type = "fileID", Nilable = false }, + { Name = "locTextureKit", Type = "textureKit", Nilable = false }, + { Name = "isExhausting", Type = "bool", Nilable = false }, + { Name = "enemies", Type = "table", InnerType = "GarrisonEnemyEncounterInfo", Nilable = false }, + }, + }, + { + Name = "MissionEncounterIconInfo", + Type = "Structure", + Fields = + { + { Name = "portraitFileDataID", Type = "fileID", Nilable = false }, + { Name = "missionScalar", Type = "number", Nilable = false }, + { Name = "isElite", Type = "bool", Nilable = false }, + { Name = "isRare", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GarrisonInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6d4d4ec --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GarrisonSharedDocumentation.lua.annotated.lua @@ -0,0 +1,104 @@ +local GarrisonShared = +{ + Tables = + { + { + Name = "GarrisonAbilityEffect", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "factor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonFollowerAbilityInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "isTrait", Type = "bool", Nilable = false }, + { Name = "isSpecialization", Type = "bool", Nilable = false }, + { Name = "temporary", Type = "bool", Nilable = false }, + { Name = "category", Type = "cstring", Nilable = true }, + { Name = "counters", Type = "table", InnerType = "GarrisonAbilityEffect", Nilable = false }, + { Name = "isEmptySlot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentCurrencyCostInfo", + Type = "Structure", + Fields = + { + { Name = "currencyType", Type = "number", Nilable = false }, + { Name = "currencyQuantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "ability", Type = "GarrisonFollowerAbilityInfo", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "tier", Type = "number", Nilable = false }, + { Name = "uiOrder", Type = "number", Nilable = false }, + { Name = "type", Type = "number", Nilable = false }, + { Name = "prerequisiteTalentID", Type = "number", Nilable = true }, + { Name = "selected", Type = "bool", Nilable = false }, + { Name = "researched", Type = "bool", Nilable = false }, + { Name = "ignoreTalent", Type = "bool", Nilable = false }, + { Name = "researchDuration", Type = "time_t", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "timeRemaining", Type = "time_t", Nilable = false }, + { Name = "researchGoldCost", Type = "number", Nilable = false }, + { Name = "researchCurrencyCosts", Type = "table", InnerType = "GarrisonTalentCurrencyCostInfo", Nilable = false }, + { Name = "talentAvailability", Type = "GarrisonTalentAvailability", Nilable = false }, + { Name = "talentRank", Type = "number", Nilable = false }, + { Name = "talentMaxRank", Type = "number", Nilable = false }, + { Name = "isBeingResearched", Type = "bool", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "perkSpellID", Type = "number", Nilable = false }, + { Name = "researchDescription", Type = "string", Nilable = true }, + { Name = "playerConditionReason", Type = "string", Nilable = true }, + { Name = "socketInfo", Type = "GarrisonTalentSocketInfo", Nilable = false }, + { Name = "treeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentSocketInfo", + Type = "Structure", + Fields = + { + { Name = "socketType", Type = "number", Nilable = false }, + { Name = "socketSubtype", Type = "number", Nilable = false }, + { Name = "misc0", Type = "number", Nilable = false }, + { Name = "misc1", Type = "number", Nilable = false }, + }, + }, + { + Name = "GarrisonTalentTreeInfo", + Type = "Structure", + Fields = + { + { Name = "treeID", Type = "number", Nilable = false }, + { Name = "title", Type = "cstring", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "talents", Type = "table", InnerType = "GarrisonTalentInfo", Nilable = false }, + { Name = "isClassAgnostic", Type = "bool", Nilable = false }, + { Name = "isThemed", Type = "bool", Nilable = false }, + { Name = "featureType", Type = "number", Nilable = false }, + { Name = "featureSubtype", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GarrisonShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f027bfd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlueDocumentation.lua.annotated.lua @@ -0,0 +1,45 @@ +local Glue = +{ + Name = "Glue", + Type = "System", + Namespace = "C_Glue", + Environment = "All", + + Functions = + { + { + Name = "IsFirstLoadThisSession", + Type = "Function", + + Returns = + { + { Name = "IsFirstLoadThisSession", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnGlueScreen", + Type = "Function", + + Returns = + { + { Name = "isOnGlueScreen", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AccountCvarsLoaded", + Type = "Event", + LiteralName = "ACCOUNT_CVARS_LOADED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Glue); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..eff86b4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local GlyphConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GlyphConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2b61166 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GlyphInfoDocumentation.lua.annotated.lua @@ -0,0 +1,47 @@ +local GlyphInfo = +{ + Name = "GlyphInfo", + Type = "System", + Namespace = "C_GlyphInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "ActivateGlyph", + Type = "Event", + LiteralName = "ACTIVATE_GLYPH", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CancelGlyphCast", + Type = "Event", + LiteralName = "CANCEL_GLYPH_CAST", + SynchronousEvent = true, + }, + { + Name = "UseGlyph", + Type = "Event", + LiteralName = "USE_GLYPH", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GlyphInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..38027e1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,109 @@ +local GossipConstants = +{ + Tables = + { + { + Name = "GossipNpcOption", + Type = "Enumeration", + NumValues = 67, + MinValue = 0, + MaxValue = 66, + Fields = + { + { Name = "None", Type = "GossipNpcOption", EnumValue = 0 }, + { Name = "Vendor", Type = "GossipNpcOption", EnumValue = 1 }, + { Name = "Taxinode", Type = "GossipNpcOption", EnumValue = 2 }, + { Name = "Trainer", Type = "GossipNpcOption", EnumValue = 3 }, + { Name = "SpiritHealer", Type = "GossipNpcOption", EnumValue = 4 }, + { Name = "Binder", Type = "GossipNpcOption", EnumValue = 5 }, + { Name = "Banker", Type = "GossipNpcOption", EnumValue = 6 }, + { Name = "PetitionVendor", Type = "GossipNpcOption", EnumValue = 7 }, + { Name = "GuildTabardVendor", Type = "GossipNpcOption", EnumValue = 8 }, + { Name = "Battlemaster", Type = "GossipNpcOption", EnumValue = 9 }, + { Name = "Auctioneer", Type = "GossipNpcOption", EnumValue = 10 }, + { Name = "TalentMaster", Type = "GossipNpcOption", EnumValue = 11 }, + { Name = "Stablemaster", Type = "GossipNpcOption", EnumValue = 12 }, + { Name = "PetSpecializationMaster", Type = "GossipNpcOption", EnumValue = 13 }, + { Name = "GuildBanker", Type = "GossipNpcOption", EnumValue = 14 }, + { Name = "Spellclick", Type = "GossipNpcOption", EnumValue = 15 }, + { Name = "DisableXPGain", Type = "GossipNpcOption", EnumValue = 16 }, + { Name = "EnableXPGain", Type = "GossipNpcOption", EnumValue = 17 }, + { Name = "Mailbox", Type = "GossipNpcOption", EnumValue = 18 }, + { Name = "WorldPvPQueue", Type = "GossipNpcOption", EnumValue = 19 }, + { Name = "LFGDungeon", Type = "GossipNpcOption", EnumValue = 20 }, + { Name = "ArtifactRespec", Type = "GossipNpcOption", EnumValue = 21 }, + { Name = "CemeterySelect", Type = "GossipNpcOption", EnumValue = 22 }, + { Name = "SpecializationMaster", Type = "GossipNpcOption", EnumValue = 23 }, + { Name = "GlyphMaster", Type = "GossipNpcOption", EnumValue = 24 }, + { Name = "QueueScenario", Type = "GossipNpcOption", EnumValue = 25 }, + { Name = "GarrisonArchitect", Type = "GossipNpcOption", EnumValue = 26 }, + { Name = "GarrisonMissionNpc", Type = "GossipNpcOption", EnumValue = 27 }, + { Name = "ShipmentCrafter", Type = "GossipNpcOption", EnumValue = 28 }, + { Name = "GarrisonTradeskillNpc", Type = "GossipNpcOption", EnumValue = 29 }, + { Name = "GarrisonRecruitment", Type = "GossipNpcOption", EnumValue = 30 }, + { Name = "AdventureMap", Type = "GossipNpcOption", EnumValue = 31 }, + { Name = "GarrisonTalent", Type = "GossipNpcOption", EnumValue = 32 }, + { Name = "ContributionCollector", Type = "GossipNpcOption", EnumValue = 33 }, + { Name = "Transmogrify", Type = "GossipNpcOption", EnumValue = 34 }, + { Name = "AzeriteRespec", Type = "GossipNpcOption", EnumValue = 35 }, + { Name = "IslandsMissionNpc", Type = "GossipNpcOption", EnumValue = 36 }, + { Name = "UIItemInteraction", Type = "GossipNpcOption", EnumValue = 37 }, + { Name = "WorldMap", Type = "GossipNpcOption", EnumValue = 38 }, + { Name = "Soulbind", Type = "GossipNpcOption", EnumValue = 39 }, + { Name = "ChromieTimeNpc", Type = "GossipNpcOption", EnumValue = 40 }, + { Name = "CovenantPreviewNpc", Type = "GossipNpcOption", EnumValue = 41 }, + { Name = "RuneforgeLegendaryCrafting", Type = "GossipNpcOption", EnumValue = 42 }, + { Name = "NewPlayerGuide", Type = "GossipNpcOption", EnumValue = 43 }, + { Name = "RuneforgeLegendaryUpgrade", Type = "GossipNpcOption", EnumValue = 44 }, + { Name = "CovenantRenownNpc", Type = "GossipNpcOption", EnumValue = 45 }, + { Name = "BlackMarketAuctionHouse", Type = "GossipNpcOption", EnumValue = 46 }, + { Name = "PerksProgramVendor", Type = "GossipNpcOption", EnumValue = 47 }, + { Name = "ProfessionsCraftingOrder", Type = "GossipNpcOption", EnumValue = 48 }, + { Name = "ProfessionsOpen", Type = "GossipNpcOption", EnumValue = 49 }, + { Name = "ProfessionsCustomerOrder", Type = "GossipNpcOption", EnumValue = 50 }, + { Name = "TraitSystem", Type = "GossipNpcOption", EnumValue = 51 }, + { Name = "BarbersChoice", Type = "GossipNpcOption", EnumValue = 52 }, + { Name = "MajorFactionRenown", Type = "GossipNpcOption", EnumValue = 53 }, + { Name = "PersonalTabardVendor", Type = "GossipNpcOption", EnumValue = 54 }, + { Name = "ForgeMaster", Type = "GossipNpcOption", EnumValue = 55 }, + { Name = "CharacterBanker", Type = "GossipNpcOption", EnumValue = 56 }, + { Name = "AccountBanker", Type = "GossipNpcOption", EnumValue = 57 }, + { Name = "ProfessionRespec", Type = "GossipNpcOption", EnumValue = 58 }, + { Name = "RenameNeighborhood", Type = "GossipNpcOption", EnumValue = 59 }, + { Name = "HousingCreateGuildNeighborhood", Type = "GossipNpcOption", EnumValue = 60 }, + { Name = "HousingGetNeighborhoodCharter", Type = "GossipNpcOption", EnumValue = 61 }, + { Name = "GuildRename", Type = "GossipNpcOption", EnumValue = 62 }, + { Name = "HousingOpenCharterConfirmation", Type = "GossipNpcOption", EnumValue = 63 }, + { Name = "ItemUpgrade", Type = "GossipNpcOption", EnumValue = 64 }, + { Name = "HouseFinder", Type = "GossipNpcOption", EnumValue = 65 }, + { Name = "TieredEntrance", Type = "GossipNpcOption", EnumValue = 66 }, + }, + }, + { + Name = "GossipNpcOptionDisplayFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "ForceInteractionOnSingleChoice", Type = "GossipNpcOptionDisplayFlags", EnumValue = 1 }, + }, + }, + { + Name = "GossipOptionRecFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "QuestLabelPrepend", Type = "GossipOptionRecFlags", EnumValue = 1 }, + { Name = "HideOptionIDFromClient", Type = "GossipOptionRecFlags", EnumValue = 2 }, + { Name = "PlayMovieLabelPrepend", Type = "GossipOptionRecFlags", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GossipConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f1d8ea2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GossipInfoDocumentation.lua.annotated.lua @@ -0,0 +1,442 @@ +local GossipInfo = +{ + Name = "GossipInfo", + Type = "System", + Namespace = "C_GossipInfo", + Environment = "All", + + Functions = + { + { + Name = "CloseGossip", + Type = "Function", + }, + { + Name = "ForceGossip", + Type = "Function", + + Returns = + { + { Name = "forceGossip", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActiveDelveGossip", + Type = "Function", + + Returns = + { + { Name = "gossip", Type = "GossipOptionUIInfo", Nilable = false }, + }, + }, + { + Name = "GetActiveQuests", + Type = "Function", + + Returns = + { + { Name = "info", Type = "table", InnerType = "GossipQuestUIInfo", Nilable = false }, + }, + }, + { + Name = "GetAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "info", Type = "table", InnerType = "GossipQuestUIInfo", Nilable = false }, + }, + }, + { + Name = "GetCompletedOptionDescriptionString", + Type = "Function", + + Returns = + { + { Name = "description", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetCustomGossipDescriptionString", + Type = "Function", + + Returns = + { + { Name = "description", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetFriendshipReputation", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "friendshipFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "reputationInfo", Type = "FriendshipReputationInfo", Nilable = false }, + }, + }, + { + Name = "GetFriendshipReputationRanks", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "friendshipFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rankInfo", Type = "FriendshipReputationRankInfo", Nilable = false }, + }, + }, + { + Name = "GetGossipDelveMapID", + Type = "Function", + + Returns = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumActiveQuests", + Type = "Function", + + Returns = + { + { Name = "numQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "numQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOptionUIWidgetSetsAndTypesByOptionID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gossipOptionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "gossipOptionUIWidgetSetsAndTypes", Type = "table", InnerType = "GossipOptionUIWidgetSetAndType", Nilable = true }, + }, + }, + { + Name = "GetOptions", + Type = "Function", + + Returns = + { + { Name = "info", Type = "table", InnerType = "GossipOptionUIInfo", Nilable = false }, + }, + }, + { + Name = "GetPoiForUiMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "gossipPoiID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPoiInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "gossipPoiID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "gossipPoiInfo", Type = "GossipPoiInfo", Nilable = true }, + }, + }, + { + Name = "GetText", + Type = "Function", + + Returns = + { + { Name = "gossipText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RefreshOptions", + Type = "Function", + }, + { + Name = "SelectActiveQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SelectAvailableQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SelectOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = true }, + { Name = "confirmed", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SelectOptionByIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionID", Type = "number", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = true }, + { Name = "confirmed", Type = "bool", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "DynamicGossipPoiUpdated", + Type = "Event", + LiteralName = "DYNAMIC_GOSSIP_POI_UPDATED", + UniqueEvent = true, + }, + { + Name = "GossipClosed", + Type = "Event", + LiteralName = "GOSSIP_CLOSED", + SynchronousEvent = true, + Payload = + { + { Name = "interactionIsContinuing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GossipConfirm", + Type = "Event", + LiteralName = "GOSSIP_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "gossipID", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "cost", Type = "WOWMONEY", Nilable = false }, + }, + }, + { + Name = "GossipConfirmCancel", + Type = "Event", + LiteralName = "GOSSIP_CONFIRM_CANCEL", + SynchronousEvent = true, + }, + { + Name = "GossipEnterCode", + Type = "Event", + LiteralName = "GOSSIP_ENTER_CODE", + SynchronousEvent = true, + Payload = + { + { Name = "gossipID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GossipOptionsRefreshed", + Type = "Event", + LiteralName = "GOSSIP_OPTIONS_REFRESHED", + SynchronousEvent = true, + }, + { + Name = "GossipShow", + Type = "Event", + LiteralName = "GOSSIP_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "uiTextureKit", Type = "textureKit", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "GossipOptionRewardType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Item", Type = "GossipOptionRewardType", EnumValue = 0 }, + { Name = "Currency", Type = "GossipOptionRewardType", EnumValue = 1 }, + }, + }, + { + Name = "GossipOptionStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Available", Type = "GossipOptionStatus", EnumValue = 0 }, + { Name = "Unavailable", Type = "GossipOptionStatus", EnumValue = 1 }, + { Name = "Locked", Type = "GossipOptionStatus", EnumValue = 2 }, + { Name = "AlreadyComplete", Type = "GossipOptionStatus", EnumValue = 3 }, + }, + }, + { + Name = "GossipOptionUIWidgetSetTypes", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Modifiers", Type = "GossipOptionUIWidgetSetTypes", EnumValue = 0 }, + { Name = "Background", Type = "GossipOptionUIWidgetSetTypes", EnumValue = 1 }, + }, + }, + { + Name = "FriendshipReputationInfo", + Type = "Structure", + Fields = + { + { Name = "friendshipFactionID", Type = "number", Nilable = false }, + { Name = "standing", Type = "number", Nilable = false }, + { Name = "maxRep", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "texture", Type = "number", Nilable = false }, + { Name = "reaction", Type = "string", Nilable = false }, + { Name = "reactionThreshold", Type = "number", Nilable = false }, + { Name = "nextThreshold", Type = "number", Nilable = true }, + { Name = "reversedColor", Type = "bool", Nilable = false }, + { Name = "overrideColor", Type = "number", Nilable = true }, + }, + }, + { + Name = "FriendshipReputationRankInfo", + Type = "Structure", + Fields = + { + { Name = "currentLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GossipOptionRewardInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "rewardType", Type = "GossipOptionRewardType", Nilable = false }, + { Name = "context", Type = "ItemCreationContext", Nilable = false }, + }, + }, + { + Name = "GossipOptionUIInfo", + Type = "Structure", + Fields = + { + { Name = "gossipOptionID", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "rewards", Type = "table", InnerType = "GossipOptionRewardInfo", Nilable = false }, + { Name = "status", Type = "GossipOptionStatus", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "flags", Type = "number", Nilable = false }, + { Name = "overrideIconID", Type = "fileID", Nilable = true }, + { Name = "selectOptionWhenOnlyOption", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "failureDescription", Type = "string", Nilable = true }, + }, + }, + { + Name = "GossipOptionUIWidgetSetAndType", + Type = "Structure", + Fields = + { + { Name = "widgetType", Type = "number", Nilable = false }, + { Name = "uiWidgetSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GossipPoiInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "textureIndex", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "inBattleMap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GossipQuestUIInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "questLevel", Type = "number", Nilable = false }, + { Name = "isTrivial", Type = "bool", Nilable = false }, + { Name = "frequency", Type = "number", Nilable = true }, + { Name = "repeatable", Type = "bool", Nilable = true }, + { Name = "isComplete", Type = "bool", Nilable = true }, + { Name = "isLegendary", Type = "bool", Nilable = false }, + { Name = "isIgnored", Type = "bool", Nilable = false }, + { Name = "questID", Type = "number", Nilable = false }, + { Name = "isImportant", Type = "bool", Nilable = false }, + { Name = "isMeta", Type = "bool", Nilable = false }, + { Name = "questInfoID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GossipInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GroupFinderConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GroupFinderConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2d52d56 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GroupFinderConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local GroupFinderConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GroupFinderConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c96544e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildBankDocumentation.lua.annotated.lua @@ -0,0 +1,98 @@ +local GuildBank = +{ + Name = "GuildBank", + Type = "System", + Namespace = "C_GuildBank", + Environment = "All", + + Functions = + { + { + Name = "IsGuildBankEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "GuildbankItemLockChanged", + Type = "Event", + LiteralName = "GUILDBANK_ITEM_LOCK_CHANGED", + SynchronousEvent = true, + }, + { + Name = "GuildbankTextChanged", + Type = "Event", + LiteralName = "GUILDBANK_TEXT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "guildBankTab", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GuildbankUpdateMoney", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_MONEY", + SynchronousEvent = true, + }, + { + Name = "GuildbankUpdateTabs", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_TABS", + SynchronousEvent = true, + }, + { + Name = "GuildbankUpdateText", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_TEXT", + SynchronousEvent = true, + Payload = + { + { Name = "guildBankTab", Type = "number", Nilable = false }, + }, + }, + { + Name = "GuildbankUpdateWithdrawmoney", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_WITHDRAWMONEY", + SynchronousEvent = true, + }, + { + Name = "GuildbankbagslotsChanged", + Type = "Event", + LiteralName = "GUILDBANKBAGSLOTS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "GuildbankframeClosed", + Type = "Event", + LiteralName = "GUILDBANKFRAME_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GuildbankframeOpened", + Type = "Event", + LiteralName = "GUILDBANKFRAME_OPENED", + SynchronousEvent = true, + }, + { + Name = "GuildbanklogUpdate", + Type = "Event", + LiteralName = "GUILDBANKLOG_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GuildBank); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e4589ed --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,71 @@ +local GuildConstants = +{ + Tables = + { + { + Name = "GuildErrorType", + Type = "Enumeration", + NumValues = 53, + MinValue = 0, + MaxValue = 52, + Fields = + { + { Name = "Success", Type = "GuildErrorType", EnumValue = 0 }, + { Name = "UnknownError", Type = "GuildErrorType", EnumValue = 1 }, + { Name = "AlreadyInGuild", Type = "GuildErrorType", EnumValue = 2 }, + { Name = "TargetAlreadyInGuild", Type = "GuildErrorType", EnumValue = 3 }, + { Name = "InvitedToGuild", Type = "GuildErrorType", EnumValue = 4 }, + { Name = "TargetInvitedToGuild", Type = "GuildErrorType", EnumValue = 5 }, + { Name = "NameInvalid", Type = "GuildErrorType", EnumValue = 6 }, + { Name = "NameAlreadyExists", Type = "GuildErrorType", EnumValue = 7 }, + { Name = "NoPermisson", Type = "GuildErrorType", EnumValue = 8 }, + { Name = "NotInGuild", Type = "GuildErrorType", EnumValue = 9 }, + { Name = "TargetNotInGuild", Type = "GuildErrorType", EnumValue = 10 }, + { Name = "PlayerNotFound", Type = "GuildErrorType", EnumValue = 11 }, + { Name = "WrongFaction", Type = "GuildErrorType", EnumValue = 12 }, + { Name = "TargetTooHigh", Type = "GuildErrorType", EnumValue = 13 }, + { Name = "TargetTooLow", Type = "GuildErrorType", EnumValue = 14 }, + { Name = "TooManyRanks", Type = "GuildErrorType", EnumValue = 15 }, + { Name = "TooFewRanks", Type = "GuildErrorType", EnumValue = 16 }, + { Name = "RanksLocked", Type = "GuildErrorType", EnumValue = 17 }, + { Name = "RankInUse", Type = "GuildErrorType", EnumValue = 18 }, + { Name = "Ignored", Type = "GuildErrorType", EnumValue = 19 }, + { Name = "Busy", Type = "GuildErrorType", EnumValue = 20 }, + { Name = "TargetLevelTooLow", Type = "GuildErrorType", EnumValue = 21 }, + { Name = "TargetLevelTooHigh", Type = "GuildErrorType", EnumValue = 22 }, + { Name = "TooManyMembers", Type = "GuildErrorType", EnumValue = 23 }, + { Name = "InvalidBankTab", Type = "GuildErrorType", EnumValue = 24 }, + { Name = "WithdrawLimit", Type = "GuildErrorType", EnumValue = 25 }, + { Name = "NotEnoughMoney", Type = "GuildErrorType", EnumValue = 26 }, + { Name = "TeamNotFound", Type = "GuildErrorType", EnumValue = 27 }, + { Name = "BankTabFull", Type = "GuildErrorType", EnumValue = 28 }, + { Name = "BadItem", Type = "GuildErrorType", EnumValue = 29 }, + { Name = "TeamsLocked", Type = "GuildErrorType", EnumValue = 30 }, + { Name = "TooMuchMoney", Type = "GuildErrorType", EnumValue = 31 }, + { Name = "WrongBankTab", Type = "GuildErrorType", EnumValue = 32 }, + { Name = "TooManyCreate", Type = "GuildErrorType", EnumValue = 33 }, + { Name = "RankRequiresAuthenticator", Type = "GuildErrorType", EnumValue = 34 }, + { Name = "BankTabLocked", Type = "GuildErrorType", EnumValue = 35 }, + { Name = "TrialAccount", Type = "GuildErrorType", EnumValue = 36 }, + { Name = "VeteranAccount", Type = "GuildErrorType", EnumValue = 37 }, + { Name = "UndeletableDueToLevel", Type = "GuildErrorType", EnumValue = 38 }, + { Name = "LockedForMove", Type = "GuildErrorType", EnumValue = 39 }, + { Name = "GuildRepTooLow", Type = "GuildErrorType", EnumValue = 40 }, + { Name = "CantInviteSelf", Type = "GuildErrorType", EnumValue = 41 }, + { Name = "HasRestriction", Type = "GuildErrorType", EnumValue = 42 }, + { Name = "BankNotFound", Type = "GuildErrorType", EnumValue = 43 }, + { Name = "NewLeaderWrongFaction", Type = "GuildErrorType", EnumValue = 44 }, + { Name = "GuildBankNotAvailable", Type = "GuildErrorType", EnumValue = 45 }, + { Name = "NewLeaderWrongRealm", Type = "GuildErrorType", EnumValue = 46 }, + { Name = "DeleteNoAppropriateLeader", Type = "GuildErrorType", EnumValue = 47 }, + { Name = "RealmMismatch", Type = "GuildErrorType", EnumValue = 48 }, + { Name = "InCooldown", Type = "GuildErrorType", EnumValue = 49 }, + { Name = "ReservationExpired", Type = "GuildErrorType", EnumValue = 50 }, + { Name = "HousingEvictError", Type = "GuildErrorType", EnumValue = 51 }, + { Name = "Throttled", Type = "GuildErrorType", EnumValue = 52 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GuildConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1e0736b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua.annotated.lua @@ -0,0 +1,636 @@ +local GuildInfo = +{ + Name = "GuildInfo", + Type = "System", + Namespace = "C_GuildInfo", + Environment = "All", + + Functions = + { + { + Name = "AreGuildEventsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanEditOfficerNote", + Type = "Function", + + Returns = + { + { Name = "canEditOfficerNote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSpeakInGuildChat", + Type = "Function", + + Returns = + { + { Name = "canSpeakInGuildChat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanViewOfficerNote", + Type = "Function", + + Returns = + { + { Name = "canViewOfficerNote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Demote", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "Disband", + Type = "Function", + }, + { + Name = "GetGuildNewsInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "newsInfo", Type = "GuildNewsInfo", Nilable = false }, + }, + }, + { + Name = "GetGuildRankOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "rankOrder", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetGuildTabardInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "tabardInfo", Type = "GuildTabardInfo", Nilable = true }, + }, + }, + { + Name = "GuildControlGetRankFlags", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rankOrder", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "permissions", Type = "table", InnerType = "bool", Nilable = false }, + }, + }, + { + Name = "GuildRoster", + Type = "Function", + }, + { + Name = "Invite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsEncounterGuildNewsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGuildOfficer", + Type = "Function", + + Returns = + { + { Name = "isOfficer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGuildRankAssignmentAllowed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "rankOrder", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isGuildRankAssignmentAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGuildReputationEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Leave", + Type = "Function", + }, + { + Name = "MemberExistsByName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Promote", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "QueryGuildMemberRecipes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guildMemberGUID", Type = "WOWGUID", Nilable = false }, + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "QueryGuildMembersForRecipe", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "updatedRecipeSpellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RemoveFromGuild", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RequestGuildRename", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "desiredName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RequestGuildRenameRefund", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "RequestRenameNameCheck", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "desiredName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RequestRenameStatus", + Type = "Function", + + Returns = + { + { Name = "ableToRequest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetGuildRankOrder", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "rankOrder", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetLeader", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetMOTD", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "motd", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetNote", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "note", Type = "cstring", Nilable = false }, + { Name = "isPublic", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Uninvite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CloseTabardFrame", + Type = "Event", + LiteralName = "CLOSE_TABARD_FRAME", + SynchronousEvent = true, + }, + { + Name = "DisableDeclineGuildInvite", + Type = "Event", + LiteralName = "DISABLE_DECLINE_GUILD_INVITE", + SynchronousEvent = true, + }, + { + Name = "EnableDeclineGuildInvite", + Type = "Event", + LiteralName = "ENABLE_DECLINE_GUILD_INVITE", + SynchronousEvent = true, + }, + { + Name = "GuildChallengeCompleted", + Type = "Event", + LiteralName = "GUILD_CHALLENGE_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "challengeType", Type = "number", Nilable = false }, + { Name = "currentCount", Type = "number", Nilable = false }, + { Name = "maxCount", Type = "number", Nilable = false }, + { Name = "goldAwarded", Type = "number", Nilable = false }, + }, + }, + { + Name = "GuildChallengeUpdated", + Type = "Event", + LiteralName = "GUILD_CHALLENGE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "GuildEventLogUpdate", + Type = "Event", + LiteralName = "GUILD_EVENT_LOG_UPDATE", + SynchronousEvent = true, + }, + { + Name = "GuildInviteCancel", + Type = "Event", + LiteralName = "GUILD_INVITE_CANCEL", + SynchronousEvent = true, + }, + { + Name = "GuildInviteRequest", + Type = "Event", + LiteralName = "GUILD_INVITE_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "inviter", Type = "cstring", Nilable = false }, + { Name = "guildName", Type = "cstring", Nilable = false }, + { Name = "guildAchievementPoints", Type = "number", Nilable = false }, + { Name = "oldGuildName", Type = "cstring", Nilable = false }, + { Name = "isNewGuild", Type = "bool", Nilable = true }, + { Name = "tabardInfo", Type = "GuildTabardInfo", Nilable = true }, + }, + }, + { + Name = "GuildMotd", + Type = "Event", + LiteralName = "GUILD_MOTD", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "motdText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GuildNewsUpdate", + Type = "Event", + LiteralName = "GUILD_NEWS_UPDATE", + UniqueEvent = true, + }, + { + Name = "GuildPartyStateUpdated", + Type = "Event", + LiteralName = "GUILD_PARTY_STATE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "inGuildParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildRanksUpdate", + Type = "Event", + LiteralName = "GUILD_RANKS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "GuildRecipeKnownByMembers", + Type = "Event", + LiteralName = "GUILD_RECIPE_KNOWN_BY_MEMBERS", + SynchronousEvent = true, + }, + { + Name = "GuildRegistrarClosed", + Type = "Event", + LiteralName = "GUILD_REGISTRAR_CLOSED", + SynchronousEvent = true, + }, + { + Name = "GuildRegistrarShow", + Type = "Event", + LiteralName = "GUILD_REGISTRAR_SHOW", + SynchronousEvent = true, + }, + { + Name = "GuildRenameNameCheck", + Type = "Event", + LiteralName = "GUILD_RENAME_NAME_CHECK", + SynchronousEvent = true, + Payload = + { + { Name = "desiredName", Type = "cstring", Nilable = false }, + { Name = "status", Type = "GuildErrorType", Nilable = false }, + { Name = "nameErrorToken", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GuildRenameRefundResult", + Type = "Event", + LiteralName = "GUILD_RENAME_REFUND_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "guildName", Type = "cstring", Nilable = false }, + { Name = "status", Type = "GuildErrorType", Nilable = false }, + }, + }, + { + Name = "GuildRenameRequired", + Type = "Event", + LiteralName = "GUILD_RENAME_REQUIRED", + SynchronousEvent = true, + Payload = + { + { Name = "flagSet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildRenameStatusUpdate", + Type = "Event", + LiteralName = "GUILD_RENAME_STATUS_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "status", Type = "GuildRenameStatus", Nilable = false }, + }, + }, + { + Name = "GuildRewardsList", + Type = "Event", + LiteralName = "GUILD_REWARDS_LIST", + SynchronousEvent = true, + }, + { + Name = "GuildRewardsListUpdate", + Type = "Event", + LiteralName = "GUILD_REWARDS_LIST_UPDATE", + UniqueEvent = true, + }, + { + Name = "GuildRosterUpdate", + Type = "Event", + LiteralName = "GUILD_ROSTER_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "canRequestRosterUpdate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildTradeskillUpdate", + Type = "Event", + LiteralName = "GUILD_TRADESKILL_UPDATE", + SynchronousEvent = true, + }, + { + Name = "GuildtabardUpdate", + Type = "Event", + LiteralName = "GUILDTABARD_UPDATE", + SynchronousEvent = true, + }, + { + Name = "OpenTabardFrame", + Type = "Event", + LiteralName = "OPEN_TABARD_FRAME", + SynchronousEvent = true, + }, + { + Name = "PlayerGuildUpdate", + Type = "Event", + LiteralName = "PLAYER_GUILD_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "RequestedGuildRenameResult", + Type = "Event", + LiteralName = "REQUESTED_GUILD_RENAME_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "newName", Type = "cstring", Nilable = false }, + { Name = "status", Type = "GuildErrorType", Nilable = false }, + }, + }, + { + Name = "RequiredGuildRenameResult", + Type = "Event", + LiteralName = "REQUIRED_GUILD_RENAME_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TabardCansaveChanged", + Type = "Event", + LiteralName = "TABARD_CANSAVE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "TabardSavePending", + Type = "Event", + LiteralName = "TABARD_SAVE_PENDING", + SynchronousEvent = true, + }, + { + Name = "UnitGuildLevel", + Type = "Event", + LiteralName = "UNIT_GUILD_LEVEL", + SynchronousEvent = true, + Payload = + { + { Name = "newLevel", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "GuildNewsInfo", + Type = "Structure", + Fields = + { + { Name = "isSticky", Type = "bool", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "newsType", Type = "number", Nilable = false }, + { Name = "whoText", Type = "string", Nilable = true }, + { Name = "whatText", Type = "string", Nilable = true }, + { Name = "newsDataID", Type = "number", Nilable = false }, + { Name = "data", Type = "table", InnerType = "number", Nilable = false }, + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "guildMembersPresent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GuildRenameStatus", + Type = "Structure", + Fields = + { + { Name = "isNameChangeEnabled", Type = "bool", Nilable = false }, + { Name = "isPlayerGuildMaster", Type = "bool", Nilable = false }, + { Name = "refundEligibleEndTime", Type = "time_t", Nilable = false }, + { Name = "nextRenameTime", Type = "time_t", Nilable = false }, + { Name = "renamePrice", Type = "WOWMONEY", Nilable = false }, + { Name = "refundAmount", Type = "WOWMONEY", Nilable = false }, + { Name = "currentGuildMoney", Type = "WOWMONEY", Nilable = false }, + { Name = "result", Type = "GuildErrorType", Nilable = false }, + { Name = "oldGuildName", Type = "cstring", Nilable = false }, + { Name = "reservedName", Type = "cstring", Nilable = false }, + { Name = "reservedNameExpirationTime", Type = "time_t", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GuildInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..22271b4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/GuildInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local GuildInfoShared = +{ + Tables = + { + { + Name = "GuildTabardInfo", + Type = "Structure", + Fields = + { + { Name = "backgroundColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "borderColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "emblemColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "emblemFileID", Type = "number", Nilable = false }, + { Name = "emblemStyle", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GuildInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6ffd7b1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HeirloomInfoDocumentation.lua.annotated.lua @@ -0,0 +1,110 @@ +local HeirloomInfo = +{ + Name = "HeirloomInfo", + Type = "System", + Namespace = "C_HeirloomInfo", + Environment = "All", + + Functions = + { + { + Name = "AreAllCollectionFiltersChecked", + Type = "Function", + + Returns = + { + { Name = "areAllCollectionFiltersChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AreAllSourceFiltersChecked", + Type = "Function", + + Returns = + { + { Name = "areAllSourceFiltersChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHeirloomSourceValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isHeirloomSourceValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingDefaultFilters", + Type = "Function", + + Returns = + { + { Name = "isUsingDefaultFilters", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllCollectionFilters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllSourceFilters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDefaultFilters", + Type = "Function", + }, + }, + + Events = + { + { + Name = "HeirloomUpgradeTargetingChanged", + Type = "Event", + LiteralName = "HEIRLOOM_UPGRADE_TARGETING_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "pendingHeirloomUpgradeSpellcast", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HeirloomsUpdated", + Type = "Event", + LiteralName = "HEIRLOOMS_UPDATED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "updateReason", Type = "cstring", Nilable = true }, + { Name = "hideUntilLearned", Type = "bool", Nilable = true }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(HeirloomInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..06f2e3e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseEditorUIDocumentation.lua.annotated.lua @@ -0,0 +1,148 @@ +local HouseEditorUI = +{ + Name = "HouseEditorUI", + Type = "System", + Namespace = "C_HouseEditor", + Environment = "All", + + Functions = + { + { + Name = "ActivateHouseEditorMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempts switch the House Editor to a specific House Editor mode" }, + + Arguments = + { + { Name = "editMode", Type = "HouseEditorMode", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "HousingResult", Nilable = false, Documentation = { "The initial result of the attempt to activate the mode; If Success, mode is either already active, or we've succesfully started making required requests to server; Listen for MODE_CHANGED or MODE_CHANGE_FAILURE events for ultimate end result after server calls" } }, + }, + }, + { + Name = "EnterHouseEditor", + Type = "Function", + Documentation = { "Attempts to open the House Editor to the default House Editor mode" }, + + Returns = + { + { Name = "result", Type = "HousingResult", Nilable = false, Documentation = { "The initial result of the attempt to open the Editor; If Success, Editor is either already active, or we've succesfully started making required requests to server; Listen for MODE_CHANGED or MODE_CHANGE_FAILURE events for ultimate end result after server calls" } }, + }, + }, + { + Name = "GetActiveHouseEditorMode", + Type = "Function", + + Returns = + { + { Name = "editMode", Type = "HouseEditorMode", Nilable = false }, + }, + }, + { + Name = "GetHouseEditorAvailability", + Type = "Function", + Documentation = { "Returns the availability state of the House Editor overall" }, + + Returns = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "GetHouseEditorModeAvailability", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the availability of a specific House Editor mode" }, + + Arguments = + { + { Name = "editMode", Type = "HouseEditorMode", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "IsHouseEditorActive", + Type = "Function", + Documentation = { "Returns whether the House Editor is active, in any mode" }, + + Returns = + { + { Name = "isEditorActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseEditorModeActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the specific House Editor mode is active" }, + + Arguments = + { + { Name = "editMode", Type = "HouseEditorMode", Nilable = false }, + }, + + Returns = + { + { Name = "isModeActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseEditorStatusAvailable", + Type = "Function", + Documentation = { "Returns true if the HouseEditor currently able process mode availability and switching; May be false if not in a house or plot, or while waiting to get house settings back from the server" }, + + Returns = + { + { Name = "editorStatusAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveHouseEditor", + Type = "Function", + }, + }, + + Events = + { + { + Name = "HouseEditorAvailabilityChanged", + Type = "Event", + LiteralName = "HOUSE_EDITOR_AVAILABILITY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "HouseEditorModeChangeFailure", + Type = "Event", + LiteralName = "HOUSE_EDITOR_MODE_CHANGE_FAILURE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HouseEditorModeChanged", + Type = "Event", + LiteralName = "HOUSE_EDITOR_MODE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "currentEditMode", Type = "HouseEditorMode", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(HouseEditorUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..89d1894 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,83 @@ +local HouseExteriorConstants = +{ + Tables = + { + { + Name = "HouseExteriorSizeOption", + Type = "Structure", + Fields = + { + { Name = "size", Type = "HousingFixtureSize", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HouseExteriorSizeOptionsInfo", + Type = "Structure", + Fields = + { + { Name = "selectedSize", Type = "HousingFixtureSize", Nilable = false }, + { Name = "options", Type = "table", InnerType = "HouseExteriorSizeOption", Nilable = false }, + }, + }, + { + Name = "HouseExteriorTypeOption", + Type = "Structure", + Fields = + { + { Name = "houseExteriorTypeID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "lockReasonString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "HouseExteriorTypeOptionsInfo", + Type = "Structure", + Fields = + { + { Name = "selectedExteriorType", Type = "number", Nilable = false }, + { Name = "options", Type = "table", InnerType = "HouseExteriorTypeOption", Nilable = false }, + }, + }, + { + Name = "HousingCoreFixtureInfo", + Type = "Structure", + Fields = + { + { Name = "selectedVariantFixtureID", Type = "number", Nilable = false, Documentation = { "For fixtures that are variants, the id of specific selected variant; If fixture has no variants, will be the same id as selectedStyleFixtureID" } }, + { Name = "selectedStyleFixtureID", Type = "number", Nilable = false, Documentation = { "For fixtures that are variants, the id of their specific base style fixture; If fixture has no variants, will be the same id as selectedVariantFixtureID" } }, + { Name = "currentStyleVariantOptions", Type = "table", InnerType = "HousingFixtureOption", Nilable = false, Documentation = { "Fixtures that are variants of the same style as the selected (meaning they all share the same hooks); Includes the currently selected fixture" } }, + { Name = "styleOptions", Type = "table", InnerType = "HousingFixtureOption", Nilable = false, Documentation = { "Fixtures that are different styles for this type and size of fixture (swapping will clear all hooks); Includes the currently selected fixture" } }, + }, + }, + { + Name = "HousingFixtureOption", + Type = "Structure", + Fields = + { + { Name = "fixtureID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "typeID", Type = "number", Nilable = false }, + { Name = "typeName", Type = "cstring", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "lockReasonString", Type = "cstring", Nilable = false }, + { Name = "colorID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingFixturePointInfo", + Type = "Structure", + Fields = + { + { Name = "ownerHash", Type = "number", Nilable = false }, + { Name = "selectedFixtureID", Type = "number", Nilable = true }, + { Name = "fixtureOptions", Type = "table", InnerType = "HousingFixtureOption", Nilable = false }, + { Name = "canSelectionBeRemoved", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HouseExteriorConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3d71894 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HouseExteriorUIDocumentation.lua.annotated.lua @@ -0,0 +1,255 @@ +local HouseExteriorUI = +{ + Name = "HouseExteriorUI", + Type = "System", + Namespace = "C_HouseExterior", + Environment = "All", + + Functions = + { + { + Name = "CancelActiveExteriorEditing", + Type = "Function", + Documentation = { "Cancels all in-progress editing of house exterior fixtures, which will deselect any active targets" }, + }, + { + Name = "GetCoreFixtureOptionsInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "coreFixtureType", Type = "HousingFixtureType", Nilable = false }, + }, + + Returns = + { + { Name = "coreFixtureOptionsInfo", Type = "HousingCoreFixtureInfo", Nilable = true }, + }, + }, + { + Name = "GetCurrentHouseExteriorSize", + Type = "Function", + + Returns = + { + { Name = "houseExteriorSize", Type = "HousingFixtureSize", Nilable = true }, + }, + }, + { + Name = "GetCurrentHouseExteriorType", + Type = "Function", + + Returns = + { + { Name = "houseExteriorTypeID", Type = "number", Nilable = true }, + { Name = "houseExteriorTypeName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetHouseExteriorSizeOptions", + Type = "Function", + + Returns = + { + { Name = "options", Type = "HouseExteriorSizeOptionsInfo", Nilable = true }, + }, + }, + { + Name = "GetHouseExteriorTypeOptions", + Type = "Function", + + Returns = + { + { Name = "options", Type = "HouseExteriorTypeOptionsInfo", Nilable = true }, + }, + }, + { + Name = "GetSelectedFixturePointInfo", + Type = "Function", + + Returns = + { + { Name = "fixturePointInfo", Type = "HousingFixturePointInfo", Nilable = true }, + }, + }, + { + Name = "HasHoveredFixture", + Type = "Function", + + Returns = + { + { Name = "anyHoveredFixture", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSelectedFixturePoint", + Type = "Function", + + Returns = + { + { Name = "anySelectedFixturePoint", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveFixtureFromSelectedPoint", + Type = "Function", + }, + { + Name = "SelectCoreFixtureOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fixtureID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SelectFixtureOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fixtureID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetHouseExteriorSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "size", Type = "HousingFixtureSize", Nilable = false }, + }, + }, + { + Name = "SetHouseExteriorType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "houseExteriorTypeID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HouseExteriorTypeUnlocked", + Type = "Event", + LiteralName = "HOUSE_EXTERIOR_TYPE_UNLOCKED", + UniqueEvent = true, + Payload = + { + { Name = "fixtureID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingCoreFixtureChanged", + Type = "Event", + LiteralName = "HOUSING_CORE_FIXTURE_CHANGED", + UniqueEvent = true, + Payload = + { + { Name = "coreFixtureType", Type = "HousingFixtureType", Nilable = false }, + }, + }, + { + Name = "HousingFixtureHoverChanged", + Type = "Event", + LiteralName = "HOUSING_FIXTURE_HOVER_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "anyHovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingFixturePointFrameAdded", + Type = "Event", + LiteralName = "HOUSING_FIXTURE_POINT_FRAME_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "pointFrame", Type = "HousingFixturePointFrame", Nilable = false }, + }, + }, + { + Name = "HousingFixturePointFrameReleased", + Type = "Event", + LiteralName = "HOUSING_FIXTURE_POINT_FRAME_RELEASED", + SynchronousEvent = true, + Payload = + { + { Name = "pointFrame", Type = "HousingFixturePointFrame", Nilable = false }, + }, + }, + { + Name = "HousingFixturePointFramesReleased", + Type = "Event", + LiteralName = "HOUSING_FIXTURE_POINT_FRAMES_RELEASED", + SynchronousEvent = true, + }, + { + Name = "HousingFixturePointSelectionChanged", + Type = "Event", + LiteralName = "HOUSING_FIXTURE_POINT_SELECTION_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasSelection", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingFixtureUnlocked", + Type = "Event", + LiteralName = "HOUSING_FIXTURE_UNLOCKED", + UniqueEvent = true, + Payload = + { + { Name = "fixtureID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingSetExteriorHouseSizeResponse", + Type = "Event", + LiteralName = "HOUSING_SET_EXTERIOR_HOUSE_SIZE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingSetExteriorHouseTypeResponse", + Type = "Event", + LiteralName = "HOUSING_SET_EXTERIOR_HOUSE_TYPE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingSetFixtureResponse", + Type = "Event", + LiteralName = "HOUSING_SET_FIXTURE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(HouseExteriorUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5cf816a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingBasicModeUIDocumentation.lua.annotated.lua @@ -0,0 +1,289 @@ +local HousingBasicModeUI = +{ + Name = "HousingBasicModeUI", + Type = "System", + Namespace = "C_HousingBasicMode", + Environment = "All", + + Functions = + { + { + Name = "CancelActiveEditing", + Type = "Function", + Documentation = { "Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target; Un-placed decor will be returned to the house chest" }, + }, + { + Name = "CommitDecorMovement", + Type = "Function", + Documentation = { "Attempt to save the changes made to the currently selected decor instance" }, + }, + { + Name = "CommitHouseExteriorPosition", + Type = "Function", + Documentation = { "Attempt to save the changes made to the House Exterior's position within the plot" }, + }, + { + Name = "FinishPlacingNewDecor", + Type = "Function", + }, + { + Name = "GetHoveredDecorInfo", + Type = "Function", + Documentation = { "Returns info for the placed decor instance currently being hovered, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetSelectedDecorInfo", + Type = "Function", + Documentation = { "Returns info for the decor instance that's currently selected, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "IsDecorSelected", + Type = "Function", + Documentation = { "Returns true if a decor instance is currently selected and being dragged" }, + + Returns = + { + { Name = "hasSelectedDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFreePlaceEnabled", + Type = "Function", + Documentation = { "When free place is enabled, collision checks while dragging decor/the house exterior are ignored" }, + + Returns = + { + { Name = "freePlaceEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGridSnapEnabled", + Type = "Function", + + Returns = + { + { Name = "isGridSnapEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGridVisible", + Type = "Function", + + Returns = + { + { Name = "gridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorHovered", + Type = "Function", + Documentation = { "Returns true if the house's exterior is currently being hovered" }, + + Returns = + { + { Name = "isHouseExteriorHovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorSelected", + Type = "Function", + Documentation = { "Returns true if the house's exterior is currently selected and being moved" }, + + Returns = + { + { Name = "isHouseExteriorSelected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHoveringDecor", + Type = "Function", + Documentation = { "Returns true if a placed decor instance is currently being hovered" }, + + Returns = + { + { Name = "isHoveringDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlacingNewDecor", + Type = "Function", + + Returns = + { + { Name = "hasPendingDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveSelectedDecor", + Type = "Function", + Documentation = { "Attempt to return the currently selected decor instance back to the house chest" }, + }, + { + Name = "RotateDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Rotates the currently selected decor along a single axis; For wall decor, rotates such that the object stays flat against its current wall; For all other decor, rotates around the Z (vertical) axis" }, + + Arguments = + { + { Name = "rotDegrees", Type = "number", Nilable = false }, + }, + }, + { + Name = "RotateHouseExterior", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Rotates the House Exterior around the Z (vertical) axis" }, + + Arguments = + { + { Name = "rotDegrees", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFreePlaceEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Set whether free place is enabled; When free place is enabled, collision checks while dragging decor/the house exterior are ignored" }, + + Arguments = + { + { Name = "freePlaceEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetGridSnapEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isGridSnapEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetGridVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartPlacingNewDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "catalogEntryID", Type = "HousingCatalogEntryID", Nilable = false }, + }, + }, + { + Name = "StartPlacingPreviewDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorRecordID", Type = "number", Nilable = false }, + { Name = "bundleCatalogShopProductID", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "HousingBasicModeHoveredTargetChanged", + Type = "Event", + LiteralName = "HOUSING_BASIC_MODE_HOVERED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasHoveredTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingBasicModeTargetType", Nilable = false }, + }, + }, + { + Name = "HousingBasicModePlacementFlagsUpdated", + Type = "Event", + LiteralName = "HOUSING_BASIC_MODE_PLACEMENT_FLAGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "targetType", Type = "HousingBasicModeTargetType", Nilable = false }, + { Name = "activeFlags", Type = "HousingDecorPlacementRestriction", Nilable = false }, + }, + }, + { + Name = "HousingBasicModeSelectedTargetChanged", + Type = "Event", + LiteralName = "HOUSING_BASIC_MODE_SELECTED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasSelectedTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingBasicModeTargetType", Nilable = false }, + { Name = "isPreview", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingDecorFreePlaceStatusChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_FREE_PLACE_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isFreePlaceEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingDecorGridSnapOccurred", + Type = "Event", + LiteralName = "HOUSING_DECOR_GRID_SNAP_OCCURRED", + SynchronousEvent = true, + }, + { + Name = "HousingDecorGridSnapStatusChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_GRID_SNAP_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isGridSnapEnabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "HousingBasicModeTargetType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "HousingBasicModeTargetType", EnumValue = 0 }, + { Name = "Decor", Type = "HousingBasicModeTargetType", EnumValue = 1 }, + { Name = "House", Type = "HousingBasicModeTargetType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingBasicModeUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6cdc239 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,126 @@ +local HousingCatalogConstants = +{ + Tables = + { + { + Name = "HousingCatalogEntryModelScenePresets", + Type = "Enumeration", + NumValues = 10, + MinValue = 1317, + MaxValue = 1452, + Fields = + { + { Name = "DecorDefault", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1317 }, + { Name = "DecorTiny", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1333 }, + { Name = "DecorSmall", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1334 }, + { Name = "DecorMedium", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1335 }, + { Name = "DecorLarge", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1336 }, + { Name = "DecorHuge", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1337 }, + { Name = "DecorCeiling", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1338 }, + { Name = "DecorWall", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1339 }, + { Name = "DecorFlat", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1318 }, + { Name = "DecorHorizontalSurface", Type = "HousingCatalogEntryModelScenePresets", EnumValue = 1452 }, + }, + }, + { + Name = "HousingCatalogEntrySize", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 69, + Fields = + { + { Name = "None", Type = "HousingCatalogEntrySize", EnumValue = 0 }, + { Name = "Tiny", Type = "HousingCatalogEntrySize", EnumValue = 65 }, + { Name = "Small", Type = "HousingCatalogEntrySize", EnumValue = 66 }, + { Name = "Medium", Type = "HousingCatalogEntrySize", EnumValue = 67 }, + { Name = "Large", Type = "HousingCatalogEntrySize", EnumValue = 68 }, + { Name = "Huge", Type = "HousingCatalogEntrySize", EnumValue = 69 }, + }, + }, + { + Name = "HousingCatalogEntrySubtype", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Invalid", Type = "HousingCatalogEntrySubtype", EnumValue = 0 }, + { Name = "Unowned", Type = "HousingCatalogEntrySubtype", EnumValue = 1, Documentation = { "Unowned entry, for displaying a catalog object in a static context" } }, + { Name = "OwnedModifiedStack", Type = "HousingCatalogEntrySubtype", EnumValue = 2, Documentation = { "Stack of owned instances that share specific modifications (ex: stack of red-dyed chairs)" } }, + { Name = "OwnedUnmodifiedStack", Type = "HousingCatalogEntrySubtype", EnumValue = 3, Documentation = { "Stack of owned default instances of a record" } }, + }, + }, + { + Name = "HousingCatalogEntryType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Invalid", Type = "HousingCatalogEntryType", EnumValue = 0 }, + { Name = "Decor", Type = "HousingCatalogEntryType", EnumValue = 1 }, + { Name = "Room", Type = "HousingCatalogEntryType", EnumValue = 2 }, + }, + }, + { + Name = "HousingCatalogSortType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "DateAdded", Type = "HousingCatalogSortType", EnumValue = 0 }, + { Name = "Alphabetical", Type = "HousingCatalogSortType", EnumValue = 1 }, + }, + }, + { + Name = "HousingCatalogConsts", + Type = "Constants", + Values = + { + { Name = "HOUSING_CATALOG_FEATURED_CATEGORY_ID", Type = "number", Value = 17 }, + { Name = "HOUSING_CATALOG_ALL_CATEGORY_ID", Type = "number", Value = 18 }, + { Name = "HOUSING_CATALOG_DECOR_MODELSCENEID_DEFAULT", Type = "number", Value = 1317 }, + }, + }, + { + Name = "HousingCatalogEntryID", + Type = "Structure", + Documentation = { "Compound Identifier for entry stacks in the catalog" }, + Fields = + { + { Name = "recordID", Type = "number", Nilable = false }, + { Name = "entryType", Type = "HousingCatalogEntryType", Nilable = false }, + { Name = "entrySubtype", Type = "HousingCatalogEntrySubtype", Nilable = false }, + { Name = "subtypeIdentifier", Type = "number", Nilable = false, Documentation = { "Hashed value used to identify and differentiate stacks that are the same type and subtype, but have some other subtype-specific difference" } }, + }, + }, + { + Name = "HousingCatalogFilterTagGroupInfo", + Type = "Structure", + Fields = + { + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "groupName", Type = "cstring", Nilable = false }, + { Name = "tags", Type = "table", InnerType = "HousingCatalogFilterTagInfo", Nilable = false }, + }, + }, + { + Name = "HousingCatalogFilterTagInfo", + Type = "Structure", + Fields = + { + { Name = "tagID", Type = "number", Nilable = false }, + { Name = "tagName", Type = "string", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "anyAssociatedEntries", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingCatalogConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogSearcherAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogSearcherAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d3d6cce --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogSearcherAPIDocumentation.lua.annotated.lua @@ -0,0 +1,550 @@ +local HousingCatalogSearcherAPI = +{ + Name = "HousingCatalogSearcherAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetAllSearchItems", + Type = "Function", + Documentation = { "Returns all catalog entries being searched (note these are NOT search results, this is the source collection of what's being searched)" }, + + Arguments = + { + }, + + Returns = + { + { Name = "matchingEntryIDs", Type = "table", InnerType = "HousingCatalogEntryID", Nilable = false }, + }, + }, + { + Name = "GetCatalogSearchResults", + Type = "Function", + Documentation = { "Returns the most recent search result entries" }, + + Arguments = + { + }, + + Returns = + { + { Name = "matchingEntryIDs", Type = "table", InnerType = "HousingCatalogEntryID", Nilable = false }, + }, + }, + { + Name = "GetEditorModeContext", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "editorModeContext", Type = "HouseEditorMode", Nilable = true }, + }, + }, + { + Name = "GetFilterTagStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "tagID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetFilteredCategoryID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "categoryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFilteredSubcategoryID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "subcategoryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNumSearchItems", + Type = "Function", + Documentation = { "Returns the total number of entries being searched through" }, + + Arguments = + { + }, + + Returns = + { + { Name = "numSearchItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSearchCount", + Type = "Function", + Documentation = { "Returns the total number of owned instances across all most recent search result entries" }, + + Arguments = + { + }, + + Returns = + { + { Name = "searchCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSearchText", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "searchText", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetSortType", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "sortType", Type = "HousingCatalogSortType", Nilable = false }, + }, + }, + { + Name = "IsAllowedIndoorsActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAllowedOutdoorsActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCollectedActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCustomizableOnlyActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDistinctPerRecordIDActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFirstAcquisitionBonusOnlyActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOwnedOnlyActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSearchInProgress", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isSearchInProgress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUncollectedActive", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RunSearch", + Type = "Function", + Documentation = { "Run search with all current param values" }, + + Arguments = + { + }, + }, + { + Name = "SetAllInFilterTagGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Set the toggle state of all filter tags within a specific group; If active, only entries that match Any of the tags in the group will be included in search results" }, + + Arguments = + { + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllowedIndoors", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, entries that can be placed in house interiors will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed outdoors" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllowedOutdoors", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, entries that can be placed outside in plots will be included in the search; Note many decor objects can be placed both indoors and outdoors, so having only this toggled on may still include decor that can also be placed indoors" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAutoUpdateOnParamChanges", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If true, searcher automatically updates results whenever search param values are changed" }, + + Arguments = + { + { Name = "autoUpdateActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCollected", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, includes all owned entries, including those that are in storage OR placed in an owned house or plot; See IsOwnedOnlyActive for a more exclusive toggle" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCustomizableOnly", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, catalog entries that cannot be customized (ie dyed) will be excluded from the search" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDistinctPerRecordID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, only the first entry per recordID will be included" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetEditorModeContext", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If set, limits search results to only entries that are used/valid in the specified editor mode" }, + + Arguments = + { + { Name = "editorModeContext", Type = "HouseEditorMode", Nilable = true }, + }, + }, + { + Name = "SetFilterTagStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Set the toggle state of a single filter tag within a specific group" }, + + Arguments = + { + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "tagID", Type = "number", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFilteredCategoryID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If set, limits search results to only those within the specified category" }, + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetFilteredSubcategoryID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If set, limits search results to only those within the specified subcategory" }, + + Arguments = + { + { Name = "subcategoryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetFirstAcquisitionBonusOnly", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, excludes any entries that do not reward house xp when acquired for the first time" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetOwnedOnly", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, only entries that you own, and have instances of available in storage, will be included; This does not include entries that you own but have all been placed in a house; See IsCollectedActive for param that includes placed entries" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetResultsUpdatedCallback", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "callback", Type = "HousingCatalogSearchResultsUpdatedCallback", Nilable = false }, + }, + }, + { + Name = "SetSearchText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If set, multiple text fields are checked for instances of the text, including name, category, subcategory, and data tags" }, + + Arguments = + { + { Name = "searchText", Type = "string", Nilable = true, Documentation = { "Supports advanced search tokens ('\"' '-' and '|'), case and accent insensitive; Set nil to clear out the search text" } }, + }, + }, + { + Name = "SetSortType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sortType", Type = "HousingCatalogSortType", Nilable = false }, + }, + }, + { + Name = "SetUncollected", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Search parameter; If true, includes entries that are not owned, meaning not available in storage nor placed in any owned houses or plots" }, + + Arguments = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ToggleAllowedIndoors", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleAllowedOutdoors", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleCollected", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleCustomizableOnly", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleDistinctPerRecordID", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleFilterTag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "tagID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ToggleFirstAcquisitionBonusOnly", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleOwnedOnly", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ToggleUncollected", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "HousingCatalogSearchResultsUpdatedCallback", + Type = "CallbackType", + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingCatalogSearcherAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..391fc0a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCatalogUIDocumentation.lua.annotated.lua @@ -0,0 +1,535 @@ +local HousingCatalogUI = +{ + Name = "HousingCatalogUI", + Type = "System", + Namespace = "C_HousingCatalog", + Environment = "All", + + Functions = + { + { + Name = "CreateCatalogSearcher", + Type = "Function", + Documentation = { "Creates a new instance of a HousingCatalog searcher; This can be used to asynchronously search/filter the HousingCatalog without affecting/being restricted by the filter state of other Housing Catalog UI displays" }, + + Returns = + { + { Name = "searcher", Type = "HousingCatalogSearcher", Nilable = false }, + }, + }, + { + Name = "DeletePreviewCartDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "DestroyEntry", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to delete the entry from storage" }, + + Arguments = + { + { Name = "entryID", Type = "HousingCatalogEntryID", Nilable = false }, + { Name = "destroyAll", Type = "bool", Nilable = false, Documentation = { "If true, deletes all entries within the stack; If false, will only delete one" } }, + }, + }, + { + Name = "GetAllFilterTagGroups", + Type = "Function", + + Returns = + { + { Name = "filterTagGroups", Type = "table", InnerType = "HousingCatalogFilterTagGroupInfo", Nilable = false }, + }, + }, + { + Name = "GetBundleInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bundleCatalogShopProductID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "bundleInfo", Type = "HousingBundleInfo", Nilable = true }, + }, + }, + { + Name = "GetCartSizeLimit", + Type = "Function", + + Returns = + { + { Name = "cartSizeLimit", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCatalogCategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "HousingCatalogCategoryInfo", Nilable = true }, + }, + }, + { + Name = "GetCatalogEntryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "entryID", Type = "HousingCatalogEntryID", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "HousingCatalogEntryInfo", Nilable = true }, + }, + }, + { + Name = "GetCatalogEntryInfoByItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false, Documentation = { "ItemID, name, or link of an item that grants/corresponds to a particular type of housing catalog object (ex: decor)" } }, + { Name = "tryGetOwnedInfo", Type = "bool", Nilable = false, Documentation = { "If true and player owns this entry, will return an 'Owned' subtype, with owned quantity info; Otherwise, will be an Unowned subtype with only basic static info" } }, + }, + + Returns = + { + { Name = "info", Type = "HousingCatalogEntryInfo", Nilable = true }, + }, + }, + { + Name = "GetCatalogEntryInfoByRecordID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "entryType", Type = "HousingCatalogEntryType", Nilable = false }, + { Name = "recordID", Type = "number", Nilable = false }, + { Name = "tryGetOwnedInfo", Type = "bool", Nilable = false, Documentation = { "If true and player owns this entry, will return an 'Owned' subtype, with owned quantity info; Otherwise, will be an Unowned subtype with only basic static info" } }, + }, + + Returns = + { + { Name = "info", Type = "HousingCatalogEntryInfo", Nilable = true }, + }, + }, + { + Name = "GetCatalogEntryRefundTimeStampByRecordID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "entryType", Type = "HousingCatalogEntryType", Nilable = false }, + { Name = "recordID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "refundTimeStamp", Type = "time_t", Nilable = true }, + }, + }, + { + Name = "GetCatalogSubcategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "subcategoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "HousingCatalogSubcategoryInfo", Nilable = true }, + }, + }, + { + Name = "GetDecorMaxOwnedCount", + Type = "Function", + Documentation = { "Returns the maximum total number of decor that can be in storage/in the house chest; Note that not all decor entries in storage count towards this limit (see GetDecorTotalOwnedCount)" }, + + Returns = + { + { Name = "maxOwnedCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDecorTotalOwnedCount", + Type = "Function", + + Returns = + { + { Name = "totalOwnedCount", Type = "number", Nilable = false, Documentation = { "The total number of owned decor in storage, including both exempt and non-exempt decor" } }, + { Name = "exemptDecorCount", Type = "number", Nilable = false, Documentation = { "The number of decor that do not count against the max storage limit" } }, + }, + }, + { + Name = "GetDestroyableInstanceCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the number of instances that can be to be destroyed in storage; These instances count towards the max storage limit" }, + + Arguments = + { + { Name = "entryID", Type = "HousingCatalogEntryID", Nilable = false }, + }, + + Returns = + { + { Name = "destroyableInstanceCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFeaturedBundles", + Type = "Function", + + Returns = + { + { Name = "bundleInfos", Type = "table", InnerType = "HousingBundleInfo", Nilable = false }, + }, + }, + { + Name = "GetFeaturedDecor", + Type = "Function", + + Returns = + { + { Name = "entryInfos", Type = "table", InnerType = "HousingFeaturedDecorEntry", Nilable = false }, + }, + }, + { + Name = "GetMarketInfoForDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns market info for a specific decor. This is decor-only for now but should be extended to support entry type and recordID generically" }, + + Arguments = + { + { Name = "decorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "marketInfo", Type = "HousingMarketInfo", Nilable = true }, + }, + }, + { + Name = "HasFeaturedEntries", + Type = "Function", + + Returns = + { + { Name = "hasEntries", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPreviewCartItemShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PromotePreviewDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorID", Type = "number", Nilable = false }, + { Name = "previewDecorGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestHousingMarketInfoRefresh", + Type = "Function", + }, + { + Name = "RequestHousingMarketRefundInfo", + Type = "Function", + }, + { + Name = "SearchCatalogCategories", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchParams", Type = "HousingCategorySearchInfo", Nilable = false }, + }, + + Returns = + { + { Name = "categoryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SearchCatalogSubcategories", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchParams", Type = "HousingCategorySearchInfo", Nilable = false }, + }, + + Returns = + { + { Name = "subcategoryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetPreviewCartItemShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HousingCatalogCategoryUpdated", + Type = "Event", + LiteralName = "HOUSING_CATALOG_CATEGORY_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingCatalogSubcategoryUpdated", + Type = "Event", + LiteralName = "HOUSING_CATALOG_SUBCATEGORY_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "subcategoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingDecorAddToPreviewList", + Type = "Event", + LiteralName = "HOUSING_DECOR_ADD_TO_PREVIEW_LIST", + SynchronousEvent = true, + Payload = + { + { Name = "previewItemData", Type = "HousingPreviewItemData", Nilable = false }, + }, + }, + { + Name = "HousingDecorPreviewListRemoveFromWorld", + Type = "Event", + LiteralName = "HOUSING_DECOR_PREVIEW_LIST_REMOVE_FROM_WORLD", + SynchronousEvent = true, + Payload = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "HousingDecorPreviewListUpdated", + Type = "Event", + LiteralName = "HOUSING_DECOR_PREVIEW_LIST_UPDATED", + SynchronousEvent = true, + }, + { + Name = "HousingRefundListUpdated", + Type = "Event", + LiteralName = "HOUSING_REFUND_LIST_UPDATED", + SynchronousEvent = true, + }, + { + Name = "HousingStorageEntryUpdated", + Type = "Event", + LiteralName = "HOUSING_STORAGE_ENTRY_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "entryID", Type = "HousingCatalogEntryID", Nilable = false }, + }, + }, + { + Name = "HousingStorageUpdated", + Type = "Event", + LiteralName = "HOUSING_STORAGE_UPDATED", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "HousingBundleDecorEntryInfo", + Type = "Structure", + Fields = + { + { Name = "decorID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingBundleInfo", + Type = "Structure", + Fields = + { + { Name = "price", Type = "number", Nilable = false }, + { Name = "originalPrice", Type = "number", Nilable = true }, + { Name = "productID", Type = "number", Nilable = false }, + { Name = "decorEntries", Type = "table", InnerType = "HousingBundleDecorEntryInfo", Nilable = false }, + { Name = "canPreview", Type = "bool", Nilable = false, Default = true, Documentation = { "Bundles containing non-decor items cannot be previewed" } }, + }, + }, + { + Name = "HousingCatalogCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "icon", Type = "textureAtlas", Nilable = true }, + { Name = "subcategoryIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "anyOwnedEntries", Type = "bool", Nilable = false, Documentation = { "True if the player owns anything that falls under this category" } }, + }, + }, + { + Name = "HousingCatalogEntryInfo", + Type = "Structure", + Fields = + { + { Name = "entryID", Type = "HousingCatalogEntryID", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "asset", Type = "ModelAsset", Nilable = true, Documentation = { "3D model asset for displaying in the UI; May be nil if the entry doesn't have a model, or has one that isn't supported by UI model scenes" } }, + { Name = "iconTexture", Type = "FileAsset", Nilable = true, Documentation = { "Entry icon in the form of a texture file; Catalog entries should have either this OR an iconAtlas set" } }, + { Name = "iconAtlas", Type = "textureAtlas", Nilable = true, Documentation = { "Entry icon in the form a texture atlas element; Catalog entries should have either this OR an iconTexture set" } }, + { Name = "uiModelSceneID", Type = "number", Nilable = true, Documentation = { "Specific UI model scene ID to use when previewing this entry's 3D model; If not set, the default catalog model scene is used" } }, + { Name = "categoryIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "subcategoryIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "dataTagsByID", Type = "LuaValueVariant", Nilable = false, Documentation = { "Simple localized 'tag' strings that are primarily used for things like categorization and filtering" } }, + { Name = "size", Type = "HousingCatalogEntrySize", Nilable = false }, + { Name = "placementCost", Type = "number", Nilable = false, Documentation = { "How much of the applicable budget placing this entry would cost (if any)" } }, + { Name = "showQuantity", Type = "bool", Nilable = false, Documentation = { "Typically false if quantity isn't used by or meaningful for this particular kind of catalog entry" } }, + { Name = "quantity", Type = "number", Nilable = false, Documentation = { "The number of fully instantiated instances of this entry that exist in storage; Does not include unredeemed instances (see remainingRedeemable)" } }, + { Name = "remainingRedeemable", Type = "number", Nilable = false, Documentation = { "The number of unredeemed instances of this entry that exist in storage; Some auto-awarded housing objects are granted in this 'lazily-instantiated' way, and will be 'redeemed' on first being placed" } }, + { Name = "destroyableInstanceCount", Type = "number", Nilable = false, Documentation = { "The number of instances that can be destroyed for this entry." } }, + { Name = "numPlaced", Type = "number", Nilable = false, Documentation = { "The total number of instances of this entry that have been placed across all of the player's houses and plots" } }, + { Name = "isUniqueTrophy", Type = "bool", Nilable = false, Documentation = { "This decor is flagged to display as a unique trophy item." } }, + { Name = "isAllowedOutdoors", Type = "bool", Nilable = false, Documentation = { "True if this entry is something that is allowed to be placed outside, within a plot" } }, + { Name = "isAllowedIndoors", Type = "bool", Nilable = false, Documentation = { "True if this entry is something that is allowed to be placed indoors, within a house interior" } }, + { Name = "canCustomize", Type = "bool", Nilable = false, Documentation = { "True if this entry is something that can be customized; Kinds of customization vary depending on the entry type" } }, + { Name = "isPrefab", Type = "bool", Nilable = false }, + { Name = "quality", Type = "ItemQuality", Nilable = true }, + { Name = "customizations", Type = "table", InnerType = "cstring", Nilable = false, Documentation = { "Labels for each of the customizations applied to this entry, if any" } }, + { Name = "dyeIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "firstAcquisitionBonus", Type = "number", Nilable = false, Documentation = { "House XP that can be gained upon acquiring this entry for the first time" } }, + { Name = "sourceText", Type = "cstring", Nilable = false, Documentation = { "Describes specific sources this entry may be gained from; Faction-specific sources may or may not be included based on the current player's faction" } }, + }, + }, + { + Name = "HousingCatalogSubcategoryInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "parentCategoryID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "icon", Type = "textureAtlas", Nilable = true }, + { Name = "anyOwnedEntries", Type = "bool", Nilable = false, Documentation = { "True if the player owns anything that falls under this subcategory" } }, + }, + }, + { + Name = "HousingCategorySearchInfo", + Type = "Structure", + Fields = + { + { Name = "withOwnedEntriesOnly", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, search will only return categories/subcategories that the player owns something under" } }, + { Name = "includeFeaturedCategory", Type = "bool", Nilable = false, Default = false }, + { Name = "editorModeContext", Type = "HouseEditorMode", Nilable = true, Documentation = { "If set, will restrict results to only categories associated with/used by this Editor Mode" } }, + }, + }, + { + Name = "HousingFeaturedDecorEntry", + Type = "Structure", + Fields = + { + { Name = "entryID", Type = "HousingCatalogEntryID", Nilable = false }, + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingMarketInfo", + Type = "Structure", + Fields = + { + { Name = "price", Type = "number", Nilable = false }, + { Name = "productID", Type = "number", Nilable = false }, + { Name = "bundleIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "HousingPreviewItemData", + Type = "Structure", + Fields = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = true }, + { Name = "productID", Type = "number", Nilable = true }, + { Name = "bundleCatalogShopProductID", Type = "number", Nilable = true }, + { Name = "isBundleParent", Type = "bool", Nilable = false }, + { Name = "isBundleChild", Type = "bool", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "decorID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "price", Type = "number", Nilable = false }, + { Name = "salePrice", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingCatalogUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3cbb5e7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCleanupModeUIDocumentation.lua.annotated.lua @@ -0,0 +1,73 @@ +local HousingCleanupModeUI = +{ + Name = "HousingCleanupModeUI", + Type = "System", + Namespace = "C_HousingCleanupMode", + Environment = "All", + + Functions = + { + { + Name = "GetHoveredDecorInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "IsHoveringDecor", + Type = "Function", + + Returns = + { + { Name = "isHoveringDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveSelectedDecor", + Type = "Function", + }, + }, + + Events = + { + { + Name = "HousingCleanupModeHoveredTargetChanged", + Type = "Event", + LiteralName = "HOUSING_CLEANUP_MODE_HOVERED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasHoveredTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingCleanupModeTargetType", Nilable = false }, + }, + }, + { + Name = "HousingCleanupModeTargetSelected", + Type = "Event", + LiteralName = "HOUSING_CLEANUP_MODE_TARGET_SELECTED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "HousingCleanupModeTargetType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "HousingCleanupModeTargetType", EnumValue = 0 }, + { Name = "Decor", Type = "HousingCleanupModeTargetType", EnumValue = 1 }, + { Name = "HouseExterior", Type = "HousingCleanupModeTargetType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingCleanupModeUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cad8c56 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingCustomizeModeUIDocumentation.lua.annotated.lua @@ -0,0 +1,442 @@ +local HousingCustomizeModeUI = +{ + Name = "HousingCustomizeModeUI", + Type = "System", + Namespace = "C_HousingCustomizeMode", + Environment = "All", + + Functions = + { + { + Name = "ApplyDyeToSelectedDecor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If a dyeable decor is selected, applies a specific dye color in a specific slot as a preview; See CommitDyesForSelectedDecor to actually save applied dye changes" }, + + Arguments = + { + { Name = "dyeSlotID", Type = "number", Nilable = false }, + { Name = "dyeColorID", Type = "number", Nilable = true, Documentation = { "If not provided, clears the dye from the specified dye slot, returning that part of the decor asset to its default color" } }, + }, + }, + { + Name = "ApplyThemeToRoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to apply a specific theme set (aka style) to all applicable room components in the current room" }, + + Arguments = + { + { Name = "themeSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ApplyThemeToSelectedRoomComponent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to apply a specific theme set (aka style) to the currently selected room component only" }, + + Arguments = + { + { Name = "themeSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ApplyWallpaperToAllWalls", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to apply a specific wallpaper (aka material/texture) to all applicable room components in the current room" }, + + Arguments = + { + { Name = "roomComponentTextureRecID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ApplyWallpaperToSelectedRoomComponent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to apply a specific wallpaper (aka material/texture) to the currently selected room component only" }, + + Arguments = + { + { Name = "roomComponentTextureRecID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CancelActiveEditing", + Type = "Function", + Documentation = { "Cancels all in-progress editing of the selected target, which will reset any unapplied customization changes and deselect the active target" }, + }, + { + Name = "ClearDyesForSelectedDecor", + Type = "Function", + Documentation = { "Clears all previewed dye changes on the selected decor; Does not clear any already saved dyes that were previously applied" }, + }, + { + Name = "ClearTargetRoomComponent", + Type = "Function", + Documentation = { "Deselect the currently selected room component, if there is one" }, + }, + { + Name = "CommitDyesForSelectedDecor", + Type = "Function", + Documentation = { "Attempt to save all previewed dye changes made to the selected decor" }, + + Returns = + { + { Name = "hasChanges", Type = "bool", Nilable = false, Documentation = { "True if there were any changes to save" } }, + }, + }, + { + Name = "GetHoveredDecorInfo", + Type = "Function", + Documentation = { "Returns info for the placed decor instance currently being hovered, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetHoveredRoomComponentInfo", + Type = "Function", + Documentation = { "Returns info for the room component currently being hovered, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingRoomComponentInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetNumDyesToRemoveOnSelectedDecor", + Type = "Function", + Documentation = { "If a dyeable decor instance is selected, returns how many dye slots would be cleared on applying all currently previewed dye changes" }, + + Returns = + { + { Name = "numDyesToRemove", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumDyesToSpendOnSelectedDecor", + Type = "Function", + Documentation = { "If a dyeable decor instance is selected, returns how many dye items would be spent on applying all currently previewed dye changes" }, + + Returns = + { + { Name = "numDyesToSpend", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPreviewDyesOnSelectedDecor", + Type = "Function", + Documentation = { "If a dyeable decor instance is selected, returns info structs for each new/changed dye currently being previewed" }, + + Returns = + { + { Name = "previewDyes", Type = "table", InnerType = "PreviewDyeSlotInfo", Nilable = false }, + }, + }, + { + Name = "GetRecentlyUsedDyes", + Type = "Function", + Documentation = { "Returns a list of ids for the dyes most recently applied by the player, if any" }, + + Returns = + { + { Name = "recentDyes", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRecentlyUsedThemeSets", + Type = "Function", + Documentation = { "Returns a list of ids for the theme sets (aka styles) most recently applied by the player, if any" }, + + Returns = + { + { Name = "recentThemeSets", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRecentlyUsedWallpapers", + Type = "Function", + Documentation = { "Returns a list of ids for the wallpapers most recently applied by the player, if any" }, + + Returns = + { + { Name = "recentWallpapers", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedDecorInfo", + Type = "Function", + Documentation = { "Returns info for the decor instance that's currently selected, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetSelectedRoomComponentInfo", + Type = "Function", + Documentation = { "Returns info for the currently selected room component, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingRoomComponentInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetThemeSetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the name of the specified theme set (aka style) if it exists" }, + + Arguments = + { + { Name = "themeSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetWallpapersForRoomComponentType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get all wallpapers (aka materials/textures) available for the selected room component type, if any" }, + + Arguments = + { + { Name = "type", Type = "HousingRoomComponentType", Nilable = false }, + }, + + Returns = + { + { Name = "availableWallpapers", Type = "table", InnerType = "RoomComponentWallpaper", Nilable = false }, + }, + }, + { + Name = "IsDecorSelected", + Type = "Function", + Documentation = { "Returns true if a decor instance is currently selected for customization" }, + + Returns = + { + { Name = "hasSelectedDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorDoorHovered", + Type = "Function", + Documentation = { "Returns true if the entry door of the house's exterior is currently being hovered" }, + + Returns = + { + { Name = "isHouseExteriorDoorHovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHoveringDecor", + Type = "Function", + Documentation = { "Returns true if a placed decor instance is currently being hovered" }, + + Returns = + { + { Name = "isHoveringDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHoveringRoomComponent", + Type = "Function", + Documentation = { "Returns true if a room component is currently being hovered" }, + + Returns = + { + { Name = "isHovering", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRoomComponentSelected", + Type = "Function", + Documentation = { "Returns true if a room component is currently selected for customization" }, + + Returns = + { + { Name = "hasSelectedComponent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RoomComponentSupportsVariant", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Check whether a specific room component supports a particular variant; What kind of id or enum 'variant' equates to is complicated, as it depends on the component type" }, + + Arguments = + { + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "variant", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "variantSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRoomComponentCeilingType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to set a specific ceiling component, within a specific room, to a specific new ceiling type" }, + + Arguments = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "ceilingType", Type = "HousingRoomComponentCeilingType", Nilable = false }, + }, + }, + { + Name = "SetRoomComponentDoorType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to set a specific door component, within a specific room, to a specific new door type" }, + + Arguments = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "newDoortype", Type = "HousingRoomComponentDoorType", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HousingCustomizeModeHoveredTargetChanged", + Type = "Event", + LiteralName = "HOUSING_CUSTOMIZE_MODE_HOVERED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasHoveredTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingCustomizeModeTargetType", Nilable = false }, + }, + }, + { + Name = "HousingCustomizeModeSelectedTargetChanged", + Type = "Event", + LiteralName = "HOUSING_CUSTOMIZE_MODE_SELECTED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasSelectedTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingCustomizeModeTargetType", Nilable = false }, + }, + }, + { + Name = "HousingDecorCustomizationChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_CUSTOMIZATION_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "HousingDecorDyeFailure", + Type = "Event", + LiteralName = "HOUSING_DECOR_DYE_FAILURE", + SynchronousEvent = true, + Payload = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "housingResult", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingRoomComponentCustomizationChangeFailed", + Type = "Event", + LiteralName = "HOUSING_ROOM_COMPONENT_CUSTOMIZATION_CHANGE_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "housingResult", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingRoomComponentCustomizationChanged", + Type = "Event", + LiteralName = "HOUSING_ROOM_COMPONENT_CUSTOMIZATION_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "HousingCustomizeModeTargetType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "HousingCustomizeModeTargetType", EnumValue = 0 }, + { Name = "Decor", Type = "HousingCustomizeModeTargetType", EnumValue = 1 }, + { Name = "RoomComponent", Type = "HousingCustomizeModeTargetType", EnumValue = 2 }, + { Name = "ExteriorHouse", Type = "HousingCustomizeModeTargetType", EnumValue = 3 }, + }, + }, + { + Name = "HousingRoomComponentInstanceInfo", + Type = "Structure", + Fields = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "type", Type = "HousingRoomComponentType", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "canBeCustomized", Type = "bool", Nilable = false }, + { Name = "currentThemeSet", Type = "number", Nilable = true }, + { Name = "availableThemeSets", Type = "table", InnerType = "number", Nilable = false }, + { Name = "currentWallpaper", Type = "number", Nilable = true }, + { Name = "currentRoomComponentTextureRecID", Type = "number", Nilable = true }, + { Name = "ceilingType", Type = "HousingRoomComponentCeilingType", Nilable = false }, + { Name = "doorType", Type = "HousingRoomComponentDoorType", Nilable = false }, + }, + }, + { + Name = "PreviewDyeSlotInfo", + Type = "Structure", + Fields = + { + { Name = "dyeColorID", Type = "number", Nilable = false }, + { Name = "dyeSlotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RoomComponentWallpaper", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "roomComponentTextureRecID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingCustomizeModeUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c65b213 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorSharedDocumentation.lua.annotated.lua @@ -0,0 +1,56 @@ +local HousingDecorShared = +{ + Tables = + { + { + Name = "HousingDecorPlacementRestriction", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 32, + Fields = + { + { Name = "TooFarAway", Type = "HousingDecorPlacementRestriction", EnumValue = 1 }, + { Name = "OutsideRoomBounds", Type = "HousingDecorPlacementRestriction", EnumValue = 2 }, + { Name = "OutsidePlotBounds", Type = "HousingDecorPlacementRestriction", EnumValue = 4 }, + { Name = "ChildOutsideBounds", Type = "HousingDecorPlacementRestriction", EnumValue = 8 }, + { Name = "InvalidTarget", Type = "HousingDecorPlacementRestriction", EnumValue = 16 }, + { Name = "InvalidCollision", Type = "HousingDecorPlacementRestriction", EnumValue = 32 }, + }, + }, + { + Name = "HousingDecorDyeSlot", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "dyeColorCategoryID", Type = "number", Nilable = false, Documentation = { "What category of dye colors this slot is for; This currently has no functional useage as slots accept colors of any category, but may be used for things like labeling in the future" } }, + { Name = "orderIndex", Type = "number", Nilable = false, Documentation = { "Display sort order" } }, + { Name = "channel", Type = "number", Nilable = false, Documentation = { "The specific shader channel that this slot affects when a dye color is applied" } }, + { Name = "dyeColorID", Type = "number", Nilable = true, Documentation = { "What dye color (if any) is currently applied to this slot" } }, + }, + }, + { + Name = "HousingDecorInstanceInfo", + Type = "Structure", + Documentation = { "Info for an instance of Housing Decor that has been/is being placed within a House or its exterior Plot" }, + Fields = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "decorID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false, Documentation = { "True if this decor is already being edited by someone else" } }, + { Name = "canBeCustomized", Type = "bool", Nilable = false, Documentation = { "True if this decor can be customized, namely by applying Dyes" } }, + { Name = "canBeRemoved", Type = "bool", Nilable = false, Documentation = { "False if this decor must remain placed in the house and cannot be placed back into house chest storage" } }, + { Name = "isAllowedOutdoors", Type = "bool", Nilable = false }, + { Name = "isAllowedIndoors", Type = "bool", Nilable = false }, + { Name = "isRefundable", Type = "bool", Nilable = false }, + { Name = "dyeSlots", Type = "table", InnerType = "HousingDecorDyeSlot", Nilable = false, Documentation = { "Empty for decor that can't be dyed (see canBeCustomized)" } }, + { Name = "dataTagsByID", Type = "LuaValueVariant", Nilable = false, Documentation = { "Simple localized 'tag' strings that are primarily used for things like categorization and filtering" } }, + { Name = "size", Type = "HousingCatalogEntrySize", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingDecorShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..29e0807 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingDecorUIDocumentation.lua.annotated.lua @@ -0,0 +1,399 @@ +local HousingDecorUI = +{ + Name = "HousingDecorUI", + Type = "System", + Namespace = "C_HousingDecor", + Environment = "All", + + Functions = + { + { + Name = "CancelActiveEditing", + Type = "Function", + Documentation = { "Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target" }, + }, + { + Name = "CommitDecorMovement", + Type = "Function", + Documentation = { "Attempt to save the changes made to the currently selected decor instance" }, + }, + { + Name = "EnterPreviewState", + Type = "Function", + }, + { + Name = "ExitPreviewState", + Type = "Function", + }, + { + Name = "GetAllPlacedDecor", + Type = "Function", + HasRestrictions = true, + Documentation = { "Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future" }, + + Returns = + { + { Name = "placedDecor", Type = "table", InnerType = "HousingDecorInstanceListEntry", Nilable = false }, + }, + }, + { + Name = "GetDecorIcon", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetDecorInstanceInfoForGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns info for the placed decor instance associated with the passed Decor GUID, if there is one" }, + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetDecorName", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "decorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetHoveredDecorInfo", + Type = "Function", + Documentation = { "Returns info for the placed decor instance currently being hovered, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetMaxPlacementBudget", + Type = "Function", + Documentation = { "Returns the max decor placement budget for the current house interior or plot; Can be increased via house level" }, + + Returns = + { + { Name = "maxBudget", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumDecorPlaced", + Type = "Function", + Documentation = { "Returns the number of individual decor objects placed in the current house or plot; This is NOT the value used in placement budget calculations, see GetSpentPlacementBudget for that" }, + + Returns = + { + { Name = "numPlaced", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumPreviewDecor", + Type = "Function", + + Returns = + { + { Name = "numDecor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedDecorInfo", + Type = "Function", + Documentation = { "Returns info for the placed decor instance that's currently selected, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetSpentPlacementBudget", + Type = "Function", + Documentation = { "Returns how much of the current house interior or plot's decor placement budget has been spent; Different kinds of decor take up different budget amounts, so this value isn't an individual decor count, see GetNumDecorPlaced for that" }, + + Returns = + { + { Name = "totalCost", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasMaxPlacementBudget", + Type = "Function", + Documentation = { "Returns whether there's a max decor placement budget available and active for the current player, in the current house interior or plot" }, + + Returns = + { + { Name = "hasMaxBudget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDecorSelected", + Type = "Function", + Documentation = { "Returns true if a placed decor instance is currently selected" }, + + Returns = + { + { Name = "hasSelectedDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGridVisible", + Type = "Function", + + Returns = + { + { Name = "gridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorDoorHovered", + Type = "Function", + Documentation = { "Returns true if the entry door of the house's exterior is currently being hovered" }, + + Returns = + { + { Name = "isHouseExteriorDoorHovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorHovered", + Type = "Function", + Documentation = { "Returns true if the house's exterior is currently being hovered" }, + + Returns = + { + { Name = "isHouseExteriorHovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHoveringDecor", + Type = "Function", + Documentation = { "Returns true if a placed decor instance is currently being hovered" }, + + Returns = + { + { Name = "isHoveringDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsModeDisabledForPreviewState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mode", Type = "HouseEditorMode", Nilable = false }, + }, + + Returns = + { + { Name = "isModeDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPreviewState", + Type = "Function", + + Returns = + { + { Name = "isPreviewState", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemovePlacedDecorEntry", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future" }, + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RemoveSelectedDecor", + Type = "Function", + Documentation = { "Attempt to return the currently selected decor instance back to the house chest" }, + }, + { + Name = "SetGridVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPlacedDecorEntryHovered", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future" }, + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "hovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPlacedDecorEntrySelected", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Placed Decor List APIs currently restricted due to being potentially very expensive operations, may be reworked & opened up in the future" }, + + Arguments = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "selected", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HouseDecorAddedToChest", + Type = "Event", + LiteralName = "HOUSE_DECOR_ADDED_TO_CHEST", + SynchronousEvent = true, + Payload = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "decorID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HouseExteriorPositionFailure", + Type = "Event", + LiteralName = "HOUSE_EXTERIOR_POSITION_FAILURE", + SynchronousEvent = true, + Payload = + { + { Name = "housingResult", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HouseExteriorPositionSuccess", + Type = "Event", + LiteralName = "HOUSE_EXTERIOR_POSITION_SUCCESS", + SynchronousEvent = true, + }, + { + Name = "HousingDecorGridVisibilityStatusChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_GRID_VISIBILITY_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isGridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingDecorPlaceFailure", + Type = "Event", + LiteralName = "HOUSING_DECOR_PLACE_FAILURE", + SynchronousEvent = true, + Payload = + { + { Name = "housingResult", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingDecorPlaceSuccess", + Type = "Event", + LiteralName = "HOUSING_DECOR_PLACE_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "size", Type = "HousingCatalogEntrySize", Nilable = false }, + { Name = "isNew", Type = "bool", Nilable = false, Documentation = { "Will be true if the decor is newly placed from storage, false if it was already placed and just moved" } }, + { Name = "isPreview", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingDecorPreviewStateChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_PREVIEW_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isPreviewState", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingDecorRemoved", + Type = "Event", + LiteralName = "HOUSING_DECOR_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "HousingDecorSelectResponse", + Type = "Event", + LiteralName = "HOUSING_DECOR_SELECT_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingNumDecorPlacedChanged", + Type = "Event", + LiteralName = "HOUSING_NUM_DECOR_PLACED_CHANGED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "HousingDecorInstanceListEntry", + Type = "Structure", + Documentation = { "Smaller structs with the minimum fields from HousingDecorInstanceInfo needed to identify/display a slim list of placed decor" }, + Fields = + { + { Name = "decorGUID", Type = "WOWGUID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingDecorUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c3d1b29 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingExpertModeUIDocumentation.lua.annotated.lua @@ -0,0 +1,308 @@ +local HousingExpertModeUI = +{ + Name = "HousingExpertModeUI", + Type = "System", + Namespace = "C_HousingExpertMode", + Environment = "All", + + Functions = + { + { + Name = "CancelActiveEditing", + Type = "Function", + Documentation = { "Cancels all in-progress editing of the selected target, which will reset any unsaved changes and deselect the active target; Will not reset any already-applied changes" }, + }, + { + Name = "CommitDecorMovement", + Type = "Function", + Documentation = { "Attempt to save the changes made to the currently selected decor instance" }, + }, + { + Name = "CommitHouseExteriorPosition", + Type = "Function", + Documentation = { "Attempt to save the changes made to the House Exterior's position within the plot" }, + }, + { + Name = "GetHoveredDecorInfo", + Type = "Function", + Documentation = { "Returns info for the placed decor instance currently being hovered, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "GetPrecisionSubmode", + Type = "Function", + Documentation = { "Returns the currently active Expert submode, if there is one" }, + + Returns = + { + { Name = "activeSubMode", Type = "HousingPrecisionSubmode", Nilable = true }, + }, + }, + { + Name = "GetPrecisionSubmodeRestriction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the type of restriction currently active on the submode; Will return HousingExpertSubmodeRestriction:None if submode is not currently restricted" }, + + Arguments = + { + { Name = "subMode", Type = "HousingPrecisionSubmode", Nilable = false }, + }, + + Returns = + { + { Name = "restriction", Type = "HousingExpertSubmodeRestriction", Nilable = false }, + }, + }, + { + Name = "GetSelectedDecorInfo", + Type = "Function", + Documentation = { "Returns info for the placed decor instance that's currently selected, if there is one" }, + + Returns = + { + { Name = "info", Type = "HousingDecorInstanceInfo", Nilable = true }, + }, + }, + { + Name = "IsDecorSelected", + Type = "Function", + Documentation = { "Returns true if a placed decor instance is currently selected" }, + + Returns = + { + { Name = "hasSelectedDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGridVisible", + Type = "Function", + + Returns = + { + { Name = "gridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorHovered", + Type = "Function", + Documentation = { "Returns true if the house's exterior is currently being hovered" }, + + Returns = + { + { Name = "isHouseExteriorHovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHouseExteriorSelected", + Type = "Function", + Documentation = { "Returns true if the house's exterior is currently selected" }, + + Returns = + { + { Name = "isHouseExteriorSelected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHoveringDecor", + Type = "Function", + Documentation = { "Returns true if a placed decor instance is currently being hovered" }, + + Returns = + { + { Name = "isHoveringDecor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveSelectedDecor", + Type = "Function", + Documentation = { "Attempt to return the currently selected decor instance back to the house chest" }, + }, + { + Name = "ResetPrecisionChanges", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Reset the selected target's transform back to default values; This is NOT an undo, meaning it will completely reset the transform value to default, NOT just recently-made changes" }, + + Arguments = + { + { Name = "activeSubmodeOnly", Type = "bool", Nilable = false, Documentation = { "If true, only transform values associated with the currently active submode with be reset (ex: in Scale submode, only target's scale will be reset); If false, all transform values will be reset" } }, + }, + }, + { + Name = "SelectNextRotationAxis", + Type = "Function", + Documentation = { "In the rotation submode, swaps the selected axis to the next available one, in order of X -> Y -> Z (wrapping back around to X again, etc); If no axis is selected, selects the first available one, also in that order" }, + }, + { + Name = "SetGridVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gridVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPrecisionIncrementingActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Sets a specific type of incremental change active or inactive; Whilever that type is active and target stays selected, incremental changes of that type will continue to be made every frame" }, + + Arguments = + { + { Name = "incrementType", Type = "HousingIncrementType", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPrecisionSubmode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Activate a specific Expert submode" }, + + Arguments = + { + { Name = "subMode", Type = "HousingPrecisionSubmode", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HousingDecorPrecisionManipulationEvent", + Type = "Event", + LiteralName = "HOUSING_DECOR_PRECISION_MANIPULATION_EVENT", + SynchronousEvent = true, + Payload = + { + { Name = "event", Type = "TransformManipulatorEvent", Nilable = false }, + }, + }, + { + Name = "HousingDecorPrecisionManipulationStatusChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_PRECISION_MANIPULATION_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isManipulatingSelection", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingDecorPrecisionSubmodeChanged", + Type = "Event", + LiteralName = "HOUSING_DECOR_PRECISION_SUBMODE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "activeSubmode", Type = "HousingPrecisionSubmode", Nilable = true }, + }, + }, + { + Name = "HousingExpertModeHoveredTargetChanged", + Type = "Event", + LiteralName = "HOUSING_EXPERT_MODE_HOVERED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasHoveredTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingExpertModeTargetType", Nilable = false }, + }, + }, + { + Name = "HousingExpertModePlacementFlagsUpdated", + Type = "Event", + LiteralName = "HOUSING_EXPERT_MODE_PLACEMENT_FLAGS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "targetType", Type = "HousingExpertModeTargetType", Nilable = false }, + { Name = "activeFlags", Type = "HousingDecorPlacementRestriction", Nilable = false }, + }, + }, + { + Name = "HousingExpertModeSelectedTargetChanged", + Type = "Event", + LiteralName = "HOUSING_EXPERT_MODE_SELECTED_TARGET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "hasSelectedTarget", Type = "bool", Nilable = false }, + { Name = "targetType", Type = "HousingExpertModeTargetType", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "HousingExpertModeTargetType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "HousingExpertModeTargetType", EnumValue = 0 }, + { Name = "Decor", Type = "HousingExpertModeTargetType", EnumValue = 1 }, + { Name = "House", Type = "HousingExpertModeTargetType", EnumValue = 2 }, + }, + }, + { + Name = "HousingExpertSubmodeRestriction", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "HousingExpertSubmodeRestriction", EnumValue = 0 }, + { Name = "NotInExpertMode", Type = "HousingExpertSubmodeRestriction", EnumValue = 1 }, + { Name = "NoHouseExteriorScale", Type = "HousingExpertSubmodeRestriction", EnumValue = 2 }, + { Name = "NoWMOScale", Type = "HousingExpertSubmodeRestriction", EnumValue = 3 }, + }, + }, + { + Name = "HousingIncrementType", + Type = "Enumeration", + NumValues = 10, + MinValue = 1, + MaxValue = 512, + Fields = + { + { Name = "Left", Type = "HousingIncrementType", EnumValue = 1 }, + { Name = "Right", Type = "HousingIncrementType", EnumValue = 2 }, + { Name = "Forward", Type = "HousingIncrementType", EnumValue = 4 }, + { Name = "Back", Type = "HousingIncrementType", EnumValue = 8 }, + { Name = "Up", Type = "HousingIncrementType", EnumValue = 16 }, + { Name = "Down", Type = "HousingIncrementType", EnumValue = 32 }, + { Name = "RotateLeft", Type = "HousingIncrementType", EnumValue = 64 }, + { Name = "RotateRight", Type = "HousingIncrementType", EnumValue = 128 }, + { Name = "ScaleUp", Type = "HousingIncrementType", EnumValue = 256 }, + { Name = "ScaleDown", Type = "HousingIncrementType", EnumValue = 512 }, + }, + }, + { + Name = "HousingPrecisionSubmode", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Translate", Type = "HousingPrecisionSubmode", EnumValue = 0 }, + { Name = "Rotate", Type = "HousingPrecisionSubmode", EnumValue = 1 }, + { Name = "Scale", Type = "HousingPrecisionSubmode", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingExpertModeUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingFixturePointFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingFixturePointFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..971be32 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingFixturePointFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,81 @@ +local HousingFixturePointFrameAPI = +{ + Name = "HousingFixturePointFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "HasAttachedFixture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hasAttachedFixture", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSelected", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isSelected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValid", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Select", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetUpdateCallback", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "FixturePointUpdatedCallback", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "FixturePointUpdatedCallback", + Type = "CallbackType", + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingFixturePointFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutPinFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutPinFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8d65977 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutPinFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,207 @@ +local HousingLayoutPinFrameAPI = +{ + Name = "HousingLayoutPinFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CanMove", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "moveRestriction", Type = "HousingLayoutRestriction", Nilable = false }, + }, + }, + { + Name = "CanRemove", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "removalRestriction", Type = "HousingLayoutRestriction", Nilable = false }, + }, + }, + { + Name = "CanRotate", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "rotateRestriction", Type = "HousingLayoutRestriction", Nilable = false }, + }, + }, + { + Name = "Drag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isAccessible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDoorConnectionInfo", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "connectionInfo", Type = "DoorConnectionInfo", Nilable = true }, + }, + }, + { + Name = "GetPinType", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "type", Type = "HousingLayoutPinType", Nilable = false }, + }, + }, + { + Name = "GetRoomGUID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetRoomName", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "IsAnyPartOfRoomSelected", + Type = "Function", + Documentation = { "Returns true if this pin's associated room, or anything attached to it, is selected. Ex: If pin is for a door, returns true if its room, or any other doors on that room, are selected" }, + + Arguments = + { + }, + + Returns = + { + { Name = "isSelected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOccupiedDoor", + Type = "Function", + Documentation = { "Will be nil if pin is not a Door" }, + + Arguments = + { + }, + + Returns = + { + { Name = "isOccupied", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsSelected", + Type = "Function", + Documentation = { "Returns true if this pin's object is itself selected; See IsAnyPartOfRoomSelected for a broader Selected check" }, + + Arguments = + { + }, + + Returns = + { + { Name = "isSelected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValid", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidForSelectedFloorplan", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Select", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetUpdateCallback", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PinUpdatedCallback", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(HousingLayoutPinFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ffbf681 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUIDocumentation.lua.annotated.lua @@ -0,0 +1,527 @@ +local HousingLayoutUI = +{ + Name = "HousingLayoutUI", + Type = "System", + Namespace = "C_HousingLayout", + Environment = "All", + + Functions = + { + { + Name = "AnyRoomsOnFloor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "floor", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "anyRooms", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelActiveLayoutEditing", + Type = "Function", + }, + { + Name = "ConfirmStairChoice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "choice", Type = "HousingLayoutStairDirection", Nilable = true, Documentation = { "If not set, the pending stair operation will be cancelled" } }, + }, + }, + { + Name = "DeselectFloorplan", + Type = "Function", + }, + { + Name = "DeselectRoomOrDoor", + Type = "Function", + }, + { + Name = "GetNumActiveRooms", + Type = "Function", + + Returns = + { + { Name = "numRooms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumFloors", + Type = "Function", + + Returns = + { + { Name = "numFloors", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRoomPlacementBudget", + Type = "Function", + Documentation = { "Returns the max room placement budget for the current house interior; Can be increased via house level" }, + + Returns = + { + { Name = "placementBudget", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedDoor", + Type = "Function", + MayReturnNothing = true, + Documentation = { "If a door is selected, returns its component id and the guid of the room it belongs to; Otherwise returns nothing" }, + + Returns = + { + { Name = "selectedDoorComponentID", Type = "number", Nilable = false }, + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetSelectedFloorplan", + Type = "Function", + + Returns = + { + { Name = "roomID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSelectedRoom", + Type = "Function", + MayReturnNothing = true, + Documentation = { "If a Room is selected, returns the room's guid; Otherwise returns nothing" }, + + Returns = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetSelectedStairwellRoomCount", + Type = "Function", + + Returns = + { + { Name = "stairwellRoomCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpentPlacementBudget", + Type = "Function", + Documentation = { "Returns how much of the current house's room placement budget has been spent; Different kinds of rooms take up different budget amounts, so this value isn't an individual room count, see GetNumActiveRooms for that" }, + + Returns = + { + { Name = "spentPlacementBudget", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetViewedFloor", + Type = "Function", + + Returns = + { + { Name = "floor", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasAnySelections", + Type = "Function", + Documentation = { "Returns true if any room, door, or floorplan is currently selected or being dragged" }, + + Returns = + { + { Name = "hasAnySelections", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasRoomPlacementBudget", + Type = "Function", + Documentation = { "Returns whether there's a max room placement budget available and active for the current player, in the current house interior" }, + + Returns = + { + { Name = "hasBudget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSelectedDoor", + Type = "Function", + Documentation = { "Returns true if a door component is currently selected" }, + + Returns = + { + { Name = "hasSelectedDoor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSelectedFloorplan", + Type = "Function", + + Returns = + { + { Name = "hasSelectedFloorplan", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSelectedRoom", + Type = "Function", + Documentation = { "Returns true if a room is selected, will NOT return true if a door is selected" }, + + Returns = + { + { Name = "hasSelectedRoom", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasStairs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roomRecordID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasStairs", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasValidConnection", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "roomId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canPlace", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBaseRoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isBaseRoom", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDraggingRoom", + Type = "Function", + + Returns = + { + { Name = "isDragging", Type = "bool", Nilable = false }, + { Name = "isAccessibleDrag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MoveDraggedRoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to move the room currently being dragged to a specific connection point on a specific other room" }, + + Arguments = + { + { Name = "sourceDoorIndex", Type = "number", Nilable = false }, + { Name = "destRoom", Type = "WOWGUID", Nilable = false }, + { Name = "destDoorIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "MoveLayoutCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "direction", Type = "HousingLayoutCameraDirection", Nilable = false }, + { Name = "isPressed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveRoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to return a previously placed room to the House Chest" }, + + Arguments = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RotateFocusedRoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Rotates either the currently dragged or currently selected room, if either exist" }, + + Arguments = + { + { Name = "isLeft", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RotateRoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to rotate an already placed room" }, + + Arguments = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "isLeft", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SelectFloorplan", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roomID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetViewedFloor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "floor", Type = "number", Nilable = false }, + }, + }, + { + Name = "StartDrag", + Type = "Function", + }, + { + Name = "StopDrag", + Type = "Function", + }, + { + Name = "StopDraggingRoom", + Type = "Function", + }, + { + Name = "ZoomLayoutCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomIn", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "zoomChanged", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HousingLayoutDoorSelected", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_DOOR_SELECTED", + SynchronousEvent = true, + Documentation = { "Fired when one of the door nodes of an already placed room has been selected" }, + Payload = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingLayoutDoorSelectionChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_DOOR_SELECTION_CHANGED", + SynchronousEvent = true, + Documentation = { "Fired when one of the door nodes of an already placed room has been selected or deselected" }, + Payload = + { + { Name = "hasSelection", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingLayoutDragTargetChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_DRAG_TARGET_CHANGED", + SynchronousEvent = true, + Documentation = { "Fired when an already placed room has either started or stopped being dragged" }, + Payload = + { + { Name = "isDraggingRoom", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingLayoutFloorplanSelectionChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_FLOORPLAN_SELECTION_CHANGED", + SynchronousEvent = true, + Documentation = { "Fired when a room option in the House Chest has been selected or deselected" }, + Payload = + { + { Name = "hasSelection", Type = "bool", Nilable = false }, + { Name = "roomID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingLayoutNumFloorsChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_NUM_FLOORS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "prevNumFloors", Type = "number", Nilable = false }, + { Name = "numFloors", Type = "number", Nilable = false }, + }, + }, + { + Name = "HousingLayoutPinFrameAdded", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_PIN_FRAME_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "pinFrame", Type = "HousingLayoutPinFrame", Nilable = false }, + }, + }, + { + Name = "HousingLayoutPinFrameReleased", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_PIN_FRAME_RELEASED", + SynchronousEvent = true, + Payload = + { + { Name = "pinFrame", Type = "HousingLayoutPinFrame", Nilable = false }, + }, + }, + { + Name = "HousingLayoutPinFramesReleased", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_PIN_FRAMES_RELEASED", + SynchronousEvent = true, + }, + { + Name = "HousingLayoutRoomComponentThemeSetChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_COMPONENT_THEME_SET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "roomGUID", Type = "WOWGUID", Nilable = false }, + { Name = "componentID", Type = "number", Nilable = false }, + { Name = "newThemeSet", Type = "number", Nilable = false }, + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingLayoutRoomMoveInvalid", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_MOVE_INVALID", + SynchronousEvent = true, + }, + { + Name = "HousingLayoutRoomMoved", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_MOVED", + SynchronousEvent = true, + Documentation = { "Fired when a previously placed room has been moved to a different position or rotation" }, + }, + { + Name = "HousingLayoutRoomReceived", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_RECEIVED", + SynchronousEvent = true, + Documentation = { "Fired when info for a newly placed room has been recieved while in Layout Mode" }, + Payload = + { + { Name = "prevNumFloors", Type = "number", Nilable = false }, + { Name = "currNumFloors", Type = "number", Nilable = false }, + { Name = "isUpstairs", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingLayoutRoomRemoved", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_REMOVED", + SynchronousEvent = true, + Documentation = { "Fired when a previously placed room has been removed while in Layout Mode" }, + }, + { + Name = "HousingLayoutRoomReturned", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_RETURNED", + SynchronousEvent = true, + Documentation = { "Fired when a room that was being dragged is let go of without being placed, and is returned to the House Chest" }, + }, + { + Name = "HousingLayoutRoomSelectionChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_SELECTION_CHANGED", + SynchronousEvent = true, + Documentation = { "Fired when an already placed room has been selected or deselected" }, + Payload = + { + { Name = "hasSelection", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HousingLayoutRoomSnapped", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_ROOM_SNAPPED", + SynchronousEvent = true, + Documentation = { "Fired when a room being dragged has been snapped to a particular door connection" }, + }, + { + Name = "HousingLayoutViewedFloorChanged", + Type = "Event", + LiteralName = "HOUSING_LAYOUT_VIEWED_FLOOR_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "floor", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowStairDirectionConfirmation", + Type = "Event", + LiteralName = "SHOW_STAIR_DIRECTION_CONFIRMATION", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(HousingLayoutUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..651d699 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingLayoutUITypesDocumentation.lua.annotated.lua @@ -0,0 +1,72 @@ +local HousingLayoutUITypes = +{ + Tables = + { + { + Name = "HousingLayoutCameraDirection", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "HousingLayoutCameraDirection", EnumValue = 0 }, + { Name = "Up", Type = "HousingLayoutCameraDirection", EnumValue = 1 }, + { Name = "Down", Type = "HousingLayoutCameraDirection", EnumValue = 2 }, + { Name = "Left", Type = "HousingLayoutCameraDirection", EnumValue = 4 }, + { Name = "Right", Type = "HousingLayoutCameraDirection", EnumValue = 8 }, + }, + }, + { + Name = "HousingLayoutPinType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Door", Type = "HousingLayoutPinType", EnumValue = 0 }, + { Name = "Room", Type = "HousingLayoutPinType", EnumValue = 1 }, + }, + }, + { + Name = "HousingLayoutStairDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Up", Type = "HousingLayoutStairDirection", EnumValue = 0 }, + { Name = "Down", Type = "HousingLayoutStairDirection", EnumValue = 1 }, + }, + }, + { + Name = "DoorConnectionInfo", + Type = "Structure", + Fields = + { + { Name = "doorID", Type = "number", Nilable = false }, + { Name = "connectionType", Type = "HousingRoomComponentType", Nilable = false }, + { Name = "doorFacing", Type = "number", Nilable = false }, + }, + }, + { + Name = "RoomOptionInfo", + Type = "Structure", + Fields = + { + { Name = "roomName", Type = "cstring", Nilable = false }, + { Name = "roomID", Type = "number", Nilable = false }, + { Name = "learned", Type = "bool", Nilable = false }, + { Name = "numOwned", Type = "number", Nilable = false }, + }, + }, + { + Name = "PinUpdatedCallback", + Type = "CallbackType", + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingLayoutUITypes); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..88d32df --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingNeighborhoodUIDocumentation.lua.annotated.lua @@ -0,0 +1,416 @@ +local HousingNeighborhoodUI = +{ + Name = "HousingNeighborhoodUI", + Type = "System", + Namespace = "C_HousingNeighborhood", + Environment = "All", + + Functions = + { + { + Name = "CanReturnAfterVisitingHouse", + Type = "Function", + + Returns = + { + { Name = "canReturn", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelInviteToNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only available when interacting with a bulletin board game object" }, + + Arguments = + { + { Name = "playerName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "DemoteToResident", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only available when interacting with a bulletin board game object" }, + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetCornerstoneHouseInfo", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "houseInfo", Type = "HouseInfo", Nilable = false }, + }, + }, + { + Name = "GetCornerstoneNeighborhoodInfo", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "neighborhoodInfo", Type = "NeighborhoodInfo", Nilable = false }, + }, + }, + { + Name = "GetCornerstonePurchaseMode", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "purchaseMode", Type = "CornerstonePurchaseMode", Nilable = false }, + }, + }, + { + Name = "GetCurrentNeighborhoodTextureSuffix", + Type = "Function", + + Returns = + { + { Name = "neighborhoodTextureSuffix", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetDiscountedMovePrice", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "movePrice", Type = "number", Nilable = false, Documentation = { "Can be negative if the refund from moving is more than the cost of the new house" } }, + }, + }, + { + Name = "GetMoveCooldownTime", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "movecooldownTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNeighborhoodMapData", + Type = "Function", + + Returns = + { + { Name = "neighborhoodPlots", Type = "table", InnerType = "NeighborhoodPlotMapInfo", Nilable = false }, + }, + }, + { + Name = "GetNeighborhoodName", + Type = "Function", + + Returns = + { + { Name = "neighborhoodName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNeighborhoodPlotName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "plotIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "neighborhoodName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPreviousHouseIdentifier", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "previousHouseIdentifier", Type = "string", Nilable = false }, + }, + }, + { + Name = "HasPermissionToPurchase", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "cantPurchaseReason", Type = "PurchaseHouseDisabledReason", Nilable = false }, + }, + }, + { + Name = "InvitePlayerToNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only available when interacting with a bulletin board game object" }, + + Arguments = + { + { Name = "playerName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsNeighborhoodManager", + Type = "Function", + + Returns = + { + { Name = "isManager", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNeighborhoodOwner", + Type = "Function", + + Returns = + { + { Name = "isOwner", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInOtherPlayersPlot", + Type = "Function", + Documentation = { "This returns true if the player is in a plot that is owned by another player" }, + + Returns = + { + { Name = "isInUnownedPlot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlotAvailableForPurchase", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlotOwnedByPlayer", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + + Returns = + { + { Name = "isPlayerOwned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnBulletinBoardClosed", + Type = "Function", + }, + { + Name = "PromoteToManager", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only available when interacting with a bulletin board game object" }, + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RequestNeighborhoodInfo", + Type = "Function", + }, + { + Name = "RequestNeighborhoodRoster", + Type = "Function", + Documentation = { "Only available when interacting with a bulletin board game object" }, + }, + { + Name = "RequestPendingNeighborhoodInvites", + Type = "Function", + Documentation = { "Only available when interacting with a bulletin board game object" }, + }, + { + Name = "TransferNeighborhoodOwnership", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only available when interacting with a bulletin board game object" }, + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "TryEvictPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only available when interacting with a bulletin board game object" }, + + Arguments = + { + { Name = "plotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TryMoveHouse", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + }, + { + Name = "TryPurchasePlot", + Type = "Function", + Documentation = { "Only available when interacting with a cornerstone game object" }, + }, + }, + + Events = + { + { + Name = "CancelNeighborhoodInviteResponse", + Type = "Event", + LiteralName = "CANCEL_NEIGHBORHOOD_INVITE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "NeighborhoodInviteResult", Nilable = false }, + { Name = "playerName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "ClosePlotCornerstone", + Type = "Event", + LiteralName = "CLOSE_PLOT_CORNERSTONE", + SynchronousEvent = true, + }, + { + Name = "NeighborhoodInfoUpdated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodInfo", Type = "NeighborhoodInfo", Nilable = false }, + }, + }, + { + Name = "NeighborhoodInviteResponse", + Type = "Event", + LiteralName = "NEIGHBORHOOD_INVITE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "NeighborhoodInviteResult", Nilable = false }, + }, + }, + { + Name = "NeighborhoodMapDataUpdated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_MAP_DATA_UPDATED", + UniqueEvent = true, + }, + { + Name = "NeighborhoodNameUpdated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_NAME_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "neighborhoodGuid", Type = "WOWGUID", Nilable = false }, + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "OpenPlotCornerstone", + Type = "Event", + LiteralName = "OPEN_PLOT_CORNERSTONE", + SynchronousEvent = true, + }, + { + Name = "PendingNeighborhoodInvitesRecieved", + Type = "Event", + LiteralName = "PENDING_NEIGHBORHOOD_INVITES_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "NeighborhoodInviteResult", Nilable = false }, + { Name = "pendingInviteList", Type = "table", InnerType = "string", Nilable = true }, + }, + }, + { + Name = "PurchasePlotResult", + Type = "Event", + LiteralName = "PURCHASE_PLOT_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowPlayerEvictedDialog", + Type = "Event", + LiteralName = "SHOW_PLAYER_EVICTED_DIALOG", + SynchronousEvent = true, + }, + { + Name = "UpdateBulletinBoardMemberType", + Type = "Event", + LiteralName = "UPDATE_BULLETIN_BOARD_MEMBER_TYPE", + SynchronousEvent = true, + Payload = + { + { Name = "player", Type = "WOWGUID", Nilable = false }, + { Name = "residentType", Type = "ResidentType", Nilable = false }, + }, + }, + { + Name = "UpdateBulletinBoardRoster", + Type = "Event", + LiteralName = "UPDATE_BULLETIN_BOARD_ROSTER", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodInfo", Type = "NeighborhoodInfo", Nilable = false }, + { Name = "rosterMemberList", Type = "table", InnerType = "NeighborhoodRosterMemberInfo", Nilable = false }, + }, + }, + { + Name = "UpdateBulletinBoardRosterStatuses", + Type = "Event", + LiteralName = "UPDATE_BULLETIN_BOARD_ROSTER_STATUSES", + SynchronousEvent = true, + Payload = + { + { Name = "rosterMemberList", Type = "table", InnerType = "NeighborhoodRosterMemberUpdateInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CornerstonePurchaseMode", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Basic", Type = "CornerstonePurchaseMode", EnumValue = 0 }, + { Name = "Import", Type = "CornerstonePurchaseMode", EnumValue = 1 }, + { Name = "Move", Type = "CornerstonePurchaseMode", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingNeighborhoodUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7222639 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingPhotoSharingUIDocumentation.lua.annotated.lua @@ -0,0 +1,142 @@ +local HousingPhotoSharingUI = +{ + Name = "HousingPhotoSharingUI", + Type = "System", + Namespace = "C_HousingPhotoSharing", + Environment = "All", + + Functions = + { + { + Name = "BeginAuthorizationFlow", + Type = "Function", + }, + { + Name = "ClearAuthorization", + Type = "Function", + }, + { + Name = "CompleteAuthorizationFlow", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "callbackURL", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCropRatio", + Type = "Function", + + Returns = + { + { Name = "cropRatio", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPhotoSharingAuthURL", + Type = "Function", + + Returns = + { + { Name = "authUrl", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsAuthorized", + Type = "Function", + + Returns = + { + { Name = "authorized", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetScreenshotPreviewTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "TakePhoto", + Type = "Function", + }, + { + Name = "UploadPhotoToService", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "optionalTitle", Type = "cstring", Nilable = false, Default = "" }, + { Name = "optionalDescription", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + }, + + Events = + { + { + Name = "PhotoSharingAuthorizationNeeded", + Type = "Event", + LiteralName = "PHOTO_SHARING_AUTHORIZATION_NEEDED", + SynchronousEvent = true, + }, + { + Name = "PhotoSharingAuthorizationUpdated", + Type = "Event", + LiteralName = "PHOTO_SHARING_AUTHORIZATION_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "showNotification", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PhotoSharingPhotoUploadStatus", + Type = "Event", + LiteralName = "PHOTO_SHARING_PHOTO_UPLOAD_STATUS", + SynchronousEvent = true, + Payload = + { + { Name = "uploadStatus", Type = "PhotoSharingUploadStatus", Nilable = false }, + }, + }, + { + Name = "PhotoSharingScreenshotReady", + Type = "Event", + LiteralName = "PHOTO_SHARING_SCREENSHOT_READY", + SynchronousEvent = true, + }, + { + Name = "PhotoSharingThirdPartyAuthorizationNeeded", + Type = "Event", + LiteralName = "PHOTO_SHARING_THIRD_PARTY_AUTHORIZATION_NEEDED", + SynchronousEvent = true, + Payload = + { + { Name = "authUrl", Type = "string", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(HousingPhotoSharingUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..be4a1ac --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUIDocumentation.lua.annotated.lua @@ -0,0 +1,895 @@ +local HousingUI = +{ + Name = "HousingUI", + Type = "System", + Namespace = "C_Housing", + Environment = "All", + + Functions = + { + { + Name = "AcceptNeighborhoodOwnership", + Type = "Function", + }, + { + Name = "CanEditCharter", + Type = "Function", + + Returns = + { + { Name = "canEditCharter", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanTakeReportScreenshot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "plotIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "reason", Type = "InvalidPlotScreenshotReason", Nilable = false }, + }, + }, + { + Name = "CreateGuildNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "CreateNeighborhoodCharter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "DeclineNeighborhoodOwnership", + Type = "Function", + }, + { + Name = "DoesFactionMatchNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "factionMatches", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EditNeighborhoodCharter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCurrentHouseInfo", + Type = "Function", + + Returns = + { + { Name = "houseInfo", Type = "HouseInfo", Nilable = true }, + }, + }, + { + Name = "GetCurrentHouseLevelFavor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "houseGuid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetCurrentHouseRefundAmount", + Type = "Function", + + Returns = + { + { Name = "refundAmount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentNeighborhoodGUID", + Type = "Function", + + Returns = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "GetHouseLevelFavorForLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "houseFavor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHouseLevelRewardsForLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHousingAccessFlags", + Type = "Function", + + Returns = + { + { Name = "accessFlags", Type = "HouseSettingFlags", Nilable = false }, + }, + }, + { + Name = "GetMaxHouseLevel", + Type = "Function", + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNeighborhoodTextureSuffix", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "neighborhoodTextureSuffix", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetOthersOwnedHouses", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = true }, + { Name = "bnetID", Type = "number", Nilable = true }, + { Name = "isInPlayersGuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerOwnedHouses", + Type = "Function", + }, + { + Name = "GetTrackedHouseGuid", + Type = "Function", + + Returns = + { + { Name = "trackedHouse", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "GetUIMapIDForNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGuid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetVisitCooldownInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "spellCooldownInfo", Type = "SpellCooldownInfo", Nilable = false }, + }, + }, + { + Name = "HasHousingExpansionAccess", + Type = "Function", + + Returns = + { + { Name = "hasAccess", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HouseFinderDeclineNeighborhoodInvitation", + Type = "Function", + }, + { + Name = "HouseFinderRequestNeighborhoods", + Type = "Function", + }, + { + Name = "HouseFinderRequestReservationAndPort", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGuid", Type = "WOWGUID", Nilable = false }, + { Name = "plotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsHousingMarketCartFullRemoveEnabled", + Type = "Function", + + Returns = + { + { Name = "isHousingMarketCartFullRemoveEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHousingMarketEnabled", + Type = "Function", + + Returns = + { + { Name = "isHousingMarketEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHousingMarketShopEnabled", + Type = "Function", + + Returns = + { + { Name = "isHousingMarketShopEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHousingServiceEnabled", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInsideHouse", + Type = "Function", + + Returns = + { + { Name = "isInside", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInsideHouseOrPlot", + Type = "Function", + + Returns = + { + { Name = "isInside", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInsideOwnHouse", + Type = "Function", + + Returns = + { + { Name = "isInsideOwnHouse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInsidePlot", + Type = "Function", + + Returns = + { + { Name = "isInside", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnNeighborhoodMap", + Type = "Function", + + Returns = + { + { Name = "isOnNeighborhoodMap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveHouse", + Type = "Function", + }, + { + Name = "OnCharterConfirmationAccepted", + Type = "Function", + }, + { + Name = "OnCharterConfirmationClosed", + Type = "Function", + }, + { + Name = "OnCreateCharterNeighborhoodClosed", + Type = "Function", + }, + { + Name = "OnCreateGuildNeighborhoodClosed", + Type = "Function", + }, + { + Name = "OnHouseFinderClickPlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "plotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "OnRequestSignatureClicked", + Type = "Function", + }, + { + Name = "OnSignCharterClicked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "charterOwnerGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RelinquishHouse", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "houseGuid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RequestCurrentHouseInfo", + Type = "Function", + }, + { + Name = "RequestHouseFinderNeighborhoodData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGuid", Type = "WOWGUID", Nilable = false }, + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RequestPlayerCharacterList", + Type = "Function", + }, + { + Name = "ReturnAfterVisitingHouse", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "SaveHouseSettings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "accessFlags", Type = "HouseSettingFlags", Nilable = false }, + }, + }, + { + Name = "SearchBNetFriendNeighborhoods", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bnetName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isValidBnetFriend", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SearchBNetFriendNeighborhoodsByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bnetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isValidBnetFriend", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTrackedHouseGuid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackedHouse", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "StartTutorial", + Type = "Function", + }, + { + Name = "TeleportHome", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + { Name = "houseGUID", Type = "WOWGUID", Nilable = false }, + { Name = "plotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TryRenameNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ValidateCreateGuildNeighborhoodSize", + Type = "Function", + }, + { + Name = "ValidateNeighborhoodName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "VisitHouse", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + { Name = "houseGUID", Type = "WOWGUID", Nilable = false }, + { Name = "plotID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AddNeighborhoodCharterSignature", + Type = "Event", + LiteralName = "ADD_NEIGHBORHOOD_CHARTER_SIGNATURE", + SynchronousEvent = true, + Payload = + { + { Name = "signature", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "BNetNeighborhoodListUpdated", + Type = "Event", + LiteralName = "B_NET_NEIGHBORHOOD_LIST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + { Name = "neighborhoodInfos", Type = "table", InnerType = "NeighborhoodInfo", Nilable = true }, + }, + }, + { + Name = "CloseCharterConfirmationUI", + Type = "Event", + LiteralName = "CLOSE_CHARTER_CONFIRMATION_UI", + SynchronousEvent = true, + }, + { + Name = "CloseCreateCharterNeighborhoodUI", + Type = "Event", + LiteralName = "CLOSE_CREATE_CHARTER_NEIGHBORHOOD_UI", + SynchronousEvent = true, + }, + { + Name = "CloseCreateGuildNeighborhoodUI", + Type = "Event", + LiteralName = "CLOSE_CREATE_GUILD_NEIGHBORHOOD_UI", + SynchronousEvent = true, + }, + { + Name = "CreateNeighborhoodResult", + Type = "Event", + LiteralName = "CREATE_NEIGHBORHOOD_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + { Name = "neighborhoodName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "CurrentHouseInfoRecieved", + Type = "Event", + LiteralName = "CURRENT_HOUSE_INFO_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "houseInfo", Type = "HouseInfo", Nilable = false }, + }, + }, + { + Name = "CurrentHouseInfoUpdated", + Type = "Event", + LiteralName = "CURRENT_HOUSE_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "houseInfo", Type = "HouseInfo", Nilable = false }, + }, + }, + { + Name = "DeclineNeighborhoodInvitationResponse", + Type = "Event", + LiteralName = "DECLINE_NEIGHBORHOOD_INVITATION_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ForceRefreshHouseFinder", + Type = "Event", + LiteralName = "FORCE_REFRESH_HOUSE_FINDER", + SynchronousEvent = true, + }, + { + Name = "HouseFinderNeighborhoodDataRecieved", + Type = "Event", + LiteralName = "HOUSE_FINDER_NEIGHBORHOOD_DATA_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodPlots", Type = "table", InnerType = "NeighborhoodPlotMapInfo", Nilable = false }, + }, + }, + { + Name = "HouseInfoUpdated", + Type = "Event", + LiteralName = "HOUSE_INFO_UPDATED", + SynchronousEvent = true, + }, + { + Name = "HouseLevelChanged", + Type = "Event", + LiteralName = "HOUSE_LEVEL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "newHouseLevelInfo", Type = "HouseLevelInfo", Nilable = true }, + }, + }, + { + Name = "HouseLevelFavorUpdated", + Type = "Event", + LiteralName = "HOUSE_LEVEL_FAVOR_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "houseLevelFavor", Type = "HouseLevelFavor", Nilable = false }, + }, + }, + { + Name = "HousePlotEntered", + Type = "Event", + LiteralName = "HOUSE_PLOT_ENTERED", + SynchronousEvent = true, + }, + { + Name = "HousePlotExited", + Type = "Event", + LiteralName = "HOUSE_PLOT_EXITED", + SynchronousEvent = true, + }, + { + Name = "HouseReservationResponseRecieved", + Type = "Event", + LiteralName = "HOUSE_RESERVATION_RESPONSE_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + }, + }, + { + Name = "HousingMarketAvailabilityUpdated", + Type = "Event", + LiteralName = "HOUSING_MARKET_AVAILABILITY_UPDATED", + SynchronousEvent = true, + }, + { + Name = "HousingServicesAvailabilityUpdated", + Type = "Event", + LiteralName = "HOUSING_SERVICES_AVAILABILITY_UPDATED", + SynchronousEvent = true, + }, + { + Name = "MoveOutReservationUpdated", + Type = "Event", + LiteralName = "MOVE_OUT_RESERVATION_UPDATED", + SynchronousEvent = true, + }, + { + Name = "NeighborhoodGuildSizeValidated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_GUILD_SIZE_VALIDATED", + SynchronousEvent = true, + Payload = + { + { Name = "approved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NeighborhoodListUpdated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_LIST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "HousingResult", Nilable = false }, + { Name = "neighborhoodInfos", Type = "table", InnerType = "NeighborhoodInfo", Nilable = true }, + }, + }, + { + Name = "NeighborhoodNameValidated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_NAME_VALIDATED", + SynchronousEvent = true, + Payload = + { + { Name = "approved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NewHousingItemAcquired", + Type = "Event", + LiteralName = "NEW_HOUSING_ITEM_ACQUIRED", + SynchronousEvent = true, + Payload = + { + { Name = "itemType", Type = "HousingItemToastType", Nilable = false }, + { Name = "itemName", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "OpenCharterConfirmationUI", + Type = "Event", + LiteralName = "OPEN_CHARTER_CONFIRMATION_UI", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodName", Type = "string", Nilable = false }, + { Name = "locationName", Type = "string", Nilable = false }, + }, + }, + { + Name = "OpenCreateCharterNeighborhoodUI", + Type = "Event", + LiteralName = "OPEN_CREATE_CHARTER_NEIGHBORHOOD_UI", + SynchronousEvent = true, + Payload = + { + { Name = "locationName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "OpenCreateGuildNeighborhoodUI", + Type = "Event", + LiteralName = "OPEN_CREATE_GUILD_NEIGHBORHOOD_UI", + SynchronousEvent = true, + Payload = + { + { Name = "locationName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "OpenNeighborhoodCharter", + Type = "Event", + LiteralName = "OPEN_NEIGHBORHOOD_CHARTER", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodInfo", Type = "NeighborhoodInfo", Nilable = false }, + { Name = "signatures", Type = "table", InnerType = "string", Nilable = false }, + { Name = "requiredSignatures", Type = "number", Nilable = false }, + }, + }, + { + Name = "OpenNeighborhoodCharterSignatureRequest", + Type = "Event", + LiteralName = "OPEN_NEIGHBORHOOD_CHARTER_SIGNATURE_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodInfo", Type = "NeighborhoodInfo", Nilable = false }, + }, + }, + { + Name = "PlayerCharacterListUpdated", + Type = "Event", + LiteralName = "PLAYER_CHARACTER_LIST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "characterInfos", Type = "table", InnerType = "HouseOwnerCharacterInfo", Nilable = false }, + { Name = "ownerListIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerHouseListUpdated", + Type = "Event", + LiteralName = "PLAYER_HOUSE_LIST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "houseInfos", Type = "table", InnerType = "HouseInfo", Nilable = false }, + }, + }, + { + Name = "ReceivedHouseLevelRewards", + Type = "Event", + LiteralName = "RECEIVED_HOUSE_LEVEL_REWARDS", + SynchronousEvent = true, + Payload = + { + { Name = "level", Type = "number", Nilable = false }, + { Name = "rewards", Type = "table", InnerType = "HouseLevelReward", Nilable = false }, + }, + }, + { + Name = "RemoveNeighborhoodCharterSignature", + Type = "Event", + LiteralName = "REMOVE_NEIGHBORHOOD_CHARTER_SIGNATURE", + SynchronousEvent = true, + Payload = + { + { Name = "signature", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ShowNeighborhoodOwnershipTransferDialog", + Type = "Event", + LiteralName = "SHOW_NEIGHBORHOOD_OWNERSHIP_TRANSFER_DIALOG", + SynchronousEvent = true, + Payload = + { + { Name = "neighborhoodName", Type = "cstring", Nilable = false }, + { Name = "cosmeticOwnerName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "TrackedHouseChanged", + Type = "Event", + LiteralName = "TRACKED_HOUSE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "trackedHouse", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "ViewHousesListRecieved", + Type = "Event", + LiteralName = "VIEW_HOUSES_LIST_RECIEVED", + SynchronousEvent = true, + Payload = + { + { Name = "houseInfos", Type = "table", InnerType = "HouseInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CreateNeighborhoodErrorType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "CreateNeighborhoodErrorType", EnumValue = 0 }, + { Name = "Profanity", Type = "CreateNeighborhoodErrorType", EnumValue = 1 }, + { Name = "UndersizedGuild", Type = "CreateNeighborhoodErrorType", EnumValue = 2 }, + { Name = "OversizedGuild", Type = "CreateNeighborhoodErrorType", EnumValue = 3 }, + }, + }, + { + Name = "HousingItemToastType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Room", Type = "HousingItemToastType", EnumValue = 0 }, + { Name = "Fixture", Type = "HousingItemToastType", EnumValue = 1 }, + { Name = "Customization", Type = "HousingItemToastType", EnumValue = 2 }, + { Name = "Decor", Type = "HousingItemToastType", EnumValue = 3 }, + { Name = "House", Type = "HousingItemToastType", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8a4c06f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/HousingUISharedDocumentation.lua.annotated.lua @@ -0,0 +1,173 @@ +local HousingUIShared = +{ + Tables = + { + { + Name = "HouseLevelRewardType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Value", Type = "HouseLevelRewardType", EnumValue = 0 }, + { Name = "Object", Type = "HouseLevelRewardType", EnumValue = 1 }, + }, + }, + { + Name = "HouseLevelRewardValueType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "ExteriorDecor", Type = "HouseLevelRewardValueType", EnumValue = 0 }, + { Name = "InteriorDecor", Type = "HouseLevelRewardValueType", EnumValue = 1 }, + { Name = "Rooms", Type = "HouseLevelRewardValueType", EnumValue = 2 }, + { Name = "Fixtures", Type = "HouseLevelRewardValueType", EnumValue = 3 }, + }, + }, + { + Name = "HouseVisitType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Unknown", Type = "HouseVisitType", EnumValue = 0 }, + { Name = "Friend", Type = "HouseVisitType", EnumValue = 1 }, + { Name = "Guild", Type = "HouseVisitType", EnumValue = 2 }, + { Name = "Party", Type = "HouseVisitType", EnumValue = 3 }, + }, + }, + { + Name = "HouseInfo", + Type = "Structure", + Fields = + { + { Name = "plotID", Type = "number", Nilable = false }, + { Name = "houseName", Type = "string", Nilable = true }, + { Name = "ownerName", Type = "string", Nilable = true }, + { Name = "plotCost", Type = "number", Nilable = true }, + { Name = "neighborhoodName", Type = "string", Nilable = true }, + { Name = "moveOutTime", Type = "time_t", Nilable = true }, + { Name = "plotReserved", Type = "bool", Nilable = true }, + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = true }, + { Name = "houseGUID", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "HouseLevelFavor", + Type = "Structure", + Fields = + { + { Name = "houseGUID", Type = "WOWGUID", Nilable = true }, + { Name = "houseLevel", Type = "number", Nilable = false }, + { Name = "houseFavor", Type = "number", Nilable = false }, + }, + }, + { + Name = "HouseLevelInfo", + Type = "Structure", + Fields = + { + { Name = "level", Type = "number", Nilable = false, Documentation = { "This specific house's current level, determined/increasesd by earning house xp" } }, + { Name = "interiorDecorPlacementBudget", Type = "number", Nilable = false, Documentation = { "Current max decor placement budget for inside the house; Can be increased via house level" } }, + { Name = "exteriorDecorPlacementBudget", Type = "number", Nilable = false, Documentation = { "Current max decor placement budget for the house exterior/in the house's plot; Can be increased via house level" } }, + { Name = "roomPlacementBudget", Type = "number", Nilable = false, Documentation = { "Current max room placement budget for the house; Can be increased via house level" } }, + { Name = "exteriorFixtureBudget", Type = "number", Nilable = false }, + }, + }, + { + Name = "HouseLevelReward", + Type = "Structure", + Fields = + { + { Name = "type", Type = "HouseLevelRewardType", Nilable = false }, + { Name = "asset", Type = "ModelAsset", Nilable = true }, + { Name = "iconTexture", Type = "FileAsset", Nilable = true }, + { Name = "iconAtlas", Type = "textureAtlas", Nilable = true }, + { Name = "objectName", Type = "string", Nilable = true }, + { Name = "tooltipText", Type = "string", Nilable = true }, + { Name = "valueType", Type = "HouseLevelRewardValueType", Nilable = true }, + { Name = "oldValue", Type = "number", Nilable = true }, + { Name = "newValue", Type = "number", Nilable = true }, + }, + }, + { + Name = "HouseOwnerCharacterInfo", + Type = "Structure", + Fields = + { + { Name = "characterName", Type = "string", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "error", Type = "HouseOwnerError", Nilable = false }, + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "HouseholdMemberInfo", + Type = "Structure", + Fields = + { + { Name = "characterName", Type = "string", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "NeighborhoodInfo", + Type = "Structure", + Fields = + { + { Name = "neighborhoodType", Type = "NeighborhoodType", Nilable = false }, + { Name = "neighborhoodOwnerType", Type = "NeighborhoodOwnerType", Nilable = false, Default = "None" }, + { Name = "neighborhoodName", Type = "string", Nilable = false }, + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + { Name = "ownerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "suggestionReason", Type = "HouseFinderSuggestionReason", Nilable = true }, + { Name = "ownerName", Type = "string", Nilable = true }, + { Name = "locationName", Type = "string", Nilable = true }, + }, + }, + { + Name = "NeighborhoodPlotMapInfo", + Type = "Structure", + Fields = + { + { Name = "mapPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "plotDataID", Type = "number", Nilable = false }, + { Name = "plotID", Type = "number", Nilable = false }, + { Name = "ownerType", Type = "HousingPlotOwnerType", Nilable = false, Default = "None" }, + { Name = "plotCost", Type = "number", Nilable = true }, + { Name = "ownerName", Type = "string", Nilable = true }, + }, + }, + { + Name = "NeighborhoodRosterMemberInfo", + Type = "Structure", + Fields = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "residentName", Type = "string", Nilable = false }, + { Name = "residentType", Type = "ResidentType", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "plotID", Type = "number", Nilable = false }, + { Name = "subdivision", Type = "number", Nilable = true }, + }, + }, + { + Name = "NeighborhoodRosterMemberUpdateInfo", + Type = "Structure", + Fields = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "residentType", Type = "ResidentType", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(HousingUIShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImageSharingConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImageSharingConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c9d62d9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImageSharingConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,91 @@ +local ImageSharingConstants = +{ + Tables = + { + { + Name = "ImageSharingResult", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "Failure", Type = "ImageSharingResult", EnumValue = 0 }, + { Name = "Success", Type = "ImageSharingResult", EnumValue = 1 }, + { Name = "NotConfigured", Type = "ImageSharingResult", EnumValue = 2 }, + { Name = "RetrievedExisting", Type = "ImageSharingResult", EnumValue = 3 }, + { Name = "PlatformApiError", Type = "ImageSharingResult", EnumValue = 4 }, + { Name = "MissingFieldApiError", Type = "ImageSharingResult", EnumValue = 5 }, + { Name = "AccountDataRequestFailure", Type = "ImageSharingResult", EnumValue = 6 }, + { Name = "GetAccountDataRequestFailure", Type = "ImageSharingResult", EnumValue = 7 }, + { Name = "SetAccountDataRequestFailure", Type = "ImageSharingResult", EnumValue = 8 }, + { Name = "RefreshTokenExpired", Type = "ImageSharingResult", EnumValue = 9 }, + { Name = "FailedToCreateHeader", Type = "ImageSharingResult", EnumValue = 10 }, + { Name = "EncryptionFailure", Type = "ImageSharingResult", EnumValue = 11 }, + { Name = "InvalidOAuthExpiration", Type = "ImageSharingResult", EnumValue = 12 }, + { Name = "InvalidRefreshExpiration", Type = "ImageSharingResult", EnumValue = 13 }, + { Name = "EncryptionSecretNotSet", Type = "ImageSharingResult", EnumValue = 14 }, + }, + }, + { + Name = "PhotoSharingStatus", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Disabled", Type = "PhotoSharingStatus", EnumValue = 0 }, + { Name = "NotConfigured", Type = "PhotoSharingStatus", EnumValue = 1 }, + { Name = "Configured", Type = "PhotoSharingStatus", EnumValue = 2 }, + { Name = "Expired", Type = "PhotoSharingStatus", EnumValue = 3 }, + { Name = "ParentalControl", Type = "PhotoSharingStatus", EnumValue = 4 }, + { Name = "TrialOrVeteran", Type = "PhotoSharingStatus", EnumValue = 5 }, + { Name = "AADCRestricted", Type = "PhotoSharingStatus", EnumValue = 6 }, + { Name = "Error", Type = "PhotoSharingStatus", EnumValue = 7 }, + { Name = "FailedToClear", Type = "PhotoSharingStatus", EnumValue = 8 }, + }, + }, + { + Name = "PhotoSharingUploadStatus", + Type = "Enumeration", + NumValues = 29, + MinValue = 0, + MaxValue = 28, + Fields = + { + { Name = "Failed", Type = "PhotoSharingUploadStatus", EnumValue = 0 }, + { Name = "Success", Type = "PhotoSharingUploadStatus", EnumValue = 1 }, + { Name = "Locked", Type = "PhotoSharingUploadStatus", EnumValue = 2 }, + { Name = "ListPagesApiCallFailed", Type = "PhotoSharingUploadStatus", EnumValue = 3 }, + { Name = "ListPagesBadRequest", Type = "PhotoSharingUploadStatus", EnumValue = 4 }, + { Name = "ListPagesUnauthorized", Type = "PhotoSharingUploadStatus", EnumValue = 5 }, + { Name = "ListPagesForbidden", Type = "PhotoSharingUploadStatus", EnumValue = 6 }, + { Name = "ListPagesNotFound", Type = "PhotoSharingUploadStatus", EnumValue = 7 }, + { Name = "ListPagesTooManyRequests", Type = "PhotoSharingUploadStatus", EnumValue = 8 }, + { Name = "ListPagesGenericFailure", Type = "PhotoSharingUploadStatus", EnumValue = 9 }, + { Name = "ListPagesEmptyBoardID", Type = "PhotoSharingUploadStatus", EnumValue = 10 }, + { Name = "ListPagesInvalidBookmark", Type = "PhotoSharingUploadStatus", EnumValue = 11 }, + { Name = "CreatePageApiCallFailed", Type = "PhotoSharingUploadStatus", EnumValue = 12 }, + { Name = "CreatePageBadRequest", Type = "PhotoSharingUploadStatus", EnumValue = 13 }, + { Name = "CreatePageUnauthorized", Type = "PhotoSharingUploadStatus", EnumValue = 14 }, + { Name = "CreatePageForbidden", Type = "PhotoSharingUploadStatus", EnumValue = 15 }, + { Name = "CreatePageNotFound", Type = "PhotoSharingUploadStatus", EnumValue = 16 }, + { Name = "CreatePageTooManyRequests", Type = "PhotoSharingUploadStatus", EnumValue = 17 }, + { Name = "CreatePageGenericFailure", Type = "PhotoSharingUploadStatus", EnumValue = 18 }, + { Name = "CreatePageNoBoardIDFound", Type = "PhotoSharingUploadStatus", EnumValue = 19 }, + { Name = "CreatePostApiCallFailed", Type = "PhotoSharingUploadStatus", EnumValue = 20 }, + { Name = "CreatePostBadRequest", Type = "PhotoSharingUploadStatus", EnumValue = 21 }, + { Name = "CreatePostUnauthorized", Type = "PhotoSharingUploadStatus", EnumValue = 22 }, + { Name = "CreatePostForbidden", Type = "PhotoSharingUploadStatus", EnumValue = 23 }, + { Name = "CreatePostNotFound", Type = "PhotoSharingUploadStatus", EnumValue = 24 }, + { Name = "CreatePostTooManyRequests", Type = "PhotoSharingUploadStatus", EnumValue = 25 }, + { Name = "CreatePostGenericFailure", Type = "PhotoSharingUploadStatus", EnumValue = 26 }, + { Name = "CreatePostNoIDFound", Type = "PhotoSharingUploadStatus", EnumValue = 27 }, + { Name = "CreatePostThrottled", Type = "PhotoSharingUploadStatus", EnumValue = 28 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ImageSharingConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..74d29d0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ImmersiveInteractionManagerDocumentation.lua.annotated.lua @@ -0,0 +1,42 @@ +local ImmersiveInteractionManager = +{ + Name = "ImmersiveInteraction", + Type = "System", + Namespace = "C_ImmersiveInteraction", + Environment = "All", + + Functions = + { + { + Name = "HasImmersiveInteraction", + Type = "Function", + + Returns = + { + { Name = "immersiveInteraction", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ImmersiveInteractionBegin", + Type = "Event", + LiteralName = "IMMERSIVE_INTERACTION_BEGIN", + SynchronousEvent = true, + }, + { + Name = "ImmersiveInteractionEnd", + Type = "Event", + LiteralName = "IMMERSIVE_INTERACTION_END", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ImmersiveInteractionManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b4048a1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InGameNavigationDocumentation.lua.annotated.lua @@ -0,0 +1,115 @@ +local InGameNavigation = +{ + Name = "InGameNavigation", + Type = "System", + Namespace = "C_Navigation", + Environment = "All", + + Functions = + { + { + Name = "GetDistance", + Type = "Function", + + Returns = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFrame", + Type = "Function", + + Returns = + { + { Name = "frame", Type = "ScriptRegion", Nilable = true }, + }, + }, + { + Name = "GetNearestPartyMemberToken", + Type = "Function", + + Returns = + { + { Name = "unitToken", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetTargetState", + Type = "Function", + + Returns = + { + { Name = "state", Type = "NavigationState", Nilable = false }, + }, + }, + { + Name = "HasValidScreenPosition", + Type = "Function", + + Returns = + { + { Name = "hasValidScreenPosition", Type = "bool", Nilable = false }, + }, + }, + { + Name = "WasClampedToScreen", + Type = "Function", + + Returns = + { + { Name = "wasClamped", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "NavigationDestinationReached", + Type = "Event", + LiteralName = "NAVIGATION_DESTINATION_REACHED", + SynchronousEvent = true, + Payload = + { + { Name = "isWaypoint", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NavigationFrameCreated", + Type = "Event", + LiteralName = "NAVIGATION_FRAME_CREATED", + SynchronousEvent = true, + Payload = + { + { Name = "region", Type = "ScriptRegion", Nilable = false }, + }, + }, + { + Name = "NavigationFrameDestroyed", + Type = "Event", + LiteralName = "NAVIGATION_FRAME_DESTROYED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "NavigationState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Invalid", Type = "NavigationState", EnumValue = 0 }, + { Name = "Occluded", Type = "NavigationState", EnumValue = 1 }, + { Name = "InRange", Type = "NavigationState", EnumValue = 2 }, + { Name = "Disabled", Type = "NavigationState", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(InGameNavigation); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4088297 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IncomingSummonDocumentation.lua.annotated.lua @@ -0,0 +1,65 @@ +local IncomingSummon = +{ + Name = "IncomingSummon", + Type = "System", + Namespace = "C_IncomingSummon", + Environment = "All", + + Functions = + { + { + Name = "HasIncomingSummon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "summon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IncomingSummonStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "SummonStatus", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "SummonStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "SummonStatus", EnumValue = 0 }, + { Name = "Pending", Type = "SummonStatus", EnumValue = 1 }, + { Name = "Accepted", Type = "SummonStatus", EnumValue = 2 }, + { Name = "Declined", Type = "SummonStatus", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(IncomingSummon); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f0d36b2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local InputConstants = +{ + Tables = + { + { + Name = "InputContext", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "InputContext", EnumValue = 0 }, + { Name = "Keyboard", Type = "InputContext", EnumValue = 1 }, + { Name = "Mouse", Type = "InputContext", EnumValue = 2 }, + { Name = "GamePad", Type = "InputContext", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(InputConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ae13bb1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InputDocumentation.lua.annotated.lua @@ -0,0 +1,300 @@ +local Input = +{ + Name = "Input", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetCursorDelta", + Type = "Function", + + Returns = + { + { Name = "deltaX", Type = "number", Nilable = false }, + { Name = "deltaY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCursorPosition", + Type = "Function", + + Returns = + { + { Name = "posX", Type = "number", Nilable = false }, + { Name = "posY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMouseButtonClicked", + Type = "Function", + + Returns = + { + { Name = "buttonName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetMouseButtonName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "button", Type = "mouseButton", Nilable = false }, + }, + + Returns = + { + { Name = "buttonName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetMouseFoci", + Type = "Function", + + Returns = + { + { Name = "region", Type = "table", InnerType = "ScriptRegion", Nilable = false }, + }, + }, + { + Name = "IsAltKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsControlKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsKeyDown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "keyOrMouseName", Type = "cstring", Nilable = false }, + { Name = "excludeBindingState", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "down", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsLeftAltKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLeftControlKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLeftMetaKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLeftShiftKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMetaKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsModifierKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseButtonDown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "button", Type = "mouseButton", Nilable = true }, + }, + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightAltKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightControlKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightMetaKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightShiftKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsShiftKeyDown", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingGamepad", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingMouse", + Type = "Function", + + Returns = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCursorPosition", + Type = "Function", + RequiresLimitedInput = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Insecure code can only call this once in response to gamepad input hardware events." }, + + Arguments = + { + { Name = "xPosition", Type = "uiUnit", Nilable = false }, + { Name = "yPosition", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SimulateMouseClick", + Type = "Function", + RequiresLimitedInput = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Effectively the same as SimulateMouseDown plus SimulateMouseUp and consumes limited input for both." }, + + Arguments = + { + { Name = "button", Type = "mouseButton", Nilable = false }, + }, + }, + { + Name = "SimulateMouseDown", + Type = "Function", + RequiresLimitedInput = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Insecure code can only call this once in response to gamepad input hardware events." }, + + Arguments = + { + { Name = "button", Type = "mouseButton", Nilable = false }, + }, + }, + { + Name = "SimulateMouseUp", + Type = "Function", + RequiresLimitedInput = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Insecure code can only call this once in response to gamepad input hardware events." }, + + Arguments = + { + { Name = "button", Type = "mouseButton", Nilable = false }, + }, + }, + { + Name = "SimulateMouseWheel", + Type = "Function", + RequiresLimitedInput = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Insecure code can only call this once in response to gamepad input hardware events." }, + + Arguments = + { + { Name = "delta", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Input); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua.annotated.lua new file mode 100644 index 0000000..09356da --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceDocumentation.lua.annotated.lua @@ -0,0 +1,271 @@ +local Instance = +{ + Name = "Instance", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CanChangePlayerDifficulty", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "canChange", Type = "bool", Nilable = false }, + { Name = "notOnCooldown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanMapChangeDifficulty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "canChange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanShowResetInstances", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDifficultyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "instanceType", Type = "cstring", Nilable = false }, + { Name = "isHeroic", Type = "bool", Nilable = false }, + { Name = "isChallengeMode", Type = "bool", Nilable = false }, + { Name = "displayHeroic", Type = "bool", Nilable = false }, + { Name = "displayMythic", Type = "bool", Nilable = false }, + { Name = "toggleDifficultyID", Type = "number", Nilable = true }, + { Name = "isLFR", Type = "bool", Nilable = false }, + { Name = "minPlayers", Type = "number", Nilable = true }, + { Name = "maxPlayers", Type = "number", Nilable = true }, + { Name = "isUserSelectable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDungeonDifficultyID", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceBootTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceInfo", + Type = "Function", + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "instanceType", Type = "cstring", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "cstring", Nilable = false }, + { Name = "maxPlayers", Type = "number", Nilable = false }, + { Name = "dynamicDifficulty", Type = "number", Nilable = false }, + { Name = "isDynamic", Type = "bool", Nilable = true }, + { Name = "instanceID", Type = "number", Nilable = false }, + { Name = "instanceGroupSize", Type = "number", Nilable = false }, + { Name = "lfgDungeonID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetInstanceLockTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + { Name = "extending", Type = "bool", Nilable = false }, + { Name = "encountersTotal", Type = "number", Nilable = false }, + { Name = "encountersCompleted", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceLockTimeRemainingEncounter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "encounterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "encounterName", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "cstring", Nilable = false }, + { Name = "isKilled", Type = "bool", Nilable = false }, + { Name = "ineligible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetLegacyRaidDifficultyID", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRaidDifficultyID", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsInInstance", + Type = "Function", + + Returns = + { + { Name = "isInInstance", Type = "bool", Nilable = false }, + { Name = "instanceType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsLegacyDifficulty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ResetInstances", + Type = "Function", + }, + { + Name = "SetDungeonDifficultyID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLegacyRaidDifficultyID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "force", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetRaidDifficultyID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "force", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "DifficultyInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "instanceType", Type = "cstring", Nilable = false }, + { Name = "isHeroic", Type = "bool", Nilable = false }, + { Name = "isChallengeMode", Type = "bool", Nilable = false }, + { Name = "displayHeroic", Type = "bool", Nilable = false }, + { Name = "displayMythic", Type = "bool", Nilable = false }, + { Name = "toggleDifficultyID", Type = "number", Nilable = true }, + { Name = "isLFR", Type = "bool", Nilable = false }, + { Name = "minPlayers", Type = "number", Nilable = true }, + { Name = "maxPlayers", Type = "number", Nilable = true }, + { Name = "isUserSelectable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DungeonEncounterInfo", + Type = "Structure", + Fields = + { + { Name = "encounterName", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "cstring", Nilable = false }, + { Name = "isKilled", Type = "bool", Nilable = false }, + { Name = "ineligible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InstanceInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "instanceType", Type = "cstring", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "cstring", Nilable = false }, + { Name = "maxPlayers", Type = "number", Nilable = false }, + { Name = "dynamicDifficulty", Type = "number", Nilable = false }, + { Name = "isDynamic", Type = "bool", Nilable = true }, + { Name = "instanceID", Type = "number", Nilable = false }, + { Name = "instanceGroupSize", Type = "number", Nilable = false }, + { Name = "lfgDungeonID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Instance); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8de5156 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceEncounterDocumentation.lua.annotated.lua @@ -0,0 +1,117 @@ +local InstanceEncounter = +{ + Name = "InstanceEncounter", + Type = "System", + Namespace = "C_InstanceEncounter", + Environment = "All", + + Functions = + { + { + Name = "IsEncounterInProgress", + Type = "Function", + + Returns = + { + { Name = "isInProgress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEncounterLimitingResurrections", + Type = "Function", + + Returns = + { + { Name = "isLimitingResurrections", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEncounterSuppressingRelease", + Type = "Function", + + Returns = + { + { Name = "isSuppressingRelease", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowTimelineForEncounter", + Type = "Function", + + Returns = + { + { Name = "shouldShow", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "EncounterStateChanged", + Type = "Event", + LiteralName = "ENCOUNTER_STATE_CHANGED", + SynchronousEvent = true, + CallbackEvent = true, + Documentation = { "Signaled when the in-progress state of an encounter changes." }, + Payload = + { + { Name = "isInProgress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InstanceEncounterAddTimer", + Type = "Event", + LiteralName = "INSTANCE_ENCOUNTER_ADD_TIMER", + SynchronousEvent = true, + Payload = + { + { Name = "timeRemaining", Type = "number", Nilable = false }, + }, + }, + { + Name = "InstanceEncounterEngageUnit", + Type = "Event", + LiteralName = "INSTANCE_ENCOUNTER_ENGAGE_UNIT", + SynchronousEvent = true, + }, + { + Name = "InstanceEncounterObjectiveComplete", + Type = "Event", + LiteralName = "INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "objectiveID", Type = "number", Nilable = false }, + }, + }, + { + Name = "InstanceEncounterObjectiveStart", + Type = "Event", + LiteralName = "INSTANCE_ENCOUNTER_OBJECTIVE_START", + SynchronousEvent = true, + Payload = + { + { Name = "objectiveID", Type = "number", Nilable = false }, + { Name = "objectiveProgress", Type = "number", Nilable = false }, + }, + }, + { + Name = "InstanceEncounterObjectiveUpdate", + Type = "Event", + LiteralName = "INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "objectiveID", Type = "number", Nilable = false }, + { Name = "objectiveProgress", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(InstanceEncounter); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..544a594 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InstanceLeaverInfoDocumentation.lua.annotated.lua @@ -0,0 +1,41 @@ +local InstanceLeaverInfo = +{ + Name = "InstanceLeaverInfo", + Type = "System", + Namespace = "C_InstanceLeaver", + Environment = "All", + + Functions = + { + { + Name = "IsPlayerLeaver", + Type = "Function", + Documentation = { "Returns whether the player is considered a leaver for repeatedly abandoning mythic+ groups." }, + + Returns = + { + { Name = "isLeaver", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "InstanceLeaverStatusChanged", + Type = "Event", + LiteralName = "INSTANCE_LEAVER_STATUS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isLeaver", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(InstanceLeaverInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d41d05f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InterfaceFileManifestDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local InterfaceFileManifest = +{ + Name = "InterfaceFileManifest", + Type = "System", + Namespace = "C_InterfaceFileManifest", + Environment = "All", + + Functions = + { + { + Name = "GetInterfaceArtFiles", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "images", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(InterfaceFileManifest); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e74fa64 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/InvasionInfoDocumentation.lua.annotated.lua @@ -0,0 +1,89 @@ +local InvasionInfo = +{ + Name = "InvasionInfo", + Type = "System", + Namespace = "C_InvasionInfo", + Environment = "All", + + Functions = + { + { + Name = "AreInvasionsAvailable", + Type = "Function", + Documentation = { "Returns true if invasions are active in the same physical area as the player." }, + + Returns = + { + { Name = "areInvasionsAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetInvasionForUiMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "invasionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetInvasionInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "invasionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "invasionInfo", Type = "InvasionMapInfo", Nilable = false }, + }, + }, + { + Name = "GetInvasionTimeLeft", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "invasionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "timeLeftMinutes", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "InvasionMapInfo", + Type = "Structure", + Fields = + { + { Name = "invasionID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "atlasName", Type = "textureAtlas", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(InvasionInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..af62e3d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsInfoDocumentation.lua.annotated.lua @@ -0,0 +1,35 @@ +local IslandsInfo = +{ + Name = "IslandsInfo", + Type = "System", + Namespace = "C_IslandsInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "IslandAzeriteGain", + Type = "Event", + LiteralName = "ISLAND_AZERITE_GAIN", + SynchronousEvent = true, + Payload = + { + { Name = "amount", Type = "number", Nilable = false }, + { Name = "gainedByPlayer", Type = "bool", Nilable = false }, + { Name = "factionIndex", Type = "number", Nilable = false }, + { Name = "gainedBy", Type = "WOWGUID", Nilable = false }, + { Name = "gainedFrom", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(IslandsInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5c01d81 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/IslandsQueueUIDocumentation.lua.annotated.lua @@ -0,0 +1,93 @@ +local IslandsQueueUI = +{ + Name = "IslandsQueue", + Type = "System", + Namespace = "C_IslandsQueue", + Environment = "All", + + Functions = + { + { + Name = "CloseIslandsQueueScreen", + Type = "Function", + }, + { + Name = "GetIslandDifficultyInfo", + Type = "Function", + + Returns = + { + { Name = "islandDifficultyInfo", Type = "table", InnerType = "IslandsQueueDifficultyInfo", Nilable = false }, + }, + }, + { + Name = "GetIslandsMaxGroupSize", + Type = "Function", + + Returns = + { + { Name = "maxGroupSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIslandsWeeklyQuestID", + Type = "Function", + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + }, + { + Name = "QueueForIsland", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestPreloadRewardData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questId", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "IslandsQueueClose", + Type = "Event", + LiteralName = "ISLANDS_QUEUE_CLOSE", + SynchronousEvent = true, + }, + { + Name = "IslandsQueueOpen", + Type = "Event", + LiteralName = "ISLANDS_QUEUE_OPEN", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "IslandsQueueDifficultyInfo", + Type = "Structure", + Fields = + { + { Name = "difficultyId", Type = "number", Nilable = false }, + { Name = "previewRewardQuestId", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(IslandsQueueUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..05e74c8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,698 @@ +local ItemConstants = +{ + Tables = + { + { + Name = "BankType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Character", Type = "BankType", EnumValue = 0 }, + { Name = "Guild", Type = "BankType", EnumValue = 1 }, + { Name = "Account", Type = "BankType", EnumValue = 2 }, + }, + }, + { + Name = "BonusStatIndex", + Type = "Enumeration", + NumValues = 83, + MinValue = 0, + MaxValue = 82, + Fields = + { + { Name = "Mana", Type = "BonusStatIndex", EnumValue = 0 }, + { Name = "Health", Type = "BonusStatIndex", EnumValue = 1 }, + { Name = "Endurance", Type = "BonusStatIndex", EnumValue = 2 }, + { Name = "Agility", Type = "BonusStatIndex", EnumValue = 3 }, + { Name = "Strength", Type = "BonusStatIndex", EnumValue = 4 }, + { Name = "Intellect", Type = "BonusStatIndex", EnumValue = 5 }, + { Name = "Spirit", Type = "BonusStatIndex", EnumValue = 6 }, + { Name = "Stamina", Type = "BonusStatIndex", EnumValue = 7 }, + { Name = "Energy", Type = "BonusStatIndex", EnumValue = 8 }, + { Name = "Rage", Type = "BonusStatIndex", EnumValue = 9 }, + { Name = "Focus", Type = "BonusStatIndex", EnumValue = 10 }, + { Name = "WeaponSkillRatingObsolete", Type = "BonusStatIndex", EnumValue = 11 }, + { Name = "DefenseSkillRating", Type = "BonusStatIndex", EnumValue = 12 }, + { Name = "DodgeRating", Type = "BonusStatIndex", EnumValue = 13 }, + { Name = "ParryRating", Type = "BonusStatIndex", EnumValue = 14 }, + { Name = "BlockRating", Type = "BonusStatIndex", EnumValue = 15 }, + { Name = "HitMeleeRating", Type = "BonusStatIndex", EnumValue = 16 }, + { Name = "HitRangedRating", Type = "BonusStatIndex", EnumValue = 17 }, + { Name = "HitSpellRating", Type = "BonusStatIndex", EnumValue = 18 }, + { Name = "CritMeleeRating", Type = "BonusStatIndex", EnumValue = 19 }, + { Name = "CritRangedRating", Type = "BonusStatIndex", EnumValue = 20 }, + { Name = "CritSpellRating", Type = "BonusStatIndex", EnumValue = 21 }, + { Name = "Corruption", Type = "BonusStatIndex", EnumValue = 22 }, + { Name = "CorruptionResistance", Type = "BonusStatIndex", EnumValue = 23 }, + { Name = "ModifiedCraftingStat_1", Type = "BonusStatIndex", EnumValue = 24 }, + { Name = "ModifiedCraftingStat_2", Type = "BonusStatIndex", EnumValue = 25 }, + { Name = "CritTakenRangedRatingObsolete", Type = "BonusStatIndex", EnumValue = 26 }, + { Name = "CritTakenSpellRatingObsolete", Type = "BonusStatIndex", EnumValue = 27 }, + { Name = "HasteMeleeRatingObsolete", Type = "BonusStatIndex", EnumValue = 28 }, + { Name = "HasteRangedRatingObsolete", Type = "BonusStatIndex", EnumValue = 29 }, + { Name = "HasteSpellRatingObsolete", Type = "BonusStatIndex", EnumValue = 30 }, + { Name = "HitRating", Type = "BonusStatIndex", EnumValue = 31 }, + { Name = "CritRating", Type = "BonusStatIndex", EnumValue = 32 }, + { Name = "HitTakenRatingObsolete", Type = "BonusStatIndex", EnumValue = 33 }, + { Name = "CritTakenRatingObsolete", Type = "BonusStatIndex", EnumValue = 34 }, + { Name = "ResilienceRating", Type = "BonusStatIndex", EnumValue = 35 }, + { Name = "HasteRating", Type = "BonusStatIndex", EnumValue = 36 }, + { Name = "ExpertiseRating", Type = "BonusStatIndex", EnumValue = 37 }, + { Name = "AttackPower", Type = "BonusStatIndex", EnumValue = 38 }, + { Name = "RangedAttackPower", Type = "BonusStatIndex", EnumValue = 39 }, + { Name = "Versatility", Type = "BonusStatIndex", EnumValue = 40 }, + { Name = "SpellHealingDone", Type = "BonusStatIndex", EnumValue = 41 }, + { Name = "SpellDamageDone", Type = "BonusStatIndex", EnumValue = 42 }, + { Name = "ManaRegenerationObsolete", Type = "BonusStatIndex", EnumValue = 43 }, + { Name = "Unused", Type = "BonusStatIndex", EnumValue = 44 }, + { Name = "SpellPower", Type = "BonusStatIndex", EnumValue = 45 }, + { Name = "HealthRegen", Type = "BonusStatIndex", EnumValue = 46 }, + { Name = "SpellPenetration", Type = "BonusStatIndex", EnumValue = 47 }, + { Name = "BlockValueObsolete", Type = "BonusStatIndex", EnumValue = 48 }, + { Name = "MasteryRating", Type = "BonusStatIndex", EnumValue = 49 }, + { Name = "ExtraArmor", Type = "BonusStatIndex", EnumValue = 50 }, + { Name = "FireResistance", Type = "BonusStatIndex", EnumValue = 51 }, + { Name = "FrostResistance", Type = "BonusStatIndex", EnumValue = 52 }, + { Name = "HolyResistance", Type = "BonusStatIndex", EnumValue = 53 }, + { Name = "ShadowResistance", Type = "BonusStatIndex", EnumValue = 54 }, + { Name = "NatureResistance", Type = "BonusStatIndex", EnumValue = 55 }, + { Name = "ArcaneResistance", Type = "BonusStatIndex", EnumValue = 56 }, + { Name = "PvPPower", Type = "BonusStatIndex", EnumValue = 57 }, + { Name = "CombatRatingUnused_0", Type = "BonusStatIndex", EnumValue = 58 }, + { Name = "CombatRatingUnused_2", Type = "BonusStatIndex", EnumValue = 59 }, + { Name = "CombatRatingUnused_3", Type = "BonusStatIndex", EnumValue = 60 }, + { Name = "CombatRatingSpeed", Type = "BonusStatIndex", EnumValue = 61 }, + { Name = "CombatRatingLifesteal", Type = "BonusStatIndex", EnumValue = 62 }, + { Name = "CombatRatingAvoidance", Type = "BonusStatIndex", EnumValue = 63 }, + { Name = "CombatRatingSturdiness", Type = "BonusStatIndex", EnumValue = 64 }, + { Name = "CombatRatingUnused_7", Type = "BonusStatIndex", EnumValue = 65 }, + { Name = "CombatRatingUnused_27", Type = "BonusStatIndex", EnumValue = 66 }, + { Name = "CombatRatingUnused_9", Type = "BonusStatIndex", EnumValue = 67 }, + { Name = "CombatRatingUnused_10", Type = "BonusStatIndex", EnumValue = 68 }, + { Name = "CombatRatingUnused_11", Type = "BonusStatIndex", EnumValue = 69 }, + { Name = "CombatRatingUnused_12", Type = "BonusStatIndex", EnumValue = 70 }, + { Name = "AgilityOrStrengthOrIntellect", Type = "BonusStatIndex", EnumValue = 71 }, + { Name = "AgilityOrStrength", Type = "BonusStatIndex", EnumValue = 72 }, + { Name = "AgilityOrIntellect", Type = "BonusStatIndex", EnumValue = 73 }, + { Name = "StrengthOrIntellect", Type = "BonusStatIndex", EnumValue = 74 }, + { Name = "ProfessionInspiration", Type = "BonusStatIndex", EnumValue = 75 }, + { Name = "ProfessionResourcefulness", Type = "BonusStatIndex", EnumValue = 76 }, + { Name = "ProfessionFinesse", Type = "BonusStatIndex", EnumValue = 77 }, + { Name = "ProfessionDeftness", Type = "BonusStatIndex", EnumValue = 78 }, + { Name = "ProfessionPerception", Type = "BonusStatIndex", EnumValue = 79 }, + { Name = "ProfessionCraftingSpeed", Type = "BonusStatIndex", EnumValue = 80 }, + { Name = "ProfessionMulticraft", Type = "BonusStatIndex", EnumValue = 81 }, + { Name = "ProfessionIngenuity", Type = "BonusStatIndex", EnumValue = 82 }, + }, + }, + { + Name = "InventoryType", + Type = "Enumeration", + NumValues = 35, + MinValue = 0, + MaxValue = 34, + Fields = + { + { Name = "IndexNonEquipType", Type = "InventoryType", EnumValue = 0 }, + { Name = "IndexHeadType", Type = "InventoryType", EnumValue = 1 }, + { Name = "IndexNeckType", Type = "InventoryType", EnumValue = 2 }, + { Name = "IndexShoulderType", Type = "InventoryType", EnumValue = 3 }, + { Name = "IndexBodyType", Type = "InventoryType", EnumValue = 4 }, + { Name = "IndexChestType", Type = "InventoryType", EnumValue = 5 }, + { Name = "IndexWaistType", Type = "InventoryType", EnumValue = 6 }, + { Name = "IndexLegsType", Type = "InventoryType", EnumValue = 7 }, + { Name = "IndexFeetType", Type = "InventoryType", EnumValue = 8 }, + { Name = "IndexWristType", Type = "InventoryType", EnumValue = 9 }, + { Name = "IndexHandType", Type = "InventoryType", EnumValue = 10 }, + { Name = "IndexFingerType", Type = "InventoryType", EnumValue = 11 }, + { Name = "IndexTrinketType", Type = "InventoryType", EnumValue = 12 }, + { Name = "IndexWeaponType", Type = "InventoryType", EnumValue = 13 }, + { Name = "IndexShieldType", Type = "InventoryType", EnumValue = 14 }, + { Name = "IndexRangedType", Type = "InventoryType", EnumValue = 15 }, + { Name = "IndexCloakType", Type = "InventoryType", EnumValue = 16 }, + { Name = "Index2HweaponType", Type = "InventoryType", EnumValue = 17 }, + { Name = "IndexBagType", Type = "InventoryType", EnumValue = 18 }, + { Name = "IndexTabardType", Type = "InventoryType", EnumValue = 19 }, + { Name = "IndexRobeType", Type = "InventoryType", EnumValue = 20 }, + { Name = "IndexWeaponmainhandType", Type = "InventoryType", EnumValue = 21 }, + { Name = "IndexWeaponoffhandType", Type = "InventoryType", EnumValue = 22 }, + { Name = "IndexHoldableType", Type = "InventoryType", EnumValue = 23 }, + { Name = "IndexAmmoType", Type = "InventoryType", EnumValue = 24 }, + { Name = "IndexThrownType", Type = "InventoryType", EnumValue = 25 }, + { Name = "IndexRangedrightType", Type = "InventoryType", EnumValue = 26 }, + { Name = "IndexQuiverType", Type = "InventoryType", EnumValue = 27 }, + { Name = "IndexRelicType", Type = "InventoryType", EnumValue = 28 }, + { Name = "IndexProfessionToolType", Type = "InventoryType", EnumValue = 29 }, + { Name = "IndexProfessionGearType", Type = "InventoryType", EnumValue = 30 }, + { Name = "IndexEquipablespellOffensiveType", Type = "InventoryType", EnumValue = 31 }, + { Name = "IndexEquipablespellUtilityType", Type = "InventoryType", EnumValue = 32 }, + { Name = "IndexEquipablespellDefensiveType", Type = "InventoryType", EnumValue = 33 }, + { Name = "IndexEquipablespellWeaponType", Type = "InventoryType", EnumValue = 34 }, + }, + }, + { + Name = "ItemArmorSubclass", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Generic", Type = "ItemArmorSubclass", EnumValue = 0 }, + { Name = "Cloth", Type = "ItemArmorSubclass", EnumValue = 1 }, + { Name = "Leather", Type = "ItemArmorSubclass", EnumValue = 2 }, + { Name = "Mail", Type = "ItemArmorSubclass", EnumValue = 3 }, + { Name = "Plate", Type = "ItemArmorSubclass", EnumValue = 4 }, + { Name = "Cosmetic", Type = "ItemArmorSubclass", EnumValue = 5 }, + { Name = "Shield", Type = "ItemArmorSubclass", EnumValue = 6 }, + { Name = "Libram", Type = "ItemArmorSubclass", EnumValue = 7 }, + { Name = "Idol", Type = "ItemArmorSubclass", EnumValue = 8 }, + { Name = "Totem", Type = "ItemArmorSubclass", EnumValue = 9 }, + { Name = "Sigil", Type = "ItemArmorSubclass", EnumValue = 10 }, + { Name = "Relic", Type = "ItemArmorSubclass", EnumValue = 11 }, + }, + }, + { + Name = "ItemBind", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "None", Type = "ItemBind", EnumValue = 0 }, + { Name = "OnAcquire", Type = "ItemBind", EnumValue = 1 }, + { Name = "OnEquip", Type = "ItemBind", EnumValue = 2 }, + { Name = "OnUse", Type = "ItemBind", EnumValue = 3 }, + { Name = "Quest", Type = "ItemBind", EnumValue = 4 }, + { Name = "Unused1", Type = "ItemBind", EnumValue = 5 }, + { Name = "Unused2", Type = "ItemBind", EnumValue = 6 }, + { Name = "ToWoWAccount", Type = "ItemBind", EnumValue = 7 }, + { Name = "ToBnetAccount", Type = "ItemBind", EnumValue = 8 }, + { Name = "ToBnetAccountUntilEquipped", Type = "ItemBind", EnumValue = 9 }, + }, + }, + { + Name = "ItemClass", + Type = "Enumeration", + NumValues = 21, + MinValue = 0, + MaxValue = 20, + Fields = + { + { Name = "Consumable", Type = "ItemClass", EnumValue = 0 }, + { Name = "Container", Type = "ItemClass", EnumValue = 1 }, + { Name = "Weapon", Type = "ItemClass", EnumValue = 2 }, + { Name = "Gem", Type = "ItemClass", EnumValue = 3 }, + { Name = "Armor", Type = "ItemClass", EnumValue = 4 }, + { Name = "Reagent", Type = "ItemClass", EnumValue = 5 }, + { Name = "Projectile", Type = "ItemClass", EnumValue = 6 }, + { Name = "Tradegoods", Type = "ItemClass", EnumValue = 7 }, + { Name = "ItemEnhancement", Type = "ItemClass", EnumValue = 8 }, + { Name = "Recipe", Type = "ItemClass", EnumValue = 9 }, + { Name = "CurrencyTokenObsolete", Type = "ItemClass", EnumValue = 10 }, + { Name = "Quiver", Type = "ItemClass", EnumValue = 11 }, + { Name = "Questitem", Type = "ItemClass", EnumValue = 12 }, + { Name = "Key", Type = "ItemClass", EnumValue = 13 }, + { Name = "PermanentObsolete", Type = "ItemClass", EnumValue = 14 }, + { Name = "Miscellaneous", Type = "ItemClass", EnumValue = 15 }, + { Name = "Glyph", Type = "ItemClass", EnumValue = 16 }, + { Name = "Battlepet", Type = "ItemClass", EnumValue = 17 }, + { Name = "WoWToken", Type = "ItemClass", EnumValue = 18 }, + { Name = "Profession", Type = "ItemClass", EnumValue = 19 }, + { Name = "Housing", Type = "ItemClass", EnumValue = 20 }, + }, + }, + { + Name = "ItemConsumableSubclass", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "Generic", Type = "ItemConsumableSubclass", EnumValue = 0 }, + { Name = "Potion", Type = "ItemConsumableSubclass", EnumValue = 1 }, + { Name = "Elixir", Type = "ItemConsumableSubclass", EnumValue = 2 }, + { Name = "Flasksphials", Type = "ItemConsumableSubclass", EnumValue = 3 }, + { Name = "Scroll", Type = "ItemConsumableSubclass", EnumValue = 4 }, + { Name = "Fooddrink", Type = "ItemConsumableSubclass", EnumValue = 5 }, + { Name = "Itemenhancement", Type = "ItemConsumableSubclass", EnumValue = 6 }, + { Name = "Bandage", Type = "ItemConsumableSubclass", EnumValue = 7 }, + { Name = "Other", Type = "ItemConsumableSubclass", EnumValue = 8 }, + { Name = "VantusRune", Type = "ItemConsumableSubclass", EnumValue = 9 }, + { Name = "UtilityCurio", Type = "ItemConsumableSubclass", EnumValue = 10 }, + { Name = "CombatCurio", Type = "ItemConsumableSubclass", EnumValue = 11 }, + { Name = "Relic", Type = "ItemConsumableSubclass", EnumValue = 12 }, + }, + }, + { + Name = "ItemGemColor", + Type = "Enumeration", + NumValues = 31, + MinValue = 1, + MaxValue = 1073741824, + Fields = + { + { Name = "Meta", Type = "ItemGemColor", EnumValue = 1 }, + { Name = "Red", Type = "ItemGemColor", EnumValue = 2 }, + { Name = "Yellow", Type = "ItemGemColor", EnumValue = 4 }, + { Name = "Blue", Type = "ItemGemColor", EnumValue = 8 }, + { Name = "Hydraulic", Type = "ItemGemColor", EnumValue = 16 }, + { Name = "Cogwheel", Type = "ItemGemColor", EnumValue = 32 }, + { Name = "Iron", Type = "ItemGemColor", EnumValue = 64 }, + { Name = "Blood", Type = "ItemGemColor", EnumValue = 128 }, + { Name = "Shadow", Type = "ItemGemColor", EnumValue = 256 }, + { Name = "Fel", Type = "ItemGemColor", EnumValue = 512 }, + { Name = "Arcane", Type = "ItemGemColor", EnumValue = 1024 }, + { Name = "Frost", Type = "ItemGemColor", EnumValue = 2048 }, + { Name = "Fire", Type = "ItemGemColor", EnumValue = 4096 }, + { Name = "Water", Type = "ItemGemColor", EnumValue = 8192 }, + { Name = "Life", Type = "ItemGemColor", EnumValue = 16384 }, + { Name = "Wind", Type = "ItemGemColor", EnumValue = 32768 }, + { Name = "Holy", Type = "ItemGemColor", EnumValue = 65536 }, + { Name = "PunchcardRed", Type = "ItemGemColor", EnumValue = 131072 }, + { Name = "PunchcardYellow", Type = "ItemGemColor", EnumValue = 262144 }, + { Name = "PunchcardBlue", Type = "ItemGemColor", EnumValue = 524288 }, + { Name = "DominationBlood", Type = "ItemGemColor", EnumValue = 1048576 }, + { Name = "DominationFrost", Type = "ItemGemColor", EnumValue = 2097152 }, + { Name = "DominationUnholy", Type = "ItemGemColor", EnumValue = 4194304 }, + { Name = "Cypher", Type = "ItemGemColor", EnumValue = 8388608 }, + { Name = "Tinker", Type = "ItemGemColor", EnumValue = 16777216 }, + { Name = "Primordial", Type = "ItemGemColor", EnumValue = 33554432 }, + { Name = "Fragrance", Type = "ItemGemColor", EnumValue = 67108864 }, + { Name = "SingingThunder", Type = "ItemGemColor", EnumValue = 134217728 }, + { Name = "SingingSea", Type = "ItemGemColor", EnumValue = 268435456 }, + { Name = "SingingWind", Type = "ItemGemColor", EnumValue = 536870912 }, + { Name = "Fiber", Type = "ItemGemColor", EnumValue = 1073741824 }, + }, + }, + { + Name = "ItemHousingSubclass", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Decor", Type = "ItemHousingSubclass", EnumValue = 0 }, + { Name = "Dye", Type = "ItemHousingSubclass", EnumValue = 1 }, + { Name = "Room", Type = "ItemHousingSubclass", EnumValue = 2 }, + { Name = "RoomCustomization", Type = "ItemHousingSubclass", EnumValue = 3 }, + { Name = "ExteriorCustomization", Type = "ItemHousingSubclass", EnumValue = 4 }, + { Name = "ServiceItem", Type = "ItemHousingSubclass", EnumValue = 5 }, + }, + }, + { + Name = "ItemMiscellaneousSubclass", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Junk", Type = "ItemMiscellaneousSubclass", EnumValue = 0 }, + { Name = "Reagent", Type = "ItemMiscellaneousSubclass", EnumValue = 1 }, + { Name = "CompanionPet", Type = "ItemMiscellaneousSubclass", EnumValue = 2 }, + { Name = "Holiday", Type = "ItemMiscellaneousSubclass", EnumValue = 3 }, + { Name = "Other", Type = "ItemMiscellaneousSubclass", EnumValue = 4 }, + { Name = "Mount", Type = "ItemMiscellaneousSubclass", EnumValue = 5 }, + { Name = "MountEquipment", Type = "ItemMiscellaneousSubclass", EnumValue = 6 }, + }, + }, + { + Name = "ItemProfessionSubclass", + Type = "Enumeration", + NumValues = 14, + MinValue = 0, + MaxValue = 13, + Fields = + { + { Name = "Blacksmithing", Type = "ItemProfessionSubclass", EnumValue = 0 }, + { Name = "Leatherworking", Type = "ItemProfessionSubclass", EnumValue = 1 }, + { Name = "Alchemy", Type = "ItemProfessionSubclass", EnumValue = 2 }, + { Name = "Herbalism", Type = "ItemProfessionSubclass", EnumValue = 3 }, + { Name = "Cooking", Type = "ItemProfessionSubclass", EnumValue = 4 }, + { Name = "Mining", Type = "ItemProfessionSubclass", EnumValue = 5 }, + { Name = "Tailoring", Type = "ItemProfessionSubclass", EnumValue = 6 }, + { Name = "Engineering", Type = "ItemProfessionSubclass", EnumValue = 7 }, + { Name = "Enchanting", Type = "ItemProfessionSubclass", EnumValue = 8 }, + { Name = "Fishing", Type = "ItemProfessionSubclass", EnumValue = 9 }, + { Name = "Skinning", Type = "ItemProfessionSubclass", EnumValue = 10 }, + { Name = "Jewelcrafting", Type = "ItemProfessionSubclass", EnumValue = 11 }, + { Name = "Inscription", Type = "ItemProfessionSubclass", EnumValue = 12 }, + { Name = "Archaeology", Type = "ItemProfessionSubclass", EnumValue = 13 }, + }, + }, + { + Name = "ItemReagentSubclass", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Reagent", Type = "ItemReagentSubclass", EnumValue = 0 }, + { Name = "Keystone", Type = "ItemReagentSubclass", EnumValue = 1 }, + { Name = "ContextToken", Type = "ItemReagentSubclass", EnumValue = 2 }, + }, + }, + { + Name = "ItemRecipeSubclass", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Book", Type = "ItemRecipeSubclass", EnumValue = 0 }, + { Name = "Leatherworking", Type = "ItemRecipeSubclass", EnumValue = 1 }, + { Name = "Tailoring", Type = "ItemRecipeSubclass", EnumValue = 2 }, + { Name = "Engineering", Type = "ItemRecipeSubclass", EnumValue = 3 }, + { Name = "Blacksmithing", Type = "ItemRecipeSubclass", EnumValue = 4 }, + { Name = "Cooking", Type = "ItemRecipeSubclass", EnumValue = 5 }, + { Name = "Alchemy", Type = "ItemRecipeSubclass", EnumValue = 6 }, + { Name = "FirstAid", Type = "ItemRecipeSubclass", EnumValue = 7 }, + { Name = "Enchanting", Type = "ItemRecipeSubclass", EnumValue = 8 }, + { Name = "Fishing", Type = "ItemRecipeSubclass", EnumValue = 9 }, + { Name = "Jewelcrafting", Type = "ItemRecipeSubclass", EnumValue = 10 }, + { Name = "Inscription", Type = "ItemRecipeSubclass", EnumValue = 11 }, + }, + }, + { + Name = "ItemSocketType", + Type = "Enumeration", + NumValues = 31, + MinValue = 0, + MaxValue = 30, + Fields = + { + { Name = "None", Type = "ItemSocketType", EnumValue = 0 }, + { Name = "Meta", Type = "ItemSocketType", EnumValue = 1 }, + { Name = "Red", Type = "ItemSocketType", EnumValue = 2 }, + { Name = "Yellow", Type = "ItemSocketType", EnumValue = 3 }, + { Name = "Blue", Type = "ItemSocketType", EnumValue = 4 }, + { Name = "Hydraulic", Type = "ItemSocketType", EnumValue = 5 }, + { Name = "Cogwheel", Type = "ItemSocketType", EnumValue = 6 }, + { Name = "Prismatic", Type = "ItemSocketType", EnumValue = 7 }, + { Name = "Iron", Type = "ItemSocketType", EnumValue = 8 }, + { Name = "Blood", Type = "ItemSocketType", EnumValue = 9 }, + { Name = "Shadow", Type = "ItemSocketType", EnumValue = 10 }, + { Name = "Fel", Type = "ItemSocketType", EnumValue = 11 }, + { Name = "Arcane", Type = "ItemSocketType", EnumValue = 12 }, + { Name = "Frost", Type = "ItemSocketType", EnumValue = 13 }, + { Name = "Fire", Type = "ItemSocketType", EnumValue = 14 }, + { Name = "Water", Type = "ItemSocketType", EnumValue = 15 }, + { Name = "Life", Type = "ItemSocketType", EnumValue = 16 }, + { Name = "Wind", Type = "ItemSocketType", EnumValue = 17 }, + { Name = "Holy", Type = "ItemSocketType", EnumValue = 18 }, + { Name = "PunchcardRed", Type = "ItemSocketType", EnumValue = 19 }, + { Name = "PunchcardYellow", Type = "ItemSocketType", EnumValue = 20 }, + { Name = "PunchcardBlue", Type = "ItemSocketType", EnumValue = 21 }, + { Name = "Domination", Type = "ItemSocketType", EnumValue = 22 }, + { Name = "Cypher", Type = "ItemSocketType", EnumValue = 23 }, + { Name = "Tinker", Type = "ItemSocketType", EnumValue = 24 }, + { Name = "Primordial", Type = "ItemSocketType", EnumValue = 25 }, + { Name = "Fragrance", Type = "ItemSocketType", EnumValue = 26 }, + { Name = "SingingThunder", Type = "ItemSocketType", EnumValue = 27 }, + { Name = "SingingSea", Type = "ItemSocketType", EnumValue = 28 }, + { Name = "SingingWind", Type = "ItemSocketType", EnumValue = 29 }, + { Name = "Fiber", Type = "ItemSocketType", EnumValue = 30 }, + }, + }, + { + Name = "ItemSubclassDisplay", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "HideSubclassInTooltips", Type = "ItemSubclassDisplay", EnumValue = 1 }, + { Name = "HideSubclassInAuction", Type = "ItemSubclassDisplay", EnumValue = 2 }, + { Name = "ShowItemCount", Type = "ItemSubclassDisplay", EnumValue = 4 }, + }, + }, + { + Name = "ItemSubclassFlag", + Type = "Enumeration", + NumValues = 11, + MinValue = 1, + MaxValue = 1024, + Fields = + { + { Name = "WeaponsubclassCanparry", Type = "ItemSubclassFlag", EnumValue = 1 }, + { Name = "WeaponsubclassSetfingerseq", Type = "ItemSubclassFlag", EnumValue = 2 }, + { Name = "WeaponsubclassIsunarmed", Type = "ItemSubclassFlag", EnumValue = 4 }, + { Name = "WeaponsubclassIsrifle", Type = "ItemSubclassFlag", EnumValue = 8 }, + { Name = "WeaponsubclassIsthrown", Type = "ItemSubclassFlag", EnumValue = 16 }, + { Name = "WeaponsubclassRighthandRanged", Type = "ItemSubclassFlag", EnumValue = 32 }, + { Name = "ItemsubclassQuivernotrequired", Type = "ItemSubclassFlag", EnumValue = 64 }, + { Name = "WeaponsubclassRanged", Type = "ItemSubclassFlag", EnumValue = 128 }, + { Name = "WeaponsubclassDeprecatedReuseMe", Type = "ItemSubclassFlag", EnumValue = 256 }, + { Name = "ItemsubclassUsesInvtype", Type = "ItemSubclassFlag", EnumValue = 512 }, + { Name = "ArmorsubclassLfgscalingarmor", Type = "ItemSubclassFlag", EnumValue = 1024 }, + }, + }, + { + Name = "ItemWeaponSubclass", + Type = "Enumeration", + NumValues = 21, + MinValue = 0, + MaxValue = 20, + Fields = + { + { Name = "Axe1H", Type = "ItemWeaponSubclass", EnumValue = 0 }, + { Name = "Axe2H", Type = "ItemWeaponSubclass", EnumValue = 1 }, + { Name = "Bows", Type = "ItemWeaponSubclass", EnumValue = 2 }, + { Name = "Guns", Type = "ItemWeaponSubclass", EnumValue = 3 }, + { Name = "Mace1H", Type = "ItemWeaponSubclass", EnumValue = 4 }, + { Name = "Mace2H", Type = "ItemWeaponSubclass", EnumValue = 5 }, + { Name = "Polearm", Type = "ItemWeaponSubclass", EnumValue = 6 }, + { Name = "Sword1H", Type = "ItemWeaponSubclass", EnumValue = 7 }, + { Name = "Sword2H", Type = "ItemWeaponSubclass", EnumValue = 8 }, + { Name = "Warglaive", Type = "ItemWeaponSubclass", EnumValue = 9 }, + { Name = "Staff", Type = "ItemWeaponSubclass", EnumValue = 10 }, + { Name = "Bearclaw", Type = "ItemWeaponSubclass", EnumValue = 11 }, + { Name = "Catclaw", Type = "ItemWeaponSubclass", EnumValue = 12 }, + { Name = "Unarmed", Type = "ItemWeaponSubclass", EnumValue = 13 }, + { Name = "Generic", Type = "ItemWeaponSubclass", EnumValue = 14 }, + { Name = "Dagger", Type = "ItemWeaponSubclass", EnumValue = 15 }, + { Name = "Thrown", Type = "ItemWeaponSubclass", EnumValue = 16 }, + { Name = "Obsolete3", Type = "ItemWeaponSubclass", EnumValue = 17 }, + { Name = "Crossbow", Type = "ItemWeaponSubclass", EnumValue = 18 }, + { Name = "Wand", Type = "ItemWeaponSubclass", EnumValue = 19 }, + { Name = "Fishingpole", Type = "ItemWeaponSubclass", EnumValue = 20 }, + }, + }, + { + Name = "Itemclassfilterflags", + Type = "Enumeration", + NumValues = 18, + MinValue = 1, + MaxValue = 131072, + Fields = + { + { Name = "Consumable", Type = "Itemclassfilterflags", EnumValue = 1 }, + { Name = "Container", Type = "Itemclassfilterflags", EnumValue = 2 }, + { Name = "Weapon", Type = "Itemclassfilterflags", EnumValue = 4 }, + { Name = "Gem", Type = "Itemclassfilterflags", EnumValue = 8 }, + { Name = "Armor", Type = "Itemclassfilterflags", EnumValue = 16 }, + { Name = "Reagent", Type = "Itemclassfilterflags", EnumValue = 32 }, + { Name = "Projectile", Type = "Itemclassfilterflags", EnumValue = 64 }, + { Name = "Tradegoods", Type = "Itemclassfilterflags", EnumValue = 128 }, + { Name = "ItemEnhancement", Type = "Itemclassfilterflags", EnumValue = 256 }, + { Name = "Recipe", Type = "Itemclassfilterflags", EnumValue = 512 }, + { Name = "CurrencyTokenObsolete", Type = "Itemclassfilterflags", EnumValue = 1024 }, + { Name = "Quiver", Type = "Itemclassfilterflags", EnumValue = 2048 }, + { Name = "Questitemclassfilterflags", Type = "Itemclassfilterflags", EnumValue = 4096 }, + { Name = "Key", Type = "Itemclassfilterflags", EnumValue = 8192 }, + { Name = "PermanentObsolete", Type = "Itemclassfilterflags", EnumValue = 16384 }, + { Name = "Miscellaneous", Type = "Itemclassfilterflags", EnumValue = 32768 }, + { Name = "Glyph", Type = "Itemclassfilterflags", EnumValue = 65536 }, + { Name = "Battlepet", Type = "Itemclassfilterflags", EnumValue = 131072 }, + }, + }, + { + Name = "Itemsetflags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Legacy", Type = "Itemsetflags", EnumValue = 1 }, + { Name = "UseItemHistorySetSlots", Type = "Itemsetflags", EnumValue = 2 }, + { Name = "RequiresPvPTalentsActive", Type = "Itemsetflags", EnumValue = 4 }, + }, + }, + { + Name = "SleevesGeoRange", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "SleevesGeoRange", EnumValue = 0 }, + { Name = "Default", Type = "SleevesGeoRange", EnumValue = 1 }, + { Name = "Flared", Type = "SleevesGeoRange", EnumValue = 2 }, + { Name = "Puffy", Type = "SleevesGeoRange", EnumValue = 3 }, + { Name = "PandaCollar", Type = "SleevesGeoRange", EnumValue = 4 }, + }, + }, + { + Name = "SlotRegion", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Invalid", Type = "SlotRegion", EnumValue = 0 }, + { Name = "PlayerEquip", Type = "SlotRegion", EnumValue = 1 }, + { Name = "PlayerBags", Type = "SlotRegion", EnumValue = 2 }, + { Name = "PlayerInv", Type = "SlotRegion", EnumValue = 3 }, + { Name = "CharacterBank", Type = "SlotRegion", EnumValue = 4 }, + { Name = "AccountBank", Type = "SlotRegion", EnumValue = 5 }, + }, + }, + { + Name = "SlotRegionMask", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 64, + Fields = + { + { Name = "Invalid", Type = "SlotRegionMask", EnumValue = 1 }, + { Name = "PlayerEquip", Type = "SlotRegionMask", EnumValue = 2 }, + { Name = "PlayerBags", Type = "SlotRegionMask", EnumValue = 4 }, + { Name = "PlayerInv", Type = "SlotRegionMask", EnumValue = 8 }, + { Name = "CharacterBank", Type = "SlotRegionMask", EnumValue = 16 }, + { Name = "AccountBank", Type = "SlotRegionMask", EnumValue = 64 }, + }, + }, + { + Name = "SubcontainerType", + Type = "Enumeration", + NumValues = 40, + MinValue = 0, + MaxValue = 39, + Fields = + { + { Name = "Bag", Type = "SubcontainerType", EnumValue = 0 }, + { Name = "Equipped", Type = "SubcontainerType", EnumValue = 1 }, + { Name = "Bankgeneric", Type = "SubcontainerType", EnumValue = 2 }, + { Name = "Bankbag", Type = "SubcontainerType", EnumValue = 3 }, + { Name = "Mail", Type = "SubcontainerType", EnumValue = 4 }, + { Name = "Auction", Type = "SubcontainerType", EnumValue = 5 }, + { Name = "Keyring", Type = "SubcontainerType", EnumValue = 6 }, + { Name = "GuildBank0", Type = "SubcontainerType", EnumValue = 7 }, + { Name = "GuildBank1", Type = "SubcontainerType", EnumValue = 8 }, + { Name = "GuildBank2", Type = "SubcontainerType", EnumValue = 9 }, + { Name = "GuildBank3", Type = "SubcontainerType", EnumValue = 10 }, + { Name = "GuildBank4", Type = "SubcontainerType", EnumValue = 11 }, + { Name = "GuildBank5", Type = "SubcontainerType", EnumValue = 12 }, + { Name = "GuildOverflow", Type = "SubcontainerType", EnumValue = 13 }, + { Name = "Equipablespells", Type = "SubcontainerType", EnumValue = 14 }, + { Name = "CurrencytokenOboslete", Type = "SubcontainerType", EnumValue = 15 }, + { Name = "GuildBank6", Type = "SubcontainerType", EnumValue = 16 }, + { Name = "GuildBank7", Type = "SubcontainerType", EnumValue = 17 }, + { Name = "GuildBank8", Type = "SubcontainerType", EnumValue = 18 }, + { Name = "GuildBank9", Type = "SubcontainerType", EnumValue = 19 }, + { Name = "GuildBank10", Type = "SubcontainerType", EnumValue = 20 }, + { Name = "GuildBank11", Type = "SubcontainerType", EnumValue = 21 }, + { Name = "Reagentbank", Type = "SubcontainerType", EnumValue = 22 }, + { Name = "Childequipmentstorage", Type = "SubcontainerType", EnumValue = 23 }, + { Name = "Quarantine", Type = "SubcontainerType", EnumValue = 24 }, + { Name = "CreatedImmediately", Type = "SubcontainerType", EnumValue = 25 }, + { Name = "BuybackSlots", Type = "SubcontainerType", EnumValue = 26 }, + { Name = "CachedReward", Type = "SubcontainerType", EnumValue = 27 }, + { Name = "EquippedBags", Type = "SubcontainerType", EnumValue = 28 }, + { Name = "EquippedProfession1", Type = "SubcontainerType", EnumValue = 29 }, + { Name = "EquippedProfession2", Type = "SubcontainerType", EnumValue = 30 }, + { Name = "EquippedCooking", Type = "SubcontainerType", EnumValue = 31 }, + { Name = "EquippedFishing", Type = "SubcontainerType", EnumValue = 32 }, + { Name = "EquippedReagentbag", Type = "SubcontainerType", EnumValue = 33 }, + { Name = "CraftingOrder", Type = "SubcontainerType", EnumValue = 34 }, + { Name = "CraftingOrderReagents", Type = "SubcontainerType", EnumValue = 35 }, + { Name = "AccountBankTabs", Type = "SubcontainerType", EnumValue = 36 }, + { Name = "CurrencyTransfer", Type = "SubcontainerType", EnumValue = 37 }, + { Name = "CharacterBankTabs", Type = "SubcontainerType", EnumValue = 38 }, + { Name = "HousingDecorConversion", Type = "SubcontainerType", EnumValue = 39 }, + }, + }, + { + Name = "UIItemInteractionFlags", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 32, + Fields = + { + { Name = "DisplayWithInset", Type = "UIItemInteractionFlags", EnumValue = 1 }, + { Name = "ConfirmationHasDelay", Type = "UIItemInteractionFlags", EnumValue = 2 }, + { Name = "ConversionMode", Type = "UIItemInteractionFlags", EnumValue = 4 }, + { Name = "ClickShowsFlyout", Type = "UIItemInteractionFlags", EnumValue = 8 }, + { Name = "AddCurrency", Type = "UIItemInteractionFlags", EnumValue = 16 }, + { Name = "UsesCharges", Type = "UIItemInteractionFlags", EnumValue = 32 }, + }, + }, + { + Name = "UIItemInteractionType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "UIItemInteractionType", EnumValue = 0 }, + { Name = "CastSpell", Type = "UIItemInteractionType", EnumValue = 1 }, + { Name = "CleanseCorruption", Type = "UIItemInteractionType", EnumValue = 2 }, + { Name = "RunecarverScrapping", Type = "UIItemInteractionType", EnumValue = 3 }, + { Name = "ItemConversion", Type = "UIItemInteractionType", EnumValue = 4 }, + }, + }, + { + Name = "WeaponSlot", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "MainHand", Type = "WeaponSlot", EnumValue = 0 }, + { Name = "OffHand", Type = "WeaponSlot", EnumValue = 1 }, + }, + }, + { + Name = "ItemConsts", + Type = "Constants", + Values = + { + { Name = "NUM_ITEM_ENCHANTMENT_SOCKETS", Type = "number", Value = 3 }, + { Name = "MAX_LOOT_OBJECT_ITEMS", Type = "number", Value = 31 }, + { Name = "INVALID_BANK_TAB_SLOT", Type = "number", Value = 0xFF }, + { Name = "DEFAULT_ITEM_SAVE_VERSION", Type = "number", Value = 2 }, + { Name = "CURRENT_ITEM_SAVE_VERSION", Type = "number", Value = DEFAULT_ITEM_SAVE_VERSION }, + { Name = "DEFAULT_ARTIFACT_POWERS_VERSION", Type = "number", Value = 1 }, + { Name = "CURRENT_ARTIFACT_POWERS_VERSION", Type = "number", Value = DEFAULT_ARTIFACT_POWERS_VERSION }, + { Name = "DEFAULT_RETENTION", Type = "number", Value = 7 }, + }, + }, + { + Name = "ITEM_WEAPON_SUBCLASSConstants", + Type = "Constants", + Values = + { + { Name = "ITEM_WEAPON_SUBCLASS_NONE", Type = "ItemWeaponSubclass", Value = -1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ItemConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_MainlineDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_MainlineDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2e25b54 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_MainlineDocumentation.lua.annotated.lua @@ -0,0 +1,77 @@ +local ItemConstants_Mainline = +{ + Tables = + { + { + Name = "ItemGemSubclass", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Intellect", Type = "ItemGemSubclass", EnumValue = 0 }, + { Name = "Agility", Type = "ItemGemSubclass", EnumValue = 1 }, + { Name = "Strength", Type = "ItemGemSubclass", EnumValue = 2 }, + { Name = "Stamina", Type = "ItemGemSubclass", EnumValue = 3 }, + { Name = "Spirit", Type = "ItemGemSubclass", EnumValue = 4 }, + { Name = "Criticalstrike", Type = "ItemGemSubclass", EnumValue = 5 }, + { Name = "Mastery", Type = "ItemGemSubclass", EnumValue = 6 }, + { Name = "Haste", Type = "ItemGemSubclass", EnumValue = 7 }, + { Name = "Versatility", Type = "ItemGemSubclass", EnumValue = 8 }, + { Name = "Other", Type = "ItemGemSubclass", EnumValue = 9 }, + { Name = "Multiplestats", Type = "ItemGemSubclass", EnumValue = 10 }, + { Name = "Artifactrelic", Type = "ItemGemSubclass", EnumValue = 11 }, + }, + }, + { + Name = "ItemRedundancySlot", + Type = "Enumeration", + NumValues = 17, + MinValue = 0, + MaxValue = 16, + Fields = + { + { Name = "Head", Type = "ItemRedundancySlot", EnumValue = 0 }, + { Name = "Neck", Type = "ItemRedundancySlot", EnumValue = 1 }, + { Name = "Shoulder", Type = "ItemRedundancySlot", EnumValue = 2 }, + { Name = "Chest", Type = "ItemRedundancySlot", EnumValue = 3 }, + { Name = "Waist", Type = "ItemRedundancySlot", EnumValue = 4 }, + { Name = "Legs", Type = "ItemRedundancySlot", EnumValue = 5 }, + { Name = "Feet", Type = "ItemRedundancySlot", EnumValue = 6 }, + { Name = "Wrist", Type = "ItemRedundancySlot", EnumValue = 7 }, + { Name = "Hand", Type = "ItemRedundancySlot", EnumValue = 8 }, + { Name = "Finger", Type = "ItemRedundancySlot", EnumValue = 9 }, + { Name = "Trinket", Type = "ItemRedundancySlot", EnumValue = 10 }, + { Name = "Cloak", Type = "ItemRedundancySlot", EnumValue = 11 }, + { Name = "Twohand", Type = "ItemRedundancySlot", EnumValue = 12 }, + { Name = "MainhandWeapon", Type = "ItemRedundancySlot", EnumValue = 13 }, + { Name = "OnehandWeapon", Type = "ItemRedundancySlot", EnumValue = 14 }, + { Name = "OnehandWeaponSecond", Type = "ItemRedundancySlot", EnumValue = 15 }, + { Name = "Offhand", Type = "ItemRedundancySlot", EnumValue = 16 }, + }, + }, + { + Name = "InventoryConstants", + Type = "Constants", + Values = + { + { Name = "NumBagSlots", Type = "number", Value = NUM_BAG_SLOTS }, + { Name = "NumCharacterBankSlots", Type = "number", Value = NUM_CHARACTERBANK_SLOTS }, + { Name = "NumReagentBagSlots", Type = "number", Value = NUM_REAGENTBAG_SLOTS }, + { Name = "NumAccountBankSlots", Type = "number", Value = NUM_ACCOUNTBANK_SLOTS }, + { Name = "MAX_TRANSACTION_BANK_TABS", Type = "number", Value = 0 }, + }, + }, + { + Name = "ItemConsts_Mainline", + Type = "Constants", + Values = + { + { Name = "HWM_SQUISH_ERA_PLAYER_DATA_ACCOUNT_ELEMENT_ID", Type = "number", Value = 212 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ItemConstants_Mainline); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4bec94b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemConstants_SharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local ItemConstants_Shared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ItemConstants_Shared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0a95547 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemDocumentation.lua.annotated.lua @@ -0,0 +1,1917 @@ +local Item = +{ + Name = "Item", + Type = "System", + Namespace = "C_Item", + Environment = "All", + + Functions = + { + { + Name = "ActionBindsItem", + Type = "Function", + }, + { + Name = "BindEnchant", + Type = "Function", + }, + { + Name = "CanBeRefunded", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canBeRefunded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanItemTransmogAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canTransmog", Type = "bool", Nilable = false }, + { Name = "errorCode", Type = "TransmogOutfitSlotError", Nilable = false }, + }, + }, + { + Name = "CanScrapItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canBeScrapped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanViewItemPowers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isItemViewable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConfirmBindOnUse", + Type = "Function", + }, + { + Name = "ConfirmNoRefundOnUse", + Type = "Function", + }, + { + Name = "ConfirmOnUse", + Type = "Function", + }, + { + Name = "DoesItemContainSpec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesItemExist", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "emptiableItemLocation", Type = "EmptiableItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesItemExistByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesItemMatchBonusTreeReplacement", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "matchesBonusTree", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesItemMatchTargetEnchantingSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "matchesTargetEnchantingSpell", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesItemMatchTrackJump", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "matchesTrackJump", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DropItemOnUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitGUID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "EndBoundTradeable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EndRefund", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "number", Nilable = false }, + }, + }, + { + Name = "EquipItemByName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "dstSlot", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetAppliedItemTransmogInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = true }, + }, + }, + { + Name = "GetBaseItemTransmogInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = true }, + }, + }, + { + Name = "GetCurrentItemLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "currentItemLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrentItemTransmogInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ItemTransmogInfo", Mixin = "ItemTransmogInfoMixin", Nilable = true }, + }, + }, + { + Name = "GetDelvePreviewItemLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "context", Type = "ItemCreationContext", Nilable = false }, + }, + + Returns = + { + { Name = "itemLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetDelvePreviewItemQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "context", Type = "ItemCreationContext", Nilable = false }, + }, + + Returns = + { + { Name = "itemQuality", Type = "ItemQuality", Nilable = false }, + }, + }, + { + Name = "GetDetailedItemLevelInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "actualItemLevel", Type = "number", Nilable = false }, + { Name = "previewLevel", Type = "bool", Nilable = false }, + { Name = "sparseItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFirstTriggeredSpellForItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemQuality", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemChildInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "slotID", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetItemClassInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemClassID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemConversionOutputIcon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "GetItemCooldown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "startTimeSeconds", Type = "number", Nilable = false }, + { Name = "durationSeconds", Type = "number", Nilable = false }, + { Name = "enableCooldownTimer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "includeBank", Type = "bool", Nilable = false, Default = false }, + { Name = "includeUses", Type = "bool", Nilable = false, Default = false }, + { Name = "includeReagentBank", Type = "bool", Nilable = false, Default = false }, + { Name = "includeAccountBank", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemCreationContext", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "creationContext", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemFamily", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetItemGem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "hyperlink", Type = "cstring", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "gemName", Type = "string", Nilable = false }, + { Name = "gemLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemGemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "gemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemIDByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemIDForItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemIcon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "GetItemIconByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "GetItemInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemName", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "itemQuality", Type = "ItemQuality", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "itemMinLevel", Type = "number", Nilable = false }, + { Name = "itemType", Type = "cstring", Nilable = false }, + { Name = "itemSubType", Type = "cstring", Nilable = false }, + { Name = "itemStackCount", Type = "number", Nilable = false }, + { Name = "itemEquipLoc", Type = "cstring", Nilable = false }, + { Name = "itemTexture", Type = "fileID", Nilable = false }, + { Name = "sellPrice", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "subclassID", Type = "number", Nilable = false }, + { Name = "bindType", Type = "number", Nilable = false }, + { Name = "expansionID", Type = "number", Nilable = false }, + { Name = "setID", Type = "number", Nilable = true }, + { Name = "isCraftingReagent", Type = "bool", Nilable = false }, + { Name = "itemDescription", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemInfoInstant", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemType", Type = "cstring", Nilable = false }, + { Name = "itemSubType", Type = "cstring", Nilable = false }, + { Name = "itemEquipLoc", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "subClassID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemInventorySlotInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlot", Type = "InventoryType", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemInventorySlotKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlot", Type = "InventoryType", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemInventoryType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "inventoryType", Type = "InventoryType", Nilable = true }, + }, + }, + { + Name = "GetItemInventoryTypeByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "inventoryType", Type = "InventoryType", Nilable = true }, + }, + }, + { + Name = "GetItemLearnTransmogSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "setID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemLinkByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "itemLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemLocation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = true }, + }, + }, + { + Name = "GetItemMaxStackSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "stackSize", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemMaxStackSizeByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "stackSize", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemName", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemNameByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemName", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemNumAddedSockets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "socketCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemNumSockets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "socketCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemQuality", Type = "ItemQuality", Nilable = true }, + }, + }, + { + Name = "GetItemQualityByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemQuality", Type = "ItemQuality", Nilable = true }, + }, + }, + { + Name = "GetItemQualityColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + + Returns = + { + { Name = "colorRGBR", Type = "number", Nilable = false }, + { Name = "colorRGBG", Type = "number", Nilable = false }, + { Name = "colorRGBB", Type = "number", Nilable = false }, + { Name = "qualityString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemSetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemSpecInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "specTable", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetItemSpell", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "spellName", Type = "cstring", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemStatDelta", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLink1", Type = "cstring", Nilable = false }, + { Name = "itemLink2", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "statTable", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "GetItemStats", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "statTable", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "GetItemSubClassInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemClassID", Type = "number", Nilable = false }, + { Name = "itemSubClassID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "subClassName", Type = "cstring", Nilable = false }, + { Name = "subClassUsesInvType", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemUniqueness", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "limitCategory", Type = "number", Nilable = false }, + { Name = "limitMax", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemUniquenessByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isUnique", Type = "bool", Nilable = false }, + { Name = "limitCategoryName", Type = "cstring", Nilable = true }, + { Name = "limitCategoryCount", Type = "number", Nilable = true }, + { Name = "limitCategoryID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemUpgradeInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemUpgradeInfo", Type = "ItemUpgradeInfo", Nilable = true }, + }, + }, + { + Name = "GetLimitedCurrencyItemInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "maxQuantity", Type = "number", Nilable = false }, + { Name = "totalEarned", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSetBonusesForSpecializationByItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemSetSpellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetStackCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "stackCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsAnimaItemByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isAnimaItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsArtifactPowerItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBound", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isBound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBoundToAccountUntilEquip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "You can use IsItemBindToAccountUntilEquip instead if the item is not in your inventory" }, + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isBoundToAccountUntilEquip", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConsumableItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCorruptedItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsCosmeticItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsCurioItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the item is a consumable curio that can be applied to a delves companion." }, + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsCurrentItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDecorItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the item is a consumable decor item." }, + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isDecor", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsDressableItemByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isDressableItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippableItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedItemType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHarmfulItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHelpfulItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemBindToAccount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isItemBindToAccount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemBindToAccountUntilEquip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "You can use IsBoundToAccountUntilEquip instead if the item exists in your inventory" }, + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isItemBindToAccountUntilEquip", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemConduit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isConduit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemConvertibleAndValidForPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isItemConvertibleAndValidForPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemCorrupted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isCorrupted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemCorruptionRelated", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isCorruptionRelated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemCorruptionResistant", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isCorruptionResistant", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemDataCached", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isCached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemDataCachedByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isCached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemGUIDInInventory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemInRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "targetToken", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsItemKeystoneByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isKeystone", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemSpecificToPlayerClass", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isItemSpecificToPlayerClass", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRelicItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the item is a consumable relic that can be applied to an artifact weapon." }, + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsUsableItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "usable", Type = "bool", Nilable = false }, + { Name = "noMana", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemHasRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LockItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "LockItemByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PickupItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + }, + { + Name = "ReplaceEnchant", + Type = "Function", + }, + { + Name = "ReplaceTradeEnchant", + Type = "Function", + }, + { + Name = "ReplaceTradeskillEnchant", + Type = "Function", + }, + { + Name = "RequestLoadItemData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "RequestLoadItemDataByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + }, + { + Name = "UnlockItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "UnlockItemByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "UseItemByName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "target", Type = "cstring", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "ActionWillBindItem", + Type = "Event", + LiteralName = "ACTION_WILL_BIND_ITEM", + SynchronousEvent = true, + }, + { + Name = "BindEnchant", + Type = "Event", + LiteralName = "BIND_ENCHANT", + SynchronousEvent = true, + }, + { + Name = "CharacterItemFixupNotification", + Type = "Event", + LiteralName = "CHARACTER_ITEM_FIXUP_NOTIFICATION", + SynchronousEvent = true, + Payload = + { + { Name = "fixupVersion", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmBeforeUse", + Type = "Event", + LiteralName = "CONFIRM_BEFORE_USE", + SynchronousEvent = true, + }, + { + Name = "ConvertToBindToAccountConfirm", + Type = "Event", + LiteralName = "CONVERT_TO_BIND_TO_ACCOUNT_CONFIRM", + SynchronousEvent = true, + }, + { + Name = "DeleteItemConfirm", + Type = "Event", + LiteralName = "DELETE_ITEM_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "itemName", Type = "cstring", Nilable = false }, + { Name = "qualityID", Type = "number", Nilable = false }, + { Name = "bonding", Type = "number", Nilable = false }, + { Name = "questWarn", Type = "number", Nilable = false }, + }, + }, + { + Name = "EndBoundTradeable", + Type = "Event", + LiteralName = "END_BOUND_TRADEABLE", + SynchronousEvent = true, + Payload = + { + { Name = "reason", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemInfoReceived", + Type = "Event", + LiteralName = "GET_ITEM_INFO_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemChanged", + Type = "Event", + LiteralName = "ITEM_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "previousHyperlink", Type = "string", Nilable = false }, + { Name = "newHyperlink", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemConversionDataReady", + Type = "Event", + LiteralName = "ITEM_CONVERSION_DATA_READY", + SynchronousEvent = true, + Payload = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ItemCountChanged", + Type = "Event", + LiteralName = "ITEM_COUNT_CHANGED", + UniqueEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemDataLoadResult", + Type = "Event", + LiteralName = "ITEM_DATA_LOAD_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MerchantConfirmTradeTimerRemoval", + Type = "Event", + LiteralName = "MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL", + SynchronousEvent = true, + Payload = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ReplaceEnchant", + Type = "Event", + LiteralName = "REPLACE_ENCHANT", + SynchronousEvent = true, + Payload = + { + { Name = "existingStr", Type = "cstring", Nilable = false }, + { Name = "replacementStr", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ReplaceTradeskillEnchant", + Type = "Event", + LiteralName = "REPLACE_TRADESKILL_ENCHANT", + SynchronousEvent = true, + Payload = + { + { Name = "existing", Type = "cstring", Nilable = false }, + { Name = "replacement", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "TradeReplaceEnchant", + Type = "Event", + LiteralName = "TRADE_REPLACE_ENCHANT", + SynchronousEvent = true, + Payload = + { + { Name = "existing", Type = "cstring", Nilable = false }, + { Name = "replacement", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UseBindConfirm", + Type = "Event", + LiteralName = "USE_BIND_CONFIRM", + SynchronousEvent = true, + }, + { + Name = "UseNoRefundConfirm", + Type = "Event", + LiteralName = "USE_NO_REFUND_CONFIRM", + SynchronousEvent = true, + }, + { + Name = "WeaponEnchantChanged", + Type = "Event", + LiteralName = "WEAPON_ENCHANT_CHANGED", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "ItemInfoResult", + Type = "Structure", + Fields = + { + { Name = "itemName", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "itemQuality", Type = "ItemQuality", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "itemMinLevel", Type = "number", Nilable = false }, + { Name = "itemType", Type = "cstring", Nilable = false }, + { Name = "itemSubType", Type = "cstring", Nilable = false }, + { Name = "itemStackCount", Type = "number", Nilable = false }, + { Name = "itemEquipLoc", Type = "cstring", Nilable = false }, + { Name = "itemTexture", Type = "fileID", Nilable = false }, + { Name = "sellPrice", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "subclassID", Type = "number", Nilable = false }, + { Name = "bindType", Type = "number", Nilable = false }, + { Name = "expansionID", Type = "number", Nilable = false }, + { Name = "setID", Type = "number", Nilable = true }, + { Name = "isCraftingReagent", Type = "bool", Nilable = false }, + { Name = "itemDescription", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ItemUpgradeInfo", + Type = "Structure", + Fields = + { + { Name = "currentLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "maxItemLevel", Type = "number", Nilable = false }, + { Name = "trackString", Type = "cstring", Nilable = true }, + { Name = "trackStringID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Item); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8b09ba6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemInteractionUIDocumentation.lua.annotated.lua @@ -0,0 +1,156 @@ +local ItemInteractionUI = +{ + Name = "ItemInteractionUI", + Type = "System", + Namespace = "C_ItemInteraction", + Environment = "All", + + Functions = + { + { + Name = "ClearPendingItem", + Type = "Function", + }, + { + Name = "CloseUI", + Type = "Function", + }, + { + Name = "GetChargeInfo", + Type = "Function", + + Returns = + { + { Name = "chargeInfo", Type = "ItemInteractionChargeInfo", Nilable = false }, + }, + }, + { + Name = "GetItemConversionCurrencyCost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "conversionCost", Type = "ConversionCurrencyCost", Nilable = false }, + }, + }, + { + Name = "GetItemInteractionInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "ItemInteractionFrameInfo", Nilable = true }, + }, + }, + { + Name = "GetItemInteractionSpellId", + Type = "Function", + + Returns = + { + { Name = "spellId", Type = "number", Nilable = false }, + }, + }, + { + Name = "InitializeFrame", + Type = "Function", + }, + { + Name = "PerformItemInteraction", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "Reset", + Type = "Function", + }, + { + Name = "SetPendingItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ItemInteractionChargeInfoUpdated", + Type = "Event", + LiteralName = "ITEM_INTERACTION_CHARGE_INFO_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ItemInteractionItemSelectionUpdated", + Type = "Event", + LiteralName = "ITEM_INTERACTION_ITEM_SELECTION_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "ConversionCurrencyCost", + Type = "Structure", + Fields = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemInteractionChargeInfo", + Type = "Structure", + Fields = + { + { Name = "newChargeAmount", Type = "number", Nilable = false }, + { Name = "rechargeRate", Type = "number", Nilable = false }, + { Name = "timeToNextCharge", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemInteractionFrameInfo", + Type = "Structure", + Fields = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "openSoundKitID", Type = "number", Nilable = false }, + { Name = "closeSoundKitID", Type = "number", Nilable = false }, + { Name = "titleText", Type = "string", Nilable = false }, + { Name = "tutorialText", Type = "string", Nilable = false }, + { Name = "buttonText", Type = "string", Nilable = false }, + { Name = "interactionType", Type = "UIItemInteractionType", Nilable = false }, + { Name = "flags", Type = "UIItemInteractionFlags", Nilable = false }, + { Name = "description", Type = "string", Nilable = true }, + { Name = "buttonTooltip", Type = "string", Nilable = true }, + { Name = "confirmationDescription", Type = "string", Nilable = true }, + { Name = "slotTooltip", Type = "string", Nilable = true }, + { Name = "cost", Type = "number", Nilable = true }, + { Name = "currencyTypeId", Type = "number", Nilable = true }, + { Name = "dropInSlotSoundKitId", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ItemInteractionUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemQualitiesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemQualitiesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..23e1b57 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemQualitiesDocumentation.lua.annotated.lua @@ -0,0 +1,27 @@ +local ItemQualities = +{ + Tables = + { + { + Name = "ItemQuality", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Poor", Type = "ItemQuality", EnumValue = 0 }, + { Name = "Common", Type = "ItemQuality", EnumValue = 1 }, + { Name = "Uncommon", Type = "ItemQuality", EnumValue = 2 }, + { Name = "Rare", Type = "ItemQuality", EnumValue = 3 }, + { Name = "Epic", Type = "ItemQuality", EnumValue = 4 }, + { Name = "Legendary", Type = "ItemQuality", EnumValue = 5 }, + { Name = "Artifact", Type = "ItemQuality", EnumValue = 6 }, + { Name = "Heirloom", Type = "ItemQuality", EnumValue = 7 }, + { Name = "WoWToken", Type = "ItemQuality", EnumValue = 8 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ItemQualities); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e77ddde --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local ItemShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ItemShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..401f812 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemSocketInfoDocumentation.lua.annotated.lua @@ -0,0 +1,276 @@ +local ItemSocketInfo = +{ + Name = "ItemSocketInfo", + Type = "System", + Namespace = "C_ItemSocketInfo", + Environment = "All", + + Functions = + { + { + Name = "AcceptSockets", + Type = "Function", + }, + { + Name = "ClickSocketButton", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CloseSocketInfo", + Type = "Function", + }, + { + Name = "CompleteSocketing", + Type = "Function", + }, + { + Name = "GetCurrUIType", + Type = "Function", + + Returns = + { + { Name = "uiType", Type = "ItemSocketInfoUIType", Nilable = false }, + }, + }, + { + Name = "GetExistingSocketInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "gemMatchesSocket", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetExistingSocketLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "existingSocketLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetNewSocketInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "gemMatchesSocket", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNewSocketLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "newSocketLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetNumSockets", + Type = "Function", + + Returns = + { + { Name = "numSockets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSocketItemBoundTradeable", + Type = "Function", + + Returns = + { + { Name = "socketItemTradeable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSocketItemInfo", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + }, + { + Name = "GetSocketItemRefundable", + Type = "Function", + + Returns = + { + { Name = "socketItemRefundable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSocketTypes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "socketType", Type = "string", Nilable = true }, + }, + }, + { + Name = "HasBoundGemProposed", + Type = "Function", + + Returns = + { + { Name = "hasBoundGemProposed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsArtifactRelicItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "info", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isArtifactRelicItem", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SocketInfoAccept", + Type = "Event", + LiteralName = "SOCKET_INFO_ACCEPT", + SynchronousEvent = true, + }, + { + Name = "SocketInfoBindConfirm", + Type = "Event", + LiteralName = "SOCKET_INFO_BIND_CONFIRM", + SynchronousEvent = true, + }, + { + Name = "SocketInfoClose", + Type = "Event", + LiteralName = "SOCKET_INFO_CLOSE", + SynchronousEvent = true, + }, + { + Name = "SocketInfoFailure", + Type = "Event", + LiteralName = "SOCKET_INFO_FAILURE", + SynchronousEvent = true, + }, + { + Name = "SocketInfoRefundableConfirm", + Type = "Event", + LiteralName = "SOCKET_INFO_REFUNDABLE_CONFIRM", + SynchronousEvent = true, + }, + { + Name = "SocketInfoSuccess", + Type = "Event", + LiteralName = "SOCKET_INFO_SUCCESS", + SynchronousEvent = true, + }, + { + Name = "SocketInfoUiEventRegistrationUpdate", + Type = "Event", + LiteralName = "SOCKET_INFO_UI_EVENT_REGISTRATION_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "uiType", Type = "ItemSocketInfoUIType", Nilable = false }, + }, + }, + { + Name = "SocketInfoUpdate", + Type = "Event", + LiteralName = "SOCKET_INFO_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "ItemSocketInfoUIType", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "Default", Type = "ItemSocketInfoUIType", EnumValue = 0 }, + }, + }, + { + Name = "SocketInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "gemMatchesSocket", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SocketItemInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ItemSocketInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemTextDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemTextDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bd2fb35 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemTextDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local ItemText = +{ + Name = "ItemText", + Type = "System", + Namespace = "C_ItemText", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "ItemTextBegin", + Type = "Event", + LiteralName = "ITEM_TEXT_BEGIN", + SynchronousEvent = true, + }, + { + Name = "ItemTextClosed", + Type = "Event", + LiteralName = "ITEM_TEXT_CLOSED", + SynchronousEvent = true, + }, + { + Name = "ItemTextReady", + Type = "Event", + LiteralName = "ITEM_TEXT_READY", + SynchronousEvent = true, + }, + { + Name = "ItemTextTranslation", + Type = "Event", + LiteralName = "ITEM_TEXT_TRANSLATION", + SynchronousEvent = true, + Payload = + { + { Name = "delay", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ItemText); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua.annotated.lua new file mode 100644 index 0000000..abe7841 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ItemUpgradeDocumentation.lua.annotated.lua @@ -0,0 +1,308 @@ +local ItemUpgrade = +{ + Name = "ItemUpgrade", + Type = "System", + Namespace = "C_ItemUpgrade", + Environment = "All", + + Functions = + { + { + Name = "CanUpgradeItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearItemUpgrade", + Type = "Function", + }, + { + Name = "CloseItemUpgrade", + Type = "Function", + }, + { + Name = "GetHighWatermarkForItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false, Documentation = { "Item ID, Link, or Name" } }, + }, + + Returns = + { + { Name = "characterHighWatermark", Type = "number", Nilable = false }, + { Name = "accountHighWatermark", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHighWatermarkForSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemRedundancySlot", Type = "number", Nilable = false, Documentation = { "Must be an Enum.ItemRedundancySlot value" } }, + }, + + Returns = + { + { Name = "characterHighWatermark", Type = "number", Nilable = false }, + { Name = "accountHighWatermark", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHighWatermarkSlotForItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false, Documentation = { "Item ID, Link, or Name" } }, + }, + + Returns = + { + { Name = "itemRedundancySlot", Type = "number", Nilable = false, Documentation = { "Enum.ItemRedundancySlot value" } }, + }, + }, + { + Name = "GetItemHyperlink", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemUpgradeCurrentLevel", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "isPvpItemLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemUpgradeEffect", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "effectIndex", Type = "number", Nilable = false }, + { Name = "numUpgradeLevels", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "outBaseEffect", Type = "string", Nilable = false }, + { Name = "outUpgradedEffect", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetItemUpgradeItemInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemInfo", Type = "ItemUpgradeItemInfo", Nilable = false }, + }, + }, + { + Name = "GetItemUpgradePvpItemLevelDeltaValues", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "numUpgradeLevels", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currentPvPItemLevel", Type = "number", Nilable = false }, + { Name = "upgradedPvPItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumItemUpgradeEffects", + Type = "Function", + + Returns = + { + { Name = "numItemUpgradeEffects", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsItemBound", + Type = "Function", + + Returns = + { + { Name = "isBound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetItemUpgradeFromCursorItem", + Type = "Function", + }, + { + Name = "SetItemUpgradeFromLocation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemToSet", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "UpgradeItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "numUpgrades", Type = "number", Nilable = false, Default = 1 }, + }, + }, + }, + + Events = + { + { + Name = "ItemUpgradeFailed", + Type = "Event", + LiteralName = "ITEM_UPGRADE_FAILED", + SynchronousEvent = true, + }, + { + Name = "ItemUpgradeMasterSetItem", + Type = "Event", + LiteralName = "ITEM_UPGRADE_MASTER_SET_ITEM", + SynchronousEvent = true, + }, + { + Name = "ItemUpgradeMasterUpdate", + Type = "Event", + LiteralName = "ITEM_UPGRADE_MASTER_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "ItemUpgradeCostDiscountInfo", + Type = "Structure", + Fields = + { + { Name = "isDiscounted", Type = "bool", Nilable = false }, + { Name = "discountHighWatermark", Type = "number", Nilable = false }, + { Name = "isPartialTwoHandDiscount", Type = "bool", Nilable = false }, + { Name = "isAccountWideDiscount", Type = "bool", Nilable = false }, + { Name = "doesCurrentCharacterMeetHighWatermark", Type = "bool", Nilable = false, Documentation = { "Reflects whether current character meets discount's high watermark, even if discount itself is account-wide" } }, + }, + }, + { + Name = "ItemUpgradeCurrencyCost", + Type = "Structure", + Fields = + { + { Name = "cost", Type = "number", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "discountInfo", Type = "ItemUpgradeCostDiscountInfo", Nilable = false }, + }, + }, + { + Name = "ItemUpgradeItemCost", + Type = "Structure", + Fields = + { + { Name = "cost", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "discountInfo", Type = "ItemUpgradeCostDiscountInfo", Nilable = false }, + }, + }, + { + Name = "ItemUpgradeItemInfo", + Type = "Structure", + Fields = + { + { Name = "iconID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "itemUpgradeable", Type = "bool", Nilable = false }, + { Name = "displayQuality", Type = "number", Nilable = false }, + { Name = "highWatermarkSlot", Type = "number", Nilable = false }, + { Name = "currUpgrade", Type = "number", Nilable = false }, + { Name = "maxUpgrade", Type = "number", Nilable = false }, + { Name = "minItemLevel", Type = "number", Nilable = false }, + { Name = "maxItemLevel", Type = "number", Nilable = false }, + { Name = "upgradeLevelInfos", Type = "table", InnerType = "ItemUpgradeLevelInfo", Nilable = false }, + { Name = "customUpgradeString", Type = "string", Nilable = true }, + { Name = "upgradeCostTypesForSeason", Type = "table", InnerType = "ItemUpgradeSeasonalCostType", Nilable = false }, + }, + }, + { + Name = "ItemUpgradeLevelInfo", + Type = "Structure", + Fields = + { + { Name = "upgradeLevel", Type = "number", Nilable = false }, + { Name = "displayQuality", Type = "number", Nilable = false }, + { Name = "itemLevelIncrement", Type = "number", Nilable = false }, + { Name = "levelStats", Type = "table", InnerType = "ItemUpgradeStat", Nilable = false }, + { Name = "currencyCostsToUpgrade", Type = "table", InnerType = "ItemUpgradeCurrencyCost", Nilable = false }, + { Name = "itemCostsToUpgrade", Type = "table", InnerType = "ItemUpgradeItemCost", Nilable = false }, + { Name = "moneyCost", Type = "WOWMONEY", Nilable = true }, + { Name = "failureMessage", Type = "string", Nilable = true }, + }, + }, + { + Name = "ItemUpgradeSeasonalCostType", + Type = "Structure", + Documentation = { "Costs are made up of either an Item OR a Currency, so either itemID or currencyID will be nil" }, + Fields = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "currencyID", Type = "number", Nilable = true }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "sourceString", Type = "string", Nilable = true }, + }, + }, + { + Name = "ItemUpgradeStat", + Type = "Structure", + Fields = + { + { Name = "displayString", Type = "string", Nilable = false }, + { Name = "statValue", Type = "number", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ItemUpgrade); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2b78b80 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/KeyBindingsDocumentation.lua.annotated.lua @@ -0,0 +1,254 @@ +local KeyBindings = +{ + Name = "KeyBindings", + Type = "System", + Namespace = "C_KeyBindings", + Environment = "All", + + Functions = + { + { + Name = "ActivateBindingContext", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "newContext", Type = "BindingContext", Nilable = false }, + }, + }, + { + Name = "DeactivateBindingContext", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "context", Type = "BindingContext", Nilable = false }, + }, + }, + { + Name = "GetBindingByKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "action", Type = "cstring", Nilable = false }, + { Name = "context", Type = "BindingContext", Nilable = true }, + }, + + Returns = + { + { Name = "binding", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetBindingContextForAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "action", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "context", Type = "BindingContext", Nilable = true }, + }, + }, + { + Name = "GetBindingIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "action", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "bindingIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetCustomBindingType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bindingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "customBindingType", Type = "CustomBindingType", Nilable = true }, + }, + }, + { + Name = "GetSearchTagsForAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "action", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "searchTags", Type = "table", InnerType = "string", Nilable = true }, + }, + }, + { + Name = "GetTurnStrafeStyle", + Type = "Function", + + Returns = + { + { Name = "style", Type = "TurnStrafeStyle", Nilable = false }, + }, + }, + { + Name = "IsBindingContextActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "context", Type = "BindingContext", Nilable = false }, + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTurnStrafeStyle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Can only set to Modern or Legacy." }, + + Arguments = + { + { Name = "style", Type = "TurnStrafeStyle", Nilable = false }, + }, + }, + { + Name = "UpdateTurnStrafeBindingsForCharacter", + Type = "Function", + }, + }, + + Events = + { + { + Name = "BindingsLoaded", + Type = "Event", + LiteralName = "BINDINGS_LOADED", + SynchronousEvent = true, + }, + { + Name = "ModifierStateChanged", + Type = "Event", + LiteralName = "MODIFIER_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "key", Type = "cstring", Nilable = false }, + { Name = "down", Type = "number", Nilable = false }, + }, + }, + { + Name = "NotifyTurnStrafeChange", + Type = "Event", + LiteralName = "NOTIFY_TURN_STRAFE_CHANGE", + SynchronousEvent = true, + }, + { + Name = "UpdateBindings", + Type = "Event", + LiteralName = "UPDATE_BINDINGS", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "BindingContext", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "None", Type = "BindingContext", EnumValue = 0 }, + { Name = "HousingEditor", Type = "BindingContext", EnumValue = 1 }, + { Name = "HousingEditorBasicDecorMode", Type = "BindingContext", EnumValue = 2 }, + { Name = "HousingEditorExpertDecorMode", Type = "BindingContext", EnumValue = 3 }, + { Name = "HousingEditorCustomizeMode", Type = "BindingContext", EnumValue = 4 }, + { Name = "HousingEditorCleanupMode", Type = "BindingContext", EnumValue = 5 }, + { Name = "HousingEditorLayoutMode", Type = "BindingContext", EnumValue = 6 }, + { Name = "HousingEditorBasicAndExpertDecorMode", Type = "BindingContext", EnumValue = 7 }, + { Name = "HousingEditorExteriorCustomizationMode", Type = "BindingContext", EnumValue = 8 }, + { Name = "ReservedFutureFeatureBinding01", Type = "BindingContext", EnumValue = 9 }, + }, + }, + { + Name = "BindingSet", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Default", Type = "BindingSet", EnumValue = 0 }, + { Name = "Account", Type = "BindingSet", EnumValue = 1 }, + { Name = "Character", Type = "BindingSet", EnumValue = 2 }, + { Name = "Current", Type = "BindingSet", EnumValue = 3 }, + }, + }, + { + Name = "CustomBindingType", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "VoicePushToTalk", Type = "CustomBindingType", EnumValue = 0 }, + }, + }, + { + Name = "TurnStrafeStyle", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Modern", Type = "TurnStrafeStyle", EnumValue = 0 }, + { Name = "Legacy", Type = "TurnStrafeStyle", EnumValue = 1 }, + { Name = "Custom", Type = "TurnStrafeStyle", EnumValue = 2 }, + }, + }, + { + Name = "InputCommandCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "keystate", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(KeyBindings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0d06b6c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,154 @@ +local LFGConstants = +{ + Tables = + { + { + Name = "LFGEntryGeneralPlaystyle", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "LFGEntryGeneralPlaystyle", EnumValue = 0 }, + { Name = "Learning", Type = "LFGEntryGeneralPlaystyle", EnumValue = 1 }, + { Name = "FunRelaxed", Type = "LFGEntryGeneralPlaystyle", EnumValue = 2 }, + { Name = "FunSerious", Type = "LFGEntryGeneralPlaystyle", EnumValue = 3 }, + { Name = "Expert", Type = "LFGEntryGeneralPlaystyle", EnumValue = 4 }, + }, + }, + { + Name = "LFGEntryPlaystyle", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "LFGEntryPlaystyle", EnumValue = 0 }, + { Name = "Standard", Type = "LFGEntryPlaystyle", EnumValue = 1 }, + { Name = "Casual", Type = "LFGEntryPlaystyle", EnumValue = 2 }, + { Name = "Hardcore", Type = "LFGEntryPlaystyle", EnumValue = 3 }, + }, + }, + { + Name = "LFGListDisplayType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "RoleCount", Type = "LFGListDisplayType", EnumValue = 0 }, + { Name = "RoleEnumerate", Type = "LFGListDisplayType", EnumValue = 1 }, + { Name = "ClassEnumerate", Type = "LFGListDisplayType", EnumValue = 2 }, + { Name = "HideAll", Type = "LFGListDisplayType", EnumValue = 3 }, + { Name = "PlayerCount", Type = "LFGListDisplayType", EnumValue = 4 }, + { Name = "Comment", Type = "LFGListDisplayType", EnumValue = 5 }, + }, + }, + { + Name = "LFGListFilter", + Type = "Enumeration", + NumValues = 8, + MinValue = 1, + MaxValue = 128, + Fields = + { + { Name = "Recommended", Type = "LFGListFilter", EnumValue = 1 }, + { Name = "NotRecommended", Type = "LFGListFilter", EnumValue = 2 }, + { Name = "PvE", Type = "LFGListFilter", EnumValue = 4 }, + { Name = "PvP", Type = "LFGListFilter", EnumValue = 8 }, + { Name = "Timerunning", Type = "LFGListFilter", EnumValue = 16 }, + { Name = "CurrentExpansion", Type = "LFGListFilter", EnumValue = 32 }, + { Name = "CurrentSeason", Type = "LFGListFilter", EnumValue = 64 }, + { Name = "NotCurrentSeason", Type = "LFGListFilter", EnumValue = 128 }, + }, + }, + { + Name = "LFGRole", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Tank", Type = "LFGRole", EnumValue = 0 }, + { Name = "Healer", Type = "LFGRole", EnumValue = 1 }, + { Name = "Damage", Type = "LFGRole", EnumValue = 2 }, + }, + }, + { + Name = "LFGSlotInvalidReason", + Type = "Enumeration", + NumValues = 20, + MinValue = 0, + MaxValue = 19, + Fields = + { + { Name = "None", Type = "LFGSlotInvalidReason", EnumValue = 0 }, + { Name = "ExpansionTooLow", Type = "LFGSlotInvalidReason", EnumValue = 1 }, + { Name = "LevelTooLow", Type = "LFGSlotInvalidReason", EnumValue = 2 }, + { Name = "LevelTooHigh", Type = "LFGSlotInvalidReason", EnumValue = 3 }, + { Name = "GearTooLow", Type = "LFGSlotInvalidReason", EnumValue = 4 }, + { Name = "GearTooHigh", Type = "LFGSlotInvalidReason", EnumValue = 5 }, + { Name = "RaidLocked", Type = "LFGSlotInvalidReason", EnumValue = 6 }, + { Name = "LevelTargetTooLow", Type = "LFGSlotInvalidReason", EnumValue = 7 }, + { Name = "LevelTargetTooHigh", Type = "LFGSlotInvalidReason", EnumValue = 8 }, + { Name = "AreaNotExplored", Type = "LFGSlotInvalidReason", EnumValue = 9 }, + { Name = "WrongFaction", Type = "LFGSlotInvalidReason", EnumValue = 10 }, + { Name = "NoValidRoles", Type = "LFGSlotInvalidReason", EnumValue = 11 }, + { Name = "EngagedInPvP", Type = "LFGSlotInvalidReason", EnumValue = 12 }, + { Name = "NoSpec", Type = "LFGSlotInvalidReason", EnumValue = 13 }, + { Name = "CannotRunAnyChildDungeon", Type = "LFGSlotInvalidReason", EnumValue = 14 }, + { Name = "Restricted", Type = "LFGSlotInvalidReason", EnumValue = 15 }, + { Name = "ChromieTime", Type = "LFGSlotInvalidReason", EnumValue = 16 }, + { Name = "Npe", Type = "LFGSlotInvalidReason", EnumValue = 17 }, + { Name = "Timerunning", Type = "LFGSlotInvalidReason", EnumValue = 18 }, + { Name = "PlayerConditionFailed", Type = "LFGSlotInvalidReason", EnumValue = 19 }, + }, + }, + { + Name = "PremadeGroupFinderStyle", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Disabled", Type = "PremadeGroupFinderStyle", EnumValue = 0 }, + { Name = "Mainline", Type = "PremadeGroupFinderStyle", EnumValue = 1 }, + { Name = "Vanilla", Type = "PremadeGroupFinderStyle", EnumValue = 2 }, + }, + }, + { + Name = "LFGConstsExposed", + Type = "Constants", + Values = + { + { Name = "GROUP_FINDER_MAX_ACTIVITY_CAPACITY", Type = "number", Value = 16 }, + }, + }, + { + Name = "LFG_ROLEConstants", + Type = "Constants", + Values = + { + { Name = "LFG_ROLE_NO_ROLE", Type = "LFGRole", Value = -1 }, + { Name = "LFG_ROLE_ANY", Type = "LFGRole", Value = Enum.LFGRoleMeta.NumValues }, + }, + }, + { + Name = "LFGRoles", + Type = "Structure", + Fields = + { + { Name = "tank", Type = "bool", Nilable = false }, + { Name = "healer", Type = "bool", Nilable = false }, + { Name = "dps", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LFGConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c3d4e6c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGInfoDocumentation.lua.annotated.lua @@ -0,0 +1,517 @@ +local LFGInfo = +{ + Name = "LFGInfo", + Type = "System", + Namespace = "C_LFGInfo", + Environment = "All", + + Functions = + { + { + Name = "AreCrossFactionGroupQueuesAllowed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lfgDungeonID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "areCrossFactionGroupQueuesAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseGroupFinder", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseLFD", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseLFR", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUsePVP", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUsePremadeGroup", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseScenarioFinder", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "ConfirmLfgExpandSearch", + Type = "Function", + }, + { + Name = "DoesActivePartyMeetPremadeLaunchCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lfgDungeonID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "doesActivePartyMeetPremadeLaunchCount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesCrossFactionQueueRequireFullPremade", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lfgDungeonID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "doesCrossFactionQueueRequireFullPremade", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAllEntriesForCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "lfgDungeonIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetDungeonInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "lfgDungeonID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dungeonInfo", Type = "LFGDungeonInfo", Nilable = false }, + }, + }, + { + Name = "GetLFDLockStates", + Type = "Function", + + Returns = + { + { Name = "lockInfo", Type = "table", InnerType = "LFGLockInfo", Nilable = false }, + }, + }, + { + Name = "GetLevelUpInstances", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currPlayerLevel", Type = "number", Nilable = false }, + { Name = "isRaid", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "instances", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRoleCheckDifficultyDetails", + Type = "Function", + + Returns = + { + { Name = "maxLevel", Type = "number", Nilable = true }, + { Name = "isLevelReduced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HideNameFromUI", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dungeonID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "shouldHide", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGroupFinderEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInLFGFollowerDungeon", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLFDEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLFGFollowerDungeon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dungeonID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLFREnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "IslandCompleted", + Type = "Event", + LiteralName = "ISLAND_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "winner", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgBootProposalUpdate", + Type = "Event", + LiteralName = "LFG_BOOT_PROPOSAL_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgCompletionReward", + Type = "Event", + LiteralName = "LFG_COMPLETION_REWARD", + SynchronousEvent = true, + }, + { + Name = "LfgCooldownsUpdated", + Type = "Event", + LiteralName = "LFG_COOLDOWNS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "LfgEnabledStateChanged", + Type = "Event", + LiteralName = "LFG_ENABLED_STATE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "LfgInvalidErrorMessage", + Type = "Event", + LiteralName = "LFG_INVALID_ERROR_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "reason", Type = "number", Nilable = false }, + { Name = "subReason1", Type = "number", Nilable = false }, + { Name = "subReason2", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgLockInfoReceived", + Type = "Event", + LiteralName = "LFG_LOCK_INFO_RECEIVED", + SynchronousEvent = true, + }, + { + Name = "LfgOfferContinue", + Type = "Event", + LiteralName = "LFG_OFFER_CONTINUE", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "lfgDungeonsID", Type = "number", Nilable = false }, + { Name = "typeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgOpenFromGossip", + Type = "Event", + LiteralName = "LFG_OPEN_FROM_GOSSIP", + SynchronousEvent = true, + Payload = + { + { Name = "dungeonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgProposalDone", + Type = "Event", + LiteralName = "LFG_PROPOSAL_DONE", + SynchronousEvent = true, + }, + { + Name = "LfgProposalFailed", + Type = "Event", + LiteralName = "LFG_PROPOSAL_FAILED", + SynchronousEvent = true, + }, + { + Name = "LfgProposalShow", + Type = "Event", + LiteralName = "LFG_PROPOSAL_SHOW", + SynchronousEvent = true, + }, + { + Name = "LfgProposalSucceeded", + Type = "Event", + LiteralName = "LFG_PROPOSAL_SUCCEEDED", + SynchronousEvent = true, + }, + { + Name = "LfgProposalUpdate", + Type = "Event", + LiteralName = "LFG_PROPOSAL_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgQueueStatusUpdate", + Type = "Event", + LiteralName = "LFG_QUEUE_STATUS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgReadyCheckDeclined", + Type = "Event", + LiteralName = "LFG_READY_CHECK_DECLINED", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LfgReadyCheckHide", + Type = "Event", + LiteralName = "LFG_READY_CHECK_HIDE", + SynchronousEvent = true, + }, + { + Name = "LfgReadyCheckPlayerIsReady", + Type = "Event", + LiteralName = "LFG_READY_CHECK_PLAYER_IS_READY", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LfgReadyCheckShow", + Type = "Event", + LiteralName = "LFG_READY_CHECK_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "isRequeue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LfgReadyCheckUpdate", + Type = "Event", + LiteralName = "LFG_READY_CHECK_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgRoleCheckDeclined", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_DECLINED", + SynchronousEvent = true, + }, + { + Name = "LfgRoleCheckHide", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_HIDE", + SynchronousEvent = true, + }, + { + Name = "LfgRoleCheckRoleChosen", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_ROLE_CHOSEN", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isTank", Type = "bool", Nilable = false }, + { Name = "isHealer", Type = "bool", Nilable = false }, + { Name = "isDamage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LfgRoleCheckShow", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "isRequeue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LfgRoleCheckUpdate", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgRoleUpdate", + Type = "Event", + LiteralName = "LFG_ROLE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgUpdate", + Type = "Event", + LiteralName = "LFG_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgUpdateRandomInfo", + Type = "Event", + LiteralName = "LFG_UPDATE_RANDOM_INFO", + SynchronousEvent = true, + }, + { + Name = "ShowLfgExpandSearchPrompt", + Type = "Event", + LiteralName = "SHOW_LFG_EXPAND_SEARCH_PROMPT", + SynchronousEvent = true, + }, + { + Name = "UpdateLfgList", + Type = "Event", + LiteralName = "UPDATE_LFG_LIST", + SynchronousEvent = true, + }, + { + Name = "WarfrontCompleted", + Type = "Event", + LiteralName = "WARFRONT_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "winner", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "LFGDungeonInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconID", Type = "fileID", Nilable = false }, + { Name = "link", Type = "string", Nilable = true }, + }, + }, + { + Name = "LFGLockInfo", + Type = "Structure", + Fields = + { + { Name = "lfgID", Type = "number", Nilable = false }, + { Name = "reason", Type = "number", Nilable = false }, + { Name = "hideEntry", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LFGInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fe8ba54 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LFGListInfoDocumentation.lua.annotated.lua @@ -0,0 +1,990 @@ +local LFGListInfo = +{ + Name = "LFGList", + Type = "System", + Namespace = "C_LFGList", + Environment = "All", + + Functions = + { + { + Name = "CanActiveEntryUseAutoAccept", + Type = "Function", + + Returns = + { + { Name = "canUseAutoAccept", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanCreateQuestGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canCreate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanCreateScenarioGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scenarioID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canCreate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearApplicationTextFields", + Type = "Function", + }, + { + Name = "ClearCreationTextFields", + Type = "Function", + }, + { + Name = "ClearSearchTextFields", + Type = "Function", + }, + { + Name = "CopyActiveEntryInfoToCreationFields", + Type = "Function", + }, + { + Name = "CreateListing", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "createData", Type = "LfgListingCreateData", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CreateScenarioListing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "autoAccept", Type = "bool", Nilable = false }, + { Name = "privateGroup", Type = "bool", Nilable = false }, + { Name = "scenarioID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canCreate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesEntryTitleMatchPrebuiltTitle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "playstyle", Type = "LFGEntryPlaystyle", Nilable = true }, + { Name = "generalPlaystyle", Type = "LFGEntryGeneralPlaystyle", Nilable = true }, + }, + + Returns = + { + { Name = "matches", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActiveEntryInfo", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + + Returns = + { + { Name = "entryData", Type = "LfgEntryData", Nilable = false }, + }, + }, + { + Name = "GetActivityFullName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "showWarmode", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "fullName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActivityGroupInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActivityInfoTable", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "showWarmode", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "activityInfo", Type = "GroupFinderActivityInfo", Nilable = false }, + }, + }, + { + Name = "GetAdvancedFilter", + Type = "Function", + + Returns = + { + { Name = "options", Type = "AdvancedFilterOptions", Nilable = false }, + }, + }, + { + Name = "GetApplicantBestDungeonScore", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "localID", Type = "number", Nilable = false }, + { Name = "applicantIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "bestDungeonScoreForListing", Type = "BestDungeonScoreMapInfo", Nilable = false }, + }, + }, + { + Name = "GetApplicantDungeonScoreForListing", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "localID", Type = "number", Nilable = false }, + { Name = "applicantIndex", Type = "luaIndex", Nilable = false }, + { Name = "activityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "bestDungeonScoreForListing", Type = "BestDungeonScoreMapInfo", Nilable = false }, + }, + }, + { + Name = "GetApplicantInfo", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "applicantID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "applicantData", Type = "LfgApplicantData", Nilable = false }, + }, + }, + { + Name = "GetApplicantPvpRatingInfoForListing", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "localID", Type = "number", Nilable = false }, + { Name = "applicantIndex", Type = "luaIndex", Nilable = false }, + { Name = "activityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pvpRatingInfo", Type = "PvpRatingInfo", Nilable = false }, + }, + }, + { + Name = "GetAvailableActivityGroups", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "filter", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetFilteredSearchResults", + Type = "Function", + + Returns = + { + { Name = "totalResultsFound", Type = "number", Nilable = false, Default = 0 }, + { Name = "filteredResults", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetGroupLeaverCountsByRole", + Type = "Function", + + Returns = + { + { Name = "tankLeavers", Type = "number", Nilable = false }, + { Name = "healerLeavers", Type = "number", Nilable = false }, + { Name = "damageLeavers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetKeystoneForActivity", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLfgCategoryInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categoryData", Type = "LfgCategoryData", Nilable = false }, + }, + }, + { + Name = "GetOwnedKeystoneActivityAndGroupAndLevel", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "getTimewalking", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "keystoneLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlaystyleString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playstyle", Type = "LFGEntryPlaystyle", Nilable = false }, + { Name = "generalPlaystyle", Type = "LFGEntryGeneralPlaystyle", Nilable = false }, + { Name = "activityInfo", Type = "GroupFinderActivityInfo", Nilable = false }, + }, + + Returns = + { + { Name = "playstyleString", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPremadeGroupFinderStyle", + Type = "Function", + + Returns = + { + { Name = "style", Type = "PremadeGroupFinderStyle", Nilable = false }, + }, + }, + { + Name = "GetSearchResultInfo", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "searchResultData", Type = "LfgSearchResultData", Nilable = false }, + }, + }, + { + Name = "GetSearchResultLeaderInfo", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "leaderInfo", Type = "LfgSearchResultPlayerInfo", Nilable = false }, + }, + }, + { + Name = "GetSearchResultPlayerInfo", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + { Name = "memberIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "playerInfo", Type = "LfgSearchResultPlayerInfo", Nilable = false }, + }, + }, + { + Name = "GetSearchResults", + Type = "Function", + + Returns = + { + { Name = "totalResultsFound", Type = "number", Nilable = false, Default = 0 }, + { Name = "results", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "HasActiveEntryInfo", + Type = "Function", + + Returns = + { + { Name = "hasActiveEntryInfo", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSearchResultInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasSearchResultInfo", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerAuthenticatedForLFG", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityCategoryID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "isAuthenticated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerValidForEndgameFieldEdits", + Type = "Function", + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPremadeGroupFinderEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ListingUsesEndgameEditRestrictions", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isEndgameListing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReportGroupAsAdvertisement", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SaveAdvancedFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "options", Type = "AdvancedFilterOptions", Nilable = false }, + }, + }, + { + Name = "Search", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "filter", Type = "number", Nilable = false, Default = 0 }, + { Name = "preferredFilters", Type = "number", Nilable = false, Default = 0 }, + { Name = "languageFilter", Type = "WowLocale", Nilable = true }, + { Name = "searchCrossFactionListings", Type = "bool", Nilable = true, Default = false }, + { Name = "advancedFilter", Type = "AdvancedFilterOptions", Nilable = true }, + { Name = "activityIDsFilter", Type = "table", InnerType = "number", Nilable = true, Documentation = { "Activity IDs to filter by." } }, + }, + }, + { + Name = "SetEntryTitle", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "playstyle", Type = "LFGEntryPlaystyle", Nilable = true }, + { Name = "generalPlaystyle", Type = "LFGEntryGeneralPlaystyle", Nilable = true }, + }, + }, + { + Name = "SetSearchToActivity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSearchToQuestID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSearchToScenarioID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scenarioID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateListing", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "createData", Type = "LfgListingCreateData", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ValidateRequiredDungeonScore", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dungeonScore", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "passes", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ValidateRequiredPvpRatingForActivity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "rating", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "passes", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "LfgGroupDelistedLeadershipChange", + Type = "Event", + LiteralName = "LFG_GROUP_DELISTED_LEADERSHIP_CHANGE", + SynchronousEvent = true, + Payload = + { + { Name = "listingName", Type = "string", Nilable = false }, + { Name = "automaticDelistTimeRemaining", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgListActiveEntryUpdate", + Type = "Event", + LiteralName = "LFG_LIST_ACTIVE_ENTRY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "created", Type = "bool", Nilable = true }, + }, + }, + { + Name = "LfgListApplicantListUpdated", + Type = "Event", + LiteralName = "LFG_LIST_APPLICANT_LIST_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "newPendingEntry", Type = "bool", Nilable = true }, + { Name = "newPendingEntryWithData", Type = "bool", Nilable = true }, + }, + }, + { + Name = "LfgListApplicantUpdated", + Type = "Event", + LiteralName = "LFG_LIST_APPLICANT_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "applicantID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgListApplicationStatusUpdated", + Type = "Event", + LiteralName = "LFG_LIST_APPLICATION_STATUS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + { Name = "newStatus", Type = "cstring", Nilable = false }, + { Name = "oldStatus", Type = "cstring", Nilable = false }, + { Name = "groupName", Type = "kstringLfgListChat", Nilable = false }, + }, + }, + { + Name = "LfgListAvailabilityUpdate", + Type = "Event", + LiteralName = "LFG_LIST_AVAILABILITY_UPDATE", + SynchronousEvent = true, + }, + { + Name = "LfgListEntryCreationFailed", + Type = "Event", + LiteralName = "LFG_LIST_ENTRY_CREATION_FAILED", + SynchronousEvent = true, + }, + { + Name = "LfgListEntryExpiredTimeout", + Type = "Event", + LiteralName = "LFG_LIST_ENTRY_EXPIRED_TIMEOUT", + SynchronousEvent = true, + }, + { + Name = "LfgListEntryExpiredTooManyPlayers", + Type = "Event", + LiteralName = "LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS", + SynchronousEvent = true, + }, + { + Name = "LfgListJoinedGroup", + Type = "Event", + LiteralName = "LFG_LIST_JOINED_GROUP", + SynchronousEvent = true, + Payload = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + { Name = "groupName", Type = "kstringLfgListChat", Nilable = false }, + }, + }, + { + Name = "LfgListSearchFailed", + Type = "Event", + LiteralName = "LFG_LIST_SEARCH_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "reason", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "LfgListSearchResultUpdated", + Type = "Event", + LiteralName = "LFG_LIST_SEARCH_RESULT_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgListSearchResultsReceived", + Type = "Event", + LiteralName = "LFG_LIST_SEARCH_RESULTS_RECEIVED", + SynchronousEvent = true, + }, + { + Name = "LfgListUpdateSearchResults", + Type = "Event", + LiteralName = "LFG_LIST_UPDATE_SEARCH_RESULTS", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "AdvancedFilterOptions", + Type = "Structure", + Fields = + { + { Name = "needsTank", Type = "bool", Nilable = false, Default = false }, + { Name = "needsHealer", Type = "bool", Nilable = false, Default = false }, + { Name = "needsDamage", Type = "bool", Nilable = false, Default = false }, + { Name = "needsMyClass", Type = "bool", Nilable = false, Default = false }, + { Name = "hasTank", Type = "bool", Nilable = false, Default = false }, + { Name = "hasHealer", Type = "bool", Nilable = false, Default = false }, + { Name = "activities", Type = "table", InnerType = "number", Nilable = false, Documentation = { "Activity group IDs to filter by." } }, + { Name = "minimumRating", Type = "number", Nilable = false, Default = 0 }, + { Name = "difficultyNormal", Type = "bool", Nilable = false, Default = false }, + { Name = "difficultyHeroic", Type = "bool", Nilable = false, Default = false }, + { Name = "difficultyMythic", Type = "bool", Nilable = false, Default = false }, + { Name = "difficultyMythicPlus", Type = "bool", Nilable = false, Default = false }, + { Name = "generalPlaystyle1", Type = "bool", Nilable = false, Default = false }, + { Name = "generalPlaystyle2", Type = "bool", Nilable = false, Default = false }, + { Name = "generalPlaystyle3", Type = "bool", Nilable = false, Default = false }, + { Name = "generalPlaystyle4", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "BestDungeonScoreMapInfo", + Type = "Structure", + Fields = + { + { Name = "mapScore", Type = "number", Nilable = false }, + { Name = "mapName", Type = "string", Nilable = false }, + { Name = "bestRunLevel", Type = "number", Nilable = false }, + { Name = "finishedSuccess", Type = "bool", Nilable = false }, + { Name = "bestRunDurationMs", Type = "number", Nilable = false }, + { Name = "bestLevelIncrement", Type = "number", Nilable = false }, + }, + }, + { + Name = "GroupFinderActivityInfo", + Type = "Structure", + Fields = + { + { Name = "fullName", Type = "string", Nilable = false }, + { Name = "shortName", Type = "string", Nilable = false }, + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "groupFinderActivityGroupID", Type = "number", Nilable = false }, + { Name = "ilvlSuggestion", Type = "number", Nilable = false }, + { Name = "filters", Type = "number", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "minLevelSuggestion", Type = "number", Nilable = false }, + { Name = "maxLevelSuggestion", Type = "number", Nilable = false }, + { Name = "maxNumPlayers", Type = "number", Nilable = false }, + { Name = "displayType", Type = "LFGListDisplayType", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "useHonorLevel", Type = "bool", Nilable = false }, + { Name = "showQuickJoinToast", Type = "bool", Nilable = false }, + { Name = "isMythicPlusActivity", Type = "bool", Nilable = false }, + { Name = "isRatedPvpActivity", Type = "bool", Nilable = false }, + { Name = "isCurrentRaidActivity", Type = "bool", Nilable = false }, + { Name = "isPvpActivity", Type = "bool", Nilable = false }, + { Name = "isMythicActivity", Type = "bool", Nilable = false }, + { Name = "allowCrossFaction", Type = "bool", Nilable = false }, + { Name = "isHeroicActivity", Type = "bool", Nilable = false }, + { Name = "isNormalActivity", Type = "bool", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + { Name = "redirectedDifficultyID", Type = "number", Nilable = false }, + { Name = "useDungeonRoleExpectations", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LfgApplicantData", + Type = "Structure", + Fields = + { + { Name = "applicantID", Type = "number", Nilable = false }, + { Name = "applicationStatus", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "pendingApplicationStatus", Type = "cstring", Nilable = true, NeverSecret = true }, + { Name = "numMembers", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "isNew", Type = "bool", Nilable = false }, + { Name = "comment", Type = "kstringLfgListApplicant", Nilable = false }, + { Name = "displayOrderID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LfgCategoryData", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "searchPromptOverride", Type = "cstring", Nilable = true }, + { Name = "separateRecommended", Type = "bool", Nilable = false }, + { Name = "autoChooseActivity", Type = "bool", Nilable = false }, + { Name = "preferCurrentArea", Type = "bool", Nilable = false }, + { Name = "showPlaystyleDropdown", Type = "bool", Nilable = false }, + { Name = "allowCrossFaction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LfgEntryData", + Type = "Structure", + Fields = + { + { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false, NeverSecret = true }, + { Name = "requiredItemLevel", Type = "number", Nilable = false }, + { Name = "requiredHonorLevel", Type = "number", Nilable = false }, + { Name = "name", Type = "kstringLfgListApplicant", Nilable = false }, + { Name = "comment", Type = "kstringLfgListApplicant", Nilable = false }, + { Name = "voiceChat", Type = "kstringLfgListApplicant", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "autoAccept", Type = "bool", Nilable = false }, + { Name = "privateGroup", Type = "bool", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "requiredDungeonScore", Type = "number", Nilable = true }, + { Name = "requiredPvpRating", Type = "number", Nilable = true }, + { Name = "playstyle", Type = "LFGEntryPlaystyle", Nilable = true }, + { Name = "generalPlaystyle", Type = "LFGEntryGeneralPlaystyle", Nilable = true }, + { Name = "isCrossFactionListing", Type = "bool", Nilable = false }, + { Name = "newPlayerFriendly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LfgListingCreateData", + Type = "Structure", + Fields = + { + { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "isAutoAccept", Type = "bool", Nilable = false, Default = false }, + { Name = "isCrossFactionListing", Type = "bool", Nilable = false, Default = false }, + { Name = "isPrivateGroup", Type = "bool", Nilable = false, Default = false }, + { Name = "newPlayerFriendly", Type = "bool", Nilable = false, Default = false }, + { Name = "playstyle", Type = "LFGEntryPlaystyle", Nilable = false, Default = "None" }, + { Name = "generalPlaystyle", Type = "LFGEntryGeneralPlaystyle", Nilable = false, Default = "None" }, + { Name = "requiredDungeonScore", Type = "number", Nilable = false, Default = 0 }, + { Name = "requiredItemLevel", Type = "number", Nilable = false, Default = 0 }, + { Name = "requiredPvpRating", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "LfgSearchResultData", + Type = "Structure", + Fields = + { + { Name = "searchResultID", Type = "number", Nilable = false }, + { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "leaderName", Type = "string", Nilable = true }, + { Name = "name", Type = "kstringLfgListSearch", Nilable = false }, + { Name = "comment", Type = "kstringLfgListSearch", Nilable = false }, + { Name = "voiceChat", Type = "kstringLfgListSearch", Nilable = false }, + { Name = "requiredItemLevel", Type = "number", Nilable = false }, + { Name = "requiredHonorLevel", Type = "number", Nilable = false }, + { Name = "hasSelf", Type = "bool", Nilable = false }, + { Name = "numMembers", Type = "number", Nilable = false }, + { Name = "numBNetFriends", Type = "number", Nilable = false }, + { Name = "numCharFriends", Type = "number", Nilable = false }, + { Name = "numGuildMates", Type = "number", Nilable = false }, + { Name = "isDelisted", Type = "bool", Nilable = false }, + { Name = "autoAccept", Type = "bool", Nilable = false }, + { Name = "isWarMode", Type = "bool", Nilable = false }, + { Name = "age", Type = "time_t", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "leaderOverallDungeonScore", Type = "number", Nilable = true }, + { Name = "leaderDungeonScoreInfo", Type = "table", InnerType = "BestDungeonScoreMapInfo", Nilable = false }, + { Name = "leaderBestDungeonScoreInfo", Type = "BestDungeonScoreMapInfo", Nilable = true }, + { Name = "leaderPvpRatingInfo", Type = "table", InnerType = "PvpRatingInfo", Nilable = false }, + { Name = "requiredDungeonScore", Type = "number", Nilable = true }, + { Name = "requiredPvpRating", Type = "number", Nilable = true }, + { Name = "playstyle", Type = "LFGEntryPlaystyle", Nilable = true }, + { Name = "generalPlaystyle", Type = "LFGEntryGeneralPlaystyle", Nilable = true }, + { Name = "crossFactionListing", Type = "bool", Nilable = true }, + { Name = "leaderFactionGroup", Type = "number", Nilable = false }, + { Name = "newPlayerFriendly", Type = "bool", Nilable = true }, + { Name = "partyGUID", Type = "WOWGUID", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "LfgSearchResultPlayerInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "level", Type = "number", Nilable = true }, + { Name = "areaName", Type = "cstring", Nilable = true }, + { Name = "className", Type = "cstring", Nilable = false }, + { Name = "classFilename", Type = "cstring", Nilable = false }, + { Name = "specName", Type = "cstring", Nilable = true }, + { Name = "assignedRole", Type = "cstring", Nilable = false }, + { Name = "lfgRoles", Type = "LFGRoles", Nilable = false }, + { Name = "isLeader", Type = "bool", Nilable = false }, + { Name = "isLeaver", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "PvpRatingInfo", + Type = "Structure", + Fields = + { + { Name = "bracket", Type = "number", Nilable = false }, + { Name = "rating", Type = "number", Nilable = false }, + { Name = "activityName", Type = "string", Nilable = false }, + { Name = "tier", Type = "number", Nilable = false }, + }, + }, + { + Name = "WowLocale", + Type = "Structure", + Fields = + { + { Name = "enUS", Type = "bool", Nilable = false, Default = false }, + { Name = "koKR", Type = "bool", Nilable = false, Default = false }, + { Name = "frFR", Type = "bool", Nilable = false, Default = false }, + { Name = "deDE", Type = "bool", Nilable = false, Default = false }, + { Name = "zhCN", Type = "bool", Nilable = false, Default = false }, + { Name = "zhTW", Type = "bool", Nilable = false, Default = false }, + { Name = "esES", Type = "bool", Nilable = false, Default = false }, + { Name = "esMX", Type = "bool", Nilable = false, Default = false }, + { Name = "ruRU", Type = "bool", Nilable = false, Default = false }, + { Name = "ptBR", Type = "bool", Nilable = false, Default = false }, + { Name = "itIT", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LFGListInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua.annotated.lua new file mode 100644 index 0000000..73ce91c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingDocumentation.lua.annotated.lua @@ -0,0 +1,334 @@ +local LegendaryCrafting = +{ + Name = "LegendaryCrafting", + Type = "System", + Namespace = "C_LegendaryCrafting", + Environment = "All", + + Functions = + { + { + Name = "CloseRuneforgeInteraction", + Type = "Function", + }, + { + Name = "CraftRuneforgeLegendary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "description", Type = "RuneforgeLegendaryCraftDescription", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeItemPreviewInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "runeforgePowerID", Type = "number", Nilable = true }, + { Name = "modifiers", Type = "table", InnerType = "number", Nilable = true }, + }, + + Returns = + { + { Name = "info", Type = "RuneforgeItemPreviewInfo", Nilable = true }, + }, + }, + { + Name = "GetRuneforgeLegendaryComponentInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgeLegendary", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "componentInfo", Type = "RuneforgeLegendaryComponentInfo", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeLegendaryCost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "cost", Type = "table", InnerType = "CurrencyCost", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeLegendaryCraftSpellID", + Type = "Function", + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeLegendaryCurrencies", + Type = "Function", + + Returns = + { + { Name = "currencies", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeLegendaryUpgradeCost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgeLegendary", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "upgradeItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "cost", Type = "table", InnerType = "CurrencyCost", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeModifierInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = true }, + { Name = "addedModifierIndex", Type = "luaIndex", Nilable = false }, + { Name = "modifiers", Type = "table", InnerType = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeModifiers", + Type = "Function", + + Returns = + { + { Name = "modifiedReagentItemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneforgePowerInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgePowerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "power", Type = "RuneforgePower", Nilable = false }, + }, + }, + { + Name = "GetRuneforgePowerSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgePowerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slotNames", Type = "table", InnerType = "cstring", Nilable = false }, + }, + }, + { + Name = "GetRuneforgePowers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = true }, + { Name = "filter", Type = "RuneforgePowerFilter", Nilable = true }, + }, + + Returns = + { + { Name = "primaryRuneforgePowerIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "otherRuneforgePowerIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneforgePowersByClassSpecAndCovenant", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = true }, + { Name = "specID", Type = "number", Nilable = true }, + { Name = "covenantID", Type = "number", Nilable = true }, + { Name = "filter", Type = "RuneforgePowerFilter", Nilable = true }, + }, + + Returns = + { + { Name = "runeforgePowerIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsRuneforgeLegendary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isRuneforgeLegendary", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRuneforgeLegendaryMaxLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgeLegendary", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isMaxLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUpgradeItemValidForRuneforgeLegendary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgeLegendary", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "upgradeItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidRuneforgeBaseItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MakeRuneforgeCraftDescription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "runeforgePowerID", Type = "number", Nilable = false }, + { Name = "modifiers", Type = "table", InnerType = "number", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "RuneforgeLegendaryCraftDescription", Nilable = false }, + }, + }, + { + Name = "UpgradeRuneforgeLegendary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeforgeLegendary", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "upgradeItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "NewRuneforgePowerAdded", + Type = "Event", + LiteralName = "NEW_RUNEFORGE_POWER_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RuneforgeLegendaryCraftingClosed", + Type = "Event", + LiteralName = "RUNEFORGE_LEGENDARY_CRAFTING_CLOSED", + SynchronousEvent = true, + }, + { + Name = "RuneforgeLegendaryCraftingOpened", + Type = "Event", + LiteralName = "RUNEFORGE_LEGENDARY_CRAFTING_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "isUpgrade", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RuneforgePowerInfoUpdated", + Type = "Event", + LiteralName = "RUNEFORGE_POWER_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LegendaryCrafting); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fa506e4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LegendaryCraftingTypesDocumentation.lua.annotated.lua @@ -0,0 +1,92 @@ +local LegendaryCraftingTypes = +{ + Tables = + { + { + Name = "RuneforgePowerFilter", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "All", Type = "RuneforgePowerFilter", EnumValue = 0 }, + { Name = "Relevant", Type = "RuneforgePowerFilter", EnumValue = 1 }, + { Name = "Available", Type = "RuneforgePowerFilter", EnumValue = 2 }, + { Name = "Unavailable", Type = "RuneforgePowerFilter", EnumValue = 3 }, + }, + }, + { + Name = "RuneforgePowerState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Available", Type = "RuneforgePowerState", EnumValue = 0 }, + { Name = "Unavailable", Type = "RuneforgePowerState", EnumValue = 1 }, + { Name = "Invalid", Type = "RuneforgePowerState", EnumValue = 2 }, + }, + }, + { + Name = "CurrencyCost", + Type = "Structure", + Fields = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "RuneforgeItemPreviewInfo", + Type = "Structure", + Fields = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "itemName", Type = "string", Nilable = false }, + }, + }, + { + Name = "RuneforgeLegendaryComponentInfo", + Type = "Structure", + Fields = + { + { Name = "powerID", Type = "number", Nilable = false }, + { Name = "modifiers", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RuneforgeLegendaryCraftDescription", + Type = "Structure", + Fields = + { + { Name = "baseItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "runeforgePowerID", Type = "number", Nilable = false }, + { Name = "modifiers", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RuneforgePower", + Type = "Structure", + Fields = + { + { Name = "runeforgePowerID", Type = "number", Nilable = false }, + { Name = "state", Type = "RuneforgePowerState", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "descriptionSpellID", Type = "number", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "source", Type = "cstring", Nilable = true }, + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "specName", Type = "cstring", Nilable = true }, + { Name = "matchesSpec", Type = "bool", Nilable = false }, + { Name = "matchesCovenant", Type = "bool", Nilable = false }, + { Name = "covenantID", Type = "number", Nilable = true }, + { Name = "slots", Type = "table", InnerType = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LegendaryCraftingTypes); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ca6d570 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,17 @@ +local LevelConstants = +{ + Tables = + { + { + Name = "LevelConstsExposed", + Type = "Constants", + Values = + { + { Name = "MIN_RES_SICKNESS_LEVEL", Type = "number", Value = 10 }, + { Name = "MIN_ACHIEVEMENT_LEVEL", Type = "number", Value = 10 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LevelConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8deec23 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelLinkDocumentation.lua.annotated.lua @@ -0,0 +1,51 @@ +local LevelLink = +{ + Name = "LevelLink", + Type = "System", + Namespace = "C_LevelLink", + Environment = "All", + + Functions = + { + { + Name = "IsActionLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LevelLink); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7c62807 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LevelSquishDocumentation.lua.annotated.lua @@ -0,0 +1,52 @@ +local LevelSquish = +{ + Name = "LevelSquish", + Type = "System", + Namespace = "C_LevelSquish", + Environment = "All", + + Functions = + { + { + Name = "ConvertFollowerLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + { Name = "maxFollowerLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "squishedLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConvertPlayerLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "squishedLevel", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LevelSquish); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1e5e5fc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LimitedInputDocumentation.lua.annotated.lua @@ -0,0 +1,50 @@ +local LimitedInput = +{ + Name = "LimitedInput", + Type = "System", + Namespace = "C_LimitedInput", + Environment = "All", + + Functions = + { + { + Name = "LimitedInputAllowed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "LimitedInputType", Nilable = false }, + }, + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "LimitedInputType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "MouseMove", Type = "LimitedInputType", EnumValue = 0 }, + { Name = "MouseDown", Type = "LimitedInputType", EnumValue = 1 }, + { Name = "MouseUp", Type = "LimitedInputType", EnumValue = 2 }, + { Name = "MouseWheel", Type = "LimitedInputType", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LimitedInput); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e538347 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LiveEventDocumentation.lua.annotated.lua @@ -0,0 +1,43 @@ +local LiveEvent = +{ + Name = "LiveEvent", + Type = "System", + Namespace = "C_LiveEvent", + Environment = "All", + + Functions = + { + { + Name = "OnLiveEventBannerClicked", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "timerunningSeasonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "OnLiveEventPopupClicked", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "timerunningSeasonID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LiveEvent); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoadingScreenDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoadingScreenDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1cb6893 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoadingScreenDocumentation.lua.annotated.lua @@ -0,0 +1,33 @@ +local LoadingScreen = +{ + Name = "LoadingScreen", + Type = "System", + Namespace = "C_LoadingScreen", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "LoadingScreenDisabled", + Type = "Event", + LiteralName = "LOADING_SCREEN_DISABLED", + SynchronousEvent = true, + }, + { + Name = "LoadingScreenEnabled", + Type = "Event", + LiteralName = "LOADING_SCREEN_ENABLED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LoadingScreen); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d51038b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LobbyMatchmakerInfoDocumentation.lua.annotated.lua @@ -0,0 +1,145 @@ +local LobbyMatchmakerInfo = +{ + Name = "LobbyMatchmakerInfo", + Type = "System", + Namespace = "C_LobbyMatchmakerInfo", + Environment = "All", + + Functions = + { + { + Name = "AbandonQueue", + Type = "Function", + }, + { + Name = "EnterQueue", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playlistEntry", Type = "PartyPlaylistEntry", Nilable = false }, + }, + }, + { + Name = "GetCurrQueuePlaylistEntry", + Type = "Function", + + Returns = + { + { Name = "playlistEntry", Type = "PartyPlaylistEntry", Nilable = false }, + }, + }, + { + Name = "GetCurrQueueState", + Type = "Function", + + Returns = + { + { Name = "queueState", Type = "PlunderstormQueueState", Nilable = false }, + }, + }, + { + Name = "GetQueueFromMainlineEnabled", + Type = "Function", + + Returns = + { + { Name = "queueFromMainlineEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQueueStartTime", + Type = "Function", + + Returns = + { + { Name = "queueStartTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsInQueue", + Type = "Function", + + Returns = + { + { Name = "isInQueue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RespondToQueuePop", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "acceptQueue", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "LobbyMatchmakerQueueAbandoned", + Type = "Event", + LiteralName = "LOBBY_MATCHMAKER_QUEUE_ABANDONED", + SynchronousEvent = true, + }, + { + Name = "LobbyMatchmakerQueueError", + Type = "Event", + LiteralName = "LOBBY_MATCHMAKER_QUEUE_ERROR", + SynchronousEvent = true, + }, + { + Name = "LobbyMatchmakerQueueExpired", + Type = "Event", + LiteralName = "LOBBY_MATCHMAKER_QUEUE_EXPIRED", + SynchronousEvent = true, + }, + { + Name = "LobbyMatchmakerQueuePopped", + Type = "Event", + LiteralName = "LOBBY_MATCHMAKER_QUEUE_POPPED", + SynchronousEvent = true, + }, + { + Name = "LobbyMatchmakerQueueStatusUpdate", + Type = "Event", + LiteralName = "LOBBY_MATCHMAKER_QUEUE_STATUS_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "PlunderstormQueueState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "PlunderstormQueueState", EnumValue = 0 }, + { Name = "Queued", Type = "PlunderstormQueueState", EnumValue = 1 }, + { Name = "Proposed", Type = "PlunderstormQueueState", EnumValue = 2 }, + { Name = "Suspended", Type = "PlunderstormQueueState", EnumValue = 3 }, + }, + }, + { + Name = "LobbyMatchmakerQueueInfo", + Type = "Structure", + Fields = + { + { Name = "isQueueActive", Type = "bool", Nilable = false, Default = false }, + { Name = "playlistEntryID", Type = "PartyPlaylistEntry", Nilable = false }, + { Name = "queueState", Type = "PlunderstormQueueState", Nilable = false }, + { Name = "queueStartTime", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LobbyMatchmakerInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8c6eede --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocaleDocumentation.lua.annotated.lua @@ -0,0 +1,86 @@ +local Locale = +{ + Name = "Locale", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetAvailableLocaleInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreLocaleRestrictions", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "localeInfos", Type = "table", InnerType = "LocaleInfo", Nilable = false }, + }, + }, + { + Name = "GetAvailableLocales", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreLocaleRestrictions", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "localeName", Type = "cstring", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetCurrentRegion", + Type = "Function", + + Returns = + { + { Name = "region", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLocale", + Type = "Function", + + Returns = + { + { Name = "localeName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetOSLocale", + Type = "Function", + + Returns = + { + { Name = "localeName", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "LocaleInfo", + Type = "Structure", + Fields = + { + { Name = "localeId", Type = "number", Nilable = false }, + { Name = "localeName", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Locale); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua.annotated.lua new file mode 100644 index 0000000..887885c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationDocumentation.lua.annotated.lua @@ -0,0 +1,175 @@ +local Localization = +{ + Name = "Localization", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "AbbreviateLargeNumbers", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "number", Type = "number", Nilable = false }, + { Name = "options", Type = "NumberAbbrevOptions", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "AbbreviateNumbers", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "number", Type = "number", Nilable = false }, + { Name = "options", Type = "NumberAbbrevOptions", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "BreakUpLargeNumbers", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "largeNumber", Type = "number", Nilable = false }, + { Name = "natural", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "CaseAccentInsensitiveParse", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "CreateAbbreviateConfig", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "data", Type = "table", InnerType = "NumberAbbreviationBreakpoint", Nilable = false }, + }, + + Returns = + { + { Name = "config", Type = "AbbreviateConfig", Nilable = false }, + }, + }, + { + Name = "DeclineName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "gender", Type = "UnitSex", Nilable = true }, + { Name = "declensionSet", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "declinedNames", Type = "string", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetNumDeclensionSets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "gender", Type = "UnitSex", Nilable = true }, + }, + + Returns = + { + { Name = "numDeclensionSets", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsEuropeanNumbers", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LocalizedClassList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isFemale", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "LuaValueVariant", Nilable = false }, + }, + }, + { + Name = "SetEuropeanNumbers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "NumberAbbrevOptions", + Type = "Structure", + Fields = + { + { Name = "breakpointData", Type = "table", InnerType = "NumberAbbreviationBreakpoint", Nilable = true, Documentation = { "Order these from largest to smallest." } }, + { Name = "locale", Type = "cstring", Nilable = true, Documentation = { "Locale controls whether standard asian abbreviation data will be used along with a small change in behavior for large number abbreviation when fractionDivisor is greater than zero." } }, + { Name = "config", Type = "AbbreviateConfig", Nilable = true, Documentation = { "Provides a cached config object for optimal performance when calling abbreviation functions multiple times with the same options." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Localization); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..27b6d49 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LocalizationSharedDocumentation.lua.annotated.lua @@ -0,0 +1,35 @@ +local LocalizationShared = +{ + Tables = + { + { + Name = "AbbreviationDataError", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "InvalidBreakpoint", Type = "AbbreviationDataError", EnumValue = 0 }, + { Name = "InvalidSignificandDivisor", Type = "AbbreviationDataError", EnumValue = 1 }, + { Name = "InvalidFractionDivisor", Type = "AbbreviationDataError", EnumValue = 2 }, + { Name = "InvalidAbbreviation", Type = "AbbreviationDataError", EnumValue = 3 }, + { Name = "NotMultipleOfTen", Type = "AbbreviationDataError", EnumValue = 4 }, + }, + }, + { + Name = "NumberAbbreviationBreakpoint", + Type = "Structure", + Fields = + { + { Name = "breakpoint", Type = "number", Nilable = false, Documentation = { "Breakpoints should generally be specified as pairs, with one at the named order (1,000) with fractionDivisor = 10, and one a single order higher (eg. 10,000) with fractionDivisor = 1., This ruleset means numbers like '1234' will be abbreviated to '1.2k' and numbers like '12345' to '12k'." } }, + { Name = "abbreviation", Type = "cstring", Nilable = false, Documentation = { "Abbreviation name to be looked up as a global string." } }, + { Name = "significandDivisor", Type = "number", Nilable = false, Documentation = { "significandDivisor and fractionDivisor should multiply such that they become equal to a named order of magnitude, such as thousands or millions." } }, + { Name = "fractionDivisor", Type = "number", Nilable = false }, + { Name = "abbreviationIsGlobal", Type = "bool", Nilable = false, Default = true, Documentation = { "Defaults to true. Set to false to skip the global string lookup and use the raw abbreviation string when formatting results" } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LocalizationShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a3e4a56 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,24 @@ +local LogConstants = +{ + Tables = + { + { + Name = "LogPriority", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 40, + Fields = + { + { Name = "Fatal", Type = "LogPriority", EnumValue = 1 }, + { Name = "Error", Type = "LogPriority", EnumValue = 2 }, + { Name = "Warning", Type = "LogPriority", EnumValue = 3 }, + { Name = "Normal", Type = "LogPriority", EnumValue = 10 }, + { Name = "Debug", Type = "LogPriority", EnumValue = 30 }, + { Name = "Spam", Type = "LogPriority", EnumValue = 40 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LogConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ebc55da --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogDocumentation.lua.annotated.lua @@ -0,0 +1,62 @@ +local Log = +{ + Name = "Log", + Type = "System", + Namespace = "C_Log", + Environment = "All", + + Functions = + { + { + Name = "LogErrorMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "message", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LogMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "message", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LogMessageWithPriority", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "priority", Type = "LogPriority", Nilable = false }, + { Name = "message", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LogWarningMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "message", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Log); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogicConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogicConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d8b4901 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LogicConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,55 @@ +local LogicConstants = +{ + Tables = + { + { + Name = "LogicLogicop", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "LogicLogicop", EnumValue = 0 }, + { Name = "And", Type = "LogicLogicop", EnumValue = 1 }, + { Name = "Or", Type = "LogicLogicop", EnumValue = 2 }, + { Name = "Xor", Type = "LogicLogicop", EnumValue = 3 }, + }, + }, + { + Name = "LogicMathop", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "LogicMathop", EnumValue = 0 }, + { Name = "Plus", Type = "LogicMathop", EnumValue = 1 }, + { Name = "Minus", Type = "LogicMathop", EnumValue = 2 }, + { Name = "Times", Type = "LogicMathop", EnumValue = 3 }, + { Name = "Div", Type = "LogicMathop", EnumValue = 4 }, + { Name = "Mod", Type = "LogicMathop", EnumValue = 5 }, + }, + }, + { + Name = "LogicRelop", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "None", Type = "LogicRelop", EnumValue = 0 }, + { Name = "Equal", Type = "LogicRelop", EnumValue = 1 }, + { Name = "Notequal", Type = "LogicRelop", EnumValue = 2 }, + { Name = "Lt", Type = "LogicRelop", EnumValue = 3 }, + { Name = "Lteq", Type = "LogicRelop", EnumValue = 4 }, + { Name = "Gt", Type = "LogicRelop", EnumValue = 5 }, + { Name = "Gteq", Type = "LogicRelop", EnumValue = 6 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LogicConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..82670ba --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,58 @@ +local LootConstants = +{ + Tables = + { + { + Name = "LootMethod", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Freeforall", Type = "LootMethod", EnumValue = 0 }, + { Name = "Roundrobin", Type = "LootMethod", EnumValue = 1 }, + { Name = "Masterlooter", Type = "LootMethod", EnumValue = 2 }, + { Name = "Group", Type = "LootMethod", EnumValue = 3 }, + { Name = "Needbeforegreed", Type = "LootMethod", EnumValue = 4 }, + { Name = "Personal", Type = "LootMethod", EnumValue = 5 }, + }, + }, + { + Name = "LootMethodStyles", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "PersonalOnly", Type = "LootMethodStyles", EnumValue = 0 }, + { Name = "Vanilla", Type = "LootMethodStyles", EnumValue = 1 }, + }, + }, + { + Name = "LootSlotType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "LootSlotType", EnumValue = 0 }, + { Name = "Item", Type = "LootSlotType", EnumValue = 1 }, + { Name = "Money", Type = "LootSlotType", EnumValue = 2 }, + { Name = "Currency", Type = "LootSlotType", EnumValue = 3 }, + }, + }, + { + Name = "LootConsts", + Type = "Constants", + Values = + { + { Name = "MasterLootQualityThreshold", Type = "number", Value = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LootConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f33f408 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootDocumentation.lua.annotated.lua @@ -0,0 +1,436 @@ +local Loot = +{ + Name = "Loot", + Type = "System", + Namespace = "C_Loot", + Environment = "All", + + Functions = + { + { + Name = "GetLootRollDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rollID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsLegacyLootModeEnabled", + Type = "Function", + + Returns = + { + { Name = "isLegacyLootModeEnabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AzeriteEmpoweredItemLooted", + Type = "Event", + LiteralName = "AZERITE_EMPOWERED_ITEM_LOOTED", + SynchronousEvent = true, + Payload = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "BonusRollActivate", + Type = "Event", + LiteralName = "BONUS_ROLL_ACTIVATE", + SynchronousEvent = true, + }, + { + Name = "BonusRollDeactivate", + Type = "Event", + LiteralName = "BONUS_ROLL_DEACTIVATE", + SynchronousEvent = true, + }, + { + Name = "BonusRollFailed", + Type = "Event", + LiteralName = "BONUS_ROLL_FAILED", + SynchronousEvent = true, + }, + { + Name = "BonusRollResult", + Type = "Event", + LiteralName = "BONUS_ROLL_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "typeIdentifier", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "personalLootToast", Type = "bool", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = true }, + { Name = "isSecondaryResult", Type = "bool", Nilable = false }, + { Name = "corrupted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BonusRollStarted", + Type = "Event", + LiteralName = "BONUS_ROLL_STARTED", + SynchronousEvent = true, + }, + { + Name = "CancelAllLootRolls", + Type = "Event", + LiteralName = "CANCEL_ALL_LOOT_ROLLS", + SynchronousEvent = true, + }, + { + Name = "CancelLootRoll", + Type = "Event", + LiteralName = "CANCEL_LOOT_ROLL", + SynchronousEvent = true, + Payload = + { + { Name = "rollID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmDisenchantRoll", + Type = "Event", + LiteralName = "CONFIRM_DISENCHANT_ROLL", + SynchronousEvent = true, + Payload = + { + { Name = "rollID", Type = "number", Nilable = false }, + { Name = "rollType", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmLootRoll", + Type = "Event", + LiteralName = "CONFIRM_LOOT_ROLL", + SynchronousEvent = true, + Payload = + { + { Name = "rollID", Type = "number", Nilable = false }, + { Name = "rollType", Type = "number", Nilable = false }, + { Name = "confirmReason", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EncounterLootReceived", + Type = "Event", + LiteralName = "ENCOUNTER_LOOT_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "itemName", Type = "cstring", Nilable = false }, + { Name = "fileName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GarrisonMissionBonusRollLoot", + Type = "Event", + LiteralName = "GARRISON_MISSION_BONUS_ROLL_LOOT", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemPush", + Type = "Event", + LiteralName = "ITEM_PUSH", + SynchronousEvent = true, + Payload = + { + { Name = "bagSlot", Type = "luaIndex", Nilable = false }, + { Name = "iconFileID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LegacyLootRulesChanged", + Type = "Event", + LiteralName = "LEGACY_LOOT_RULES_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isLegacyLootModeEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LootBindConfirm", + Type = "Event", + LiteralName = "LOOT_BIND_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "LootClosed", + Type = "Event", + LiteralName = "LOOT_CLOSED", + SynchronousEvent = true, + }, + { + Name = "LootItemAvailable", + Type = "Event", + LiteralName = "LOOT_ITEM_AVAILABLE", + SynchronousEvent = true, + Payload = + { + { Name = "itemTooltip", Type = "cstring", Nilable = false }, + { Name = "lootHandle", Type = "number", Nilable = false }, + }, + }, + { + Name = "LootItemRollWon", + Type = "Event", + LiteralName = "LOOT_ITEM_ROLL_WON", + SynchronousEvent = true, + Payload = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "rollQuantity", Type = "number", Nilable = false }, + { Name = "rollType", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + { Name = "upgraded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LootOpened", + Type = "Event", + LiteralName = "LOOT_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "autoLoot", Type = "bool", Nilable = false }, + { Name = "isFromItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LootReady", + Type = "Event", + LiteralName = "LOOT_READY", + SynchronousEvent = true, + Payload = + { + { Name = "autoloot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LootRollsComplete", + Type = "Event", + LiteralName = "LOOT_ROLLS_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "lootHandle", Type = "number", Nilable = false }, + }, + }, + { + Name = "LootSlotChanged", + Type = "Event", + LiteralName = "LOOT_SLOT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "LootSlotCleared", + Type = "Event", + LiteralName = "LOOT_SLOT_CLEARED", + SynchronousEvent = true, + Payload = + { + { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "MainSpecNeedRoll", + Type = "Event", + LiteralName = "MAIN_SPEC_NEED_ROLL", + SynchronousEvent = true, + Payload = + { + { Name = "rollID", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + { Name = "isWinning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpenMasterLootList", + Type = "Event", + LiteralName = "OPEN_MASTER_LOOT_LIST", + SynchronousEvent = true, + }, + { + Name = "PetBattleLootReceived", + Type = "Event", + LiteralName = "PET_BATTLE_LOOT_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "typeIdentifier", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerLootSpecUpdated", + Type = "Event", + LiteralName = "PLAYER_LOOT_SPEC_UPDATED", + SynchronousEvent = true, + }, + { + Name = "QuestCurrencyLootReceived", + Type = "Event", + LiteralName = "QUEST_CURRENCY_LOOT_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "currencyId", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestLootReceived", + Type = "Event", + LiteralName = "QUEST_LOOT_RECEIVED", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowLootToast", + Type = "Event", + LiteralName = "SHOW_LOOT_TOAST", + SynchronousEvent = true, + Payload = + { + { Name = "typeIdentifier", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "personalLootToast", Type = "bool", Nilable = false }, + { Name = "toastMethod", Type = "number", Nilable = false }, + { Name = "lessAwesome", Type = "bool", Nilable = false }, + { Name = "upgraded", Type = "bool", Nilable = false }, + { Name = "corrupted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowLootToastLegendaryLooted", + Type = "Event", + LiteralName = "SHOW_LOOT_TOAST_LEGENDARY_LOOTED", + SynchronousEvent = true, + Payload = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ShowLootToastUpgrade", + Type = "Event", + LiteralName = "SHOW_LOOT_TOAST_UPGRADE", + SynchronousEvent = true, + Payload = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "baseQuality", Type = "number", Nilable = false }, + { Name = "personalLootToast", Type = "bool", Nilable = false }, + { Name = "lessAwesome", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowPvpFactionLootToast", + Type = "Event", + LiteralName = "SHOW_PVP_FACTION_LOOT_TOAST", + SynchronousEvent = true, + Payload = + { + { Name = "typeIdentifier", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "personalLootToast", Type = "bool", Nilable = false }, + { Name = "lessAwesome", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowRatedPvpRewardToast", + Type = "Event", + LiteralName = "SHOW_RATED_PVP_REWARD_TOAST", + SynchronousEvent = true, + Payload = + { + { Name = "typeIdentifier", Type = "cstring", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "personalLootToast", Type = "bool", Nilable = false }, + { Name = "lessAwesome", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartLootRoll", + Type = "Event", + LiteralName = "START_LOOT_ROLL", + SynchronousEvent = true, + Payload = + { + { Name = "rollID", Type = "number", Nilable = false }, + { Name = "rollTime", Type = "number", Nilable = false }, + { Name = "lootHandle", Type = "number", Nilable = true }, + }, + }, + { + Name = "TrialCapReachedMoney", + Type = "Event", + LiteralName = "TRIAL_CAP_REACHED_MONEY", + SynchronousEvent = true, + }, + { + Name = "UpdateMasterLootList", + Type = "Event", + LiteralName = "UPDATE_MASTER_LOOT_LIST", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Loot); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c42d3de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootHistoryDocumentation.lua.annotated.lua @@ -0,0 +1,200 @@ +local LootHistory = +{ + Name = "LootHistory", + Type = "System", + Namespace = "C_LootHistory", + Environment = "All", + + Functions = + { + { + Name = "GetAllEncounterInfos", + Type = "Function", + + Returns = + { + { Name = "infos", Type = "table", InnerType = "EncounterLootInfo", Nilable = false }, + }, + }, + { + Name = "GetInfoForEncounter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "encounterID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "EncounterLootInfo", Nilable = true }, + }, + }, + { + Name = "GetLootHistoryTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSortedDropsForEncounter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "encounterID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "drops", Type = "table", InnerType = "EncounterLootDropInfo", Nilable = true }, + }, + }, + { + Name = "GetSortedInfoForDrop", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "lootListID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "EncounterLootDropInfo", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "LootHistoryClearHistory", + Type = "Event", + LiteralName = "LOOT_HISTORY_CLEAR_HISTORY", + SynchronousEvent = true, + }, + { + Name = "LootHistoryGoToEncounter", + Type = "Event", + LiteralName = "LOOT_HISTORY_GO_TO_ENCOUNTER", + UniqueEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LootHistoryOneHundredRoll", + Type = "Event", + LiteralName = "LOOT_HISTORY_ONE_HUNDRED_ROLL", + SynchronousEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "lootListID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LootHistoryUpdateDrop", + Type = "Event", + LiteralName = "LOOT_HISTORY_UPDATE_DROP", + UniqueEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "lootListID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LootHistoryUpdateEncounter", + Type = "Event", + LiteralName = "LOOT_HISTORY_UPDATE_ENCOUNTER", + UniqueEvent = true, + Payload = + { + { Name = "encounterID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "EncounterLootDropRollState", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "NeedMainSpec", Type = "EncounterLootDropRollState", EnumValue = 0 }, + { Name = "NeedOffSpec", Type = "EncounterLootDropRollState", EnumValue = 1 }, + { Name = "Transmog", Type = "EncounterLootDropRollState", EnumValue = 2 }, + { Name = "Greed", Type = "EncounterLootDropRollState", EnumValue = 3 }, + { Name = "NoRoll", Type = "EncounterLootDropRollState", EnumValue = 4 }, + { Name = "Pass", Type = "EncounterLootDropRollState", EnumValue = 5 }, + }, + }, + { + Name = "EncounterLootDropInfo", + Type = "Structure", + Fields = + { + { Name = "lootListID", Type = "number", Nilable = false }, + { Name = "itemHyperlink", Type = "string", Nilable = false }, + { Name = "playerRollState", Type = "EncounterLootDropRollState", Nilable = false }, + { Name = "currentLeader", Type = "EncounterLootDropRollInfo", Nilable = true }, + { Name = "isTied", Type = "bool", Nilable = false, Default = false }, + { Name = "winner", Type = "EncounterLootDropRollInfo", Nilable = true }, + { Name = "allPassed", Type = "bool", Nilable = false, Default = false }, + { Name = "rollInfos", Type = "table", InnerType = "EncounterLootDropRollInfo", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "EncounterLootDropRollInfo", + Type = "Structure", + Fields = + { + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "playerClass", Type = "string", Nilable = false }, + { Name = "isSelf", Type = "bool", Nilable = false }, + { Name = "state", Type = "EncounterLootDropRollState", Nilable = false }, + { Name = "isWinner", Type = "bool", Nilable = false, Default = false }, + { Name = "roll", Type = "number", Nilable = true }, + }, + }, + { + Name = "EncounterLootDrops", + Type = "Structure", + Fields = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "drops", Type = "table", InnerType = "EncounterLootDropInfo", Nilable = false }, + }, + }, + { + Name = "EncounterLootInfo", + Type = "Structure", + Fields = + { + { Name = "encounterName", Type = "string", Nilable = false }, + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LootHistory); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..41049dc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LootJournalDocumentation.lua.annotated.lua @@ -0,0 +1,80 @@ +local LootJournal = +{ + Name = "LootJournal", + Type = "System", + Namespace = "C_LootJournal", + Environment = "All", + + Functions = + { + { + Name = "GetItemSetItems", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "items", Type = "table", InnerType = "LootJournalItemInfo", Nilable = false }, + }, + }, + { + Name = "GetItemSets", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = true }, + { Name = "specID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "itemSets", Type = "table", InnerType = "LootJournalItemSetInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "LootJournalItemUpdate", + Type = "Event", + LiteralName = "LOOT_JOURNAL_ITEM_UPDATE", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "LootJournalItemInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "invType", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "LootJournalItemSetInfo", + Type = "Structure", + Fields = + { + { Name = "setID", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LootJournal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8baadb0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LoreTextDocumentation.lua.annotated.lua @@ -0,0 +1,51 @@ +local LoreText = +{ + Name = "LoreText", + Type = "System", + Namespace = "C_LoreText", + Environment = "All", + + Functions = + { + { + Name = "RequestLoreTextForCampaignID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "LoreTextUpdatedCampaign", + Type = "Event", + LiteralName = "LORE_TEXT_UPDATED_CAMPAIGN", + SynchronousEvent = true, + Payload = + { + { Name = "campaignID", Type = "number", Nilable = false }, + { Name = "textEntries", Type = "table", InnerType = "LoreTextEntry", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "LoreTextEntry", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LoreText); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1dedf87 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LossOfControlDocumentation.lua.annotated.lua @@ -0,0 +1,151 @@ +local LossOfControl = +{ + Name = "LossOfControl", + Type = "System", + Namespace = "C_LossOfControl", + Environment = "All", + + Functions = + { + { + Name = "GetActiveLossOfControlData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "event", Type = "LossOfControlData", Nilable = true }, + }, + }, + { + Name = "GetActiveLossOfControlDataByUnit", + Type = "Function", + SecretWhenLossOfControlInfoRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "event", Type = "LossOfControlData", Nilable = true }, + }, + }, + { + Name = "GetActiveLossOfControlDataCount", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActiveLossOfControlDataCountByUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "LossOfControlAdded", + Type = "Event", + LiteralName = "LOSS_OF_CONTROL_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "effectIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "LossOfControlCommentatorAdded", + Type = "Event", + LiteralName = "LOSS_OF_CONTROL_COMMENTATOR_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "victim", Type = "WOWGUID", Nilable = false }, + { Name = "effectIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "LossOfControlCommentatorUpdate", + Type = "Event", + LiteralName = "LOSS_OF_CONTROL_COMMENTATOR_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "victim", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "LossOfControlUpdate", + Type = "Event", + LiteralName = "LOSS_OF_CONTROL_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerControlGained", + Type = "Event", + LiteralName = "PLAYER_CONTROL_GAINED", + SynchronousEvent = true, + }, + { + Name = "PlayerControlLost", + Type = "Event", + LiteralName = "PLAYER_CONTROL_LOST", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "LossOfControlData", + Type = "Structure", + Fields = + { + { Name = "locType", Type = "cstring", Nilable = false, NeverSecret = true }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "displayText", Type = "cstring", Nilable = false }, + { Name = "iconTexture", Type = "number", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = true }, + { Name = "timeRemaining", Type = "number", Nilable = true }, + { Name = "duration", Type = "number", Nilable = true }, + { Name = "lockoutSchool", Type = "number", Nilable = false }, + { Name = "priority", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "displayType", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "auraInstanceID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LossOfControl); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaColorCurveObjectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaColorCurveObjectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8eab9b1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaColorCurveObjectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,178 @@ +local LuaColorCurveObjectAPI = +{ + Name = "LuaColorCurveObjectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddPoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Adds a single point to the curve." }, + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "ClearPoints", + Type = "Function", + Documentation = { "Removes all points from the curve. Evaluating an empty curve always yields a zero value." }, + + Arguments = + { + }, + }, + { + Name = "Copy", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns a new copy of this curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "curve", Type = "LuaColorCurveObject", Nilable = false }, + }, + }, + { + Name = "Evaluate", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a calculated color value from the configured curve points." }, + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "y", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "EvaluateUnpacked", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns an unpacked calculated color value from the configured curve points." }, + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "yR", Type = "number", Nilable = false }, + { Name = "yG", Type = "number", Nilable = false }, + { Name = "yB", Type = "number", Nilable = false }, + { Name = "yA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPoint", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the vector for an individual point index on the curve." }, + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "point", Type = "LuaColorCurvePoint", Nilable = true }, + }, + }, + { + Name = "GetPointCount", + Type = "Function", + Documentation = { "Returns the total number of points on the curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "count", Type = "size", Nilable = false }, + }, + }, + { + Name = "GetPoints", + Type = "Function", + Documentation = { "Returns the vectors for all points on the curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "point", Type = "table", InnerType = "LuaColorCurvePoint", Nilable = false }, + }, + }, + { + Name = "RemovePoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Removes a single point from the curve. Raises an error if the supplied point index is out of range." }, + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetPoints", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Replaces all points on the curve." }, + + Arguments = + { + { Name = "point", Type = "table", InnerType = "LuaColorCurvePoint", Nilable = false }, + }, + }, + { + Name = "SetToDefaults", + Type = "Function", + Documentation = { "Resets all state on the curve, and clears the secret values flag." }, + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "LuaColorCurvePoint", + Type = "Structure", + Fields = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LuaColorCurveObjectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d311628 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,149 @@ +local LuaCurveObjectAPI = +{ + Name = "LuaCurveObjectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddPoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Adds a single point to the curve." }, + + Arguments = + { + { Name = "pointX", Type = "number", Nilable = false }, + { Name = "pointY", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClearPoints", + Type = "Function", + Documentation = { "Removes all points from the curve. Evaluating an empty curve always yields a zero value." }, + + Arguments = + { + }, + }, + { + Name = "Copy", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns a new copy of this curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "curve", Type = "LuaCurveObject", Nilable = false }, + }, + }, + { + Name = "Evaluate", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a calculated 'y' value from the configured curve points." }, + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "y", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPoint", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the vector for an individual point index on the curve." }, + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "point", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "GetPointCount", + Type = "Function", + Documentation = { "Returns the total number of points on the curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "count", Type = "size", Nilable = false }, + }, + }, + { + Name = "GetPoints", + Type = "Function", + Documentation = { "Returns the vectors for all points on the curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "point", Type = "table", InnerType = "vector2", Nilable = false }, + }, + }, + { + Name = "RemovePoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Removes a single point from the curve. Raises an error if the supplied point index is out of range." }, + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetPoints", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Replaces all points on the curve." }, + + Arguments = + { + { Name = "point", Type = "table", InnerType = "vector2", Nilable = false }, + }, + }, + { + Name = "SetToDefaults", + Type = "Function", + Documentation = { "Resets all state on the curve, and clears the secret values flag." }, + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LuaCurveObjectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectBaseAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectBaseAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2464d14 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectBaseAPIDocumentation.lua.annotated.lua @@ -0,0 +1,60 @@ +local LuaCurveObjectBaseAPI = +{ + Name = "LuaCurveObjectBaseAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetType", + Type = "Function", + Documentation = { "Returns the configured type of the curve." }, + + Arguments = + { + }, + + Returns = + { + { Name = "curveType", Type = "LuaCurveType", Nilable = false }, + }, + }, + { + Name = "HasSecretValues", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns true if the curve has been configured with any secret values. Curves with secret values always produce secret results when evaluated." }, + + Arguments = + { + }, + + Returns = + { + { Name = "hasSecretValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Changes the evaluation type of the curve." }, + + Arguments = + { + { Name = "type", Type = "LuaCurveType", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LuaCurveObjectBaseAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b32f141 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaCurveObjectConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local LuaCurveObjectConstants = +{ + Tables = + { + { + Name = "LuaCurveType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Linear", Type = "LuaCurveType", EnumValue = 0, Documentation = { "Linearly interpolates between points." } }, + { Name = "Step", Type = "LuaCurveType", EnumValue = 1, Documentation = { "Performs no interpolation between points, instead snapping to values exactly." } }, + { Name = "Cosine", Type = "LuaCurveType", EnumValue = 2, Documentation = { "Interpolates between points with cosine smoothing applied." } }, + { Name = "Cubic", Type = "LuaCurveType", EnumValue = 3, Documentation = { "Interpolates between points with cubic smoothing applied. Requires a minimum of four points be defined; less than this will fall back to Cosine interpolation." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LuaCurveObjectConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ada9e0f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,343 @@ +local LuaDurationObjectAPI = +{ + Name = "LuaDurationObjectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "Assign", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Copies another duration object and assigns it to this one." }, + + Arguments = + { + { Name = "other", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "Copy", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns a copy of this duration object." }, + + Arguments = + { + }, + + Returns = + { + { Name = "copy", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "EvaluateElapsedDuration", + Type = "Function", + SecretWhenCurveSecret = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the elapsed duration in seconds and evaluates it against a supplied curve." }, + + Arguments = + { + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = false }, + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false }, + }, + }, + { + Name = "EvaluateElapsedPercent", + Type = "Function", + SecretWhenCurveSecret = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the elapsed duration as a percentage value and evaluates it against a supplied curve." }, + + Arguments = + { + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = false }, + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false }, + }, + }, + { + Name = "EvaluateRemainingDuration", + Type = "Function", + SecretWhenCurveSecret = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the remaining duration in seconds and evaluates it against a supplied curve." }, + + Arguments = + { + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = false }, + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false }, + }, + }, + { + Name = "EvaluateRemainingPercent", + Type = "Function", + SecretWhenCurveSecret = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the remaining duration as a percentage value and evaluates it against a supplied curve." }, + + Arguments = + { + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = false }, + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false }, + }, + }, + { + Name = "GetClockTime", + Type = "Function", + Documentation = { "Returns the current time of the clock source used by this object." }, + + Arguments = + { + }, + + Returns = + { + { Name = "clockTime", Type = "FrameTime", Nilable = false }, + }, + }, + { + Name = "GetElapsedDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the elapsed duration of the stored time span." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "elapsedDuration", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetElapsedPercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the elapsed duration as a percentage value." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "elapsedPercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEndTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the end time of the stored time span." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "endTime", Type = "FrameTime", Nilable = false }, + }, + }, + { + Name = "GetModRate", + Type = "Function", + Documentation = { "Returns the divisor used to convert a duration from real time to base time." }, + + Arguments = + { + }, + + Returns = + { + { Name = "modRate", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRemainingDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the remaining duration of the stored time span." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "remainingDuration", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "GetRemainingPercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the remaining duration as a percentage value." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "remainingPercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStartTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the start time of the stored time span." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "startTime", Type = "FrameTime", Nilable = false }, + }, + }, + { + Name = "GetTotalDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the total duration of the stored time span." }, + + Arguments = + { + { Name = "modifier", Type = "DurationTimeModifier", Nilable = false, Default = "RealTime" }, + }, + + Returns = + { + { Name = "totalDuration", Type = "DurationSeconds", Nilable = false }, + }, + }, + { + Name = "HasSecretValues", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns true if the duration has been configured with any secret values." }, + + Arguments = + { + }, + + Returns = + { + { Name = "hasSecretValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsZero", + Type = "Function", + Documentation = { "Returns true if the duration object is measuring a zero duration time span." }, + + Arguments = + { + }, + + Returns = + { + { Name = "isZero", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Reset", + Type = "Function", + Documentation = { "Resets the duration object to represent a zero duration time span." }, + + Arguments = + { + }, + }, + { + Name = "SetTimeFromEnd", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Configures the duration object to represent an end time and a duration." }, + + Arguments = + { + { Name = "endTime", Type = "FrameTime", Nilable = false }, + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false, Default = 1, Documentation = { "Optional divisor for converting this time span to a base time." } }, + }, + }, + { + Name = "SetTimeFromStart", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Configures the duration object to represent a start time and a duration." }, + + Arguments = + { + { Name = "startTime", Type = "FrameTime", Nilable = false }, + { Name = "duration", Type = "DurationSeconds", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false, Default = 1, Documentation = { "Optional divisor for converting this time span to a base time." } }, + }, + }, + { + Name = "SetTimeSpan", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Configures the duration object to represent a fixed start and end time span. If the end time is earlier than the start time, the duration will clamp to zero." }, + + Arguments = + { + { Name = "startTime", Type = "FrameTime", Nilable = false }, + { Name = "endTime", Type = "FrameTime", Nilable = false }, + }, + }, + { + Name = "SetToDefaults", + Type = "Function", + Documentation = { "Resets all state on the duration, and clears the secret values flag." }, + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LuaDurationObjectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1c7fe23 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaDurationObjectSharedDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local LuaDurationObjectShared = +{ + Tables = + { + { + Name = "DurationTimeModifier", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "RealTime", Type = "DurationTimeModifier", EnumValue = 0, Documentation = { "Use real time for duration calculations. Durations will speed up or slow down based on the applied mod time." } }, + { Name = "BaseTime", Type = "DurationTimeModifier", EnumValue = 1, Documentation = { "Use base time for duration calculations. Durations will be unaffected the applied mod time." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LuaDurationObjectShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d672666 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/LuaTableUtilDocumentation.lua.annotated.lua @@ -0,0 +1,74 @@ +local LuaTableUtil = +{ + Name = "LuaTableUtil", + Type = "System", + Namespace = "C_TableUtil", + Environment = "All", + + Functions = + { + { + Name = "count", + Type = "Function", + MayReturnNothing = true, + Namespace = "table", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "table", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "numTableNodes", Type = "number", Nilable = false, Documentation = { "Total number of elements within the table" } }, + { Name = "numArrayNodes", Type = "number", Nilable = false, Documentation = { "Total number of elements within the table that had integral keys in the range [1..numTableNodes]" } }, + { Name = "maxArrayIndex", Type = "number", Nilable = false, Documentation = { "Largest integral key within the table, or zero if no such keys were found" } }, + }, + }, + { + Name = "create", + Type = "Function", + Namespace = "table", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "arraySizeHint", Type = "number", Nilable = false }, + { Name = "nodeSizeHint", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "table", Type = "LuaValueReference", Nilable = false }, + }, + }, + { + Name = "FindIndexedMismatch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Given two tables, finds the first index in the range (1, #t1) and (1, #t2) where two elements compare as inequal, or nil if no such elements are found." }, + + Arguments = + { + { Name = "t1", Type = "LuaValueReference", Nilable = false }, + { Name = "t2", Type = "LuaValueReference", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LuaTableUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bf35cf9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MacOptionsDocumentation.lua.annotated.lua @@ -0,0 +1,98 @@ +local MacOptions = +{ + Name = "MacOptions", + Type = "System", + Namespace = "C_MacOptions", + Environment = "All", + + Functions = + { + { + Name = "AreOSShortcutsDisabled", + Type = "Function", + + Returns = + { + { Name = "osShortcutsDisabledCVar", Type = "bool", Nilable = true }, + { Name = "osShortcutsDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetGameBundleName", + Type = "Function", + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "HasNewStyleInputMonitoring", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInputMonitoringEnabled", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMicrophoneEnabled", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUniversalAccessEnabled", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpenInputMonitoring", + Type = "Function", + }, + { + Name = "OpenMicrophoneRequestDialogue", + Type = "Function", + }, + { + Name = "OpenUniversalAccess", + Type = "Function", + }, + { + Name = "SetOSShortcutsDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "disable", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(MacOptions); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6104ea4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MailInfoDocumentation.lua.annotated.lua @@ -0,0 +1,177 @@ +local MailInfo = +{ + Name = "MailInfo", + Type = "System", + Namespace = "C_Mail", + Environment = "All", + + Functions = + { + { + Name = "CanCheckInbox", + Type = "Function", + + Returns = + { + { Name = "canCheckInbox", Type = "bool", Nilable = false }, + { Name = "secondsUntilAllowed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCraftingOrderMailInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inboxIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingOrderMailInfo", Nilable = true }, + }, + }, + { + Name = "HasInboxMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inboxIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inboxItemHasMoneyAttached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCommandPending", + Type = "Function", + + Returns = + { + { Name = "isCommandPending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetOpeningAll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "openingAll", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CloseInboxItem", + Type = "Event", + LiteralName = "CLOSE_INBOX_ITEM", + SynchronousEvent = true, + Payload = + { + { Name = "mailIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "MailClosed", + Type = "Event", + LiteralName = "MAIL_CLOSED", + SynchronousEvent = true, + }, + { + Name = "MailFailed", + Type = "Event", + LiteralName = "MAIL_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "MailInboxUpdate", + Type = "Event", + LiteralName = "MAIL_INBOX_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "MailLockSendItems", + Type = "Event", + LiteralName = "MAIL_LOCK_SEND_ITEMS", + SynchronousEvent = true, + Payload = + { + { Name = "attachSlot", Type = "luaIndex", Nilable = false }, + { Name = "itemLink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "MailSendInfoUpdate", + Type = "Event", + LiteralName = "MAIL_SEND_INFO_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "MailSendSuccess", + Type = "Event", + LiteralName = "MAIL_SEND_SUCCESS", + SynchronousEvent = true, + }, + { + Name = "MailShow", + Type = "Event", + LiteralName = "MAIL_SHOW", + SynchronousEvent = true, + }, + { + Name = "MailSuccess", + Type = "Event", + LiteralName = "MAIL_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "MailUnlockSendItems", + Type = "Event", + LiteralName = "MAIL_UNLOCK_SEND_ITEMS", + SynchronousEvent = true, + }, + { + Name = "SendMailCodChanged", + Type = "Event", + LiteralName = "SEND_MAIL_COD_CHANGED", + SynchronousEvent = true, + }, + { + Name = "SendMailMoneyChanged", + Type = "Event", + LiteralName = "SEND_MAIL_MONEY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "UpdatePendingMail", + Type = "Event", + LiteralName = "UPDATE_PENDING_MAIL", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(MailInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..28f28de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local MajorFactionsConstants = +{ + Tables = + { + { + Name = "MajorFactionFeatureAbility", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Generic", Type = "MajorFactionFeatureAbility", EnumValue = 0 }, + { Name = "Fishing", Type = "MajorFactionFeatureAbility", EnumValue = 1 }, + { Name = "Hunts", Type = "MajorFactionFeatureAbility", EnumValue = 2 }, + }, + }, + { + Name = "MajorFactionType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "MajorFactionType", EnumValue = 0 }, + { Name = "DragonscaleExpedition", Type = "MajorFactionType", EnumValue = 1 }, + { Name = "MaruukCentaur", Type = "MajorFactionType", EnumValue = 2 }, + { Name = "IskaaraTuskarr", Type = "MajorFactionType", EnumValue = 3 }, + { Name = "ValdrakkenAccord", Type = "MajorFactionType", EnumValue = 4 }, + }, + }, + { + Name = "MajorFactionsConsts", + Type = "Constants", + Values = + { + { Name = "WORLD_STATE_RENOWN_CAP_10_0", Type = "number", Value = 19735 }, + { Name = "WORLD_STATE_RAPID_RENOWN_CAP_10_0", Type = "number", Value = 20851 }, + { Name = "PLUNDERSTORM_MAJOR_FACTION_ID", Type = "number", Value = 2593 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MajorFactionsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8202da6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MajorFactionsDocumentation.lua.annotated.lua @@ -0,0 +1,311 @@ +local MajorFactions = +{ + Name = "MajorFactionsUI", + Type = "System", + Namespace = "C_MajorFactions", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentRenownLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMajorFactionData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "MajorFactionData", Nilable = true }, + }, + }, + { + Name = "GetMajorFactionIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "expansionID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "majorFactionIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetMajorFactionRenownInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "MajorFactionRenownInfo", Nilable = true }, + }, + }, + { + Name = "GetRenownLevels", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "levels", Type = "table", InnerType = "MajorFactionRenownLevelInfo", Nilable = false }, + }, + }, + { + Name = "GetRenownNPCFactionID", + Type = "Function", + + Returns = + { + { Name = "renownNPCFactionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRenownRewardsForLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + { Name = "renownLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rewards", Type = "table", InnerType = "MajorFactionRenownRewardInfo", Nilable = false }, + }, + }, + { + Name = "HasMaximumRenown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasMaxRenown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMajorFactionHiddenFromExpansionPage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isHidden", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWeeklyRenownCapped", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isWeeklyCapped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldDisplayMajorFactionAsJourney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "shouldDisplayMajorFactionAsJourney", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUseJourneyRewardTrack", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "shouldUseJourneyRewardTrack", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "MajorFactionInteractionEnded", + Type = "Event", + LiteralName = "MAJOR_FACTION_INTERACTION_ENDED", + SynchronousEvent = true, + }, + { + Name = "MajorFactionInteractionStarted", + Type = "Event", + LiteralName = "MAJOR_FACTION_INTERACTION_STARTED", + SynchronousEvent = true, + }, + { + Name = "MajorFactionRenownLevelChanged", + Type = "Event", + LiteralName = "MAJOR_FACTION_RENOWN_LEVEL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + { Name = "newRenownLevel", Type = "number", Nilable = false }, + { Name = "oldRenownLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "MajorFactionUnlocked", + Type = "Event", + LiteralName = "MAJOR_FACTION_UNLOCKED", + SynchronousEvent = true, + Payload = + { + { Name = "majorFactionID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "MajorFactionData", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "highlights", Type = "table", InnerType = "RenownHighlightInfo", Nilable = false }, + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "expansionID", Type = "number", Nilable = false }, + { Name = "bountySetID", Type = "number", Nilable = false }, + { Name = "isUnlocked", Type = "bool", Nilable = false }, + { Name = "useJourneyUnlockToast", Type = "bool", Nilable = false }, + { Name = "unlockDescription", Type = "cstring", Nilable = true }, + { Name = "uiPriority", Type = "number", Nilable = false }, + { Name = "renownLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "renownReputationEarned", Type = "number", Nilable = false }, + { Name = "renownLevelThreshold", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "celebrationSoundKit", Type = "number", Nilable = false }, + { Name = "renownFanfareSoundKitID", Type = "number", Nilable = false }, + { Name = "factionFontColor", Type = "DBColorExport", Nilable = true }, + { Name = "renownTrackLevelEffectID", Type = "number", Nilable = true }, + { Name = "playerCompanionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "MajorFactionRenownInfo", + Type = "Structure", + Fields = + { + { Name = "renownLevel", Type = "number", Nilable = false }, + { Name = "renownReputationEarned", Type = "number", Nilable = false }, + { Name = "renownLevelThreshold", Type = "number", Nilable = false }, + }, + }, + { + Name = "MajorFactionRenownLevelInfo", + Type = "Structure", + Fields = + { + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + { Name = "isMilestone", Type = "bool", Nilable = false }, + { Name = "isCapstone", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MajorFactionRenownRewardInfo", + Type = "Structure", + Fields = + { + { Name = "renownRewardID", Type = "number", Nilable = false }, + { Name = "uiOrder", Type = "number", Nilable = false }, + { Name = "isAccountUnlock", Type = "bool", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "mountID", Type = "number", Nilable = true }, + { Name = "transmogID", Type = "number", Nilable = true }, + { Name = "transmogSetID", Type = "number", Nilable = true }, + { Name = "titleMaskID", Type = "number", Nilable = true }, + { Name = "transmogIllusionSourceID", Type = "number", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "description", Type = "cstring", Nilable = true }, + { Name = "toastDescription", Type = "cstring", Nilable = true }, + { Name = "rewardType", Type = "number", Nilable = true }, + }, + }, + { + Name = "RenownHighlightInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MajorFactions); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..00fff28 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,109 @@ +local MapConstants = +{ + Tables = + { + { + Name = "MapCanvasPosition", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "MapCanvasPosition", EnumValue = 0 }, + { Name = "BottomLeft", Type = "MapCanvasPosition", EnumValue = 1 }, + { Name = "BottomRight", Type = "MapCanvasPosition", EnumValue = 2 }, + { Name = "TopLeft", Type = "MapCanvasPosition", EnumValue = 3 }, + { Name = "TopRight", Type = "MapCanvasPosition", EnumValue = 4 }, + }, + }, + { + Name = "MapobjEventTypes", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "PlayAnim", Type = "MapobjEventTypes", EnumValue = 0 }, + { Name = "SetAnimSpeed", Type = "MapobjEventTypes", EnumValue = 1 }, + }, + }, + { + Name = "UIMapFlag", + Type = "Enumeration", + NumValues = 22, + MinValue = 1, + MaxValue = 2097152, + Fields = + { + { Name = "NoHighlight", Type = "UIMapFlag", EnumValue = 1 }, + { Name = "ShowOverlays", Type = "UIMapFlag", EnumValue = 2 }, + { Name = "ShowTaxiNodes", Type = "UIMapFlag", EnumValue = 4 }, + { Name = "GarrisonMap", Type = "UIMapFlag", EnumValue = 8 }, + { Name = "FallbackToParentMap", Type = "UIMapFlag", EnumValue = 16 }, + { Name = "NoHighlightTexture", Type = "UIMapFlag", EnumValue = 32 }, + { Name = "ShowTaskObjectives", Type = "UIMapFlag", EnumValue = 64 }, + { Name = "NoWorldPositions", Type = "UIMapFlag", EnumValue = 128 }, + { Name = "HideArchaeologyDigs", Type = "UIMapFlag", EnumValue = 256 }, + { Name = "DoNotTranslateBranches", Type = "UIMapFlag", EnumValue = 512 }, + { Name = "HideIcons", Type = "UIMapFlag", EnumValue = 1024 }, + { Name = "HideVignettes", Type = "UIMapFlag", EnumValue = 2048 }, + { Name = "ForceAllOverlayExplored", Type = "UIMapFlag", EnumValue = 4096 }, + { Name = "FlightMapShowZoomOut", Type = "UIMapFlag", EnumValue = 8192 }, + { Name = "FlightMapAutoZoom", Type = "UIMapFlag", EnumValue = 16384 }, + { Name = "ForceOnNavbar", Type = "UIMapFlag", EnumValue = 32768 }, + { Name = "AlwaysAllowUserWaypoints", Type = "UIMapFlag", EnumValue = 65536 }, + { Name = "AlwaysAllowTaxiPathing", Type = "UIMapFlag", EnumValue = 131072 }, + { Name = "ForceAllowMapLinks", Type = "UIMapFlag", EnumValue = 262144 }, + { Name = "DoNotShowOnNavbar", Type = "UIMapFlag", EnumValue = 524288 }, + { Name = "IsCityMap", Type = "UIMapFlag", EnumValue = 1048576 }, + { Name = "IgnoreInTranslationsToParent", Type = "UIMapFlag", EnumValue = 2097152 }, + }, + }, + { + Name = "UIMapGroupFlag", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "ShowIconsAcrossFloors", Type = "UIMapGroupFlag", EnumValue = 1 }, + }, + }, + { + Name = "UIMapSystem", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "World", Type = "UIMapSystem", EnumValue = 0 }, + { Name = "Taxi", Type = "UIMapSystem", EnumValue = 1 }, + { Name = "Adventure", Type = "UIMapSystem", EnumValue = 2 }, + { Name = "Minimap", Type = "UIMapSystem", EnumValue = 3 }, + }, + }, + { + Name = "UIMapType", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Cosmic", Type = "UIMapType", EnumValue = 0 }, + { Name = "World", Type = "UIMapType", EnumValue = 1 }, + { Name = "Continent", Type = "UIMapType", EnumValue = 2 }, + { Name = "Zone", Type = "UIMapType", EnumValue = 3 }, + { Name = "Dungeon", Type = "UIMapType", EnumValue = 4 }, + { Name = "Micro", Type = "UIMapType", EnumValue = 5 }, + { Name = "Orphan", Type = "UIMapType", EnumValue = 6 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MapConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fa2368c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapDocumentation.lua.annotated.lua @@ -0,0 +1,744 @@ +local Map = +{ + Name = "MapUI", + Type = "System", + Namespace = "C_Map", + Environment = "All", + + Functions = + { + { + Name = "CanSetUserWaypointOnMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canSet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearUserWaypoint", + Type = "Function", + }, + { + Name = "CloseWorldMapInteraction", + Type = "Function", + }, + { + Name = "GetAreaInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "areaID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetBestMapForUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only works for the player and party members." }, + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetBountySetMaps", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bountySetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetFallbackWorldMapID", + Type = "Function", + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapArtBackgroundAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "atlasName", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetMapArtHelpTextPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "position", Type = "MapCanvasPosition", Nilable = false }, + }, + }, + { + Name = "GetMapArtID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapArtID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapArtLayerTextures", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "layerIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "textures", Type = "table", InnerType = "fileID", Nilable = false }, + }, + }, + { + Name = "GetMapArtLayers", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "layerInfo", Type = "table", InnerType = "UiMapLayerInfo", Nilable = false }, + }, + }, + { + Name = "GetMapArtZoneTextPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "position", Type = "MapCanvasPosition", Nilable = false }, + }, + }, + { + Name = "GetMapBannersForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapBanners", Type = "table", InnerType = "MapBannerInfo", Nilable = false }, + }, + }, + { + Name = "GetMapChildrenInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "mapType", Type = "UIMapType", Nilable = true }, + { Name = "allDescendants", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "info", Type = "table", InnerType = "UiMapDetails", Nilable = false }, + }, + }, + { + Name = "GetMapDisplayInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hideIcons", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMapGroupID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapGroupID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapGroupMembersInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapGroupID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "table", InnerType = "UiMapGroupMemberInfo", Nilable = false }, + }, + }, + { + Name = "GetMapHighlightInfoAtPosition", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "fileDataID", Type = "fileID", Nilable = false }, + { Name = "atlasID", Type = "textureAtlas", Nilable = false }, + { Name = "texturePercentageX", Type = "number", Nilable = false }, + { Name = "texturePercentageY", Type = "number", Nilable = false }, + { Name = "textureX", Type = "number", Nilable = false }, + { Name = "textureY", Type = "number", Nilable = false }, + { Name = "scrollChildX", Type = "number", Nilable = false }, + { Name = "scrollChildY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapHighlightPulseInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "fileDataID", Type = "fileID", Nilable = false }, + { Name = "atlasID", Type = "textureAtlas", Nilable = false }, + { Name = "texturePercentageX", Type = "number", Nilable = false }, + { Name = "texturePercentageY", Type = "number", Nilable = false }, + { Name = "textureX", Type = "number", Nilable = false }, + { Name = "textureY", Type = "number", Nilable = false }, + { Name = "scrollChildX", Type = "number", Nilable = false }, + { Name = "scrollChildY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "UiMapDetails", Nilable = false }, + }, + }, + { + Name = "GetMapInfoAtPosition", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "ignoreZoneMapPositionData", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "info", Type = "UiMapDetails", Nilable = false }, + }, + }, + { + Name = "GetMapLevels", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "playerMinLevel", Type = "number", Nilable = false }, + { Name = "playerMaxLevel", Type = "number", Nilable = false }, + { Name = "petMinLevel", Type = "number", Nilable = false, Default = 0 }, + { Name = "petMaxLevel", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetMapLinksForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapLinks", Type = "table", InnerType = "MapLinkInfo", Nilable = false }, + }, + }, + { + Name = "GetMapPosFromWorldPos", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "continentID", Type = "number", Nilable = false }, + { Name = "worldPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "overrideUiMapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "mapPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetMapRectOnMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "topUiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "minX", Type = "number", Nilable = false }, + { Name = "maxX", Type = "number", Nilable = false }, + { Name = "minY", Type = "number", Nilable = false }, + { Name = "maxY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapWorldSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the size in yards of the area represented by the map." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "width", Type = "number", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerMapPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only works for the player and party members." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "GetUserWaypoint", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "point", Type = "UiMapPoint", Nilable = false }, + }, + }, + { + Name = "GetUserWaypointFromHyperlink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "hyperlink", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "point", Type = "UiMapPoint", Nilable = false }, + }, + }, + { + Name = "GetUserWaypointHyperlink", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "hyperlink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetUserWaypointPositionForMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetWorldPosFromMapPos", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "mapPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + + Returns = + { + { Name = "continentID", Type = "number", Nilable = false }, + { Name = "worldPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "HasUserWaypoint", + Type = "Function", + + Returns = + { + { Name = "hasUserWaypoint", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCityMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCityMap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMapValidForNavBarDropdown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MapHasArt", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasArt", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpenWorldMap", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "RequestPreloadMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetUserWaypoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "point", Type = "UiMapPoint", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "NewWmoChunk", + Type = "Event", + LiteralName = "NEW_WMO_CHUNK", + SynchronousEvent = true, + }, + { + Name = "PlayerMapChanged", + Type = "Event", + LiteralName = "PLAYER_MAP_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "oldMapID", Type = "number", Nilable = false }, + { Name = "newMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UserWaypointUpdated", + Type = "Event", + LiteralName = "USER_WAYPOINT_UPDATED", + SynchronousEvent = true, + }, + { + Name = "WorldMapOpen", + Type = "Event", + LiteralName = "WORLD_MAP_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ZoneChanged", + Type = "Event", + LiteralName = "ZONE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ZoneChangedIndoors", + Type = "Event", + LiteralName = "ZONE_CHANGED_INDOORS", + SynchronousEvent = true, + }, + { + Name = "ZoneChangedNewArea", + Type = "Event", + LiteralName = "ZONE_CHANGED_NEW_AREA", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "MapBannerInfo", + Type = "Structure", + Fields = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "atlasName", Type = "string", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = true }, + }, + }, + { + Name = "MapLinkInfo", + Type = "Structure", + Fields = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "atlasName", Type = "string", Nilable = false }, + { Name = "linkedUiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UiMapDetails", + Type = "Structure", + Fields = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "mapType", Type = "UIMapType", Nilable = false }, + { Name = "parentMapID", Type = "number", Nilable = false }, + { Name = "flags", Type = "UIMapFlag", Nilable = false }, + }, + }, + { + Name = "UiMapGroupMemberInfo", + Type = "Structure", + Fields = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "relativeHeightIndex", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UiMapHighlightInfo", + Type = "Structure", + Fields = + { + { Name = "fileDataID", Type = "fileID", Nilable = false }, + { Name = "atlasID", Type = "textureAtlas", Nilable = false }, + { Name = "texturePercentageX", Type = "number", Nilable = false }, + { Name = "texturePercentageY", Type = "number", Nilable = false }, + { Name = "textureX", Type = "number", Nilable = false }, + { Name = "textureY", Type = "number", Nilable = false }, + { Name = "scrollChildX", Type = "number", Nilable = false }, + { Name = "scrollChildY", Type = "number", Nilable = false }, + }, + }, + { + Name = "UiMapLayerInfo", + Type = "Structure", + Fields = + { + { Name = "layerWidth", Type = "number", Nilable = false }, + { Name = "layerHeight", Type = "number", Nilable = false }, + { Name = "tileWidth", Type = "number", Nilable = false }, + { Name = "tileHeight", Type = "number", Nilable = false }, + { Name = "minScale", Type = "number", Nilable = false }, + { Name = "maxScale", Type = "number", Nilable = false }, + { Name = "additionalZoomSteps", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Map); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c9aacfb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MapExplorationDocumentation.lua.annotated.lua @@ -0,0 +1,85 @@ +local MapExploration = +{ + Name = "MapExplorationInfo", + Type = "System", + Namespace = "C_MapExplorationInfo", + Environment = "All", + + Functions = + { + { + Name = "GetExploredAreaIDsAtPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "normalizedPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + + Returns = + { + { Name = "areaID", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetExploredMapTextures", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "overlayInfo", Type = "table", InnerType = "UiMapExplorationInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "MapExplorationUpdated", + Type = "Event", + LiteralName = "MAP_EXPLORATION_UPDATED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "UiMapExplorationHitRect", + Type = "Structure", + Fields = + { + { Name = "top", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + { Name = "left", Type = "number", Nilable = false }, + { Name = "right", Type = "number", Nilable = false }, + }, + }, + { + Name = "UiMapExplorationInfo", + Type = "Structure", + Fields = + { + { Name = "textureWidth", Type = "number", Nilable = false }, + { Name = "textureHeight", Type = "number", Nilable = false }, + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + { Name = "isShownByMouseOver", Type = "bool", Nilable = false }, + { Name = "isDrawOnTopLayer", Type = "bool", Nilable = false }, + { Name = "fileDataIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "hitRect", Type = "UiMapExplorationHitRect", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MapExploration); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MatrixSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MatrixSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f65fed6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MatrixSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local MatrixShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(MatrixShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8fdfbc6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MerchantFrameDocumentation.lua.annotated.lua @@ -0,0 +1,136 @@ +local MerchantFrame = +{ + Name = "MerchantFrame", + Type = "System", + Namespace = "C_MerchantFrame", + Environment = "All", + + Functions = + { + { + Name = "GetBuybackItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "buybackSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "buybackItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "MerchantItemInfo", Nilable = false }, + }, + }, + { + Name = "GetNumJunkItems", + Type = "Function", + + Returns = + { + { Name = "numJunkItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsMerchantItemRefundable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "refundable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSellAllJunkEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SellAllJunkItems", + Type = "Function", + }, + }, + + Events = + { + { + Name = "MerchantClosed", + Type = "Event", + LiteralName = "MERCHANT_CLOSED", + SynchronousEvent = true, + }, + { + Name = "MerchantFilterItemUpdate", + Type = "Event", + LiteralName = "MERCHANT_FILTER_ITEM_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MerchantShow", + Type = "Event", + LiteralName = "MERCHANT_SHOW", + SynchronousEvent = true, + }, + { + Name = "MerchantUpdate", + Type = "Event", + LiteralName = "MERCHANT_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "MerchantItemInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "price", Type = "number", Nilable = false, Default = 0 }, + { Name = "stackCount", Type = "number", Nilable = false, Default = 0 }, + { Name = "numAvailable", Type = "number", Nilable = false, Default = 0 }, + { Name = "isPurchasable", Type = "bool", Nilable = false, Default = false }, + { Name = "isUsable", Type = "bool", Nilable = false, Default = false }, + { Name = "hasExtendedCost", Type = "bool", Nilable = false, Default = false }, + { Name = "currencyID", Type = "number", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "isQuestStartItem", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MerchantFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..278c61c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,42 @@ +local MinimapConstants = +{ + Tables = + { + { + Name = "MinimapTrackingFilter", + Type = "Enumeration", + NumValues = 24, + MinValue = 0, + MaxValue = 4194304, + Fields = + { + { Name = "Unfiltered", Type = "MinimapTrackingFilter", EnumValue = 0 }, + { Name = "Auctioneer", Type = "MinimapTrackingFilter", EnumValue = 1 }, + { Name = "Banker", Type = "MinimapTrackingFilter", EnumValue = 2 }, + { Name = "Battlemaster", Type = "MinimapTrackingFilter", EnumValue = 4 }, + { Name = "TaxiNode", Type = "MinimapTrackingFilter", EnumValue = 8 }, + { Name = "VenderFood", Type = "MinimapTrackingFilter", EnumValue = 16 }, + { Name = "Innkeeper", Type = "MinimapTrackingFilter", EnumValue = 32 }, + { Name = "Mailbox", Type = "MinimapTrackingFilter", EnumValue = 64 }, + { Name = "TrainerProfession", Type = "MinimapTrackingFilter", EnumValue = 128 }, + { Name = "VendorReagent", Type = "MinimapTrackingFilter", EnumValue = 256 }, + { Name = "Repair", Type = "MinimapTrackingFilter", EnumValue = 512 }, + { Name = "TrivialQuests", Type = "MinimapTrackingFilter", EnumValue = 1024 }, + { Name = "Stablemaster", Type = "MinimapTrackingFilter", EnumValue = 2048 }, + { Name = "Transmogrifier", Type = "MinimapTrackingFilter", EnumValue = 4096 }, + { Name = "POI", Type = "MinimapTrackingFilter", EnumValue = 8192 }, + { Name = "Target", Type = "MinimapTrackingFilter", EnumValue = 16384 }, + { Name = "Focus", Type = "MinimapTrackingFilter", EnumValue = 32768 }, + { Name = "QuestPOIs", Type = "MinimapTrackingFilter", EnumValue = 65536 }, + { Name = "Digsites", Type = "MinimapTrackingFilter", EnumValue = 131072 }, + { Name = "Barber", Type = "MinimapTrackingFilter", EnumValue = 262144 }, + { Name = "ItemUpgrade", Type = "MinimapTrackingFilter", EnumValue = 524288 }, + { Name = "VendorPoison", Type = "MinimapTrackingFilter", EnumValue = 1048576 }, + { Name = "AccountCompletedQuests", Type = "MinimapTrackingFilter", EnumValue = 2097152 }, + { Name = "AccountBanker", Type = "MinimapTrackingFilter", EnumValue = 4194304 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MinimapConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c248e48 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapDocumentation.lua.annotated.lua @@ -0,0 +1,341 @@ +local Minimap = +{ + Name = "Minimap", + Type = "System", + Namespace = "C_Minimap", + Environment = "All", + + Functions = + { + { + Name = "CanTrackBattlePets", + Type = "Function", + + Returns = + { + { Name = "CanTrackBattlePets", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearAllTracking", + Type = "Function", + }, + { + Name = "ClearMinimapInsetInfo", + Type = "Function", + }, + { + Name = "GetDefaultTrackingValue", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterType", Type = "MinimapTrackingFilter", Nilable = false }, + }, + + Returns = + { + { Name = "defaultValue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDrawGroundTextures", + Type = "Function", + + Returns = + { + { Name = "draw", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNumQuestPOIWorldEffects", + Type = "Function", + + Returns = + { + { Name = "worldEffectCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTrackingTypes", + Type = "Function", + + Returns = + { + { Name = "numTrackingTypes", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetObjectIconTextureCoords", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "textureCoordsX", Type = "number", Nilable = false }, + { Name = "textureCoordsY", Type = "number", Nilable = false }, + { Name = "textureCoordsZ", Type = "number", Nilable = false }, + { Name = "textureCoordsW", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPOITextureCoords", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "textureCoordsX", Type = "number", Nilable = false }, + { Name = "textureCoordsY", Type = "number", Nilable = false }, + { Name = "textureCoordsZ", Type = "number", Nilable = false }, + { Name = "textureCoordsW", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrackingFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "trackingType", Type = "MinimapScriptTrackingFilter", Nilable = false }, + }, + }, + { + Name = "GetTrackingInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "trackingInfo", Type = "MinimapScriptTrackingInfo", Nilable = true }, + }, + }, + { + Name = "GetUiMapID", + Type = "Function", + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetViewRadius", + Type = "Function", + + Returns = + { + { Name = "yards", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsFilteredOut", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterType", Type = "MinimapTrackingFilter", Nilable = false }, + }, + + Returns = + { + { Name = "isFiltered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInsideQuestBlob", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isInside", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRotateMinimapIgnored", + Type = "Function", + + Returns = + { + { Name = "isIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackingAccountCompletedQuests", + Type = "Function", + + Returns = + { + { Name = "IsTrackingAccountCompletedQuests", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackingBattlePets", + Type = "Function", + + Returns = + { + { Name = "isTrackingBattlePets", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackingHiddenQuests", + Type = "Function", + + Returns = + { + { Name = "isTrackingHiddenQuests", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDrawGroundTextures", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "draw", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetIgnoreRotateMinimap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMinimapInsetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "minAngle", Type = "number", Nilable = false }, + { Name = "maxAngle", Type = "number", Nilable = false }, + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTracking", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "on", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUseHybridMinimap", + Type = "Function", + + Returns = + { + { Name = "shouldUse", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "MinimapPing", + Type = "Event", + LiteralName = "MINIMAP_PING", + SecretPayloads = true, + HasRestrictions = true, + CallbackEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + }, + }, + { + Name = "MinimapUpdateTracking", + Type = "Event", + LiteralName = "MINIMAP_UPDATE_TRACKING", + UniqueEvent = true, + }, + { + Name = "MinimapUpdateZoom", + Type = "Event", + LiteralName = "MINIMAP_UPDATE_ZOOM", + UniqueEvent = true, + }, + { + Name = "PlayerInsideQuestBlobStateChanged", + Type = "Event", + LiteralName = "PLAYER_INSIDE_QUEST_BLOB_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "isInside", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "MinimapScriptTrackingFilter", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "filterID", Type = "MinimapTrackingFilter", Nilable = true }, + }, + }, + { + Name = "MinimapScriptTrackingInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "subType", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Minimap); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..97cf66c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MinimapFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,369 @@ +local MinimapFrameAPI = +{ + Name = "MinimapFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetPingPosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetZoom", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "zoomFactor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetZoomLevels", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "zoomLevels", Type = "number", Nilable = false }, + }, + }, + { + Name = "PingLocation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "locationX", Type = "number", Nilable = false }, + { Name = "locationY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetArchBlobInsideAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetArchBlobInsideTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetArchBlobOutsideAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetArchBlobOutsideTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetArchBlobRingAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetArchBlobRingScalar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetArchBlobRingTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetBlipTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetCorpsePOIArrowTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetIconTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetMaskTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetPOIArrowTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetPlayerTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobInsideAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobInsideTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobOutsideAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobOutsideTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobRingAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobRingScalar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetQuestBlobRingTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetStaticPOIArrowTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobInsideAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobInsideTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobOutsideAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobOutsideTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobRingAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobRingScalar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scalar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTaskBlobRingTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetZoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoomFactor", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateBlips", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(MinimapFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b980e7f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MirrorTimerDocumentation.lua.annotated.lua @@ -0,0 +1,71 @@ +local MirrorTimer = +{ + Name = "MirrorTimer", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetMirrorTimerInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "timerIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "startValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "paused", Type = "number", Nilable = false }, + { Name = "label", Type = "cstring", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMirrorTimerProgress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "timerName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "MirrorTimerInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "startValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "paused", Type = "number", Nilable = false }, + { Name = "label", Type = "cstring", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MirrorTimer); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ModelAnimationSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ModelAnimationSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..68dc161 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ModelAnimationSharedDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local ModelAnimationShared = +{ + Tables = + { + { + Name = "ModelBlendOperation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "ModelBlendOperation", EnumValue = 0 }, + { Name = "Anim", Type = "ModelBlendOperation", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ModelAnimationShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MoneyConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MoneyConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..62d9d9a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MoneyConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,16 @@ +local MoneyConstants = +{ + Tables = + { + { + Name = "MoneyFormattingConstants", + Type = "Constants", + Values = + { + { Name = "GOLD_REWARD_THRESHOLD_TO_HIDE_COPPER", Type = "number", Value = 10 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MoneyConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..af59139 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local MountConstants = +{ + Tables = + { + { + Name = "MountType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Ground", Type = "MountType", EnumValue = 0 }, + { Name = "Flying", Type = "MountType", EnumValue = 1 }, + { Name = "Aquatic", Type = "MountType", EnumValue = 2 }, + { Name = "Dragonriding", Type = "MountType", EnumValue = 3 }, + { Name = "RideAlong", Type = "MountType", EnumValue = 4 }, + }, + }, + { + Name = "MountTypeFlag", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "IsFlyingMount", Type = "MountTypeFlag", EnumValue = 1 }, + { Name = "IsAquaticMount", Type = "MountTypeFlag", EnumValue = 2 }, + { Name = "IsDragonRidingMount", Type = "MountTypeFlag", EnumValue = 4 }, + { Name = "IsRideAlongMount", Type = "MountTypeFlag", EnumValue = 8 }, + }, + }, + { + Name = "MountDynamicFlightConsts", + Type = "Constants", + Values = + { + { Name = "TRAIT_SYSTEM_ID", Type = "number", Value = 1 }, + { Name = "TREE_ID", Type = "number", Value = 672 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MountConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..192b039 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MountJournalDocumentation.lua.annotated.lua @@ -0,0 +1,697 @@ +local MountJournal = +{ + Name = "MountJournal", + Type = "System", + Namespace = "C_MountJournal", + Environment = "All", + + Functions = + { + { + Name = "ApplyMountEquipment", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canContinue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AreMountEquipmentEffectsSuppressed", + Type = "Function", + + Returns = + { + { Name = "areEffectsSuppressed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearFanfare", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClearRecentFanfares", + Type = "Function", + }, + { + Name = "Dismiss", + Type = "Function", + }, + { + Name = "GetAllCreatureDisplayIDsForMountID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "creatureDisplayIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAppliedMountEquipmentID", + Type = "Function", + + Returns = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCollectedDragonridingMounts", + Type = "Function", + + Returns = + { + { Name = "mountIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCollectedFilterSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDisplayedMountAllCreatureDisplayInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "allDisplayInfo", Type = "table", InnerType = "MountCreatureDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetDisplayedMountID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "displayIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDisplayedMountInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "displayIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "sourceType", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "isFactionSpecific", Type = "bool", Nilable = false }, + { Name = "faction", Type = "PvPFaction", Nilable = true }, + { Name = "shouldHideOnChar", Type = "bool", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "isSteadyFlight", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDisplayedMountInfoExtra", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "creatureDisplayInfoID", Type = "number", Nilable = true }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "source", Type = "cstring", Nilable = false }, + { Name = "isSelfMount", Type = "bool", Nilable = false }, + { Name = "mountTypeID", Type = "number", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false }, + { Name = "animID", Type = "number", Nilable = false }, + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + { Name = "disablePlayerMountPreview", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDynamicFlightModeSpellID", + Type = "Function", + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIsFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "canSetFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMountAllCreatureDisplayInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "allDisplayInfo", Type = "table", InnerType = "MountCreatureDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetMountEquipmentUnlockLevel", + Type = "Function", + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMountFromItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mountID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMountFromSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mountID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMountIDs", + Type = "Function", + + Returns = + { + { Name = "mountIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetMountInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "sourceType", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "isFactionSpecific", Type = "bool", Nilable = false }, + { Name = "faction", Type = "PvPFaction", Nilable = true }, + { Name = "shouldHideOnChar", Type = "bool", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "isSteadyFlight", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMountInfoExtraByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "creatureDisplayInfoID", Type = "number", Nilable = true }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "source", Type = "cstring", Nilable = false }, + { Name = "isSelfMount", Type = "bool", Nilable = false }, + { Name = "mountTypeID", Type = "number", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false }, + { Name = "animID", Type = "number", Nilable = false }, + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + { Name = "disablePlayerMountPreview", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMountLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mountCreatureDisplayInfoLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetMountUsabilityByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "checkIndoors", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "useError", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetNumDisplayedMounts", + Type = "Function", + + Returns = + { + { Name = "numMounts", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMounts", + Type = "Function", + + Returns = + { + { Name = "numMounts", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMountsNeedingFanfare", + Type = "Function", + + Returns = + { + { Name = "numMountsNeedingFanfare", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsDragonridingUnlocked", + Type = "Function", + Documentation = { "Returns whether the player has unlocked the ability to switch between Skyriding and steady flight styles for flying mounts ." }, + + Returns = + { + { Name = "isUnlocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemMountEquipment", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Determines if the item is mount equipment based on its class and subclass." }, + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isMountEquipment", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMountEquipmentApplied", + Type = "Function", + + Returns = + { + { Name = "isApplied", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSourceChecked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTypeChecked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingDefaultFilters", + Type = "Function", + + Returns = + { + { Name = "isUsingDefaultFilters", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidSourceFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidTypeFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NeedsFanfare", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "needsFanfare", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Pickup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "displayIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "PickupDynamicFlightMode", + Type = "Function", + }, + { + Name = "SetAllSourceFilters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllTypeFilters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCollectedFilterSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDefaultFilters", + Type = "Function", + }, + { + Name = "SetIsFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountIndex", Type = "luaIndex", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSearch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchValue", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetSourceFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTypeFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterIndex", Type = "luaIndex", Nilable = false }, + { Name = "isChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SummonByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SwapDynamicFlightMode", + Type = "Function", + }, + }, + + Events = + { + { + Name = "MountEquipmentApplyResult", + Type = "Event", + LiteralName = "MOUNT_EQUIPMENT_APPLY_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MountJournalSearchUpdated", + Type = "Event", + LiteralName = "MOUNT_JOURNAL_SEARCH_UPDATED", + SynchronousEvent = true, + }, + { + Name = "MountJournalUsabilityChanged", + Type = "Event", + LiteralName = "MOUNT_JOURNAL_USABILITY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "NewMountAdded", + Type = "Event", + LiteralName = "NEW_MOUNT_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "mountID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "MountCreatureDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "creatureDisplayID", Type = "number", Nilable = false }, + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MountInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "sourceType", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "isFactionSpecific", Type = "bool", Nilable = false }, + { Name = "faction", Type = "PvPFaction", Nilable = true }, + { Name = "shouldHideOnChar", Type = "bool", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "isSteadyFlight", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MountInfoExtra", + Type = "Structure", + Fields = + { + { Name = "creatureDisplayInfoID", Type = "number", Nilable = true }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "source", Type = "cstring", Nilable = false }, + { Name = "isSelfMount", Type = "bool", Nilable = false }, + { Name = "mountTypeID", Type = "number", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false }, + { Name = "animID", Type = "number", Nilable = false }, + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + { Name = "disablePlayerMountPreview", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MountJournal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua.annotated.lua new file mode 100644 index 0000000..95b30fa --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MovieDocumentation.lua.annotated.lua @@ -0,0 +1,102 @@ +local Movie = +{ + Name = "Movie", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CancelPreloadingMovie", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieId", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMovieDownloadProgress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "inProgress", Type = "bool", Nilable = false }, + { Name = "downloaded", Type = "BigUInteger", Nilable = false }, + { Name = "total", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "IsMovieLocal", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isLocal", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMoviePlayable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPlayable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMovieReadable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "readable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PreloadMovie", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieId", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Movie); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6b17e77 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoDocumentation.lua.annotated.lua @@ -0,0 +1,351 @@ +local MythicPlusInfo = +{ + Name = "MythicPlusInfo", + Type = "System", + Namespace = "C_MythicPlus", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentAffixes", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "affixIDs", Type = "table", InnerType = "MythicPlusKeystoneAffix", Nilable = false }, + }, + }, + { + Name = "GetCurrentSeason", + Type = "Function", + + Returns = + { + { Name = "seasonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentSeasonValues", + Type = "Function", + + Returns = + { + { Name = "displaySeasonID", Type = "number", Nilable = false }, + { Name = "milestoneSeasonID", Type = "number", Nilable = false }, + { Name = "rewardSeasonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentUIDisplaySeason", + Type = "Function", + + Returns = + { + { Name = "seasonID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetEndOfRunGearSequenceLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "keystoneLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sequenceLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetLastWeeklyBestInformation", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "challengeMapId", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOwnedKeystoneChallengeMapID", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "challengeMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOwnedKeystoneLevel", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "keyStoneLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOwnedKeystoneMapID", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRewardLevelForDifficultyLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "difficultyLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "weeklyRewardLevel", Type = "number", Nilable = false }, + { Name = "endOfRunRewardLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRewardLevelFromKeystoneLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "keystoneLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rewardLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRunHistory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "includePreviousWeeks", Type = "bool", Nilable = false, Default = false }, + { Name = "includeIncompleteRuns", Type = "bool", Nilable = false, Default = false }, + { Name = "currentSeasonOnly", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "runs", Type = "table", InnerType = "MythicPlusRunInfo", Nilable = false }, + }, + }, + { + Name = "GetSeasonBestAffixScoreInfoForMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Gets the active players best runs by the seasonal tracked affixes as well as their overall score for the current season." }, + + Arguments = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "affixScores", Type = "table", InnerType = "MythicPlusAffixScoreInfo", Nilable = false }, + { Name = "bestOverAllScore", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSeasonBestForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "intimeInfo", Type = "MapSeasonBestInfo", Nilable = true }, + { Name = "overtimeInfo", Type = "MapSeasonBestInfo", Nilable = true }, + }, + }, + { + Name = "GetSeasonBestMythicRatingFromThisExpansion", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "bestSeasonScore", Type = "number", Nilable = false }, + { Name = "bestSeason", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWeeklyBestForMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "durationSec", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "completionDate", Type = "MythicPlusDate", Nilable = false }, + { Name = "affixIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "members", Type = "table", InnerType = "MythicPlusMember", Nilable = false }, + { Name = "dungeonScore", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWeeklyChestRewardLevel", + Type = "Function", + + Returns = + { + { Name = "currentWeekBestLevel", Type = "number", Nilable = false }, + { Name = "weeklyRewardLevel", Type = "number", Nilable = false }, + { Name = "nextDifficultyWeeklyRewardLevel", Type = "number", Nilable = false }, + { Name = "nextBestLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsMythicPlusActive", + Type = "Function", + + Returns = + { + { Name = "isMythicPlusActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestCurrentAffixes", + Type = "Function", + }, + { + Name = "RequestMapInfo", + Type = "Function", + }, + { + Name = "RequestRewards", + Type = "Function", + }, + }, + + Events = + { + { + Name = "MythicPlusCurrentAffixUpdate", + Type = "Event", + LiteralName = "MYTHIC_PLUS_CURRENT_AFFIX_UPDATE", + SynchronousEvent = true, + }, + { + Name = "MythicPlusNewWeeklyRecord", + Type = "Event", + LiteralName = "MYTHIC_PLUS_NEW_WEEKLY_RECORD", + SynchronousEvent = true, + Payload = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + { Name = "completionMilliseconds", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "MapSeasonBestInfo", + Type = "Structure", + Fields = + { + { Name = "durationSec", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "completionDate", Type = "MythicPlusDate", Nilable = false }, + { Name = "affixIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "members", Type = "table", InnerType = "MythicPlusMember", Nilable = false }, + { Name = "dungeonScore", Type = "number", Nilable = false }, + }, + }, + { + Name = "MythicPlusDate", + Type = "Structure", + Fields = + { + { Name = "year", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + { Name = "weekday", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "MythicPlusKeystoneAffix", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "seasonID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MythicPlusMember", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MythicPlusRunInfo", + Type = "Structure", + Fields = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "thisWeek", Type = "bool", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "runScore", Type = "number", Nilable = false }, + { Name = "durationSec", Type = "number", Nilable = false }, + { Name = "completionDate", Type = "MythicPlusDate", Nilable = false }, + { Name = "season", Type = "number", Nilable = false }, + }, + }, + { + Name = "SeasonTimeInfo", + Type = "Structure", + Fields = + { + { Name = "bestTime", Type = "number", Nilable = false }, + { Name = "lastTime", Type = "number", Nilable = false }, + { Name = "medal", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MythicPlusInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fb7e727 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/MythicPlusInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,51 @@ +local MythicPlusInfoShared = +{ + Tables = + { + { + Name = "MythicPlusAffixScoreInfo", + Type = "Structure", + Documentation = { "Information about a specific M+ run" }, + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "score", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "durationSec", Type = "number", Nilable = false }, + { Name = "overTime", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MythicPlusLeaderboardPlayerResult", + Type = "Structure", + Fields = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MythicPlusLeaderboardResult", + Type = "Structure", + Fields = + { + { Name = "completionTime", Type = "number", Nilable = false }, + { Name = "players", Type = "table", InnerType = "MythicPlusLeaderboardPlayerResult", Nilable = false }, + }, + }, + { + Name = "MythicPlusRatingLinkInfo", + Type = "Structure", + Fields = + { + { Name = "mapChallengeModeID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "completedInTime", Type = "number", Nilable = false }, + { Name = "dungeonScore", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(MythicPlusInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..75f3ded --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,165 @@ +local NamePlateConstants = +{ + Tables = + { + { + Name = "NamePlateCastBarDisplay", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "NamePlateCastBarDisplay", EnumValue = 0 }, + { Name = "SpellName", Type = "NamePlateCastBarDisplay", EnumValue = 1 }, + { Name = "SpellIcon", Type = "NamePlateCastBarDisplay", EnumValue = 2 }, + { Name = "SpellTarget", Type = "NamePlateCastBarDisplay", EnumValue = 3 }, + { Name = "HighlightImportantCasts", Type = "NamePlateCastBarDisplay", EnumValue = 4 }, + { Name = "HighlightWhenCastTarget", Type = "NamePlateCastBarDisplay", EnumValue = 5 }, + }, + }, + { + Name = "NamePlateEnemyNpcAuraDisplay", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "NamePlateEnemyNpcAuraDisplay", EnumValue = 0 }, + { Name = "Buffs", Type = "NamePlateEnemyNpcAuraDisplay", EnumValue = 1 }, + { Name = "Debuffs", Type = "NamePlateEnemyNpcAuraDisplay", EnumValue = 2 }, + { Name = "CrowdControl", Type = "NamePlateEnemyNpcAuraDisplay", EnumValue = 3 }, + }, + }, + { + Name = "NamePlateEnemyPlayerAuraDisplay", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "NamePlateEnemyPlayerAuraDisplay", EnumValue = 0 }, + { Name = "Buffs", Type = "NamePlateEnemyPlayerAuraDisplay", EnumValue = 1 }, + { Name = "Debuffs", Type = "NamePlateEnemyPlayerAuraDisplay", EnumValue = 2 }, + { Name = "LossOfControl", Type = "NamePlateEnemyPlayerAuraDisplay", EnumValue = 3 }, + }, + }, + { + Name = "NamePlateFriendlyPlayerAuraDisplay", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "NamePlateFriendlyPlayerAuraDisplay", EnumValue = 0 }, + { Name = "Buffs", Type = "NamePlateFriendlyPlayerAuraDisplay", EnumValue = 1 }, + { Name = "Debuffs", Type = "NamePlateFriendlyPlayerAuraDisplay", EnumValue = 2 }, + { Name = "LossOfControl", Type = "NamePlateFriendlyPlayerAuraDisplay", EnumValue = 3 }, + }, + }, + { + Name = "NamePlateInfoDisplay", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "NamePlateInfoDisplay", EnumValue = 0 }, + { Name = "CurrentHealthPercent", Type = "NamePlateInfoDisplay", EnumValue = 1 }, + { Name = "CurrentHealthValue", Type = "NamePlateInfoDisplay", EnumValue = 2 }, + { Name = "RarityIcon", Type = "NamePlateInfoDisplay", EnumValue = 3 }, + }, + }, + { + Name = "NamePlateSimplifiedType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "NamePlateSimplifiedType", EnumValue = 0 }, + { Name = "Minion", Type = "NamePlateSimplifiedType", EnumValue = 1 }, + { Name = "MinusMob", Type = "NamePlateSimplifiedType", EnumValue = 2 }, + { Name = "FriendlyPlayer", Type = "NamePlateSimplifiedType", EnumValue = 3 }, + { Name = "FriendlyNpc", Type = "NamePlateSimplifiedType", EnumValue = 4 }, + }, + }, + { + Name = "NamePlateSize", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 5, + Fields = + { + { Name = "Small", Type = "NamePlateSize", EnumValue = 1 }, + { Name = "Medium", Type = "NamePlateSize", EnumValue = 2 }, + { Name = "Large", Type = "NamePlateSize", EnumValue = 3 }, + { Name = "ExtraLarge", Type = "NamePlateSize", EnumValue = 4 }, + { Name = "Huge", Type = "NamePlateSize", EnumValue = 5 }, + }, + }, + { + Name = "NamePlateStackType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "NamePlateStackType", EnumValue = 0 }, + { Name = "Enemy", Type = "NamePlateStackType", EnumValue = 1 }, + { Name = "Friendly", Type = "NamePlateStackType", EnumValue = 2 }, + }, + }, + { + Name = "NamePlateStyle", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Modern", Type = "NamePlateStyle", EnumValue = 0 }, + { Name = "Thin", Type = "NamePlateStyle", EnumValue = 1 }, + { Name = "Block", Type = "NamePlateStyle", EnumValue = 2 }, + { Name = "HealthFocus", Type = "NamePlateStyle", EnumValue = 3 }, + { Name = "CastFocus", Type = "NamePlateStyle", EnumValue = 4 }, + { Name = "Legacy", Type = "NamePlateStyle", EnumValue = 5 }, + }, + }, + { + Name = "NamePlateThreatDisplay", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "NamePlateThreatDisplay", EnumValue = 0 }, + { Name = "Progressive", Type = "NamePlateThreatDisplay", EnumValue = 1 }, + { Name = "Flash", Type = "NamePlateThreatDisplay", EnumValue = 2 }, + { Name = "HealthBarColor", Type = "NamePlateThreatDisplay", EnumValue = 3 }, + }, + }, + { + Name = "NamePlateType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Friendly", Type = "NamePlateType", EnumValue = 0 }, + { Name = "Enemy", Type = "NamePlateType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(NamePlateConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b917cfc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateDocumentation.lua.annotated.lua @@ -0,0 +1,68 @@ +local NamePlate = +{ + Name = "NamePlate", + Type = "System", + Namespace = "C_NamePlate", + Environment = "All", + + Functions = + { + { + Name = "GetNamePlateForUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenNamePlate", Nilable = false }, + { Name = "includeForbidden", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "nameplate", Type = "NamePlateFrame", Nilable = false }, + }, + }, + { + Name = "GetNamePlateSize", + Type = "Function", + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetNamePlates", + Type = "Function", + + Returns = + { + { Name = "nameplates", Type = "table", InnerType = "NamePlateFrame", Nilable = false }, + }, + }, + { + Name = "SetNamePlateSize", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(NamePlate); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..47af600 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NamePlateManagerDocumentation.lua.annotated.lua @@ -0,0 +1,168 @@ +local NamePlateManager = +{ + Name = "NamePlateManager", + Type = "System", + Namespace = "C_NamePlateManager", + Environment = "All", + + Functions = + { + { + Name = "GetNamePlateHitTestInsets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the values used to adjust the hit testing area for nameplates." }, + + Arguments = + { + { Name = "type", Type = "NamePlateType", Nilable = false }, + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "IsNamePlateUnitBehindCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the unit to which the nameplate is attached is behind the player's camera." }, + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenNamePlate", Nilable = false }, + }, + + Returns = + { + { Name = "isBehindCamera", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetNamePlateHitTestFrame", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Set the frame used to determine where the mouse should interact with the nameplate. Used to control which part of the nameplate is clickable." }, + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenNamePlate", Nilable = false }, + { Name = "hitTestFrame", Type = "SimpleFrame", Nilable = false }, + }, + }, + { + Name = "SetNamePlateHitTestInsets", + Type = "Function", + HasRestrictions = true, + SecretArguments = "NotAllowed", + Documentation = { "Provide values to adjust the hit testing area for nameplates. Positive values will decrease the hit test area, negative values will increase it. Note that all hit testing is clamped to the bounds of the nameplate and can not be moved outside it." }, + + Arguments = + { + { Name = "type", Type = "NamePlateType", Nilable = false }, + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetNamePlateSimplified", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Set whether the nameplate attached to a unit is considered simplified, which can change the way it's displayed." }, + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenNamePlate", Nilable = false }, + { Name = "isSimplified", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ForbiddenNamePlateCreated", + Type = "Event", + LiteralName = "FORBIDDEN_NAME_PLATE_CREATED", + SynchronousEvent = true, + Payload = + { + { Name = "namePlateFrame", Type = "NamePlateFrame", Nilable = false }, + }, + }, + { + Name = "ForbiddenNamePlateUnitAdded", + Type = "Event", + LiteralName = "FORBIDDEN_NAME_PLATE_UNIT_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "unitToken", Type = "string", Nilable = false }, + }, + }, + { + Name = "ForbiddenNamePlateUnitRemoved", + Type = "Event", + LiteralName = "FORBIDDEN_NAME_PLATE_UNIT_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "unitToken", Type = "string", Nilable = false }, + }, + }, + { + Name = "NamePlateCreated", + Type = "Event", + LiteralName = "NAME_PLATE_CREATED", + SynchronousEvent = true, + Payload = + { + { Name = "namePlateFrame", Type = "NamePlateFrame", Nilable = false }, + }, + }, + { + Name = "NamePlateUnitAdded", + Type = "Event", + LiteralName = "NAME_PLATE_UNIT_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "unitToken", Type = "string", Nilable = false }, + }, + }, + { + Name = "NamePlateUnitBehindCameraChanged", + Type = "Event", + LiteralName = "NAME_PLATE_UNIT_BEHIND_CAMERA_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "isBehindCamera", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NamePlateUnitRemoved", + Type = "Event", + LiteralName = "NAME_PLATE_UNIT_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "unitToken", Type = "string", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(NamePlateManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua.annotated.lua new file mode 100644 index 0000000..76e0b69 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativeDocumentation.lua.annotated.lua @@ -0,0 +1,333 @@ +local NeighborhoodInitiative = +{ + Name = "NeighborhoodInitiative", + Type = "System", + Namespace = "C_NeighborhoodInitiative", + Environment = "All", + + Functions = + { + { + Name = "AddTrackedInitiativeTask", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "initiativeTaskID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActiveNeighborhood", + Type = "Function", + + Returns = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetInitiativeActivityLogInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "InitiativeActivityLogInfo", Nilable = true }, + }, + }, + { + Name = "GetInitiativeTaskChatLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "initiativeTaskID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetInitiativeTaskInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "initiativeTaskID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "InitiativeTaskInfo", Nilable = true }, + }, + }, + { + Name = "GetNeighborhoodInitiativeInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "NeighborhoodInitiativeInfo", Nilable = true }, + }, + }, + { + Name = "GetRequiredLevel", + Type = "Function", + + Returns = + { + { Name = "reqLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrackedInitiativeTasks", + Type = "Function", + + Returns = + { + { Name = "trackedInitiativeTasks", Type = "InitiativeTasksTracked", Nilable = false }, + }, + }, + { + Name = "IsInitiativeEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInNeighborhoodGroup", + Type = "Function", + + Returns = + { + { Name = "inValidGroup", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsViewingActiveNeighborhood", + Type = "Function", + + Returns = + { + { Name = "isViewingActiveNeighborhood", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerHasInitiativeAccess", + Type = "Function", + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerMeetsRequiredLevel", + Type = "Function", + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveTrackedInitiativeTask", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "initiativeTaskID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestInitiativeActivityLog", + Type = "Function", + }, + { + Name = "RequestNeighborhoodInitiativeInfo", + Type = "Function", + }, + { + Name = "SetActiveNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "SetViewingNeighborhood", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "InitiativeActivityLogUpdated", + Type = "Event", + LiteralName = "INITIATIVE_ACTIVITY_LOG_UPDATED", + SynchronousEvent = true, + }, + { + Name = "InitiativeCompleted", + Type = "Event", + LiteralName = "INITIATIVE_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "initiativeTitle", Type = "string", Nilable = false }, + }, + }, + { + Name = "InitiativeTaskCompleted", + Type = "Event", + LiteralName = "INITIATIVE_TASK_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "taskName", Type = "string", Nilable = false }, + }, + }, + { + Name = "InitiativeTasksTrackedListChanged", + Type = "Event", + LiteralName = "INITIATIVE_TASKS_TRACKED_LIST_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "initiativeTaskID", Type = "number", Nilable = false }, + { Name = "added", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InitiativeTasksTrackedUpdated", + Type = "Event", + LiteralName = "INITIATIVE_TASKS_TRACKED_UPDATED", + UniqueEvent = true, + }, + { + Name = "NeighborhoodInitiativeUpdated", + Type = "Event", + LiteralName = "NEIGHBORHOOD_INITIATIVE_UPDATED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "InitiativeActivityLogEntry", + Type = "Structure", + Fields = + { + { Name = "taskID", Type = "number", Nilable = false }, + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "taskName", Type = "cstring", Nilable = false }, + { Name = "completionTime", Type = "time_t", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "InitiativeActivityLogInfo", + Type = "Structure", + Fields = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + { Name = "nextUpdateTime", Type = "time_t", Nilable = false }, + { Name = "taskActivity", Type = "table", InnerType = "InitiativeActivityLogEntry", Nilable = false }, + }, + }, + { + Name = "InitiativeMilestoneInfo", + Type = "Structure", + Fields = + { + { Name = "milestoneOrderIndex", Type = "number", Nilable = false }, + { Name = "requiredContributionAmount", Type = "number", Nilable = false }, + { Name = "rewards", Type = "table", InnerType = "InitiativeMilestoneRewardInfo", Nilable = false }, + }, + }, + { + Name = "InitiativeMilestoneRewardInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "decorID", Type = "number", Nilable = false }, + { Name = "decorQuantity", Type = "number", Nilable = false }, + { Name = "favor", Type = "number", Nilable = false }, + { Name = "money", Type = "WOWMONEY", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + }, + }, + { + Name = "InitiativeTaskInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "taskName", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "progressContributionAmount", Type = "number", Nilable = false }, + { Name = "tracked", Type = "bool", Nilable = false }, + { Name = "supersedes", Type = "number", Nilable = false }, + { Name = "timesCompleted", Type = "number", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "inProgress", Type = "bool", Nilable = false }, + { Name = "taskType", Type = "NeighborhoodInitiativeTaskType", Nilable = false }, + { Name = "sortOrder", Type = "number", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + { Name = "requirementsList", Type = "table", InnerType = "CriteriaRequirement", Nilable = false }, + { Name = "criteriaList", Type = "table", InnerType = "CriteriaRequiredValue", Nilable = false }, + }, + }, + { + Name = "InitiativeTasksTracked", + Type = "Structure", + Fields = + { + { Name = "trackedIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "NeighborhoodInitiativeInfo", + Type = "Structure", + Fields = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + { Name = "neighborhoodGUID", Type = "WOWGUID", Nilable = false }, + { Name = "initiativeID", Type = "number", Nilable = false }, + { Name = "currentCycleID", Type = "number", Nilable = false }, + { Name = "progressRequired", Type = "number", Nilable = false }, + { Name = "currentProgress", Type = "number", Nilable = false }, + { Name = "playerTotalContribution", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "tasks", Type = "table", InnerType = "InitiativeTaskInfo", Nilable = false }, + { Name = "milestones", Type = "table", InnerType = "InitiativeMilestoneInfo", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(NeighborhoodInitiative); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativesConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativesConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1fb486d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NeighborhoodInitiativesConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,111 @@ +local NeighborhoodInitiativesConstants = +{ + Tables = + { + { + Name = "InitiativeMilestoneFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "FinalMilestone", Type = "InitiativeMilestoneFlags", EnumValue = 1 }, + }, + }, + { + Name = "InitiativeRewardFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "PermanentWorldState", Type = "InitiativeRewardFlags", EnumValue = 1 }, + }, + }, + { + Name = "NeighborhoodInitiativeChestResult", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "NiSuccess", Type = "NeighborhoodInitiativeChestResult", EnumValue = 0 }, + { Name = "NiUnspecifiedFailure", Type = "NeighborhoodInitiativeChestResult", EnumValue = 1 }, + { Name = "NiNoHouseFound", Type = "NeighborhoodInitiativeChestResult", EnumValue = 2 }, + { Name = "NiNoRewards", Type = "NeighborhoodInitiativeChestResult", EnumValue = 3 }, + { Name = "NiThrottled", Type = "NeighborhoodInitiativeChestResult", EnumValue = 4 }, + { Name = "NiServiceDisabled", Type = "NeighborhoodInitiativeChestResult", EnumValue = 5 }, + }, + }, + { + Name = "NeighborhoodInitiativeFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Disabled", Type = "NeighborhoodInitiativeFlags", EnumValue = 1 }, + { Name = "NoAbandon", Type = "NeighborhoodInitiativeFlags", EnumValue = 2 }, + { Name = "NoRepeat", Type = "NeighborhoodInitiativeFlags", EnumValue = 4 }, + }, + }, + { + Name = "NeighborhoodInitiativeNeighborhoodTypes", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "NiNeighborhoodTypeSingleton", Type = "NeighborhoodInitiativeNeighborhoodTypes", EnumValue = 0 }, + { Name = "NiNeighborhoodTypePool", Type = "NeighborhoodInitiativeNeighborhoodTypes", EnumValue = 1 }, + }, + }, + { + Name = "NeighborhoodInitiativeTaskType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Single", Type = "NeighborhoodInitiativeTaskType", EnumValue = 0 }, + { Name = "RepeatableFinite", Type = "NeighborhoodInitiativeTaskType", EnumValue = 1 }, + { Name = "RepeatableInfinite", Type = "NeighborhoodInitiativeTaskType", EnumValue = 2 }, + }, + }, + { + Name = "NeighborhoodInitiativeUpdateStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Started", Type = "NeighborhoodInitiativeUpdateStatus", EnumValue = 0 }, + { Name = "MilestoneCompleted", Type = "NeighborhoodInitiativeUpdateStatus", EnumValue = 1 }, + { Name = "Completed", Type = "NeighborhoodInitiativeUpdateStatus", EnumValue = 2 }, + { Name = "Failed", Type = "NeighborhoodInitiativeUpdateStatus", EnumValue = 3 }, + }, + }, + { + Name = "NeighborhoodInitiativesCompletionStates", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "NiCompletionStateNotCompleted", Type = "NeighborhoodInitiativesCompletionStates", EnumValue = 0 }, + { Name = "NiCompletionStatePlayerCompleted", Type = "NeighborhoodInitiativesCompletionStates", EnumValue = 1 }, + { Name = "NiCompletionStateSystemAbandoned", Type = "NeighborhoodInitiativesCompletionStates", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(NeighborhoodInitiativesConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..46a2b0a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/NewItemsDocumentation.lua.annotated.lua @@ -0,0 +1,52 @@ +local NewItems = +{ + Name = "NewItems", + Type = "System", + Namespace = "C_NewItems", + Environment = "All", + + Functions = + { + { + Name = "ClearAll", + Type = "Function", + }, + { + Name = "IsNewItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isNew", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveNewItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(NewItems); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/OsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/OsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..168e799 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/OsDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local Os = +{ + Name = "Os", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CopyToClipboard", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "removeMarkup", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "length", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTimePreciseSec", + Type = "Function", + + Returns = + { + { Name = "time", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Os); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PVPMgrConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PVPMgrConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..eb12980 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PVPMgrConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local PVPMgrConstants = +{ + Tables = + { + { + Name = "PvPMatchmakingType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Battleground", Type = "PvPMatchmakingType", EnumValue = 0 }, + { Name = "Arena", Type = "PvPMatchmakingType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PVPMgrConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..afae363 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PaperDollInfoDocumentation.lua.annotated.lua @@ -0,0 +1,418 @@ +local PaperDollInfo = +{ + Name = "PaperDollInfo", + Type = "System", + Namespace = "C_PaperDollInfo", + Environment = "All", + + Functions = + { + { + Name = "CanAutoEquipCursorItem", + Type = "Function", + + Returns = + { + { Name = "canAutoEquip", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanCursorCanGoInSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canOccupySlot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetArmorEffectiveness", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "armor", Type = "number", Nilable = false }, + { Name = "attackerLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "effectiveness", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArmorEffectivenessAgainstTarget", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "armor", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "effectiveness", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetInspectAzeriteItemEmpoweredChoices", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "equipmentSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "azeritePowerIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetInspectGuildInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitString", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "achievementPoints", Type = "number", Nilable = false }, + { Name = "numMembers", Type = "number", Nilable = false }, + { Name = "guildName", Type = "string", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetInspectItemLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "equippedItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInspectRatedBGBlitzData", + Type = "Function", + + Returns = + { + { Name = "ratedBGBlitzData", Type = "InspectPVPData", Nilable = false }, + }, + }, + { + Name = "GetInspectRatedBGData", + Type = "Function", + + Returns = + { + { Name = "ratedBGData", Type = "InspectRatedBGData", Nilable = false }, + }, + }, + { + Name = "GetInspectRatedSoloShuffleData", + Type = "Function", + + Returns = + { + { Name = "ratedSoloShuffleData", Type = "InspectPVPData", Nilable = false }, + }, + }, + { + Name = "GetMinItemLevel", + Type = "Function", + + Returns = + { + { Name = "minItemLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetStaggerPercentage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "stagger", Type = "number", Nilable = false }, + { Name = "staggerAgainstTarget", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsInventorySlotEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotName", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRangedSlotShown", + Type = "Function", + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OffhandHasShield", + Type = "Function", + + Returns = + { + { Name = "offhandHasShield", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OffhandHasWeapon", + Type = "Function", + + Returns = + { + { Name = "offhandHasWeapon", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AvoidanceUpdate", + Type = "Event", + LiteralName = "AVOIDANCE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "CharacterPointsChanged", + Type = "Event", + LiteralName = "CHARACTER_POINTS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "change", Type = "number", Nilable = false }, + }, + }, + { + Name = "CharacterUpgradeSpellTierSet", + Type = "Event", + LiteralName = "CHARACTER_UPGRADE_SPELL_TIER_SET", + SynchronousEvent = true, + Payload = + { + { Name = "tierIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "CombatRatingUpdate", + Type = "Event", + LiteralName = "COMBAT_RATING_UPDATE", + SynchronousEvent = true, + }, + { + Name = "DisableXpGain", + Type = "Event", + LiteralName = "DISABLE_XP_GAIN", + SynchronousEvent = true, + }, + { + Name = "EnableXpGain", + Type = "Event", + LiteralName = "ENABLE_XP_GAIN", + SynchronousEvent = true, + }, + { + Name = "EquipBindConfirm", + Type = "Event", + LiteralName = "EQUIP_BIND_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "InspectHonorUpdate", + Type = "Event", + LiteralName = "INSPECT_HONOR_UPDATE", + SynchronousEvent = true, + }, + { + Name = "InspectReady", + Type = "Event", + LiteralName = "INSPECT_READY", + SynchronousEvent = true, + Payload = + { + { Name = "inspecteeGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "LifestealUpdate", + Type = "Event", + LiteralName = "LIFESTEAL_UPDATE", + SynchronousEvent = true, + }, + { + Name = "MasteryUpdate", + Type = "Event", + LiteralName = "MASTERY_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PetSpellPowerUpdate", + Type = "Event", + LiteralName = "PET_SPELL_POWER_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PlayerAvgItemLevelUpdate", + Type = "Event", + LiteralName = "PLAYER_AVG_ITEM_LEVEL_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PlayerEquipmentChanged", + Type = "Event", + LiteralName = "PLAYER_EQUIPMENT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "equipmentSlot", Type = "number", Nilable = false }, + { Name = "hasCurrent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ProfessionEquipmentChanged", + Type = "Event", + LiteralName = "PROFESSION_EQUIPMENT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + { Name = "isTool", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PvpPowerUpdate", + Type = "Event", + LiteralName = "PVP_POWER_UPDATE", + SynchronousEvent = true, + }, + { + Name = "SpeedUpdate", + Type = "Event", + LiteralName = "SPEED_UPDATE", + SynchronousEvent = true, + }, + { + Name = "SpellPowerChanged", + Type = "Event", + LiteralName = "SPELL_POWER_CHANGED", + SynchronousEvent = true, + }, + { + Name = "SturdinessUpdate", + Type = "Event", + LiteralName = "STURDINESS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "UpdateFaction", + Type = "Event", + LiteralName = "UPDATE_FACTION", + SynchronousEvent = true, + }, + { + Name = "UpdateInventoryAlerts", + Type = "Event", + LiteralName = "UPDATE_INVENTORY_ALERTS", + SynchronousEvent = true, + }, + { + Name = "UpdateInventoryDurability", + Type = "Event", + LiteralName = "UPDATE_INVENTORY_DURABILITY", + SynchronousEvent = true, + }, + { + Name = "WeaponSlotChanged", + Type = "Event", + LiteralName = "WEAPON_SLOT_CHANGED", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "InspectGuildInfo", + Type = "Structure", + Fields = + { + { Name = "achievementPoints", Type = "number", Nilable = false }, + { Name = "numMembers", Type = "number", Nilable = false }, + { Name = "guildName", Type = "string", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = false }, + }, + }, + { + Name = "InspectPVPData", + Type = "Structure", + Fields = + { + { Name = "rating", Type = "number", Nilable = false }, + { Name = "gamesWon", Type = "number", Nilable = false }, + { Name = "gamesPlayed", Type = "number", Nilable = false }, + { Name = "roundsWon", Type = "number", Nilable = false }, + { Name = "roundsPlayed", Type = "number", Nilable = false }, + }, + }, + { + Name = "InspectRatedBGData", + Type = "Structure", + Fields = + { + { Name = "rating", Type = "number", Nilable = false }, + { Name = "played", Type = "number", Nilable = false }, + { Name = "won", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PaperDollInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a6722ce --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ParentalControlsDocumentation.lua.annotated.lua @@ -0,0 +1,29 @@ +local ParentalControls = +{ + Name = "ParentalControls", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetSecondsUntilParentalControlsKick", + Type = "Function", + + Returns = + { + { Name = "remaining", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ParentalControls); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2ea299a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,61 @@ +local PartyConstants = +{ + Tables = + { + { + Name = "AvgItemLevelCategories", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Base", Type = "AvgItemLevelCategories", EnumValue = 0 }, + { Name = "EquippedBase", Type = "AvgItemLevelCategories", EnumValue = 1 }, + { Name = "EquippedEffective", Type = "AvgItemLevelCategories", EnumValue = 2 }, + { Name = "PvP", Type = "AvgItemLevelCategories", EnumValue = 3 }, + { Name = "PvPWeighted", Type = "AvgItemLevelCategories", EnumValue = 4 }, + { Name = "EquippedEffectiveWeighted", Type = "AvgItemLevelCategories", EnumValue = 5 }, + }, + }, + { + Name = "PartyRequestJoinRelation", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "PartyRequestJoinRelation", EnumValue = 0 }, + { Name = "Friend", Type = "PartyRequestJoinRelation", EnumValue = 1 }, + { Name = "Guild", Type = "PartyRequestJoinRelation", EnumValue = 2 }, + { Name = "Club", Type = "PartyRequestJoinRelation", EnumValue = 3 }, + { Name = "RecentAllies", Type = "PartyRequestJoinRelation", EnumValue = 4 }, + }, + }, + { + Name = "RestrictPingsTo", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "RestrictPingsTo", EnumValue = 0 }, + { Name = "Lead", Type = "RestrictPingsTo", EnumValue = 1 }, + { Name = "Assist", Type = "RestrictPingsTo", EnumValue = 2 }, + { Name = "TankHealer", Type = "RestrictPingsTo", EnumValue = 3 }, + }, + }, + { + Name = "PartyCountdownConstants", + Type = "Constants", + Values = + { + { Name = "MaxCountdownSeconds", Type = "number", Value = 3600 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PartyConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..62b7774 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyInfoDocumentation.lua.annotated.lua @@ -0,0 +1,788 @@ +local PartyInfo = +{ + Name = "PartyInfo", + Type = "System", + Namespace = "C_PartyInfo", + Environment = "All", + + Functions = + { + { + Name = "AllowedToDoPartyConversion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "toRaid", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanFormCrossFactionParties", + Type = "Function", + + Returns = + { + { Name = "canFormCrossFactionParties", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanInvite", + Type = "Function", + + Returns = + { + { Name = "allowedToInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanStartInstanceAbandonVote", + Type = "Function", + Documentation = { "Returns whether it's possible to start a vote at this time" }, + + Returns = + { + { Name = "canStart", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChallengeModeRestrictionsActive", + Type = "Function", + + Returns = + { + { Name = "restrictionsActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConfirmConvertToRaid", + Type = "Function", + Documentation = { "Immediately convert to raid with no regard for potentially destructive actions." }, + }, + { + Name = "ConfirmInviteTravelPass", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + { Name = "targetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ConfirmInviteUnit", + Type = "Function", + RequiresValidInviteTarget = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Immediately invites the named unit to a party, with no regard for potentially destructive actions." }, + + Arguments = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ConfirmLeaveParty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Immediately leave the party with no regard for potentially destructive actions" }, + + Arguments = + { + { Name = "category", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "ConfirmRequestInviteFromUnit", + Type = "Function", + RequiresValidInviteTarget = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Immediately request an invite into the target party, this is the confirmation function to call after RequestInviteFromUnit, or if you would like to skip the confirmation process." }, + + Arguments = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + { Name = "tank", Type = "bool", Nilable = true }, + { Name = "healer", Type = "bool", Nilable = true }, + { Name = "dps", Type = "bool", Nilable = true }, + }, + }, + { + Name = "ConvertToParty", + Type = "Function", + }, + { + Name = "ConvertToRaid", + Type = "Function", + Documentation = { "Usually this will convert to raid immediately. In some cases (e.g. PartySync) the user will be prompted to confirm converting to raid, because it's potentially destructive." }, + }, + { + Name = "DelveTeleportOut", + Type = "Function", + }, + { + Name = "DoCountdown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActiveCategories", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "categories", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAvailableLootMethods", + Type = "Function", + + Returns = + { + { Name = "methods", Type = "table", InnerType = "LootMethod", Nilable = false }, + }, + }, + { + Name = "GetInstanceAbandonShutdownTime", + Type = "Function", + Documentation = { "Returns the total duration of the shutdown time after a vote passes and how much time is left before it ends" }, + + Returns = + { + { Name = "durationSeconds", Type = "number", Nilable = false, Default = 0 }, + { Name = "timeLeftSeconds", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetInstanceAbandonVoteCooldownTime", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Returns the total duration of the abandon vote cooldown and how much time is left before it ends" }, + + Returns = + { + { Name = "durationSeconds", Type = "number", Nilable = false, Default = 0 }, + { Name = "timeLeftSeconds", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetInstanceAbandonVoteRequirements", + Type = "Function", + Documentation = { "Returns values controlling the vote" }, + + Returns = + { + { Name = "votesRequired", Type = "number", Nilable = false, Default = 0 }, + { Name = "keystoneOwnerVoteWeight", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetInstanceAbandonVoteResponse", + Type = "Function", + Documentation = { "Returns how the player voted, nil for not yet" }, + + Returns = + { + { Name = "response", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetInstanceAbandonVoteTime", + Type = "Function", + Documentation = { "Returns the total duration of the vote and how much time is left before it ends" }, + + Returns = + { + { Name = "durationSeconds", Type = "number", Nilable = false, Default = 0 }, + { Name = "timeLeftSeconds", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetInviteConfirmationInvalidQueues", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inviteGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "invalidQueues", Type = "table", InnerType = "QueueSpecificInfo", Nilable = false }, + }, + }, + { + Name = "GetInviteReferralInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inviteGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "outReferredByGuid", Type = "WOWGUID", Nilable = false }, + { Name = "outReferredByName", Type = "cstring", Nilable = false }, + { Name = "outRelationType", Type = "PartyRequestJoinRelation", Nilable = false }, + { Name = "outIsQuickJoin", Type = "bool", Nilable = false }, + { Name = "outClubId", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "GetLootMethod", + Type = "Function", + + Returns = + { + { Name = "method", Type = "LootMethod", Nilable = false }, + { Name = "masterLootPartyID", Type = "number", Nilable = true }, + { Name = "masterLooterRaidID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMinItemLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "avgItemLevelCategory", Type = "AvgItemLevelCategories", Nilable = false, Documentation = { "The active party is always used" } }, + }, + + Returns = + { + { Name = "minItemLevel", Type = "number", Nilable = false }, + { Name = "playerNameWithLowestItemLevel", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetMinLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "luaIndex", Nilable = true, Documentation = { "If not provided, the active party is used" } }, + }, + + Returns = + { + { Name = "minLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumInstanceAbandonGroupVoteResponses", + Type = "Function", + Documentation = { "Returns how many players have voted either way" }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRestrictPings", + Type = "Function", + + Returns = + { + { Name = "restrictTo", Type = "RestrictPingsTo", Nilable = false }, + }, + }, + { + Name = "InviteUnit", + Type = "Function", + RequiresValidInviteTarget = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to invite the named unit to a party, requires confirmation in some cases (e.g. the party will convert to a raid, or if there is a party sync in progress)." }, + + Arguments = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsChallengeModeActive", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChallengeModeKeystoneOwner", + Type = "Function", + + Returns = + { + { Name = "isKeystoneOwner", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCrossFactionParty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "luaIndex", Nilable = true, Documentation = { "If not provided, the active party is used" } }, + }, + + Returns = + { + { Name = "isCrossFactionParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDelveComplete", + Type = "Function", + + Returns = + { + { Name = "isDelveComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDelveInProgress", + Type = "Function", + + Returns = + { + { Name = "isDelveComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPartyFull", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "luaIndex", Nilable = true, Documentation = { "If not provided, the active party is used" } }, + }, + + Returns = + { + { Name = "isFull", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPartyInJailersTower", + Type = "Function", + + Returns = + { + { Name = "isPartyInJailersTower", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPartyWalkIn", + Type = "Function", + + Returns = + { + { Name = "isPartyWalkIn", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveParty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Usually this will leave the party immediately. In some cases (e.g. PartySync) the user will be prompted to confirm leaving the party, because it's potentially destructive" }, + + Arguments = + { + { Name = "category", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "RequestInviteFromUnit", + Type = "Function", + RequiresValidInviteTarget = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Attempt to request an invite into the target party, requires confirmation in some cases (e.g. there is a party sync in progress)." }, + + Arguments = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + { Name = "tank", Type = "bool", Nilable = true }, + { Name = "healer", Type = "bool", Nilable = true }, + { Name = "dps", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SetInstanceAbandonVoteResponse", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Vote on whether to abandon instance, true for yes, false for no" }, + + Arguments = + { + { Name = "response", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetLootMethod", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "method", Type = "LootMethod", Nilable = false }, + { Name = "lootMaster", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRestrictPings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "restrictTo", Type = "RestrictPingsTo", Nilable = false }, + }, + }, + { + Name = "StartInstanceAbandonVote", + Type = "Function", + HasRestrictions = true, + Documentation = { "Start the vote" }, + }, + }, + + Events = + { + { + Name = "BnetRequestInviteConfirmation", + Type = "Event", + LiteralName = "BNET_REQUEST_INVITE_CONFIRMATION", + SynchronousEvent = true, + Payload = + { + { Name = "gameAccountID", Type = "number", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + { Name = "tank", Type = "bool", Nilable = false }, + { Name = "healer", Type = "bool", Nilable = false }, + { Name = "dps", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConvertToRaidConfirmation", + Type = "Event", + LiteralName = "CONVERT_TO_RAID_CONFIRMATION", + SynchronousEvent = true, + }, + { + Name = "EnteredDifferentInstanceFromParty", + Type = "Event", + LiteralName = "ENTERED_DIFFERENT_INSTANCE_FROM_PARTY", + SynchronousEvent = true, + }, + { + Name = "GroupFormed", + Type = "Event", + LiteralName = "GROUP_FORMED", + SynchronousEvent = true, + Payload = + { + { Name = "category", Type = "number", Nilable = false }, + { Name = "partyGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GroupInviteConfirmation", + Type = "Event", + LiteralName = "GROUP_INVITE_CONFIRMATION", + SynchronousEvent = true, + }, + { + Name = "GroupJoined", + Type = "Event", + LiteralName = "GROUP_JOINED", + SynchronousEvent = true, + Payload = + { + { Name = "category", Type = "number", Nilable = false }, + { Name = "partyGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GroupLeft", + Type = "Event", + LiteralName = "GROUP_LEFT", + SynchronousEvent = true, + Payload = + { + { Name = "category", Type = "number", Nilable = false }, + { Name = "partyGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GroupRosterUpdate", + Type = "Event", + LiteralName = "GROUP_ROSTER_UPDATE", + UniqueEvent = true, + }, + { + Name = "InstanceAbandonVoteFinished", + Type = "Event", + LiteralName = "INSTANCE_ABANDON_VOTE_FINISHED", + SynchronousEvent = true, + Payload = + { + { Name = "votePassed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InstanceAbandonVoteStarted", + Type = "Event", + LiteralName = "INSTANCE_ABANDON_VOTE_STARTED", + SynchronousEvent = true, + }, + { + Name = "InstanceAbandonVoteUpdated", + Type = "Event", + LiteralName = "INSTANCE_ABANDON_VOTE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "InstanceBootStart", + Type = "Event", + LiteralName = "INSTANCE_BOOT_START", + SynchronousEvent = true, + }, + { + Name = "InstanceBootStop", + Type = "Event", + LiteralName = "INSTANCE_BOOT_STOP", + SynchronousEvent = true, + }, + { + Name = "InstanceGroupSizeChanged", + Type = "Event", + LiteralName = "INSTANCE_GROUP_SIZE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "InviteToPartyConfirmation", + Type = "Event", + LiteralName = "INVITE_TO_PARTY_CONFIRMATION", + SynchronousEvent = true, + Payload = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + { Name = "willConvertToRaid", Type = "bool", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InviteTravelPassConfirmation", + Type = "Event", + LiteralName = "INVITE_TRAVEL_PASS_CONFIRMATION", + SynchronousEvent = true, + Payload = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + { Name = "targetGUID", Type = "WOWGUID", Nilable = false }, + { Name = "willConvertToRaid", Type = "bool", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeavePartyConfirmation", + Type = "Event", + LiteralName = "LEAVE_PARTY_CONFIRMATION", + SynchronousEvent = true, + Payload = + { + { Name = "reason", Type = "LeavePartyConfirmReason", Nilable = false }, + }, + }, + { + Name = "PartyInviteCancel", + Type = "Event", + LiteralName = "PARTY_INVITE_CANCEL", + SynchronousEvent = true, + }, + { + Name = "PartyInviteRequest", + Type = "Event", + LiteralName = "PARTY_INVITE_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isTank", Type = "bool", Nilable = false }, + { Name = "isHealer", Type = "bool", Nilable = false }, + { Name = "isDamage", Type = "bool", Nilable = false }, + { Name = "isNativeRealm", Type = "bool", Nilable = false }, + { Name = "allowMultipleRoles", Type = "bool", Nilable = false }, + { Name = "inviterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PartyLeaderChanged", + Type = "Event", + LiteralName = "PARTY_LEADER_CHANGED", + UniqueEvent = true, + }, + { + Name = "PartyLfgRestricted", + Type = "Event", + LiteralName = "PARTY_LFG_RESTRICTED", + SynchronousEvent = true, + }, + { + Name = "PartyLootMethodChanged", + Type = "Event", + LiteralName = "PARTY_LOOT_METHOD_CHANGED", + UniqueEvent = true, + }, + { + Name = "PartyMemberDisable", + Type = "Event", + LiteralName = "PARTY_MEMBER_DISABLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PartyMemberEnable", + Type = "Event", + LiteralName = "PARTY_MEMBER_ENABLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerDifficultyChanged", + Type = "Event", + LiteralName = "PLAYER_DIFFICULTY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerRolesAssigned", + Type = "Event", + LiteralName = "PLAYER_ROLES_ASSIGNED", + UniqueEvent = true, + }, + { + Name = "RaidRosterUpdate", + Type = "Event", + LiteralName = "RAID_ROSTER_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ReadyCheck", + Type = "Event", + LiteralName = "READY_CHECK", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "initiatorName", Type = "cstring", Nilable = false }, + { Name = "readyCheckTimeLeft", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "ReadyCheckConfirm", + Type = "Event", + LiteralName = "READY_CHECK_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "isReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReadyCheckFinished", + Type = "Event", + LiteralName = "READY_CHECK_FINISHED", + SynchronousEvent = true, + Payload = + { + { Name = "preempted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestInviteConfirmation", + Type = "Event", + LiteralName = "REQUEST_INVITE_CONFIRMATION", + SynchronousEvent = true, + Payload = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + { Name = "partyLevelLink", Type = "number", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + { Name = "tank", Type = "bool", Nilable = true }, + { Name = "healer", Type = "bool", Nilable = true }, + { Name = "dps", Type = "bool", Nilable = true }, + }, + }, + { + Name = "VoteKickReasonNeeded", + Type = "Event", + LiteralName = "VOTE_KICK_REASON_NEEDED", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "resultGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "LeavePartyConfirmReason", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "QuestSync", Type = "LeavePartyConfirmReason", EnumValue = 0 }, + { Name = "RestrictedChallengeMode", Type = "LeavePartyConfirmReason", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PartyInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2cf7728 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,19 @@ +local PartyPoseUIConstants = +{ + Tables = + { + { + Name = "PartyPoseFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "HideLeaveInstanceButton", Type = "PartyPoseFlags", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PartyPoseUIConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7e8aefd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PartyPoseUIDocumentation.lua.annotated.lua @@ -0,0 +1,107 @@ +local PartyPoseUI = +{ + Name = "PartyPose", + Type = "System", + Namespace = "C_PartyPose", + Environment = "All", + + Functions = + { + { + Name = "ExtraAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "partyPoseID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPartyPoseInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PartyPoseInfo", Nilable = false }, + }, + }, + { + Name = "GetPartyPoseInfoByMapID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PartyPoseInfo", Nilable = false }, + }, + }, + { + Name = "HasExtraAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "partyPoseID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasExtraAction", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ShowPartyPoseUI", + Type = "Event", + LiteralName = "SHOW_PARTY_POSE_UI", + SynchronousEvent = true, + Payload = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "won", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "PartyPoseInfo", + Type = "Structure", + Fields = + { + { Name = "partyPoseID", Type = "number", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "widgetSetID", Type = "number", Nilable = true }, + { Name = "victoryModelSceneID", Type = "number", Nilable = false }, + { Name = "defeatModelSceneID", Type = "number", Nilable = false }, + { Name = "victorySoundKitID", Type = "number", Nilable = false }, + { Name = "defeatSoundKitID", Type = "number", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = true }, + { Name = "titleText", Type = "string", Nilable = true }, + { Name = "extraButtonText", Type = "string", Nilable = true }, + { Name = "flags", Type = "PartyPoseFlags", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PartyPoseUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua.annotated.lua new file mode 100644 index 0000000..00458e9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerformanceDocumentation.lua.annotated.lua @@ -0,0 +1,79 @@ +local Performance = +{ + Name = "PerformanceScript", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetAddOnCPUUsage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAddOnMemoryUsage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "uiAddon", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFrameCPUUsage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "frame", Type = "SimpleFrame", Nilable = false }, + { Name = "includeChildren", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "call_time", Type = "number", Nilable = false }, + { Name = "call_count", Type = "number", Nilable = false }, + }, + }, + { + Name = "ResetCPUUsage", + Type = "Function", + }, + { + Name = "UpdateAddOnCPUUsage", + Type = "Function", + }, + { + Name = "UpdateAddOnMemoryUsage", + Type = "Function", + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Performance); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a4ff912 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksActivitiesDocumentation.lua.annotated.lua @@ -0,0 +1,235 @@ +local PerksActivities = +{ + Name = "PerksActivities", + Type = "System", + Namespace = "C_PerksActivities", + Environment = "All", + + Functions = + { + { + Name = "AddTrackedPerksActivity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksActivityID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClearPerksActivitiesPendingCompletion", + Type = "Function", + }, + { + Name = "GetAllPerksActivityTags", + Type = "Function", + + Returns = + { + { Name = "tags", Type = "PerksActivityTags", Nilable = false }, + }, + }, + { + Name = "GetPerksActivitiesInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "PerksActivitiesInfo", Nilable = false }, + }, + }, + { + Name = "GetPerksActivitiesPendingCompletion", + Type = "Function", + + Returns = + { + { Name = "pending", Type = "PerksActivitiesPending", Nilable = false }, + }, + }, + { + Name = "GetPerksActivityChatLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksActivityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetPerksActivityInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksActivityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PerksActivityInfo", Nilable = true }, + }, + }, + { + Name = "GetPerksUIThemePrefix", + Type = "Function", + + Returns = + { + { Name = "kitPrefix", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTrackedPerksActivities", + Type = "Function", + + Returns = + { + { Name = "trackedPerksActivities", Type = "PerksActivitiesTracked", Nilable = false }, + }, + }, + { + Name = "RemoveTrackedPerksActivity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksActivityID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "PerksActivitiesTrackedListChanged", + Type = "Event", + LiteralName = "PERKS_ACTIVITIES_TRACKED_LIST_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "perksActivityID", Type = "number", Nilable = false }, + { Name = "added", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PerksActivitiesTrackedUpdated", + Type = "Event", + LiteralName = "PERKS_ACTIVITIES_TRACKED_UPDATED", + UniqueEvent = true, + }, + { + Name = "PerksActivitiesUpdated", + Type = "Event", + LiteralName = "PERKS_ACTIVITIES_UPDATED", + UniqueEvent = true, + }, + { + Name = "PerksActivityCompleted", + Type = "Event", + LiteralName = "PERKS_ACTIVITY_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "perksActivityID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "PerksActivitiesInfo", + Type = "Structure", + Fields = + { + { Name = "activePerksMonth", Type = "number", Nilable = false }, + { Name = "displayMonthName", Type = "cstring", Nilable = false }, + { Name = "secondsRemaining", Type = "time_t", Nilable = false }, + { Name = "activities", Type = "table", InnerType = "PerksActivityInfo", Nilable = false }, + { Name = "thresholds", Type = "table", InnerType = "PerksActivityThresholdInfo", Nilable = false }, + }, + }, + { + Name = "PerksActivitiesPending", + Type = "Structure", + Fields = + { + { Name = "pendingIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "PerksActivitiesTracked", + Type = "Structure", + Fields = + { + { Name = "trackedIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "PerksActivityCondition", + Type = "Structure", + Fields = + { + { Name = "isMet", Type = "bool", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "uiPriority", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksActivityInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "activityName", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "thresholdContributionAmount", Type = "number", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "inProgress", Type = "bool", Nilable = false }, + { Name = "tracked", Type = "bool", Nilable = false }, + { Name = "supersedes", Type = "number", Nilable = false }, + { Name = "uiPriority", Type = "number", Nilable = false }, + { Name = "areAllConditionsMet", Type = "bool", Nilable = false }, + { Name = "conditions", Type = "table", InnerType = "PerksActivityCondition", Nilable = false }, + { Name = "eventName", Type = "cstring", Nilable = true }, + { Name = "eventStartTime", Type = "time_t", Nilable = true }, + { Name = "eventEndTime", Type = "time_t", Nilable = true }, + { Name = "requirementsList", Type = "table", InnerType = "CriteriaRequirement", Nilable = false }, + { Name = "criteriaList", Type = "table", InnerType = "CriteriaRequiredValue", Nilable = false }, + { Name = "tagNames", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "PerksActivityTags", + Type = "Structure", + Fields = + { + { Name = "tagName", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "PerksActivityThresholdInfo", + Type = "Structure", + Fields = + { + { Name = "thresholdOrderIndex", Type = "number", Nilable = false }, + { Name = "currencyAwardAmount", Type = "number", Nilable = false }, + { Name = "requiredContributionAmount", Type = "number", Nilable = false }, + { Name = "pendingReward", Type = "bool", Nilable = false }, + { Name = "itemReward", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PerksActivities); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2ee1bc0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksProgramDocumentation.lua.annotated.lua @@ -0,0 +1,468 @@ +local PerksProgram = +{ + Name = "PerksProgram", + Type = "System", + Namespace = "C_PerksProgram", + Environment = "All", + + Functions = + { + { + Name = "ClearFrozenPerksVendorItem", + Type = "Function", + }, + { + Name = "CloseInteraction", + Type = "Function", + }, + { + Name = "GetAvailableCategoryIDs", + Type = "Function", + + Returns = + { + { Name = "categoryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAvailableVendorItemIDs", + Type = "Function", + + Returns = + { + { Name = "vendorItemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCategoryInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categoryInfo", Type = "PerksVendorCategoryInfo", Nilable = false }, + }, + }, + { + Name = "GetCurrencyAmount", + Type = "Function", + + Returns = + { + { Name = "currencyAmount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDraggedPerksVendorItem", + Type = "Function", + + Returns = + { + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFrozenPerksVendorItemInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "vendorItemInfo", Type = "PerksVendorItemInfo", Nilable = false }, + }, + }, + { + Name = "GetPendingChestRewards", + Type = "Function", + + Returns = + { + { Name = "pendingRewards", Type = "table", InnerType = "PerksProgramPendingChestRewards", Nilable = false }, + }, + }, + { + Name = "GetPerksProgramItemDisplayInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "item", Type = "PerksProgramItemDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetTimeRemaining", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "timeRemaining", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetVendorItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "vendorItemInfo", Type = "PerksVendorItemInfo", Nilable = false }, + }, + }, + { + Name = "GetVendorItemInfoRefundTimeLeft", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "refundTimeRemaining", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "IsAttackAnimToggleEnabled", + Type = "Function", + + Returns = + { + { Name = "isAttackAnimToggleEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFrozenPerksVendorItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isFrozen", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMountSpecialAnimToggleEnabled", + Type = "Function", + + Returns = + { + { Name = "isMountSpecialAnimToggleEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemSelectedTelemetry", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PickupPerksVendorItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestCartCheckout", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksVendorItemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RequestPendingChestRewards", + Type = "Function", + }, + { + Name = "RequestPurchase", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestRefund", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ResetHeldItemDragAndDrop", + Type = "Function", + }, + { + Name = "SetFrozenPerksVendorItem", + Type = "Function", + }, + }, + + Events = + { + { + Name = "ChestRewardsUpdatedFromServer", + Type = "Event", + LiteralName = "CHEST_REWARDS_UPDATED_FROM_SERVER", + SynchronousEvent = true, + }, + { + Name = "PerksProgramAddPendingShopItem", + Type = "Event", + LiteralName = "PERKS_PROGRAM_ADD_PENDING_SHOP_ITEM", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramClose", + Type = "Event", + LiteralName = "PERKS_PROGRAM_CLOSE", + SynchronousEvent = true, + }, + { + Name = "PerksProgramCurrencyAwarded", + Type = "Event", + LiteralName = "PERKS_PROGRAM_CURRENCY_AWARDED", + SynchronousEvent = true, + Payload = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramCurrencyRefresh", + Type = "Event", + LiteralName = "PERKS_PROGRAM_CURRENCY_REFRESH", + SynchronousEvent = true, + Payload = + { + { Name = "oldValue", Type = "number", Nilable = false }, + { Name = "newValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramDataRefresh", + Type = "Event", + LiteralName = "PERKS_PROGRAM_DATA_REFRESH", + SynchronousEvent = true, + }, + { + Name = "PerksProgramDataSpecificItemRefresh", + Type = "Event", + LiteralName = "PERKS_PROGRAM_DATA_SPECIFIC_ITEM_REFRESH", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramDisabled", + Type = "Event", + LiteralName = "PERKS_PROGRAM_DISABLED", + SynchronousEvent = true, + }, + { + Name = "PerksProgramOpen", + Type = "Event", + LiteralName = "PERKS_PROGRAM_OPEN", + SynchronousEvent = true, + }, + { + Name = "PerksProgramPurchaseCartSuccess", + Type = "Event", + LiteralName = "PERKS_PROGRAM_PURCHASE_CART_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramPurchaseSuccess", + Type = "Event", + LiteralName = "PERKS_PROGRAM_PURCHASE_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramRefundSuccess", + Type = "Event", + LiteralName = "PERKS_PROGRAM_REFUND_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramRemovePendingShopItem", + Type = "Event", + LiteralName = "PERKS_PROGRAM_REMOVE_PENDING_SHOP_ITEM", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksProgramResultError", + Type = "Event", + LiteralName = "PERKS_PROGRAM_RESULT_ERROR", + SynchronousEvent = true, + }, + { + Name = "PerksProgramSetFrozenItem", + Type = "Event", + LiteralName = "PERKS_PROGRAM_SET_FROZEN_ITEM", + SynchronousEvent = true, + Payload = + { + { Name = "vendorItemID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "PerksProgramItemDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "overrideModelSceneID", Type = "number", Nilable = true }, + { Name = "creatureDisplayInfoID", Type = "number", Nilable = true }, + { Name = "mainHandItemModifiedAppearanceID", Type = "number", Nilable = true }, + { Name = "offHandItemModifiedAppearanceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "PerksProgramPendingChestRewards", + Type = "Structure", + Fields = + { + { Name = "rewardTypeID", Type = "number", Nilable = false }, + { Name = "perksVendorItemID", Type = "number", Nilable = true }, + { Name = "rewardAmount", Type = "number", Nilable = false }, + { Name = "monthRewarded", Type = "string", Nilable = true }, + { Name = "activityMonthID", Type = "number", Nilable = false }, + { Name = "thresholdOrderIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksVendorCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "displayName", Type = "cstring", Nilable = false }, + { Name = "defaultUIModelSceneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksVendorItemInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "perksVendorCategoryID", Type = "number", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "timeRemaining", Type = "time_t", Nilable = false }, + { Name = "purchased", Type = "bool", Nilable = false }, + { Name = "refundable", Type = "bool", Nilable = false }, + { Name = "subItemsLoaded", Type = "bool", Nilable = false }, + { Name = "isPurchasePending", Type = "bool", Nilable = false }, + { Name = "doesNotExpire", Type = "bool", Nilable = false }, + { Name = "price", Type = "number", Nilable = false }, + { Name = "originalPrice", Type = "number", Nilable = true }, + { Name = "showSaleBanner", Type = "bool", Nilable = false }, + { Name = "perksVendorItemID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "iconTexture", Type = "string", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + { Name = "mountTypeName", Type = "string", Nilable = false }, + { Name = "speciesID", Type = "number", Nilable = false }, + { Name = "transmogSetID", Type = "number", Nilable = false }, + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + { Name = "subItems", Type = "table", InnerType = "PerksVendorSubItemInfo", Nilable = false }, + { Name = "uiGroupInfo", Type = "PerksVendorItemUIGroupInfo", Nilable = true }, + { Name = "invType", Type = "string", Nilable = false }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + }, + { + Name = "PerksVendorItemUIGroupInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "priority", Type = "number", Nilable = false }, + }, + }, + { + Name = "PerksVendorSubItemInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + { Name = "invType", Type = "string", Nilable = false }, + { Name = "quality", Type = "ItemQuality", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PerksProgram); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5746bba --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PerksVendorConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,48 @@ +local PerksVendorConstants = +{ + Tables = + { + { + Name = "PerksVendorCategoryType", + Type = "Enumeration", + NumValues = 12, + MinValue = 1, + MaxValue = 24, + Fields = + { + { Name = "Transmog", Type = "PerksVendorCategoryType", EnumValue = 1 }, + { Name = "Mount", Type = "PerksVendorCategoryType", EnumValue = 2 }, + { Name = "Pet", Type = "PerksVendorCategoryType", EnumValue = 3 }, + { Name = "Toy", Type = "PerksVendorCategoryType", EnumValue = 5 }, + { Name = "Illusion", Type = "PerksVendorCategoryType", EnumValue = 7 }, + { Name = "Transmogset", Type = "PerksVendorCategoryType", EnumValue = 8 }, + { Name = "WarbandScene", Type = "PerksVendorCategoryType", EnumValue = 9 }, + { Name = "Stipend", Type = "PerksVendorCategoryType", EnumValue = 20 }, + { Name = "Activity", Type = "PerksVendorCategoryType", EnumValue = 21 }, + { Name = "GmAdjustment", Type = "PerksVendorCategoryType", EnumValue = 22 }, + { Name = "Achievement", Type = "PerksVendorCategoryType", EnumValue = 23 }, + { Name = "RefundUnused", Type = "PerksVendorCategoryType", EnumValue = 24 }, + }, + }, + { + Name = "CriteriaRequiredValue", + Type = "Structure", + Fields = + { + { Name = "criteriaID", Type = "number", Nilable = false }, + { Name = "requiredValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "CriteriaRequirement", + Type = "Structure", + Fields = + { + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "requirementText", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PerksVendorConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattleConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattleConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cec09b6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattleConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,354 @@ +local PetBattleConstants = +{ + Tables = + { + { + Name = "PetBattleQueueStatus", + Type = "Enumeration", + NumValues = 22, + MinValue = 0, + MaxValue = 21, + Fields = + { + { Name = "None", Type = "PetBattleQueueStatus", EnumValue = 0 }, + { Name = "Queued", Type = "PetBattleQueueStatus", EnumValue = 1 }, + { Name = "QueuedUpdate", Type = "PetBattleQueueStatus", EnumValue = 2 }, + { Name = "AlreadyQueued", Type = "PetBattleQueueStatus", EnumValue = 3 }, + { Name = "JoinFailed", Type = "PetBattleQueueStatus", EnumValue = 4 }, + { Name = "JoinFailedSlots", Type = "PetBattleQueueStatus", EnumValue = 5 }, + { Name = "JoinFailedJournalLock", Type = "PetBattleQueueStatus", EnumValue = 6 }, + { Name = "JoinFailedNeutral", Type = "PetBattleQueueStatus", EnumValue = 7 }, + { Name = "MatchAccepted", Type = "PetBattleQueueStatus", EnumValue = 8 }, + { Name = "MatchDeclined", Type = "PetBattleQueueStatus", EnumValue = 9 }, + { Name = "MatchOpponentDeclined", Type = "PetBattleQueueStatus", EnumValue = 10 }, + { Name = "ProposalTimedOut", Type = "PetBattleQueueStatus", EnumValue = 11 }, + { Name = "Removed", Type = "PetBattleQueueStatus", EnumValue = 12 }, + { Name = "RequeuedAfterInternalError", Type = "PetBattleQueueStatus", EnumValue = 13 }, + { Name = "RequeuedAfterOpponentRemoved", Type = "PetBattleQueueStatus", EnumValue = 14 }, + { Name = "Matchmaking", Type = "PetBattleQueueStatus", EnumValue = 15 }, + { Name = "LostConnection", Type = "PetBattleQueueStatus", EnumValue = 16 }, + { Name = "Shutdown", Type = "PetBattleQueueStatus", EnumValue = 17 }, + { Name = "Suspended", Type = "PetBattleQueueStatus", EnumValue = 18 }, + { Name = "Unsuspended", Type = "PetBattleQueueStatus", EnumValue = 19 }, + { Name = "InBattle", Type = "PetBattleQueueStatus", EnumValue = 20 }, + { Name = "NoBattlingHere", Type = "PetBattleQueueStatus", EnumValue = 21 }, + }, + }, + { + Name = "PetbattleAuraStateFlags", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 32, + Fields = + { + { Name = "None", Type = "PetbattleAuraStateFlags", EnumValue = 0 }, + { Name = "Infinite", Type = "PetbattleAuraStateFlags", EnumValue = 1 }, + { Name = "Canceled", Type = "PetbattleAuraStateFlags", EnumValue = 2 }, + { Name = "InitDisabled", Type = "PetbattleAuraStateFlags", EnumValue = 4 }, + { Name = "CountdownFirstRound", Type = "PetbattleAuraStateFlags", EnumValue = 8 }, + { Name = "JustApplied", Type = "PetbattleAuraStateFlags", EnumValue = 16 }, + { Name = "RemoveEventHandled", Type = "PetbattleAuraStateFlags", EnumValue = 32 }, + }, + }, + { + Name = "PetbattleCheatFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "PetbattleCheatFlags", EnumValue = 0 }, + { Name = "AutoPlay", Type = "PetbattleCheatFlags", EnumValue = 1 }, + }, + }, + { + Name = "PetbattleEffectFlags", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 8192, + Fields = + { + { Name = "None", Type = "PetbattleEffectFlags", EnumValue = 0 }, + { Name = "InvalidTarget", Type = "PetbattleEffectFlags", EnumValue = 1 }, + { Name = "Miss", Type = "PetbattleEffectFlags", EnumValue = 2 }, + { Name = "Crit", Type = "PetbattleEffectFlags", EnumValue = 4 }, + { Name = "Blocked", Type = "PetbattleEffectFlags", EnumValue = 8 }, + { Name = "Dodge", Type = "PetbattleEffectFlags", EnumValue = 16 }, + { Name = "Heal", Type = "PetbattleEffectFlags", EnumValue = 32 }, + { Name = "Unkillable", Type = "PetbattleEffectFlags", EnumValue = 64 }, + { Name = "Reflect", Type = "PetbattleEffectFlags", EnumValue = 128 }, + { Name = "Absorb", Type = "PetbattleEffectFlags", EnumValue = 256 }, + { Name = "Immune", Type = "PetbattleEffectFlags", EnumValue = 512 }, + { Name = "Strong", Type = "PetbattleEffectFlags", EnumValue = 1024 }, + { Name = "Weak", Type = "PetbattleEffectFlags", EnumValue = 2048 }, + { Name = "SuccessChain", Type = "PetbattleEffectFlags", EnumValue = 4096 }, + { Name = "AuraReapply", Type = "PetbattleEffectFlags", EnumValue = 8192 }, + }, + }, + { + Name = "PetbattleEffectType", + Type = "Enumeration", + NumValues = 18, + MinValue = 0, + MaxValue = 17, + Fields = + { + { Name = "SetHealth", Type = "PetbattleEffectType", EnumValue = 0 }, + { Name = "AuraApply", Type = "PetbattleEffectType", EnumValue = 1 }, + { Name = "AuraCancel", Type = "PetbattleEffectType", EnumValue = 2 }, + { Name = "AuraChange", Type = "PetbattleEffectType", EnumValue = 3 }, + { Name = "PetSwap", Type = "PetbattleEffectType", EnumValue = 4 }, + { Name = "StatusChange", Type = "PetbattleEffectType", EnumValue = 5 }, + { Name = "SetState", Type = "PetbattleEffectType", EnumValue = 6 }, + { Name = "SetMaxHealth", Type = "PetbattleEffectType", EnumValue = 7 }, + { Name = "SetSpeed", Type = "PetbattleEffectType", EnumValue = 8 }, + { Name = "SetPower", Type = "PetbattleEffectType", EnumValue = 9 }, + { Name = "TriggerAbility", Type = "PetbattleEffectType", EnumValue = 10 }, + { Name = "AbilityChange", Type = "PetbattleEffectType", EnumValue = 11 }, + { Name = "NpcEmote", Type = "PetbattleEffectType", EnumValue = 12 }, + { Name = "AuraProcessingBegin", Type = "PetbattleEffectType", EnumValue = 13 }, + { Name = "AuraProcessingEnd", Type = "PetbattleEffectType", EnumValue = 14 }, + { Name = "ReplacePet", Type = "PetbattleEffectType", EnumValue = 15 }, + { Name = "OverrideAbility", Type = "PetbattleEffectType", EnumValue = 16 }, + { Name = "WorldStateUpdate", Type = "PetbattleEffectType", EnumValue = 17 }, + }, + }, + { + Name = "PetbattleEnviros", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Pad0", Type = "PetbattleEnviros", EnumValue = 0 }, + { Name = "Pad1", Type = "PetbattleEnviros", EnumValue = 1 }, + { Name = "Weather", Type = "PetbattleEnviros", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleInputMoveMsgDebugFlag", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "PetbattleInputMoveMsgDebugFlag", EnumValue = 0 }, + { Name = "DontValidate", Type = "PetbattleInputMoveMsgDebugFlag", EnumValue = 1 }, + { Name = "EnemyCast", Type = "PetbattleInputMoveMsgDebugFlag", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleMoveType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Quit", Type = "PetbattleMoveType", EnumValue = 0 }, + { Name = "Ability", Type = "PetbattleMoveType", EnumValue = 1 }, + { Name = "Swap", Type = "PetbattleMoveType", EnumValue = 2 }, + { Name = "Trap", Type = "PetbattleMoveType", EnumValue = 3 }, + { Name = "FinalRoundOk", Type = "PetbattleMoveType", EnumValue = 4 }, + { Name = "Pass", Type = "PetbattleMoveType", EnumValue = 5 }, + }, + }, + { + Name = "PetbattlePboid", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "P0Pet_0", Type = "PetbattlePboid", EnumValue = 0 }, + { Name = "P0Pet_1", Type = "PetbattlePboid", EnumValue = 1 }, + { Name = "P0Pet_2", Type = "PetbattlePboid", EnumValue = 2 }, + { Name = "P1Pet_0", Type = "PetbattlePboid", EnumValue = 3 }, + { Name = "P1Pet_1", Type = "PetbattlePboid", EnumValue = 4 }, + { Name = "P1Pet_2", Type = "PetbattlePboid", EnumValue = 5 }, + { Name = "EnvPad_0", Type = "PetbattlePboid", EnumValue = 6 }, + { Name = "EnvPad_1", Type = "PetbattlePboid", EnumValue = 7 }, + { Name = "EnvWeather", Type = "PetbattlePboid", EnumValue = 8 }, + }, + }, + { + Name = "PetbattlePetStatus", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "FlagNone", Type = "PetbattlePetStatus", EnumValue = 0 }, + { Name = "FlagTrapped", Type = "PetbattlePetStatus", EnumValue = 1 }, + { Name = "Stunned", Type = "PetbattlePetStatus", EnumValue = 2 }, + { Name = "SwapOutLocked", Type = "PetbattlePetStatus", EnumValue = 4 }, + { Name = "SwapInLocked", Type = "PetbattlePetStatus", EnumValue = 8 }, + }, + }, + { + Name = "PetbattlePlayer", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Player_0", Type = "PetbattlePlayer", EnumValue = 0 }, + { Name = "Player_1", Type = "PetbattlePlayer", EnumValue = 1 }, + }, + }, + { + Name = "PetbattlePlayerInputFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "PetbattlePlayerInputFlags", EnumValue = 0 }, + { Name = "TurnInProgress", Type = "PetbattlePlayerInputFlags", EnumValue = 1 }, + { Name = "AbilityLocked", Type = "PetbattlePlayerInputFlags", EnumValue = 2 }, + { Name = "SwapLocked", Type = "PetbattlePlayerInputFlags", EnumValue = 4 }, + { Name = "WaitingForPet", Type = "PetbattlePlayerInputFlags", EnumValue = 8 }, + }, + }, + { + Name = "PetbattleResult", + Type = "Enumeration", + NumValues = 24, + MinValue = 0, + MaxValue = 23, + Fields = + { + { Name = "FailUnknown", Type = "PetbattleResult", EnumValue = 0 }, + { Name = "FailNotHere", Type = "PetbattleResult", EnumValue = 1 }, + { Name = "FailNotHereOnTransport", Type = "PetbattleResult", EnumValue = 2 }, + { Name = "FailNotHereUnevenGround", Type = "PetbattleResult", EnumValue = 3 }, + { Name = "FailNotHereObstructed", Type = "PetbattleResult", EnumValue = 4 }, + { Name = "FailNotWhileInCombat", Type = "PetbattleResult", EnumValue = 5 }, + { Name = "FailNotWhileDead", Type = "PetbattleResult", EnumValue = 6 }, + { Name = "FailNotWhileFlying", Type = "PetbattleResult", EnumValue = 7 }, + { Name = "FailTargetInvalid", Type = "PetbattleResult", EnumValue = 8 }, + { Name = "FailTargetOutOfRange", Type = "PetbattleResult", EnumValue = 9 }, + { Name = "FailTargetNotCapturable", Type = "PetbattleResult", EnumValue = 10 }, + { Name = "FailNotATrainer", Type = "PetbattleResult", EnumValue = 11 }, + { Name = "FailDeclined", Type = "PetbattleResult", EnumValue = 12 }, + { Name = "FailInBattle", Type = "PetbattleResult", EnumValue = 13 }, + { Name = "FailInvalidLoadout", Type = "PetbattleResult", EnumValue = 14 }, + { Name = "FailInvalidLoadoutAllDead", Type = "PetbattleResult", EnumValue = 15 }, + { Name = "FailInvalidLoadoutNoneSlotted", Type = "PetbattleResult", EnumValue = 16 }, + { Name = "FailNoJournalLock", Type = "PetbattleResult", EnumValue = 17 }, + { Name = "FailWildPetTapped", Type = "PetbattleResult", EnumValue = 18 }, + { Name = "FailRestrictedAccount", Type = "PetbattleResult", EnumValue = 19 }, + { Name = "FailOpponentNotAvailable", Type = "PetbattleResult", EnumValue = 20 }, + { Name = "FailLogout", Type = "PetbattleResult", EnumValue = 21 }, + { Name = "FailDisconnect", Type = "PetbattleResult", EnumValue = 22 }, + { Name = "Success", Type = "PetbattleResult", EnumValue = 23 }, + }, + }, + { + Name = "PetbattleSlot", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Slot_0", Type = "PetbattleSlot", EnumValue = 0 }, + { Name = "Slot_1", Type = "PetbattleSlot", EnumValue = 1 }, + { Name = "Slot_2", Type = "PetbattleSlot", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleSlotAbility", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Ability_0", Type = "PetbattleSlotAbility", EnumValue = 0 }, + { Name = "Ability_1", Type = "PetbattleSlotAbility", EnumValue = 1 }, + { Name = "Ability_2", Type = "PetbattleSlotAbility", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleSlotResult", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Success", Type = "PetbattleSlotResult", EnumValue = 0 }, + { Name = "SlotLocked", Type = "PetbattleSlotResult", EnumValue = 1 }, + { Name = "SlotEmpty", Type = "PetbattleSlotResult", EnumValue = 2 }, + { Name = "NoTracker", Type = "PetbattleSlotResult", EnumValue = 3 }, + { Name = "NoSpeciesRec", Type = "PetbattleSlotResult", EnumValue = 4 }, + { Name = "CantBattle", Type = "PetbattleSlotResult", EnumValue = 5 }, + { Name = "Revoked", Type = "PetbattleSlotResult", EnumValue = 6 }, + { Name = "Dead", Type = "PetbattleSlotResult", EnumValue = 7 }, + { Name = "NoPet", Type = "PetbattleSlotResult", EnumValue = 8 }, + }, + }, + { + Name = "PetbattleState", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Created", Type = "PetbattleState", EnumValue = 0 }, + { Name = "WaitingPreBattle", Type = "PetbattleState", EnumValue = 1 }, + { Name = "RoundInProgress", Type = "PetbattleState", EnumValue = 2 }, + { Name = "WaitingForFrontPets", Type = "PetbattleState", EnumValue = 3 }, + { Name = "CreatedFailed", Type = "PetbattleState", EnumValue = 4 }, + { Name = "FinalRound", Type = "PetbattleState", EnumValue = 5 }, + { Name = "Finished", Type = "PetbattleState", EnumValue = 6 }, + }, + }, + { + Name = "PetbattleTrapstatus", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Invalid", Type = "PetbattleTrapstatus", EnumValue = 0 }, + { Name = "CanTrap", Type = "PetbattleTrapstatus", EnumValue = 1 }, + { Name = "CantTrapNewbie", Type = "PetbattleTrapstatus", EnumValue = 2 }, + { Name = "CantTrapPetDead", Type = "PetbattleTrapstatus", EnumValue = 3 }, + { Name = "CantTrapPetHealth", Type = "PetbattleTrapstatus", EnumValue = 4 }, + { Name = "CantTrapNoRoomInJournal", Type = "PetbattleTrapstatus", EnumValue = 5 }, + { Name = "CantTrapPetNotCapturable", Type = "PetbattleTrapstatus", EnumValue = 6 }, + { Name = "CantTrapTrainerBattle", Type = "PetbattleTrapstatus", EnumValue = 7 }, + { Name = "CantTrapTwice", Type = "PetbattleTrapstatus", EnumValue = 8 }, + }, + }, + { + Name = "PetbattleType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "PvE", Type = "PetbattleType", EnumValue = 0 }, + { Name = "PvP", Type = "PetbattleType", EnumValue = 1 }, + { Name = "Lfpb", Type = "PetbattleType", EnumValue = 2 }, + { Name = "Npc", Type = "PetbattleType", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PetBattleConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..25153c7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetBattlesDocumentation.lua.annotated.lua @@ -0,0 +1,90 @@ +local PetBattles = +{ + Name = "PetBattles", + Type = "System", + Namespace = "C_PetBattles", + Environment = "All", + + Functions = + { + { + Name = "GetBreedQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petOwner", Type = "BattlePetOwner", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "quality", Type = "BattlePetBreedQuality", Nilable = false }, + }, + }, + { + Name = "GetIcon", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petOwner", Type = "BattlePetOwner", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "iconFileID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetName", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petOwner", Type = "BattlePetOwner", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "customName", Type = "string", Nilable = false }, + { Name = "speciesName", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsPlayerNPC", + Type = "Function", + + Returns = + { + { Name = "isPlayerNPC", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWildBattle", + Type = "Function", + + Returns = + { + { Name = "isWildBattle", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PetBattles); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..02b6b2a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,193 @@ +local PetConstants = +{ + Tables = + { + { + Name = "PetActionFeedback", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Success", Type = "PetActionFeedback", EnumValue = 0 }, + { Name = "Dead", Type = "PetActionFeedback", EnumValue = 1 }, + { Name = "InvalidTarget", Type = "PetActionFeedback", EnumValue = 2 }, + { Name = "FriendlyTarget", Type = "PetActionFeedback", EnumValue = 3 }, + { Name = "NoPath", Type = "PetActionFeedback", EnumValue = 4 }, + }, + }, + { + Name = "PetActionbuttonType", + Type = "Enumeration", + NumValues = 20, + MinValue = 0, + MaxValue = 19, + Fields = + { + { Name = "None", Type = "PetActionbuttonType", EnumValue = 0 }, + { Name = "Spell", Type = "PetActionbuttonType", EnumValue = 1 }, + { Name = "Slot1Obsolete", Type = "PetActionbuttonType", EnumValue = 2 }, + { Name = "Slot2Obsolete", Type = "PetActionbuttonType", EnumValue = 3 }, + { Name = "Slot3Obsolete", Type = "PetActionbuttonType", EnumValue = 4 }, + { Name = "Slot4Obsolete", Type = "PetActionbuttonType", EnumValue = 5 }, + { Name = "Mode", Type = "PetActionbuttonType", EnumValue = 6 }, + { Name = "Orders", Type = "PetActionbuttonType", EnumValue = 7 }, + { Name = "Slot1", Type = "PetActionbuttonType", EnumValue = 8 }, + { Name = "Slot2", Type = "PetActionbuttonType", EnumValue = 9 }, + { Name = "Slot3", Type = "PetActionbuttonType", EnumValue = 10 }, + { Name = "Slot4", Type = "PetActionbuttonType", EnumValue = 11 }, + { Name = "Slot5", Type = "PetActionbuttonType", EnumValue = 12 }, + { Name = "Slot6", Type = "PetActionbuttonType", EnumValue = 13 }, + { Name = "Slot7", Type = "PetActionbuttonType", EnumValue = 14 }, + { Name = "Slot8", Type = "PetActionbuttonType", EnumValue = 15 }, + { Name = "Slot9", Type = "PetActionbuttonType", EnumValue = 16 }, + { Name = "Slot10", Type = "PetActionbuttonType", EnumValue = 17 }, + { Name = "Max", Type = "PetActionbuttonType", EnumValue = 18 }, + { Name = "VehicleAction", Type = "PetActionbuttonType", EnumValue = 19 }, + }, + }, + { + Name = "PetMode", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Passive", Type = "PetMode", EnumValue = 0 }, + { Name = "Defensive", Type = "PetMode", EnumValue = 1 }, + { Name = "Aggressive", Type = "PetMode", EnumValue = 2 }, + { Name = "Assist", Type = "PetMode", EnumValue = 3 }, + }, + }, + { + Name = "PetOrders", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Wait", Type = "PetOrders", EnumValue = 0 }, + { Name = "Follow", Type = "PetOrders", EnumValue = 1 }, + { Name = "Attack", Type = "PetOrders", EnumValue = 2 }, + { Name = "Dismiss", Type = "PetOrders", EnumValue = 3 }, + { Name = "MoveTo", Type = "PetOrders", EnumValue = 4 }, + }, + }, + { + Name = "PetOverride", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "PetOverride", EnumValue = 0 }, + { Name = "AICombatControl", Type = "PetOverride", EnumValue = 1 }, + { Name = "AICombatPassive", Type = "PetOverride", EnumValue = 2 }, + { Name = "OwnerMounted", Type = "PetOverride", EnumValue = 4 }, + }, + }, + { + Name = "Pettameresult", + Type = "Enumeration", + NumValues = 16, + MinValue = 0, + MaxValue = 15, + Fields = + { + { Name = "Ok", Type = "Pettameresult", EnumValue = 0 }, + { Name = "Invalidcreature", Type = "Pettameresult", EnumValue = 1 }, + { Name = "Toomany", Type = "Pettameresult", EnumValue = 2 }, + { Name = "Creaturealreadyowned", Type = "Pettameresult", EnumValue = 3 }, + { Name = "Nottameable", Type = "Pettameresult", EnumValue = 4 }, + { Name = "Anothersummonactive", Type = "Pettameresult", EnumValue = 5 }, + { Name = "Unitscanttame", Type = "Pettameresult", EnumValue = 6 }, + { Name = "Nopetavailable", Type = "Pettameresult", EnumValue = 7 }, + { Name = "Internalerror", Type = "Pettameresult", EnumValue = 8 }, + { Name = "Toohighlevel", Type = "Pettameresult", EnumValue = 9 }, + { Name = "Dead", Type = "Pettameresult", EnumValue = 10 }, + { Name = "Notdead", Type = "Pettameresult", EnumValue = 11 }, + { Name = "Cantcontrolexotic", Type = "Pettameresult", EnumValue = 12 }, + { Name = "Invalidslot", Type = "Pettameresult", EnumValue = 13 }, + { Name = "EliteToohighlevel", Type = "Pettameresult", EnumValue = 14 }, + { Name = "Numresults", Type = "Pettameresult", EnumValue = 15 }, + }, + }, + { + Name = "StableResult", + Type = "Enumeration", + NumValues = 17, + MinValue = 0, + MaxValue = 16, + Fields = + { + { Name = "MaxSlots", Type = "StableResult", EnumValue = 0 }, + { Name = "InsufficientFunds", Type = "StableResult", EnumValue = 1 }, + { Name = "NotStableMaster", Type = "StableResult", EnumValue = 2 }, + { Name = "InvalidSlot", Type = "StableResult", EnumValue = 3 }, + { Name = "NoPet", Type = "StableResult", EnumValue = 4 }, + { Name = "AlreadyStabled", Type = "StableResult", EnumValue = 5 }, + { Name = "AlreadySummoned", Type = "StableResult", EnumValue = 6 }, + { Name = "NotFound", Type = "StableResult", EnumValue = 7 }, + { Name = "StableSuccess", Type = "StableResult", EnumValue = 8 }, + { Name = "UnstableSuccess", Type = "StableResult", EnumValue = 9 }, + { Name = "ReviveSuccess", Type = "StableResult", EnumValue = 10 }, + { Name = "CantControlExotic", Type = "StableResult", EnumValue = 11 }, + { Name = "InternalError", Type = "StableResult", EnumValue = 12 }, + { Name = "CheckForLuaHack", Type = "StableResult", EnumValue = 13 }, + { Name = "BuySlotSuccess", Type = "StableResult", EnumValue = 14 }, + { Name = "FavoriteToggle", Type = "StableResult", EnumValue = 15 }, + { Name = "PetRenamed", Type = "StableResult", EnumValue = 16 }, + }, + }, + { + Name = "UnitMirrorPetFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "Renameable", Type = "UnitMirrorPetFlags", EnumValue = 1 }, + { Name = "Dismissable", Type = "UnitMirrorPetFlags", EnumValue = 2 }, + { Name = "RecentlyTamed", Type = "UnitMirrorPetFlags", EnumValue = 4 }, + { Name = "Stampede", Type = "UnitMirrorPetFlags", EnumValue = 8 }, + { Name = "ExtraPet", Type = "UnitMirrorPetFlags", EnumValue = 16 }, + }, + }, + { + Name = "PetConsts", + Type = "Constants", + Values = + { + { Name = "PETNUMBER_INVALIDSLOT", Type = "number", Value = -1 }, + { Name = "MAX_SUMMONABLE_PETS", Type = "number", Value = 25 }, + { Name = "PETNUMBER_INVALIDPET", Type = "number", Value = 0 }, + { Name = "PETNUMBER_PENDINGPET", Type = "number", Value = -1 }, + }, + }, + { + Name = "PetConsts_PostCata", + Type = "Constants", + Values = + { + { Name = "NUM_PET_SLOTS_THAT_NEED_LEARNED_SPELL", Type = "number", Value = 5 }, + { Name = "MAX_SUMMONABLE_HUNTER_PETS", Type = "number", Value = Constants.PetConsts_PostCata.NUM_PET_SLOTS_THAT_NEED_LEARNED_SPELL }, + { Name = "MAX_STABLE_SLOTS", Type = "number", Value = 200 }, + { Name = "EXTRA_PET_STABLE_SLOT", Type = "number", Value = Constants.PetConsts_PostCata.MAX_SUMMONABLE_HUNTER_PETS }, + { Name = "STABLED_PETS_FIRST_SLOT_INDEX", Type = "number", Value = Constants.PetConsts_PostCata.EXTRA_PET_STABLE_SLOT }, + { Name = "NUM_PET_SLOTS_HUNTER", Type = "number", Value = Constants.PetConsts_PostCata.MAX_STABLE_SLOTS + Constants.PetConsts_PostCata.NUM_PET_SLOTS_THAT_NEED_LEARNED_SPELL }, + { Name = "NUM_PET_SLOTS_DEATHKNIGHT", Type = "number", Value = Constants.PetConsts.MAX_SUMMONABLE_PETS }, + { Name = "DEATHKNIGHT_PET_CREATURE_ID", Type = "number", Value = 26125 }, + { Name = "NUM_PET_SLOTS_MAGE", Type = "number", Value = 1 }, + { Name = "NUM_PET_SLOTS_WARLOCK", Type = "number", Value = Constants.PetConsts.MAX_SUMMONABLE_PETS }, + { Name = "MAX_NUM_PET_SLOTS", Type = "number", Value = Constants.PetConsts_PostCata.NUM_PET_SLOTS_HUNTER }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PetConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6ca5855 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetInfoDocumentation.lua.annotated.lua @@ -0,0 +1,194 @@ +local PetInfo = +{ + Name = "PetInfo", + Type = "System", + Namespace = "C_PetInfo", + Environment = "All", + + Functions = + { + { + Name = "GetPetTalentTree", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "talentTreeName", Type = "stringView", Nilable = false }, + }, + }, + { + Name = "GetPetTamersForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "petTamers", Type = "table", InnerType = "PetTamerMapInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellForPetAction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsPetActionPassive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPassive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetAbandon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petNumber", Type = "number", Nilable = true }, + }, + }, + { + Name = "PetAssistMode", + Type = "Function", + }, + { + Name = "PetRename", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "petNumber", Type = "number", Nilable = true }, + { Name = "declensions", Type = "table", InnerType = "cstring", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "PetAttackStart", + Type = "Event", + LiteralName = "PET_ATTACK_START", + SynchronousEvent = true, + }, + { + Name = "PetAttackStop", + Type = "Event", + LiteralName = "PET_ATTACK_STOP", + SynchronousEvent = true, + }, + { + Name = "PetBarHidegrid", + Type = "Event", + LiteralName = "PET_BAR_HIDEGRID", + SynchronousEvent = true, + }, + { + Name = "PetBarShowgrid", + Type = "Event", + LiteralName = "PET_BAR_SHOWGRID", + SynchronousEvent = true, + }, + { + Name = "PetBarUpdateCooldown", + Type = "Event", + LiteralName = "PET_BAR_UPDATE_COOLDOWN", + SynchronousEvent = true, + }, + { + Name = "PetDismissStart", + Type = "Event", + LiteralName = "PET_DISMISS_START", + SynchronousEvent = true, + Payload = + { + { Name = "delay", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetForceNameDeclension", + Type = "Event", + LiteralName = "PET_FORCE_NAME_DECLENSION", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "petNumber", Type = "number", Nilable = true }, + { Name = "declinedName1", Type = "cstring", Nilable = true }, + { Name = "declinedName2", Type = "cstring", Nilable = true }, + { Name = "declinedName3", Type = "cstring", Nilable = true }, + { Name = "declinedName4", Type = "cstring", Nilable = true }, + { Name = "declinedName5", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "PetUiClose", + Type = "Event", + LiteralName = "PET_UI_CLOSE", + SynchronousEvent = true, + }, + { + Name = "RaisedAsGhoul", + Type = "Event", + LiteralName = "RAISED_AS_GHOUL", + SynchronousEvent = true, + }, + { + Name = "UpdatePossessBar", + Type = "Event", + LiteralName = "UPDATE_POSSESS_BAR", + SynchronousEvent = true, + }, + { + Name = "UpdateVehicleActionbar", + Type = "Event", + LiteralName = "UPDATE_VEHICLE_ACTIONBAR", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "PetTamerMapInfo", + Type = "Structure", + Fields = + { + { Name = "areaPoiID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "atlasName", Type = "string", Nilable = true }, + { Name = "textureIndex", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PetInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bb653d7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetJournalInfoDocumentation.lua.annotated.lua @@ -0,0 +1,494 @@ +local PetJournalInfo = +{ + Name = "PetJournalInfo", + Type = "System", + Namespace = "C_PetJournal", + Environment = "All", + + Functions = + { + { + Name = "ClearHoveredBattlePet", + Type = "Function", + }, + { + Name = "ClearSearchFilter", + Type = "Function", + }, + { + Name = "DismissSummonedPet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetDisplayIDByIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "speciesID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "displayID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetDisplayProbabilityByIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "speciesID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "displayProbability", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNonBattlePetLinkByIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetNumDisplays", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "speciesID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numDisplays", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNumPetsInJournal", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "maxAllowed", Type = "number", Nilable = false }, + { Name = "numPets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOwnedPetIDs", + Type = "Function", + + Returns = + { + { Name = "ownedPetIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetPetAbilityInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "abilityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "petType", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetAbilityListTable", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "speciesID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "table", InnerType = "PetAbilityLevelInfo", Nilable = false }, + }, + }, + { + Name = "GetPetInfoTableByPetID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PetJournalPetInfo", Nilable = false }, + }, + }, + { + Name = "GetPetLoadOutInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "petID", Type = "WOWGUID", Nilable = true }, + { Name = "ability1ID", Type = "number", Nilable = false }, + { Name = "ability2ID", Type = "number", Nilable = false }, + { Name = "ability3ID", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPetSummonInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isSummonable", Type = "bool", Nilable = false }, + { Name = "error", Type = "PetJournalError", Nilable = false }, + { Name = "errorText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetSearchFilter", + Type = "Function", + + Returns = + { + { Name = "filterText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "HasFavoritePets", + Type = "Function", + + Returns = + { + { Name = "hasFavorites", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrentlySummoned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isSummoned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingDefaultFilters", + Type = "Function", + + Returns = + { + { Name = "isUsingDefaultFilters", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetIsSummonable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isSummonable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetUsesRandomDisplay", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "speciesID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "usesRandomDisplay", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SetDefaultFilters", + Type = "Function", + }, + { + Name = "SetHoveredBattlePet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "SetSearchFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "filterText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SpellTargetBattlePet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BattlepetForceNameDeclension", + Type = "Event", + LiteralName = "BATTLEPET_FORCE_NAME_DECLENSION", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "CompanionLearned", + Type = "Event", + LiteralName = "COMPANION_LEARNED", + SynchronousEvent = true, + }, + { + Name = "CompanionUnlearned", + Type = "Event", + LiteralName = "COMPANION_UNLEARNED", + SynchronousEvent = true, + }, + { + Name = "CompanionUpdate", + Type = "Event", + LiteralName = "COMPANION_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "companionType", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "NewPetAdded", + Type = "Event", + LiteralName = "NEW_PET_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PetJournalAutoSlottedPet", + Type = "Event", + LiteralName = "PET_JOURNAL_AUTO_SLOTTED_PET", + SynchronousEvent = true, + Payload = + { + { Name = "slotIndex", Type = "number", Nilable = false }, + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PetJournalCageFailed", + Type = "Event", + LiteralName = "PET_JOURNAL_CAGE_FAILED", + SynchronousEvent = true, + }, + { + Name = "PetJournalListUpdate", + Type = "Event", + LiteralName = "PET_JOURNAL_LIST_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "PetJournalNewBattleSlot", + Type = "Event", + LiteralName = "PET_JOURNAL_NEW_BATTLE_SLOT", + SynchronousEvent = true, + }, + { + Name = "PetJournalPetDeleted", + Type = "Event", + LiteralName = "PET_JOURNAL_PET_DELETED", + SynchronousEvent = true, + Payload = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PetJournalPetRestored", + Type = "Event", + LiteralName = "PET_JOURNAL_PET_RESTORED", + SynchronousEvent = true, + Payload = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PetJournalPetRevoked", + Type = "Event", + LiteralName = "PET_JOURNAL_PET_REVOKED", + SynchronousEvent = true, + Payload = + { + { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PetJournalPetsHealed", + Type = "Event", + LiteralName = "PET_JOURNAL_PETS_HEALED", + SynchronousEvent = true, + }, + { + Name = "PetJournalTrapLevelSet", + Type = "Event", + LiteralName = "PET_JOURNAL_TRAP_LEVEL_SET", + SynchronousEvent = true, + Payload = + { + { Name = "trapLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateSummonpetsAction", + Type = "Event", + LiteralName = "UPDATE_SUMMONPETS_ACTION", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "PetJournalError", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "PetJournalError", EnumValue = 0 }, + { Name = "PetIsDead", Type = "PetJournalError", EnumValue = 1 }, + { Name = "JournalIsLocked", Type = "PetJournalError", EnumValue = 2 }, + { Name = "InvalidFaction", Type = "PetJournalError", EnumValue = 3 }, + { Name = "NoFavoritesToSummon", Type = "PetJournalError", EnumValue = 4 }, + { Name = "NoValidRandomSummon", Type = "PetJournalError", EnumValue = 5 }, + }, + }, + { + Name = "PetAbilityLevelInfo", + Type = "Structure", + Fields = + { + { Name = "abilityID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetJournalPetInfo", + Type = "Structure", + Fields = + { + { Name = "speciesID", Type = "number", Nilable = false }, + { Name = "customName", Type = "string", Nilable = true }, + { Name = "petLevel", Type = "number", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "maxXP", Type = "number", Nilable = false }, + { Name = "displayID", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "petType", Type = "number", Nilable = false }, + { Name = "creatureID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "sourceText", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "isWild", Type = "bool", Nilable = false }, + { Name = "canBattle", Type = "bool", Nilable = false }, + { Name = "tradable", Type = "bool", Nilable = false }, + { Name = "unique", Type = "bool", Nilable = false }, + { Name = "obtainable", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PetJournalInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetScalingConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetScalingConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d900a41 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PetScalingConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local PetScalingConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PetScalingConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cf800c3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,93 @@ +local PingConstants = +{ + Tables = + { + { + Name = "PingMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "KeyDown", Type = "PingMode", EnumValue = 0 }, + { Name = "ClickDrag", Type = "PingMode", EnumValue = 1 }, + }, + }, + { + Name = "PingResult", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Success", Type = "PingResult", EnumValue = 0 }, + { Name = "FailedGeneric", Type = "PingResult", EnumValue = 1 }, + { Name = "FailedSpamming", Type = "PingResult", EnumValue = 2 }, + { Name = "FailedDisabledByLeader", Type = "PingResult", EnumValue = 3 }, + { Name = "FailedDisabledBySettings", Type = "PingResult", EnumValue = 4 }, + { Name = "FailedOutOfPingArea", Type = "PingResult", EnumValue = 5 }, + { Name = "FailedSquelched", Type = "PingResult", EnumValue = 6 }, + { Name = "FailedUnspecified", Type = "PingResult", EnumValue = 7 }, + }, + }, + { + Name = "PingSubjectType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Attack", Type = "PingSubjectType", EnumValue = 0 }, + { Name = "Warning", Type = "PingSubjectType", EnumValue = 1 }, + { Name = "Assist", Type = "PingSubjectType", EnumValue = 2 }, + { Name = "OnMyWay", Type = "PingSubjectType", EnumValue = 3 }, + { Name = "AlertThreat", Type = "PingSubjectType", EnumValue = 4 }, + { Name = "AlertNotThreat", Type = "PingSubjectType", EnumValue = 5 }, + }, + }, + { + Name = "PingTypeFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "DefaultPing", Type = "PingTypeFlags", EnumValue = 1 }, + }, + }, + { + Name = "ContextualWorldPingResult", + Type = "Structure", + Fields = + { + { Name = "contextualPingType", Type = "PingSubjectType", Nilable = true }, + { Name = "result", Type = "PingResult", Nilable = false }, + }, + }, + { + Name = "PingCooldownInfo", + Type = "Structure", + Fields = + { + { Name = "startTimeMs", Type = "number", Nilable = false }, + { Name = "endTimeMs", Type = "number", Nilable = false }, + }, + }, + { + Name = "PingTypeInfo", + Type = "Structure", + Fields = + { + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "type", Type = "PingSubjectType", Nilable = false }, + { Name = "uiTextureKitID", Type = "textureKit", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PingConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9648d14 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerDocumentation.lua.annotated.lua @@ -0,0 +1,111 @@ +local PingManager = +{ + Name = "PingManager", + Type = "System", + Namespace = "C_Ping", + Environment = "All", + + Functions = + { + { + Name = "GetContextualPingTypeForUnit", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "targetUnit", Type = "WOWGUID", Nilable = true }, + }, + + Returns = + { + { Name = "type", Type = "PingSubjectType", Nilable = false }, + }, + }, + { + Name = "GetCooldownInfo", + Type = "Function", + + Returns = + { + { Name = "cooldownInfo", Type = "PingCooldownInfo", Nilable = false }, + }, + }, + { + Name = "GetDefaultPingOptions", + Type = "Function", + + Returns = + { + { Name = "pingTypes", Type = "table", InnerType = "PingTypeInfo", Nilable = false }, + }, + }, + { + Name = "GetTextureKitForType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PingSubjectType", Nilable = false }, + }, + + Returns = + { + { Name = "uiTextureKitID", Type = "textureKit", Nilable = false }, + }, + }, + { + Name = "IsPingSystemEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SendMacroPing", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PingSubjectType", Nilable = true }, + { Name = "targetToken", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "TogglePingListener", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "PingSystemError", + Type = "Event", + LiteralName = "PING_SYSTEM_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "error", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PingManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua.annotated.lua new file mode 100644 index 0000000..74feaab --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingManagerSecureDocumentation.lua.annotated.lua @@ -0,0 +1,262 @@ +local PingManagerSecure = +{ + Name = "PingManagerSecure", + Type = "System", + Namespace = "C_PingSecure", + Environment = "SecureOnly", + + Functions = + { + { + Name = "ClearPendingPingInfo", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "CreateFrame", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "DisplayError", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "error", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetTargetPingReceiver", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mousePosX", Type = "number", Nilable = false }, + { Name = "mousePosY", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "frame", Type = "ScriptRegion", Nilable = false }, + }, + }, + { + Name = "GetTargetWorldPing", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mousePosX", Type = "number", Nilable = false }, + { Name = "mousePosY", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "foundTarget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTargetWorldPingAndSend", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "result", Type = "ContextualWorldPingResult", Nilable = false }, + }, + }, + { + Name = "SendPing", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PingSubjectType", Nilable = false }, + { Name = "target", Type = "WOWGUID", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "PingResult", Nilable = false }, + }, + }, + { + Name = "SetPendingPingOffScreenCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PendingPingOffScreenCallback", Nilable = false }, + }, + }, + { + Name = "SetPingCooldownStartedCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PingCooldownStartedCallback", Nilable = false }, + }, + }, + { + Name = "SetPingPinFrameAddedCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PingPinFrameAddedCallback", Nilable = false }, + }, + }, + { + Name = "SetPingPinFrameRemovedCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PingPinFrameRemovedCallback", Nilable = false }, + }, + }, + { + Name = "SetPingPinFrameScreenClampStateUpdatedCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PingPinFrameScreenClampStateUpdatedCallback", Nilable = false }, + }, + }, + { + Name = "SetPingRadialWheelCreatedCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "PingRadialWheelCreatedCallback", Nilable = false }, + }, + }, + { + Name = "SetSendMacroPingCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "SendMacroPingCallback", Nilable = false }, + }, + }, + { + Name = "SetTogglePingListenerCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "TogglePingListenerCallback", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "PendingPingOffScreenCallback", + Type = "CallbackType", + }, + { + Name = "PingCooldownStartedCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "info", Type = "PingCooldownInfo", Nilable = false }, + }, + }, + { + Name = "PingPinFrameAddedCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "region", Type = "ScriptRegion", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "isWorldPoint", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PingPinFrameRemovedCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "region", Type = "ScriptRegion", Nilable = false }, + }, + }, + { + Name = "PingPinFrameScreenClampStateUpdatedCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "region", Type = "ScriptRegion", Nilable = false }, + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PingRadialWheelCreatedCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "region", Type = "ScriptRegion", Nilable = false }, + }, + }, + { + Name = "SendMacroPingCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "type", Type = "PingSubjectType", Nilable = true }, + { Name = "targetToken", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "TogglePingListenerCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "down", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PingManagerSecure); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingPinFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingPinFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c9abd46 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PingPinFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local PingPinFrameAPI = +{ + Name = "PingPinFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PingPinFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlatformDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlatformDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c5017f7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlatformDocumentation.lua.annotated.lua @@ -0,0 +1,33 @@ +local Platform = +{ + Name = "Platform", + Type = "System", + Namespace = "C_Platform", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + { + Name = "ClientPlatformType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Windows", Type = "ClientPlatformType", EnumValue = 0 }, + { Name = "Macintosh", Type = "ClientPlatformType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Platform); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ddaa67b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerChoiceDocumentation.lua.annotated.lua @@ -0,0 +1,205 @@ +local PlayerChoice = +{ + Name = "PlayerChoice", + Type = "System", + Namespace = "C_PlayerChoice", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentPlayerChoiceInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "choiceInfo", Type = "PlayerChoiceInfo", Nilable = false }, + }, + }, + { + Name = "GetNumRerolls", + Type = "Function", + + Returns = + { + { Name = "numRerolls", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRemainingTime", + Type = "Function", + + Returns = + { + { Name = "remainingTime", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsWaitingForPlayerChoiceResponse", + Type = "Function", + + Returns = + { + { Name = "isWaitingForResponse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnUIClosed", + Type = "Function", + }, + { + Name = "RequestRerollPlayerChoice", + Type = "Function", + }, + { + Name = "SendPlayerChoiceResponse", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "responseID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "PlayerChoiceClose", + Type = "Event", + LiteralName = "PLAYER_CHOICE_CLOSE", + SynchronousEvent = true, + }, + { + Name = "PlayerChoiceUpdate", + Type = "Event", + LiteralName = "PLAYER_CHOICE_UPDATE", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "PlayerChoiceRarity", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Common", Type = "PlayerChoiceRarity", EnumValue = 0 }, + { Name = "Uncommon", Type = "PlayerChoiceRarity", EnumValue = 1 }, + { Name = "Rare", Type = "PlayerChoiceRarity", EnumValue = 2 }, + { Name = "Epic", Type = "PlayerChoiceRarity", EnumValue = 3 }, + }, + }, + { + Name = "PlayerChoiceInfo", + Type = "Structure", + Fields = + { + { Name = "objectGUID", Type = "WOWGUID", Nilable = false }, + { Name = "choiceID", Type = "number", Nilable = false }, + { Name = "questionText", Type = "string", Nilable = false }, + { Name = "pendingChoiceText", Type = "string", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hideWarboardHeader", Type = "bool", Nilable = false }, + { Name = "keepOpenAfterChoice", Type = "bool", Nilable = false }, + { Name = "showChoicesAsList", Type = "bool", Nilable = false }, + { Name = "requiresSelection", Type = "bool", Nilable = false }, + { Name = "options", Type = "table", InnerType = "PlayerChoiceOptionInfo", Nilable = false }, + { Name = "soundKitID", Type = "number", Nilable = true }, + { Name = "closeUISoundKitID", Type = "number", Nilable = true }, + }, + }, + { + Name = "PlayerChoiceOptionButtonInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "disabled", Type = "bool", Nilable = false }, + { Name = "showCheckmark", Type = "bool", Nilable = false }, + { Name = "hideButtonShowText", Type = "bool", Nilable = false }, + { Name = "selected", Type = "bool", Nilable = false }, + { Name = "confirmation", Type = "string", Nilable = true }, + { Name = "tooltip", Type = "string", Nilable = true }, + { Name = "rewardQuestID", Type = "number", Nilable = true }, + { Name = "soundKitID", Type = "number", Nilable = true }, + { Name = "listText", Type = "string", Nilable = true }, + }, + }, + { + Name = "PlayerChoiceOptionInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "header", Type = "string", Nilable = false }, + { Name = "choiceArtID", Type = "number", Nilable = false }, + { Name = "desaturatedArt", Type = "bool", Nilable = false }, + { Name = "disabledOption", Type = "bool", Nilable = false }, + { Name = "hasRewards", Type = "bool", Nilable = false }, + { Name = "rewardInfo", Type = "PlayerChoiceOptionRewardInfo", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "maxStacks", Type = "number", Nilable = false }, + { Name = "buttons", Type = "table", InnerType = "PlayerChoiceOptionButtonInfo", Nilable = false }, + { Name = "widgetSetID", Type = "number", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "rarity", Type = "PlayerChoiceRarity", Nilable = true }, + { Name = "typeArtID", Type = "number", Nilable = true }, + { Name = "headerIconAtlasElement", Type = "string", Nilable = true }, + { Name = "subHeader", Type = "string", Nilable = true }, + { Name = "consolidateWidgets", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerChoiceOptionRewardInfo", + Type = "Structure", + Fields = + { + { Name = "currencyRewards", Type = "table", InnerType = "PlayerChoiceRewardCurrencyInfo", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "PlayerChoiceRewardItemInfo", Nilable = false }, + { Name = "repRewards", Type = "table", InnerType = "PlayerChoiceRewardReputationInfo", Nilable = false }, + }, + }, + { + Name = "PlayerChoiceRewardCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "currencyId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "currencyTexture", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "isCurrencyContainer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerChoiceRewardItemInfo", + Type = "Structure", + Fields = + { + { Name = "itemId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerChoiceRewardReputationInfo", + Type = "Structure", + Fields = + { + { Name = "factionId", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerChoice); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDataConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDataConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2915cd0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDataConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local PlayerDataConstants = +{ + Tables = + { + { + Name = "PlayerDataElementType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Int", Type = "PlayerDataElementType", EnumValue = 0 }, + { Name = "Float", Type = "PlayerDataElementType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerDataConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a003b95 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local Player = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Player); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerHousingConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerHousingConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dc5c8ae --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerHousingConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,512 @@ +local PlayerHousingConstants = +{ + Tables = + { + { + Name = "HouseEditingContext", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "HouseEditingContext", EnumValue = 0 }, + { Name = "Decor", Type = "HouseEditingContext", EnumValue = 1 }, + { Name = "Room", Type = "HouseEditingContext", EnumValue = 2 }, + { Name = "Fixture", Type = "HouseEditingContext", EnumValue = 3 }, + }, + }, + { + Name = "HouseEditorMode", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "None", Type = "HouseEditorMode", EnumValue = 0 }, + { Name = "BasicDecor", Type = "HouseEditorMode", EnumValue = 1 }, + { Name = "ExpertDecor", Type = "HouseEditorMode", EnumValue = 2 }, + { Name = "Layout", Type = "HouseEditorMode", EnumValue = 3 }, + { Name = "Customize", Type = "HouseEditorMode", EnumValue = 4 }, + { Name = "Cleanup", Type = "HouseEditorMode", EnumValue = 5 }, + { Name = "ExteriorCustomization", Type = "HouseEditorMode", EnumValue = 6 }, + }, + }, + { + Name = "HouseExteriorWMODataFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "HouseExteriorWMODataFlags", EnumValue = 0 }, + { Name = "UnlockedByDefault", Type = "HouseExteriorWMODataFlags", EnumValue = 1 }, + { Name = "AllowedInHordeNeighborhoods", Type = "HouseExteriorWMODataFlags", EnumValue = 2 }, + { Name = "AllowedInAllianceNeighborhoods", Type = "HouseExteriorWMODataFlags", EnumValue = 4 }, + }, + }, + { + Name = "HouseFinderSuggestionReason", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 32, + Fields = + { + { Name = "None", Type = "HouseFinderSuggestionReason", EnumValue = 0 }, + { Name = "Owner", Type = "HouseFinderSuggestionReason", EnumValue = 1 }, + { Name = "CharterInvite", Type = "HouseFinderSuggestionReason", EnumValue = 2 }, + { Name = "Guild", Type = "HouseFinderSuggestionReason", EnumValue = 4 }, + { Name = "BNetFriends", Type = "HouseFinderSuggestionReason", EnumValue = 8 }, + { Name = "PartySync", Type = "HouseFinderSuggestionReason", EnumValue = 16 }, + { Name = "Random", Type = "HouseFinderSuggestionReason", EnumValue = 32 }, + }, + }, + { + Name = "HouseOwnerError", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "HouseOwnerError", EnumValue = 0 }, + { Name = "Faction", Type = "HouseOwnerError", EnumValue = 1 }, + { Name = "Guild", Type = "HouseOwnerError", EnumValue = 2 }, + { Name = "GenericPermission", Type = "HouseOwnerError", EnumValue = 3 }, + }, + }, + { + Name = "HousingDecorTheme", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "HousingDecorTheme", EnumValue = 0 }, + { Name = "Folk", Type = "HousingDecorTheme", EnumValue = 1 }, + { Name = "Rugged", Type = "HousingDecorTheme", EnumValue = 2 }, + { Name = "Generic", Type = "HousingDecorTheme", EnumValue = 3 }, + { Name = "NightElf", Type = "HousingDecorTheme", EnumValue = 4 }, + { Name = "BloodElf", Type = "HousingDecorTheme", EnumValue = 5 }, + }, + }, + { + Name = "HousingFixtureFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "HousingFixtureFlags", EnumValue = 0 }, + { Name = "IsDefaultFixture", Type = "HousingFixtureFlags", EnumValue = 1 }, + { Name = "UnlockedByDefault", Type = "HousingFixtureFlags", EnumValue = 2 }, + }, + }, + { + Name = "HousingFixtureSize", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "HousingFixtureSize", EnumValue = 0 }, + { Name = "Any", Type = "HousingFixtureSize", EnumValue = 1 }, + { Name = "Small", Type = "HousingFixtureSize", EnumValue = 2 }, + { Name = "Medium", Type = "HousingFixtureSize", EnumValue = 3 }, + { Name = "Large", Type = "HousingFixtureSize", EnumValue = 4 }, + }, + }, + { + Name = "HousingFixtureType", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 16, + Fields = + { + { Name = "None", Type = "HousingFixtureType", EnumValue = 0 }, + { Name = "Base", Type = "HousingFixtureType", EnumValue = 9 }, + { Name = "Roof", Type = "HousingFixtureType", EnumValue = 10 }, + { Name = "Door", Type = "HousingFixtureType", EnumValue = 11 }, + { Name = "Window", Type = "HousingFixtureType", EnumValue = 12 }, + { Name = "RoofDetail", Type = "HousingFixtureType", EnumValue = 13 }, + { Name = "RoofWindow", Type = "HousingFixtureType", EnumValue = 14 }, + { Name = "Tower", Type = "HousingFixtureType", EnumValue = 15 }, + { Name = "Chimney", Type = "HousingFixtureType", EnumValue = 16 }, + }, + }, + { + Name = "HousingLayoutRestriction", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "None", Type = "HousingLayoutRestriction", EnumValue = 0 }, + { Name = "RoomNotFound", Type = "HousingLayoutRestriction", EnumValue = 1 }, + { Name = "NotInsideHouse", Type = "HousingLayoutRestriction", EnumValue = 2 }, + { Name = "NotHouseOwner", Type = "HousingLayoutRestriction", EnumValue = 3 }, + { Name = "IsBaseRoom", Type = "HousingLayoutRestriction", EnumValue = 4 }, + { Name = "RoomNotLeaf", Type = "HousingLayoutRestriction", EnumValue = 5 }, + { Name = "StairwellConnection", Type = "HousingLayoutRestriction", EnumValue = 6 }, + { Name = "LastRoom", Type = "HousingLayoutRestriction", EnumValue = 7 }, + { Name = "UnreachableRoom", Type = "HousingLayoutRestriction", EnumValue = 8 }, + { Name = "SingleDoor", Type = "HousingLayoutRestriction", EnumValue = 9 }, + }, + }, + { + Name = "HousingPlotOwnerType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "HousingPlotOwnerType", EnumValue = 0 }, + { Name = "Stranger", Type = "HousingPlotOwnerType", EnumValue = 1 }, + { Name = "Friend", Type = "HousingPlotOwnerType", EnumValue = 2 }, + { Name = "Self", Type = "HousingPlotOwnerType", EnumValue = 3 }, + }, + }, + { + Name = "HousingResult", + Type = "Enumeration", + NumValues = 90, + MinValue = 0, + MaxValue = 89, + Fields = + { + { Name = "Success", Type = "HousingResult", EnumValue = 0 }, + { Name = "ActionLockedByCombat", Type = "HousingResult", EnumValue = 1 }, + { Name = "BoundsFailureChildren", Type = "HousingResult", EnumValue = 2 }, + { Name = "BoundsFailurePlot", Type = "HousingResult", EnumValue = 3 }, + { Name = "BoundsFailureRoom", Type = "HousingResult", EnumValue = 4 }, + { Name = "CannotAfford", Type = "HousingResult", EnumValue = 5 }, + { Name = "CharterComplete", Type = "HousingResult", EnumValue = 6 }, + { Name = "CollisionInvalid", Type = "HousingResult", EnumValue = 7 }, + { Name = "DbError", Type = "HousingResult", EnumValue = 8 }, + { Name = "DecorCannotBeRedeemed", Type = "HousingResult", EnumValue = 9 }, + { Name = "DecorItemNotDestroyable", Type = "HousingResult", EnumValue = 10 }, + { Name = "DecorNotFound", Type = "HousingResult", EnumValue = 11 }, + { Name = "DecorNotFoundInStorage", Type = "HousingResult", EnumValue = 12 }, + { Name = "DuplicateCharterSignature", Type = "HousingResult", EnumValue = 13 }, + { Name = "FilterRejected", Type = "HousingResult", EnumValue = 14 }, + { Name = "FixtureCantDeleteDoor", Type = "HousingResult", EnumValue = 15 }, + { Name = "FixtureHookEmpty", Type = "HousingResult", EnumValue = 16 }, + { Name = "FixtureHookOccupied", Type = "HousingResult", EnumValue = 17 }, + { Name = "FixtureHouseTypeMismatch", Type = "HousingResult", EnumValue = 18 }, + { Name = "FixtureNotFound", Type = "HousingResult", EnumValue = 19 }, + { Name = "FixtureSizeMismatch", Type = "HousingResult", EnumValue = 20 }, + { Name = "FixtureTypeMismatch", Type = "HousingResult", EnumValue = 21 }, + { Name = "GenericFailure", Type = "HousingResult", EnumValue = 22 }, + { Name = "GuildMoreAccountsNeeded", Type = "HousingResult", EnumValue = 23 }, + { Name = "GuildMoreActivePlayersNeeded", Type = "HousingResult", EnumValue = 24 }, + { Name = "GuildNotLoaded", Type = "HousingResult", EnumValue = 25 }, + { Name = "HouseEditLockFailed", Type = "HousingResult", EnumValue = 26 }, + { Name = "HouseExteriorAlreadyThatSize", Type = "HousingResult", EnumValue = 27 }, + { Name = "HouseExteriorAlreadyThatType", Type = "HousingResult", EnumValue = 28 }, + { Name = "HouseExteriorRootNotFound", Type = "HousingResult", EnumValue = 29 }, + { Name = "HouseExteriorTypeNeighborhoodMismatch", Type = "HousingResult", EnumValue = 30 }, + { Name = "HouseExteriorTypeNotFound", Type = "HousingResult", EnumValue = 31 }, + { Name = "HouseExteriorTypeSizeMismatch", Type = "HousingResult", EnumValue = 32 }, + { Name = "HouseExteriorSizeNotAvailable", Type = "HousingResult", EnumValue = 33 }, + { Name = "HookNotChildOfFixture", Type = "HousingResult", EnumValue = 34 }, + { Name = "HouseNotFound", Type = "HousingResult", EnumValue = 35 }, + { Name = "IncorrectFaction", Type = "HousingResult", EnumValue = 36 }, + { Name = "InvalidDecorItem", Type = "HousingResult", EnumValue = 37 }, + { Name = "InvalidDistance", Type = "HousingResult", EnumValue = 38 }, + { Name = "InvalidGuild", Type = "HousingResult", EnumValue = 39 }, + { Name = "InvalidHouse", Type = "HousingResult", EnumValue = 40 }, + { Name = "InvalidInstance", Type = "HousingResult", EnumValue = 41 }, + { Name = "InvalidInteraction", Type = "HousingResult", EnumValue = 42 }, + { Name = "InvalidMap", Type = "HousingResult", EnumValue = 43 }, + { Name = "InvalidNeighborhoodName", Type = "HousingResult", EnumValue = 44 }, + { Name = "InvalidRoomLayout", Type = "HousingResult", EnumValue = 45 }, + { Name = "LockedByOtherPlayer", Type = "HousingResult", EnumValue = 46 }, + { Name = "LockOperationFailed", Type = "HousingResult", EnumValue = 47 }, + { Name = "MaxDecorReached", Type = "HousingResult", EnumValue = 48 }, + { Name = "MaxPreviewDecorReached", Type = "HousingResult", EnumValue = 49 }, + { Name = "MissingCoreFixture", Type = "HousingResult", EnumValue = 50 }, + { Name = "MissingDye", Type = "HousingResult", EnumValue = 51 }, + { Name = "MissingExpansionAccess", Type = "HousingResult", EnumValue = 52 }, + { Name = "MissingFactionMap", Type = "HousingResult", EnumValue = 53 }, + { Name = "MissingPrivateNeighborhoodInvite", Type = "HousingResult", EnumValue = 54 }, + { Name = "MoreHouseSlotsNeeded", Type = "HousingResult", EnumValue = 55 }, + { Name = "MoreSignaturesNeeded", Type = "HousingResult", EnumValue = 56 }, + { Name = "NeighborhoodNotFound", Type = "HousingResult", EnumValue = 57 }, + { Name = "NoNeighborhoodOwnershipRequests", Type = "HousingResult", EnumValue = 58 }, + { Name = "NotInDecorEditMode", Type = "HousingResult", EnumValue = 59 }, + { Name = "NotInFixtureEditMode", Type = "HousingResult", EnumValue = 60 }, + { Name = "NotInLayoutEditMode", Type = "HousingResult", EnumValue = 61 }, + { Name = "NotInsideHouse", Type = "HousingResult", EnumValue = 62 }, + { Name = "NotOnOwnedPlot", Type = "HousingResult", EnumValue = 63 }, + { Name = "OperationAborted", Type = "HousingResult", EnumValue = 64 }, + { Name = "OwnerNotInGuild", Type = "HousingResult", EnumValue = 65 }, + { Name = "PermissionDenied", Type = "HousingResult", EnumValue = 66 }, + { Name = "PlacementTargetInvalid", Type = "HousingResult", EnumValue = 67 }, + { Name = "PlayerNotFound", Type = "HousingResult", EnumValue = 68 }, + { Name = "PlayerNotInInstance", Type = "HousingResult", EnumValue = 69 }, + { Name = "PlotNotFound", Type = "HousingResult", EnumValue = 70 }, + { Name = "PlotNotVacant", Type = "HousingResult", EnumValue = 71 }, + { Name = "PlotReservationCooldown", Type = "HousingResult", EnumValue = 72 }, + { Name = "PlotReserved", Type = "HousingResult", EnumValue = 73 }, + { Name = "RoomNotFound", Type = "HousingResult", EnumValue = 74 }, + { Name = "RoomUpdateFailed", Type = "HousingResult", EnumValue = 75 }, + { Name = "RpcFailure", Type = "HousingResult", EnumValue = 76 }, + { Name = "ServiceNotAvailable", Type = "HousingResult", EnumValue = 77 }, + { Name = "StaticDataNotFound", Type = "HousingResult", EnumValue = 78 }, + { Name = "TimeoutLimit", Type = "HousingResult", EnumValue = 79 }, + { Name = "TimerunningNotAllowed", Type = "HousingResult", EnumValue = 80 }, + { Name = "TokenRequired", Type = "HousingResult", EnumValue = 81 }, + { Name = "TooManyRequests", Type = "HousingResult", EnumValue = 82 }, + { Name = "TransactionFailure", Type = "HousingResult", EnumValue = 83 }, + { Name = "UncollectedExteriorFixture", Type = "HousingResult", EnumValue = 84 }, + { Name = "UncollectedHouseType", Type = "HousingResult", EnumValue = 85 }, + { Name = "UncollectedRoom", Type = "HousingResult", EnumValue = 86 }, + { Name = "UncollectedRoomMaterial", Type = "HousingResult", EnumValue = 87 }, + { Name = "UncollectedRoomTheme", Type = "HousingResult", EnumValue = 88 }, + { Name = "UnlockOperationFailed", Type = "HousingResult", EnumValue = 89 }, + }, + }, + { + Name = "HousingRoomComponentCeilingType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Flat", Type = "HousingRoomComponentCeilingType", EnumValue = 0 }, + { Name = "Vaulted", Type = "HousingRoomComponentCeilingType", EnumValue = 1 }, + }, + }, + { + Name = "HousingRoomComponentDoorType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "HousingRoomComponentDoorType", EnumValue = 0 }, + { Name = "Doorway", Type = "HousingRoomComponentDoorType", EnumValue = 1 }, + { Name = "Threshold", Type = "HousingRoomComponentDoorType", EnumValue = 2 }, + }, + }, + { + Name = "HousingRoomComponentFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "HousingRoomComponentFlags", EnumValue = 0 }, + { Name = "HiddenInLayoutMode", Type = "HousingRoomComponentFlags", EnumValue = 1 }, + }, + }, + { + Name = "HousingRoomComponentFloorType", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "Floor", Type = "HousingRoomComponentFloorType", EnumValue = 0 }, + }, + }, + { + Name = "HousingRoomComponentOptionFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "HousingRoomComponentOptionFlags", EnumValue = 0 }, + { Name = "IsDefault", Type = "HousingRoomComponentOptionFlags", EnumValue = 1 }, + }, + }, + { + Name = "HousingRoomComponentOptionType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Cosmetic", Type = "HousingRoomComponentOptionType", EnumValue = 0 }, + { Name = "DoorwayWall", Type = "HousingRoomComponentOptionType", EnumValue = 1 }, + { Name = "Doorway", Type = "HousingRoomComponentOptionType", EnumValue = 2 }, + }, + }, + { + Name = "HousingRoomComponentStairType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "HousingRoomComponentStairType", EnumValue = 0 }, + { Name = "StartToEnd", Type = "HousingRoomComponentStairType", EnumValue = 1 }, + { Name = "StartToMiddle", Type = "HousingRoomComponentStairType", EnumValue = 2 }, + { Name = "MiddleToMiddle", Type = "HousingRoomComponentStairType", EnumValue = 3 }, + { Name = "MiddleToEnd", Type = "HousingRoomComponentStairType", EnumValue = 4 }, + }, + }, + { + Name = "HousingRoomComponentTextureFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "HousingRoomComponentTextureFlags", EnumValue = 0 }, + { Name = "UnlockedByDefault", Type = "HousingRoomComponentTextureFlags", EnumValue = 1 }, + }, + }, + { + Name = "HousingRoomComponentType", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "None", Type = "HousingRoomComponentType", EnumValue = 0 }, + { Name = "Wall", Type = "HousingRoomComponentType", EnumValue = 1 }, + { Name = "Floor", Type = "HousingRoomComponentType", EnumValue = 2 }, + { Name = "Ceiling", Type = "HousingRoomComponentType", EnumValue = 3 }, + { Name = "Stairs", Type = "HousingRoomComponentType", EnumValue = 4 }, + { Name = "Pillar", Type = "HousingRoomComponentType", EnumValue = 5 }, + { Name = "DoorwayWall", Type = "HousingRoomComponentType", EnumValue = 6 }, + { Name = "Doorway", Type = "HousingRoomComponentType", EnumValue = 7 }, + }, + }, + { + Name = "HousingRoomFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "HousingRoomFlags", EnumValue = 0 }, + { Name = "BaseRoom", Type = "HousingRoomFlags", EnumValue = 1 }, + { Name = "HasStairs", Type = "HousingRoomFlags", EnumValue = 2 }, + { Name = "UnlockedByDefault", Type = "HousingRoomFlags", EnumValue = 4 }, + { Name = "HasCustomGeometry", Type = "HousingRoomFlags", EnumValue = 8 }, + }, + }, + { + Name = "HousingThemeFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "HousingThemeFlags", EnumValue = 0 }, + { Name = "UnlockedByDefault", Type = "HousingThemeFlags", EnumValue = 1 }, + { Name = "ShowInStyleSelector", Type = "HousingThemeFlags", EnumValue = 2 }, + }, + }, + { + Name = "HousingThrottleType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "General", Type = "HousingThrottleType", EnumValue = 0 }, + { Name = "Decoration", Type = "HousingThrottleType", EnumValue = 1 }, + }, + }, + { + Name = "NeighborhoodFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "NeighborhoodFlags", EnumValue = 0 }, + { Name = "PoolParent", Type = "NeighborhoodFlags", EnumValue = 1 }, + { Name = "OpenToPublic", Type = "NeighborhoodFlags", EnumValue = 2 }, + }, + }, + { + Name = "NeighborhoodInviteResult", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Success", Type = "NeighborhoodInviteResult", EnumValue = 0 }, + { Name = "DbError", Type = "NeighborhoodInviteResult", EnumValue = 1 }, + { Name = "RpcFailure", Type = "NeighborhoodInviteResult", EnumValue = 2 }, + { Name = "GenericFailure", Type = "NeighborhoodInviteResult", EnumValue = 3 }, + { Name = "Permission", Type = "NeighborhoodInviteResult", EnumValue = 4 }, + { Name = "Faction", Type = "NeighborhoodInviteResult", EnumValue = 5 }, + { Name = "PendingInvitation", Type = "NeighborhoodInviteResult", EnumValue = 6 }, + { Name = "InviteLimit", Type = "NeighborhoodInviteResult", EnumValue = 7 }, + { Name = "NotEnoughPlots", Type = "NeighborhoodInviteResult", EnumValue = 8 }, + { Name = "NotFound", Type = "NeighborhoodInviteResult", EnumValue = 9 }, + { Name = "TooManyRequests", Type = "NeighborhoodInviteResult", EnumValue = 10 }, + { Name = "AlreadyInNeighborhood", Type = "NeighborhoodInviteResult", EnumValue = 11 }, + }, + }, + { + Name = "NeighborhoodMapFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "NeighborhoodMapFlags", EnumValue = 0 }, + { Name = "AlliancePurchasable", Type = "NeighborhoodMapFlags", EnumValue = 1 }, + { Name = "HordePurchasable", Type = "NeighborhoodMapFlags", EnumValue = 2 }, + { Name = "CanSystemGenerate", Type = "NeighborhoodMapFlags", EnumValue = 4 }, + }, + }, + { + Name = "RetroactiveDecorRewardFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "RetroactiveDecorRewardFlags", EnumValue = 0 }, + { Name = "AllCriteriaRequired", Type = "RetroactiveDecorRewardFlags", EnumValue = 1 }, + }, + }, + { + Name = "RoomConnectionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "RoomConnectionType", EnumValue = 0 }, + { Name = "All", Type = "RoomConnectionType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerHousingConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8e39782 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoDocumentation.lua.annotated.lua @@ -0,0 +1,376 @@ +local PlayerInfo = +{ + Name = "PlayerInfo", + Type = "System", + Namespace = "C_PlayerInfo", + Environment = "All", + + Functions = + { + { + Name = "CanPlayerEnterChromieTime", + Type = "Function", + + Returns = + { + { Name = "canEnter", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseAreaLoot", + Type = "Function", + + Returns = + { + { Name = "canUseAreaLoot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseMountEquipment", + Type = "Function", + + Returns = + { + { Name = "canUseMountEquipment", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanUseItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isUseable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAlternateFormInfo", + Type = "Function", + + Returns = + { + { Name = "hasAlternateForm", Type = "bool", Nilable = false }, + { Name = "inAlternateForm", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetContentDifficultyCreatureForPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "difficulty", Type = "RelativeContentDifficulty", Nilable = false }, + }, + }, + { + Name = "GetContentDifficultyQuestForPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "difficulty", Type = "RelativeContentDifficulty", Nilable = false }, + }, + }, + { + Name = "GetDisplayID", + Type = "Function", + + Returns = + { + { Name = "displayID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGlidingInfo", + Type = "Function", + + Returns = + { + { Name = "isGliding", Type = "bool", Nilable = false }, + { Name = "canGlide", Type = "bool", Nilable = false }, + { Name = "forwardSpeed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstancesUnlockedAtLevel", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + { Name = "isRaid", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "dungeonID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetNativeDisplayID", + Type = "Function", + + Returns = + { + { Name = "nativeDisplayID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetStableCreatureDisplayInfoID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "creatureDisplayInfoID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerCharacterData", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "characterData", Type = "PlayerInfoCharacterData", Nilable = false }, + }, + }, + { + Name = "GetPlayerMythicPlusRatingSummary", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the players mythic+ rating summary which includes the runs they've completed as well as their current season m+ rating" }, + + Arguments = + { + { Name = "playerToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "ratingSummary", Type = "MythicPlusRatingSummary", Nilable = false }, + }, + }, + { + Name = "HasAccountInventoryLock", + Type = "Function", + + Returns = + { + { Name = "hasAccountInventoryLock", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasVisibleInvSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAccountBankEnabled", + Type = "Function", + + Returns = + { + { Name = "isAccountBankEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCharacterBankEnabled", + Type = "Function", + + Returns = + { + { Name = "isCharacterBankEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDisplayRaceNative", + Type = "Function", + + Returns = + { + { Name = "isDisplayRaceNative", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMirrorImage", + Type = "Function", + + Returns = + { + { Name = "isMirrorImage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerEligibleForNPE", + Type = "Function", + + Returns = + { + { Name = "isEligible", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsPlayerEligibleForNPEv2", + Type = "Function", + + Returns = + { + { Name = "isEligible", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsPlayerInChromieTime", + Type = "Function", + + Returns = + { + { Name = "inChromieTime", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInRPE", + Type = "Function", + + Returns = + { + { Name = "isInRPE", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInTimerunningHeroicWorldTier", + Type = "Function", + + Returns = + { + { Name = "inTimerunningHeroicWorldTier", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerNPERestricted", + Type = "Function", + + Returns = + { + { Name = "isRestricted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsReturningCharacter", + Type = "Function", + + Returns = + { + { Name = "isReturning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSelfFoundActive", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTradingPostAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTravelersLogAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTutorialsTabAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "MythicPlusRatingMapSummary", + Type = "Structure", + Documentation = { "Specific information about a completed mythic plus run." }, + Fields = + { + { Name = "challengeModeID", Type = "number", Nilable = false }, + { Name = "mapScore", Type = "number", Nilable = false }, + { Name = "bestRunLevel", Type = "number", Nilable = false }, + { Name = "bestRunDurationMS", Type = "number", Nilable = false }, + { Name = "finishedSuccess", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MythicPlusRatingSummary", + Type = "Structure", + Documentation = { "The current season rating and well as a list of completed mythic plus runs." }, + Fields = + { + { Name = "currentSeasonScore", Type = "number", Nilable = false }, + { Name = "runs", Type = "table", InnerType = "MythicPlusRatingMapSummary", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..45ffffb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local PlayerInfoShared = +{ + Tables = + { + { + Name = "CharacterAlternateFormData", + Type = "Structure", + Fields = + { + { Name = "raceID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "fileName", Type = "cstring", Nilable = false }, + { Name = "createScreenIconAtlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "PlayerInfoCharacterData", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "fileName", Type = "cstring", Nilable = false }, + { Name = "alternateFormRaceData", Type = "CharacterAlternateFormData", Nilable = true }, + { Name = "createScreenIconAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "sex", Type = "UnitSex", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..07fb6de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,98 @@ +local PlayerInteractionManagerConstants = +{ + Tables = + { + { + Name = "PlayerInteractionType", + Type = "Enumeration", + NumValues = 80, + MinValue = 0, + MaxValue = 79, + Fields = + { + { Name = "None", Type = "PlayerInteractionType", EnumValue = 0 }, + { Name = "TradePartner", Type = "PlayerInteractionType", EnumValue = 1 }, + { Name = "Item", Type = "PlayerInteractionType", EnumValue = 2 }, + { Name = "Gossip", Type = "PlayerInteractionType", EnumValue = 3 }, + { Name = "QuestGiver", Type = "PlayerInteractionType", EnumValue = 4 }, + { Name = "Merchant", Type = "PlayerInteractionType", EnumValue = 5 }, + { Name = "TaxiNode", Type = "PlayerInteractionType", EnumValue = 6 }, + { Name = "Trainer", Type = "PlayerInteractionType", EnumValue = 7 }, + { Name = "Banker", Type = "PlayerInteractionType", EnumValue = 8 }, + { Name = "AlliedRaceDetailsGiver", Type = "PlayerInteractionType", EnumValue = 9 }, + { Name = "GuildBanker", Type = "PlayerInteractionType", EnumValue = 10 }, + { Name = "Registrar", Type = "PlayerInteractionType", EnumValue = 11 }, + { Name = "Vendor", Type = "PlayerInteractionType", EnumValue = 12 }, + { Name = "PetitionVendor", Type = "PlayerInteractionType", EnumValue = 13 }, + { Name = "GuildTabardVendor", Type = "PlayerInteractionType", EnumValue = 14 }, + { Name = "TalentMaster", Type = "PlayerInteractionType", EnumValue = 15 }, + { Name = "SpecializationMaster", Type = "PlayerInteractionType", EnumValue = 16 }, + { Name = "MailInfo", Type = "PlayerInteractionType", EnumValue = 17 }, + { Name = "SpiritHealer", Type = "PlayerInteractionType", EnumValue = 18 }, + { Name = "AreaSpiritHealer", Type = "PlayerInteractionType", EnumValue = 19 }, + { Name = "Binder", Type = "PlayerInteractionType", EnumValue = 20 }, + { Name = "Auctioneer", Type = "PlayerInteractionType", EnumValue = 21 }, + { Name = "StableMaster", Type = "PlayerInteractionType", EnumValue = 22 }, + { Name = "BattleMaster", Type = "PlayerInteractionType", EnumValue = 23 }, + { Name = "Transmogrifier", Type = "PlayerInteractionType", EnumValue = 24 }, + { Name = "LFGDungeon", Type = "PlayerInteractionType", EnumValue = 25 }, + { Name = "VoidStorageBanker", Type = "PlayerInteractionType", EnumValue = 26 }, + { Name = "BlackMarketAuctioneer", Type = "PlayerInteractionType", EnumValue = 27 }, + { Name = "AdventureMap", Type = "PlayerInteractionType", EnumValue = 28 }, + { Name = "WorldMap", Type = "PlayerInteractionType", EnumValue = 29 }, + { Name = "GarrArchitect", Type = "PlayerInteractionType", EnumValue = 30 }, + { Name = "GarrTradeskill", Type = "PlayerInteractionType", EnumValue = 31 }, + { Name = "GarrMission", Type = "PlayerInteractionType", EnumValue = 32 }, + { Name = "ShipmentCrafter", Type = "PlayerInteractionType", EnumValue = 33 }, + { Name = "GarrRecruitment", Type = "PlayerInteractionType", EnumValue = 34 }, + { Name = "GarrTalent", Type = "PlayerInteractionType", EnumValue = 35 }, + { Name = "Trophy", Type = "PlayerInteractionType", EnumValue = 36 }, + { Name = "PlayerChoice", Type = "PlayerInteractionType", EnumValue = 37 }, + { Name = "ArtifactForge", Type = "PlayerInteractionType", EnumValue = 38 }, + { Name = "ObliterumForge", Type = "PlayerInteractionType", EnumValue = 39 }, + { Name = "ScrappingMachine", Type = "PlayerInteractionType", EnumValue = 40 }, + { Name = "ContributionCollector", Type = "PlayerInteractionType", EnumValue = 41 }, + { Name = "AzeriteRespec", Type = "PlayerInteractionType", EnumValue = 42 }, + { Name = "IslandQueue", Type = "PlayerInteractionType", EnumValue = 43 }, + { Name = "ItemInteraction", Type = "PlayerInteractionType", EnumValue = 44 }, + { Name = "ChromieTime", Type = "PlayerInteractionType", EnumValue = 45 }, + { Name = "CovenantPreview", Type = "PlayerInteractionType", EnumValue = 46 }, + { Name = "AnimaDiversion", Type = "PlayerInteractionType", EnumValue = 47 }, + { Name = "LegendaryCrafting", Type = "PlayerInteractionType", EnumValue = 48 }, + { Name = "WeeklyRewards", Type = "PlayerInteractionType", EnumValue = 49 }, + { Name = "Soulbind", Type = "PlayerInteractionType", EnumValue = 50 }, + { Name = "CovenantSanctum", Type = "PlayerInteractionType", EnumValue = 51 }, + { Name = "NewPlayerGuide", Type = "PlayerInteractionType", EnumValue = 52 }, + { Name = "ItemUpgrade", Type = "PlayerInteractionType", EnumValue = 53 }, + { Name = "AdventureJournal", Type = "PlayerInteractionType", EnumValue = 54 }, + { Name = "Renown", Type = "PlayerInteractionType", EnumValue = 55 }, + { Name = "AzeriteForge", Type = "PlayerInteractionType", EnumValue = 56 }, + { Name = "PerksProgramVendor", Type = "PlayerInteractionType", EnumValue = 57 }, + { Name = "ProfessionsCraftingOrder", Type = "PlayerInteractionType", EnumValue = 58 }, + { Name = "Professions", Type = "PlayerInteractionType", EnumValue = 59 }, + { Name = "ProfessionsCustomerOrder", Type = "PlayerInteractionType", EnumValue = 60 }, + { Name = "TraitSystem", Type = "PlayerInteractionType", EnumValue = 61 }, + { Name = "BarbersChoice", Type = "PlayerInteractionType", EnumValue = 62 }, + { Name = "JailersTowerBuffs", Type = "PlayerInteractionType", EnumValue = 63 }, + { Name = "MajorFactionRenown", Type = "PlayerInteractionType", EnumValue = 64 }, + { Name = "PersonalTabardVendor", Type = "PlayerInteractionType", EnumValue = 65 }, + { Name = "ForgeMaster", Type = "PlayerInteractionType", EnumValue = 66 }, + { Name = "CharacterBanker", Type = "PlayerInteractionType", EnumValue = 67 }, + { Name = "AccountBanker", Type = "PlayerInteractionType", EnumValue = 68 }, + { Name = "ProfessionRespec", Type = "PlayerInteractionType", EnumValue = 69 }, + { Name = "CornerstoneInteraction", Type = "PlayerInteractionType", EnumValue = 70 }, + { Name = "RenameNeighborhood", Type = "PlayerInteractionType", EnumValue = 71 }, + { Name = "HousingBulletinBoard", Type = "PlayerInteractionType", EnumValue = 72 }, + { Name = "HousingPedestal", Type = "PlayerInteractionType", EnumValue = 73 }, + { Name = "CreateGuildNeighborhood", Type = "PlayerInteractionType", EnumValue = 74 }, + { Name = "NeighborhoodCharter", Type = "PlayerInteractionType", EnumValue = 75 }, + { Name = "GuildRename", Type = "PlayerInteractionType", EnumValue = 76 }, + { Name = "OpenNeighborhoodCharterConfirmation", Type = "PlayerInteractionType", EnumValue = 77 }, + { Name = "OpenHouseFinder", Type = "PlayerInteractionType", EnumValue = 78 }, + { Name = "TieredEntrance", Type = "PlayerInteractionType", EnumValue = 79 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerInteractionManagerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bab7846 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerInteractionManagerDocumentation.lua.annotated.lua @@ -0,0 +1,123 @@ +local PlayerInteractionManager = +{ + Name = "PlayerInteractionManager", + Type = "System", + Namespace = "C_PlayerInteractionManager", + Environment = "All", + + Functions = + { + { + Name = "ClearInteraction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PlayerInteractionType", Nilable = true }, + }, + }, + { + Name = "ConfirmationInteraction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PlayerInteractionType", Nilable = true }, + }, + }, + { + Name = "InteractUnit", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "string", Nilable = false }, + { Name = "exactMatch", Type = "bool", Nilable = false, Default = false }, + { Name = "looseTargeting", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInteractingWithNpcOfType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PlayerInteractionType", Nilable = false }, + }, + + Returns = + { + { Name = "interacting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsReplacingUnit", + Type = "Function", + + Returns = + { + { Name = "replacing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidNPCInteraction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "PlayerInteractionType", Nilable = false }, + }, + + Returns = + { + { Name = "isValidInteraction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReopenInteraction", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + { + Name = "PlayerInteractionManagerFrameHide", + Type = "Event", + LiteralName = "PLAYER_INTERACTION_MANAGER_FRAME_HIDE", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "PlayerInteractionType", Nilable = false }, + }, + }, + { + Name = "PlayerInteractionManagerFrameShow", + Type = "Event", + LiteralName = "PLAYER_INTERACTION_MANAGER_FRAME_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "PlayerInteractionType", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerInteractionManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cd39a67 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerLocationDocumentation.lua.annotated.lua @@ -0,0 +1,128 @@ +local PlayerLocation = +{ + Name = "PlayerLocationInfo", + Type = "System", + Namespace = "C_PlayerInfo", + Environment = "All", + + Functions = + { + { + Name = "GUIDIsPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetClass", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "className", Type = "cstring", Nilable = true }, + { Name = "classFilename", Type = "cstring", Nilable = true }, + { Name = "classID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetRace", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "raceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "sex", Type = "UnitSex", Nilable = true }, + }, + }, + { + Name = "IsConnected", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = true }, + }, + + Returns = + { + { Name = "isConnected", Type = "bool", Nilable = true }, + }, + }, + { + Name = "UnitIsSameServer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "unitIsSameServer", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerLocation); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bc91308 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,34 @@ +local PlayerMentorshipConstants = +{ + Tables = + { + { + Name = "PlayerMentorshipApplicationResult", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Success", Type = "PlayerMentorshipApplicationResult", EnumValue = 0 }, + { Name = "AlreadyMentor", Type = "PlayerMentorshipApplicationResult", EnumValue = 1 }, + { Name = "Ineligible", Type = "PlayerMentorshipApplicationResult", EnumValue = 2 }, + }, + }, + { + Name = "PlayerMentorshipStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "PlayerMentorshipStatus", EnumValue = 0 }, + { Name = "Newcomer", Type = "PlayerMentorshipStatus", EnumValue = 1 }, + { Name = "Mentor", Type = "PlayerMentorshipStatus", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerMentorshipConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a0b18c5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerMentorshipDocumentation.lua.annotated.lua @@ -0,0 +1,86 @@ +local PlayerMentorship = +{ + Name = "PlayerMentorship", + Type = "System", + Namespace = "C_PlayerMentorship", + Environment = "All", + + Functions = + { + { + Name = "GetMentorLevelRequirement", + Type = "Function", + + Returns = + { + { Name = "level", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMentorRequirements", + Type = "Function", + + Returns = + { + { Name = "achievementIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "optionalAchievementIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "optionalCompleteAtLeastCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMentorshipStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "PlayerMentorshipStatus", Nilable = false }, + }, + }, + { + Name = "IsActivePlayerConsideredNewcomer", + Type = "Function", + + Returns = + { + { Name = "isConsideredNewcomer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMentorRestricted", + Type = "Function", + + Returns = + { + { Name = "isRestricted", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "MentorshipStatusChanged", + Type = "Event", + LiteralName = "MENTORSHIP_STATUS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "NewcomerGraduation", + Type = "Event", + LiteralName = "NEWCOMER_GRADUATION", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerMentorship); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4c74d0d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PlayerScriptDocumentation.lua.annotated.lua @@ -0,0 +1,1631 @@ +local PlayerScript = +{ + Name = "PlayerScript", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "AcceptAreaSpiritHeal", + Type = "Function", + }, + { + Name = "AcceptGuild", + Type = "Function", + }, + { + Name = "AcceptResurrect", + Type = "Function", + }, + { + Name = "Ambiguate", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fullName", Type = "cstring", Nilable = false }, + { Name = "context", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "AutoEquipCursorItem", + Type = "Function", + }, + { + Name = "BeginTrade", + Type = "Function", + }, + { + Name = "CanDualWield", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanInspect", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetGUID", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanLootUnit", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetUnit", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "hasLoot", Type = "bool", Nilable = false }, + { Name = "canLoot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelAreaSpiritHeal", + Type = "Function", + }, + { + Name = "CancelPendingEquip", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "CancelTrade", + Type = "Function", + }, + { + Name = "CheckInteractDistance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitGUID", Type = "UnitToken", Nilable = false }, + { Name = "distIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CheckTalentMasterDist", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearPendingBindConversionItem", + Type = "Function", + }, + { + Name = "ConfirmTalentWipe", + Type = "Function", + }, + { + Name = "ConvertItemToBindToAccount", + Type = "Function", + }, + { + Name = "DeclineGuild", + Type = "Function", + }, + { + Name = "DeclineResurrect", + Type = "Function", + }, + { + Name = "Dismount", + Type = "Function", + }, + { + Name = "EquipPendingItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "FollowUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false, Default = "0" }, + { Name = "exactMatch", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetAllowLowLevelRaid", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAllowRecentAlliesSeeLocation", + Type = "Function", + + Returns = + { + { Name = "allowRecentAlliesSeeLocation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAreaSpiritHealerTime", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAttackPowerForStat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "stat", Type = "luaIndex", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAutoDeclineGuildInvites", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAutoDeclineNeighborhoodInvites", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAvoidance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBindLocation", + Type = "Function", + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetBlockChance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCemeteryPreference", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCollapsingStarCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCombatRating", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCombatRatingBonus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCombatRatingBonusForCombatRatingValue", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCorpseRecoveryDelay", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCorruption", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCorruptionResistance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCritChance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCritChanceProvidesParryEffect", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDodgeChance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDodgeChanceFromAttribute", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExpertise", + Type = "Function", + + Returns = + { + { Name = "mainhandExpertise", Type = "number", Nilable = false }, + { Name = "offhandExpertise", Type = "number", Nilable = false }, + { Name = "rangedExpertise", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExpertisePercent", + Type = "Function", + + Returns = + { + { Name = "mainhandExpertisePercent", Type = "number", Nilable = false }, + { Name = "offhandExpertisePercent", Type = "number", Nilable = false }, + { Name = "rangedExpertisePercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHaste", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHitModifier", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetJailersTowerLevel", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLifesteal", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLootSpecialization", + Type = "Function", + + Returns = + { + { Name = "specializationID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetManaRegen", + Type = "Function", + + Returns = + { + { Name = "baseManaRegen", Type = "number", Nilable = false }, + { Name = "castingManaRegen", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMastery", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMasteryEffect", + Type = "Function", + + Returns = + { + { Name = "masteryEffect", Type = "number", Nilable = false }, + { Name = "bonusCoefficient", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxCombatRatingBonus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMaxPlayerLevel", + Type = "Function", + + Returns = + { + { Name = "maxPlayerLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMeleeHaste", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetModResilienceDamageReduction", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMoney", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNormalizedRealmName", + Type = "Function", + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetOverrideAPBySpellPower", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOverrideSpellPowerByAP", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPDesired", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPVPGearStatRules", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPVPLifetimeStats", + Type = "Function", + + Returns = + { + { Name = "lifetimeHonorableKills", Type = "number", Nilable = false }, + { Name = "lifetimeMaxPVPRank", Type = "PvPRanks", Nilable = false }, + }, + }, + { + Name = "GetPVPSessionStats", + Type = "Function", + + Returns = + { + { Name = "honorableKills", Type = "number", Nilable = false }, + { Name = "dishonorableKills", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPTimer", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPYesterdayStats", + Type = "Function", + + Returns = + { + { Name = "honorableKills", Type = "number", Nilable = false }, + { Name = "dishonorableKills", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetParryChance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetParryChanceFromAttribute", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetMeleeHaste", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetSpellBonusDamage", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerFacing", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPlayerInfoByGUID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "localizedClass", Type = "cstring", Nilable = false }, + { Name = "englishClass", Type = "cstring", Nilable = false }, + { Name = "localizedRace", Type = "cstring", Nilable = false }, + { Name = "englishRace", Type = "cstring", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "realmName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetPowerRegen", + Type = "Function", + + Returns = + { + { Name = "basePowerRegen", Type = "number", Nilable = false }, + { Name = "castingPowerRegen", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerRegenForPowerType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerType", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "basePowerRegen", Type = "number", Nilable = false }, + { Name = "castingPowerRegen", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPvpPowerDamage", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPvpPowerHealing", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRangedCritChance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRangedHaste", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetReleaseTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetResSicknessDuration", + Type = "Function", + + Returns = + { + { Name = "result", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetRestState", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "exhaustionID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "factor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRestrictedAccountData", + Type = "Function", + + Returns = + { + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "maxMoney", Type = "WOWMONEY", Nilable = false }, + { Name = "professionCap", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneCooldown", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "isRuneReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRuneCount", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runeIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSheathState", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetShieldBlock", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpeed", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBonusDamage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "school", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSpellBonusHealing", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellCritChance", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellHitModifier", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellPenetration", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSturdiness", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTaxiBenchmarkMode", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetVersatilityBonus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "combatRating", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetXPExhaustion", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "HasAPEffectsSpellPower", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasDualWieldPenalty", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFullControl", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasIgnoreDualWieldWeapon", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasKey", + Type = "Function", + + Returns = + { + { Name = "hasKey", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasNoReleaseAura", + Type = "Function", + + Returns = + { + { Name = "hasCannotReleaseEffect", Type = "bool", Nilable = false }, + { Name = "longestDuration", Type = "number", Nilable = false }, + { Name = "hasUntilCancelledDuration", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSPEffectsAttackPower", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InitiateTrade", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "IsAccountSecured", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAdvancedFlyableArea", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCemeterySelectionAvailable", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCharacterNewlyBoosted", + Type = "Function", + + Returns = + { + { Name = "newlyBoosted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDrivableArea", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDualWielding", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFlyableArea", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGuildLeader", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInGuild", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInJailersTower", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIndoors", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInsane", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemPreferredArmorType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isItemPreferredArmorType", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsJailersTowerLayerTimeLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layerLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsLoggedIn", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMounted", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnGroundFloorInJailersTower", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOutOfBounds", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOutdoors", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPVPTimerRunning", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInWorld", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerMoving", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRangedWeapon", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsResting", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRestrictedAccount", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStealthed", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsXPUserDisabled", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NoPlayTime", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "NotifyInspect", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetGUID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "PartialPlayTime", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "PlayerCanTeleport", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerEffectiveAttackPower", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "mainHandAttackPower", Type = "number", Nilable = false }, + { Name = "offHandAttackPower", Type = "number", Nilable = false }, + { Name = "rangedAttackPower", Type = "number", Nilable = false }, + { Name = "baseAttackPower", Type = "number", Nilable = false }, + { Name = "baseRangedAttackPower", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerGetTimerunningSeasonID", + Type = "Function", + + Returns = + { + { Name = "timerunningSeasonID", Type = "number", Nilable = true }, + }, + }, + { + Name = "PlayerIsInCombat", + Type = "Function", + + Returns = + { + { Name = "playerIsInCombat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerIsTimerunning", + Type = "Function", + + Returns = + { + { Name = "playerIsTimerunning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PortGraveyard", + Type = "Function", + }, + { + Name = "RandomRoll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "min", Type = "number", Nilable = false }, + { Name = "max", Type = "number", Nilable = false }, + }, + }, + { + Name = "RepopMe", + Type = "Function", + }, + { + Name = "RequestTimePlayed", + Type = "Function", + }, + { + Name = "RespondInstanceLock", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "acceptLock", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResurrectGetOfferer", + Type = "Function", + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ResurrectHasSickness", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResurrectHasTimer", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RetrieveCorpse", + Type = "Function", + }, + { + Name = "SetAllowLowLevelRaid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allow", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetAllowRecentAlliesSeeLocation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allowRecentAlliesSeeLocation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAutoDeclineGuildInvites", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allow", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetAutoDeclineNeighborhoodInvites", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allow", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetCemeteryPreference", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cemetaryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLootSpecialization", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specializationID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTaxiBenchmarkMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "ShouldShowIslandsWeeklyPOI", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowSpecialSplashScreen", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowCloak", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowHelm", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowingCloak", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowingHelm", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SitStandOrDescendStart", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "SplashFrameCanBeShown", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartAttack", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false, Default = "0" }, + { Name = "exactMatch", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "StopAttack", + Type = "Function", + }, + { + Name = "Stuck", + Type = "Function", + }, + { + Name = "TimeoutResurrect", + Type = "Function", + }, + { + Name = "ToggleSelfHighlight", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ToggleSheath", + Type = "Function", + }, + }, + + Events = + { + { + Name = "PlayerInCombatChanged", + Type = "Event", + LiteralName = "PLAYER_IN_COMBAT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "inCombat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerTargetDied", + Type = "Event", + LiteralName = "PLAYER_TARGET_DIED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "PlayerAttackPowerInfo", + Type = "Structure", + Fields = + { + { Name = "mainHandAttackPower", Type = "number", Nilable = false }, + { Name = "offHandAttackPower", Type = "number", Nilable = false }, + { Name = "rangedAttackPower", Type = "number", Nilable = false }, + { Name = "baseAttackPower", Type = "number", Nilable = false }, + { Name = "baseRangedAttackPower", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerScript); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PonyDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PonyDocumentation.lua.annotated.lua new file mode 100644 index 0000000..22d0b11 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PonyDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local Pony = +{ + Name = "Pony", + Type = "System", + Namespace = "C_Pony", + Environment = "All", + Documentation = { "A pony is not simply a small horse., Time to pony up some documentation., See? Pony." }, + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Pony); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PowerTypeConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PowerTypeConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e77a4f3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PowerTypeConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,93 @@ +local PowerTypeConstants = +{ + Tables = + { + { + Name = "BalanceType", + Type = "Enumeration", + NumValues = 2, + MinValue = -1, + MaxValue = 0, + Fields = + { + { Name = "None", Type = "BalanceType", EnumValue = -1 }, + { Name = "Eclipse", Type = "BalanceType", EnumValue = 0 }, + }, + }, + { + Name = "PowerType", + Type = "Enumeration", + NumValues = 30, + MinValue = 0, + MaxValue = 29, + Fields = + { + { Name = "Mana", Type = "PowerType", EnumValue = 0 }, + { Name = "Rage", Type = "PowerType", EnumValue = 1 }, + { Name = "Focus", Type = "PowerType", EnumValue = 2 }, + { Name = "Energy", Type = "PowerType", EnumValue = 3 }, + { Name = "ComboPoints", Type = "PowerType", EnumValue = 4 }, + { Name = "Runes", Type = "PowerType", EnumValue = 5 }, + { Name = "RunicPower", Type = "PowerType", EnumValue = 6 }, + { Name = "SoulShards", Type = "PowerType", EnumValue = 7 }, + { Name = "LunarPower", Type = "PowerType", EnumValue = 8 }, + { Name = "HolyPower", Type = "PowerType", EnumValue = 9 }, + { Name = "Alternate", Type = "PowerType", EnumValue = 10 }, + { Name = "Maelstrom", Type = "PowerType", EnumValue = 11 }, + { Name = "Chi", Type = "PowerType", EnumValue = 12 }, + { Name = "Insanity", Type = "PowerType", EnumValue = 13 }, + { Name = "BurningEmbers", Type = "PowerType", EnumValue = 14 }, + { Name = "DemonicFury", Type = "PowerType", EnumValue = 15 }, + { Name = "ArcaneCharges", Type = "PowerType", EnumValue = 16 }, + { Name = "Fury", Type = "PowerType", EnumValue = 17 }, + { Name = "Pain", Type = "PowerType", EnumValue = 18 }, + { Name = "Essence", Type = "PowerType", EnumValue = 19 }, + { Name = "RuneBlood", Type = "PowerType", EnumValue = 20 }, + { Name = "RuneFrost", Type = "PowerType", EnumValue = 21 }, + { Name = "RuneUnholy", Type = "PowerType", EnumValue = 22 }, + { Name = "AlternateQuest", Type = "PowerType", EnumValue = 23 }, + { Name = "AlternateEncounter", Type = "PowerType", EnumValue = 24 }, + { Name = "AlternateMount", Type = "PowerType", EnumValue = 25 }, + { Name = "Balance", Type = "PowerType", EnumValue = 26 }, + { Name = "Happiness", Type = "PowerType", EnumValue = 27 }, + { Name = "ShadowOrbs", Type = "PowerType", EnumValue = 28 }, + { Name = "RuneChromatic", Type = "PowerType", EnumValue = 29 }, + }, + }, + { + Name = "PowerTypeSign", + Type = "Enumeration", + NumValues = 3, + MinValue = -1, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "PowerTypeSign", EnumValue = -1 }, + { Name = "Positive", Type = "PowerTypeSign", EnumValue = 0 }, + { Name = "Negative", Type = "PowerTypeSign", EnumValue = 1 }, + }, + }, + { + Name = "PowerTypeSlot", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "Slot_0", Type = "PowerTypeSlot", EnumValue = 0 }, + { Name = "Slot_1", Type = "PowerTypeSlot", EnumValue = 1 }, + { Name = "Slot_2", Type = "PowerTypeSlot", EnumValue = 2 }, + { Name = "Slot_3", Type = "PowerTypeSlot", EnumValue = 3 }, + { Name = "Slot_4", Type = "PowerTypeSlot", EnumValue = 4 }, + { Name = "Slot_5", Type = "PowerTypeSlot", EnumValue = 5 }, + { Name = "Slot_6", Type = "PowerTypeSlot", EnumValue = 6 }, + { Name = "Slot_7", Type = "PowerTypeSlot", EnumValue = 7 }, + { Name = "Slot_8", Type = "PowerTypeSlot", EnumValue = 8 }, + { Name = "Slot_9", Type = "PowerTypeSlot", EnumValue = 9 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PowerTypeConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProceduralSpawnConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProceduralSpawnConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..974539d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProceduralSpawnConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,33 @@ +local ProceduralSpawnConstants = +{ + Tables = + { + { + Name = "ProceduralSpawnInteractionMode", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "ProceduralSpawnInteractionMode", EnumValue = 0 }, + { Name = "Paint", Type = "ProceduralSpawnInteractionMode", EnumValue = 1 }, + { Name = "Manipulate", Type = "ProceduralSpawnInteractionMode", EnumValue = 2 }, + }, + }, + { + Name = "ProceduralSpawnVolumeChunkFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "ProceduralSpawnVolumeChunkFlags", EnumValue = 0 }, + { Name = "AllSubChunksSet", Type = "ProceduralSpawnVolumeChunkFlags", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ProceduralSpawnConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f0042b0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,391 @@ +local ProfessionConstants = +{ + Tables = + { + { + Name = "CraftingOrderDuration", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Short", Type = "CraftingOrderDuration", EnumValue = 0 }, + { Name = "Medium", Type = "CraftingOrderDuration", EnumValue = 1 }, + { Name = "Long", Type = "CraftingOrderDuration", EnumValue = 2 }, + }, + }, + { + Name = "CraftingOrderFlags", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 16, + Fields = + { + { Name = "None", Type = "CraftingOrderFlags", EnumValue = 0 }, + { Name = "IsRecraft", Type = "CraftingOrderFlags", EnumValue = 1 }, + { Name = "HasNoneReagents", Type = "CraftingOrderFlags", EnumValue = 2 }, + { Name = "HasSomeReagents", Type = "CraftingOrderFlags", EnumValue = 4 }, + { Name = "HasAllReagents", Type = "CraftingOrderFlags", EnumValue = 8 }, + { Name = "IsFulfillable", Type = "CraftingOrderFlags", EnumValue = 16 }, + }, + }, + { + Name = "CraftingOrderItemFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "CraftingOrderItemFlags", EnumValue = 0 }, + { Name = "NpcProvided", Type = "CraftingOrderItemFlags", EnumValue = 1 }, + { Name = "HasEnchantmentData", Type = "CraftingOrderItemFlags", EnumValue = 2 }, + }, + }, + { + Name = "CraftingOrderItemType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Item", Type = "CraftingOrderItemType", EnumValue = 0 }, + { Name = "Recraft", Type = "CraftingOrderItemType", EnumValue = 1 }, + { Name = "CraftedResult", Type = "CraftingOrderItemType", EnumValue = 2 }, + { Name = "RemoveReagent", Type = "CraftingOrderItemType", EnumValue = 3 }, + { Name = "Deprecated", Type = "CraftingOrderItemType", EnumValue = 4 }, + { Name = "Currency", Type = "CraftingOrderItemType", EnumValue = 5 }, + }, + }, + { + Name = "CraftingOrderReagentSource", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Any", Type = "CraftingOrderReagentSource", EnumValue = 0 }, + { Name = "Customer", Type = "CraftingOrderReagentSource", EnumValue = 1 }, + { Name = "Crafter", Type = "CraftingOrderReagentSource", EnumValue = 2 }, + { Name = "None", Type = "CraftingOrderReagentSource", EnumValue = 3 }, + }, + }, + { + Name = "CraftingOrderResult", + Type = "Enumeration", + NumValues = 49, + MinValue = 0, + MaxValue = 48, + Fields = + { + { Name = "Ok", Type = "CraftingOrderResult", EnumValue = 0 }, + { Name = "Aborted", Type = "CraftingOrderResult", EnumValue = 1 }, + { Name = "AlreadyClaimed", Type = "CraftingOrderResult", EnumValue = 2 }, + { Name = "AlreadyCrafted", Type = "CraftingOrderResult", EnumValue = 3 }, + { Name = "CannotBeOrdered", Type = "CraftingOrderResult", EnumValue = 4 }, + { Name = "CannotCancel", Type = "CraftingOrderResult", EnumValue = 5 }, + { Name = "CannotClaim", Type = "CraftingOrderResult", EnumValue = 6 }, + { Name = "CannotClaimOwnOrder", Type = "CraftingOrderResult", EnumValue = 7 }, + { Name = "CannotCraft", Type = "CraftingOrderResult", EnumValue = 8 }, + { Name = "CannotCreate", Type = "CraftingOrderResult", EnumValue = 9 }, + { Name = "CannotFulfill", Type = "CraftingOrderResult", EnumValue = 10 }, + { Name = "CannotRecraft", Type = "CraftingOrderResult", EnumValue = 11 }, + { Name = "CannotReject", Type = "CraftingOrderResult", EnumValue = 12 }, + { Name = "CannotRelease", Type = "CraftingOrderResult", EnumValue = 13 }, + { Name = "CrafterIsIgnored", Type = "CraftingOrderResult", EnumValue = 14 }, + { Name = "DatabaseError", Type = "CraftingOrderResult", EnumValue = 15 }, + { Name = "Expired", Type = "CraftingOrderResult", EnumValue = 16 }, + { Name = "Locked", Type = "CraftingOrderResult", EnumValue = 17 }, + { Name = "InvalidDuration", Type = "CraftingOrderResult", EnumValue = 18 }, + { Name = "InvalidMinQuality", Type = "CraftingOrderResult", EnumValue = 19 }, + { Name = "InvalidNotes", Type = "CraftingOrderResult", EnumValue = 20 }, + { Name = "InvalidReagent", Type = "CraftingOrderResult", EnumValue = 21 }, + { Name = "InvalidRealm", Type = "CraftingOrderResult", EnumValue = 22 }, + { Name = "InvalidRecipe", Type = "CraftingOrderResult", EnumValue = 23 }, + { Name = "InvalidRecraftItem", Type = "CraftingOrderResult", EnumValue = 24 }, + { Name = "InvalidSort", Type = "CraftingOrderResult", EnumValue = 25 }, + { Name = "InvalidTarget", Type = "CraftingOrderResult", EnumValue = 26 }, + { Name = "InvalidType", Type = "CraftingOrderResult", EnumValue = 27 }, + { Name = "MaxOrdersReached", Type = "CraftingOrderResult", EnumValue = 28 }, + { Name = "MissingCraftingTable", Type = "CraftingOrderResult", EnumValue = 29 }, + { Name = "MissingCurrency", Type = "CraftingOrderResult", EnumValue = 30 }, + { Name = "MissingItem", Type = "CraftingOrderResult", EnumValue = 31 }, + { Name = "MissingNpc", Type = "CraftingOrderResult", EnumValue = 32 }, + { Name = "MissingOrder", Type = "CraftingOrderResult", EnumValue = 33 }, + { Name = "MissingRecraftItem", Type = "CraftingOrderResult", EnumValue = 34 }, + { Name = "NoAccountItems", Type = "CraftingOrderResult", EnumValue = 35 }, + { Name = "NotClaimed", Type = "CraftingOrderResult", EnumValue = 36 }, + { Name = "NotCrafted", Type = "CraftingOrderResult", EnumValue = 37 }, + { Name = "NotInGuild", Type = "CraftingOrderResult", EnumValue = 38 }, + { Name = "NotYetImplemented", Type = "CraftingOrderResult", EnumValue = 39 }, + { Name = "OutOfPublicOrderCapacity", Type = "CraftingOrderResult", EnumValue = 40 }, + { Name = "ServerIsNotAvailable", Type = "CraftingOrderResult", EnumValue = 41 }, + { Name = "ThrottleViolation", Type = "CraftingOrderResult", EnumValue = 42 }, + { Name = "TargetCannotCraft", Type = "CraftingOrderResult", EnumValue = 43 }, + { Name = "TargetLocked", Type = "CraftingOrderResult", EnumValue = 44 }, + { Name = "Timeout", Type = "CraftingOrderResult", EnumValue = 45 }, + { Name = "TooManyCurrencies", Type = "CraftingOrderResult", EnumValue = 46 }, + { Name = "TooManyItems", Type = "CraftingOrderResult", EnumValue = 47 }, + { Name = "WrongVersion", Type = "CraftingOrderResult", EnumValue = 48 }, + }, + }, + { + Name = "CraftingOrderSortType", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "ItemName", Type = "CraftingOrderSortType", EnumValue = 0 }, + { Name = "AveTip", Type = "CraftingOrderSortType", EnumValue = 1 }, + { Name = "MaxTip", Type = "CraftingOrderSortType", EnumValue = 2 }, + { Name = "Quantity", Type = "CraftingOrderSortType", EnumValue = 3 }, + { Name = "Reagents", Type = "CraftingOrderSortType", EnumValue = 4 }, + { Name = "Tip", Type = "CraftingOrderSortType", EnumValue = 5 }, + { Name = "TimeRemaining", Type = "CraftingOrderSortType", EnumValue = 6 }, + { Name = "Status", Type = "CraftingOrderSortType", EnumValue = 7 }, + }, + }, + { + Name = "CraftingOrderState", + Type = "Enumeration", + NumValues = 16, + MinValue = 0, + MaxValue = 15, + Fields = + { + { Name = "None", Type = "CraftingOrderState", EnumValue = 0 }, + { Name = "Creating", Type = "CraftingOrderState", EnumValue = 1 }, + { Name = "Created", Type = "CraftingOrderState", EnumValue = 2 }, + { Name = "Claiming", Type = "CraftingOrderState", EnumValue = 3 }, + { Name = "Claimed", Type = "CraftingOrderState", EnumValue = 4 }, + { Name = "Rejecting", Type = "CraftingOrderState", EnumValue = 5 }, + { Name = "Rejected", Type = "CraftingOrderState", EnumValue = 6 }, + { Name = "Releasing", Type = "CraftingOrderState", EnumValue = 7 }, + { Name = "Crafting", Type = "CraftingOrderState", EnumValue = 8 }, + { Name = "Recrafting", Type = "CraftingOrderState", EnumValue = 9 }, + { Name = "Fulfilling", Type = "CraftingOrderState", EnumValue = 10 }, + { Name = "Fulfilled", Type = "CraftingOrderState", EnumValue = 11 }, + { Name = "Canceling", Type = "CraftingOrderState", EnumValue = 12 }, + { Name = "Canceled", Type = "CraftingOrderState", EnumValue = 13 }, + { Name = "Expiring", Type = "CraftingOrderState", EnumValue = 14 }, + { Name = "Expired", Type = "CraftingOrderState", EnumValue = 15 }, + }, + }, + { + Name = "CraftingOrderType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Public", Type = "CraftingOrderType", EnumValue = 0 }, + { Name = "Guild", Type = "CraftingOrderType", EnumValue = 1 }, + { Name = "Personal", Type = "CraftingOrderType", EnumValue = 2 }, + { Name = "Npc", Type = "CraftingOrderType", EnumValue = 3 }, + }, + }, + { + Name = "CraftingReagentType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Modifying", Type = "CraftingReagentType", EnumValue = 0 }, + { Name = "Basic", Type = "CraftingReagentType", EnumValue = 1 }, + { Name = "Finishing", Type = "CraftingReagentType", EnumValue = 2 }, + { Name = "Automatic", Type = "CraftingReagentType", EnumValue = 3 }, + }, + }, + { + Name = "ItemRecraftFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "Invalid", Type = "ItemRecraftFlags", EnumValue = 1 }, + }, + }, + { + Name = "NpcCraftingOrderSetFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "AllowMultiple", Type = "NpcCraftingOrderSetFlags", EnumValue = 1 }, + { Name = "AllowDuplicate", Type = "NpcCraftingOrderSetFlags", EnumValue = 2 }, + }, + }, + { + Name = "Profession", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "FirstAid", Type = "Profession", EnumValue = 0 }, + { Name = "Blacksmithing", Type = "Profession", EnumValue = 1 }, + { Name = "Leatherworking", Type = "Profession", EnumValue = 2 }, + { Name = "Alchemy", Type = "Profession", EnumValue = 3 }, + { Name = "Herbalism", Type = "Profession", EnumValue = 4 }, + { Name = "Cooking", Type = "Profession", EnumValue = 5 }, + { Name = "Mining", Type = "Profession", EnumValue = 6 }, + { Name = "Tailoring", Type = "Profession", EnumValue = 7 }, + { Name = "Engineering", Type = "Profession", EnumValue = 8 }, + { Name = "Enchanting", Type = "Profession", EnumValue = 9 }, + { Name = "Fishing", Type = "Profession", EnumValue = 10 }, + { Name = "Skinning", Type = "Profession", EnumValue = 11 }, + { Name = "Jewelcrafting", Type = "Profession", EnumValue = 12 }, + { Name = "Inscription", Type = "Profession", EnumValue = 13 }, + { Name = "Archaeology", Type = "Profession", EnumValue = 14 }, + }, + }, + { + Name = "ProfessionActionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Craft", Type = "ProfessionActionType", EnumValue = 0 }, + { Name = "Gather", Type = "ProfessionActionType", EnumValue = 1 }, + }, + }, + { + Name = "ProfessionEffect", + Type = "Enumeration", + NumValues = 31, + MinValue = 0, + MaxValue = 30, + Fields = + { + { Name = "Skill", Type = "ProfessionEffect", EnumValue = 0 }, + { Name = "StatInspiration", Type = "ProfessionEffect", EnumValue = 1 }, + { Name = "StatResourcefulness", Type = "ProfessionEffect", EnumValue = 2 }, + { Name = "StatFinesse", Type = "ProfessionEffect", EnumValue = 3 }, + { Name = "StatDeftness", Type = "ProfessionEffect", EnumValue = 4 }, + { Name = "StatPerception", Type = "ProfessionEffect", EnumValue = 5 }, + { Name = "StatCraftingSpeed", Type = "ProfessionEffect", EnumValue = 6 }, + { Name = "StatMulticraft", Type = "ProfessionEffect", EnumValue = 7 }, + { Name = "UnlockReagentSlot", Type = "ProfessionEffect", EnumValue = 8 }, + { Name = "ModInspiration", Type = "ProfessionEffect", EnumValue = 9 }, + { Name = "ModResourcefulness", Type = "ProfessionEffect", EnumValue = 10 }, + { Name = "ModFinesse", Type = "ProfessionEffect", EnumValue = 11 }, + { Name = "ModDeftness", Type = "ProfessionEffect", EnumValue = 12 }, + { Name = "ModPerception", Type = "ProfessionEffect", EnumValue = 13 }, + { Name = "ModCraftingSpeed", Type = "ProfessionEffect", EnumValue = 14 }, + { Name = "ModMulticraft", Type = "ProfessionEffect", EnumValue = 15 }, + { Name = "ModUnused_1", Type = "ProfessionEffect", EnumValue = 16 }, + { Name = "ModUnused_2", Type = "ProfessionEffect", EnumValue = 17 }, + { Name = "ModCraftExtraQuantity", Type = "ProfessionEffect", EnumValue = 18 }, + { Name = "ModGatherExtraQuantity", Type = "ProfessionEffect", EnumValue = 19 }, + { Name = "ModCraftCritSize", Type = "ProfessionEffect", EnumValue = 20 }, + { Name = "ModCraftReductionQuantity", Type = "ProfessionEffect", EnumValue = 21 }, + { Name = "DecreaseDifficulty", Type = "ProfessionEffect", EnumValue = 22 }, + { Name = "IncreaseDifficulty", Type = "ProfessionEffect", EnumValue = 23 }, + { Name = "ModSkillGain", Type = "ProfessionEffect", EnumValue = 24 }, + { Name = "AccumulateRanksByLabel", Type = "ProfessionEffect", EnumValue = 25 }, + { Name = "StatIngenuity", Type = "ProfessionEffect", EnumValue = 26 }, + { Name = "ModConcentration", Type = "ProfessionEffect", EnumValue = 27 }, + { Name = "Tokenizer", Type = "ProfessionEffect", EnumValue = 28 }, + { Name = "ModIngenuity", Type = "ProfessionEffect", EnumValue = 29 }, + { Name = "ConcentrationRefund", Type = "ProfessionEffect", EnumValue = 30 }, + }, + }, + { + Name = "ProfessionRating", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Inspiration", Type = "ProfessionRating", EnumValue = 0 }, + { Name = "Resourcefulness", Type = "ProfessionRating", EnumValue = 1 }, + { Name = "Finesse", Type = "ProfessionRating", EnumValue = 2 }, + { Name = "Deftness", Type = "ProfessionRating", EnumValue = 3 }, + { Name = "Perception", Type = "ProfessionRating", EnumValue = 4 }, + { Name = "CraftingSpeed", Type = "ProfessionRating", EnumValue = 5 }, + { Name = "Multicraft", Type = "ProfessionRating", EnumValue = 6 }, + { Name = "Ingenuity", Type = "ProfessionRating", EnumValue = 7 }, + { Name = "Unused_2", Type = "ProfessionRating", EnumValue = 8 }, + }, + }, + { + Name = "ProfessionRatingType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Craft", Type = "ProfessionRatingType", EnumValue = 0 }, + { Name = "Gather", Type = "ProfessionRatingType", EnumValue = 1 }, + }, + }, + { + Name = "RcoCloseReason", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Fulfill", Type = "RcoCloseReason", EnumValue = 0 }, + { Name = "Expire", Type = "RcoCloseReason", EnumValue = 1 }, + { Name = "Cancel", Type = "RcoCloseReason", EnumValue = 2 }, + { Name = "Reject", Type = "RcoCloseReason", EnumValue = 3 }, + { Name = "GmCancel", Type = "RcoCloseReason", EnumValue = 4 }, + { Name = "CrafterFulfill", Type = "RcoCloseReason", EnumValue = 5 }, + { Name = "Invalid", Type = "RcoCloseReason", EnumValue = 6 }, + }, + }, + { + Name = "SkinningState", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "SkinningState", EnumValue = 0 }, + { Name = "Reserved", Type = "SkinningState", EnumValue = 1 }, + { Name = "Skinning", Type = "SkinningState", EnumValue = 2 }, + { Name = "Looting", Type = "SkinningState", EnumValue = 3 }, + { Name = "Skinned", Type = "SkinningState", EnumValue = 4 }, + }, + }, + { + Name = "ProfessionConsts", + Type = "Constants", + Values = + { + { Name = "NUM_PRIMARY_PROFESSIONS", Type = "number", Value = 2 }, + { Name = "CLASSIC_PROFESSION_PARENT_TIER_INDEX", Type = "number", Value = 4 }, + { Name = "RUNEFORGING_SKILL_LINE_ID", Type = "number", Value = 960 }, + { Name = "RUNEFORGING_ROOT_CATEGORY_ID", Type = "number", Value = 210 }, + { Name = "MAX_CRAFTING_REAGENT_SLOTS", Type = "number", Value = 12 }, + { Name = "CRAFTING_ORDER_CLAIM_DURATION", Type = "number", Value = 0 }, + { Name = "PUBLIC_CRAFTING_ORDER_STALE_THRESHOLD", Type = "number", Value = 0 }, + { Name = "CRAFTING_ORDER_ITEM_RETENTION", Type = "number", Value = 30 }, + { Name = "CRAFTING_ORDER_CURRENCY_WALLET_ITEM_ID", Type = "number", Value = 262724 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ProfessionConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..449e81b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,106 @@ +local ProfessionSpecConstants = +{ + Tables = + { + { + Name = "ProfTraitPerkNodeFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "UnlocksSubpath", Type = "ProfTraitPerkNodeFlags", EnumValue = 1 }, + { Name = "IsMajorBonus", Type = "ProfTraitPerkNodeFlags", EnumValue = 2 }, + }, + }, + { + Name = "ProfessionsSpecPathState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Locked", Type = "ProfessionsSpecPathState", EnumValue = 0 }, + { Name = "Progressing", Type = "ProfessionsSpecPathState", EnumValue = 1 }, + { Name = "Completed", Type = "ProfessionsSpecPathState", EnumValue = 2 }, + }, + }, + { + Name = "ProfessionsSpecPerkState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Unearned", Type = "ProfessionsSpecPerkState", EnumValue = 0 }, + { Name = "Pending", Type = "ProfessionsSpecPerkState", EnumValue = 1 }, + { Name = "Earned", Type = "ProfessionsSpecPerkState", EnumValue = 2 }, + }, + }, + { + Name = "ProfessionsSpecTabState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Locked", Type = "ProfessionsSpecTabState", EnumValue = 0 }, + { Name = "Unlocked", Type = "ProfessionsSpecTabState", EnumValue = 1 }, + { Name = "Unlockable", Type = "ProfessionsSpecTabState", EnumValue = 2 }, + }, + }, + { + Name = "ProfTabHighlight", + Type = "Structure", + Fields = + { + { Name = "description", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ProfTabInfo", + Type = "Structure", + Fields = + { + { Name = "rootNodeID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "rootIconID", Type = "number", Nilable = false }, + { Name = "highlights", Type = "table", InnerType = "ProfTabHighlight", Nilable = false }, + }, + }, + { + Name = "SpecPerkInfo", + Type = "Structure", + Fields = + { + { Name = "perkID", Type = "number", Nilable = false }, + { Name = "isMajorPerk", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpecializationCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "numAvailable", Type = "number", Nilable = false }, + { Name = "currencyName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SpecializationTabInfo", + Type = "Structure", + Fields = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = true }, + { Name = "errorReason", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ProfessionSpecConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a61af23 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ProfessionSpecUIDocumentation.lua.annotated.lua @@ -0,0 +1,419 @@ +local ProfessionSpecUI = +{ + Name = "ProfessionSpecUI", + Type = "System", + Namespace = "C_ProfSpecs", + Environment = "All", + + Functions = + { + { + Name = "CanRefundPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canRefund", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanUnlockTab", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tabTreeID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canUnlock", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetChildrenForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "childIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetConfigIDForSkillLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrencyInfoForSkillLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "SpecializationCurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetDefaultSpecSkillLine", + Type = "Function", + + Returns = + { + { Name = "defaultSpecSkillLine", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetDescriptionForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetDescriptionForPerk", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perkID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetEntryIDForPerk", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perkID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "entryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNewSpecReminderProfName", + Type = "Function", + + Returns = + { + { Name = "profName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetPerksForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "perkInfos", Type = "table", InnerType = "SpecPerkInfo", Nilable = false }, + }, + }, + { + Name = "GetRootPathForTab", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tabTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rootPathID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSourceTextForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sourceText", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetSpecTabIDsForSkillLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specTabIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetSpecTabInfo", + Type = "Function", + + Returns = + { + { Name = "specTabInfo", Type = "SpecializationTabInfo", Nilable = false }, + }, + }, + { + Name = "GetSpendCurrencyForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currencyID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSpendEntryForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "entryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStateForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "ProfessionsSpecPathState", Nilable = false }, + }, + }, + { + Name = "GetStateForPerk", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perkID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "ProfessionsSpecPerkState", Nilable = false }, + }, + }, + { + Name = "GetStateForTab", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tabTreeID", Type = "number", Nilable = false }, + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "tabInfo", Type = "ProfessionsSpecTabState", Nilable = false }, + }, + }, + { + Name = "GetTabInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tabTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "tabInfo", Type = "ProfTabInfo", Nilable = true }, + }, + }, + { + Name = "GetUnlockEntryForPath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pathID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "entryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnlockRankForPerk", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "perkID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "unlockRank", Type = "number", Nilable = true }, + }, + }, + { + Name = "ShouldShowPointsReminder", + Type = "Function", + + Returns = + { + { Name = "showReminder", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowPointsReminderForSkillLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "showReminder", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowSpecTab", + Type = "Function", + + Returns = + { + { Name = "showSpecTab", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SkillLineHasSpecialization", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasSpecialization", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SkillLineSpecsRanksChanged", + Type = "Event", + LiteralName = "SKILL_LINE_SPECS_RANKS_CHANGED", + UniqueEvent = true, + }, + { + Name = "SkillLineSpecsUnlocked", + Type = "Event", + LiteralName = "SKILL_LINE_SPECS_UNLOCKED", + UniqueEvent = true, + Payload = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + { Name = "tradeSkillID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ProfessionSpecUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvPFactionConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvPFactionConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0775a5f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvPFactionConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local PvPFactionConstants = +{ + Tables = + { + { + Name = "PvPFaction", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horde", Type = "PvPFaction", EnumValue = 0 }, + { Name = "Alliance", Type = "PvPFaction", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PvPFactionConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..022f361 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local PvpInfoConstants = +{ + Tables = + { + { + Name = "PvPRanks", + Type = "Enumeration", + NumValues = 19, + MinValue = 0, + MaxValue = 18, + Fields = + { + { Name = "RankNone", Type = "PvPRanks", EnumValue = 0 }, + { Name = "RankPariah", Type = "PvPRanks", EnumValue = 1 }, + { Name = "RankOutlaw", Type = "PvPRanks", EnumValue = 2 }, + { Name = "RankExiled", Type = "PvPRanks", EnumValue = 3 }, + { Name = "RankDishonored", Type = "PvPRanks", EnumValue = 4 }, + { Name = "Rank_1", Type = "PvPRanks", EnumValue = 5 }, + { Name = "Rank_2", Type = "PvPRanks", EnumValue = 6 }, + { Name = "Rank_3", Type = "PvPRanks", EnumValue = 7 }, + { Name = "Rank_4", Type = "PvPRanks", EnumValue = 8 }, + { Name = "Rank_5", Type = "PvPRanks", EnumValue = 9 }, + { Name = "Rank_6", Type = "PvPRanks", EnumValue = 10 }, + { Name = "Rank_7", Type = "PvPRanks", EnumValue = 11 }, + { Name = "Rank_8", Type = "PvPRanks", EnumValue = 12 }, + { Name = "Rank_9", Type = "PvPRanks", EnumValue = 13 }, + { Name = "Rank_10", Type = "PvPRanks", EnumValue = 14 }, + { Name = "Rank_11", Type = "PvPRanks", EnumValue = 15 }, + { Name = "Rank_12", Type = "PvPRanks", EnumValue = 16 }, + { Name = "Rank_13", Type = "PvPRanks", EnumValue = 17 }, + { Name = "Rank_14", Type = "PvPRanks", EnumValue = 18 }, + }, + }, + { + Name = "PvpInfoConsts", + Type = "Constants", + Values = + { + { Name = "MaxPlayersPerInstance", Type = "number", Value = 80 }, + { Name = "MAX_PVP_LOCK_LIST_MAP", Type = "number", Value = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PvpInfoConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b771087 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/PvpInfoDocumentation.lua.annotated.lua @@ -0,0 +1,1886 @@ +local PvpInfo = +{ + Name = "PvpInfo", + Type = "System", + Namespace = "C_PvP", + Environment = "All", + + Functions = + { + { + Name = "ArePvpTalentsUnlocked", + Type = "Function", + + Returns = + { + { Name = "arePvpTalentsUnlocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AreTrainingGroundsEnabled", + Type = "Function", + + Returns = + { + { Name = "areTrainingGroundsEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanDisplayDeaths", + Type = "Function", + + Returns = + { + { Name = "canDisplay", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanDisplayHonorableKills", + Type = "Function", + + Returns = + { + { Name = "canDisplay", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseRatedPVPUI", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseTrainingGroundsUI", + Type = "Function", + + Returns = + { + { Name = "canUseTrainingGroundsUI", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanToggleWarMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "toggle", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "canTogglePvP", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanToggleWarModeInArea", + Type = "Function", + + Returns = + { + { Name = "canTogglePvPInArea", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesMatchOutcomeAffectRating", + Type = "Function", + + Returns = + { + { Name = "doesAffect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActiveBrawlInfo", + Type = "Function", + + Returns = + { + { Name = "brawlInfo", Type = "PvpBrawlInfo", Nilable = true }, + }, + }, + { + Name = "GetActiveMatchBracket", + Type = "Function", + + Returns = + { + { Name = "bracket", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActiveMatchDuration", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetActiveMatchState", + Type = "Function", + + Returns = + { + { Name = "state", Type = "PvPMatchState", Nilable = false }, + }, + }, + { + Name = "GetActiveMatchWinner", + Type = "Function", + + Returns = + { + { Name = "winner", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArenaCrowdControlInfo", + Type = "Function", + MayReturnNothing = true, + SecretWhenLossOfControlInfoRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArenaRewards", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "teamSize", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetArenaSkirmishRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetAssignedSpecForBattlefieldQueue", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "queueID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specializationID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetAvailableBrawlInfo", + Type = "Function", + Documentation = { "If nil is returned, PVP_BRAWL_INFO_UPDATED event will be sent when the data is ready." }, + + Returns = + { + { Name = "brawlInfo", Type = "PvpBrawlInfo", Nilable = true }, + }, + }, + { + Name = "GetBattlefieldFlagPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flagIndex", Type = "luaIndex", Nilable = false }, + { Name = "uiMapId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiPosx", Type = "number", Nilable = true }, + { Name = "uiPosy", Type = "number", Nilable = true }, + { Name = "flagTexture", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldVehicleInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vehicleIndex", Type = "luaIndex", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "BattlefieldVehicleInfo", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldVehicles", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "vehicles", Type = "table", InnerType = "BattlefieldVehicleInfo", Nilable = false }, + }, + }, + { + Name = "GetBattlegroundInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battlegroundIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "battlegroundInfo", Type = "BattlegroundInfo", Nilable = true }, + }, + }, + { + Name = "GetBrawlRewards", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "brawlType", Type = "BrawlType", Nilable = false }, + }, + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + { Name = "hasWon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBrawlSoloRBGMinItemLevel", + Type = "Function", + + Returns = + { + { Name = "minItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCustomVictoryStatID", + Type = "Function", + + Returns = + { + { Name = "statID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGlobalPvpScalingInfoForSpecID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specializationID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pvpScalingData", Type = "table", InnerType = "PvpScalingData", Nilable = false }, + }, + }, + { + Name = "GetHonorRewardInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "honorLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "HonorRewardInfo", Nilable = true }, + }, + }, + { + Name = "GetLevelUpBattlegrounds", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "battlefields", Type = "table", InnerType = "LevelUpBattlegroundInfo", Nilable = false }, + }, + }, + { + Name = "GetMatchPVPStatColumn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pvpStatID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "MatchPVPStatColumn", Nilable = true }, + }, + }, + { + Name = "GetMatchPVPStatColumns", + Type = "Function", + + Returns = + { + { Name = "columns", Type = "table", InnerType = "MatchPVPStatColumn", Nilable = false }, + }, + }, + { + Name = "GetNextHonorLevelForReward", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "honorLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nextHonorLevelWithReward", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetOutdoorPvPWaitTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pvpWaitTime", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetPVPActiveMatchPersonalRatedInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "PVPPersonalRatedInfo", Nilable = true }, + }, + }, + { + Name = "GetPVPActiveRatedMatchDeserterPenalty", + Type = "Function", + + Returns = + { + { Name = "deserterPenalty", Type = "RatedMatchDeserterPenalty", Nilable = true }, + }, + }, + { + Name = "GetPVPSeasonRewardAchievementID", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPersonalRatedBGBlitzSpecStats", + Type = "Function", + + Returns = + { + { Name = "specStats", Type = "RatedBGBlitzSpecStats", Nilable = true }, + }, + }, + { + Name = "GetPersonalRatedSoloShuffleSpecStats", + Type = "Function", + + Returns = + { + { Name = "specStats", Type = "RatedSoloShuffleSpecStats", Nilable = true }, + }, + }, + { + Name = "GetPostMatchCurrencyRewards", + Type = "Function", + + Returns = + { + { Name = "rewards", Type = "table", InnerType = "PVPPostMatchCurrencyReward", Nilable = false }, + }, + }, + { + Name = "GetPostMatchItemRewards", + Type = "Function", + + Returns = + { + { Name = "rewards", Type = "table", InnerType = "PVPPostMatchItemReward", Nilable = false }, + }, + }, + { + Name = "GetPvpTalentsUnlockedLevel", + Type = "Function", + + Returns = + { + { Name = "unlockLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPvpTierID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tierEnum", Type = "number", Nilable = false }, + { Name = "bracketEnum", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPvpTierInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tierID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pvpTierInfo", Type = "PvpTierInfo", Nilable = true }, + }, + }, + { + Name = "GetRandomBGInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "RandomBGInfo", Nilable = false }, + }, + }, + { + Name = "GetRandomBGRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetRandomEpicBGInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "RandomBGInfo", Nilable = false }, + }, + }, + { + Name = "GetRandomEpicBGRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetRandomTrainingGroundRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetRatedBGRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetRatedSoloRBGMinItemLevel", + Type = "Function", + + Returns = + { + { Name = "minItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRatedSoloRBGRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetRatedSoloShuffleMinItemLevel", + Type = "Function", + + Returns = + { + { Name = "minItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRatedSoloShuffleRewards", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "GetRewardItemLevelsByTierEnum", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pvpTierEnum", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "activityItemLevel", Type = "number", Nilable = false }, + { Name = "weeklyItemLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScoreInfo", + Type = "Function", + SecretInActivePvPMatch = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PVPScoreInfo", Nilable = true }, + }, + }, + { + Name = "GetScoreInfoByPlayerGuid", + Type = "Function", + SecretInActivePvPMatch = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PVPScoreInfo", Nilable = true }, + }, + }, + { + Name = "GetSeasonBestInfo", + Type = "Function", + + Returns = + { + { Name = "tierID", Type = "number", Nilable = false }, + { Name = "nextTierID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSkirmishInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pvpBracket", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "battlemasterListInfo", Type = "BattlemasterListInfo", Nilable = false }, + }, + }, + { + Name = "GetSpecialEventBrawlInfo", + Type = "Function", + + Returns = + { + { Name = "brawlInfo", Type = "PvpBrawlInfo", Nilable = true }, + }, + }, + { + Name = "GetTeamInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "PVPTeamInfo", Nilable = true }, + }, + }, + { + Name = "GetTrainingGrounds", + Type = "Function", + + Returns = + { + { Name = "trainingGrounds", Type = "table", InnerType = "BattlegroundInfo", Nilable = false }, + }, + }, + { + Name = "GetUIDisplaySeason", + Type = "Function", + + Returns = + { + { Name = "uiDisplaySeason", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWarModeRewardBonus", + Type = "Function", + + Returns = + { + { Name = "rewardBonus", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWarModeRewardBonusDefault", + Type = "Function", + + Returns = + { + { Name = "defaultBonus", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWeeklyChestInfo", + Type = "Function", + + Returns = + { + { Name = "rewardAchieved", Type = "bool", Nilable = false }, + { Name = "lastWeekRewardAchieved", Type = "bool", Nilable = false }, + { Name = "lastWeekRewardClaimed", Type = "bool", Nilable = false }, + { Name = "pvpTierMaxFromWins", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetZonePVPInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "pvpType", Type = "cstring", Nilable = false }, + { Name = "isSubZonePvP", Type = "bool", Nilable = false }, + { Name = "factionName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "HasArenaSkirmishWinToday", + Type = "Function", + + Returns = + { + { Name = "hasArenaSkirmishWinToday", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasMatchStarted", + Type = "Function", + Documentation = { "Returns true if a match is either active or complete." }, + + Returns = + { + { Name = "hasStarted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasRandomTrainingGroundWinToday", + Type = "Function", + + Returns = + { + { Name = "hasRandomTrainingGroundWinToday", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsActiveBattlefield", + Type = "Function", + + Returns = + { + { Name = "isActiveBattlefield", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsActiveMatchRegistered", + Type = "Function", + + Returns = + { + { Name = "registered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsArena", + Type = "Function", + + Returns = + { + { Name = "isArena", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBattleground", + Type = "Function", + + Returns = + { + { Name = "isBattleground", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBattlegroundEnlistmentBonusActive", + Type = "Function", + + Returns = + { + { Name = "battlegroundActive", Type = "bool", Nilable = false }, + { Name = "brawlActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBrawlSoloRBG", + Type = "Function", + + Returns = + { + { Name = "isBrawlSoloRBG", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBrawlSoloShuffle", + Type = "Function", + + Returns = + { + { Name = "isBrawlSoloShuffle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInBrawl", + Type = "Function", + + Returns = + { + { Name = "isInBrawl", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInRatedMatchWithDeserterPenalty", + Type = "Function", + + Returns = + { + { Name = "isInRatedMatchWithDeserterPenalty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMatchActive", + Type = "Function", + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMatchComplete", + Type = "Function", + + Returns = + { + { Name = "isComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMatchConsideredArena", + Type = "Function", + + Returns = + { + { Name = "asArena", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMatchFactional", + Type = "Function", + + Returns = + { + { Name = "isFactional", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPVPMap", + Type = "Function", + + Returns = + { + { Name = "isPVPMap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRatedArena", + Type = "Function", + + Returns = + { + { Name = "isRatedArena", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRatedBattleground", + Type = "Function", + + Returns = + { + { Name = "isRatedBattleground", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRatedMap", + Type = "Function", + + Returns = + { + { Name = "isRatedMap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRatedSoloRBG", + Type = "Function", + + Returns = + { + { Name = "isRatedSoloRBG", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRatedSoloShuffle", + Type = "Function", + + Returns = + { + { Name = "isRatedSoloShuffle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSoloRBG", + Type = "Function", + + Returns = + { + { Name = "isSoloRBG", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSoloShuffle", + Type = "Function", + + Returns = + { + { Name = "isSoloShuffle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSubZonePVPPOI", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWarModeActive", + Type = "Function", + + Returns = + { + { Name = "warModeActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWarModeDesired", + Type = "Function", + + Returns = + { + { Name = "warModeDesired", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWarModeFeatureEnabled", + Type = "Function", + + Returns = + { + { Name = "warModeEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "JoinBattlefield", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "battlemasterListId", Type = "number", Nilable = false }, + }, + }, + { + Name = "JoinBrawl", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isSpecialBrawl", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "JoinRandomTrainingGround", + Type = "Function", + }, + { + Name = "JoinRatedBGBlitz", + Type = "Function", + }, + { + Name = "JoinTrainingGround", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trainingGroundID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RequestCrowdControlSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerToken", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "SetPVP", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enablePVP", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetWarModeDesired", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "warModeDesired", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartSoloRBGWarGameByName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "args", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "number", Nilable = false }, + }, + }, + { + Name = "StartSpectatorSoloRBGWarGame", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "opaqueID1", Type = "number", Nilable = false }, + { Name = "opaqueID2", Type = "number", Nilable = false }, + { Name = "specifiedMap", Type = "cstring", Nilable = false }, + { Name = "tournamentRules", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "number", Nilable = false }, + }, + }, + { + Name = "TogglePVP", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "ToggleWarMode", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + { + Name = "ArenaOpponentUpdate", + Type = "Event", + LiteralName = "ARENA_OPPONENT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitToken", Type = "cstring", Nilable = false }, + { Name = "updateReason", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ArenaPrepOpponentSpecializations", + Type = "Event", + LiteralName = "ARENA_PREP_OPPONENT_SPECIALIZATIONS", + SynchronousEvent = true, + }, + { + Name = "ArenaSeasonWorldState", + Type = "Event", + LiteralName = "ARENA_SEASON_WORLD_STATE", + SynchronousEvent = true, + }, + { + Name = "BattlefieldAutoQueue", + Type = "Event", + LiteralName = "BATTLEFIELD_AUTO_QUEUE", + SynchronousEvent = true, + }, + { + Name = "BattlefieldAutoQueueEject", + Type = "Event", + LiteralName = "BATTLEFIELD_AUTO_QUEUE_EJECT", + SynchronousEvent = true, + }, + { + Name = "BattlefieldQueueTimeout", + Type = "Event", + LiteralName = "BATTLEFIELD_QUEUE_TIMEOUT", + SynchronousEvent = true, + }, + { + Name = "BattlefieldsClosed", + Type = "Event", + LiteralName = "BATTLEFIELDS_CLOSED", + SynchronousEvent = true, + }, + { + Name = "BattlefieldsShow", + Type = "Event", + LiteralName = "BATTLEFIELDS_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "isArena", Type = "bool", Nilable = true }, + { Name = "battleMasterListID", Type = "number", Nilable = true }, + }, + }, + { + Name = "BattlegroundObjectivesUpdate", + Type = "Event", + LiteralName = "BATTLEGROUND_OBJECTIVES_UPDATE", + SynchronousEvent = true, + }, + { + Name = "BattlegroundPointsUpdate", + Type = "Event", + LiteralName = "BATTLEGROUND_POINTS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "GdfSimComplete", + Type = "Event", + LiteralName = "GDF_SIM_COMPLETE", + SynchronousEvent = true, + }, + { + Name = "HonorLevelUpdate", + Type = "Event", + LiteralName = "HONOR_LEVEL_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "isHigherLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NotifyPvpAfkResult", + Type = "Event", + LiteralName = "NOTIFY_PVP_AFK_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "offender", Type = "cstring", Nilable = false }, + { Name = "numBlackMarksOnOffender", Type = "number", Nilable = false }, + { Name = "numPlayersIHaveReported", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerEnteringBattleground", + Type = "Event", + LiteralName = "PLAYER_ENTERING_BATTLEGROUND", + SynchronousEvent = true, + }, + { + Name = "PlayerJoinedPvpMatch", + Type = "Event", + LiteralName = "PLAYER_JOINED_PVP_MATCH", + SynchronousEvent = true, + }, + { + Name = "PostMatchCurrencyRewardUpdate", + Type = "Event", + LiteralName = "POST_MATCH_CURRENCY_REWARD_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "reward", Type = "PVPPostMatchCurrencyReward", Nilable = false }, + }, + }, + { + Name = "PostMatchItemRewardUpdate", + Type = "Event", + LiteralName = "POST_MATCH_ITEM_REWARD_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PvpBrawlInfoUpdated", + Type = "Event", + LiteralName = "PVP_BRAWL_INFO_UPDATED", + SynchronousEvent = true, + }, + { + Name = "PvpMatchActive", + Type = "Event", + LiteralName = "PVP_MATCH_ACTIVE", + SynchronousEvent = true, + }, + { + Name = "PvpMatchComplete", + Type = "Event", + LiteralName = "PVP_MATCH_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "winner", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "PvpMatchInactive", + Type = "Event", + LiteralName = "PVP_MATCH_INACTIVE", + SynchronousEvent = true, + }, + { + Name = "PvpMatchStateChanged", + Type = "Event", + LiteralName = "PVP_MATCH_STATE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PvpRatedStatsUpdate", + Type = "Event", + LiteralName = "PVP_RATED_STATS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PvpRewardsUpdate", + Type = "Event", + LiteralName = "PVP_REWARDS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PvpRolePopupHide", + Type = "Event", + LiteralName = "PVP_ROLE_POPUP_HIDE", + SynchronousEvent = true, + Payload = + { + { Name = "readyCheckInfo", Type = "PvpReadyCheckInfo", Nilable = true }, + }, + }, + { + Name = "PvpRolePopupShow", + Type = "Event", + LiteralName = "PVP_ROLE_POPUP_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "readyCheckInfo", Type = "PvpReadyCheckInfo", Nilable = false }, + }, + }, + { + Name = "PvpRoleUpdate", + Type = "Event", + LiteralName = "PVP_ROLE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PvpSpecialEventInfoUpdated", + Type = "Event", + LiteralName = "PVP_SPECIAL_EVENT_INFO_UPDATED", + SynchronousEvent = true, + }, + { + Name = "PvpTypesEnabled", + Type = "Event", + LiteralName = "PVP_TYPES_ENABLED", + SynchronousEvent = true, + Payload = + { + { Name = "wargameBattlegrounds", Type = "bool", Nilable = false }, + { Name = "ratedBattlegrounds", Type = "bool", Nilable = false }, + { Name = "ratedArenas", Type = "bool", Nilable = false }, + { Name = "ratedSoloShuffle", Type = "bool", Nilable = false }, + { Name = "ratedBGBlitz", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PvpVehicleInfoUpdated", + Type = "Event", + LiteralName = "PVP_VEHICLE_INFO_UPDATED", + UniqueEvent = true, + }, + { + Name = "PvpWorldstateUpdate", + Type = "Event", + LiteralName = "PVP_WORLDSTATE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PvpqueueAnywhereShow", + Type = "Event", + LiteralName = "PVPQUEUE_ANYWHERE_SHOW", + SynchronousEvent = true, + }, + { + Name = "PvpqueueAnywhereUpdateAvailable", + Type = "Event", + LiteralName = "PVPQUEUE_ANYWHERE_UPDATE_AVAILABLE", + SynchronousEvent = true, + }, + { + Name = "TrainingGroundsEnabledStatusUpdated", + Type = "Event", + LiteralName = "TRAINING_GROUNDS_ENABLED_STATUS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "UpdateActiveBattlefield", + Type = "Event", + LiteralName = "UPDATE_ACTIVE_BATTLEFIELD", + SynchronousEvent = true, + }, + { + Name = "UpdateBattlefieldScore", + Type = "Event", + LiteralName = "UPDATE_BATTLEFIELD_SCORE", + SynchronousEvent = true, + }, + { + Name = "UpdateBattlefieldStatus", + Type = "Event", + LiteralName = "UPDATE_BATTLEFIELD_STATUS", + SynchronousEvent = true, + Payload = + { + { Name = "battleFieldIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "WarModeStatusUpdate", + Type = "Event", + LiteralName = "WAR_MODE_STATUS_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "warModeEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "WargameInviteSent", + Type = "Event", + LiteralName = "WARGAME_INVITE_SENT", + SynchronousEvent = true, + }, + { + Name = "WargameRequestResponse", + Type = "Event", + LiteralName = "WARGAME_REQUEST_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "responderGUID", Type = "WOWGUID", Nilable = false }, + { Name = "responderName", Type = "cstring", Nilable = true }, + { Name = "accepted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "WargameRequested", + Type = "Event", + LiteralName = "WARGAME_REQUESTED", + SynchronousEvent = true, + Payload = + { + { Name = "opposingPartyMemberName", Type = "cstring", Nilable = false }, + { Name = "battlegroundName", Type = "cstring", Nilable = false }, + { Name = "timeoutSeconds", Type = "time_t", Nilable = false }, + { Name = "tournamentRules", Type = "bool", Nilable = false }, + }, + }, + { + Name = "WorldPvpQueue", + Type = "Event", + LiteralName = "WORLD_PVP_QUEUE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "BrawlType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "BrawlType", EnumValue = 0 }, + { Name = "Battleground", Type = "BrawlType", EnumValue = 1 }, + { Name = "Arena", Type = "BrawlType", EnumValue = 2 }, + { Name = "LFG", Type = "BrawlType", EnumValue = 3 }, + { Name = "SoloShuffle", Type = "BrawlType", EnumValue = 4 }, + { Name = "SoloRbg", Type = "BrawlType", EnumValue = 5 }, + }, + }, + { + Name = "PvPMatchState", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Inactive", Type = "PvPMatchState", EnumValue = 0 }, + { Name = "Waiting", Type = "PvPMatchState", EnumValue = 1 }, + { Name = "StartUp", Type = "PvPMatchState", EnumValue = 2 }, + { Name = "Engaged", Type = "PvPMatchState", EnumValue = 3 }, + { Name = "PostRound", Type = "PvPMatchState", EnumValue = 4 }, + { Name = "Complete", Type = "PvPMatchState", EnumValue = 5 }, + }, + }, + { + Name = "BattlefieldCurrencyReward", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "BattlefieldItemReward", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "BattlefieldRewards", + Type = "Structure", + Fields = + { + { Name = "honor", Type = "number", Nilable = false }, + { Name = "experience", Type = "number", Nilable = false }, + { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true }, + { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true }, + { Name = "roleShortageBonus", Type = "RoleShortageReward", Nilable = true }, + }, + }, + { + Name = "BattlefieldVehicleInfo", + Type = "Structure", + Fields = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isOccupied", Type = "bool", Nilable = false }, + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + { Name = "textureWidth", Type = "number", Nilable = false }, + { Name = "textureHeight", Type = "number", Nilable = false }, + { Name = "facing", Type = "number", Nilable = false }, + { Name = "isPlayer", Type = "bool", Nilable = false }, + { Name = "isAlive", Type = "bool", Nilable = false }, + { Name = "shouldDrawBelowPlayerBlips", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BattlegroundInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "gameType", Type = "cstring", Nilable = false }, + { Name = "shortDescription", Type = "cstring", Nilable = false }, + { Name = "longDescription", Type = "cstring", Nilable = false }, + { Name = "mapDescription", Type = "cstring", Nilable = false }, + { Name = "maxPlayers", Type = "number", Nilable = false }, + { Name = "battlegroundID", Type = "number", Nilable = true }, + { Name = "lfgDungeonID", Type = "number", Nilable = true }, + { Name = "mapID", Type = "number", Nilable = true }, + { Name = "isHoliday", Type = "bool", Nilable = false }, + { Name = "isRandom", Type = "bool", Nilable = false }, + { Name = "canEnter", Type = "bool", Nilable = false }, + { Name = "isTrainingGround", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BattlemasterListInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "matchmakingType", Type = "PvPMatchmakingType", Nilable = false }, + { Name = "minPlayers", Type = "number", Nilable = false }, + { Name = "maxPlayers", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "longDescription", Type = "string", Nilable = false }, + { Name = "shortDescription", Type = "string", Nilable = false }, + }, + }, + { + Name = "HonorRewardInfo", + Type = "Structure", + Fields = + { + { Name = "honorLevelName", Type = "string", Nilable = false }, + { Name = "badgeFileDataID", Type = "fileID", Nilable = false }, + { Name = "achievementRewardedID", Type = "number", Nilable = false }, + }, + }, + { + Name = "LevelUpBattlegroundInfo", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isEpic", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MatchPVPStatColumn", + Type = "Structure", + Fields = + { + { Name = "pvpStatID", Type = "number", Nilable = false }, + { Name = "columnHeaderID", Type = "number", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "tooltipTitle", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + }, + }, + { + Name = "PvpBrawlInfo", + Type = "Structure", + Fields = + { + { Name = "brawlID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "shortDescription", Type = "string", Nilable = false }, + { Name = "longDescription", Type = "string", Nilable = false }, + { Name = "canQueue", Type = "bool", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "groupsAllowed", Type = "bool", Nilable = false }, + { Name = "crossFactionAllowed", Type = "bool", Nilable = false, Default = false }, + { Name = "timeLeftUntilNextChange", Type = "number", Nilable = true }, + { Name = "brawlType", Type = "BrawlType", Nilable = false }, + { Name = "mapNames", Type = "table", InnerType = "string", Nilable = false }, + { Name = "includesAllArenas", Type = "bool", Nilable = false, Default = false }, + { Name = "minItemLevel", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "PVPPersonalRatedInfo", + Type = "Structure", + Fields = + { + { Name = "personalRating", Type = "number", Nilable = false }, + { Name = "bestSeasonRating", Type = "number", Nilable = false }, + { Name = "bestWeeklyRating", Type = "number", Nilable = false }, + { Name = "seasonPlayed", Type = "number", Nilable = false }, + { Name = "seasonWon", Type = "number", Nilable = false }, + { Name = "weeklyPlayed", Type = "number", Nilable = false }, + { Name = "weeklyWon", Type = "number", Nilable = false }, + { Name = "lastWeeksBestRating", Type = "number", Nilable = false }, + { Name = "hasWonBracketToday", Type = "bool", Nilable = false }, + { Name = "tier", Type = "number", Nilable = false }, + { Name = "ranking", Type = "number", Nilable = true }, + { Name = "roundsSeasonPlayed", Type = "number", Nilable = false }, + { Name = "roundsSeasonWon", Type = "number", Nilable = false }, + { Name = "roundsWeeklyPlayed", Type = "number", Nilable = false }, + { Name = "roundsWeeklyWon", Type = "number", Nilable = false }, + }, + }, + { + Name = "PVPPostMatchCurrencyReward", + Type = "Structure", + Fields = + { + { Name = "currencyType", Type = "number", Nilable = false }, + { Name = "quantityChanged", Type = "number", Nilable = false }, + }, + }, + { + Name = "PVPPostMatchItemReward", + Type = "Structure", + Fields = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "link", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "isUpgraded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PvpReadyCheckInfo", + Type = "Structure", + Fields = + { + { Name = "roles", Type = "table", InnerType = "PvpRoleQueueInfo", Nilable = false }, + { Name = "numPlayersAccepted", Type = "number", Nilable = false }, + { Name = "numPlayersDeclined", Type = "number", Nilable = false }, + { Name = "totalNumPlayers", Type = "number", Nilable = false }, + }, + }, + { + Name = "PvpRoleQueueInfo", + Type = "Structure", + Fields = + { + { Name = "role", Type = "cstring", Nilable = false }, + { Name = "totalRole", Type = "number", Nilable = false }, + { Name = "totalAccepted", Type = "number", Nilable = false }, + { Name = "totalDeclined", Type = "number", Nilable = false }, + }, + }, + { + Name = "PvpScalingData", + Type = "Structure", + Fields = + { + { Name = "scalingDataID", Type = "number", Nilable = false }, + { Name = "specializationID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "PVPScoreInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "killingBlows", Type = "number", Nilable = false }, + { Name = "honorableKills", Type = "number", Nilable = false }, + { Name = "deaths", Type = "number", Nilable = false }, + { Name = "honorGained", Type = "number", Nilable = false }, + { Name = "faction", Type = "number", Nilable = false }, + { Name = "raceName", Type = "string", Nilable = false }, + { Name = "className", Type = "string", Nilable = false }, + { Name = "classToken", Type = "string", Nilable = false }, + { Name = "damageDone", Type = "number", Nilable = false }, + { Name = "healingDone", Type = "number", Nilable = false }, + { Name = "rating", Type = "number", Nilable = false }, + { Name = "ratingChange", Type = "number", Nilable = false }, + { Name = "prematchMMR", Type = "number", Nilable = false }, + { Name = "mmrChange", Type = "number", Nilable = false }, + { Name = "postmatchMMR", Type = "number", Nilable = false }, + { Name = "talentSpec", Type = "string", Nilable = false }, + { Name = "honorLevel", Type = "number", Nilable = false }, + { Name = "roleAssigned", Type = "number", Nilable = false }, + { Name = "stats", Type = "table", InnerType = "PVPStatInfo", Nilable = false }, + }, + }, + { + Name = "PVPStatInfo", + Type = "Structure", + Fields = + { + { Name = "pvpStatID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "pvpStatValue", Type = "number", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "name", Type = "string", Nilable = false, NeverSecret = true }, + { Name = "tooltip", Type = "string", Nilable = false, NeverSecret = true }, + { Name = "iconName", Type = "string", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "PVPTeamInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "size", Type = "number", Nilable = false }, + { Name = "rating", Type = "number", Nilable = false }, + { Name = "ratingNew", Type = "number", Nilable = false }, + { Name = "ratingMMR", Type = "number", Nilable = false }, + }, + }, + { + Name = "PvpTierInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "descendRating", Type = "number", Nilable = false }, + { Name = "ascendRating", Type = "number", Nilable = false }, + { Name = "descendTier", Type = "number", Nilable = false }, + { Name = "ascendTier", Type = "number", Nilable = false }, + { Name = "pvpTierEnum", Type = "number", Nilable = false }, + { Name = "tierIconID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "RandomBGInfo", + Type = "Structure", + Fields = + { + { Name = "canQueue", Type = "bool", Nilable = false }, + { Name = "bgID", Type = "number", Nilable = false }, + { Name = "bgIndex", Type = "luaIndex", Nilable = false }, + { Name = "hasRandomWinToday", Type = "bool", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "RatedBGBlitzSpecStats", + Type = "Structure", + Fields = + { + { Name = "weeklyMostPlayedSpecID", Type = "number", Nilable = false }, + { Name = "weeklyMostPlayedSpecGames", Type = "number", Nilable = false }, + { Name = "seasonMostPlayedSpecID", Type = "number", Nilable = false }, + { Name = "seasonMostPlayedSpecGames", Type = "number", Nilable = false }, + }, + }, + { + Name = "RatedMatchDeserterPenalty", + Type = "Structure", + Fields = + { + { Name = "personalRatingChange", Type = "number", Nilable = false }, + { Name = "queuePenaltySpellID", Type = "number", Nilable = false }, + { Name = "queuePenaltyDuration", Type = "number", Nilable = false }, + }, + }, + { + Name = "RatedSoloShuffleSpecStats", + Type = "Structure", + Fields = + { + { Name = "weeklyMostPlayedSpecID", Type = "number", Nilable = false }, + { Name = "weeklyMostPlayedSpecRounds", Type = "number", Nilable = false }, + { Name = "seasonMostPlayedSpecID", Type = "number", Nilable = false }, + { Name = "seasonMostPlayedSpecRounds", Type = "number", Nilable = false }, + }, + }, + { + Name = "RoleShortageReward", + Type = "Structure", + Fields = + { + { Name = "validRoles", Type = "table", InnerType = "cstring", Nilable = false }, + { Name = "rewardSpellID", Type = "number", Nilable = false }, + { Name = "rewardItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "WorldPVPBattlegroundInfo", + Type = "Structure", + Fields = + { + { Name = "bgID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "canQueue", Type = "bool", Nilable = false }, + { Name = "canEnter", Type = "bool", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PvpInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ce4b49c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,157 @@ +local QuestConstants = +{ + Tables = + { + { + Name = "CombinedQuestLogStatus", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Available", Type = "CombinedQuestLogStatus", EnumValue = 0 }, + { Name = "Complete", Type = "CombinedQuestLogStatus", EnumValue = 1 }, + { Name = "CompleteDaily", Type = "CombinedQuestLogStatus", EnumValue = 2 }, + { Name = "CompleteWeekly", Type = "CombinedQuestLogStatus", EnumValue = 3 }, + { Name = "CompleteMonthly", Type = "CombinedQuestLogStatus", EnumValue = 4 }, + { Name = "CompleteYearly", Type = "CombinedQuestLogStatus", EnumValue = 5 }, + { Name = "CompleteGameReset", Type = "CombinedQuestLogStatus", EnumValue = 6 }, + { Name = "Reset", Type = "CombinedQuestLogStatus", EnumValue = 7 }, + }, + }, + { + Name = "CombinedQuestStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Invalid", Type = "CombinedQuestStatus", EnumValue = 0 }, + { Name = "Completed", Type = "CombinedQuestStatus", EnumValue = 1 }, + { Name = "NotCompleted", Type = "CombinedQuestStatus", EnumValue = 2 }, + }, + }, + { + Name = "QuestCompleteSpellType", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "LegacyBehavior", Type = "QuestCompleteSpellType", EnumValue = 0 }, + { Name = "Follower", Type = "QuestCompleteSpellType", EnumValue = 1 }, + { Name = "Tradeskill", Type = "QuestCompleteSpellType", EnumValue = 2 }, + { Name = "Ability", Type = "QuestCompleteSpellType", EnumValue = 3 }, + { Name = "Aura", Type = "QuestCompleteSpellType", EnumValue = 4 }, + { Name = "Spell", Type = "QuestCompleteSpellType", EnumValue = 5 }, + { Name = "Unlock", Type = "QuestCompleteSpellType", EnumValue = 6 }, + { Name = "Companion", Type = "QuestCompleteSpellType", EnumValue = 7 }, + { Name = "QuestlineUnlock", Type = "QuestCompleteSpellType", EnumValue = 8 }, + { Name = "QuestlineReward", Type = "QuestCompleteSpellType", EnumValue = 9 }, + { Name = "QuestlineUnlockPart", Type = "QuestCompleteSpellType", EnumValue = 10 }, + { Name = "PossibleReward", Type = "QuestCompleteSpellType", EnumValue = 11 }, + }, + }, + { + Name = "QuestRepeatability", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "QuestRepeatability", EnumValue = 0 }, + { Name = "Daily", Type = "QuestRepeatability", EnumValue = 1 }, + { Name = "Weekly", Type = "QuestRepeatability", EnumValue = 2 }, + { Name = "Turnin", Type = "QuestRepeatability", EnumValue = 3 }, + { Name = "World", Type = "QuestRepeatability", EnumValue = 4 }, + }, + }, + { + Name = "QuestRewardContextFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "QuestRewardContextFlags", EnumValue = 0 }, + { Name = "FirstCompletionBonus", Type = "QuestRewardContextFlags", EnumValue = 1 }, + { Name = "RepeatCompletionBonus", Type = "QuestRewardContextFlags", EnumValue = 2 }, + }, + }, + { + Name = "QuestTagType", + Type = "Enumeration", + NumValues = 20, + MinValue = 0, + MaxValue = 19, + Fields = + { + { Name = "Tag", Type = "QuestTagType", EnumValue = 0 }, + { Name = "Profession", Type = "QuestTagType", EnumValue = 1 }, + { Name = "Normal", Type = "QuestTagType", EnumValue = 2 }, + { Name = "PvP", Type = "QuestTagType", EnumValue = 3 }, + { Name = "PetBattle", Type = "QuestTagType", EnumValue = 4 }, + { Name = "Bounty", Type = "QuestTagType", EnumValue = 5 }, + { Name = "Dungeon", Type = "QuestTagType", EnumValue = 6 }, + { Name = "Invasion", Type = "QuestTagType", EnumValue = 7 }, + { Name = "Raid", Type = "QuestTagType", EnumValue = 8 }, + { Name = "Contribution", Type = "QuestTagType", EnumValue = 9 }, + { Name = "RatedReward", Type = "QuestTagType", EnumValue = 10 }, + { Name = "InvasionWrapper", Type = "QuestTagType", EnumValue = 11 }, + { Name = "FactionAssault", Type = "QuestTagType", EnumValue = 12 }, + { Name = "Islands", Type = "QuestTagType", EnumValue = 13 }, + { Name = "Threat", Type = "QuestTagType", EnumValue = 14 }, + { Name = "CovenantCalling", Type = "QuestTagType", EnumValue = 15 }, + { Name = "DragonRiderRacing", Type = "QuestTagType", EnumValue = 16 }, + { Name = "Capstone", Type = "QuestTagType", EnumValue = 17 }, + { Name = "WorldBoss", Type = "QuestTagType", EnumValue = 18 }, + { Name = "Prey", Type = "QuestTagType", EnumValue = 19 }, + }, + }, + { + Name = "QuestTreasurePickerType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Visible", Type = "QuestTreasurePickerType", EnumValue = 0 }, + { Name = "Hidden", Type = "QuestTreasurePickerType", EnumValue = 1 }, + { Name = "Select", Type = "QuestTreasurePickerType", EnumValue = 2 }, + }, + }, + { + Name = "RelativeContentDifficulty", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Trivial", Type = "RelativeContentDifficulty", EnumValue = 0 }, + { Name = "Easy", Type = "RelativeContentDifficulty", EnumValue = 1 }, + { Name = "Fair", Type = "RelativeContentDifficulty", EnumValue = 2 }, + { Name = "Difficult", Type = "RelativeContentDifficulty", EnumValue = 3 }, + { Name = "Impossible", Type = "RelativeContentDifficulty", EnumValue = 4 }, + }, + }, + { + Name = "QuestWatchConsts", + Type = "Constants", + Values = + { + { Name = "MAX_QUEST_WATCHES", Type = "number", Value = 25 }, + { Name = "MAX_WORLD_QUEST_WATCHES_AUTOMATIC", Type = "number", Value = 1 }, + { Name = "MAX_WORLD_QUEST_WATCHES_MANUAL", Type = "number", Value = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstants_MainlineDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstants_MainlineDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4f9af9f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestConstants_MainlineDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local QuestConstants_Mainline = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(QuestConstants_Mainline); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2e5b080 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestHubInfoDocumentation.lua.annotated.lua @@ -0,0 +1,37 @@ +local QuestHubInfo = +{ + Name = "QuestHubUI", + Type = "System", + Namespace = "C_QuestHub", + Environment = "All", + + Functions = + { + { + Name = "IsQuestCurrentlyRelatedToHub", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "areaPoiID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isRelated", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(QuestHubInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..122a67e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local QuestInfoShared = +{ + Tables = + { + { + Name = "QuestClassification", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "Important", Type = "QuestClassification", EnumValue = 0 }, + { Name = "Legendary", Type = "QuestClassification", EnumValue = 1 }, + { Name = "Campaign", Type = "QuestClassification", EnumValue = 2 }, + { Name = "Calling", Type = "QuestClassification", EnumValue = 3 }, + { Name = "Meta", Type = "QuestClassification", EnumValue = 4 }, + { Name = "Recurring", Type = "QuestClassification", EnumValue = 5 }, + { Name = "Questline", Type = "QuestClassification", EnumValue = 6 }, + { Name = "Normal", Type = "QuestClassification", EnumValue = 7 }, + { Name = "BonusObjective", Type = "QuestClassification", EnumValue = 8 }, + { Name = "Threat", Type = "QuestClassification", EnumValue = 9 }, + { Name = "WorldQuest", Type = "QuestClassification", EnumValue = 10 }, + }, + }, + { + Name = "QuestPOIMapInfo", + Type = "Structure", + Fields = + { + { Name = "childDepth", Type = "number", Nilable = true }, + { Name = "questTagType", Type = "QuestTagType", Nilable = true }, + { Name = "questID", Type = "number", Nilable = false }, + { Name = "numObjectives", Type = "number", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "isQuestStart", Type = "bool", Nilable = false }, + { Name = "isDaily", Type = "bool", Nilable = false }, + { Name = "isCombatAllyQuest", Type = "bool", Nilable = false }, + { Name = "isMeta", Type = "bool", Nilable = false }, + { Name = "inProgress", Type = "bool", Nilable = false }, + { Name = "isMapIndicatorQuest", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3dc9fc1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestInfoSystemDocumentation.lua.annotated.lua @@ -0,0 +1,146 @@ +local QuestInfoSystem = +{ + Name = "QuestInfoSystem", + Type = "System", + Namespace = "C_QuestInfoSystem", + Environment = "All", + + Functions = + { + { + Name = "GetQuestClassification", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + { Name = "questInfoID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "classification", Type = "QuestClassification", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardFavor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "clampFavorToCycleCap", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestRewardCurrencies", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "questRewardCurrencyInfo", Type = "table", InnerType = "QuestRewardCurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetQuestRewardSpellInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "QuestRewardSpellInfo", Nilable = true }, + }, + }, + { + Name = "GetQuestRewardSpells", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestShouldToastCompletion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "shouldToast", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasQuestRewardCurrencies", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "hasQuestRewardCurrencies", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasQuestRewardSpells", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "hasRewardSpells", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(QuestInfoSystem); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua.annotated.lua new file mode 100644 index 0000000..18ee980 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestItemUseDocumentation.lua.annotated.lua @@ -0,0 +1,38 @@ +local QuestItemUse = +{ + Name = "QuestItemUse", + Type = "System", + Namespace = "C_QuestItemUse", + Environment = "All", + + Functions = + { + { + Name = "CanUseQuestItemOnObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "checkRange", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(QuestItemUse); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..288c44d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLineInfoDocumentation.lua.annotated.lua @@ -0,0 +1,163 @@ +local QuestLineInfo = +{ + Name = "QuestLineUI", + Type = "System", + Namespace = "C_QuestLine", + Environment = "All", + + Functions = + { + { + Name = "GetAvailableQuestLines", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questLines", Type = "table", InnerType = "QuestLineInfo", Nilable = false }, + }, + }, + { + Name = "GetForceVisibleQuests", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLineInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = true }, + { Name = "displayableOnly", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "questLineInfo", Type = "QuestLineInfo", Nilable = true }, + }, + }, + { + Name = "GetQuestLineQuests", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsComplete", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestLineIgnoresAccountCompletedFiltering", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "questLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questLineIgnoresAccountCompletedFiltering", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestQuestLinesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "QuestLineFloorLocation", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Above", Type = "QuestLineFloorLocation", EnumValue = 0 }, + { Name = "Below", Type = "QuestLineFloorLocation", EnumValue = 1 }, + { Name = "Same", Type = "QuestLineFloorLocation", EnumValue = 2 }, + }, + }, + { + Name = "QuestLineInfo", + Type = "Structure", + Fields = + { + { Name = "questLineName", Type = "cstring", Nilable = false }, + { Name = "questName", Type = "cstring", Nilable = false }, + { Name = "questLineID", Type = "number", Nilable = false }, + { Name = "questID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "isHidden", Type = "bool", Nilable = false }, + { Name = "isLegendary", Type = "bool", Nilable = false }, + { Name = "isLocalStory", Type = "bool", Nilable = false }, + { Name = "isDaily", Type = "bool", Nilable = false }, + { Name = "isCampaign", Type = "bool", Nilable = false }, + { Name = "isImportant", Type = "bool", Nilable = false }, + { Name = "isAccountCompleted", Type = "bool", Nilable = false }, + { Name = "isCombatAllyQuest", Type = "bool", Nilable = false }, + { Name = "isMeta", Type = "bool", Nilable = false }, + { Name = "inProgress", Type = "bool", Nilable = false }, + { Name = "isQuestStart", Type = "bool", Nilable = false }, + { Name = "floorLocation", Type = "QuestLineFloorLocation", Nilable = false }, + { Name = "startMapID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestLineInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua.annotated.lua new file mode 100644 index 0000000..72df633 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestLogDocumentation.lua.annotated.lua @@ -0,0 +1,1589 @@ +local QuestLog = +{ + Name = "QuestLog", + Type = "System", + Namespace = "C_QuestLog", + Environment = "All", + + Functions = + { + { + Name = "AbandonQuest", + Type = "Function", + }, + { + Name = "AddQuestWatch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "wasWatched", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AddWorldQuestWatch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "watchType", Type = "QuestWatchType", Nilable = true }, + }, + + Returns = + { + { Name = "wasWatched", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanAbandonQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canAbandon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesQuestAwardReputationWithFaction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "targetFactionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "awardsReputation", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAbandonQuest", + Type = "Function", + + Returns = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAbandonQuestItems", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetActivePreyQuest", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActiveThreatMaps", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "uiMapIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAllCompletedQuestIDs", + Type = "Function", + + Returns = + { + { Name = "quests", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetBountiesForMapID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "bounties", Type = "table", InnerType = "BountyInfo", Nilable = true }, + }, + }, + { + Name = "GetBountySetInfoForMapID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "displayLocation", Type = "MapOverlayDisplayLocation", Nilable = false }, + { Name = "lockQuestID", Type = "number", Nilable = false }, + { Name = "bountySetID", Type = "number", Nilable = false }, + { Name = "isActivitySet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDistanceSqToQuest", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "distanceSq", Type = "number", Nilable = false }, + { Name = "onContinent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetHeaderIndexForQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questLogIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "QuestInfo", Nilable = true }, + }, + }, + { + Name = "GetLogIndexForQuestID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only returns a log index for actual quests, not headers" }, + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questLogIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetMapForQuestPOIs", + Type = "Function", + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxNumQuests", + Type = "Function", + Documentation = { "This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries etc" }, + + Returns = + { + { Name = "maxNumQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxNumQuestsCanAccept", + Type = "Function", + Documentation = { "This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log." }, + + Returns = + { + { Name = "maxNumQuestsCanAccept", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNextWaypoint", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNextWaypointForMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNextWaypointText", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "waypointText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumQuestLogEntries", + Type = "Function", + + Returns = + { + { Name = "numShownEntries", Type = "number", Nilable = false }, + { Name = "numQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestObjectives", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "leaderboardCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestWatches", + Type = "Function", + + Returns = + { + { Name = "numQuestWatches", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumWorldQuestWatches", + Type = "Function", + + Returns = + { + { Name = "numQuestWatches", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestAdditionalHighlights", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "worldQuests", Type = "bool", Nilable = false }, + { Name = "worldQuestsElite", Type = "bool", Nilable = false }, + { Name = "dungeons", Type = "bool", Nilable = false }, + { Name = "treasures", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestDetailsTheme", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "theme", Type = "QuestTheme", Nilable = true }, + }, + }, + { + Name = "GetQuestDifficultyLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestIDForLogIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only returns a questID for actual quests, not headers" }, + + Arguments = + { + { Name = "questLogIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetQuestIDForQuestWatchIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questWatchIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetQuestIDForWorldQuestWatchIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questWatchIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetQuestLogMajorFactionReputationRewards", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "reputationRewards", Type = "table", InnerType = "QuestRewardReputationInfo", Nilable = false }, + }, + }, + { + Name = "GetQuestLogPortraitGiver", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questLogIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "portraitGiver", Type = "number", Nilable = false }, + { Name = "portraitGiverText", Type = "cstring", Nilable = false }, + { Name = "portraitGiverName", Type = "cstring", Nilable = false }, + { Name = "portraitGiverMount", Type = "number", Nilable = false }, + { Name = "portraitGiverModelSceneID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetQuestObjectives", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "objectives", Type = "table", InnerType = "QuestObjectiveInfo", Nilable = false }, + }, + }, + { + Name = "GetQuestRewardCurrencies", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questRewardCurrencies", Type = "table", InnerType = "QuestRewardCurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetQuestRewardCurrencyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "currencyIndex", Type = "luaIndex", Nilable = false }, + { Name = "isChoice", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "questRewardCurrencyInfo", Type = "QuestRewardCurrencyInfo", Nilable = true }, + }, + }, + { + Name = "GetQuestTagInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "QuestTagInfo", Nilable = true }, + }, + }, + { + Name = "GetQuestType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questType", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetQuestWatchType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "watchType", Type = "QuestWatchType", Nilable = true }, + }, + }, + { + Name = "GetQuestsOnMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "quests", Type = "table", InnerType = "QuestPOIMapInfo", Nilable = false }, + }, + }, + { + Name = "GetRequiredMoney", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Uses the selected quest if no questID is provided" }, + + Arguments = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "requiredMoney", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedQuest", + Type = "Function", + + Returns = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSuggestedGroupSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "suggestedGroupSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTimeAllowed", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "totalTime", Type = "number", Nilable = false }, + { Name = "elapsedTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTitleForLogIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a valid title for anything that is in the quest log." }, + + Arguments = + { + { Name = "questLogIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "title", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetTitleForQuestID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Only returns a valid title for quests, header titles cannot be discovered using this." }, + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "title", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetZoneStoryInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "achievementID", Type = "number", Nilable = false }, + { Name = "storyMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasActiveThreats", + Type = "Function", + + Returns = + { + { Name = "hasActiveThreats", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAccountQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAccountQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsComplete", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFailed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isFailed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsImportantQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isImportant", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMetaQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isMeta", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "onMap", Type = "bool", Nilable = false }, + { Name = "hasLocalPOI", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOnQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isOnQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPushableQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPushable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestBounty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isBounty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestCalling", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCalling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestCriteriaForBounty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "bountyQuestID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCriteriaForBounty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestDisabledForSession", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestFlaggedCompleted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCompleted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestFlaggedCompletedOnAccount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCompletedOnAccount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestFromContentPush", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isFromContentPush", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestInvasion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isInvasion", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestReplayable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isReplayable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestReplayedRecently", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "recentlyReplayed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestTask", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTask", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestTrivial", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTrivial", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRepeatableQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isRepeatable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsThreatQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isThreat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUnitOnQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isOnQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWorldQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isWorldQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestCanHaveWarModeBonus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Tests whether a quest is eligible for warmode bonuses (e.g. most world quests, some daily quests" }, + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasBonus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestContainsFirstTimeRepBonusForPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questContainsFirstTimeRepBonusForPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestHasQuestSessionBonus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasBonus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestHasWarModeBonus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Tests whether a quest in the player's quest log that is eligible for warmode bonuses (see 'QuestCanHaveWarModeBOnus') has been completed in warmode (including accepting it)" }, + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasBonus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestIgnoresAccountCompletedFiltering", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questIgnoresAccountCompletedFiltering", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReadyForTurnIn", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "readyForTurnIn", Type = "bool", Nilable = true }, + }, + }, + { + Name = "RemoveQuestWatch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "wasRemoved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveWorldQuestWatch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "wasRemoved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestLoadQuestByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetAbandonQuest", + Type = "Function", + }, + { + Name = "SetMapForQuestPOIs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSelectedQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShouldDisplayTimeRemaining", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "displayTimeRemaining", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowQuestRewards", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "shouldShow", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SortQuestWatches", + Type = "Function", + }, + { + Name = "UnitIsRelatedToActiveQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isRelatedToActiveQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UpdateCampaignHeaders", + Type = "Function", + }, + }, + + Events = + { + { + Name = "QuestAccepted", + Type = "Event", + LiteralName = "QUEST_ACCEPTED", + SynchronousEvent = true, + Payload = + { + { Name = "questId", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestAutocomplete", + Type = "Event", + LiteralName = "QUEST_AUTOCOMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "questId", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestComplete", + Type = "Event", + LiteralName = "QUEST_COMPLETE", + SynchronousEvent = true, + }, + { + Name = "QuestDataLoadResult", + Type = "Event", + LiteralName = "QUEST_DATA_LOAD_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestDetail", + Type = "Event", + LiteralName = "QUEST_DETAIL", + SynchronousEvent = true, + Payload = + { + { Name = "questStartItemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "QuestLogCriteriaUpdate", + Type = "Event", + LiteralName = "QUEST_LOG_CRITERIA_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "specificTreeID", Type = "number", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "numFulfilled", Type = "number", Nilable = false }, + { Name = "numRequired", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestLogUpdate", + Type = "Event", + LiteralName = "QUEST_LOG_UPDATE", + UniqueEvent = true, + }, + { + Name = "QuestPoiUpdate", + Type = "Event", + LiteralName = "QUEST_POI_UPDATE", + UniqueEvent = true, + }, + { + Name = "QuestRemoved", + Type = "Event", + LiteralName = "QUEST_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "wasReplayQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestTurnedIn", + Type = "Event", + LiteralName = "QUEST_TURNED_IN", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "xpReward", Type = "number", Nilable = false }, + { Name = "moneyReward", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestWatchListChanged", + Type = "Event", + LiteralName = "QUEST_WATCH_LIST_CHANGED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = true }, + { Name = "added", Type = "bool", Nilable = true }, + }, + }, + { + Name = "QuestWatchUpdate", + Type = "Event", + LiteralName = "QUEST_WATCH_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestlineUpdate", + Type = "Event", + LiteralName = "QUESTLINE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "requestRequired", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TaskProgressUpdate", + Type = "Event", + LiteralName = "TASK_PROGRESS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "TreasurePickerCacheFlush", + Type = "Event", + LiteralName = "TREASURE_PICKER_CACHE_FLUSH", + SynchronousEvent = true, + }, + { + Name = "WaypointUpdate", + Type = "Event", + LiteralName = "WAYPOINT_UPDATE", + SynchronousEvent = true, + }, + { + Name = "WorldQuestCompletedBySpell", + Type = "Event", + LiteralName = "WORLD_QUEST_COMPLETED_BY_SPELL", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "MapOverlayDisplayLocation", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Default", Type = "MapOverlayDisplayLocation", EnumValue = 0 }, + { Name = "BottomLeft", Type = "MapOverlayDisplayLocation", EnumValue = 1 }, + { Name = "TopLeft", Type = "MapOverlayDisplayLocation", EnumValue = 2 }, + { Name = "BottomRight", Type = "MapOverlayDisplayLocation", EnumValue = 3 }, + { Name = "TopRight", Type = "MapOverlayDisplayLocation", EnumValue = 4 }, + { Name = "Hidden", Type = "MapOverlayDisplayLocation", EnumValue = 5 }, + }, + }, + { + Name = "QuestFrequency", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Default", Type = "QuestFrequency", EnumValue = 0 }, + { Name = "Daily", Type = "QuestFrequency", EnumValue = 1 }, + { Name = "Weekly", Type = "QuestFrequency", EnumValue = 2 }, + { Name = "ResetByScheduler", Type = "QuestFrequency", EnumValue = 3 }, + }, + }, + { + Name = "QuestTag", + Type = "Enumeration", + NumValues = 12, + MinValue = 1, + MaxValue = 288, + Fields = + { + { Name = "Group", Type = "QuestTag", EnumValue = 1 }, + { Name = "PvP", Type = "QuestTag", EnumValue = 41 }, + { Name = "Raid", Type = "QuestTag", EnumValue = 62 }, + { Name = "Dungeon", Type = "QuestTag", EnumValue = 81 }, + { Name = "Legendary", Type = "QuestTag", EnumValue = 83 }, + { Name = "Heroic", Type = "QuestTag", EnumValue = 85 }, + { Name = "Raid10", Type = "QuestTag", EnumValue = 88 }, + { Name = "Raid25", Type = "QuestTag", EnumValue = 89 }, + { Name = "Scenario", Type = "QuestTag", EnumValue = 98 }, + { Name = "Account", Type = "QuestTag", EnumValue = 102 }, + { Name = "CombatAlly", Type = "QuestTag", EnumValue = 266 }, + { Name = "Delve", Type = "QuestTag", EnumValue = 288 }, + }, + }, + { + Name = "QuestWatchType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Automatic", Type = "QuestWatchType", EnumValue = 0 }, + { Name = "Manual", Type = "QuestWatchType", EnumValue = 1 }, + }, + }, + { + Name = "WorldQuestQuality", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Common", Type = "WorldQuestQuality", EnumValue = 0 }, + { Name = "Rare", Type = "WorldQuestQuality", EnumValue = 1 }, + { Name = "Epic", Type = "WorldQuestQuality", EnumValue = 2 }, + }, + }, + { + Name = "QuestInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "questLogIndex", Type = "luaIndex", Nilable = false }, + { Name = "questID", Type = "number", Nilable = false }, + { Name = "campaignID", Type = "number", Nilable = true }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "difficultyLevel", Type = "number", Nilable = false }, + { Name = "suggestedGroup", Type = "number", Nilable = false }, + { Name = "frequency", Type = "QuestFrequency", Nilable = true }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "useMinimalHeader", Type = "bool", Nilable = false }, + { Name = "sortAsNormalQuest", Type = "bool", Nilable = false }, + { Name = "isCollapsed", Type = "bool", Nilable = false }, + { Name = "startEvent", Type = "bool", Nilable = false }, + { Name = "isTask", Type = "bool", Nilable = false }, + { Name = "isBounty", Type = "bool", Nilable = false }, + { Name = "isStory", Type = "bool", Nilable = false }, + { Name = "isScaling", Type = "bool", Nilable = false }, + { Name = "isOnMap", Type = "bool", Nilable = false }, + { Name = "hasLocalPOI", Type = "bool", Nilable = false }, + { Name = "isHidden", Type = "bool", Nilable = false }, + { Name = "isAutoComplete", Type = "bool", Nilable = false }, + { Name = "overridesSortOrder", Type = "bool", Nilable = false }, + { Name = "readyForTranslation", Type = "bool", Nilable = false, Default = true }, + { Name = "isInternalOnly", Type = "bool", Nilable = false }, + { Name = "isAbandonOnDisable", Type = "bool", Nilable = false }, + { Name = "headerSortKey", Type = "number", Nilable = true }, + { Name = "questClassification", Type = "QuestClassification", Nilable = false }, + }, + }, + { + Name = "QuestObjectiveInfo", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "type", Type = "string", Nilable = false }, + { Name = "finished", Type = "bool", Nilable = false }, + { Name = "numFulfilled", Type = "number", Nilable = false }, + { Name = "numRequired", Type = "number", Nilable = false }, + { Name = "objectiveType", Type = "QuestObjectiveType", Nilable = true }, + }, + }, + { + Name = "QuestTagInfo", + Type = "Structure", + Fields = + { + { Name = "tagName", Type = "cstring", Nilable = false }, + { Name = "tagID", Type = "number", Nilable = false }, + { Name = "worldQuestType", Type = "number", Nilable = true }, + { Name = "quality", Type = "WorldQuestQuality", Nilable = true }, + { Name = "tradeskillLineID", Type = "number", Nilable = true }, + { Name = "isElite", Type = "bool", Nilable = true }, + { Name = "displayExpiration", Type = "bool", Nilable = true }, + }, + }, + { + Name = "QuestTheme", + Type = "Structure", + Fields = + { + { Name = "background", Type = "textureAtlas", Nilable = false }, + { Name = "seal", Type = "textureAtlas", Nilable = false }, + { Name = "signature", Type = "cstring", Nilable = false }, + { Name = "poiIcon", Type = "textureAtlas", Nilable = false }, + { Name = "mapPinInfo", Type = "UIMapPinInfo", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestLog); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f573e7f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestOfferDocumentation.lua.annotated.lua @@ -0,0 +1,118 @@ +local QuestOffer = +{ + Name = "QuestOffer", + Type = "System", + Namespace = "C_QuestOffer", + Environment = "All", + + Functions = + { + { + Name = "GetHideRequiredItems", + Type = "Function", + + Returns = + { + { Name = "hideRequiredItems", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestOfferMajorFactionReputationRewards", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "reputationRewards", Type = "table", InnerType = "QuestRewardReputationInfo", Nilable = false }, + }, + }, + { + Name = "GetQuestRequiredCurrencyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questRewardIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questRequiredCurrencyInfo", Type = "QuestRequiredCurrencyInfo", Nilable = true }, + }, + }, + { + Name = "GetQuestRewardCurrencyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questInfoType", Type = "cstring", Nilable = false }, + { Name = "questRewardIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questRewardCurrencyInfo", Type = "QuestRewardCurrencyInfo", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "QuestAcceptConfirm", + Type = "Event", + LiteralName = "QUEST_ACCEPT_CONFIRM", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "questTitle", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "QuestFinished", + Type = "Event", + LiteralName = "QUEST_FINISHED", + SynchronousEvent = true, + }, + { + Name = "QuestGreeting", + Type = "Event", + LiteralName = "QUEST_GREETING", + SynchronousEvent = true, + }, + { + Name = "QuestItemUpdate", + Type = "Event", + LiteralName = "QUEST_ITEM_UPDATE", + SynchronousEvent = true, + }, + { + Name = "QuestProgress", + Type = "Event", + LiteralName = "QUEST_PROGRESS", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "QuestRequiredCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "requiredAmount", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestOffer); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c1716fb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestRewardsDocumentation.lua.annotated.lua @@ -0,0 +1,48 @@ +local QuestRewards = +{ + Tables = + { + { + Name = "QuestRewardCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "baseRewardAmount", Type = "number", Nilable = false }, + { Name = "bonusRewardAmount", Type = "number", Nilable = false }, + { Name = "totalRewardAmount", Type = "number", Nilable = false }, + { Name = "questRewardContextFlags", Type = "QuestRewardContextFlags", Nilable = true }, + }, + }, + { + Name = "QuestRewardReputationInfo", + Type = "Structure", + Fields = + { + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "rewardAmount", Type = "number", Nilable = false }, + }, + }, + { + Name = "QuestRewardSpellInfo", + Type = "Structure", + Fields = + { + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "garrFollowerID", Type = "number", Nilable = true }, + { Name = "isTradeskill", Type = "bool", Nilable = false }, + { Name = "isSpellLearned", Type = "bool", Nilable = false }, + { Name = "hideSpellLearnText", Type = "bool", Nilable = false }, + { Name = "isBoostSpell", Type = "bool", Nilable = false }, + { Name = "genericUnlock", Type = "bool", Nilable = false }, + { Name = "type", Type = "QuestCompleteSpellType", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestRewards); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..433d536 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,67 @@ +local QuestSessionConstants = +{ + Tables = + { + { + Name = "QuestSessionCommand", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "QuestSessionCommand", EnumValue = 0 }, + { Name = "Start", Type = "QuestSessionCommand", EnumValue = 1 }, + { Name = "Stop", Type = "QuestSessionCommand", EnumValue = 2 }, + { Name = "SessionActiveNoCommand", Type = "QuestSessionCommand", EnumValue = 3 }, + }, + }, + { + Name = "QuestSessionResult", + Type = "Enumeration", + NumValues = 35, + MinValue = 0, + MaxValue = 34, + Fields = + { + { Name = "Ok", Type = "QuestSessionResult", EnumValue = 0 }, + { Name = "NotInParty", Type = "QuestSessionResult", EnumValue = 1 }, + { Name = "InvalidOwner", Type = "QuestSessionResult", EnumValue = 2 }, + { Name = "AlreadyActive", Type = "QuestSessionResult", EnumValue = 3 }, + { Name = "NotActive", Type = "QuestSessionResult", EnumValue = 4 }, + { Name = "InRaid", Type = "QuestSessionResult", EnumValue = 5 }, + { Name = "OwnerRefused", Type = "QuestSessionResult", EnumValue = 6 }, + { Name = "Timeout", Type = "QuestSessionResult", EnumValue = 7 }, + { Name = "Disabled", Type = "QuestSessionResult", EnumValue = 8 }, + { Name = "Started", Type = "QuestSessionResult", EnumValue = 9 }, + { Name = "Stopped", Type = "QuestSessionResult", EnumValue = 10 }, + { Name = "Joined", Type = "QuestSessionResult", EnumValue = 11 }, + { Name = "Left", Type = "QuestSessionResult", EnumValue = 12 }, + { Name = "OwnerLeft", Type = "QuestSessionResult", EnumValue = 13 }, + { Name = "ReadyCheckFailed", Type = "QuestSessionResult", EnumValue = 14 }, + { Name = "PartyDestroyed", Type = "QuestSessionResult", EnumValue = 15 }, + { Name = "MemberTimeout", Type = "QuestSessionResult", EnumValue = 16 }, + { Name = "AlreadyMember", Type = "QuestSessionResult", EnumValue = 17 }, + { Name = "NotOwner", Type = "QuestSessionResult", EnumValue = 18 }, + { Name = "AlreadyOwner", Type = "QuestSessionResult", EnumValue = 19 }, + { Name = "AlreadyJoined", Type = "QuestSessionResult", EnumValue = 20 }, + { Name = "NotMember", Type = "QuestSessionResult", EnumValue = 21 }, + { Name = "Busy", Type = "QuestSessionResult", EnumValue = 22 }, + { Name = "JoinRejected", Type = "QuestSessionResult", EnumValue = 23 }, + { Name = "Logout", Type = "QuestSessionResult", EnumValue = 24 }, + { Name = "Empty", Type = "QuestSessionResult", EnumValue = 25 }, + { Name = "QuestNotCompleted", Type = "QuestSessionResult", EnumValue = 26 }, + { Name = "Resync", Type = "QuestSessionResult", EnumValue = 27 }, + { Name = "Restricted", Type = "QuestSessionResult", EnumValue = 28 }, + { Name = "InPetBattle", Type = "QuestSessionResult", EnumValue = 29 }, + { Name = "InvalidPublicParty", Type = "QuestSessionResult", EnumValue = 30 }, + { Name = "Unknown", Type = "QuestSessionResult", EnumValue = 31 }, + { Name = "InCombat", Type = "QuestSessionResult", EnumValue = 32 }, + { Name = "MemberInCombat", Type = "QuestSessionResult", EnumValue = 33 }, + { Name = "RestrictedCrossFaction", Type = "QuestSessionResult", EnumValue = 34 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestSessionConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a9b0289 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestSessionDocumentation.lua.annotated.lua @@ -0,0 +1,211 @@ +local QuestSession = +{ + Name = "QuestSession", + Type = "System", + Namespace = "C_QuestSession", + Environment = "All", + + Functions = + { + { + Name = "CanStart", + Type = "Function", + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanStop", + Type = "Function", + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Exists", + Type = "Function", + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAvailableSessionCommand", + Type = "Function", + + Returns = + { + { Name = "command", Type = "QuestSessionCommand", Nilable = false }, + }, + }, + { + Name = "GetPendingCommand", + Type = "Function", + + Returns = + { + { Name = "command", Type = "QuestSessionCommand", Nilable = false }, + }, + }, + { + Name = "GetProposedMaxLevelForSession", + Type = "Function", + + Returns = + { + { Name = "proposedMaxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSessionBeginDetails", + Type = "Function", + + Returns = + { + { Name = "details", Type = "QuestSessionPlayerDetails", Nilable = true }, + }, + }, + { + Name = "GetSuperTrackedQuest", + Type = "Function", + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + }, + { + Name = "HasJoined", + Type = "Function", + + Returns = + { + { Name = "hasJoined", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPendingCommand", + Type = "Function", + + Returns = + { + { Name = "hasPendingCommand", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestSessionStart", + Type = "Function", + }, + { + Name = "RequestSessionStop", + Type = "Function", + }, + { + Name = "SendSessionBeginResponse", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "beginSession", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetQuestIsSuperTracked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "superTrack", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "QuestSessionCreated", + Type = "Event", + LiteralName = "QUEST_SESSION_CREATED", + UniqueEvent = true, + }, + { + Name = "QuestSessionDestroyed", + Type = "Event", + LiteralName = "QUEST_SESSION_DESTROYED", + UniqueEvent = true, + }, + { + Name = "QuestSessionEnabledStateChanged", + Type = "Event", + LiteralName = "QUEST_SESSION_ENABLED_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestSessionJoined", + Type = "Event", + LiteralName = "QUEST_SESSION_JOINED", + UniqueEvent = true, + }, + { + Name = "QuestSessionLeft", + Type = "Event", + LiteralName = "QUEST_SESSION_LEFT", + UniqueEvent = true, + }, + { + Name = "QuestSessionMemberConfirm", + Type = "Event", + LiteralName = "QUEST_SESSION_MEMBER_CONFIRM", + SynchronousEvent = true, + }, + { + Name = "QuestSessionMemberStartResponse", + Type = "Event", + LiteralName = "QUEST_SESSION_MEMBER_START_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "response", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestSessionNotification", + Type = "Event", + LiteralName = "QUEST_SESSION_NOTIFICATION", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "QuestSessionResult", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "QuestSessionPlayerDetails", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestSession); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d5bf7e5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QuestTaskInfoDocumentation.lua.annotated.lua @@ -0,0 +1,204 @@ +local QuestTaskInfo = +{ + Name = "QuestTaskInfo", + Type = "System", + Namespace = "C_TaskQuest", + Environment = "All", + + Functions = + { + { + Name = "DoesMapShowTaskQuestObjectives", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "showsTaskQuestObjectives", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestInfoByQuestID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "questTitle", Type = "cstring", Nilable = false }, + { Name = "factionID", Type = "number", Nilable = true }, + { Name = "capped", Type = "bool", Nilable = true }, + { Name = "displayAsObjective", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetQuestLocation", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "locationX", Type = "number", Nilable = false }, + { Name = "locationY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestProgressBarInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestTimeLeftMinutes", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "minutesLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestTimeLeftSeconds", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "secondsLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestUIWidgetSetByType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "type", Type = "MapIconUIWidgetSetType", Nilable = false }, + }, + + Returns = + { + { Name = "widgetSet", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestZoneID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestsOnMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "taskPOIs", Type = "table", InnerType = "QuestPOIMapInfo", Nilable = false }, + }, + }, + { + Name = "GetThreatQuests", + Type = "Function", + + Returns = + { + { Name = "quests", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "IsActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestPreloadRewardData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(QuestTaskInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e1baf4a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/QueueSpecificDocumentation.lua.annotated.lua @@ -0,0 +1,25 @@ +local QueueSpecific = +{ + Tables = + { + { + Name = "QueueSpecificInfo", + Type = "Structure", + Fields = + { + { Name = "queueType", Type = "cstring", Nilable = false }, + { Name = "lfgIDs", Type = "table", InnerType = "number", Nilable = true }, + { Name = "lfgListID", Type = "number", Nilable = true }, + { Name = "activityID", Type = "number", Nilable = true }, + { Name = "battlefieldType", Type = "cstring", Nilable = true }, + { Name = "listID", Type = "number", Nilable = true }, + { Name = "mapName", Type = "cstring", Nilable = true }, + { Name = "rated", Type = "bool", Nilable = true }, + { Name = "isBrawl", Type = "bool", Nilable = true }, + { Name = "teamSize", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QueueSpecific); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua.annotated.lua new file mode 100644 index 0000000..43e2f45 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidLocksDocumentation.lua.annotated.lua @@ -0,0 +1,63 @@ +local RaidLocks = +{ + Name = "RaidLocks", + Type = "System", + Namespace = "C_RaidLocks", + Environment = "All", + + Functions = + { + { + Name = "GetRedirectedDifficultyID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "redirectedDifficultyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsEncounterComplete", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "difficultyID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "encounterIsComplete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRaidLockExtendFeatureEnabled", + Type = "Function", + + Returns = + { + { Name = "raidLockExtendFeatureEnabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(RaidLocks); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2482437 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RaidMarkersDocumentation.lua.annotated.lua @@ -0,0 +1,116 @@ +local RaidMarkers = +{ + Name = "RaidMarkers", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CanBeRaidTarget", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearRaidMarker", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "raidMarkerIndex", Type = "luaIndex", Nilable = false, Default = MAX_RAID_MARKERS }, + }, + }, + { + Name = "GetRaidTargetIndex", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "IsRaidMarkerActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRaidMarkerSystemEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlaceRaidMarker", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "token", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "RemoveRaidTargets", + Type = "Function", + HasRestrictions = true, + Documentation = { "Removes all assigned raid target markers." }, + }, + { + Name = "SetRaidTarget", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "target", Type = "UnitToken", Nilable = false }, + { Name = "userIndex", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(RaidMarkers); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..484886c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,28 @@ +local RecentAlliesConstants = +{ + Tables = + { + { + Name = "RecentAllyPinResult", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Success", Type = "RecentAllyPinResult", EnumValue = 0 }, + { Name = "ServerError", Type = "RecentAllyPinResult", EnumValue = 1 }, + }, + }, + { + Name = "RecentAlliesConsts", + Type = "Constants", + Values = + { + { Name = "PIN_EXPIRATION_WARNING_DAYS", Type = "number", Value = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RecentAlliesConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..53310f6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecentAlliesDocumentation.lua.annotated.lua @@ -0,0 +1,288 @@ +local RecentAllies = +{ + Name = "RecentAllies", + Type = "System", + Namespace = "C_RecentAllies", + Environment = "All", + + Functions = + { + { + Name = "CanSetRecentAllyNote", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "canSetNote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRecentAllies", + Type = "Function", + RequiresRecentAllies = true, + + Returns = + { + { Name = "recentAlliesData", Type = "table", InnerType = "RecentAllyData", Nilable = false }, + }, + }, + { + Name = "GetRecentAllyByFullName", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fullCharacterName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "recentAllyData", Type = "RecentAllyData", Nilable = true }, + }, + }, + { + Name = "GetRecentAllyByGUID", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "recentAllyData", Type = "RecentAllyData", Nilable = true }, + }, + }, + { + Name = "IsRecentAllyByFullName", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fullCharacterName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isRecentAlly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecentAllyByGUID", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isRecentAlly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecentAllyDataReady", + Type = "Function", + RequiresRecentAllies = true, + + Returns = + { + { Name = "isReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecentAllyPinned", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isPinned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSystemEnabled", + Type = "Function", + + Returns = + { + { Name = "isRecentAllySystemEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSystemSupported", + Type = "Function", + + Returns = + { + { Name = "isRecentAllySystemSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRecentAllyNote", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "note", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetRecentAllyPinned", + Type = "Function", + RequiresRecentAllies = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + { Name = "isPinned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TryRequestRecentAlliesData", + Type = "Function", + RequiresRecentAllies = true, + HasRestrictions = true, + }, + }, + + Events = + { + { + Name = "LetRecentAlliesSeeLocationSettingUpdated", + Type = "Event", + LiteralName = "LET_RECENT_ALLIES_SEE_LOCATION_SETTING_UPDATED", + SynchronousEvent = true, + }, + { + Name = "RecentAlliesCacheUpdate", + Type = "Event", + LiteralName = "RECENT_ALLIES_CACHE_UPDATE", + UniqueEvent = true, + }, + { + Name = "RecentAlliesDataReady", + Type = "Event", + LiteralName = "RECENT_ALLIES_DATA_READY", + SynchronousEvent = true, + }, + { + Name = "RecentAlliesSystemStatusUpdated", + Type = "Event", + LiteralName = "RECENT_ALLIES_SYSTEM_STATUS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "RecentAllyDataUpdated", + Type = "Event", + LiteralName = "RECENT_ALLY_DATA_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "characterGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "RecentAllyCharacterData", + Type = "Structure", + Fields = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "fullName", Type = "string", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "raceID", Type = "number", Nilable = false }, + { Name = "sex", Type = "UnitSex", Nilable = false }, + }, + }, + { + Name = "RecentAllyData", + Type = "Structure", + Fields = + { + { Name = "stateData", Type = "RecentAllyStateData", Nilable = false }, + { Name = "characterData", Type = "RecentAllyCharacterData", Nilable = false }, + { Name = "interactionData", Type = "RecentAllyInteractionData", Nilable = false }, + }, + }, + { + Name = "RecentAllyInteraction", + Type = "Structure", + Fields = + { + { Name = "type", Type = "RolodexType", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "timestamp", Type = "time_t", Nilable = false }, + { Name = "contextData", Type = "RecentAllyInteractionContextData", Nilable = false }, + }, + }, + { + Name = "RecentAllyInteractionContextData", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "locationName", Type = "cstring", Nilable = true }, + { Name = "activityDifficultyID", Type = "number", Nilable = true }, + { Name = "activityDifficultyLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "RecentAllyInteractionData", + Type = "Structure", + Fields = + { + { Name = "interactions", Type = "table", InnerType = "RecentAllyInteraction", Nilable = false }, + { Name = "note", Type = "string", Nilable = true }, + }, + }, + { + Name = "RecentAllyStateData", + Type = "Structure", + Fields = + { + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "isDND", Type = "bool", Nilable = false }, + { Name = "isAFK", Type = "bool", Nilable = false }, + { Name = "pinExpirationDate", Type = "time_t", Nilable = true }, + { Name = "hasFriendRequestPending", Type = "bool", Nilable = false }, + { Name = "currentLocation", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RecentAllies); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e1dbc50 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendDocumentation.lua.annotated.lua @@ -0,0 +1,460 @@ +local RecruitAFriend = +{ + Name = "RecruitAFriend", + Type = "System", + Namespace = "C_RecruitAFriend", + Environment = "All", + + Functions = + { + { + Name = "CanSummonFriend", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClaimActivityReward", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "acceptanceID", Type = "RecruitAcceptanceID", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClaimNextReward", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rafVersion", Type = "RecruitAFriendRewardsVersion", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GenerateRecruitmentLink", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRAFInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "RafInfo", Nilable = false }, + }, + }, + { + Name = "GetRAFSystemInfo", + Type = "Function", + + Returns = + { + { Name = "systemInfo", Type = "RafSystemInfo", Nilable = false }, + }, + }, + { + Name = "GetRecruitActivityRequirementsText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "acceptanceID", Type = "RecruitAcceptanceID", Nilable = false }, + }, + + Returns = + { + { Name = "requirementsText", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "GetRecruitInfo", + Type = "Function", + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + { Name = "faction", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSummonFriendCooldown", + Type = "Function", + + Returns = + { + { Name = "startTimeSeconds", Type = "number", Nilable = false }, + { Name = "durationSeconds", Type = "number", Nilable = false }, + { Name = "enableCooldownTimer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecruitAFriendLinked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecruitingEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveRAFRecruit", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "wowAccountGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestUpdatedRecruitmentInfo", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SummonFriend", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "target", Type = "WOWGUID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "RafInfoUpdated", + Type = "Event", + LiteralName = "RAF_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "info", Type = "RafInfo", Nilable = false }, + }, + }, + { + Name = "RafRecruitingEnabledStatus", + Type = "Event", + LiteralName = "RAF_RECRUITING_ENABLED_STATUS", + SynchronousEvent = true, + Payload = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RafRewardClaimFailed", + Type = "Event", + LiteralName = "RAF_REWARD_CLAIM_FAILED", + SynchronousEvent = true, + }, + { + Name = "RafSystemEnabledStatus", + Type = "Event", + LiteralName = "RAF_SYSTEM_ENABLED_STATUS", + SynchronousEvent = true, + Payload = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RafSystemInfoUpdated", + Type = "Event", + LiteralName = "RAF_SYSTEM_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "systemInfo", Type = "RafSystemInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "RafRecruitActivityState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Incomplete", Type = "RafRecruitActivityState", EnumValue = 0 }, + { Name = "Complete", Type = "RafRecruitActivityState", EnumValue = 1 }, + { Name = "RewardClaimed", Type = "RafRecruitActivityState", EnumValue = 2 }, + }, + }, + { + Name = "RafRecruitSubStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Trial", Type = "RafRecruitSubStatus", EnumValue = 0 }, + { Name = "Active", Type = "RafRecruitSubStatus", EnumValue = 1 }, + { Name = "Inactive", Type = "RafRecruitSubStatus", EnumValue = 2 }, + }, + }, + { + Name = "RafRewardType", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Pet", Type = "RafRewardType", EnumValue = 0 }, + { Name = "Mount", Type = "RafRewardType", EnumValue = 1 }, + { Name = "Appearance", Type = "RafRewardType", EnumValue = 2 }, + { Name = "Title", Type = "RafRewardType", EnumValue = 3 }, + { Name = "GameTime", Type = "RafRewardType", EnumValue = 4 }, + { Name = "AppearanceSet", Type = "RafRewardType", EnumValue = 5 }, + { Name = "Illusion", Type = "RafRewardType", EnumValue = 6 }, + { Name = "Invalid", Type = "RafRewardType", EnumValue = 7 }, + }, + }, + { + Name = "RafAppearanceInfo", + Type = "Structure", + Fields = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RafAppearanceSetInfo", + Type = "Structure", + Fields = + { + { Name = "setID", Type = "number", Nilable = false }, + { Name = "setName", Type = "string", Nilable = false }, + { Name = "appearanceIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "RafIllusionInfo", + Type = "Structure", + Fields = + { + { Name = "spellItemEnchantmentID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RafInfo", + Type = "Structure", + Fields = + { + { Name = "versions", Type = "table", InnerType = "RafVersionInfo", Nilable = false }, + { Name = "recruitmentInfo", Type = "RafRecruitmentinfo", Nilable = true }, + { Name = "recruits", Type = "table", InnerType = "RafRecruit", Nilable = false }, + { Name = "claimInProgress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RafMonthCount", + Type = "Structure", + Fields = + { + { Name = "lifetimeMonths", Type = "number", Nilable = false }, + { Name = "spentMonths", Type = "number", Nilable = false }, + { Name = "availableMonths", Type = "number", Nilable = false }, + }, + }, + { + Name = "RafMountInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "mountID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RafPetInfo", + Type = "Structure", + Fields = + { + { Name = "creatureID", Type = "number", Nilable = false }, + { Name = "speciesID", Type = "number", Nilable = false }, + { Name = "displayID", Type = "number", Nilable = false }, + { Name = "speciesName", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "RafRecruit", + Type = "Structure", + Fields = + { + { Name = "bnetAccountID", Type = "number", Nilable = false }, + { Name = "wowAccountGUID", Type = "WOWGUID", Nilable = false }, + { Name = "battleTag", Type = "string", Nilable = false }, + { Name = "monthsRemaining", Type = "number", Nilable = false }, + { Name = "subStatus", Type = "RafRecruitSubStatus", Nilable = false }, + { Name = "acceptanceID", Type = "RecruitAcceptanceID", Nilable = false }, + { Name = "versionRecruited", Type = "RecruitAFriendRewardsVersion", Nilable = false }, + { Name = "activities", Type = "table", InnerType = "RafRecruitActivity", Nilable = false }, + }, + }, + { + Name = "RafRecruitActivity", + Type = "Structure", + Fields = + { + { Name = "activityID", Type = "number", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + { Name = "state", Type = "RafRecruitActivityState", Nilable = false }, + }, + }, + { + Name = "RafRecruitmentinfo", + Type = "Structure", + Fields = + { + { Name = "recruitmentCode", Type = "string", Nilable = false }, + { Name = "recruitmentURL", Type = "string", Nilable = false }, + { Name = "expireTime", Type = "number", Nilable = false }, + { Name = "remainingTimeSeconds", Type = "number", Nilable = false }, + { Name = "totalUses", Type = "number", Nilable = false }, + { Name = "remainingUses", Type = "number", Nilable = false }, + { Name = "sourceRealm", Type = "string", Nilable = false }, + { Name = "sourceFaction", Type = "string", Nilable = false }, + }, + }, + { + Name = "RafReward", + Type = "Structure", + Fields = + { + { Name = "rewardID", Type = "number", Nilable = false }, + { Name = "rafVersion", Type = "RecruitAFriendRewardsVersion", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "rewardType", Type = "RafRewardType", Nilable = false }, + { Name = "petInfo", Type = "RafPetInfo", Nilable = true }, + { Name = "mountInfo", Type = "RafMountInfo", Nilable = true }, + { Name = "appearanceInfo", Type = "RafAppearanceInfo", Nilable = true }, + { Name = "titleInfo", Type = "RafTitleInfo", Nilable = true }, + { Name = "appearanceSetInfo", Type = "RafAppearanceSetInfo", Nilable = true }, + { Name = "illusionInfo", Type = "RafIllusionInfo", Nilable = true }, + { Name = "canClaim", Type = "bool", Nilable = false }, + { Name = "claimed", Type = "bool", Nilable = false }, + { Name = "canAfford", Type = "bool", Nilable = false }, + { Name = "repeatable", Type = "bool", Nilable = false }, + { Name = "repeatableClaimCount", Type = "number", Nilable = false }, + { Name = "monthsRequired", Type = "number", Nilable = false }, + { Name = "monthCost", Type = "number", Nilable = false }, + { Name = "availableInMonths", Type = "number", Nilable = false }, + { Name = "iconID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "RafSystemInfo", + Type = "Structure", + Fields = + { + { Name = "maxRecruits", Type = "number", Nilable = false }, + { Name = "maxRecruitMonths", Type = "number", Nilable = false }, + { Name = "maxRecruitmentUses", Type = "number", Nilable = false }, + { Name = "daysInCycle", Type = "number", Nilable = false }, + }, + }, + { + Name = "RafTitleInfo", + Type = "Structure", + Fields = + { + { Name = "titleMaskID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RafVersionInfo", + Type = "Structure", + Fields = + { + { Name = "rafVersion", Type = "RecruitAFriendRewardsVersion", Nilable = false }, + { Name = "monthCount", Type = "RafMonthCount", Nilable = false }, + { Name = "rewards", Type = "table", InnerType = "RafReward", Nilable = false }, + { Name = "nextReward", Type = "RafReward", Nilable = true }, + { Name = "numAffordableRewards", Type = "number", Nilable = false }, + { Name = "numRecruits", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RecruitAFriend); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..78f28a3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RecruitAFriendSharedDocumentation.lua.annotated.lua @@ -0,0 +1,36 @@ +local RecruitAFriendShared = +{ + Tables = + { + { + Name = "RafLinkType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "RafLinkType", EnumValue = 0 }, + { Name = "Recruit", Type = "RafLinkType", EnumValue = 1 }, + { Name = "Friend", Type = "RafLinkType", EnumValue = 2 }, + { Name = "Both", Type = "RafLinkType", EnumValue = 3 }, + }, + }, + { + Name = "RecruitAFriendRewardsVersion", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "InvalidVersion", Type = "RecruitAFriendRewardsVersion", EnumValue = 0 }, + { Name = "UnusedVersionOne", Type = "RecruitAFriendRewardsVersion", EnumValue = 1 }, + { Name = "VersionTwo", Type = "RecruitAFriendRewardsVersion", EnumValue = 2 }, + { Name = "VersionThree", Type = "RecruitAFriendRewardsVersion", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RecruitAFriendShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dc1ea4e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RemixArtifactUIDocumentation.lua.annotated.lua @@ -0,0 +1,160 @@ +local RemixArtifactUI = +{ + Name = "RemixArtifactUI", + Type = "System", + Namespace = "C_RemixArtifactUI", + Environment = "All", + + Functions = + { + { + Name = "ClearRemixArtifactItem", + Type = "Function", + }, + { + Name = "GetAppearanceInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiCameraID", Type = "number", Nilable = false }, + { Name = "altHandUICameraID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetArtifactArtInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "artifactArtInfo", Type = "RemixArtifactArtInfo", Nilable = false }, + }, + }, + { + Name = "GetArtifactItemInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "altItemID", Type = "number", Nilable = true }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "altItemAppearanceID", Type = "number", Nilable = true }, + { Name = "altOnTop", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCurrArtifactItemID", + Type = "Function", + + Returns = + { + { Name = "reqitemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrItemSpecIndex", + Type = "Function", + + Returns = + { + { Name = "specIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetCurrTraitTreeID", + Type = "Function", + + Returns = + { + { Name = "traitTreeID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ItemInSlotIsRemixArtifact", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "invSlot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isRemixArtifact", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "RemixArtifactItemSpecsLoaded", + Type = "Event", + LiteralName = "REMIX_ARTIFACT_ITEM_SPECS_LOADED", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemixArtifactUpdate", + Type = "Event", + LiteralName = "REMIX_ARTIFACT_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "RemixArtifactAppearanceInfo", + Type = "Structure", + Fields = + { + { Name = "uiCameraID", Type = "number", Nilable = false }, + { Name = "altHandUICameraID", Type = "number", Nilable = true }, + }, + }, + { + Name = "RemixArtifactArtInfo", + Type = "Structure", + Fields = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "titleName", Type = "string", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false }, + { Name = "spellVisualKitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RemixArtifactInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "altItemID", Type = "number", Nilable = true }, + { Name = "artifactAppearanceID", Type = "number", Nilable = false }, + { Name = "appearanceModID", Type = "number", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "altItemAppearanceID", Type = "number", Nilable = true }, + { Name = "altOnTop", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RemixArtifactUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RenownConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RenownConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..20ef52b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RenownConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,42 @@ +local RenownConstants = +{ + Tables = + { + { + Name = "RenownRewardDisplayType", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "None", Type = "RenownRewardDisplayType", EnumValue = 0 }, + { Name = "Item", Type = "RenownRewardDisplayType", EnumValue = 1 }, + { Name = "Spell", Type = "RenownRewardDisplayType", EnumValue = 2 }, + { Name = "Mount", Type = "RenownRewardDisplayType", EnumValue = 3 }, + { Name = "Transmog", Type = "RenownRewardDisplayType", EnumValue = 4 }, + { Name = "TransmogSet", Type = "RenownRewardDisplayType", EnumValue = 5 }, + { Name = "TransmogIllusion", Type = "RenownRewardDisplayType", EnumValue = 6 }, + { Name = "Title", Type = "RenownRewardDisplayType", EnumValue = 7 }, + { Name = "GarrFollower", Type = "RenownRewardDisplayType", EnumValue = 8 }, + { Name = "Currency", Type = "RenownRewardDisplayType", EnumValue = 9 }, + }, + }, + { + Name = "RenownRewardsFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "Milestone", Type = "RenownRewardsFlags", EnumValue = 1 }, + { Name = "Capstone", Type = "RenownRewardsFlags", EnumValue = 2 }, + { Name = "Hidden", Type = "RenownRewardsFlags", EnumValue = 4 }, + { Name = "AccountUnlock", Type = "RenownRewardsFlags", EnumValue = 8 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RenownConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a2f6d5f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,151 @@ +local ReportSystemConstants = +{ + Tables = + { + { + Name = "ReportEvidenceType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Invalid", Type = "ReportEvidenceType", EnumValue = 0 }, + { Name = "HouseScreenshot", Type = "ReportEvidenceType", EnumValue = 1 }, + { Name = "HouseLayoutJson", Type = "ReportEvidenceType", EnumValue = 2 }, + }, + }, + { + Name = "ReportMajorCategory", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "InappropriateCommunication", Type = "ReportMajorCategory", EnumValue = 0 }, + { Name = "GameplaySabotage", Type = "ReportMajorCategory", EnumValue = 1 }, + { Name = "Cheating", Type = "ReportMajorCategory", EnumValue = 2 }, + { Name = "InappropriateName", Type = "ReportMajorCategory", EnumValue = 3 }, + { Name = "InappropriateDecor", Type = "ReportMajorCategory", EnumValue = 4 }, + }, + }, + { + Name = "ReportMinorCategory", + Type = "Enumeration", + NumValues = 20, + MinValue = 1, + MaxValue = 524288, + Fields = + { + { Name = "TextChat", Type = "ReportMinorCategory", EnumValue = 1 }, + { Name = "Boosting", Type = "ReportMinorCategory", EnumValue = 2 }, + { Name = "Spam", Type = "ReportMinorCategory", EnumValue = 4 }, + { Name = "Afk", Type = "ReportMinorCategory", EnumValue = 8 }, + { Name = "IntentionallyFeeding", Type = "ReportMinorCategory", EnumValue = 16 }, + { Name = "BlockingProgress", Type = "ReportMinorCategory", EnumValue = 32 }, + { Name = "Hacking", Type = "ReportMinorCategory", EnumValue = 64 }, + { Name = "Botting", Type = "ReportMinorCategory", EnumValue = 128 }, + { Name = "Advertisement", Type = "ReportMinorCategory", EnumValue = 256 }, + { Name = "BTag", Type = "ReportMinorCategory", EnumValue = 512 }, + { Name = "GroupName", Type = "ReportMinorCategory", EnumValue = 1024 }, + { Name = "CharacterName", Type = "ReportMinorCategory", EnumValue = 2048 }, + { Name = "GuildName", Type = "ReportMinorCategory", EnumValue = 4096 }, + { Name = "Description", Type = "ReportMinorCategory", EnumValue = 8192 }, + { Name = "Name", Type = "ReportMinorCategory", EnumValue = 16384 }, + { Name = "HarmfulToMinors", Type = "ReportMinorCategory", EnumValue = 32768 }, + { Name = "Disruption", Type = "ReportMinorCategory", EnumValue = 65536 }, + { Name = "TerroristAndViolentExtremistContent", Type = "ReportMinorCategory", EnumValue = 131072 }, + { Name = "ChildSexualExploitationAndAbuse", Type = "ReportMinorCategory", EnumValue = 262144 }, + { Name = "NeighborhoodName", Type = "ReportMinorCategory", EnumValue = 524288 }, + }, + }, + { + Name = "ReportSubComplaintTypes", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Inappropriate", Type = "ReportSubComplaintTypes", EnumValue = 0 }, + { Name = "Advertising", Type = "ReportSubComplaintTypes", EnumValue = 1 }, + }, + }, + { + Name = "ReportThrottleType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Invalid", Type = "ReportThrottleType", EnumValue = 0 }, + { Name = "General", Type = "ReportThrottleType", EnumValue = 1 }, + { Name = "Expensive", Type = "ReportThrottleType", EnumValue = 2 }, + }, + }, + { + Name = "ReportType", + Type = "Enumeration", + NumValues = 21, + MinValue = 0, + MaxValue = 20, + Fields = + { + { Name = "Chat", Type = "ReportType", EnumValue = 0 }, + { Name = "InWorld", Type = "ReportType", EnumValue = 1 }, + { Name = "ClubFinderPosting", Type = "ReportType", EnumValue = 2 }, + { Name = "ClubFinderApplicant", Type = "ReportType", EnumValue = 3 }, + { Name = "GroupFinderPosting", Type = "ReportType", EnumValue = 4 }, + { Name = "GroupFinderApplicant", Type = "ReportType", EnumValue = 5 }, + { Name = "ClubMember", Type = "ReportType", EnumValue = 6 }, + { Name = "GroupMember", Type = "ReportType", EnumValue = 7 }, + { Name = "Friend", Type = "ReportType", EnumValue = 8 }, + { Name = "Pet", Type = "ReportType", EnumValue = 9 }, + { Name = "BattlePet", Type = "ReportType", EnumValue = 10 }, + { Name = "Calendar", Type = "ReportType", EnumValue = 11 }, + { Name = "Mail", Type = "ReportType", EnumValue = 12 }, + { Name = "PvP", Type = "ReportType", EnumValue = 13 }, + { Name = "PvPScoreboard", Type = "ReportType", EnumValue = 14 }, + { Name = "PvPGroupMember", Type = "ReportType", EnumValue = 15 }, + { Name = "CraftingOrder", Type = "ReportType", EnumValue = 16 }, + { Name = "RecentAlly", Type = "ReportType", EnumValue = 17 }, + { Name = "HousingDecor", Type = "ReportType", EnumValue = 18 }, + { Name = "Neighborhood", Type = "ReportType", EnumValue = 19 }, + { Name = "NeighborhoodRoster", Type = "ReportType", EnumValue = 20 }, + }, + }, + { + Name = "ScreenshotSource", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Automatic", Type = "ScreenshotSource", EnumValue = 0 }, + { Name = "PlayerReport", Type = "ScreenshotSource", EnumValue = 1 }, + { Name = "Cheat", Type = "ScreenshotSource", EnumValue = 2 }, + }, + }, + { + Name = "SendReportResult", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Success", Type = "SendReportResult", EnumValue = 0 }, + { Name = "GeneralError", Type = "SendReportResult", EnumValue = 1 }, + { Name = "TooManyReports", Type = "SendReportResult", EnumValue = 2 }, + { Name = "RequiresChatLine", Type = "SendReportResult", EnumValue = 3 }, + { Name = "RequiresChatLineOrVoice", Type = "SendReportResult", EnumValue = 4 }, + { Name = "RequiresScreenshot", Type = "SendReportResult", EnumValue = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ReportSystemConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..70d7f93 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReportSystemDocumentation.lua.annotated.lua @@ -0,0 +1,180 @@ +local ReportSystem = +{ + Name = "ReportSystem", + Type = "System", + Namespace = "C_ReportSystem", + Environment = "All", + + Functions = + { + { + Name = "CanReportPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canReport", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanReportPlayerForLanguage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "canReport", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMajorCategoriesForReportType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reportType", Type = "ReportType", Nilable = false }, + }, + + Returns = + { + { Name = "majorCategories", Type = "table", InnerType = "ReportMajorCategory", Nilable = false }, + }, + }, + { + Name = "GetMajorCategoryString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "majorCategory", Type = "ReportMajorCategory", Nilable = false }, + }, + + Returns = + { + { Name = "majorCategoryString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetMinorCategoriesForReportTypeAndMajorCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reportType", Type = "ReportType", Nilable = false }, + { Name = "majorCategory", Type = "ReportMajorCategory", Nilable = false }, + }, + + Returns = + { + { Name = "minorCategories", Type = "table", InnerType = "ReportMinorCategory", Nilable = false }, + }, + }, + { + Name = "GetMinorCategoryString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "minorCategory", Type = "ReportMinorCategory", Nilable = false }, + }, + + Returns = + { + { Name = "minorCategoryString", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ReportServerLag", + Type = "Function", + }, + { + Name = "ReportStuckInCombat", + Type = "Function", + }, + { + Name = "RequiresScreenshotForReportType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reportType", Type = "ReportType", Nilable = false }, + { Name = "majorCategory", Type = "ReportMajorCategory", Nilable = false }, + }, + + Returns = + { + { Name = "requiresScreenshot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SendReport", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Not allowed to be called by addons" }, + + Arguments = + { + { Name = "reportInfo", Type = "ReportInfo", Mixin = "ReportInfoMixin", Nilable = false }, + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = true }, + }, + }, + { + Name = "SetScreenshotPreviewTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "TakeReportScreenshot", + Type = "Function", + }, + }, + + Events = + { + { + Name = "ReportPlayerResult", + Type = "Event", + LiteralName = "REPORT_PLAYER_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "SendReportResult", Nilable = false }, + { Name = "reportType", Type = "ReportType", Nilable = false }, + }, + }, + { + Name = "ReportScreenshotReady", + Type = "Event", + LiteralName = "REPORT_SCREENSHOT_READY", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ReportSystem); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2759b05 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ReputationInfoDocumentation.lua.annotated.lua @@ -0,0 +1,367 @@ +local ReputationInfo = +{ + Name = "ReputationInfo", + Type = "System", + Namespace = "C_Reputation", + Environment = "All", + + Functions = + { + { + Name = "AreLegacyReputationsShown", + Type = "Function", + + Returns = + { + { Name = "areLegacyReputationsShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CollapseAllFactionHeaders", + Type = "Function", + }, + { + Name = "CollapseFactionHeader", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ExpandAllFactionHeaders", + Type = "Function", + }, + { + Name = "ExpandFactionHeader", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetFactionDataByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "factionData", Type = "FactionData", Nilable = true }, + }, + }, + { + Name = "GetFactionDataByIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "factionData", Type = "FactionData", Nilable = true }, + }, + }, + { + Name = "GetFactionParagonInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currentValue", Type = "number", Nilable = false }, + { Name = "threshold", Type = "number", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + { Name = "hasRewardPending", Type = "bool", Nilable = false }, + { Name = "tooLowLevelForParagon", Type = "bool", Nilable = false }, + { Name = "paragonStorageLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildFactionData", + Type = "Function", + + Returns = + { + { Name = "guildFactionData", Type = "FactionData", Nilable = true }, + }, + }, + { + Name = "GetGuildRepExpirationTime", + Type = "Function", + + Returns = + { + { Name = "expirationTime", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNumFactions", + Type = "Function", + + Returns = + { + { Name = "numFactions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetReputationSortType", + Type = "Function", + + Returns = + { + { Name = "sortType", Type = "ReputationSortType", Nilable = false }, + }, + }, + { + Name = "GetSelectedFaction", + Type = "Function", + + Returns = + { + { Name = "selectedFactionSortIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetWatchedFactionData", + Type = "Function", + + Returns = + { + { Name = "watchedFactionData", Type = "FactionData", Nilable = true }, + }, + }, + { + Name = "IsAccountWideReputation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAccountWide", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFactionActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFactionParagon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "factionIsParagon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFactionParagonForCurrentPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currentPlayerHasParagon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMajorFaction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isMajorFaction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestFactionParagonPreloadRewardData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFactionActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + { Name = "setActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetLegacyReputationsShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "showLegacyReputations", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetReputationSortType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sortType", Type = "ReputationSortType", Nilable = false }, + }, + }, + { + Name = "SetSelectedFaction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetWatchedFactionByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetWatchedFactionByIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ToggleFactionAtWar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "factionSortIndex", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "FactionStandingChanged", + Type = "Event", + LiteralName = "FACTION_STANDING_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "updatedStanding", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ReputationSortType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "ReputationSortType", EnumValue = 0 }, + { Name = "Account", Type = "ReputationSortType", EnumValue = 1 }, + { Name = "Character", Type = "ReputationSortType", EnumValue = 2 }, + }, + }, + { + Name = "FactionData", + Type = "Structure", + Fields = + { + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "reaction", Type = "luaIndex", Nilable = false }, + { Name = "currentReactionThreshold", Type = "number", Nilable = false }, + { Name = "nextReactionThreshold", Type = "number", Nilable = false }, + { Name = "currentStanding", Type = "number", Nilable = false }, + { Name = "atWarWith", Type = "bool", Nilable = false }, + { Name = "canToggleAtWar", Type = "bool", Nilable = false }, + { Name = "isChild", Type = "bool", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "isHeaderWithRep", Type = "bool", Nilable = false }, + { Name = "isCollapsed", Type = "bool", Nilable = false }, + { Name = "isWatched", Type = "bool", Nilable = false }, + { Name = "hasBonusRepGain", Type = "bool", Nilable = false }, + { Name = "canSetInactive", Type = "bool", Nilable = false }, + { Name = "isAccountWide", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ReputationInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e4bf85b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ResearchInfoDocumentation.lua.annotated.lua @@ -0,0 +1,117 @@ +local ResearchInfo = +{ + Name = "ResearchInfo", + Type = "System", + Namespace = "C_ResearchInfo", + Environment = "All", + + Functions = + { + { + Name = "GetDigSitesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "digSites", Type = "table", InnerType = "DigSiteMapInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ArchaeologyClosed", + Type = "Event", + LiteralName = "ARCHAEOLOGY_CLOSED", + SynchronousEvent = true, + }, + { + Name = "ArchaeologyFindComplete", + Type = "Event", + LiteralName = "ARCHAEOLOGY_FIND_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "numFindsCompleted", Type = "number", Nilable = false }, + { Name = "totalFinds", Type = "number", Nilable = false }, + { Name = "researchBranchID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ArchaeologySurveyCast", + Type = "Event", + LiteralName = "ARCHAEOLOGY_SURVEY_CAST", + SynchronousEvent = true, + Payload = + { + { Name = "numFindsCompleted", Type = "number", Nilable = false }, + { Name = "totalFinds", Type = "number", Nilable = false }, + { Name = "researchBranchID", Type = "number", Nilable = false }, + { Name = "successfulFind", Type = "number", Nilable = false }, + }, + }, + { + Name = "ArchaeologyToggle", + Type = "Event", + LiteralName = "ARCHAEOLOGY_TOGGLE", + SynchronousEvent = true, + }, + { + Name = "ArtifactDigsiteComplete", + Type = "Event", + LiteralName = "ARTIFACT_DIGSITE_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "researchBranchID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ResearchArtifactComplete", + Type = "Event", + LiteralName = "RESEARCH_ARTIFACT_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ResearchArtifactDigSiteUpdated", + Type = "Event", + LiteralName = "RESEARCH_ARTIFACT_DIG_SITE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "ResearchArtifactUpdate", + Type = "Event", + LiteralName = "RESEARCH_ARTIFACT_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "DigSiteMapInfo", + Type = "Structure", + Fields = + { + { Name = "researchSiteID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "poiBlobID", Type = "number", Nilable = false }, + { Name = "textureIndex", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ResearchInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f339faf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,36 @@ +local RestrictedActionsConstants = +{ + Tables = + { + { + Name = "AddOnRestrictionState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Inactive", Type = "AddOnRestrictionState", EnumValue = 0, Documentation = { "State used when an addon restriction is not being enforced." } }, + { Name = "Activating", Type = "AddOnRestrictionState", EnumValue = 1, Documentation = { "State used during the dispatch of ADDON_RESTRICTION_STATE_CHANGED to infer that a restriction is about to become active, but won't be enforced until event dispatch has completed." } }, + { Name = "Active", Type = "AddOnRestrictionState", EnumValue = 2, Documentation = { "State used when an addon restriction is presently being enforced." } }, + }, + }, + { + Name = "AddOnRestrictionType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Combat", Type = "AddOnRestrictionType", EnumValue = 0, Documentation = { "The player is actively affecting combat." } }, + { Name = "Encounter", Type = "AddOnRestrictionType", EnumValue = 1, Documentation = { "The player is actively participating in an instance encounter." } }, + { Name = "ChallengeMode", Type = "AddOnRestrictionType", EnumValue = 2, Documentation = { "The player is in an active and incomplete challenge mode or mythic keystone dungeon." } }, + { Name = "PvPMatch", Type = "AddOnRestrictionType", EnumValue = 3, Documentation = { "The player is in an active and incomplete PvP match." } }, + { Name = "Map", Type = "AddOnRestrictionType", EnumValue = 4, Documentation = { "The player is on a map that applies addon restrictions." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RestrictedActionsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dc3ab61 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RestrictedActionsDocumentation.lua.annotated.lua @@ -0,0 +1,135 @@ +local RestrictedActions = +{ + Name = "RestrictedActions", + Type = "System", + Namespace = "C_RestrictedActions", + Environment = "All", + + Functions = + { + { + Name = "CheckAllowProtectedFunctions", + Type = "Function", + SecureHooksAllowed = false, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the calling context has permissions to call protected functions on the supplied object." }, + + Arguments = + { + { Name = "object", Type = "FrameScriptObject", Nilable = false }, + { Name = "silent", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, don't signal blocked action errors if protected function calls are disallowed." } }, + }, + + Returns = + { + { Name = "protectedFunctionsAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAddOnRestrictionState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the current state of an addon restriction type." }, + + Arguments = + { + { Name = "type", Type = "AddOnRestrictionType", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "AddOnRestrictionState", Nilable = false }, + }, + }, + { + Name = "InCombatLockdown", + Type = "Function", + Namespace = "", + + Returns = + { + { Name = "inCombatLockdown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAddOnRestrictionActive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if an addon restriction type is in an active state. Will always return false during dispatch of ADDON_RESTRICTION_STATE_CHANGED." }, + + Arguments = + { + { Name = "type", Type = "AddOnRestrictionType", Nilable = false }, + }, + + Returns = + { + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AddonActionBlocked", + Type = "Event", + LiteralName = "ADDON_ACTION_BLOCKED", + SynchronousEvent = true, + Payload = + { + { Name = "isTainted", Type = "cstring", Nilable = false }, + { Name = "function", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "AddonActionForbidden", + Type = "Event", + LiteralName = "ADDON_ACTION_FORBIDDEN", + SynchronousEvent = true, + Payload = + { + { Name = "isTainted", Type = "cstring", Nilable = false }, + { Name = "function", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "AddonRestrictionStateChanged", + Type = "Event", + LiteralName = "ADDON_RESTRICTION_STATE_CHANGED", + SynchronousEvent = true, + Documentation = { "Fired when the state of an addon restriction type is changing. This event is sequenced such that it will always be fired before a restriction becomes active, or after it is deactivated." }, + Payload = + { + { Name = "type", Type = "AddOnRestrictionType", Nilable = false }, + { Name = "state", Type = "AddOnRestrictionState", Nilable = false }, + }, + }, + { + Name = "MacroActionBlocked", + Type = "Event", + LiteralName = "MACRO_ACTION_BLOCKED", + SynchronousEvent = true, + Payload = + { + { Name = "function", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "MacroActionForbidden", + Type = "Event", + LiteralName = "MACRO_ACTION_FORBIDDEN", + SynchronousEvent = true, + Payload = + { + { Name = "function", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(RestrictedActions); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RolodexConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RolodexConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..22ed8bb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/RolodexConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,79 @@ +local RolodexConstants = +{ + Tables = + { + { + Name = "RolodexContextIDType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "RolodexContextIDType", EnumValue = 0 }, + { Name = "ItemID", Type = "RolodexContextIDType", EnumValue = 1 }, + { Name = "AreaID", Type = "RolodexContextIDType", EnumValue = 2 }, + { Name = "MapID", Type = "RolodexContextIDType", EnumValue = 3 }, + }, + }, + { + Name = "RolodexContextLevelType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "RolodexContextLevelType", EnumValue = 0 }, + { Name = "Difficulty", Type = "RolodexContextLevelType", EnumValue = 1 }, + { Name = "KeystoneLevel", Type = "RolodexContextLevelType", EnumValue = 2 }, + { Name = "DelveTier", Type = "RolodexContextLevelType", EnumValue = 3 }, + }, + }, + { + Name = "RolodexType", + Type = "Enumeration", + NumValues = 21, + MinValue = 0, + MaxValue = 20, + Fields = + { + { Name = "None", Type = "RolodexType", EnumValue = 0 }, + { Name = "PartyMember", Type = "RolodexType", EnumValue = 1 }, + { Name = "RaidMember", Type = "RolodexType", EnumValue = 2 }, + { Name = "Trade", Type = "RolodexType", EnumValue = 3 }, + { Name = "Whisper", Type = "RolodexType", EnumValue = 4 }, + { Name = "PublicOrderFilledByOther", Type = "RolodexType", EnumValue = 5 }, + { Name = "PublicOrderFilledByYou", Type = "RolodexType", EnumValue = 6 }, + { Name = "PersonalOrderFilledByOther", Type = "RolodexType", EnumValue = 7 }, + { Name = "PersonalOrderFilledByYou", Type = "RolodexType", EnumValue = 8 }, + { Name = "GuildOrderFilledByOther", Type = "RolodexType", EnumValue = 9 }, + { Name = "GuildOrderFilledByYou", Type = "RolodexType", EnumValue = 10 }, + { Name = "CreatureKill", Type = "RolodexType", EnumValue = 11 }, + { Name = "CompleteDungeon", Type = "RolodexType", EnumValue = 12 }, + { Name = "KillRaidBoss", Type = "RolodexType", EnumValue = 13 }, + { Name = "KillLfrBoss", Type = "RolodexType", EnumValue = 14 }, + { Name = "CompleteDelve", Type = "RolodexType", EnumValue = 15 }, + { Name = "CompleteArena", Type = "RolodexType", EnumValue = 16 }, + { Name = "CompleteBg", Type = "RolodexType", EnumValue = 17 }, + { Name = "Duel", Type = "RolodexType", EnumValue = 18 }, + { Name = "PetBattle", Type = "RolodexType", EnumValue = 19 }, + { Name = "PvPKill", Type = "RolodexType", EnumValue = 20 }, + }, + }, + { + Name = "RolodexTypeFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "RolodexTypeFlags", EnumValue = 0 }, + { Name = "HiddenFromHistory", Type = "RolodexTypeFlags", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RolodexConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..247f030 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScenarioInfoDocumentation.lua.annotated.lua @@ -0,0 +1,269 @@ +local ScenarioInfo = +{ + Name = "ScenarioInfo", + Type = "System", + Namespace = "C_ScenarioInfo", + Environment = "All", + + Functions = + { + { + Name = "GetCriteriaInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "criteriaIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "scenarioCriteriaInfo", Type = "ScenarioCriteriaInfo", Nilable = false }, + }, + }, + { + Name = "GetCriteriaInfoByStep", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "stepID", Type = "number", Nilable = false }, + { Name = "criteriaIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "scenarioCriteriaInfo", Type = "ScenarioCriteriaInfo", Nilable = false }, + }, + }, + { + Name = "GetJailersTowerTypeString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "runType", Type = "JailersTowerType", Nilable = false }, + }, + + Returns = + { + { Name = "typeString", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetScenarioInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "scenarioInfo", Type = "ScenarioInformation", Nilable = false }, + }, + }, + { + Name = "GetScenarioStepInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scenarioStepID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "scenarioStepInfo", Type = "ScenarioStepInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "JailersTowerLevelUpdate", + Type = "Event", + LiteralName = "JAILERS_TOWER_LEVEL_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "level", Type = "number", Nilable = false }, + { Name = "type", Type = "JailersTowerType", Nilable = false }, + }, + }, + { + Name = "ScenarioBonusObjectiveComplete", + Type = "Event", + LiteralName = "SCENARIO_BONUS_OBJECTIVE_COMPLETE", + SynchronousEvent = true, + Payload = + { + { Name = "bonusObjectiveID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioBonusVisibilityUpdate", + Type = "Event", + LiteralName = "SCENARIO_BONUS_VISIBILITY_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ScenarioCompleted", + Type = "Event", + LiteralName = "SCENARIO_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "questID", Type = "number", Nilable = true }, + { Name = "xp", Type = "number", Nilable = true }, + { Name = "money", Type = "number", Nilable = true }, + }, + }, + { + Name = "ScenarioCriteriaShowStateUpdate", + Type = "Event", + LiteralName = "SCENARIO_CRITERIA_SHOW_STATE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ScenarioCriteriaUpdate", + Type = "Event", + LiteralName = "SCENARIO_CRITERIA_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "criteriaID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioPoiUpdate", + Type = "Event", + LiteralName = "SCENARIO_POI_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ScenarioSpellUpdate", + Type = "Event", + LiteralName = "SCENARIO_SPELL_UPDATE", + SynchronousEvent = true, + }, + { + Name = "ScenarioUpdate", + Type = "Event", + LiteralName = "SCENARIO_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "newStep", Type = "bool", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "JailersTowerType", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "TwistingCorridors", Type = "JailersTowerType", EnumValue = 0 }, + { Name = "SkoldusHalls", Type = "JailersTowerType", EnumValue = 1 }, + { Name = "FractureChambers", Type = "JailersTowerType", EnumValue = 2 }, + { Name = "Soulforges", Type = "JailersTowerType", EnumValue = 3 }, + { Name = "Coldheart", Type = "JailersTowerType", EnumValue = 4 }, + { Name = "Mortregar", Type = "JailersTowerType", EnumValue = 5 }, + { Name = "UpperReaches", Type = "JailersTowerType", EnumValue = 6 }, + { Name = "ArkobanHall", Type = "JailersTowerType", EnumValue = 7 }, + { Name = "TormentChamberJaina", Type = "JailersTowerType", EnumValue = 8 }, + { Name = "TormentChamberThrall", Type = "JailersTowerType", EnumValue = 9 }, + { Name = "TormentChamberAnduin", Type = "JailersTowerType", EnumValue = 10 }, + { Name = "AdamantVaults", Type = "JailersTowerType", EnumValue = 11 }, + { Name = "ForgottenCatacombs", Type = "JailersTowerType", EnumValue = 12 }, + { Name = "Ossuary", Type = "JailersTowerType", EnumValue = 13 }, + { Name = "BossRush", Type = "JailersTowerType", EnumValue = 14 }, + }, + }, + { + Name = "ScenarioCriteriaInfo", + Type = "Structure", + Fields = + { + { Name = "description", Type = "string", Nilable = false }, + { Name = "criteriaType", Type = "number", Nilable = false, Default = 0 }, + { Name = "completed", Type = "bool", Nilable = false, Default = false }, + { Name = "quantity", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalQuantity", Type = "number", Nilable = false, Default = 0 }, + { Name = "flags", Type = "number", Nilable = false, Default = 0 }, + { Name = "assetID", Type = "number", Nilable = false, Default = 0 }, + { Name = "criteriaID", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false, Default = 0 }, + { Name = "elapsed", Type = "number", Nilable = false, Default = 0 }, + { Name = "failed", Type = "bool", Nilable = false, Default = false }, + { Name = "isWeightedProgress", Type = "bool", Nilable = false, Default = false }, + { Name = "isFormatted", Type = "bool", Nilable = false, Default = false }, + { Name = "quantityString", Type = "string", Nilable = false }, + }, + }, + { + Name = "ScenarioInformation", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "currentStage", Type = "number", Nilable = false }, + { Name = "numStages", Type = "number", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + { Name = "isComplete", Type = "bool", Nilable = false }, + { Name = "xp", Type = "number", Nilable = false }, + { Name = "money", Type = "number", Nilable = false }, + { Name = "type", Type = "number", Nilable = false }, + { Name = "area", Type = "string", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "scenarioID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioStepInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "numCriteria", Type = "number", Nilable = false }, + { Name = "stepFailed", Type = "bool", Nilable = false }, + { Name = "isBonusStep", Type = "bool", Nilable = false }, + { Name = "isForCurrentStepOnly", Type = "bool", Nilable = false }, + { Name = "shouldShowBonusObjective", Type = "bool", Nilable = false }, + { Name = "spells", Type = "table", InnerType = "ScenarioStepSpellInfo", Nilable = false }, + { Name = "weightedProgress", Type = "number", Nilable = true }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + { Name = "widgetSetID", Type = "number", Nilable = true }, + { Name = "stepID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioStepSpellInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ScenarioInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1bd5d38 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScrappingMachineUIDocumentation.lua.annotated.lua @@ -0,0 +1,137 @@ +local ScrappingMachineUI = +{ + Name = "ScrappingMachineUI", + Type = "System", + Namespace = "C_ScrappingMachineUI", + Environment = "All", + + Functions = + { + { + Name = "CloseScrappingMachine", + Type = "Function", + }, + { + Name = "DropPendingScrapItemFromCursor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentPendingScrapItemLocationByIndex", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemLoc", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "GetScrapSpellID", + Type = "Function", + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScrappingMachineName", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "HasScrappableItems", + Type = "Function", + + Returns = + { + { Name = "hasScrappableItems", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveAllScrapItems", + Type = "Function", + }, + { + Name = "RemoveCurrentScrappingItem", + Type = "Function", + }, + { + Name = "RemoveItemToScrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScrapItems", + Type = "Function", + }, + { + Name = "ValidateScrappingList", + Type = "Function", + }, + }, + + Events = + { + { + Name = "ScrappingMachineItemAdded", + Type = "Event", + LiteralName = "SCRAPPING_MACHINE_ITEM_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScrappingMachineItemRemoved", + Type = "Event", + LiteralName = "SCRAPPING_MACHINE_ITEM_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScrappingMachinePendingItemChanged", + Type = "Event", + LiteralName = "SCRAPPING_MACHINE_PENDING_ITEM_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ScrappingMachineScrappingFinished", + Type = "Event", + LiteralName = "SCRAPPING_MACHINE_SCRAPPING_FINISHED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ScrappingMachineUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6e36d39 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenDocumentation.lua.annotated.lua @@ -0,0 +1,66 @@ +local Screen = +{ + Name = "Screen", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetDefaultScale", + Type = "Function", + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPhysicalScreenSize", + Type = "Function", + + Returns = + { + { Name = "sizeX", Type = "number", Nilable = false }, + { Name = "sizeY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScreenDPIScale", + Type = "Function", + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScreenHeight", + Type = "Function", + + Returns = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScreenWidth", + Type = "Function", + + Returns = + { + { Name = "width", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Screen); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenLocationConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenLocationConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..40da0f4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScreenLocationConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,30 @@ +local ScreenLocationConstants = +{ + Tables = + { + { + Name = "ScreenLocationType", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "Center", Type = "ScreenLocationType", EnumValue = 0 }, + { Name = "Left", Type = "ScreenLocationType", EnumValue = 1 }, + { Name = "Right", Type = "ScreenLocationType", EnumValue = 2 }, + { Name = "Top", Type = "ScreenLocationType", EnumValue = 3 }, + { Name = "Bottom", Type = "ScreenLocationType", EnumValue = 4 }, + { Name = "TopLeft", Type = "ScreenLocationType", EnumValue = 5 }, + { Name = "TopRight", Type = "ScreenLocationType", EnumValue = 6 }, + { Name = "LeftOutside", Type = "ScreenLocationType", EnumValue = 7 }, + { Name = "RightOutside", Type = "ScreenLocationType", EnumValue = 8 }, + { Name = "LeftRight", Type = "ScreenLocationType", EnumValue = 9 }, + { Name = "TopBottom", Type = "ScreenLocationType", EnumValue = 10 }, + { Name = "LeftRightOutside", Type = "ScreenLocationType", EnumValue = 11 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ScreenLocationConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptRegionSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptRegionSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..0aa577a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptRegionSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local ScriptRegionShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ScriptRegionShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptWarningsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptWarningsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..132c695 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptWarningsDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local ScriptWarnings = +{ + Name = "ScriptWarnings", + Type = "System", + Namespace = "C_ScriptWarnings", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "LuaWarning", + Type = "Event", + LiteralName = "LUA_WARNING", + SynchronousEvent = true, + Payload = + { + { Name = "warningText", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ScriptWarnings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..21632e3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ScriptedAnimationsDocumentation.lua.annotated.lua @@ -0,0 +1,114 @@ +local ScriptedAnimations = +{ + Name = "ScriptedAnimations", + Type = "System", + Namespace = "C_ScriptedAnimations", + Environment = "All", + + Functions = + { + { + Name = "GetAllScriptedAnimationEffects", + Type = "Function", + + Returns = + { + { Name = "scriptedAnimationEffects", Type = "table", InnerType = "ScriptedAnimationEffect", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ScriptedAnimationsUpdate", + Type = "Event", + LiteralName = "SCRIPTED_ANIMATIONS_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "ScriptedAnimationBehavior", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "None", Type = "ScriptedAnimationBehavior", EnumValue = 0 }, + { Name = "TargetShake", Type = "ScriptedAnimationBehavior", EnumValue = 1 }, + { Name = "TargetKnockBack", Type = "ScriptedAnimationBehavior", EnumValue = 2 }, + { Name = "SourceRecoil", Type = "ScriptedAnimationBehavior", EnumValue = 3 }, + { Name = "SourceCollideWithTarget", Type = "ScriptedAnimationBehavior", EnumValue = 4 }, + { Name = "UIParentShake", Type = "ScriptedAnimationBehavior", EnumValue = 5 }, + }, + }, + { + Name = "ScriptedAnimationFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "UseTargetAsSource", Type = "ScriptedAnimationFlags", EnumValue = 1 }, + }, + }, + { + Name = "ScriptedAnimationTrajectory", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "AtSource", Type = "ScriptedAnimationTrajectory", EnumValue = 0 }, + { Name = "AtTarget", Type = "ScriptedAnimationTrajectory", EnumValue = 1 }, + { Name = "Straight", Type = "ScriptedAnimationTrajectory", EnumValue = 2 }, + { Name = "CurveLeft", Type = "ScriptedAnimationTrajectory", EnumValue = 3 }, + { Name = "CurveRight", Type = "ScriptedAnimationTrajectory", EnumValue = 4 }, + { Name = "CurveRandom", Type = "ScriptedAnimationTrajectory", EnumValue = 5 }, + { Name = "HalfwayBetween", Type = "ScriptedAnimationTrajectory", EnumValue = 6 }, + }, + }, + { + Name = "ScriptedAnimationEffect", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "visual", Type = "fileID", Nilable = false }, + { Name = "visualScale", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "trajectory", Type = "ScriptedAnimationTrajectory", Nilable = false }, + { Name = "yawRadians", Type = "number", Nilable = false }, + { Name = "pitchRadians", Type = "number", Nilable = false }, + { Name = "rollRadians", Type = "number", Nilable = false }, + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + { Name = "offsetZ", Type = "number", Nilable = false }, + { Name = "animation", Type = "number", Nilable = false }, + { Name = "animationSpeed", Type = "number", Nilable = false }, + { Name = "alpha", Type = "number", Nilable = false }, + { Name = "useTargetAsSource", Type = "bool", Nilable = false }, + { Name = "startBehavior", Type = "ScriptedAnimationBehavior", Nilable = true }, + { Name = "startSoundKitID", Type = "number", Nilable = true }, + { Name = "finishEffectID", Type = "number", Nilable = true }, + { Name = "finishBehavior", Type = "ScriptedAnimationBehavior", Nilable = true }, + { Name = "finishSoundKitID", Type = "number", Nilable = true }, + { Name = "startAlphaFade", Type = "number", Nilable = true }, + { Name = "startAlphaFadeDuration", Type = "number", Nilable = true }, + { Name = "endAlphaFade", Type = "number", Nilable = true }, + { Name = "endAlphaFadeDuration", Type = "number", Nilable = true }, + { Name = "animationStartOffset", Type = "number", Nilable = true }, + { Name = "loopingSoundKitID", Type = "number", Nilable = true }, + { Name = "particleOverrideScale", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ScriptedAnimations); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..54a51a6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonInfoDocumentation.lua.annotated.lua @@ -0,0 +1,39 @@ +local SeasonInfo = +{ + Name = "SeasonInfo", + Type = "System", + Namespace = "C_SeasonInfo", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentDisplaySeasonExpansion", + Type = "Function", + + Returns = + { + { Name = "expansionID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrentDisplaySeasonID", + Type = "Function", + + Returns = + { + { Name = "seasonID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SeasonInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e989e3c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SeasonsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,24 @@ +local SeasonsConstants = +{ + Tables = + { + { + Name = "SeasonID", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "NoSeason", Type = "SeasonID", EnumValue = 0 }, + { Name = "SeasonOfMastery", Type = "SeasonID", EnumValue = 1 }, + { Name = "SeasonOfDiscovery", Type = "SeasonID", EnumValue = 2 }, + { Name = "Hardcore", Type = "SeasonID", EnumValue = 3 }, + { Name = "Fresh", Type = "SeasonID", EnumValue = 11 }, + { Name = "FreshHardcore", Type = "SeasonID", EnumValue = 12 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SeasonsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretAspectConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretAspectConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..948b69c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretAspectConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local SecretAspectConstants = +{ + Tables = + { + { + Name = "SecretAspect", + Type = "Enumeration", + NumValues = 26, + MinValue = 1, + MaxValue = 524288, + Fields = + { + { Name = "ObjectDebug", Type = "SecretAspect", EnumValue = 1 }, + { Name = "ObjectName", Type = "SecretAspect", EnumValue = 1 }, + { Name = "ObjectType", Type = "SecretAspect", EnumValue = 1 }, + { Name = "ObjectSecrets", Type = "SecretAspect", EnumValue = 1 }, + { Name = "ObjectSecurity", Type = "SecretAspect", EnumValue = 1 }, + { Name = "Attributes", Type = "SecretAspect", EnumValue = 1 }, + { Name = "Hierarchy", Type = "SecretAspect", EnumValue = 1 }, + { Name = "ID", Type = "SecretAspect", EnumValue = 2 }, + { Name = "Toplevel", Type = "SecretAspect", EnumValue = 4 }, + { Name = "Text", Type = "SecretAspect", EnumValue = 8 }, + { Name = "SecureText", Type = "SecretAspect", EnumValue = 16 }, + { Name = "Shown", Type = "SecretAspect", EnumValue = 32 }, + { Name = "Scale", Type = "SecretAspect", EnumValue = 64 }, + { Name = "Alpha", Type = "SecretAspect", EnumValue = 128 }, + { Name = "FrameLevel", Type = "SecretAspect", EnumValue = 256 }, + { Name = "ScrollRange", Type = "SecretAspect", EnumValue = 512 }, + { Name = "Cursor", Type = "SecretAspect", EnumValue = 1024 }, + { Name = "VertexColor", Type = "SecretAspect", EnumValue = 2048 }, + { Name = "Desaturation", Type = "SecretAspect", EnumValue = 4096 }, + { Name = "TexCoords", Type = "SecretAspect", EnumValue = 8192 }, + { Name = "BarValue", Type = "SecretAspect", EnumValue = 16384 }, + { Name = "Cooldown", Type = "SecretAspect", EnumValue = 32768 }, + { Name = "Rotation", Type = "SecretAspect", EnumValue = 65536 }, + { Name = "MinimumWidth", Type = "SecretAspect", EnumValue = 131072 }, + { Name = "Padding", Type = "SecretAspect", EnumValue = 262144 }, + { Name = "CooldownStyle", Type = "SecretAspect", EnumValue = 524288 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SecretAspectConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9fc814c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicateAPIDocumentation.lua.annotated.lua @@ -0,0 +1,415 @@ +local SecretPredicateAPI = +{ + Name = "SecretUtil", + Type = "System", + Namespace = "C_Secrets", + Environment = "All", + Documentation = { "'How is it a secret if we can C it?'" }, + + Functions = + { + { + Name = "GetPowerTypeSecrecy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Queries the base secrecy for a power type." }, + + Arguments = + { + { Name = "powerType", Type = "PowerType", Nilable = false }, + }, + + Returns = + { + { Name = "secrecy", Type = "SecrecyLevel", Nilable = false }, + }, + }, + { + Name = "GetSpellAuraSecrecy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Queries the base secrecy for a spell if queried as an aura." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "secrecy", Type = "SecrecyLevel", Nilable = false }, + }, + }, + { + Name = "GetSpellCastSecrecy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Queries the base secrecy for a spell if queried as a cast." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "secrecy", Type = "SecrecyLevel", Nilable = false }, + }, + }, + { + Name = "GetSpellCooldownSecrecy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Queries the base secrecy for a spell if queried as a cooldown." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "secrecy", Type = "SecrecyLevel", Nilable = false }, + }, + }, + { + Name = "HasSecretRestrictions", + Type = "Function", + Documentation = { "Returns true if this client build has secret value restrictions enabled. If false, all APIs that are tagged as potentially returning secrets will never do so." }, + + Returns = + { + { Name = "hasSecretRestrictions", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldActionCooldownBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given action bar slot ID will produce secret values for cooldowns if queried." }, + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isCooldownSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldAurasBeSecret", + Type = "Function", + Documentation = { "Returns true if queries for aura data will generally produce secret values." }, + + Returns = + { + { Name = "hasSecretAuras", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldCooldownsBeSecret", + Type = "Function", + Documentation = { "Returns true if queries for cooldown data will generally produce secret values." }, + + Returns = + { + { Name = "hasSecretCooldowns", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldSpellAuraBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given spell identifier would, if applied as an aura, produce secret values when queried." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isAuraSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldSpellBookItemCooldownBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given spellbook item will produce secret values for cooldowns if queried." }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isCooldownSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldSpellCooldownBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given spell identifier will produce secret values for cooldowns if queried." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isCooldownSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldTotemSlotBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if information about a totem slot will produce secret values if queried." }, + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isTotemSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldTotemSpellBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if information about a spell when associated with a totem slot will produce secret values if queried." }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTotemSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitAuraIndexBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given aura index will produce secret values if queried." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "isAuraSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitAuraInstanceBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given aura instance ID will produce secret values if queried." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAuraSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitAuraSlotBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a given aura slot ID will produce secret values if queried." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAuraSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitComparisonBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries that compare units will produce secret values." }, + + Arguments = + { + { Name = "unit1", Type = "UnitToken", Nilable = false }, + { Name = "unit2", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isUnitComparisonSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitHealthMaxBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for maximum unit health will produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isUnitHealthMaxSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitIdentityBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for unit identity (such as name or GUID) will produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isUnitIdentitySecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitPowerBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for unit power will produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + }, + + Returns = + { + { Name = "isUnitPowerSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitPowerMaxBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for maximum unit power will produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + }, + + Returns = + { + { Name = "isUnitPowerMaxSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitSpellCastBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for spell casting information for a unit would produce secret values when queried." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isSpellCastSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitSpellCastingBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for spell casting information for a specific unit will generally produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isSpellCastingSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitThreatStateBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for unit threat status will produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "mobUnit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "isUnitThreatSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldUnitThreatValuesBeSecret", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if queries for unit threat values will produce secret values." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "mobUnit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isUnitThreatSecret", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SecretPredicateAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicatesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicatesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3de77b5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretPredicatesDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local SecretPredicates = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SecretPredicates); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretWrapperConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretWrapperConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..099b59e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecretWrapperConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local SecretWrapperConstants = +{ + Tables = + { + { + Name = "SecrecyLevel", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "NeverSecret", Type = "SecrecyLevel", EnumValue = 0, Documentation = { "Will never yield secret values when queried." } }, + { Name = "AlwaysSecret", Type = "SecrecyLevel", EnumValue = 1, Documentation = { "Will always yield secret values when queried." } }, + { Name = "ContextuallySecret", Type = "SecrecyLevel", EnumValue = 2, Documentation = { "May yield secret values when queried depending upon factors such as addon restriction states, unit disposition, etc." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SecretWrapperConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3b5e782 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SecureTransferDocumentation.lua.annotated.lua @@ -0,0 +1,115 @@ +local SecureTransfer = +{ + Name = "SecureTransfer", + Type = "System", + Namespace = "C_SecureTransfer", + Environment = "All", + + Functions = + { + { + Name = "AcceptTrade", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "Cancel", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "CompleteHousingPurchase", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "CompleteHousingVCPurchase", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "GetHousingPurchaseCost", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "totalCost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHousingVCPurchaseProductID", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "productID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMailInfo", + Type = "Function", + HasRestrictions = true, + + Returns = + { + { Name = "mailInfo", Type = "MailInfo", Nilable = false }, + }, + }, + { + Name = "SendMail", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + { + Name = "SecureTransferCancel", + Type = "Event", + LiteralName = "SECURE_TRANSFER_CANCEL", + SynchronousEvent = true, + }, + { + Name = "SecureTransferConfirmHousingPurchase", + Type = "Event", + LiteralName = "SECURE_TRANSFER_CONFIRM_HOUSING_PURCHASE", + SynchronousEvent = true, + }, + { + Name = "SecureTransferConfirmSendMail", + Type = "Event", + LiteralName = "SECURE_TRANSFER_CONFIRM_SEND_MAIL", + SynchronousEvent = true, + }, + { + Name = "SecureTransferConfirmTradeAccept", + Type = "Event", + LiteralName = "SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT", + SynchronousEvent = true, + }, + { + Name = "SecureTransferHousingCurrencyPurchaseConfirmation", + Type = "Event", + LiteralName = "SECURE_TRANSFER_HOUSING_CURRENCY_PURCHASE_CONFIRMATION", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "MailInfo", + Type = "Structure", + Fields = + { + { Name = "target", Type = "string", Nilable = false }, + { Name = "sendMoney", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SecureTransfer); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ee2b85d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SettingsUtilDocumentation.lua.annotated.lua @@ -0,0 +1,54 @@ +local SettingsUtil = +{ + Name = "SettingsUtil", + Type = "System", + Namespace = "C_SettingsUtil", + Environment = "All", + + Functions = + { + { + Name = "NotifySettingsLoaded", + Type = "Function", + }, + { + Name = "OpenSettingsPanel", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "openToCategoryID", Type = "number", Nilable = true }, + { Name = "scrollToElementName", Type = "stringView", Nilable = true }, + }, + }, + }, + + Events = + { + { + Name = "SettingsLoaded", + Type = "Event", + LiteralName = "SETTINGS_LOADED", + SynchronousEvent = true, + }, + { + Name = "SettingsPanelOpen", + Type = "Event", + LiteralName = "SETTINGS_PANEL_OPEN", + SynchronousEvent = true, + Payload = + { + { Name = "openToCategoryID", Type = "number", Nilable = true }, + { Name = "scrollToElementName", Type = "stringView", Nilable = true }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SettingsUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b271b9b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectModelLightDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local SharedScriptObjectModelLight = +{ + Tables = + { + { + Name = "ModelLight", + Type = "Structure", + Fields = + { + { Name = "omnidirectional", Type = "bool", Nilable = false, Default = false }, + { Name = "point", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false, Documentation = { "If this light is omnidirectional then point refers to a position, otherwise it refers to a direction" } }, + { Name = "ambientIntensity", Type = "number", Nilable = false, Default = 0 }, + { Name = "ambientColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + { Name = "diffuseIntensity", Type = "number", Nilable = false, Default = 0 }, + { Name = "diffuseColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SharedScriptObjectModelLight); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectNamePlateFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectNamePlateFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..64f1bbe --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectNamePlateFrameDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local SharedScriptObjectNamePlateFrame = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SharedScriptObjectNamePlateFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectUnitPositionFrameDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectUnitPositionFrameDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ac17963 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedScriptObjectUnitPositionFrameDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local SharedScriptObjectUnitPositionFrame = +{ + Tables = + { + { + Name = "PingTextureType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Center", Type = "PingTextureType", EnumValue = 0 }, + { Name = "Expand", Type = "PingTextureType", EnumValue = 1 }, + { Name = "Rotation", Type = "PingTextureType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SharedScriptObjectUnitPositionFrame); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..23f772c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsDocumentation.lua.annotated.lua @@ -0,0 +1,1115 @@ +local SharedTraits = +{ + Name = "SharedTraits", + Type = "System", + Namespace = "C_Traits", + Environment = "All", + + Functions = + { + { + Name = "CanEditConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the player can make changes to the specified talent config." }, + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + { Name = "errorMessage", Type = "cstring", Nilable = false, Documentation = { "If canEdit is false, this will be filled out with text explaining why the player can not make changes." } }, + }, + }, + { + Name = "CanPurchaseRank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "nodeEntryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canPurchase", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanRefundRank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canRefund", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CascadeRepurchaseRanks", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "entryID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearCascadeRepurchaseHistory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CloseTraitSystemInteraction", + Type = "Function", + }, + { + Name = "CommitConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConfigHasStagedChanges", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasChanges", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GenerateImportString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "importString", Type = "string", Nilable = false }, + }, + }, + { + Name = "GenerateInspectImportString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "target", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "importString", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetConditionInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "condID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "condInfo", Type = "TraitCondInfo", Nilable = false }, + }, + }, + { + Name = "GetConfigIDBySystemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "systemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConfigIDByTreeID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConfigInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "configInfo", Type = "TraitConfigInfo", Nilable = false }, + }, + }, + { + Name = "GetConfigVariationID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "systemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "variationID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConfigsByType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configType", Type = "TraitConfigType", Nilable = false }, + }, + + Returns = + { + { Name = "configIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetDefinitionInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "definitionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "definitionInfo", Type = "TraitDefinitionInfo", Nilable = false }, + }, + }, + { + Name = "GetEntryInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "entryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "entryInfo", Type = "TraitEntryInfo", Nilable = false }, + }, + }, + { + Name = "GetIncreasedTraitData", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "entryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemName", Type = "table", InnerType = "IncreasedTraitData", Nilable = false }, + }, + }, + { + Name = "GetLoadoutSerializationVersion", + Type = "Function", + + Returns = + { + { Name = "serializationVersion", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNodeCost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "costs", Type = "table", InnerType = "TraitCurrencyCost", Nilable = false }, + }, + }, + { + Name = "GetNodeInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeInfo", Type = "TraitNodeInfo", Nilable = false }, + }, + }, + { + Name = "GetStagedChanges", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns IDs of Trait Nodes with pending changes, grouped by the type of change; Returns nothing if there are no pending changes" }, + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeIDsWithPurchases", Type = "table", InnerType = "number", Nilable = false }, + { Name = "nodeIDsWithRefunds", Type = "table", InnerType = "number", Nilable = false }, + { Name = "nodeIDsWithSelectionSwaps", Type = "table", InnerType = "number", Nilable = false, Documentation = { "Selection nodes that had a previously committed selected entry, and now have a different selected entry pending" } }, + }, + }, + { + Name = "GetStagedChangesCost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "costs", Type = "table", InnerType = "TraitCurrencyCost", Nilable = false }, + }, + }, + { + Name = "GetSubTreeInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "subTreeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "subTreeInfo", Type = "TraitSubTreeInfo", Nilable = false }, + }, + }, + { + Name = "GetSystemIDByTreeID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "systemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTraitCurrencyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "traitCurrencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "flags", Type = "number", Nilable = false }, + { Name = "type", Type = "number", Nilable = false }, + { Name = "currencyTypesID", Type = "number", Nilable = true }, + { Name = "icon", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetTraitDescription", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "entryID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTraitSystemFlags", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "flags", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTraitSystemWidgetSetID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiWidgetSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTreeCurrencyInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "treeID", Type = "number", Nilable = false }, + { Name = "excludeStagedChanges", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "treeCurrencyInfo", Type = "table", InnerType = "TreeCurrencyInfo", Nilable = false }, + }, + }, + { + Name = "GetTreeHash", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetTreeInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "treeInfo", Type = "TraitTreeInfo", Nilable = false }, + }, + }, + { + Name = "GetTreeNodes", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a list of nodeIDs, sorted ascending, for a given treeID. Contains nodes for all class specializations." }, + + Arguments = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "HasValidInspectData", + Type = "Function", + + Returns = + { + { Name = "hasValidInspectData", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsReadyForCommit", + Type = "Function", + + Returns = + { + { Name = "isReadyForCommit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PurchaseAllRanks", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "ignoreCost", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PurchaseRank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RefundAllRanks", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RefundRank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "clearEdges", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetTree", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetTreeByCurrency", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "treeID", Type = "number", Nilable = false }, + { Name = "traitCurrencyID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RollbackConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSelection", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "nodeEntryID", Type = "number", Nilable = true }, + { Name = "clearEdges", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StageConfig", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TalentTestUnlearnSpells", + Type = "Function", + }, + { + Name = "TryPurchaseAllRanks", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TryPurchaseToNode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TryRefundToNode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "configID", Type = "number", Nilable = false }, + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "entryID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ConfigCommitFailed", + Type = "Event", + LiteralName = "CONFIG_COMMIT_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitCondInfoChanged", + Type = "Event", + LiteralName = "TRAIT_COND_INFO_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "condID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitConfigCreated", + Type = "Event", + LiteralName = "TRAIT_CONFIG_CREATED", + SynchronousEvent = true, + Payload = + { + { Name = "configInfo", Type = "TraitConfigInfo", Nilable = false }, + }, + }, + { + Name = "TraitConfigDeleted", + Type = "Event", + LiteralName = "TRAIT_CONFIG_DELETED", + SynchronousEvent = true, + Payload = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitConfigListUpdated", + Type = "Event", + LiteralName = "TRAIT_CONFIG_LIST_UPDATED", + SynchronousEvent = true, + }, + { + Name = "TraitConfigUpdated", + Type = "Event", + LiteralName = "TRAIT_CONFIG_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "configID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitNodeChanged", + Type = "Event", + LiteralName = "TRAIT_NODE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitNodeChangedPartial", + Type = "Event", + LiteralName = "TRAIT_NODE_CHANGED_PARTIAL", + SynchronousEvent = true, + Payload = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "info", Type = "TraitNodeInfoPartial", Nilable = false }, + }, + }, + { + Name = "TraitNodeEntryUpdated", + Type = "Event", + LiteralName = "TRAIT_NODE_ENTRY_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeEntryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitSubTreeChanged", + Type = "Event", + LiteralName = "TRAIT_SUB_TREE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "subTreeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitSystemInteractionStarted", + Type = "Event", + LiteralName = "TRAIT_SYSTEM_INTERACTION_STARTED", + SynchronousEvent = true, + Payload = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitSystemNpcClosed", + Type = "Event", + LiteralName = "TRAIT_SYSTEM_NPC_CLOSED", + SynchronousEvent = true, + }, + { + Name = "TraitTreeChanged", + Type = "Event", + LiteralName = "TRAIT_TREE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitTreeCurrencyInfoUpdated", + Type = "Event", + LiteralName = "TRAIT_TREE_CURRENCY_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TryPurchaseToNodePartialSuccess", + Type = "Event", + LiteralName = "TRY_PURCHASE_TO_NODE_PARTIAL_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "nodeFinishedOn", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "IncreasedTraitData", + Type = "Structure", + Fields = + { + { Name = "itemNameIncreasing", Type = "string", Nilable = false }, + { Name = "itemQualityIncreasing", Type = "ItemQuality", Nilable = false }, + { Name = "numPointsIncreased", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitCondInfo", + Type = "Structure", + Fields = + { + { Name = "condID", Type = "number", Nilable = false }, + { Name = "ranksGranted", Type = "number", Nilable = true }, + { Name = "isAlwaysMet", Type = "bool", Nilable = false }, + { Name = "isMet", Type = "bool", Nilable = false, Documentation = { "True if the source for the condition has been fulfilled." } }, + { Name = "isGate", Type = "bool", Nilable = false }, + { Name = "isSufficient", Type = "bool", Nilable = false, Documentation = { "True if meeting the requirements for the condition means any nodes using this condition are considered fulfilled if the condition is met." } }, + { Name = "type", Type = "number", Nilable = false, Documentation = { "The value from the TraitConditionType enum the condition uses." } }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "achievementID", Type = "number", Nilable = true }, + { Name = "specSetID", Type = "number", Nilable = true }, + { Name = "playerLevel", Type = "number", Nilable = true }, + { Name = "traitCurrencyID", Type = "number", Nilable = true }, + { Name = "spentAmountRequired", Type = "number", Nilable = true }, + { Name = "tooltipFormat", Type = "string", Nilable = true }, + { Name = "traitCondAccountElementID", Type = "number", Nilable = true }, + }, + }, + { + Name = "TraitConfigInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "type", Type = "TraitConfigType", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "treeIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "usesSharedActionBars", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TraitCurrencyCost", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitDefinitionInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "overrideName", Type = "string", Nilable = true }, + { Name = "overrideSubtext", Type = "string", Nilable = true }, + { Name = "overrideDescription", Type = "string", Nilable = true }, + { Name = "overrideIcon", Type = "number", Nilable = true }, + { Name = "overriddenSpellID", Type = "number", Nilable = true }, + { Name = "subType", Type = "TraitDefinitionSubType", Nilable = true }, + }, + }, + { + Name = "TraitEntryInfo", + Type = "Structure", + Fields = + { + { Name = "definitionID", Type = "number", Nilable = true, Documentation = { "Nil on SubTreeSelection Node Entries" } }, + { Name = "subTreeID", Type = "number", Nilable = true, Documentation = { "Populated only on SubTreeSelection Node Entries; This is the SubTree that is activated if this Entry is chosen" } }, + { Name = "type", Type = "TraitNodeEntryType", Nilable = false }, + { Name = "maxRanks", Type = "number", Nilable = false }, + { Name = "isAvailable", Type = "bool", Nilable = false }, + { Name = "isDisplayError", Type = "bool", Nilable = false, Documentation = { "True if this entry fails the TRAIT_CONDITION_TYPE_DISPLAY_ERROR condition check. Used to communicate a problem with the node to the player (e.g. A prerequisite node has not been purchased.) but will not prevent the player from spending points on the node." } }, + { Name = "conditionIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "TraitEntryRankInfo", + Type = "Structure", + Fields = + { + { Name = "entryID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitGateInfo", + Type = "Structure", + Fields = + { + { Name = "topLeftNodeID", Type = "number", Nilable = false }, + { Name = "conditionID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TraitNodeInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "posX", Type = "number", Nilable = false }, + { Name = "posY", Type = "number", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + { Name = "entryIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "entryIDsWithCommittedRanks", Type = "table", InnerType = "number", Nilable = false }, + { Name = "canPurchaseRank", Type = "bool", Nilable = false }, + { Name = "canRefundRank", Type = "bool", Nilable = false }, + { Name = "isAvailable", Type = "bool", Nilable = false }, + { Name = "isVisible", Type = "bool", Nilable = false }, + { Name = "isDisplayError", Type = "bool", Nilable = false, Documentation = { "True if this node fails the TRAIT_CONDITION_TYPE_DISPLAY_ERROR condition check. Used to communicate a problem with the node to the player (e.g. A prerequisite node has not been purchased.) but will not prevent the player from spending points on the node." } }, + { Name = "ranksPurchased", Type = "number", Nilable = false }, + { Name = "ranksIncreased", Type = "number", Nilable = false }, + { Name = "entryIDToRanksIncreased", Type = "LuaValueVariant", Nilable = false, Documentation = { "A map of the entry IDs on this node to the number of ranks increased. This covers all entries on the node, which is important in the case of selection nodes where we have more than one option that could be increased." } }, + { Name = "activeRank", Type = "number", Nilable = false }, + { Name = "currentRank", Type = "number", Nilable = false }, + { Name = "activeEntry", Type = "TraitEntryRankInfo", Nilable = true }, + { Name = "nextEntry", Type = "TraitEntryRankInfo", Nilable = true }, + { Name = "maxRanks", Type = "number", Nilable = false }, + { Name = "totalMaxRanks", Type = "number", Nilable = false }, + { Name = "type", Type = "TraitNodeType", Nilable = false }, + { Name = "visibleEdges", Type = "table", InnerType = "TraitOutEdgeInfo", Nilable = false }, + { Name = "meetsEdgeRequirements", Type = "bool", Nilable = false }, + { Name = "groupIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "conditionIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "isCascadeRepurchasable", Type = "bool", Nilable = false }, + { Name = "cascadeRepurchaseEntryID", Type = "number", Nilable = true }, + { Name = "subTreeID", Type = "number", Nilable = true, Documentation = { "The SubTree this Node belongs to; Nil if it is not part of a SubTree" } }, + { Name = "subTreeActive", Type = "bool", Nilable = true, Documentation = { "True if this node has a SubTreeID, and the SubTree is chosen or staged; May be nil if not part of a SubTree at all" } }, + }, + }, + { + Name = "TraitNodeInfoPartial", + Type = "Structure", + Fields = + { + { Name = "canPurchaseRank", Type = "bool", Nilable = true }, + { Name = "canRefundRank", Type = "bool", Nilable = true }, + { Name = "isAvailable", Type = "bool", Nilable = true }, + { Name = "isVisible", Type = "bool", Nilable = true }, + { Name = "ranksPurchased", Type = "number", Nilable = true }, + { Name = "activeRank", Type = "number", Nilable = true }, + { Name = "currentRank", Type = "number", Nilable = true }, + { Name = "meetsEdgeRequirements", Type = "bool", Nilable = true }, + { Name = "isCascadeRepurchasable", Type = "bool", Nilable = true }, + { Name = "activeEntryID", Type = "number", Nilable = true }, + { Name = "subTreeActive", Type = "bool", Nilable = true }, + }, + }, + { + Name = "TraitOutEdgeInfo", + Type = "Structure", + Fields = + { + { Name = "targetNode", Type = "number", Nilable = false }, + { Name = "type", Type = "number", Nilable = false }, + { Name = "visualStyle", Type = "number", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TraitSubTreeInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = true }, + { Name = "iconElementID", Type = "textureAtlas", Nilable = true }, + { Name = "traitCurrencyID", Type = "number", Nilable = true }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "subTreeSelectionNodeIDs", Type = "table", InnerType = "number", Nilable = false, Documentation = { "SubTreeSelectionNodes whose choice entries include this SubTree" } }, + { Name = "posX", Type = "number", Nilable = false, Documentation = { "Center X node position calculated from the posX values of all of this subTree's nodes" } }, + { Name = "posY", Type = "number", Nilable = false, Documentation = { "Topmost Y node position taken from the posY values of all of this subTree's nodes" } }, + }, + }, + { + Name = "TraitTreeInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "gates", Type = "table", InnerType = "TraitGateInfo", Nilable = false }, + { Name = "hideSingleRankNumbers", Type = "bool", Nilable = false }, + { Name = "rootNodeID", Type = "number", Nilable = true }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "titleText", Type = "string", Nilable = true }, + }, + }, + { + Name = "TreeCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "traitCurrencyID", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "maxQuantity", Type = "number", Nilable = true }, + { Name = "spent", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SharedTraits); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsEnumsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsEnumsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e8ea08d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SharedTraitsEnumsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local SharedTraitsEnums = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SharedTraitsEnums); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..15e40ac --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAPIDocumentation.lua.annotated.lua @@ -0,0 +1,461 @@ +local SimpleAnimAPI = +{ + Name = "SimpleAnimAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetDuration", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "durationSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetElapsed", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "elapsedSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEndDelay", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "delaySec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOrder", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "order", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetProgress", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRegionParent", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "region", Type = "CScriptObject", Nilable = false }, + }, + }, + { + Name = "GetScript", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "bindingType", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "script", Type = "luaFunction", Nilable = false }, + }, + }, + { + Name = "GetSmoothProgress", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSmoothing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "weights", Type = "SmoothingType", Nilable = false }, + }, + }, + { + Name = "GetStartDelay", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "delaySec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTarget", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "target", Type = "CScriptObject", Nilable = false }, + }, + }, + { + Name = "HasScript", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectType }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "hasScript", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HookScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "script", Type = "luaFunction", Nilable = false }, + { Name = "bindingType", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsDelaying", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isDelaying", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDone", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isDone", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPaused", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isPaused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlaying", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isPlaying", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStopped", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isStopped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Pause", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Play", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Restart", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetChildKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "childKey", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "durationSec", Type = "number", Nilable = false }, + { Name = "recomputeGroupDuration", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetEndDelay", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "delaySec", Type = "number", Nilable = false }, + { Name = "recomputeGroupDuration", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetOrder", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "newOrder", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetParent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "parent", Type = "SimpleAnimGroup", Nilable = false }, + { Name = "order", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetPlaying", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "play", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "script", Type = "luaFunction", Nilable = true }, + }, + }, + { + Name = "SetSmoothProgress", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "durationSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSmoothing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "weights", Type = "SmoothingType", Nilable = false }, + }, + }, + { + Name = "SetStartDelay", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "delaySec", Type = "number", Nilable = false }, + { Name = "recomputeGroupDuration", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetTarget", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "target", Type = "CScriptObject", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTargetKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "key", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTargetName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTargetParent", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Stop", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAlphaAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAlphaAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9a59828 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimAlphaAPIDocumentation.lua.annotated.lua @@ -0,0 +1,66 @@ +local SimpleAnimAlphaAPI = +{ + Name = "SimpleAnimAlphaAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetFromAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "normalizedAlpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetToAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "normalizedAlpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFromAlpha", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "normalizedAlpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetToAlpha", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "normalizedAlpha", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimAlphaAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimFlipBookAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimFlipBookAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dc725d6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimFlipBookAPIDocumentation.lua.annotated.lua @@ -0,0 +1,135 @@ +local SimpleAnimFlipBookAPI = +{ + Name = "SimpleAnimFlipBookAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetFlipBookColumns", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "columns", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFlipBookFrameHeight", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFlipBookFrameWidth", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "width", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFlipBookFrames", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "frames", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFlipBookRows", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "rows", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFlipBookColumns", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "columns", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFlipBookFrameHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFlipBookFrameWidth", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "width", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFlipBookFrames", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "frames", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFlipBookRows", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rows", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimFlipBookAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimGroupAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimGroupAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8469c44 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimGroupAPIDocumentation.lua.annotated.lua @@ -0,0 +1,357 @@ +local SimpleAnimGroupAPI = +{ + Name = "SimpleAnimGroupAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CreateAnimation", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "animationType", Type = "cstring", Nilable = true }, + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "anim", Type = "SimpleAnim", Nilable = false }, + }, + }, + { + Name = "Finish", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetAnimationSpeedMultiplier", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "animationSpeedMultiplier", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAnimations", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "anims", Type = "SimpleAnim", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetDuration", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "durationSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetElapsed", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "elapsedSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLoopState", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "loopState", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetLooping", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "loopType", Type = "LoopType", Nilable = false }, + }, + }, + { + Name = "GetProgress", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScript", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "bindingType", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "script", Type = "luaFunction", Nilable = false }, + }, + }, + { + Name = "HasScript", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectType }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "hasScript", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HookScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "script", Type = "luaFunction", Nilable = false }, + { Name = "bindingType", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsDone", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isDone", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPaused", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isPaused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPendingFinish", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isPendingFinish", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlaying", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isPlaying", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsReverse", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isReverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSetToFinalAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isSetToFinalAlpha", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Pause", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Play", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + { Name = "offset", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "RemoveAnimations", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Restart", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + { Name = "offset", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetAnimationSpeedMultiplier", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "animationSpeedMultiplier", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLooping", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "loopType", Type = "LoopType", Nilable = false }, + }, + }, + { + Name = "SetPlaying", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "play", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "script", Type = "luaFunction", Nilable = true }, + }, + }, + { + Name = "SetToFinalAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setToFinalAlpha", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Stop", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimGroupAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimPathAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimPathAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5bd151f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimPathAPIDocumentation.lua.annotated.lua @@ -0,0 +1,86 @@ +local SimpleAnimPathAPI = +{ + Name = "SimpleAnimPathAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CreateControlPoint", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + { Name = "order", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "point", Type = "SimpleControlPoint", Nilable = false }, + }, + }, + { + Name = "GetControlPoints", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "points", Type = "SimpleControlPoint", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetCurveType", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "curveType", Type = "CurveType", Nilable = false }, + }, + }, + { + Name = "GetMaxControlPointOrder", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxOrder", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCurveType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "curveType", Type = "CurveType", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimPathAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimRotationAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimRotationAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..454ee58 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimRotationAPIDocumentation.lua.annotated.lua @@ -0,0 +1,93 @@ +local SimpleAnimRotationAPI = +{ + Name = "SimpleAnimRotationAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetDegrees", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOrigin", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "originX", Type = "number", Nilable = false }, + { Name = "originY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRadians", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetDegrees", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetOrigin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "originX", Type = "number", Nilable = false }, + { Name = "originY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetRadians", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimRotationAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..29d7d09 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleAPIDocumentation.lua.annotated.lua @@ -0,0 +1,122 @@ +local SimpleAnimScaleAPI = +{ + Name = "SimpleAnimScaleAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetOrigin", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "originX", Type = "number", Nilable = false }, + { Name = "originY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scaleX", Type = "number", Nilable = false }, + { Name = "scaleY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScaleFrom", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scaleX", Type = "number", Nilable = false }, + { Name = "scaleY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScaleTo", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scaleX", Type = "number", Nilable = false }, + { Name = "scaleY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetOrigin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "originX", Type = "number", Nilable = false }, + { Name = "originY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scaleX", Type = "number", Nilable = false }, + { Name = "scaleY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetScaleFrom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scaleX", Type = "number", Nilable = false }, + { Name = "scaleY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetScaleTo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scaleX", Type = "number", Nilable = false }, + { Name = "scaleY", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimScaleAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleLineAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleLineAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..71565a6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimScaleLineAPIDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local SimpleAnimScaleLineAPI = +{ + Name = "SimpleAnimScaleLineAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimScaleLineAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTextureCoordTranslationAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTextureCoordTranslationAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4db7c6d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTextureCoordTranslationAPIDocumentation.lua.annotated.lua @@ -0,0 +1,45 @@ +local SimpleAnimTextureCoordTranslationAPI = +{ + Name = "SimpleAnimTextureCoordTranslationAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetU", Type = "number", Nilable = false }, + { Name = "offsetV", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetU", Type = "number", Nilable = false }, + { Name = "offsetV", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimTextureCoordTranslationAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6132783 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationAPIDocumentation.lua.annotated.lua @@ -0,0 +1,45 @@ +local SimpleAnimTranslationAPI = +{ + Name = "SimpleAnimTranslationAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimTranslationAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationLineAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationLineAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b21ca8d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimTranslationLineAPIDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local SimpleAnimTranslationLineAPI = +{ + Name = "SimpleAnimTranslationLineAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimTranslationLineAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimVertexColorAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimVertexColorAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..78a0dde --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimVertexColorAPIDocumentation.lua.annotated.lua @@ -0,0 +1,66 @@ +local SimpleAnimVertexColorAPI = +{ + Name = "SimpleAnimVertexColorAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetEndColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetStartColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "SetEndColor", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "SetStartColor", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimVertexColorAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimatableObjectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimatableObjectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c0ca846 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleAnimatableObjectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,57 @@ +local SimpleAnimatableObjectAPI = +{ + Name = "SimpleAnimatableObjectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CreateAnimationGroup", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "group", Type = "SimpleAnimGroup", Nilable = false }, + }, + }, + { + Name = "GetAnimationGroups", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "groups", Type = "SimpleAnimGroup", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "StopAnimating", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleAnimatableObjectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleBrowserAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleBrowserAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3b51c2f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleBrowserAPIDocumentation.lua.annotated.lua @@ -0,0 +1,122 @@ +local SimpleBrowserAPI = +{ + Name = "SimpleBrowserAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearFocus", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "CopyExternalLink", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "DeleteCookies", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "NavigateBack", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "NavigateForward", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "NavigateHome", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "urlType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "NavigateReload", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "NavigateStop", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "OpenExternalLink", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "OpenTicket", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFocus", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetZoom", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoom", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleBrowserAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleButtonAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleButtonAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4245064 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleButtonAPIDocumentation.lua.annotated.lua @@ -0,0 +1,487 @@ +local SimpleButtonAPI = +{ + Name = "SimpleButtonAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearDisabledTexture", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearHighlightTexture", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearNormalTexture", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearPushedTexture", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Click", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "button", Type = "cstring", Nilable = false, Default = "LeftButton" }, + { Name = "isDown", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "Disable", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "Enable", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "GetButtonState", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "buttonState", Type = "SimpleButtonStateToken", Nilable = false }, + }, + }, + { + Name = "GetDisabledFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetDisabledTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetFontString", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fontString", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "GetHighlightFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetHighlightTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetMotionScriptsWhileDisabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "motionScriptsWhileDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNormalFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetNormalTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetPushedTextOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetPushedTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetText", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetTextHeight", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetTextWidth", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterForClicks", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "buttons", Type = "ClickButton", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "RegisterForMouse", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "buttons", Type = "ClickButton", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "SetButtonState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "buttonState", Type = "SimpleButtonStateToken", Nilable = false }, + { Name = "lock", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetDisabledAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "SetDisabledFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetDisabledTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetEnabled", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetFontString", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontString", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "SetFormattedText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetHighlightAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + { Name = "blendMode", Type = "BlendMode", Nilable = true }, + }, + }, + { + Name = "SetHighlightFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetHighlightTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + { Name = "blendMode", Type = "BlendMode", Nilable = true }, + }, + }, + { + Name = "SetMotionScriptsWhileDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "motionScriptsWhileDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetNormalAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "SetNormalFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetNormalTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetPushedAtlas", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "SetPushedTextOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetPushedTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleButtonAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleCheckboxAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleCheckboxAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..20130ba --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleCheckboxAPIDocumentation.lua.annotated.lua @@ -0,0 +1,89 @@ +local SimpleCheckboxAPI = +{ + Name = "SimpleCheckboxAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetChecked", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCheckedTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetDisabledCheckedTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "SetChecked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checked", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetCheckedTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetDisabledCheckedTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleCheckboxAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleColorSelectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleColorSelectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6a0148e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleColorSelectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,243 @@ +local SimpleColorSelectAPI = +{ + Name = "SimpleColorSelectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearColorWheelTexture", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetColorAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetColorAlphaTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetColorAlphaThumbTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetColorHSV", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hsvX", Type = "number", Nilable = false }, + { Name = "hsvY", Type = "number", Nilable = false }, + { Name = "hsvZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetColorRGB", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "rgbR", Type = "number", Nilable = false }, + { Name = "rgbG", Type = "number", Nilable = false }, + { Name = "rgbB", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetColorValueTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetColorValueThumbTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetColorWheelTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetColorWheelThumbTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "SetColorAlpha", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetColorAlphaTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "SetColorAlphaThumbTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetColorHSV", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "hsvX", Type = "number", Nilable = false }, + { Name = "hsvY", Type = "number", Nilable = false }, + { Name = "hsvZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetColorRGB", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "rgbR", Type = "number", Nilable = false }, + { Name = "rgbG", Type = "number", Nilable = false }, + { Name = "rgbB", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetColorValueTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "SetColorValueThumbTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetColorWheelTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "SetColorWheelThumbTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "TextureAsset", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleColorSelectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleControlPointAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleControlPointAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d8ab96c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleControlPointAPIDocumentation.lua.annotated.lua @@ -0,0 +1,79 @@ +local SimpleControlPointAPI = +{ + Name = "SimpleControlPointAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetOrder", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "order", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "order", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetParent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "parent", Type = "SimplePathAnim", Nilable = false }, + { Name = "order", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleControlPointAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleEditBoxAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleEditBoxAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4beddf9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleEditBoxAPIDocumentation.lua.annotated.lua @@ -0,0 +1,952 @@ +local SimpleEditBoxAPI = +{ + Name = "SimpleEditBoxAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddHistoryLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ClearFocus", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearHighlightText", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearHistory", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Disable", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Enable", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetAltArrowKeyMode", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "altMode", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBlinkSpeed", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "cursorBlinkSpeedSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCursorPosition", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Cursor, Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "cursorPosition", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDisplayText", + Type = "Function", + MayReturnNothing = true, + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "displayText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetFont", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "fontHeight", Type = "uiUnit", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "GetFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetHighlightColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHistoryLines", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "numHistoryLines", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIndentedWordWrap", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isIndented", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetInputLanguage", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "language", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetJustifyH", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "GetJustifyV", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "GetMaxBytes", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxBytes", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxLetters", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxLetters", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumLetters", + Type = "Function", + MayReturnNothing = true, + + Arguments = + { + }, + + Returns = + { + { Name = "numLetters", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumLines", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "lines", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumber", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "number", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetShadowColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShadowOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpacing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fontHeight", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetText", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetTextColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTextInsets", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetUTF8CursorPosition", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Cursor, Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "cursorPosition", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVisibleTextByteLimit", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxVisibleBytes", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasFocus", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hasFocus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasText", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hasText", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HighlightText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "start", Type = "number", Nilable = false, Default = 0 }, + { Name = "stop", Type = "number", Nilable = false, Default = -1 }, + }, + }, + { + Name = "Insert", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "IsAlphabeticOnly", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoFocus", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "autoFocus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCountInvisibleLetters", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "countInvisibleLetters", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInIMECompositionMode", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isInIMECompositionMode", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMultiLine", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "multiline", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNumeric", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isNumeric", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNumericFullRange", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isNumeric", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPassword", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "isPassword", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSecureText", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.SecureText }, + + Arguments = + { + }, + + Returns = + { + { Name = "isSecure", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetInputMode", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetAlphabeticOnly", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetAltArrowKeyMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "altMode", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetAutoFocus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "autoFocus", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetBlinkSpeed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cursorBlinkSpeedSec", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCountInvisibleLetters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "countInvisibleLetters", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetCursorPosition", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Cursor }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cursorPosition", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetFocus", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetFont", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetHighlightColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetHistoryLines", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "numHistoryLines", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetIndentedWordWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isIndented", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetJustifyH", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "SetJustifyV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "SetMaxBytes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "maxBytes", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMaxLetters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "maxLetters", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMultiLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "multiline", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetNumber", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "number", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetNumeric", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isNumeric", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetNumericFullRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isNumeric", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetPassword", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isPassword", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetSecureText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.SecureText }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isSecure", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetSecurityDisablePaste", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetSecurityDisableSetText", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetShadowColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetShadowOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontHeight", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetTextColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetTextInsets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetVisibleTextByteLimit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "maxVisibleBytes", Type = "number", Nilable = false }, + }, + }, + { + Name = "ToggleInputLanguage", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleEditBoxAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..07b0b19 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontAPIDocumentation.lua.annotated.lua @@ -0,0 +1,319 @@ +local SimpleFontAPI = +{ + Name = "SimpleFontAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CopyFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceFont", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "alpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "GetFont", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "GetFontHeight", + Type = "Function", + Documentation = { "Return is either in uiUnits or internal height due to fixedHeight." }, + + Arguments = + { + }, + + Returns = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetFontObjectForAlphabet", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alphabet", Type = "FontAlphabet", Nilable = false }, + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetIndentedWordWrap", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "wordWrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetJustifyH", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "GetJustifyV", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "GetShadowColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShadowOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpacing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetTextColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "SetFont", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "SetFontHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Preserves all flags, does correct height conversion due to fixedHeight." }, + + Arguments = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetIndentedWordWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "wordWrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetJustifyH", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "SetJustifyV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "SetShadowColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetShadowOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetTextColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleFontAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontStringAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontStringAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..917006e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFontStringAPIDocumentation.lua.annotated.lua @@ -0,0 +1,683 @@ +local SimpleFontStringAPI = +{ + Name = "SimpleFontStringAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CalculateScreenAreaFromCharacterSpan", + Type = "Function", + RequiresFontStringTextAccess = true, + SecretWhenAnchoringSecret = true, + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "leftIndex", Type = "luaIndex", Nilable = false }, + { Name = "rightIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "areas", Type = "table", InnerType = "uiBoundsRect", Nilable = true }, + }, + }, + { + Name = "CanNonSpaceWrap", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "wrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanWordWrap", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "wrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearAlphaGradient", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearText", + Type = "Function", + Documentation = { "Sets text to an empty string and removes the Text secret aspect." }, + + Arguments = + { + }, + }, + { + Name = "FindCharacterIndexAtCoordinate", + Type = "Function", + MayReturnNothing = true, + RequiresFontStringTextAccess = true, + SecretWhenAnchoringSecret = true, + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + + Returns = + { + { Name = "characterIndex", Type = "luaIndex", Nilable = false }, + { Name = "inside", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAlphaGradient", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "length", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFieldSize", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fieldSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFont", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fontFile", Type = "cstring", Nilable = true }, + { Name = "fontHeight", Type = "uiUnit", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "GetFontHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "calculated", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetIndentedWordWrap", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "wrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetJustifyH", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "GetJustifyV", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "GetLineHeight", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "lineHeight", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetMaxLines", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxLines", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumLines", + Type = "Function", + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "numLines", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRotation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScaleAnimationMode", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scaleAnimationMode", Type = "FontStringScaleAnimationMode", Nilable = false }, + }, + }, + { + Name = "GetShadowColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShadowOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpacing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetStringHeight", + Type = "Function", + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetStringWidth", + Type = "Function", + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetText", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetTextColor", + Type = "Function", + MayReturnNothing = true, + SecretReturnsForAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTextScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "textScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnboundedStringWidth", + Type = "Function", + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetWrappedWidth", + Type = "Function", + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "IsTruncated", + Type = "Function", + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "isTruncated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnColorsUpdated", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetAlphaGradient", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "length", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isWithinText", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFixedColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fixedColor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFont", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "fontHeight", Type = "uiUnit", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "SetFontHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetFormattedText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetIndentedWordWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "wrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetJustifyH", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "SetJustifyV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "SetMaxLines", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "maxLines", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetNonSpaceWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "wrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRotation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetScaleAnimationMode", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "scaleAnimationMode", Type = "FontStringScaleAnimationMode", Nilable = false }, + }, + }, + { + Name = "SetShadowColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetShadowOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + { + Name = "SetTextColor", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetTextHeight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetTextScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTextToFit", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + { + Name = "SetWordWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "wrap", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleFontStringAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..157540d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,1494 @@ +local SimpleFrameAPI = +{ + Name = "SimpleFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AbortDrag", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "CanChangeAttribute", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity }, + + Arguments = + { + }, + + Returns = + { + { Name = "canChangeAttributes", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearAlphaGradient", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearAttribute", + Type = "Function", + IsProtectedFunction = true, + SecretReturnsForAspect = { Enum.SecretAspect.Attributes }, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "attributeName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "cleared", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearAttributes", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "CreateFontString", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "drawLayer", Type = "DrawLayer", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "line", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "CreateLine", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "drawLayer", Type = "DrawLayer", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + { Name = "subLevel", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "line", Type = "SimpleLine", Nilable = false }, + }, + }, + { + Name = "CreateMaskTexture", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "drawLayer", Type = "DrawLayer", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + { Name = "subLevel", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "maskTexture", Type = "SimpleMaskTexture", Nilable = false }, + }, + }, + { + Name = "CreateTexture", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "drawLayer", Type = "DrawLayer", Nilable = true }, + { Name = "templateName", Type = "cstring", Nilable = true }, + { Name = "subLevel", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "DesaturateHierarchy", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "desaturation", Type = "number", Nilable = false }, + { Name = "excludeRoot", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "DisableDrawLayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + }, + }, + { + Name = "DoesClipChildren", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "clipsChildren", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesHyperlinkPropagateToParent", + Type = "Function", + Documentation = { "Returns whether hyperlink events (ex. OnHyperlinkEnter, OnHyperlinkLeave, OnHyperlinkClick) are propagated to this frame's parent." }, + + Arguments = + { + }, + + Returns = + { + { Name = "canPropagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EnableDrawLayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + }, + }, + { + Name = "EnableGamePadButton", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "EnableGamePadStick", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "EnableKeyboard", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "ExecuteAttribute", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Attributes }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "attributeName", Type = "cstring", Nilable = false }, + { Name = "arguments", Type = "cstring", Nilable = true, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "returns", Type = "cstring", Nilable = true, StrideIndex = 1 }, + }, + }, + { + Name = "GetAlpha", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Alpha }, + + Arguments = + { + }, + + Returns = + { + { Name = "alpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "GetAttribute", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Attributes }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "attributeName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetBoundsRect", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false, ConditionalSecret = true }, + { Name = "bottom", Type = "uiUnit", Nilable = false, ConditionalSecret = true }, + { Name = "width", Type = "uiUnit", Nilable = false, ConditionalSecret = true }, + { Name = "height", Type = "uiUnit", Nilable = false, ConditionalSecret = true }, + }, + }, + { + Name = "GetChildren", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + + Arguments = + { + }, + + Returns = + { + { Name = "children", Type = "SimpleFrame", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetClampRectInsets", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetDontSavePosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "dontSave", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetEffectiveAlpha", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Alpha }, + + Arguments = + { + }, + + Returns = + { + { Name = "effectiveAlpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "GetEffectiveScale", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Scale }, + + Arguments = + { + }, + + Returns = + { + { Name = "effectiveScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEffectivelyFlattensRenderLayers", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "flatten", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetFlattensRenderLayers", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "flatten", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetFrameLevel", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.FrameLevel }, + + Arguments = + { + }, + + Returns = + { + { Name = "frameLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFrameStrata", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "strata", Type = "FrameStrata", Nilable = false }, + }, + }, + { + Name = "GetHighestFrameLevel", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the highest framelevel of the frame and its first order children, or all children if iterateAllChildren is true." }, + + Arguments = + { + { Name = "iterateAllChildren", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "frameLevel", Type = "number", Nilable = false, ConditionalSecret = true }, + }, + }, + { + Name = "GetHitRectInsets", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetHyperlinksEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetID", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ID }, + + Arguments = + { + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumChildren", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + + Arguments = + { + }, + + Returns = + { + { Name = "numChildren", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumRegions", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + + Arguments = + { + }, + + Returns = + { + { Name = "numRegions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPropagateKeyboardInput", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "propagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRaisedFrameLevel", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "frameLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRegions", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + + Arguments = + { + }, + + Returns = + { + { Name = "regions", Type = "SimpleRegion", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetResizeBounds", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "minWidth", Type = "uiUnit", Nilable = false }, + { Name = "minHeight", Type = "uiUnit", Nilable = false }, + { Name = "maxWidth", Type = "uiUnit", Nilable = false }, + { Name = "maxHeight", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetScale", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Scale }, + + Arguments = + { + }, + + Returns = + { + { Name = "frameScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWindow", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "window", Type = "SimpleWindow", Nilable = false }, + }, + }, + { + Name = "HasAlphaGradient", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hasAlphaGradient", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFixedFrameLevel", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isFixed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasFixedFrameStrata", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isFixed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Hide", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "InterceptStartDrag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "delegate", Type = "SimpleFrame", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsClampedToScreen", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "clampedToScreen", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDrawLayerEnabled", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + }, + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEventRegistered", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isRegistered", Type = "bool", Nilable = false }, + { Name = "units", Type = "string", Nilable = true, StrideIndex = 1 }, + }, + }, + { + Name = "IsFrameBuffer", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isFrameBuffer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGamePadButtonEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGamePadStickEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHighlightLocked", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnoringChildrenForBounds", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnoringParentAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnoringParentScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsKeyboardEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMovable", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isMovable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsObjectLoaded", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsResizable", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "resizable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsShown", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Shown }, + + Arguments = + { + }, + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsToplevel", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Toplevel }, + + Arguments = + { + }, + + Returns = + { + { Name = "isTopLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUserPlaced", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isUserPlaced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingParentLevel", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "usingParentLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVisible", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Shown }, + + Arguments = + { + }, + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LockHighlight", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Lower", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "Raise", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "RegisterAllEvents", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "RegisterEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "registered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterEventCallback", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "cb", Type = "FrameEventCallbackType", Nilable = false }, + }, + + Returns = + { + { Name = "registered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterForDrag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "buttons", Type = "MouseButton", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "RegisterUnitEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "units", Type = "string", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "registered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterUnitEventCallback", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + { Name = "cb", Type = "FrameEventCallbackType", Nilable = false }, + { Name = "units", Type = "string", Nilable = false, StrideIndex = 1 }, + }, + + Returns = + { + { Name = "registered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RotateTextures", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false, Default = 0.5 }, + { Name = "y", Type = "number", Nilable = false, Default = 0.5 }, + }, + }, + { + Name = "SetAlpha", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "alpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "SetAlphaFromBoolean", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "value", Type = "bool", Nilable = false }, + { Name = "alphaIfTrue", Type = "SingleColorValue", Nilable = false, Default = 255 }, + { Name = "alphaIfFalse", Type = "SingleColorValue", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetAlphaGradient", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + { Name = "gradient", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "SetAttribute", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Attributes }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "attributeName", Type = "cstring", Nilable = false }, + { Name = "value", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetAttributeNoHandler", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Attributes }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "attributeName", Type = "cstring", Nilable = false }, + { Name = "value", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetClampRectInsets", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetClampedToScreen", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "clampedToScreen", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetClipsChildren", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clipsChildren", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDontSavePosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dontSave", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDrawLayerEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + { Name = "isEnabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetFixedFrameLevel", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isFixed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFixedFrameStrata", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isFixed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFlattensRenderLayers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flatten", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFrameLevel", + Type = "Function", + IsProtectedFunction = true, + SecretArgumentsAddAspect = { Enum.SecretAspect.FrameLevel }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "frameLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFrameStrata", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "strata", Type = "FrameStrata", Nilable = false }, + }, + }, + { + Name = "SetHighlightLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetHitRectInsets", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetHyperlinkPropagateToParent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Enables or disables propagating hyperlink events (ex. OnHyperlinkEnter, OnHyperlinkLeave, OnHyperlinkClick) to this frame's parent." }, + + Arguments = + { + { Name = "canPropagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetHyperlinksEnabled", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetID", + Type = "Function", + IsProtectedFunction = true, + SecretArgumentsAddAspect = { Enum.SecretAspect.ID }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetIgnoreParentAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetIgnoreParentScale", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetIgnoringChildrenForBounds", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetIsFrameBuffer", + Type = "Function", + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "isFrameBuffer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMovable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPropagateKeyboardInput", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "propagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetResizable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "resizable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetResizeBounds", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "minWidth", Type = "uiUnit", Nilable = false }, + { Name = "minHeight", Type = "uiUnit", Nilable = false }, + { Name = "maxWidth", Type = "uiUnit", Nilable = true }, + { Name = "maxHeight", Type = "uiUnit", Nilable = true }, + }, + }, + { + Name = "SetScale", + Type = "Function", + IsProtectedFunction = true, + SecretArgumentsAddAspect = { Enum.SecretAspect.Scale }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetShown", + Type = "Function", + IsProtectedFunction = true, + SecretArgumentsAddAspect = { Enum.SecretAspect.Shown }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "shown", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetToplevel", + Type = "Function", + IsProtectedFunction = true, + SecretArgumentsAddAspect = { Enum.SecretAspect.Toplevel }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "topLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetUserPlaced", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "userPlaced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetUsingParentLevel", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "usingParentLevel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetWindow", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "window", Type = "SimpleWindow", Nilable = true }, + }, + }, + { + Name = "Show", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "StartMoving", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alwaysStartFromMouse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "StartSizing", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "resizePoint", Type = "FramePoint", Nilable = true }, + { Name = "alwaysStartFromMouse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "StopMovingOrSizing", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "UnlockHighlight", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "UnregisterAllEvents", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "UnregisterEvent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "eventName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "registered", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "FrameEventCallbackType", + Type = "CallbackType", + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameScriptObjectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameScriptObjectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d17a612 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleFrameScriptObjectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,167 @@ +local SimpleFrameScriptObjectAPI = +{ + Name = "SimpleFrameScriptObjectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetName", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectName }, + + Arguments = + { + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetObjectType", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectType }, + + Arguments = + { + }, + + Returns = + { + { Name = "objectType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "HasAnySecretAspect", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecrets }, + + Arguments = + { + }, + + Returns = + { + { Name = "hasSecretAspect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSecretAspect", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecrets }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "aspect", Type = "SecretAspect", Nilable = false }, + }, + + Returns = + { + { Name = "hasSecretAspect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSecretValues", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecrets }, + + Arguments = + { + }, + + Returns = + { + { Name = "hasSecretValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsForbidden", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity }, + + Arguments = + { + }, + + Returns = + { + { Name = "isForbidden", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsObjectType", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectType }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "objectType", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isType", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPreventingSecretValues", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecrets }, + + Arguments = + { + }, + + Returns = + { + { Name = "isPreventingSecretValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetForbidden", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetPreventSecretValues", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "preventSecretValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetToDefaults", + Type = "Function", + IsProtectedFunction = true, + Documentation = { "Reset all script accessible values to their default values. If possible, clears secret states." }, + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleFrameScriptObjectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..23908d7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLAPIDocumentation.lua.annotated.lua @@ -0,0 +1,343 @@ +local SimpleHTMLAPI = +{ + Name = "SimpleHTMLAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetContentHeight", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetFont", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "GetFontObject", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetHyperlinkFormat", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "format", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetIndentedWordWrap", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "wordWrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetJustifyH", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "GetJustifyV", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "GetShadowColor", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShadowOffset", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpacing", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetTextColor", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTextData", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Text }, + + Arguments = + { + }, + + Returns = + { + { Name = "content", Type = "table", InnerType = "HTMLContentNode", Nilable = false }, + }, + }, + { + Name = "SetFont", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "SetFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetHyperlinkFormat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "format", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetIndentedWordWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "wordWrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetJustifyH", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "SetJustifyV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "SetShadowColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetShadowOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetText", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Text }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "ignoreMarkup", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetTextColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textType", Type = "HTMLTextType", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleHTMLAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..87270ee --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleHTMLSharedDocumentation.lua.annotated.lua @@ -0,0 +1,18 @@ +local SimpleHTMLShared = +{ + Tables = + { + { + Name = "HTMLContentNode", + Type = "Structure", + Fields = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "type", Type = "HTMLTextType", Nilable = false }, + { Name = "align", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleHTMLShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleLineAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleLineAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..74d539d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleLineAPIDocumentation.lua.annotated.lua @@ -0,0 +1,133 @@ +local SimpleLineAPI = +{ + Name = "SimpleLineAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearAllPoints", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "GetEndPoint", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetHitRectThickness", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "thickness", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetStartPoint", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetThickness", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "thickness", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetEndPoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false, Default = 0 }, + { Name = "offsetY", Type = "uiUnit", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetHitRectThickness", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "thickness", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetStartPoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false, Default = 0 }, + { Name = "offsetY", Type = "uiUnit", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetThickness", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "thickness", Type = "uiUnit", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleLineAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMapSceneAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMapSceneAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..45323a9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMapSceneAPIDocumentation.lua.annotated.lua @@ -0,0 +1,86 @@ +local SimpleMapSceneAPI = +{ + Name = "SimpleMapSceneAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetMaxCharacterSlotCount", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxCharacterSlotCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetModelDrawLayer", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + { Name = "sublayer", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetViewInsets", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetModelDrawLayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + }, + }, + { + Name = "SetViewInsets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleMapSceneAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMaskTextureAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMaskTextureAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2628fe0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMaskTextureAPIDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local SimpleMaskTextureAPI = +{ + Name = "SimpleMaskTextureAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleMaskTextureAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMessageFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMessageFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f01e4c8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMessageFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,424 @@ +local SimpleMessageFrameAPI = +{ + Name = "SimpleMessageFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + { Name = "messageID", Type = "number", Nilable = true }, + }, + }, + { + Name = "Clear", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetFadeDuration", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fadeDurationSeconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFadePower", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fadePower", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFading", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isFading", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetFont", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "GetFontObject", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "GetFontStringByID", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "messageID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "fontString", Type = "SimpleFontString", Nilable = false }, + }, + }, + { + Name = "GetIndentedWordWrap", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "wordWrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetInsertMode", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "mode", Type = "InsertMode", Nilable = false }, + }, + }, + { + Name = "GetJustifyH", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "GetJustifyV", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "GetShadowColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShadowOffset", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpacing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetTextColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTimeVisible", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "timeVisibleSeconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasMessageByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "messageID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasMessage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetMessageFadeByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "messageID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFadeDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fadeDurationSeconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFadePower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fadePower", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFading", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fading", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFont", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fontFile", Type = "cstring", Nilable = false }, + { Name = "height", Type = "uiFontHeight", Nilable = false }, + { Name = "flags", Type = "TBFFlags", Nilable = false }, + }, + }, + { + Name = "SetFontObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "font", Type = "SimpleFont", Nilable = false }, + }, + }, + { + Name = "SetIndentedWordWrap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "wordWrap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetInsertMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mode", Type = "InsertMode", Nilable = false }, + }, + }, + { + Name = "SetJustifyH", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyH", Type = "JustifyHorizontal", Nilable = false }, + }, + }, + { + Name = "SetJustifyV", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "justifyV", Type = "JustifyVertical", Nilable = false }, + }, + }, + { + Name = "SetShadowColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetShadowOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetX", Type = "number", Nilable = false }, + { Name = "offsetY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spacing", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetTextColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetTimeVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "timeVisibleSeconds", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleMessageFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..51bd08d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelAPIDocumentation.lua.annotated.lua @@ -0,0 +1,780 @@ +local SimpleModelAPI = +{ + Name = "SimpleModelAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AdvanceTime", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearFog", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearModel", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ClearTransform", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetCameraDistance", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraFacing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraPosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraRoll", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCameraTarget", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "targetX", Type = "number", Nilable = false }, + { Name = "targetY", Type = "number", Nilable = false }, + { Name = "targetZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDesaturation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFacing", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "facing", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFogColor", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFogFar", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fogFar", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFogNear", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fogNear", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLight", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "light", Type = "ModelLight", Nilable = false }, + }, + }, + { + Name = "GetModelAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetModelDrawLayer", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + { Name = "sublayer", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetModelFileID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "modelFileID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetModelScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPaused", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "paused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPitch", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "pitch", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPosition", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRoll", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "roll", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShadowEffect", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetViewInsets", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetViewTranslation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetWorldScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "worldScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasAttachmentPoints", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hasAttachmentPoints", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasCustomCamera", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "hasCustomCamera", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingModelCenterToTransform", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "useCenter", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MakeCurrentCameraCustom", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "ReplaceIconTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "FileAsset", Nilable = false }, + }, + }, + { + Name = "SetCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cameraIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraDistance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraFacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraRoll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCameraTarget", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "targetX", Type = "number", Nilable = false }, + { Name = "targetY", Type = "number", Nilable = false }, + { Name = "targetZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCustomCamera", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cameraIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetDesaturation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFacing", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "facing", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFogColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetFogFar", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fogFar", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetFogNear", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fogNear", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetGlow", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "glow", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetGradientMask", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "grad0", Type = "number", Nilable = false }, + { Name = "grad1", Type = "number", Nilable = false }, + { Name = "grad2", Type = "number", Nilable = false }, + { Name = "grad3", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetLight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "light", Type = "ModelLight", Nilable = false }, + }, + }, + { + Name = "SetModel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "ModelAsset", Nilable = false }, + { Name = "noMip", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetModelAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetModelDrawLayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + }, + }, + { + Name = "SetModelScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetParticlesEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPaused", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "paused", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPitch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "pitch", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetRoll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "roll", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSequence", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sequence", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSequenceTime", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sequence", Type = "number", Nilable = false }, + { Name = "timeOffset", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetShadowEffect", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "strength", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTransform", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "translation", Type = "vector3", Mixin = "Vector3DMixin", Nilable = true }, + { Name = "rotation", Type = "vector3", Mixin = "Vector3DMixin", Nilable = true }, + { Name = "scale", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetUseGBuffer", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "useGBuffer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetViewInsets", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "right", Type = "uiUnit", Nilable = false }, + { Name = "top", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetViewTranslation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "TransformCameraSpaceToModelSpace", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cameraPosition", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + }, + + Returns = + { + { Name = "modelPosition", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + }, + }, + { + Name = "UseModelCenterToTransform", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "useCenter", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleModelAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelFFXAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelFFXAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b2a70dd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleModelFFXAPIDocumentation.lua.annotated.lua @@ -0,0 +1,61 @@ +local SimpleModelFFXAPI = +{ + Name = "SimpleModelFFXAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddCharacterLight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = true }, + { Name = "light", Type = "ModelLight", Nilable = false }, + }, + }, + { + Name = "AddLight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = true }, + { Name = "light", Type = "ModelLight", Nilable = false }, + }, + }, + { + Name = "AddPetLight", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = true }, + { Name = "light", Type = "ModelLight", Nilable = false }, + }, + }, + { + Name = "ResetLights", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleModelFFXAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMovieAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMovieAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e07eca2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleMovieAPIDocumentation.lua.annotated.lua @@ -0,0 +1,73 @@ +local SimpleMovieAPI = +{ + Name = "SimpleMovieAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "EnableSubtitles", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "StartMovie", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieID", Type = "number", Nilable = false }, + { Name = "looping", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "returnCode", Type = "number", Nilable = false }, + }, + }, + { + Name = "StartMovieByName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "movieName", Type = "cstring", Nilable = false }, + { Name = "looping", Type = "bool", Nilable = false, Default = false }, + { Name = "resolution", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "returnCode", Type = "number", Nilable = false }, + }, + }, + { + Name = "StopMovie", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleMovieAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleObjectAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleObjectAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2c116a0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleObjectAPIDocumentation.lua.annotated.lua @@ -0,0 +1,82 @@ +local SimpleObjectAPI = +{ + Name = "SimpleObjectAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearParentKey", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetDebugName", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "preferParentKey", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "debugName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetParent", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + + Arguments = + { + }, + + Returns = + { + { Name = "parent", Type = "CScriptObject", Nilable = false }, + }, + }, + { + Name = "GetParentKey", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "parentKey", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetParentKey", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "parentKey", Type = "cstring", Nilable = false }, + { Name = "clearOtherKeys", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleObjectAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleOffScreenFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleOffScreenFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a8b708c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleOffScreenFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,125 @@ +local SimpleOffScreenFrameAPI = +{ + Name = "SimpleOffScreenFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ApplySnapshot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + { Name = "snapshotID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Flush", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetMaxSnapshots", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "maxSnapshots", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsSnapshotValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "snapshotID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMaxSnapshots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "maxSnapshots", Type = "number", Nilable = false }, + }, + }, + { + Name = "TakeSnapshot", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "snapshotID", Type = "number", Nilable = true }, + }, + }, + { + Name = "TestPrintToFile", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Unavailable in public builds" }, + + Arguments = + { + { Name = "snapshotID", Type = "number", Nilable = false }, + { Name = "filename", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UsesNPOT", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "usesNPOT", Type = "bool", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleOffScreenFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleRegionAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleRegionAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..de53ec0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleRegionAPIDocumentation.lua.annotated.lua @@ -0,0 +1,228 @@ +local SimpleRegionAPI = +{ + Name = "SimpleRegionAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetAlpha", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Alpha }, + + Arguments = + { + }, + + Returns = + { + { Name = "alpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "GetDrawLayer", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + { Name = "sublayer", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEffectiveScale", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Scale }, + + Arguments = + { + }, + + Returns = + { + { Name = "effectiveScale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScale", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Scale }, + + Arguments = + { + }, + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVertexColor", + Type = "Function", + MayReturnNothing = true, + SecretReturnsForAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsIgnoringParentAlpha", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isIgnoring", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnoringParentScale", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isIgnoring", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsObjectLoaded", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAlpha", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "alpha", Type = "SingleColorValue", Nilable = false }, + }, + }, + { + Name = "SetAlphaFromBoolean", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "value", Type = "bool", Nilable = false }, + { Name = "alphaIfTrue", Type = "SingleColorValue", Nilable = false, Default = 255 }, + { Name = "alphaIfFalse", Type = "SingleColorValue", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetDrawLayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "layer", Type = "DrawLayer", Nilable = false }, + { Name = "sublevel", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "SetIgnoreParentAlpha", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetIgnoreParentScale", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "ignore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetScale", + Type = "Function", + IsProtectedFunction = true, + SecretArgumentsAddAspect = { Enum.SecretAspect.Scale }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetVertexColor", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetVertexColorFromBoolean", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "value", Type = "bool", Nilable = false }, + { Name = "colorIfTrue", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + { Name = "colorIfFalse", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleRegionAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c71d89b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionAPIDocumentation.lua.annotated.lua @@ -0,0 +1,683 @@ +local SimpleScriptRegionAPI = +{ + Name = "SimpleScriptRegionAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "CanChangeProtectedState", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity }, + + Arguments = + { + }, + + Returns = + { + { Name = "canChange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPropagateMouseClicks", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "canPropagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPropagateMouseMotion", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "canPropagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearScripts", + Type = "Function", + Documentation = { "Remove all script handlers set through Scripts in XML or SetScript in Lua" }, + + Arguments = + { + }, + }, + { + Name = "CollapsesLayout", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "collapsesLayout", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EnableMouse", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "EnableMouseMotion", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "EnableMouseWheel", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetBottom", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "bottom", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetCenter", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetHeight", + Type = "Function", + SecretWhenAnchoringSecret = true, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreRect", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetLeft", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetRect", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + { Name = "width", Type = "uiUnit", Nilable = false }, + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetRight", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "right", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetScaledRect", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + { Name = "width", Type = "uiUnit", Nilable = false }, + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetScript", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "bindingType", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "script", Type = "luaFunction", Nilable = false }, + }, + }, + { + Name = "GetSize", + Type = "Function", + SecretWhenAnchoringSecret = true, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreRect", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetSourceLocation", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectDebug }, + + Arguments = + { + }, + + Returns = + { + { Name = "location", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTop", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + + Arguments = + { + }, + + Returns = + { + { Name = "top", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetWidth", + Type = "Function", + SecretWhenAnchoringSecret = true, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ignoreRect", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "HasScript", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectType }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "hasScript", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Hide", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "HookScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "script", Type = "luaFunction", Nilable = false }, + { Name = "bindingType", Type = "number", Nilable = true }, + }, + }, + { + Name = "Intersects", + Type = "Function", + SecretWhenAnchoringSecret = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "region", Type = "ScriptRegion", Nilable = false }, + }, + + Returns = + { + { Name = "intersects", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAnchoringRestricted", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity }, + + Arguments = + { + }, + + Returns = + { + { Name = "isRestricted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAnchoringSecret", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecrets }, + + Arguments = + { + }, + + Returns = + { + { Name = "isSecret", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCollapsed", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isCollapsed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDragging", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isDragging", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseClickEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseMotionEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseMotionFocus", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isMouseMotionFocus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseOver", + Type = "Function", + SecretWhenAnchoringSecret = true, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "offsetTop", Type = "uiUnit", Nilable = false, Default = 0 }, + { Name = "offsetBottom", Type = "uiUnit", Nilable = false, Default = 0 }, + { Name = "offsetLeft", Type = "uiUnit", Nilable = false, Default = 0 }, + { Name = "offsetRight", Type = "uiUnit", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "isMouseOver", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseWheelEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsProtected", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ObjectSecurity }, + + Arguments = + { + }, + + Returns = + { + { Name = "isProtected", Type = "bool", Nilable = false }, + { Name = "isProtectedExplicitly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRectValid", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsShown", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Shown }, + + Arguments = + { + }, + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVisible", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Shown }, + + Arguments = + { + }, + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCollapsesLayout", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "collapsesLayout", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMouseClickEnabled", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetMouseMotionEnabled", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetParent", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "parent", Type = "SimpleFrame", Nilable = true }, + }, + }, + { + Name = "SetPassThroughButtons", + Type = "Function", + IsProtectedFunction = true, + HasRestrictions = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "buttons", Type = "MouseButton", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "SetPropagateMouseClicks", + Type = "Function", + IsProtectedFunction = true, + HasRestrictions = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "propagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPropagateMouseMotion", + Type = "Function", + IsProtectedFunction = true, + HasRestrictions = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "propagate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetScript", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scriptTypeName", Type = "cstring", Nilable = false }, + { Name = "script", Type = "luaFunction", Nilable = true }, + }, + }, + { + Name = "SetShown", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Shown }, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "ShouldButtonPassThrough", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "button", Type = "MouseButton", Nilable = false }, + }, + + Returns = + { + { Name = "shouldPassThrough", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Show", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleScriptRegionAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionResizingAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionResizingAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2c0bd64 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScriptRegionResizingAPIDocumentation.lua.annotated.lua @@ -0,0 +1,194 @@ +local SimpleScriptRegionResizingAPI = +{ + Name = "SimpleScriptRegionResizingAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AdjustPointsOffset", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "ClearAllPoints", + Type = "Function", + IsProtectedFunction = true, + Documentation = { "Clears all points and immediately invalidates the rect. (Prior to 11.2.0, this would only invalidate rect immediately for AnchoringRestricted regions.)" }, + + Arguments = + { + }, + }, + { + Name = "ClearPoint", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + }, + }, + { + Name = "ClearPointsOffset", + Type = "Function", + IsProtectedFunction = true, + + Arguments = + { + }, + }, + { + Name = "GetNumPoints", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "numPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPoint", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "anchorIndex", Type = "luaIndex", Nilable = false, Default = 0 }, + { Name = "resolveCollapsed", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetPointByName", + Type = "Function", + MayReturnNothing = true, + SecretWhenAnchoringSecret = true, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "resolveCollapsed", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetAllPoints", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "doResize", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SetHeight", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetPoint", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetPointsOffset", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetSize", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "uiUnit", Nilable = false }, + { Name = "y", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetWidth", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "width", Type = "uiUnit", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleScriptRegionResizingAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScrollFrameAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScrollFrameAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ff4c088 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleScrollFrameAPIDocumentation.lua.annotated.lua @@ -0,0 +1,128 @@ +local SimpleScrollFrameAPI = +{ + Name = "SimpleScrollFrameAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetHorizontalScroll", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offset", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetHorizontalScrollRange", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ScrollRange }, + + Arguments = + { + }, + + Returns = + { + { Name = "range", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetScrollChild", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "scrollChild", Type = "SimpleFrame", Nilable = false }, + }, + }, + { + Name = "GetVerticalScroll", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "offset", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "GetVerticalScrollRange", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.ScrollRange }, + + Arguments = + { + }, + + Returns = + { + { Name = "range", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetHorizontalScroll", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "offset", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "SetScrollChild", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scrollChild", Type = "SimpleFrame", Nilable = false }, + }, + }, + { + Name = "SetVerticalScroll", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "NotAllowed", + + Arguments = + { + { Name = "offset", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "UpdateScrollChildRect", + Type = "Function", + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleScrollFrameAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleSliderAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleSliderAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6b421a0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleSliderAPIDocumentation.lua.annotated.lua @@ -0,0 +1,236 @@ +local SimpleSliderAPI = +{ + Name = "SimpleSliderAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "Disable", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "Enable", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetMinMaxValues", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "minValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetObeyStepOnDrag", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isObeyStepOnDrag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetOrientation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "orientation", Type = "Orientation", Nilable = false }, + }, + }, + { + Name = "GetStepsPerPage", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "stepsPerPage", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetThumbTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetValue", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetValueStep", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "valueStep", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsDraggingThumb", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isDraggingThumb", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMinMaxValues", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "minValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetObeyStepOnDrag", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "obeyStepOnDrag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetOrientation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orientation", Type = "Orientation", Nilable = false }, + }, + }, + { + Name = "SetStepsPerPage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "stepsPerPage", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetThumbTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + }, + { + Name = "SetValue", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "value", Type = "number", Nilable = false }, + { Name = "treatAsMouseEvent", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetValueStep", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "valueStep", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleSliderAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f2dc4f3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarAPIDocumentation.lua.annotated.lua @@ -0,0 +1,351 @@ +local SimpleStatusBarAPI = +{ + Name = "SimpleStatusBarAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "GetFillStyle", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "fillStyle", Type = "StatusBarFillStyle", Nilable = false }, + }, + }, + { + Name = "GetInterpolatedValue", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.BarValue }, + Documentation = { "Returns the current interpolated value displayed by the bar." }, + + Arguments = + { + }, + + Returns = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMinMaxValues", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.BarValue }, + + Arguments = + { + }, + + Returns = + { + { Name = "minValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOrientation", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "orientation", Type = "Orientation", Nilable = false }, + }, + }, + { + Name = "GetReverseFill", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "isReverseFill", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRotatesTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "rotatesTexture", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetStatusBarColor", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + + Arguments = + { + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStatusBarDesaturation", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Desaturation }, + + Arguments = + { + }, + + Returns = + { + { Name = "desaturation", Type = "normalizedValue", Nilable = false }, + }, + }, + { + Name = "GetStatusBarTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetTimerDuration", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetValue", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.BarValue }, + + Arguments = + { + }, + + Returns = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsInterpolating", + Type = "Function", + Documentation = { "Returns true if the status bar is currently interpolating toward a target value." }, + + Arguments = + { + }, + + Returns = + { + { Name = "isInterpolating", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStatusBarDesaturated", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Desaturation }, + + Arguments = + { + }, + + Returns = + { + { Name = "desaturated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetColorFill", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetFillStyle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fillStyle", Type = "StatusBarFillStyle", Nilable = false }, + }, + }, + { + Name = "SetMinMaxValues", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.BarValue }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "minValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + { Name = "interpolation", Type = "StatusBarInterpolation", Nilable = false, NeverSecret = true, Default = "Immediate" }, + }, + }, + { + Name = "SetOrientation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orientation", Type = "Orientation", Nilable = false }, + }, + }, + { + Name = "SetReverseFill", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isReverseFill", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetRotatesTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "rotatesTexture", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetStatusBarColor", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.VertexColor, Enum.SecretAspect.Alpha }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetStatusBarDesaturated", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Desaturation }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "desaturated", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetStatusBarDesaturation", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Desaturation }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "desaturation", Type = "normalizedValue", Nilable = false }, + }, + }, + { + Name = "SetStatusBarTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "asset", Type = "TextureAsset", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTimerDuration", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + { Name = "interpolation", Type = "StatusBarInterpolation", Nilable = false, Default = "Immediate" }, + { Name = "direction", Type = "StatusBarTimerDirection", Nilable = false, Default = "ElapsedTime" }, + }, + }, + { + Name = "SetToTargetValue", + Type = "Function", + Documentation = { "Immediately finishes any interpolation of the bar and snaps it to the target value." }, + + Arguments = + { + }, + }, + { + Name = "SetValue", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.BarValue }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "value", Type = "number", Nilable = false }, + { Name = "interpolation", Type = "StatusBarInterpolation", Nilable = false, NeverSecret = true, Default = "Immediate" }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleStatusBarAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ef1458a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleStatusBarConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local SimpleStatusBarConstants = +{ + Tables = + { + { + Name = "StatusBarFillStyle", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Standard", Type = "StatusBarFillStyle", EnumValue = 0, Documentation = { "Fills the bar regularly, either in a left-to-right or top-to-bottom direction as values increase." } }, + { Name = "StandardNoRangeFill", Type = "StatusBarFillStyle", EnumValue = 1, Documentation = { "Similar to standard, except if the range between the min and max values is zero instead render as-if the bar were 100% full. If the min and max values are both zero, will render as 0% full." } }, + { Name = "Center", Type = "StatusBarFillStyle", EnumValue = 2, Documentation = { "Fills the bar in an outward growing manner from the center." } }, + { Name = "Reverse", Type = "StatusBarFillStyle", EnumValue = 3, Documentation = { "Inverse of Standard, filling right-to-left or bottom-to-top as values increase." } }, + }, + }, + { + Name = "StatusBarInterpolation", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Immediate", Type = "StatusBarInterpolation", EnumValue = 0, Documentation = { "Immediately snap to the target value with no interpolation." } }, + { Name = "ExponentialEaseOut", Type = "StatusBarInterpolation", EnumValue = 1, Documentation = { "Interpolate the bar toward the target value with exponential ease-out style decay." } }, + }, + }, + { + Name = "StatusBarTimerDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "ElapsedTime", Type = "StatusBarTimerDirection", EnumValue = 0, Documentation = { "Calculate status timer bar values using the elapsed time of a duration." } }, + { Name = "RemainingTime", Type = "StatusBarTimerDirection", EnumValue = 1, Documentation = { "Calculate status timer bar values using the remaining time of a duration." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleStatusBarConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..72f94b8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureAPIDocumentation.lua.annotated.lua @@ -0,0 +1,71 @@ +local SimpleTextureAPI = +{ + Name = "SimpleTextureAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "AddMaskTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mask", Type = "SimpleMaskTexture", Nilable = false }, + }, + }, + { + Name = "GetMaskTexture", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "mask", Type = "SimpleMaskTexture", Nilable = false }, + }, + }, + { + Name = "GetNumMaskTextures", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Hierarchy }, + + Arguments = + { + }, + + Returns = + { + { Name = "count", Type = "size", Nilable = false }, + }, + }, + { + Name = "RemoveMaskTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mask", Type = "SimpleMaskTexture", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleTextureAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureBaseAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureBaseAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b45be7f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SimpleTextureBaseAPIDocumentation.lua.annotated.lua @@ -0,0 +1,515 @@ +local SimpleTextureBaseAPI = +{ + Name = "SimpleTextureBaseAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "ClearTextureSlice", + Type = "Function", + Documentation = { "Disable shader based nineslice texture rendering. Since SetAtlas will automatically load slice data for the atlas from the DB, can be useful if you want to disable nineslice after setting an atlas." }, + + Arguments = + { + }, + }, + { + Name = "ClearVertexOffsets", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "GetAtlas", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetBlendMode", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "blendMode", Type = "BlendMode", Nilable = false }, + }, + }, + { + Name = "GetDesaturation", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Desaturation }, + + Arguments = + { + }, + + Returns = + { + { Name = "desaturation", Type = "normalizedValue", Nilable = false }, + }, + }, + { + Name = "GetHorizTile", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "tiling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRotation", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Rotation }, + + Arguments = + { + }, + + Returns = + { + { Name = "radians", Type = "number", Nilable = false }, + { Name = "normalizedRotationPoint", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetTexCoord", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.TexCoords }, + + Arguments = + { + }, + + Returns = + { + { Name = "ulX", Type = "number", Nilable = false }, + { Name = "ulY", Type = "number", Nilable = false }, + { Name = "llX", Type = "number", Nilable = false }, + { Name = "llY", Type = "number", Nilable = false }, + { Name = "urX", Type = "number", Nilable = false }, + { Name = "urY", Type = "number", Nilable = false }, + { Name = "lrX", Type = "number", Nilable = false }, + { Name = "lrY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTexelSnappingBias", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "bias", Type = "normalizedValue", Nilable = false }, + }, + }, + { + Name = "GetTexture", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "textureFile", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetTextureFileID", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "textureFile", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetTextureFilePath", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "textureFile", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetTextureSliceMargins", + Type = "Function", + MayReturnNothing = true, + + Arguments = + { + }, + + Returns = + { + { Name = "left", Type = "number", Nilable = false }, + { Name = "top", Type = "number", Nilable = false }, + { Name = "right", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTextureSliceMode", + Type = "Function", + MayReturnNothing = true, + + Arguments = + { + }, + + Returns = + { + { Name = "sliceMode", Type = "UITextureSliceMode", Nilable = false }, + }, + }, + { + Name = "GetVertTile", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "tiling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetVertexOffset", + Type = "Function", + ConstSecretAccessor = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vertexIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "IsBlockingLoadRequested", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "blocking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDesaturated", + Type = "Function", + SecretReturnsForAspect = { Enum.SecretAspect.Desaturation }, + + Arguments = + { + }, + + Returns = + { + { Name = "desaturated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSnappingToPixelGrid", + Type = "Function", + + Arguments = + { + }, + + Returns = + { + { Name = "snap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetTexCoord", + Type = "Function", + + Arguments = + { + }, + }, + { + Name = "SetAtlas", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + { Name = "useAtlasSize", Type = "bool", Nilable = false, NeverSecret = true, Default = false }, + { Name = "filterMode", Type = "FilterMode", Nilable = true, NeverSecret = true }, + { Name = "resetTexCoords", Type = "bool", Nilable = true, NeverSecret = true }, + { Name = "wrapModeHorizontal", Type = "cstring", Nilable = true, NeverSecret = true }, + { Name = "wrapModeVertical", Type = "cstring", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "SetBlendMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "blendMode", Type = "BlendMode", Nilable = false }, + }, + }, + { + Name = "SetBlockingLoadsRequested", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "blocking", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetColorTexture", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "a", Type = "SingleColorValue", Nilable = true }, + }, + }, + { + Name = "SetDesaturated", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Desaturation }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "desaturated", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetDesaturation", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Desaturation }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "desaturation", Type = "normalizedValue", Nilable = false }, + }, + }, + { + Name = "SetGradient", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orientation", Type = "Orientation", Nilable = false }, + { Name = "minColor", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + { Name = "maxColor", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "SetHorizTile", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tiling", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetMask", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "file", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetRotation", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.Rotation }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + { Name = "normalizedRotationPoint", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "SetSnapToPixelGrid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "snap", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetSpriteSheetCell", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.TexCoords }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "cell", Type = "luaIndex", Nilable = false, ConditionalSecret = true }, + { Name = "numRows", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "numColumns", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "cellWidth", Type = "number", Nilable = true, NeverSecret = true }, + { Name = "cellHeight", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "SetTexCoord", + Type = "Function", + SecretArgumentsAddAspect = { Enum.SecretAspect.TexCoords }, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "left", Type = "number", Nilable = false }, + { Name = "right", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + { Name = "top", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTexelSnappingBias", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bias", Type = "normalizedValue", Nilable = false }, + }, + }, + { + Name = "SetTexture", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "textureAsset", Type = "cstring", Nilable = true }, + { Name = "wrapModeHorizontal", Type = "cstring", Nilable = true }, + { Name = "wrapModeVertical", Type = "cstring", Nilable = true }, + { Name = "filterMode", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTextureSliceMargins", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Enables nineslice texture rendering using the specified pixel margins. Preferred over legacy nineslice approach that uses 9 separate textures." }, + + Arguments = + { + { Name = "left", Type = "number", Nilable = false }, + { Name = "top", Type = "number", Nilable = false }, + { Name = "right", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTextureSliceMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Controls whether the center and sides are Stretched or Tiled when using nineslice texture rendering. Defaults to Stretched." }, + + Arguments = + { + { Name = "sliceMode", Type = "UITextureSliceMode", Nilable = false }, + }, + }, + { + Name = "SetVertTile", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tiling", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetVertexOffset", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vertexIndex", Type = "luaIndex", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleTextureBaseAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SkillInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SkillInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b1ffdf7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SkillInfoDocumentation.lua.annotated.lua @@ -0,0 +1,27 @@ +local SkillInfo = +{ + Name = "SkillInfo", + Type = "System", + Namespace = "C_SkillInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "SkillLinesChanged", + Type = "Event", + LiteralName = "SKILL_LINES_CHANGED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SkillInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua.annotated.lua new file mode 100644 index 0000000..68fa734 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SlashCommandDocumentation.lua.annotated.lua @@ -0,0 +1,39 @@ +local SlashCommand = +{ + Name = "SlashCommand", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "AreDangerousScriptsAllowed", + Type = "Function", + + Returns = + { + { Name = "allowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllowDangerousScripts", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allowed", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SlashCommand); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d5caefe --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local SocialConstants = +{ + Tables = + { + { + Name = "SocialWhoOrigin", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Unknown", Type = "SocialWhoOrigin", EnumValue = 0 }, + { Name = "Social", Type = "SocialWhoOrigin", EnumValue = 1 }, + { Name = "Chat", Type = "SocialWhoOrigin", EnumValue = 2 }, + { Name = "Item", Type = "SocialWhoOrigin", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SocialConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f8e8dd1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialQueueDocumentation.lua.annotated.lua @@ -0,0 +1,233 @@ +local SocialQueue = +{ + Name = "SocialQueue", + Type = "System", + Namespace = "C_SocialQueue", + Environment = "All", + + Functions = + { + { + Name = "GetAllGroups", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "allowNonJoinable", Type = "bool", Nilable = false, Default = false }, + { Name = "allowNonQueuedGroups", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "groupGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetConfig", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "config", Type = "SocialQueueConfig", Nilable = false }, + }, + }, + { + Name = "GetGroupForPlayer", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + { Name = "isSoloQueueParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetGroupInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "canJoin", Type = "bool", Nilable = false }, + { Name = "numQueues", Type = "number", Nilable = false }, + { Name = "needTank", Type = "bool", Nilable = false }, + { Name = "needHealer", Type = "bool", Nilable = false }, + { Name = "needDamage", Type = "bool", Nilable = false }, + { Name = "isSoloQueueParty", Type = "bool", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + { Name = "leaderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetGroupMembers", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "groupMembers", Type = "table", InnerType = "SocialQueuePlayerInfo", Nilable = false }, + }, + }, + { + Name = "GetGroupQueues", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "queues", Type = "table", InnerType = "SocialQueueGroupQueueInfo", Nilable = false }, + }, + }, + { + Name = "RequestToJoin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + { Name = "applyAsTank", Type = "bool", Nilable = false, Default = false }, + { Name = "applyAsHealer", Type = "bool", Nilable = false, Default = false }, + { Name = "applyAsDamage", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "requestSuccessful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SignalToastDisplayed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + { Name = "priority", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SocialQueueConfigUpdated", + Type = "Event", + LiteralName = "SOCIAL_QUEUE_CONFIG_UPDATED", + SynchronousEvent = true, + }, + { + Name = "SocialQueueUpdate", + Type = "Event", + LiteralName = "SOCIAL_QUEUE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "groupGUID", Type = "WOWGUID", Nilable = false }, + { Name = "numAddedItems", Type = "number", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "SocialQueueConfig", + Type = "Structure", + Fields = + { + { Name = "TOASTS_DISABLED", Type = "bool", Nilable = false }, + { Name = "TOAST_DURATION", Type = "number", Nilable = false }, + { Name = "DELAY_DURATION", Type = "number", Nilable = false }, + { Name = "QUEUE_MULTIPLIER", Type = "number", Nilable = false }, + { Name = "PLAYER_MULTIPLIER", Type = "number", Nilable = false }, + { Name = "PLAYER_FRIEND_VALUE", Type = "number", Nilable = false }, + { Name = "PLAYER_GUILD_VALUE", Type = "number", Nilable = false }, + { Name = "THROTTLE_INITIAL_THRESHOLD", Type = "number", Nilable = false }, + { Name = "THROTTLE_DECAY_TIME", Type = "number", Nilable = false }, + { Name = "THROTTLE_PRIORITY_SPIKE", Type = "number", Nilable = false }, + { Name = "THROTTLE_MIN_THRESHOLD", Type = "number", Nilable = false }, + { Name = "THROTTLE_PVP_PRIORITY_NORMAL", Type = "number", Nilable = false }, + { Name = "THROTTLE_PVP_PRIORITY_LOW", Type = "number", Nilable = false }, + { Name = "THROTTLE_PVP_HONOR_THRESHOLD", Type = "number", Nilable = false }, + { Name = "THROTTLE_LFGLIST_PRIORITY_DEFAULT", Type = "number", Nilable = false }, + { Name = "THROTTLE_LFGLIST_PRIORITY_ABOVE", Type = "number", Nilable = false }, + { Name = "THROTTLE_LFGLIST_PRIORITY_BELOW", Type = "number", Nilable = false }, + { Name = "THROTTLE_LFGLIST_ILVL_SCALING_ABOVE", Type = "number", Nilable = false }, + { Name = "THROTTLE_LFGLIST_ILVL_SCALING_BELOW", Type = "number", Nilable = false }, + { Name = "THROTTLE_RF_PRIORITY_ABOVE", Type = "number", Nilable = false }, + { Name = "THROTTLE_RF_ILVL_SCALING_ABOVE", Type = "number", Nilable = false }, + { Name = "THROTTLE_DF_MAX_ITEM_LEVEL", Type = "number", Nilable = false }, + { Name = "THROTTLE_DF_BEST_PRIORITY", Type = "number", Nilable = false }, + }, + }, + { + Name = "SocialQueueGroupInfo", + Type = "Structure", + Fields = + { + { Name = "canJoin", Type = "bool", Nilable = false }, + { Name = "numQueues", Type = "number", Nilable = false }, + { Name = "needTank", Type = "bool", Nilable = false }, + { Name = "needHealer", Type = "bool", Nilable = false }, + { Name = "needDamage", Type = "bool", Nilable = false }, + { Name = "isSoloQueueParty", Type = "bool", Nilable = false }, + { Name = "questSessionActive", Type = "bool", Nilable = false }, + { Name = "leaderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "SocialQueueGroupQueueInfo", + Type = "Structure", + Fields = + { + { Name = "clientID", Type = "number", Nilable = false }, + { Name = "eligible", Type = "bool", Nilable = false }, + { Name = "needTank", Type = "bool", Nilable = false }, + { Name = "needHealer", Type = "bool", Nilable = false }, + { Name = "needDamage", Type = "bool", Nilable = false }, + { Name = "isAutoAccept", Type = "bool", Nilable = false }, + { Name = "queueData", Type = "QueueSpecificInfo", Nilable = false }, + }, + }, + { + Name = "SocialQueuePlayerInfo", + Type = "Structure", + Fields = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "clubId", Type = "ClubId", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SocialQueue); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8a91570 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SocialRestrictionsDocumentation.lua.annotated.lua @@ -0,0 +1,117 @@ +local SocialRestrictions = +{ + Name = "SocialRestrictions", + Type = "System", + Namespace = "C_SocialRestrictions", + Environment = "All", + + Functions = + { + { + Name = "AcknowledgeRegionalChatDisabled", + Type = "Function", + }, + { + Name = "CanReceiveChat", + Type = "Function", + Documentation = { "Returns true if the player meets all conditions that allow them to receive chat messages." }, + + Returns = + { + { Name = "canReceiveChat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSendChat", + Type = "Function", + Documentation = { "Returns true if the player meets all conditions that allow them to send chat messages." }, + + Returns = + { + { Name = "canSendChat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsChatDisabled", + Type = "Function", + + Returns = + { + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMuted", + Type = "Function", + + Returns = + { + { Name = "isMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSilenced", + Type = "Function", + + Returns = + { + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSquelched", + Type = "Function", + + Returns = + { + { Name = "isSquelched", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetChatDisabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AlertRegionalChatDisabled", + Type = "Event", + LiteralName = "ALERT_REGIONAL_CHAT_DISABLED", + SynchronousEvent = true, + }, + { + Name = "ChatDisabledChangeFailed", + Type = "Event", + LiteralName = "CHAT_DISABLED_CHANGE_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatDisabledChanged", + Type = "Event", + LiteralName = "CHAT_DISABLED_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SocialRestrictions); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoftTargetConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoftTargetConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ac20d70 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoftTargetConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local SoftTargetConstants = +{ + Tables = + { + { + Name = "SoftTargetEnableFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "SoftTargetEnableFlags", EnumValue = 0 }, + { Name = "Gamepad", Type = "SoftTargetEnableFlags", EnumValue = 1 }, + { Name = "Kbm", Type = "SoftTargetEnableFlags", EnumValue = 2 }, + { Name = "Any", Type = "SoftTargetEnableFlags", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SoftTargetConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d8fbafa --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,90 @@ +local SoulbindsConstants = +{ + Tables = + { + { + Name = "AddSoulbindConduitReason", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "AddSoulbindConduitReason", EnumValue = 0 }, + { Name = "Cheat", Type = "AddSoulbindConduitReason", EnumValue = 1 }, + { Name = "SpellEffect", Type = "AddSoulbindConduitReason", EnumValue = 2 }, + { Name = "Upgrade", Type = "AddSoulbindConduitReason", EnumValue = 3 }, + }, + }, + { + Name = "SoulbindConduitFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "VisibleToGetallsoulbindconduitScript", Type = "SoulbindConduitFlags", EnumValue = 1 }, + }, + }, + { + Name = "SoulbindConduitInstallResult", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Success", Type = "SoulbindConduitInstallResult", EnumValue = 0 }, + { Name = "InvalidItem", Type = "SoulbindConduitInstallResult", EnumValue = 1 }, + { Name = "InvalidConduit", Type = "SoulbindConduitInstallResult", EnumValue = 2 }, + { Name = "InvalidTalent", Type = "SoulbindConduitInstallResult", EnumValue = 3 }, + { Name = "DuplicateConduit", Type = "SoulbindConduitInstallResult", EnumValue = 4 }, + { Name = "ForgeNotInProximity", Type = "SoulbindConduitInstallResult", EnumValue = 5 }, + { Name = "SocketNotEmpty", Type = "SoulbindConduitInstallResult", EnumValue = 6 }, + }, + }, + { + Name = "SoulbindConduitTransactionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Install", Type = "SoulbindConduitTransactionType", EnumValue = 0 }, + { Name = "Uninstall", Type = "SoulbindConduitTransactionType", EnumValue = 1 }, + }, + }, + { + Name = "SoulbindConduitType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Finesse", Type = "SoulbindConduitType", EnumValue = 0 }, + { Name = "Potency", Type = "SoulbindConduitType", EnumValue = 1 }, + { Name = "Endurance", Type = "SoulbindConduitType", EnumValue = 2 }, + { Name = "Flex", Type = "SoulbindConduitType", EnumValue = 3 }, + }, + }, + { + Name = "SoulbindNodeState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Unavailable", Type = "SoulbindNodeState", EnumValue = 0 }, + { Name = "Unselected", Type = "SoulbindNodeState", EnumValue = 1 }, + { Name = "Selectable", Type = "SoulbindNodeState", EnumValue = 2 }, + { Name = "Selected", Type = "SoulbindNodeState", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SoulbindsConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6cf15ff --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoulbindsDocumentation.lua.annotated.lua @@ -0,0 +1,744 @@ +local Soulbinds = +{ + Name = "Soulbinds", + Type = "System", + Namespace = "C_Soulbinds", + Environment = "All", + + Functions = + { + { + Name = "ActivateSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CanActivateSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + { Name = "errorDescription", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "CanModifySoulbind", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanResetConduitsInSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + { Name = "errorDescription", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "CanSwitchActiveSoulbindTreeBranch", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseUI", + Type = "Function", + }, + { + Name = "CommitPendingConduitsInSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + }, + { + Name = "FindNodeIDActuallyInstalled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "FindNodeIDAppearingInstalled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "FindNodeIDPendingInstall", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "FindNodeIDPendingUninstall", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActiveSoulbindID", + Type = "Function", + + Returns = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConduitCollection", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitType", Type = "SoulbindConduitType", Nilable = false }, + }, + + Returns = + { + { Name = "collectionData", Type = "table", InnerType = "ConduitCollectionData", Nilable = false }, + }, + }, + { + Name = "GetConduitCollectionCount", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConduitCollectionData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "collectionData", Type = "ConduitCollectionData", Nilable = true }, + }, + }, + { + Name = "GetConduitCollectionDataAtCursor", + Type = "Function", + + Returns = + { + { Name = "collectionData", Type = "ConduitCollectionData", Nilable = true }, + }, + }, + { + Name = "GetConduitCollectionDataByVirtualID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "virtualID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "collectionData", Type = "ConduitCollectionData", Nilable = true }, + }, + }, + { + Name = "GetConduitDisplayed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "conduitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConduitHyperlink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetConduitIDPendingInstall", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "conduitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConduitQuality", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "quality", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConduitRank", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "conduitRank", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetConduitSpellID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "conduitRank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstalledConduitID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "conduitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "node", Type = "SoulbindNode", Nilable = false }, + }, + }, + { + Name = "GetSoulbindData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "SoulbindData", Nilable = false }, + }, + }, + { + Name = "GetSpecsAssignedToSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetTree", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "treeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "tree", Type = "SoulbindTree", Nilable = false }, + }, + }, + { + Name = "HasAnyInstalledConduitInSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasAnyPendingConduits", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPendingConduitsInSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConduitInstalled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConduitInstalledInSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemConduitByItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNodePendingModify", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUnselectedConduitPendingInSoulbind", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ModifyNode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "type", Type = "SoulbindConduitTransactionType", Nilable = false }, + }, + }, + { + Name = "SelectNode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnmodifyNode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SoulbindActivated", + Type = "Event", + LiteralName = "SOULBIND_ACTIVATED", + SynchronousEvent = true, + Payload = + { + { Name = "soulbindID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindConduitCollectionCleared", + Type = "Event", + LiteralName = "SOULBIND_CONDUIT_COLLECTION_CLEARED", + SynchronousEvent = true, + }, + { + Name = "SoulbindConduitCollectionRemoved", + Type = "Event", + LiteralName = "SOULBIND_CONDUIT_COLLECTION_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "conduitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindConduitCollectionUpdated", + Type = "Event", + LiteralName = "SOULBIND_CONDUIT_COLLECTION_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "collectionData", Type = "ConduitCollectionData", Nilable = false }, + }, + }, + { + Name = "SoulbindConduitInstalled", + Type = "Event", + LiteralName = "SOULBIND_CONDUIT_INSTALLED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "data", Type = "SoulbindConduitData", Nilable = false }, + }, + }, + { + Name = "SoulbindConduitUninstalled", + Type = "Event", + LiteralName = "SOULBIND_CONDUIT_UNINSTALLED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "data", Type = "SoulbindConduitData", Nilable = false }, + }, + }, + { + Name = "SoulbindForgeInteractionEnded", + Type = "Event", + LiteralName = "SOULBIND_FORGE_INTERACTION_ENDED", + SynchronousEvent = true, + }, + { + Name = "SoulbindForgeInteractionStarted", + Type = "Event", + LiteralName = "SOULBIND_FORGE_INTERACTION_STARTED", + SynchronousEvent = true, + }, + { + Name = "SoulbindNodeLearned", + Type = "Event", + LiteralName = "SOULBIND_NODE_LEARNED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindNodeUnlearned", + Type = "Event", + LiteralName = "SOULBIND_NODE_UNLEARNED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindNodeUpdated", + Type = "Event", + LiteralName = "SOULBIND_NODE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindPathChanged", + Type = "Event", + LiteralName = "SOULBIND_PATH_CHANGED", + SynchronousEvent = true, + }, + { + Name = "SoulbindPendingConduitChanged", + Type = "Event", + LiteralName = "SOULBIND_PENDING_CONDUIT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "conduitID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "ConduitCollectionData", + Type = "Structure", + Fields = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "conduitRank", Type = "number", Nilable = false }, + { Name = "conduitItemLevel", Type = "number", Nilable = false }, + { Name = "conduitType", Type = "SoulbindConduitType", Nilable = false }, + { Name = "conduitSpecSetID", Type = "number", Nilable = false }, + { Name = "conduitSpecIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "conduitSpecName", Type = "cstring", Nilable = true }, + { Name = "covenantID", Type = "number", Nilable = true }, + { Name = "conduitItemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindConduitData", + Type = "Structure", + Fields = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "conduitRank", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindData", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "covenantID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "cvarIndex", Type = "luaIndex", Nilable = false }, + { Name = "tree", Type = "SoulbindTree", Nilable = false }, + { Name = "modelSceneData", Type = "SoulbindModelSceneData", Nilable = false }, + { Name = "activationSoundKitID", Type = "number", Nilable = false }, + { Name = "playerConditionReason", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "SoulbindModelSceneData", + Type = "Structure", + Fields = + { + { Name = "creatureDisplayInfoID", Type = "number", Nilable = false }, + { Name = "modelSceneActorID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SoulbindNode", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "row", Type = "number", Nilable = false }, + { Name = "column", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "playerConditionReason", Type = "cstring", Nilable = true }, + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "conduitRank", Type = "number", Nilable = false }, + { Name = "state", Type = "SoulbindNodeState", Nilable = false }, + { Name = "conduitType", Type = "SoulbindConduitType", Nilable = true }, + { Name = "parentNodeIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "failureRenownRequirement", Type = "number", Nilable = true }, + { Name = "socketEnhanced", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SoulbindTree", + Type = "Structure", + Fields = + { + { Name = "editable", Type = "bool", Nilable = false }, + { Name = "nodes", Type = "table", InnerType = "SoulbindNode", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Soulbinds); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua.annotated.lua new file mode 100644 index 0000000..40695e7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SoundDocumentation.lua.annotated.lua @@ -0,0 +1,130 @@ +local Sound = +{ + Name = "Sound", + Type = "System", + Namespace = "C_Sound", + Environment = "All", + + Functions = + { + { + Name = "GetSoundScaledVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "scaledVolume", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsPlaying", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPlaying", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayItemSound", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soundType", Type = "ItemSoundType", Nilable = false }, + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "PlaySound", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "soundKitID", Type = "number", Nilable = false }, + { Name = "uiSoundSubType", Type = "UISoundSubType", Nilable = false, Default = "g_defaultSI3UISoundSubTypeForLua" }, + { Name = "forceNoDuplicates", Type = "bool", Nilable = false, Default = false }, + { Name = "runFinishCallback", Type = "bool", Nilable = false, Default = false }, + { Name = "overridePriority", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "soundHandle", Type = "SoundHandle", Nilable = false }, + }, + }, + { + Name = "PlayVocalErrorSound", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vocalErrorSoundID", Type = "Vocalerrorsounds", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SoundDeviceUpdate", + Type = "Event", + LiteralName = "SOUND_DEVICE_UPDATE", + SynchronousEvent = true, + }, + { + Name = "SoundkitFinished", + Type = "Event", + LiteralName = "SOUNDKIT_FINISHED", + SynchronousEvent = true, + Payload = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "PlaySoundParams", + Type = "Structure", + Fields = + { + { Name = "soundKitID", Type = "number", Nilable = false }, + { Name = "uiSoundSubType", Type = "UISoundSubType", Nilable = false, Default = "g_defaultSI3UISoundSubTypeForLua" }, + { Name = "forceNoDuplicates", Type = "bool", Nilable = false, Default = false }, + { Name = "runFinishCallback", Type = "bool", Nilable = false, Default = false }, + { Name = "overridePriority", Type = "number", Nilable = true }, + }, + }, + { + Name = "PlaySoundResult", + Type = "Structure", + Fields = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "soundHandle", Type = "SoundHandle", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Sound); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2a0529a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationInfoDocumentation.lua.annotated.lua @@ -0,0 +1,559 @@ +local SpecializationInfo = +{ + Name = "SpecializationInfo", + Type = "System", + Namespace = "C_SpecializationInfo", + Environment = "All", + + Functions = + { + { + Name = "CanPlayerUsePVPTalentUI", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseTalentSpecUI", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseTalentUI", + Type = "Function", + + Returns = + { + { Name = "canUse", Type = "bool", Nilable = false }, + { Name = "failureReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActiveSpecGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isInspect", Type = "bool", Nilable = true }, + { Name = "isPet", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "groupIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetAllSelectedPvpTalentIDs", + Type = "Function", + + Returns = + { + { Name = "selectedPvpTalentIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetClassIDFromSpecID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "classID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetInspectSelectedPvpTalent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inspectedUnit", Type = "UnitToken", Nilable = false }, + { Name = "talentIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "selectedTalentID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNumSpecializationsForClassID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPvpTalentAlertStatus", + Type = "Function", + + Returns = + { + { Name = "hasUnspentSlot", Type = "bool", Nilable = false }, + { Name = "hasNewTalent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPvpTalentInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "talentInfo", Type = "PvpTalentInfo", Nilable = true }, + }, + }, + { + Name = "GetPvpTalentSlotInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slotInfo", Type = "PvpTalentSlotInfo", Nilable = true }, + }, + }, + { + Name = "GetPvpTalentSlotUnlockLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "requiredLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPvpTalentUnlockLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "requiredLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSpecIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "specIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetSpecialization", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isInspect", Type = "bool", Nilable = true }, + { Name = "isPet", Type = "bool", Nilable = true }, + { Name = "specGroupIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "specializationIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetSpecializationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specializationIndex", Type = "luaIndex", Nilable = false }, + { Name = "isInspect", Type = "bool", Nilable = false, Default = false }, + { Name = "isPet", Type = "bool", Nilable = false, Default = false }, + { Name = "inspectTarget", Type = "string", Nilable = true }, + { Name = "sex", Type = "number", Nilable = true }, + { Name = "groupIndex", Type = "luaIndex", Nilable = true }, + { Name = "classID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "specId", Type = "number", Nilable = false, Default = 0 }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "role", Type = "string", Nilable = true }, + { Name = "primaryStat", Type = "luaIndex", Nilable = true }, + { Name = "pointsSpent", Type = "number", Nilable = false, Default = 0 }, + { Name = "background", Type = "string", Nilable = true }, + { Name = "previewPointsSpent", Type = "number", Nilable = false, Default = 0 }, + { Name = "isUnlocked", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "GetSpecializationMasterySpells", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specializationIndex", Type = "luaIndex", Nilable = false }, + { Name = "isInspect", Type = "bool", Nilable = true }, + { Name = "isPet", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellsDisplay", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specializationID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetTalentInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "query", Type = "TalentInfoQuery", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "TalentInfoResult", Nilable = true }, + }, + }, + { + Name = "IsInitialized", + Type = "Function", + + Returns = + { + { Name = "isSpecializationDataInitialized", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPvpTalentLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MatchesCurrentSpecSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "matches", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPetSpecialization", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specIndex", Type = "luaIndex", Nilable = false }, + { Name = "petNumber", Type = "number", Nilable = true }, + }, + }, + { + Name = "SetPvpTalentLocked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSpecialization", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActiveTalentGroupChanged", + Type = "Event", + LiteralName = "ACTIVE_TALENT_GROUP_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "curr", Type = "number", Nilable = false }, + { Name = "prev", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmPetUnlearn", + Type = "Event", + LiteralName = "CONFIRM_PET_UNLEARN", + SynchronousEvent = true, + Payload = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmTalentWipe", + Type = "Event", + LiteralName = "CONFIRM_TALENT_WIPE", + SynchronousEvent = true, + Payload = + { + { Name = "cost", Type = "number", Nilable = false }, + { Name = "respecType", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetSpecializationChanged", + Type = "Event", + LiteralName = "PET_SPECIALIZATION_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerLearnPvpTalentFailed", + Type = "Event", + LiteralName = "PLAYER_LEARN_PVP_TALENT_FAILED", + SynchronousEvent = true, + }, + { + Name = "PlayerLearnTalentFailed", + Type = "Event", + LiteralName = "PLAYER_LEARN_TALENT_FAILED", + SynchronousEvent = true, + }, + { + Name = "PlayerPvpTalentUpdate", + Type = "Event", + LiteralName = "PLAYER_PVP_TALENT_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PlayerTalentUpdate", + Type = "Event", + LiteralName = "PLAYER_TALENT_UPDATE", + SynchronousEvent = true, + }, + { + Name = "SpecInvoluntarilyChanged", + Type = "Event", + LiteralName = "SPEC_INVOLUNTARILY_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isPet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TalentsInvoluntarilyReset", + Type = "Event", + LiteralName = "TALENTS_INVOLUNTARILY_RESET", + SynchronousEvent = true, + Payload = + { + { Name = "isPetTalents", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "PvpTalentInfo", + Type = "Structure", + Fields = + { + { Name = "talentID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "selected", Type = "bool", Nilable = false }, + { Name = "available", Type = "bool", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "unlocked", Type = "bool", Nilable = false }, + { Name = "known", Type = "bool", Nilable = false }, + { Name = "grantedByAura", Type = "bool", Nilable = false }, + { Name = "dependenciesUnmet", Type = "bool", Nilable = false }, + { Name = "dependenciesUnmetReason", Type = "string", Nilable = true }, + }, + }, + { + Name = "PvpTalentSlotInfo", + Type = "Structure", + Fields = + { + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "selectedTalentID", Type = "number", Nilable = true }, + { Name = "availableTalentIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SpecializationInfoOutput", + Type = "Structure", + Fields = + { + { Name = "specId", Type = "number", Nilable = false, Default = 0 }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "description", Type = "string", Nilable = true }, + { Name = "icon", Type = "fileID", Nilable = true }, + { Name = "role", Type = "string", Nilable = true }, + { Name = "primaryStat", Type = "luaIndex", Nilable = true }, + { Name = "pointsSpent", Type = "number", Nilable = false, Default = 0 }, + { Name = "background", Type = "string", Nilable = true }, + { Name = "previewPointsSpent", Type = "number", Nilable = false, Default = 0 }, + { Name = "isUnlocked", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "SpecializationInfoQuery", + Type = "Structure", + Fields = + { + { Name = "specializationIndex", Type = "luaIndex", Nilable = false }, + { Name = "isInspect", Type = "bool", Nilable = false, Default = false }, + { Name = "isPet", Type = "bool", Nilable = false, Default = false }, + { Name = "inspectTarget", Type = "string", Nilable = true }, + { Name = "sex", Type = "number", Nilable = true }, + { Name = "groupIndex", Type = "luaIndex", Nilable = true }, + { Name = "classID", Type = "number", Nilable = true }, + }, + }, + { + Name = "TalentInfoQuery", + Type = "Structure", + Fields = + { + { Name = "groupIndex", Type = "luaIndex", Nilable = true }, + { Name = "isInspect", Type = "bool", Nilable = false, Default = false }, + { Name = "tier", Type = "luaIndex", Nilable = true }, + { Name = "column", Type = "luaIndex", Nilable = true }, + { Name = "target", Type = "UnitToken", Nilable = true }, + { Name = "specializationIndex", Type = "luaIndex", Nilable = true }, + { Name = "talentIndex", Type = "luaIndex", Nilable = true }, + { Name = "isPet", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TalentInfoResult", + Type = "Structure", + Fields = + { + { Name = "talentID", Type = "number", Nilable = false, Default = 0 }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "tier", Type = "luaIndex", Nilable = false }, + { Name = "column", Type = "luaIndex", Nilable = false }, + { Name = "selected", Type = "bool", Nilable = false, Default = false }, + { Name = "available", Type = "bool", Nilable = false, Default = false }, + { Name = "spellID", Type = "number", Nilable = false, Default = 0 }, + { Name = "isPVPTalentUnlocked", Type = "bool", Nilable = false, Default = false }, + { Name = "known", Type = "bool", Nilable = false, Default = false }, + { Name = "grantedByAura", Type = "bool", Nilable = false, Default = false }, + { Name = "rank", Type = "luaIndex", Nilable = false }, + { Name = "maxRank", Type = "luaIndex", Nilable = false }, + { Name = "meetsPrereq", Type = "bool", Nilable = false, Default = false }, + { Name = "previewRank", Type = "luaIndex", Nilable = false }, + { Name = "meetsPreviewPrereq", Type = "bool", Nilable = false, Default = false }, + { Name = "isExceptional", Type = "bool", Nilable = false, Default = false }, + { Name = "hasGoldBorder", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpecializationInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8bb4733 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpecializationSharedDocumentation.lua.annotated.lua @@ -0,0 +1,122 @@ +local SpecializationShared = +{ + Name = "SpecializationShared", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetSpecializationInfoForClassID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "gender", Type = "UnitSex", Nilable = true }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "role", Type = "cstring", Nilable = false }, + { Name = "recommended", Type = "bool", Nilable = false }, + { Name = "allowedForBoost", Type = "bool", Nilable = false }, + { Name = "masterySpell1", Type = "number", Nilable = true }, + { Name = "masterySpell2", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSpecializationInfoForSpecID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "gender", Type = "UnitSex", Nilable = true }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "role", Type = "cstring", Nilable = false }, + { Name = "recommended", Type = "bool", Nilable = false }, + { Name = "allowedForBoost", Type = "bool", Nilable = false }, + { Name = "masterySpell1", Type = "number", Nilable = true }, + { Name = "masterySpell2", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSpecializationNameForSpecID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "gender", Type = "UnitSex", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "HasLootSpecializations", + Type = "Function", + + Returns = + { + { Name = "hasLootSpecializations", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "SpecializationSystem", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "TalentTab", Type = "SpecializationSystem", EnumValue = 0 }, + { Name = "ChrSpecialization", Type = "SpecializationSystem", EnumValue = 1 }, + }, + }, + { + Name = "SpecializationInfoResult", + Type = "Structure", + Fields = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "role", Type = "cstring", Nilable = false }, + { Name = "recommended", Type = "bool", Nilable = false }, + { Name = "allowedForBoost", Type = "bool", Nilable = false }, + { Name = "masterySpell1", Type = "number", Nilable = true }, + { Name = "masterySpell2", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpecializationShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d55b323 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellActivationOverlayDocumentation.lua.annotated.lua @@ -0,0 +1,82 @@ +local SpellActivationOverlay = +{ + Name = "SpellActivationOverlay", + Type = "System", + Namespace = "C_SpellActivationOverlay", + Environment = "All", + + Functions = + { + { + Name = "IsSpellOverlayed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isSpellOverlayed", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SpellActivationOverlayGlowHide", + Type = "Event", + LiteralName = "SPELL_ACTIVATION_OVERLAY_GLOW_HIDE", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpellActivationOverlayGlowShow", + Type = "Event", + LiteralName = "SPELL_ACTIVATION_OVERLAY_GLOW_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpellActivationOverlayHide", + Type = "Event", + LiteralName = "SPELL_ACTIVATION_OVERLAY_HIDE", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "SpellActivationOverlayShow", + Type = "Event", + LiteralName = "SPELL_ACTIVATION_OVERLAY_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "overlayFileDataID", Type = "number", Nilable = false }, + { Name = "locationType", Type = "ScreenLocationType", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "r", Type = "number", Nilable = false }, + { Name = "g", Type = "number", Nilable = false }, + { Name = "b", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SpellActivationOverlay); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e576a3d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local SpellBookConstants = +{ + Tables = + { + { + Name = "SpellBookSkillLineIndex", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "General", Type = "SpellBookSkillLineIndex", EnumValue = 1 }, + { Name = "Class", Type = "SpellBookSkillLineIndex", EnumValue = 2 }, + { Name = "MainSpec", Type = "SpellBookSkillLineIndex", EnumValue = 3 }, + { Name = "OffSpecStart", Type = "SpellBookSkillLineIndex", EnumValue = 4 }, + }, + }, + { + Name = "SpellBookItemType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "SpellBookItemType", EnumValue = 0 }, + { Name = "Spell", Type = "SpellBookItemType", EnumValue = 1 }, + { Name = "FutureSpell", Type = "SpellBookItemType", EnumValue = 2 }, + { Name = "PetAction", Type = "SpellBookItemType", EnumValue = 3 }, + { Name = "Flyout", Type = "SpellBookItemType", EnumValue = 4 }, + }, + }, + { + Name = "SpellBookSpellBank", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Player", Type = "SpellBookSpellBank", EnumValue = 0 }, + { Name = "Pet", Type = "SpellBookSpellBank", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellBookConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ab50d5b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellBookDocumentation.lua.annotated.lua @@ -0,0 +1,979 @@ +local SpellBook = +{ + Name = "SpellBook", + Type = "System", + Namespace = "C_SpellBook", + Environment = "All", + + Functions = + { + { + Name = "CastSpellBookItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + { Name = "targetSelf", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, spell will target the current player; Otherwise, targets the player's current target" } }, + }, + }, + { + Name = "ContainsAnyDisenchantSpell", + Type = "Function", + Documentation = { "Returns true if player knows any Disenchant spells" }, + + Returns = + { + { Name = "contains", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FindBaseSpellByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "baseSpellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "FindFlyoutSlotBySpellID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "flyoutSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "FindSpellBookSlotForSpell", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If found, returns the first slot position of a SpellBookItem matching the specified spell and criteria" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "includeHidden", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, search includes SpellBookItems that are hidden from the SpellBook UI (ex: spells that have been replaced, are also in a Flyout, etc)" } }, + { Name = "includeFlyouts", Type = "bool", Nilable = false, Default = true, Documentation = { "If true, search includes Flyout SpellBookItems containing the specified spell" } }, + { Name = "includeFutureSpells", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, search includes SpellBookItems for spells that have not yet been learned" } }, + { Name = "includeOffSpec", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, search includes SpellBookItems belonging to non-active specializations; If spell is in active and inactive spec, the active spec slot will always be returned" } }, + }, + + Returns = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + }, + { + Name = "FindSpellOverrideByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "overrideSpellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrentLevelSpells", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns general, class, and active spec spells that are learned at the specified level" }, + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetNumSpellBookSkillLines", + Type = "Function", + + Returns = + { + { Name = "numSpellBookSkillLines", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSkillLineIndexByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "skillIndex", Type = "luaIndex", Nilable = true, Documentation = { "Will be nil if the specified SkillLine could not be found, or if it is not one of the player's tracked skill lines" } }, + }, + }, + { + Name = "GetSpellBookItemAutoCast", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns nothing if item doesn't exist or isn't a spell" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "autoCastAllowed", Type = "bool", Nilable = false, Documentation = { "True if this spell is allowed to be auto-cast" } }, + { Name = "autoCastEnabled", Type = "bool", Nilable = false, Documentation = { "True if auto-casting this spell is currently enabled (usually by the player)" } }, + }, + }, + { + Name = "GetSpellBookItemCastCount", + Type = "Function", + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns number of times a SpellBookItem can be cast, typically based on availability of things like required reagent items; Always returns 0 if item is not found or is not a spell" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "castCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemChargeDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object describing the active recharge time for a spellbook item." }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemCharges", + Type = "Function", + MayReturnNothing = true, + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a table of info about the charges of a charge-accumulating SpellBookItem; May return nil if item is not found or is not charge-based" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "chargeInfo", Type = "SpellChargeInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemCooldown", + Type = "Function", + MayReturnNothing = true, + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns nil if item doesn't exist or if this kind of item doesn't display cooldowns (ex: future or offspec spells)" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "spellCooldownInfo", Type = "SpellCooldownInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemCooldownDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object describing the active cooldown duration for a spellbook item." }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemDescription", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false, Documentation = { "May be empty if spell's data isn't loaded yet; Listen for SPELL_TEXT_UPDATE event, or use SpellMixin to load asynchronously" } }, + }, + }, + { + Name = "GetSpellBookItemInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "spellBookItemInfo", Type = "SpellBookItemInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemLevelLearned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns the level the spell is learned at; May return a different value if the player is currently Level Linked with another player; Returns 0 if item is not a Spell" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "levelLearned", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemLink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + { Name = "glyphID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "spellLink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemLossOfControlCooldown", + Type = "Function", + MayReturnNothing = true, + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns nil if item doesn't exist or if this kind of item doesn't display cooldowns (ex: future or offspec spells)" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemLossOfControlCooldownDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object describing the active loss of control cooldown duration for a spellbook item." }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemName", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subName", Type = "string", Nilable = false, Documentation = { "May be empty if spell's data isn't loaded yet; Listen for SPELL_TEXT_UPDATE event, or use SpellMixin to load asynchronously" } }, + }, + }, + { + Name = "GetSpellBookItemPowerCost", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a table containing one or more SpellPowerCostInfos, one for each power type a SpellBookItem costs; May return nil if item is not found or has no resource costs" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "powerCosts", Type = "table", InnerType = "SpellPowerCostInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemSkillLineIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Get the index of the SkillLine this SpellBookItem is part of" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "skillLineIndex", Type = "luaIndex", Nilable = true, Documentation = { "Will be nil if the specified SpellBookItem doesn't exist or isn't part of a SkillLine" } }, + }, + }, + { + Name = "GetSpellBookItemTexture", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "iconID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemTradeSkillLink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns nil if SpellBookItem is not associated with a trade skill" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "spellLink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItemType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "itemType", Type = "SpellBookItemType", Nilable = false }, + { Name = "actionID", Type = "number", Nilable = false, Documentation = { "Represents a base spellID for spells, flyoutID for flyouts, or petActionID for pet actions" } }, + { Name = "spellID", Type = "number", Nilable = true, Documentation = { "May be nil if item is not a spell; Will be the overriding spellID if spell is overriden, otherwise will match actionID" } }, + }, + }, + { + Name = "GetSpellBookSkillLineInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "skillLineInfo", Type = "SpellBookSkillLineInfo", Nilable = false }, + }, + }, + { + Name = "HasPetSpells", + Type = "Function", + MayReturnNothing = true, + Documentation = { "Returns nothing if player has no pet spells" }, + + Returns = + { + { Name = "numPetSpells", Type = "number", Nilable = false }, + { Name = "petNameToken", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsAutoAttackSpellBookItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookItem is the player's melee Auto Attack spell" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsClassTalentSpellBookItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookItem comes from a Class Talent" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isClassTalent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPvPTalentSpellBookItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookItem comes from a PvP Talent" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isPvPTalent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRangedAutoAttackSpellBookItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookItem is the player's ranged Auto Attack spell (ex: Shoot, Auto Shot, etc)" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isRangedAutoAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellBookItemHarmful", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookIem can be cast on hostile targets" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellBookItemHelpful", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookIem can be cast on the player or other friendly targets" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isHelpful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellBookItemInRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the current target is within range of the SpellBookIem; False if out of range; Nil if range check was invalid" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + { Name = "targetUnit", Type = "UnitToken", Nilable = true, Documentation = { "Optional specific target; If not supplied, player's current target (if any) will be used" } }, + }, + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = true, Documentation = { "May be nil if the range check was invalid, ie due to unknown/invalid spell, missing/invalid target, etc" } }, + }, + }, + { + Name = "IsSpellBookItemOffSpec", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookItem belongs to a non-active class specialization" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isOffSpec", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellBookItemPassive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookItem is a passive spell; Will always return false if it is not a spell" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isPassive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellBookItemUsable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the SpellBookIem is currently castable; Typically based on things like learned status, required resources, etc" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "insufficientPower", Type = "bool", Nilable = false, Documentation = { "True if SpellBookIem is specifically unusable due to insufficient power (ie MANA, RAGE, etc)" } }, + }, + }, + { + Name = "IsSpellInSpellBook", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a spell should be found in the spellbook. This function can also return true for spells that aren't known, such as override spells granted by an aura linked to class talents" }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "spellBank", Type = "SpellBookSpellBank", Nilable = false, Default = "Player" }, + { Name = "includeOverrides", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "isInSpellBook", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellKnown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a player knows a spell. This function can also return true for spells that aren't in the spellbook, such as temporarily-granted abilities" }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "spellBank", Type = "SpellBookSpellBank", Nilable = false, Default = "Player" }, + }, + + Returns = + { + { Name = "isKnown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellKnownOrInSpellBook", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if a spell is considered to be known or present in the spellbook" }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "spellBank", Type = "SpellBookSpellBank", Nilable = false, Default = "Player" }, + { Name = "includeOverrides", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "isKnownOrInSpellBook", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupSpellBookItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + }, + { + Name = "SetSpellBookItemAutoCastEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellBookItemHasRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the SpellBookIem has a min and/or max range greater than 0; Will always return false if it is not a spell" }, + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "hasRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ToggleSpellBookItemAutoCast", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CurrentSpellCastChanged", + Type = "Event", + LiteralName = "CURRENT_SPELL_CAST_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "cancelledCast", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LearnedSpellInSkillLine", + Type = "Event", + LiteralName = "LEARNED_SPELL_IN_SKILL_LINE", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "skillLineIndex", Type = "luaIndex", Nilable = false }, + { Name = "isGuildPerkSpell", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MaxSpellStartRecoveryOffsetChanged", + Type = "Event", + LiteralName = "MAX_SPELL_START_RECOVERY_OFFSET_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "clampedNewQueueWindowMs", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerTotemUpdate", + Type = "Event", + LiteralName = "PLAYER_TOTEM_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "totemSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SpellFlyoutUpdate", + Type = "Event", + LiteralName = "SPELL_FLYOUT_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "flyoutID", Type = "number", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = true }, + { Name = "isLearned", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SpellPushedToActionbar", + Type = "Event", + LiteralName = "SPELL_PUSHED_TO_ACTIONBAR", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "page", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpellPushedToFlyoutOnActionbar", + Type = "Event", + LiteralName = "SPELL_PUSHED_TO_FLYOUT_ON_ACTIONBAR", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "flyoutSlot", Type = "luaIndex", Nilable = false }, + { Name = "flyoutPage", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SpellUpdateCharges", + Type = "Event", + LiteralName = "SPELL_UPDATE_CHARGES", + SynchronousEvent = true, + UniqueEvent = true, + }, + { + Name = "SpellUpdateCooldown", + Type = "Event", + LiteralName = "SPELL_UPDATE_COOLDOWN", + UniqueEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = true, Documentation = { "Can be a base spell or an override spell. A nil value indicates that all cooldowns should be updated, rather than just a specific one." } }, + { Name = "baseSpellID", Type = "number", Nilable = true, Documentation = { "Will be set to the base spell if the spellID parameter is an override spell." } }, + { Name = "category", Type = "number", Nilable = true, Documentation = { "If the spellID parameter is set, the cooldown category of the spell. A nil value indicates the spell does not have a cooldown category." } }, + { Name = "startRecoveryCategory", Type = "number", Nilable = true, Documentation = { "If the spellID parameter is set, the cooldown start recovery category of the spell. A nil value indicates the spell does not have a cooldown start recovery category." } }, + }, + }, + { + Name = "SpellUpdateIcon", + Type = "Event", + LiteralName = "SPELL_UPDATE_ICON", + UniqueEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = true, Documentation = { "Always refers to the base spell. A nil value indicates that all icons should be updated, rather than just a specific one." } }, + }, + }, + { + Name = "SpellUpdateUsable", + Type = "Event", + LiteralName = "SPELL_UPDATE_USABLE", + UniqueEvent = true, + }, + { + Name = "SpellUpdateUses", + Type = "Event", + LiteralName = "SPELL_UPDATE_USES", + UniqueEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false, Documentation = { "Can be a base spell or override spell." } }, + { Name = "baseSpellID", Type = "number", Nilable = true, Documentation = { "Will be set to the base spell if the spellID parameter is an override spell." } }, + }, + }, + { + Name = "SpellsChanged", + Type = "Event", + LiteralName = "SPELLS_CHANGED", + UniqueEvent = true, + }, + { + Name = "StartAutorepeatSpell", + Type = "Event", + LiteralName = "START_AUTOREPEAT_SPELL", + SynchronousEvent = true, + }, + { + Name = "StopAutorepeatSpell", + Type = "Event", + LiteralName = "STOP_AUTOREPEAT_SPELL", + SynchronousEvent = true, + }, + { + Name = "UpdateShapeshiftCooldown", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_COOLDOWN", + UniqueEvent = true, + }, + { + Name = "UpdateShapeshiftForm", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_FORM", + SynchronousEvent = true, + }, + { + Name = "UpdateShapeshiftForms", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_FORMS", + UniqueEvent = true, + }, + { + Name = "UpdateShapeshiftUsable", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_USABLE", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "SpellBookItemInfo", + Type = "Structure", + Fields = + { + { Name = "actionID", Type = "number", Nilable = false, Documentation = { "Represents a base spellID for spells, flyoutID for flyouts, or petActionID for pet actions" } }, + { Name = "spellID", Type = "number", Nilable = true, Documentation = { "May be nil if item is not a spell; Will be the overriding spellID if spell is overriden, otherwise will match actionID" } }, + { Name = "itemType", Type = "SpellBookItemType", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "subName", Type = "string", Nilable = false, Documentation = { "May be empty if flyout, or if spell's data isn't loaded yet; Listen for SPELL_TEXT_UPDATE event, or use SpellMixin to load asynchronously" } }, + { Name = "iconID", Type = "fileID", Nilable = false }, + { Name = "isPassive", Type = "bool", Nilable = false, Documentation = { "True if the item is a passive spell; Will always be false if it is not a spell" } }, + { Name = "isOffSpec", Type = "bool", Nilable = false, Documentation = { "True if the item belongs to a non-active specialization" } }, + { Name = "skillLineIndex", Type = "luaIndex", Nilable = true, Documentation = { "Index of the SkillLine this SpellBookItem is part of; Nil this SpellBookItem isn't part of a SkillLine" } }, + }, + }, + { + Name = "SpellBookSkillLineInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconID", Type = "fileID", Nilable = false }, + { Name = "itemIndexOffset", Type = "number", Nilable = false, Documentation = { "This value + 1 is the first Spell Book Item slotIndex within this skill line" } }, + { Name = "numSpellBookItems", Type = "number", Nilable = false }, + { Name = "isGuild", Type = "bool", Nilable = false }, + { Name = "shouldHide", Type = "bool", Nilable = false }, + { Name = "specID", Type = "number", Nilable = true, Documentation = { "Will be nil if this skill line is not associated with a specialization" } }, + { Name = "offSpecID", Type = "number", Nilable = true, Documentation = { "Will be nil if this skill line is not associated with a non-active specialization" } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellBook); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..10f56bc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,44 @@ +local SpellConstants = +{ + Tables = + { + { + Name = "ConfirmationPromptUIType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "StaticText", Type = "ConfirmationPromptUIType", EnumValue = 0 }, + { Name = "BonusRoll", Type = "ConfirmationPromptUIType", EnumValue = 1 }, + { Name = "SimpleWarning", Type = "ConfirmationPromptUIType", EnumValue = 2 }, + { Name = "StaticTextAlert", Type = "ConfirmationPromptUIType", EnumValue = 3 }, + { Name = "SimpleWarningAlert", Type = "ConfirmationPromptUIType", EnumValue = 4 }, + }, + }, + { + Name = "SpellAuraVisibilityType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "RaidInCombat", Type = "SpellAuraVisibilityType", EnumValue = 0 }, + { Name = "RaidOutOfCombat", Type = "SpellAuraVisibilityType", EnumValue = 1 }, + { Name = "EnemyTarget", Type = "SpellAuraVisibilityType", EnumValue = 2 }, + }, + }, + { + Name = "SpellCooldownConsts", + Type = "Constants", + Values = + { + { Name = "GLOBAL_RECOVERY_CATEGORY", Type = "number", Value = 133 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a34167b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,39 @@ +local SpellDiminishConstants = +{ + Tables = + { + { + Name = "SpellDiminishCategory", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Root", Type = "SpellDiminishCategory", EnumValue = 0 }, + { Name = "Taunt", Type = "SpellDiminishCategory", EnumValue = 1 }, + { Name = "Stun", Type = "SpellDiminishCategory", EnumValue = 2 }, + { Name = "AoEKnockback", Type = "SpellDiminishCategory", EnumValue = 3 }, + { Name = "Incapacitate", Type = "SpellDiminishCategory", EnumValue = 4 }, + { Name = "Disorient", Type = "SpellDiminishCategory", EnumValue = 5 }, + { Name = "Silence", Type = "SpellDiminishCategory", EnumValue = 6 }, + { Name = "Disarm", Type = "SpellDiminishCategory", EnumValue = 7 }, + }, + }, + { + Name = "SpellDiminishRuleset", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "SpellDiminishRuleset", EnumValue = 0 }, + { Name = "PvE", Type = "SpellDiminishRuleset", EnumValue = 1 }, + { Name = "PvP", Type = "SpellDiminishRuleset", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellDiminishConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dea81a5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDiminishUIDocumentation.lua.annotated.lua @@ -0,0 +1,114 @@ +local SpellDiminishUI = +{ + Name = "SpellDiminishUI", + Type = "System", + Namespace = "C_SpellDiminish", + Environment = "All", + + Functions = + { + { + Name = "GetAllSpellDiminishCategories", + Type = "Function", + RequiresSpellDiminishUI = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "ruleset", Type = "SpellDiminishRuleset", Nilable = true }, + }, + + Returns = + { + { Name = "categories", Type = "table", InnerType = "SpellDiminishCategoryInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellDiminishCategoryInfo", + Type = "Function", + RequiresSpellDiminishUI = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "SpellDiminishCategory", Nilable = false }, + }, + + Returns = + { + { Name = "categoryInfo", Type = "SpellDiminishCategoryInfo", Nilable = true }, + }, + }, + { + Name = "IsSystemSupported", + Type = "Function", + + Returns = + { + { Name = "isSystemSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldTrackSpellDiminishCategory", + Type = "Function", + RequiresSpellDiminishUI = true, + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "SpellDiminishCategory", Nilable = false }, + { Name = "ruleset", Type = "SpellDiminishRuleset", Nilable = false }, + }, + + Returns = + { + { Name = "isTracked", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "UnitSpellDiminishCategoryStateUpdated", + Type = "Event", + LiteralName = "UNIT_SPELL_DIMINISH_CATEGORY_STATE_UPDATED", + SecretPayloads = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "trackerInfo", Type = "SpellDiminishTrackerInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "SpellDiminishCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "category", Type = "SpellDiminishCategory", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "SpellDiminishTrackerInfo", + Type = "Structure", + Fields = + { + { Name = "category", Type = "SpellDiminishCategory", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "showCountdown", Type = "bool", Nilable = false }, + { Name = "isImmune", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellDiminishUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7830747 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellDocumentation.lua.annotated.lua @@ -0,0 +1,1077 @@ +local Spell = +{ + Name = "Spell", + Type = "System", + Namespace = "C_Spell", + Environment = "All", + + Functions = + { + { + Name = "CancelSpellByID", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DoesSpellExist", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if the spell exists, regardless of whether the player has learned it" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false, Documentation = { "Spell ID, name, name(subtext), or link; Using name will always check for an override on that spell" } }, + }, + + Returns = + { + { Name = "spellExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EnableSpellRangeCheck", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Used in conjunction with SpellRangeCheckUpdate to inform the UI when a spell goes in or out of range with the current target." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "enable", Type = "bool", Nilable = false, Documentation = { "True if changes in range for the spell should dispatch SpellRangeCheckUpdate. False if the spell no longer needs the event." } }, + }, + }, + { + Name = "GetAuraStatChanges", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "healthChange", Type = "number", Nilable = false }, + { Name = "powerTypeChanges", Type = "table", InnerType = "PowerTypeChange", Nilable = false }, + }, + }, + { + Name = "GetBaseSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "spec", Type = "number", Nilable = false, Default = 0, Documentation = { "Which Class Specialization to consider, as overrides may vary by Spec; Defaults to player's current Spec" } }, + }, + + Returns = + { + { Name = "baseSpellID", Type = "number", Nilable = false, Documentation = { "Returns the spellID passed in if there is no override" } }, + }, + }, + { + Name = "GetDeadlyDebuffInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "deadlyDebuffInfo", Type = "DeadlyDebuffInfo", Nilable = false }, + }, + }, + { + Name = "GetItemModifiedAppearancesApplied", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemModifiedAppearanceIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetMawPowerBorderAtlasBySpellID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rarityBorderAtlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetMawPowerLinkBySpellID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetOverrideSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "spec", Type = "number", Nilable = false, Default = 0, Documentation = { "Which Class Specialization to consider, as overrides may vary by Spec; Defaults to player's current Spec" } }, + { Name = "onlyKnown", Type = "bool", Nilable = false, Default = true }, + { Name = "ignoreOverrideSpellID", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "overrideSpellID", Type = "number", Nilable = false, Documentation = { "Returns the spellID passed in if there is no override" } }, + }, + }, + { + Name = "GetSchoolString", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "schoolMask", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetSpellAutoCast", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "autoCastAllowed", Type = "bool", Nilable = false }, + { Name = "autoCastEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSpellCastCount", + Type = "Function", + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns number of times a spell can be cast, typically based on availability of things like required reagent items; Returns 0 if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "castCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellChargeDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a duration object describing the active recharge time for a spell." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetSpellCharges", + Type = "Function", + MayReturnNothing = true, + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a table of info about the charges of a charge-accumulating spell; May return nil if spell is not found or is not charge-based" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "chargeInfo", Type = "SpellChargeInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellCooldown", + Type = "Function", + MayReturnNothing = true, + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "spellCooldownInfo", Type = "SpellCooldownInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellCooldownDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a duration object describing the active cooldown duration for a spell." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetSpellDescription", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false, Documentation = { "May be empty if spell's data isn't loaded yet; Listen for SPELL_TEXT_UPDATE event, or use SpellMixin to load asynchronously" } }, + }, + }, + { + Name = "GetSpellDisplayCount", + Type = "Function", + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Depending on the spell, return a string that is either the use count or number of charges. If value is beyond the display count parameter, returns the replacementString (defaults to '*')." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "maxDisplayCount", Type = "number", Nilable = false, Default = 9999 }, + { Name = "replacementString", Type = "cstring", Nilable = false, Default = "*" }, + }, + + Returns = + { + { Name = "displayCount", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellIDForSpellIdentifier", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Meant primarily for getting a spell id from a spell name or link; Returns nothing if spell does not exist" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false, Documentation = { "Spell ID, name, name(subtext), or link; Using name will always check for an override on that spell; If passed a spell ID, will return same id as was passed" } }, + }, + + Returns = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false, Documentation = { "Spell ID, name, name(subtext), or link; Using name will always check for an override on that spell" } }, + }, + + Returns = + { + { Name = "spellInfo", Type = "SpellInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellLevelLearned", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns the level the spell is learned at; May return a different value if the player is currently Level Linked with another player" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "levelLearned", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellLink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "glyphID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "spellLink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellLossOfControlCooldown", + Type = "Function", + MayReturnNothing = true, + SecretWhenSpellCooldownRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellLossOfControlCooldownDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a duration object describing the active loss of control cooldown duration for a spell." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetSpellMaxCumulativeAuraApplications", + Type = "Function", + SecretWhenSpellAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "cumulativeAura", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellName", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellPowerCost", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a table containing one or more SpellPowerCostInfos, one for each power type this spell costs; May return nil if spell is not found or has no resource costs" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "powerCosts", Type = "table", InnerType = "SpellPowerCostInfo", Nilable = false }, + }, + }, + { + Name = "GetSpellQueueWindow", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellSkillLineAbilityRank", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns the rank of a spell that corresponds to an ability within a ranked SkillLine (ex: a crafting Recipe); Returns nil if spell is not found, or isn't part of a ranked SkillLine" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellSubtext", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "subtext", Type = "string", Nilable = false, Documentation = { "May be empty if spell's data isn't loaded yet; Listen for SPELL_TEXT_UPDATE event, or use SpellMixin to load asynchronously" } }, + }, + }, + { + Name = "GetSpellTexture", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nothing if spell is not found" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "iconID", Type = "fileID", Nilable = false }, + { Name = "originalIconID", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetSpellTradeSkillLink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns nil if spell is not associated with a trade skill" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "spellLink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetVisibilityInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "visibilityType", Type = "SpellAuraVisibilityType", Nilable = false }, + }, + + Returns = + { + { Name = "hasCustom", Type = "bool", Nilable = false }, + { Name = "alwaysShowMine", Type = "bool", Nilable = false }, + { Name = "showForMySpec", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoAttackSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell is the player's melee Auto Attack spell" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoRepeatSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell is an auto repeat player spell" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoRepeat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsClassTalentSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell comes from a Class Talent" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoRepeat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConsumableSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "consumable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrentSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell is currently being cast or is queued to be cast" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isCurrentSpell", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsExternalDefensive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if an aura is considered an external defensive." }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isExternalDefensive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPressHoldReleaseSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell is an 'empower' type spell that is cast by pressing and holding, with the on-release cast typically being affected by time held" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isPressHoldRelease", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPriorityAura", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if an aura is considered high priority and should be ordered ahead of other auras in the UI." }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isHighPriority", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPvPTalentSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell comes from a PvP Talent" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoRepeat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRangedAutoAttackSpell", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell is the player's ranged Auto Attack spell (ex: Shoot, Auto Shot, etc)" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isRangedAutoAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSelfBuff", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if an aura only applies effects to the player, and no other units." }, + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasSelfEffectsOnly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellCrowdControl", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell causes a crowd control effect when cast on a valid target." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isCrowdControl", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellDataCached", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns true if data for the spell has already been loaded and cached this session" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isCached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellDisabled", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "disabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellHarmful", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell can be cast on hostile targets" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellHelpful", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell can be cast on the player or other friendly targets" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isHelpful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellImportant", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell is considered important. For example a spell that's lethal if not interrupted would be considered important." }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isImportant", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellInRange", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the current target is within range of the spell; False if out of range; Nil if range check was invalid" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "targetUnit", Type = "UnitToken", Nilable = true, Documentation = { "Optional specific target; If not supplied, player's current target (if any) will be used" } }, + }, + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = true, Documentation = { "May be nil if the range check was invalid, ie due to unknown/invalid spell, missing/invalid target, etc" } }, + }, + }, + { + Name = "IsSpellPassive", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isPassive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellUsable", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns whether the spell is currently castable; Typically based on things like learned status, required resources, etc" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "insufficientPower", Type = "bool", Nilable = false, Documentation = { "True if spell is specifically unusable due to insufficient power (ie MANA, RAGE, etc)" } }, + }, + }, + { + Name = "PickupSpell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + }, + { + Name = "RequestLoadSpellData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Requests data for the spell be loaded; Listen for SPELL_DATA_LOAD_RESULT to be notified when load is finished" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + }, + { + Name = "SetSpellAutoCastEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellHasRange", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if the spell has a min and/or max range greater than 0" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + + Returns = + { + { Name = "hasRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TargetSpellIsEnchanting", + Type = "Function", + + Returns = + { + { Name = "isEnchanting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TargetSpellJumpsUpgradeTrack", + Type = "Function", + + Returns = + { + { Name = "jumpsUpgradeTrack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TargetSpellReplacesBonusTree", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ToggleSpellAutoCast", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Toggles whether spell's autoCast is enabled" }, + + Arguments = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "EnchantSpellCompleted", + Type = "Event", + LiteralName = "ENCHANT_SPELL_COMPLETED", + SynchronousEvent = true, + Payload = + { + { Name = "successful", Type = "bool", Nilable = false }, + { Name = "enchantedItem", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = true }, + }, + }, + { + Name = "EnchantSpellSelected", + Type = "Event", + LiteralName = "ENCHANT_SPELL_SELECTED", + SynchronousEvent = true, + }, + { + Name = "SpellDataLoadResult", + Type = "Event", + LiteralName = "SPELL_DATA_LOAD_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellRangeCheckUpdate", + Type = "Event", + LiteralName = "SPELL_RANGE_CHECK_UPDATE", + SynchronousEvent = true, + Documentation = { "Used in conjunction with EnableSpellRangeCheck to inform the UI when a spell goes in or out of range with the current target." }, + Payload = + { + { Name = "spellIdentifier", Type = "SpellIdentifier", Nilable = false }, + { Name = "isInRange", Type = "bool", Nilable = false, Documentation = { "Whether or not the current target is in range of the spell. Should not be used if the 'checksRange' parameter is false." } }, + { Name = "checksRange", Type = "bool", Nilable = false, Documentation = { "Can be false if a range check was not made for any reason, for example there is not a current target." } }, + }, + }, + { + Name = "SpellTextUpdate", + Type = "Event", + LiteralName = "SPELL_TEXT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateSpellTargetItemContext", + Type = "Event", + LiteralName = "UPDATE_SPELL_TARGET_ITEM_CONTEXT", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "DeadlyDebuffInfo", + Type = "Structure", + Fields = + { + { Name = "criticalTimeRemainingMs", Type = "number", Nilable = true }, + { Name = "criticalStacks", Type = "number", Nilable = true }, + { Name = "priority", Type = "number", Nilable = false }, + { Name = "warningText", Type = "string", Nilable = false }, + { Name = "soundKitID", Type = "number", Nilable = true }, + }, + }, + { + Name = "PowerTypeChange", + Type = "Structure", + Fields = + { + { Name = "powerType", Type = "PowerType", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpellInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconID", Type = "fileID", Nilable = false, Documentation = { "Icon for this spell; If spell has been overriden, this may be the icon for the overriding spell; See originalIconID for spell's non-overriden icon" } }, + { Name = "originalIconID", Type = "fileID", Nilable = false }, + { Name = "castTime", Type = "number", Nilable = false }, + { Name = "minRange", Type = "number", Nilable = false }, + { Name = "maxRange", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Spell); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellIDDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellIDDocumentation.lua.annotated.lua new file mode 100644 index 0000000..572a09e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellIDDocumentation.lua.annotated.lua @@ -0,0 +1,28 @@ +local SpellID = +{ + Tables = + { + { + Name = "SpellBookSpellIDs", + Type = "Constants", + Values = + { + { Name = "SPELL_ID_DISMISS_PET", Type = "number", Value = 2641 }, + }, + }, + { + Name = "UnitPowerSpellIDs", + Type = "Constants", + Values = + { + { Name = "VOID_METAMORPHOSIS_SPELL_ID", Type = "number", Value = 1217607 }, + { Name = "DARK_HEART_SPELL_ID", Type = "number", Value = 1225789 }, + { Name = "SILENCE_THE_WHISPERS_SPELL_ID", Type = "number", Value = 1227702 }, + { Name = "COLLAPSING_STAR_PASSIVE_SPELL_ID", Type = "number", Value = 1221167 }, + { Name = "COLLAPSING_STAR_SPELL_ID", Type = "number", Value = 1221150 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellID); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ddf5742 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SpellSharedDocumentation.lua.annotated.lua @@ -0,0 +1,49 @@ +local SpellShared = +{ + Tables = + { + { + Name = "SpellChargeInfo", + Type = "Structure", + Fields = + { + { Name = "currentCharges", Type = "number", Nilable = false, Documentation = { "Number of charges currently available" } }, + { Name = "maxCharges", Type = "number", Nilable = false, Documentation = { "Max number of charges that can be accumulated" } }, + { Name = "cooldownStartTime", Type = "number", Nilable = false, Documentation = { "If charge cooldown is active, time at which the most recent charge cooldown began; 0 if cooldown is not active" } }, + { Name = "cooldownDuration", Type = "number", Nilable = false, Documentation = { "Cooldown duration in seconds required to generate a charge" } }, + { Name = "chargeModRate", Type = "number", Nilable = false, Documentation = { "Rate at which cooldown UI should update" } }, + }, + }, + { + Name = "SpellCooldownInfo", + Type = "Structure", + Fields = + { + { Name = "startTime", Type = "number", Nilable = false, Documentation = { "If cooldown is active, time started; 0 if no cooldown; Current time if isEnabled is false" } }, + { Name = "duration", Type = "number", Nilable = false, Documentation = { "Cooldown duration in seconds if active; 0 if cooldown is inactive" } }, + { Name = "isEnabled", Type = "bool", Nilable = false, Documentation = { "False if cooldown is on hold (ex: some cooldowns only start after an active spell is cancelled); True otherwise" } }, + { Name = "modRate", Type = "number", Nilable = false, Documentation = { "Rate at which cooldown UI should update" } }, + { Name = "activeCategory", Type = "number", Nilable = true, Documentation = { "Indicates which category is responsible for determining the duration. A nil value indicates the duration was determined through some other logic, e.g. the spell is on hold." } }, + { Name = "timeUntilEndOfStartRecovery", Type = "number", Nilable = true, Documentation = { "When this is set it indicates that the spell is in recovery and this is how long it will be until that recovery period is finished" } }, + { Name = "isOnGCD", Type = "bool", Nilable = true, NeverSecret = true, Documentation = { "Whether or not this spell is considered to be on the global cooldown, do not trust this field unless responding to a SPELL_UPDATE_COOLDOWN event" } }, + }, + }, + { + Name = "SpellPowerCostInfo", + Type = "Structure", + Fields = + { + { Name = "type", Type = "PowerType", Nilable = false }, + { Name = "name", Type = "string", Nilable = false, Documentation = { "The name or 'power token' for this power type (ex: MANA, FOCUS, etc)" } }, + { Name = "cost", Type = "number", Nilable = false, Documentation = { "Full cost including optional cost; Optional cost is cost the spell will use but isn't required (ex: Rogue spell might cost 1CP but have optional cost of up to 5 more)" } }, + { Name = "minCost", Type = "number", Nilable = false, Documentation = { "Cost excluding optional cost; This is min required to cast the spell" } }, + { Name = "costPercent", Type = "number", Nilable = false, Documentation = { "Cost as a percentage of base maximum resource; May be 0 if the cost is simply a flat cost" } }, + { Name = "costPerSec", Type = "number", Nilable = false, Documentation = { "Cost as a percentage of base maximum resource consumed per second, used by channel spells; May be 0 if cost is simply a flat cost" } }, + { Name = "requiredAuraID", Type = "number", Nilable = false, Documentation = { "An aura the caster must have for the cost to apply; Usually based on things like active spec or shapeshift form" } }, + { Name = "hasRequiredAura", Type = "bool", Nilable = false, Documentation = { "True if there is a requiredAuraID and the caster currently has that aura; Caster is either the current player or their pet, depending on spell type" } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SpellShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ff48694 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local SplashScreenConstants = +{ + Tables = + { + { + Name = "SplashScreenType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "WhatsNew", Type = "SplashScreenType", EnumValue = 0 }, + { Name = "SeasonRollOver", Type = "SplashScreenType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SplashScreenConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua.annotated.lua new file mode 100644 index 0000000..462a033 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SplashScreenDocumentation.lua.annotated.lua @@ -0,0 +1,87 @@ +local SplashScreen = +{ + Name = "SplashScreen", + Type = "System", + Namespace = "C_SplashScreen", + Environment = "All", + + Functions = + { + { + Name = "AcknowledgeSplash", + Type = "Function", + }, + { + Name = "CanViewSplashScreen", + Type = "Function", + + Returns = + { + { Name = "canView", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestLatestSplashScreen", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fromGameMenu", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SendSplashScreenActionLaunchedTelem", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "SendSplashScreenCloseTelem", + Type = "Function", + HasRestrictions = true, + }, + }, + + Events = + { + { + Name = "OpenSplashScreen", + Type = "Event", + LiteralName = "OPEN_SPLASH_SCREEN", + SynchronousEvent = true, + Payload = + { + { Name = "info", Type = "SplashScreenInfo", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "SplashScreenInfo", + Type = "Structure", + Fields = + { + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "minDisplayCharLevel", Type = "number", Nilable = false }, + { Name = "minQuestDisplayLevel", Type = "number", Nilable = false }, + { Name = "soundKitID", Type = "number", Nilable = false }, + { Name = "allianceQuestID", Type = "number", Nilable = true }, + { Name = "hordeQuestID", Type = "number", Nilable = true }, + { Name = "header", Type = "string", Nilable = false }, + { Name = "topLeftFeatureTitle", Type = "string", Nilable = false }, + { Name = "topLeftFeatureDesc", Type = "string", Nilable = false }, + { Name = "bottomLeftFeatureTitle", Type = "string", Nilable = false }, + { Name = "bottomLeftFeatureDesc", Type = "string", Nilable = false }, + { Name = "rightFeatureTitle", Type = "string", Nilable = false }, + { Name = "rightFeatureDesc", Type = "string", Nilable = false }, + { Name = "shouldShowQuest", Type = "bool", Nilable = false }, + { Name = "screenType", Type = "SplashScreenType", Nilable = false }, + { Name = "gameMenuRequest", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SplashScreen); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..62642b6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StableInfoDocumentation.lua.annotated.lua @@ -0,0 +1,228 @@ +local StableInfo = +{ + Name = "StableInfo", + Type = "System", + Namespace = "C_StableInfo", + Environment = "All", + + Functions = + { + { + Name = "ClosePetStables", + Type = "Function", + }, + { + Name = "GetActivePetList", + Type = "Function", + + Returns = + { + { Name = "activePets", Type = "table", InnerType = "PetInfo", Nilable = false }, + }, + }, + { + Name = "GetAvailablePetSpecInfos", + Type = "Function", + + Returns = + { + { Name = "petSpecInfos", Type = "table", InnerType = "PetSpecInfo", Nilable = false }, + }, + }, + { + Name = "GetNumActivePets", + Type = "Function", + + Returns = + { + { Name = "numActivePets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumStablePets", + Type = "Function", + + Returns = + { + { Name = "numStablePets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStablePetFoodTypes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "foodTypes", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "GetStablePetInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "petInfo", Type = "PetInfo", Nilable = true }, + }, + }, + { + Name = "GetStabledPetList", + Type = "Function", + + Returns = + { + { Name = "stabledPets", Type = "table", InnerType = "PetInfo", Nilable = false }, + }, + }, + { + Name = "IsAtStableMaster", + Type = "Function", + + Returns = + { + { Name = "isAtStableMaster", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsBonusPetSlotAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPetFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupStablePet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetPetFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPetSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "PetInfoUpdate", + Type = "Event", + LiteralName = "PET_INFO_UPDATE", + UniqueEvent = true, + }, + { + Name = "PetStableClosed", + Type = "Event", + LiteralName = "PET_STABLE_CLOSED", + SynchronousEvent = true, + }, + { + Name = "PetStableFavoritesUpdated", + Type = "Event", + LiteralName = "PET_STABLE_FAVORITES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "PetStableShow", + Type = "Event", + LiteralName = "PET_STABLE_SHOW", + SynchronousEvent = true, + }, + { + Name = "PetStableUpdate", + Type = "Event", + LiteralName = "PET_STABLE_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "PetInfo", + Type = "Structure", + Fields = + { + { Name = "slotID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "familyName", Type = "string", Nilable = false }, + { Name = "specialization", Type = "string", Nilable = false }, + { Name = "type", Type = "string", Nilable = false }, + { Name = "petAbilities", Type = "table", InnerType = "number", Nilable = false }, + { Name = "specAbilities", Type = "table", InnerType = "number", Nilable = false }, + { Name = "displayID", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "isExotic", Type = "bool", Nilable = false }, + { Name = "uiModelSceneID", Type = "number", Nilable = false, Default = 718 }, + { Name = "petNumber", Type = "number", Nilable = false }, + { Name = "creatureID", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetSpecInfo", + Type = "Structure", + Fields = + { + { Name = "specID", Type = "number", Nilable = false }, + { Name = "specIndex", Type = "luaIndex", Nilable = false }, + { Name = "specializationName", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(StableInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..64f4322 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StorePublicUIDocumentation.lua.annotated.lua @@ -0,0 +1,56 @@ +local StorePublicUI = +{ + Name = "StorePublic", + Type = "System", + Namespace = "C_StorePublic", + Environment = "All", + + Functions = + { + { + Name = "DoesGroupHavePurchaseableProducts", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "groupID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasPurchaseableProducts", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventStoreUISetShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "newShown", Type = "bool", Nilable = false }, + { Name = "contextKey", Type = "string", Nilable = true }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(StorePublicUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f1849c2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StreamingDocumentation.lua.annotated.lua @@ -0,0 +1,56 @@ +local Streaming = +{ + Name = "Streaming", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetAvailableBandwidth", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBackgroundLoadingStatus", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDownloadedPercentage", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFileStreamingStatus", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Streaming); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..85d5f10 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/StringUtilDocumentation.lua.annotated.lua @@ -0,0 +1,215 @@ +local StringUtil = +{ + Name = "StringUtil", + Type = "System", + Namespace = "C_StringUtil", + Environment = "All", + + Functions = + { + { + Name = "EscapeLuaFormatString", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a string with Lua format string tokens ('%') escaped." }, + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "escapedText", Type = "stringView", Nilable = false }, + }, + }, + { + Name = "EscapeLuaPatterns", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a string with all Lua pattern characters escaped." }, + + Arguments = + { + { Name = "text", Type = "stringView", Nilable = false }, + }, + + Returns = + { + { Name = "escapedText", Type = "string", Nilable = false }, + }, + }, + { + Name = "EscapeQuotedCodes", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a string with all quoted code sequences ('|' characters) escaped." }, + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "escaped", Type = "stringView", Nilable = false }, + }, + }, + { + Name = "FloorToNearestString", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "number", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "RemoveContiguousSpaces", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a string with all contiguous occurrences of ASCII space characters truncated." }, + + Arguments = + { + { Name = "text", Type = "stringView", Nilable = false }, + { Name = "maxAllowedSpaces", Type = "number", Nilable = false, Documentation = { "Maximum number of permitted contiguous space characters; excessive spaces will be truncated to this count." } }, + }, + + Returns = + { + { Name = "trimmedText", Type = "string", Nilable = false }, + }, + }, + { + Name = "RoundToNearestString", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "number", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "StripHyperlinks", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "maintainColor", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all '|c' and '|r' quoted code sequences." } }, + { Name = "maintainBrackets", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all '[' and ']' characters." } }, + { Name = "stripNewlines", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, remove all '|n' quoted code sequences." } }, + { Name = "maintainAtlases", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all balanced '|A' and '|a' quoted code sequences." } }, + { Name = "maintainTextures", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all balanced '|T' and '|t' quoted code sequences." } }, + }, + + Returns = + { + { Name = "stripped", Type = "stringView", Nilable = false }, + }, + }, + { + Name = "StripTextureMarkupForLooseFiles", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "stripped", Type = "stringView", Nilable = false }, + }, + }, + { + Name = "trim", + Type = "Function", + Namespace = "string", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a string with all bytes in the 'characters' set removed from the start and end." }, + + Arguments = + { + { Name = "str", Type = "stringView", Nilable = false }, + { Name = "characters", Type = "stringView", Nilable = false, Default = " \\r\\n\\t" }, + }, + + Returns = + { + { Name = "trimmed", Type = "stringView", Nilable = false }, + }, + }, + { + Name = "TruncateWhenZero", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Formats the given number to a string as an integer (rounding down). If the integer is zero, returns an empty string." }, + + Arguments = + { + { Name = "number", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "WrapString", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns a string with 'prefix' and 'suffix' joined to 'infix' iif 'infix' is not an empty string. Else, an empty string is returned." }, + + Arguments = + { + { Name = "infix", Type = "stringView", Nilable = false }, + { Name = "prefix", Type = "stringView", Nilable = true }, + { Name = "suffix", Type = "stringView", Nilable = true }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "StripHyperlinkOptions", + Type = "Structure", + Fields = + { + { Name = "maintainColor", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all '|c' and '|r' quoted code sequences." } }, + { Name = "maintainBrackets", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all '[' and ']' characters." } }, + { Name = "stripNewlines", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, remove all '|n' quoted code sequences." } }, + { Name = "maintainAtlases", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all balanced '|A' and '|a' quoted code sequences." } }, + { Name = "maintainTextures", Type = "bool", Nilable = false, Default = false, Documentation = { "If true, preserve all balanced '|T' and '|t' quoted code sequences." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(StringUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..32245b4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local SummonConstants = +{ + Tables = + { + { + Name = "SummonReason", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Spell", Type = "SummonReason", EnumValue = 0 }, + { Name = "Scenario", Type = "SummonReason", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SummonConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..75691e0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SummonInfoDocumentation.lua.annotated.lua @@ -0,0 +1,74 @@ +local SummonInfo = +{ + Name = "SummonInfo", + Type = "System", + Namespace = "C_SummonInfo", + Environment = "All", + + Functions = + { + { + Name = "CancelSummon", + Type = "Function", + }, + { + Name = "ConfirmSummon", + Type = "Function", + }, + { + Name = "GetSummonConfirmAreaName", + Type = "Function", + + Returns = + { + { Name = "areaName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSummonConfirmSummoner", + Type = "Function", + + Returns = + { + { Name = "summoner", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetSummonConfirmTimeLeft", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSummonReason", + Type = "Function", + + Returns = + { + { Name = "summonReason", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsSummonSkippingStartExperience", + Type = "Function", + + Returns = + { + { Name = "isSummonSkippingStartExperience", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SummonInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2a41d3c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerDocumentation.lua.annotated.lua @@ -0,0 +1,229 @@ +local SuperTrackManager = +{ + Name = "SuperTrackManager", + Type = "System", + Namespace = "C_SuperTrack", + Environment = "All", + + Functions = + { + { + Name = "ClearAllSuperTracked", + Type = "Function", + }, + { + Name = "ClearSuperTrackedContent", + Type = "Function", + }, + { + Name = "ClearSuperTrackedMapPin", + Type = "Function", + }, + { + Name = "GetHighestPrioritySuperTrackingType", + Type = "Function", + + Returns = + { + { Name = "type", Type = "SuperTrackingType", Nilable = true }, + }, + }, + { + Name = "GetNextWaypointForMap", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "waypointDescription", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSuperTrackedContent", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSuperTrackedItemName", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSuperTrackedMapPin", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "type", Type = "SuperTrackingMapPinType", Nilable = false }, + { Name = "typeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSuperTrackedQuestID", + Type = "Function", + + Returns = + { + { Name = "questID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSuperTrackedVignette", + Type = "Function", + + Returns = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "IsSuperTrackingAnything", + Type = "Function", + + Returns = + { + { Name = "isSuperTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSuperTrackingContent", + Type = "Function", + + Returns = + { + { Name = "isSuperTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSuperTrackingCorpse", + Type = "Function", + + Returns = + { + { Name = "isSuperTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSuperTrackingMapPin", + Type = "Function", + + Returns = + { + { Name = "isSuperTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSuperTrackingQuest", + Type = "Function", + + Returns = + { + { Name = "isSuperTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSuperTrackingUserWaypoint", + Type = "Function", + + Returns = + { + { Name = "isSuperTracking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSuperTrackedContent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trackableType", Type = "ContentTrackingType", Nilable = false }, + { Name = "trackableID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSuperTrackedMapPin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "SuperTrackingMapPinType", Nilable = false }, + { Name = "typeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSuperTrackedQuestID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSuperTrackedUserWaypoint", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "superTracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSuperTrackedVignette", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SuperTrackingChanged", + Type = "Event", + LiteralName = "SUPER_TRACKING_CHANGED", + UniqueEvent = true, + }, + { + Name = "SuperTrackingPathUpdated", + Type = "Event", + LiteralName = "SUPER_TRACKING_PATH_UPDATED", + UniqueEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SuperTrackManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..09e17e9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SuperTrackManagerSharedDocumentation.lua.annotated.lua @@ -0,0 +1,41 @@ +local SuperTrackManagerShared = +{ + Tables = + { + { + Name = "SuperTrackingMapPinType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "AreaPOI", Type = "SuperTrackingMapPinType", EnumValue = 0 }, + { Name = "QuestOffer", Type = "SuperTrackingMapPinType", EnumValue = 1 }, + { Name = "TaxiNode", Type = "SuperTrackingMapPinType", EnumValue = 2 }, + { Name = "DigSite", Type = "SuperTrackingMapPinType", EnumValue = 3 }, + { Name = "HousingPlot", Type = "SuperTrackingMapPinType", EnumValue = 4 }, + }, + }, + { + Name = "SuperTrackingType", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Quest", Type = "SuperTrackingType", EnumValue = 0 }, + { Name = "UserWaypoint", Type = "SuperTrackingType", EnumValue = 1 }, + { Name = "Corpse", Type = "SuperTrackingType", EnumValue = 2 }, + { Name = "Scenario", Type = "SuperTrackingType", EnumValue = 3 }, + { Name = "Content", Type = "SuperTrackingType", EnumValue = 4 }, + { Name = "PartyMember", Type = "SuperTrackingType", EnumValue = 5 }, + { Name = "MapPin", Type = "SuperTrackingType", EnumValue = 6 }, + { Name = "Vignette", Type = "SuperTrackingType", EnumValue = 7 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SuperTrackManagerShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b4dc9ab --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemDocumentation.lua.annotated.lua @@ -0,0 +1,238 @@ +local System = +{ + Name = "SystemInfo", + Type = "System", + Namespace = "C_System", + Environment = "All", + + Functions = + { + { + Name = "GetFrameStack", + Type = "Function", + + Returns = + { + { Name = "objects", Type = "table", InnerType = "ScriptRegion", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CaptureframesFailed", + Type = "Event", + LiteralName = "CAPTUREFRAMES_FAILED", + SynchronousEvent = true, + }, + { + Name = "CaptureframesSucceeded", + Type = "Event", + LiteralName = "CAPTUREFRAMES_SUCCEEDED", + SynchronousEvent = true, + }, + { + Name = "DisableTaxiBenchmark", + Type = "Event", + LiteralName = "DISABLE_TAXI_BENCHMARK", + SynchronousEvent = true, + }, + { + Name = "EnableTaxiBenchmark", + Type = "Event", + LiteralName = "ENABLE_TAXI_BENCHMARK", + SynchronousEvent = true, + }, + { + Name = "FirstFrameRendered", + Type = "Event", + LiteralName = "FIRST_FRAME_RENDERED", + UniqueEvent = true, + }, + { + Name = "GenericError", + Type = "Event", + LiteralName = "GENERIC_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "errorMessage", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GlobalMouseDown", + Type = "Event", + LiteralName = "GLOBAL_MOUSE_DOWN", + SynchronousEvent = true, + Payload = + { + { Name = "button", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GlobalMouseUp", + Type = "Event", + LiteralName = "GLOBAL_MOUSE_UP", + SynchronousEvent = true, + Payload = + { + { Name = "button", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "InitialHotfixesApplied", + Type = "Event", + LiteralName = "INITIAL_HOTFIXES_APPLIED", + SynchronousEvent = true, + }, + { + Name = "LocResult", + Type = "Event", + LiteralName = "LOC_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LogoutCancel", + Type = "Event", + LiteralName = "LOGOUT_CANCEL", + SynchronousEvent = true, + }, + { + Name = "PlayerCamping", + Type = "Event", + LiteralName = "PLAYER_CAMPING", + SynchronousEvent = true, + }, + { + Name = "PlayerEnteringWorld", + Type = "Event", + LiteralName = "PLAYER_ENTERING_WORLD", + SynchronousEvent = true, + Payload = + { + { Name = "isInitialLogin", Type = "bool", Nilable = false }, + { Name = "isReloadingUi", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerLeavingWorld", + Type = "Event", + LiteralName = "PLAYER_LEAVING_WORLD", + SynchronousEvent = true, + }, + { + Name = "PlayerLogin", + Type = "Event", + LiteralName = "PLAYER_LOGIN", + SynchronousEvent = true, + }, + { + Name = "PlayerLogout", + Type = "Event", + LiteralName = "PLAYER_LOGOUT", + SynchronousEvent = true, + }, + { + Name = "PlayerQuiting", + Type = "Event", + LiteralName = "PLAYER_QUITING", + SynchronousEvent = true, + }, + { + Name = "SearchDbLoaded", + Type = "Event", + LiteralName = "SEARCH_DB_LOADED", + SynchronousEvent = true, + }, + { + Name = "StreamingIcon", + Type = "Event", + LiteralName = "STREAMING_ICON", + SynchronousEvent = true, + Payload = + { + { Name = "streamingStatus", Type = "number", Nilable = false }, + }, + }, + { + Name = "Sysmsg", + Type = "Event", + LiteralName = "SYSMSG", + SynchronousEvent = true, + Payload = + { + { Name = "string", Type = "cstring", Nilable = false }, + { Name = "r", Type = "number", Nilable = false }, + { Name = "g", Type = "number", Nilable = false }, + { Name = "b", Type = "number", Nilable = false }, + }, + }, + { + Name = "TimePlayedMsg", + Type = "Event", + LiteralName = "TIME_PLAYED_MSG", + SynchronousEvent = true, + Payload = + { + { Name = "totalTimePlayed", Type = "number", Nilable = false }, + { Name = "timePlayedThisLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "UiErrorMessage", + Type = "Event", + LiteralName = "UI_ERROR_MESSAGE", + UniqueEvent = true, + Payload = + { + { Name = "errorType", Type = "luaIndex", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "UiErrorPopup", + Type = "Event", + LiteralName = "UI_ERROR_POPUP", + UniqueEvent = true, + Payload = + { + { Name = "errorType", Type = "luaIndex", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "UiInfoMessage", + Type = "Event", + LiteralName = "UI_INFO_MESSAGE", + UniqueEvent = true, + Payload = + { + { Name = "errorType", Type = "luaIndex", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "VariablesLoaded", + Type = "Event", + LiteralName = "VARIABLES_LOADED", + SynchronousEvent = true, + }, + { + Name = "WoWMouseNotFound", + Type = "Event", + LiteralName = "WOW_MOUSE_NOT_FOUND", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(System); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9617dfb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/SystemTimeDocumentation.lua.annotated.lua @@ -0,0 +1,85 @@ +local SystemTime = +{ + Name = "SystemTime", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetGameTime", + Type = "Function", + + Returns = + { + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLocalGameTime", + Type = "Function", + + Returns = + { + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetServerTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSessionTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTickTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsUsingFixedTimeStep", + Type = "Function", + + Returns = + { + { Name = "isUsingFixedTimeStep", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SystemTime); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c3a740e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TTSSettingsDocumentation.lua.annotated.lua @@ -0,0 +1,233 @@ +local TTSSettings = +{ + Name = "TTSSettings", + Type = "System", + Namespace = "C_TTSSettings", + Environment = "All", + + Functions = + { + { + Name = "GetChannelEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelInfo", Type = "ChatChannelInfo", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCharacterSettingsSaved", + Type = "Function", + + Returns = + { + { Name = "settingsBeenSaved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetChatTypeEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setting", Type = "TtsBoolSetting", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSpeechRate", + Type = "Function", + + Returns = + { + { Name = "rate", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpeechVolume", + Type = "Function", + + Returns = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVoiceOptionID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, + }, + + Returns = + { + { Name = "voiceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVoiceOptionName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, + }, + + Returns = + { + { Name = "voiceName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "MarkCharacterSettingsSaved", + Type = "Function", + }, + { + Name = "SetChannelEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelInfo", Type = "ChatChannelInfo", Nilable = false }, + { Name = "newVal", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetChannelKeyEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelKey", Type = "string", Nilable = false }, + { Name = "newVal", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetChatTypeEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "chatName", Type = "cstring", Nilable = false }, + { Name = "newVal", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetDefaultSettings", + Type = "Function", + }, + { + Name = "SetSetting", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setting", Type = "TtsBoolSetting", Nilable = false }, + { Name = "newVal", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetSpeechRate", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "newVal", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetSpeechVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "newVal", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetVoiceOption", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, + { Name = "voiceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetVoiceOptionName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, + { Name = "voiceName", Type = "string", Nilable = false }, + }, + }, + { + Name = "ShouldOverrideMessage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "language", Type = "number", Nilable = false }, + { Name = "messageText", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "overrideMessage", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TTSSettings); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalentAndGlyphConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalentAndGlyphConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..122b023 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalentAndGlyphConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local TalentAndGlyphConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TalentAndGlyphConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalkingHeadDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalkingHeadDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3b3bca4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TalkingHeadDocumentation.lua.annotated.lua @@ -0,0 +1,33 @@ +local TalkingHead = +{ + Name = "TalkingHead", + Type = "System", + Namespace = "C_TalkingHead", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "TalkingheadClose", + Type = "Event", + LiteralName = "TALKINGHEAD_CLOSE", + SynchronousEvent = true, + }, + { + Name = "TalkingheadRequested", + Type = "Event", + LiteralName = "TALKINGHEAD_REQUESTED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TalkingHead); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua.annotated.lua new file mode 100644 index 0000000..604a6c5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TargetScriptDocumentation.lua.annotated.lua @@ -0,0 +1,208 @@ +local TargetScript = +{ + Name = "TargetScript", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "AssistUnit", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false, Default = "" }, + { Name = "exactMatch", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "AttackTarget", + Type = "Function", + }, + { + Name = "ClearFocus", + Type = "Function", + }, + { + Name = "ClearTarget", + Type = "Function", + + Returns = + { + { Name = "willMakeChange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "FocusUnit", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false, Default = "" }, + }, + }, + { + Name = "IsTargetLoose", + Type = "Function", + + Returns = + { + { Name = "isTargetLoose", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TargetDirectionEnemy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "facing", Type = "number", Nilable = false }, + { Name = "coneAngle", Type = "number", Nilable = true }, + }, + }, + { + Name = "TargetDirectionFinished", + Type = "Function", + }, + { + Name = "TargetDirectionFriend", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "facing", Type = "number", Nilable = false }, + { Name = "coneAngle", Type = "number", Nilable = true }, + }, + }, + { + Name = "TargetLastEnemy", + Type = "Function", + }, + { + Name = "TargetLastFriend", + Type = "Function", + }, + { + Name = "TargetLastTarget", + Type = "Function", + }, + { + Name = "TargetNearest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetNearestEnemy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetNearestEnemyPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetNearestFriend", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetNearestFriendPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetNearestPartyMember", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetNearestRaidMember", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reverse", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetPriorityHighlightEnd", + Type = "Function", + }, + { + Name = "TargetPriorityHighlightStart", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "useStartDelay", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TargetToggle", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "TargetUnit", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false, Default = "" }, + { Name = "exactMatch", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TargetScript); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c48bff9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TaxiMapDocumentation.lua.annotated.lua @@ -0,0 +1,146 @@ +local TaxiMap = +{ + Name = "TaxiMap", + Type = "System", + Namespace = "C_TaxiMap", + Environment = "All", + + Functions = + { + { + Name = "GetAllTaxiNodes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns information on taxi nodes at the current flight master." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "taxiNodes", Type = "table", InnerType = "TaxiNodeInfo", Nilable = false }, + }, + }, + { + Name = "GetTaxiNodesForMap", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns information on taxi nodes for a given map, without considering the current flight master." }, + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapTaxiNodes", Type = "table", InnerType = "MapTaxiNodeInfo", Nilable = false }, + }, + }, + { + Name = "ShouldMapShowTaxiNodes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "shouldShowNodes", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "TaxiNodeStatusChanged", + Type = "Event", + LiteralName = "TAXI_NODE_STATUS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "TaximapClosed", + Type = "Event", + LiteralName = "TAXIMAP_CLOSED", + SynchronousEvent = true, + }, + { + Name = "TaximapOpened", + Type = "Event", + LiteralName = "TAXIMAP_OPENED", + SynchronousEvent = true, + Payload = + { + { Name = "system", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "FlightPathFaction", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Neutral", Type = "FlightPathFaction", EnumValue = 0 }, + { Name = "Horde", Type = "FlightPathFaction", EnumValue = 1 }, + { Name = "Alliance", Type = "FlightPathFaction", EnumValue = 2 }, + }, + }, + { + Name = "FlightPathState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Current", Type = "FlightPathState", EnumValue = 0 }, + { Name = "Reachable", Type = "FlightPathState", EnumValue = 1 }, + { Name = "Unreachable", Type = "FlightPathState", EnumValue = 2 }, + }, + }, + { + Name = "MapTaxiNodeInfo", + Type = "Structure", + Fields = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "atlasName", Type = "cstring", Nilable = false }, + { Name = "faction", Type = "FlightPathFaction", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "isUndiscovered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TaxiNodeInfo", + Type = "Structure", + Fields = + { + { Name = "nodeID", Type = "number", Nilable = false }, + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "state", Type = "FlightPathState", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "useSpecialIcon", Type = "bool", Nilable = false }, + { Name = "specialIconCostString", Type = "string", Nilable = true }, + { Name = "isMapLayerTransition", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TaxiMap); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..85b8b97 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local TextureShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TextureShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1974435 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TextureUtilsDocumentation.lua.annotated.lua @@ -0,0 +1,211 @@ +local TextureUtils = +{ + Name = "TextureUtils", + Type = "System", + Namespace = "C_Texture", + Environment = "All", + + Functions = + { + { + Name = "ClearTitleIconTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + }, + }, + { + Name = "GetAtlasElementID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + + Returns = + { + { Name = "elementID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAtlasElements", + Type = "Function", + + Returns = + { + { Name = "atlases", Type = "table", InnerType = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetAtlasExists", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + + Returns = + { + { Name = "atlasExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAtlasID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + + Returns = + { + { Name = "atlasID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAtlasInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "AtlasInfo", Nilable = false }, + }, + }, + { + Name = "GetFilenameFromFileDataID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "fileDataID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "filename", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTitleIconTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "titleID", Type = "string", Nilable = false }, + { Name = "version", Type = "TitleIconVersion", Nilable = false }, + { Name = "callback", Type = "GetTitleIconTextureCallback", Nilable = false }, + }, + }, + { + Name = "IsTitleIconTextureReady", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "titleID", Type = "string", Nilable = false }, + { Name = "version", Type = "TitleIconVersion", Nilable = false }, + }, + + Returns = + { + { Name = "ready", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTitleIconTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + { Name = "titleID", Type = "string", Nilable = false }, + { Name = "version", Type = "TitleIconVersion", Nilable = false }, + }, + }, + { + Name = "SetURLTexture", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + { Name = "url", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "TitleIconVersion", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Small", Type = "TitleIconVersion", EnumValue = 0 }, + { Name = "Medium", Type = "TitleIconVersion", EnumValue = 1 }, + { Name = "Large", Type = "TitleIconVersion", EnumValue = 2 }, + }, + }, + { + Name = "AtlasInfo", + Type = "Structure", + Fields = + { + { Name = "elementName", Type = "cstring", Nilable = false }, + { Name = "width", Type = "number", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + { Name = "rawSize", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "leftTexCoord", Type = "number", Nilable = false }, + { Name = "rightTexCoord", Type = "number", Nilable = false }, + { Name = "topTexCoord", Type = "number", Nilable = false }, + { Name = "bottomTexCoord", Type = "number", Nilable = false }, + { Name = "tilesHorizontally", Type = "bool", Nilable = false }, + { Name = "tilesVertically", Type = "bool", Nilable = false }, + { Name = "file", Type = "fileID", Nilable = true }, + { Name = "filename", Type = "string", Nilable = true }, + { Name = "sliceData", Type = "UITextureSliceData", Nilable = true }, + }, + }, + { + Name = "GetTitleIconTextureCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "success", Type = "bool", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TextureUtils); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b2fd8fe --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ThreatDocumentation.lua.annotated.lua @@ -0,0 +1,46 @@ +local Threat = +{ + Name = "Threat", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetThreatStatusColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameErrorIndex", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsThreatWarningEnabled", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Threat); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua.annotated.lua new file mode 100644 index 0000000..dca9364 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimeDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local Time = +{ + Tables = + { + { + Name = "CalendarTime", + Type = "Structure", + Fields = + { + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "weekday", Type = "luaIndex", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Time); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..81a8cca --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,22 @@ +local TimerConstants = +{ + Tables = + { + { + Name = "StartTimerType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "PvPBeginTimer", Type = "StartTimerType", EnumValue = 0 }, + { Name = "ChallengeModeCountdown", Type = "StartTimerType", EnumValue = 1 }, + { Name = "PlayerCountdown", Type = "StartTimerType", EnumValue = 2 }, + { Name = "PlunderstormCountdown", Type = "StartTimerType", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TimerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b625023 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local TimerunningConstants = +{ + Tables = + { + { + Name = "TimerunningConsts", + Type = "Constants", + Values = + { + { Name = "TIMERUNNING_SEASON_NONE", Type = "number", Value = 0 }, + { Name = "TIMERUNNING_SEASON_PANDARIA", Type = "number", Value = 1 }, + { Name = "TIMERUNNING_SEASON_LEGION", Type = "number", Value = 2 }, + { Name = "TIMERUNNING_ITEM_CTR", Type = "number", Value = 2905 }, + { Name = "TIMERUNNING_LEGION_ARTIFACT_CTR", Type = "number", Value = 4579 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TimerunningConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5403d94 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TimerunningUIDocumentation.lua.annotated.lua @@ -0,0 +1,36 @@ +local TimerunningUI = +{ + Name = "TimerunningUI", + Type = "System", + Namespace = "C_TimerunningUI", + Environment = "All", + + Functions = + { + { + Name = "GetActiveTimerunningSeasonID", + Type = "Function", + + Returns = + { + { Name = "activeTimerunningSeasonID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "RemixEndOfEvent", + Type = "Event", + LiteralName = "REMIX_END_OF_EVENT", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TimerunningUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a129859 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TitleDocumentation.lua.annotated.lua @@ -0,0 +1,79 @@ +local Title = +{ + Name = "Title", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentTitle", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTitles", + Type = "Function", + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTitleName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "titleMaskID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "titleString", Type = "string", Nilable = false }, + { Name = "playerTitle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTitleKnown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "titleMaskID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetCurrentTitle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "titleMaskID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Title); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua.annotated.lua new file mode 100644 index 0000000..93a63b9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipComparisonDocumentation.lua.annotated.lua @@ -0,0 +1,105 @@ +local TooltipComparison = +{ + Name = "TooltipComparison", + Type = "System", + Namespace = "C_TooltipComparison", + Environment = "All", + + Functions = + { + { + Name = "CompareItem", + Type = "Function", + IsProtectedFunction = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false }, + { Name = "tooltip", Type = "Tooltip", Nilable = false }, + { Name = "anchorFrame", Type = "SimpleFrame", Nilable = true }, + }, + }, + { + Name = "GetItemComparisonDelta", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false }, + { Name = "equippedItem", Type = "TooltipComparisonItem", Nilable = false }, + { Name = "pairedItem", Type = "TooltipComparisonItem", Nilable = true }, + { Name = "addPairedStats", Type = "bool", Nilable = true, Documentation = { "Whether the paired item's stats are added or subtracted" } }, + }, + + Returns = + { + { Name = "lines", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "GetItemComparisonInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "TooltipItemComparisonInfo", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "TooltipShowItemComparison", + Type = "Event", + LiteralName = "TOOLTIP_SHOW_ITEM_COMPARISON", + CallbackEvent = true, + Payload = + { + { Name = "comparisonItem", Type = "TooltipComparisonItem", Nilable = false }, + { Name = "tooltip", Type = "Tooltip", Nilable = false }, + { Name = "anchorFrame", Type = "SimpleFrame", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "TooltipComparisonMethod", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Single", Type = "TooltipComparisonMethod", EnumValue = 0 }, + { Name = "WithBothHands", Type = "TooltipComparisonMethod", EnumValue = 1 }, + { Name = "WithBagMainHandItem", Type = "TooltipComparisonMethod", EnumValue = 2 }, + { Name = "WithBagOffHandItem", Type = "TooltipComparisonMethod", EnumValue = 3 }, + }, + }, + { + Name = "TooltipItemComparisonInfo", + Type = "Structure", + Fields = + { + { Name = "method", Type = "TooltipComparisonMethod", Nilable = false, Default = "Single" }, + { Name = "item", Type = "TooltipComparisonItem", Nilable = false }, + { Name = "additionalItems", Type = "table", InnerType = "TooltipComparisonItem", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TooltipComparison); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ba565b4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,51 @@ +local TooltipConstants = +{ + Tables = + { + { + Name = "TooltipSide", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Left", Type = "TooltipSide", EnumValue = 0 }, + { Name = "Right", Type = "TooltipSide", EnumValue = 1 }, + { Name = "Top", Type = "TooltipSide", EnumValue = 2 }, + { Name = "Bottom", Type = "TooltipSide", EnumValue = 3 }, + }, + }, + { + Name = "TooltipTextureAnchor", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "LeftTop", Type = "TooltipTextureAnchor", EnumValue = 0 }, + { Name = "LeftCenter", Type = "TooltipTextureAnchor", EnumValue = 1 }, + { Name = "LeftBottom", Type = "TooltipTextureAnchor", EnumValue = 2 }, + { Name = "RightTop", Type = "TooltipTextureAnchor", EnumValue = 3 }, + { Name = "RightCenter", Type = "TooltipTextureAnchor", EnumValue = 4 }, + { Name = "RightBottom", Type = "TooltipTextureAnchor", EnumValue = 5 }, + { Name = "All", Type = "TooltipTextureAnchor", EnumValue = 6 }, + }, + }, + { + Name = "TooltipTextureRelativeRegion", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "LeftLine", Type = "TooltipTextureRelativeRegion", EnumValue = 0 }, + { Name = "RightLine", Type = "TooltipTextureRelativeRegion", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TooltipConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ccde57d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoDocumentation.lua.annotated.lua @@ -0,0 +1,1400 @@ +local TooltipInfo = +{ + Name = "TooltipInfo", + Type = "System", + Namespace = "C_TooltipInfo", + Environment = "All", + + Functions = + { + { + Name = "GetAchievementByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetAction", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "actionID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetArtifactItem", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetArtifactPowerByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetAzeriteEssence", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "essenceID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetAzeriteEssenceSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetAzeritePower", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = false }, + { Name = "owningItemLink", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetBackpackToken", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetBagItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetBagItemChild", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "equipSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetBuybackItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetCompanionPet", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "petGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetConduit", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "conduitRank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetCurrencyByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "currencyID", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetCurrencyToken", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tokenIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetEnhancedConduit", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "conduitID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetEquipmentSet", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetExistingSocketGem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "toDestroy", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetGuildBankItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tab", Type = "luaIndex", Nilable = false }, + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetHeirloomByItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetHyperlink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "hyperlink", Type = "cstring", Nilable = false }, + { Name = "optionalArg1", Type = "number", Nilable = true }, + { Name = "optionalArg2", Type = "number", Nilable = true }, + { Name = "hideVendorPrice", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetInboxItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "messageIndex", Type = "luaIndex", Nilable = false }, + { Name = "attachmentIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetInstanceLockEncountersComplete", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetInventoryItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "luaIndex", Nilable = false }, + { Name = "hideUselessStats", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetItemByGUID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetItemByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetItemByItemModifiedAppearanceID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetItemInteractionItem", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetItemKey", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "itemSuffix", Type = "number", Nilable = false }, + { Name = "requiredLevel", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetLFGDungeonReward", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dungeonID", Type = "number", Nilable = false }, + { Name = "lootIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetLFGDungeonShortageReward", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "dungeonID", Type = "number", Nilable = false }, + { Name = "shortageSeverity", Type = "number", Nilable = false }, + { Name = "lootIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetLootCurrency", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetLootItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetLootRollItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetMerchantCostItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + { Name = "costIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetMerchantItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetMinimapMouseover", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetMountBySpellID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "checkIndoors", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetOutfit", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetOwnedItemByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetPetAction", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetPossession", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetPvpBrawl", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isSpecial", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetPvpTalent", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + { Name = "isInspect", Type = "bool", Nilable = true }, + { Name = "groupIndex", Type = "luaIndex", Nilable = true }, + { Name = "talentIndex", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetQuestCurrency", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "currencyIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetQuestItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "itemIndex", Type = "luaIndex", Nilable = false }, + { Name = "allowCollectionText", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetQuestLogCurrency", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "currencyIndex", Type = "luaIndex", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetQuestLogItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "itemIndex", Type = "luaIndex", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "allowCollectionText", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSpecialItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetQuestPartyProgress", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "omitTitle", Type = "bool", Nilable = true }, + { Name = "ignoreActivePlayer", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetRecipeRankInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetRecipeReagentItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "dataSlotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetRecipeResultItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "reagentInfos", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "recraftItemGUID", Type = "WOWGUID", Nilable = true }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + { Name = "overrideQualityID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetRecipeResultItemForOrder", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "reagentInfos", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "orderID", Type = "BigUInteger", Nilable = true }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + { Name = "overrideQualityID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetRuneforgeResultItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "powerID", Type = "number", Nilable = true }, + { Name = "modifiers", Type = "table", InnerType = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSendMailItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "attachmentIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetShapeshift", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSlottedKeystone", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSocketGem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSocketedItem", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSocketedRelic", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSpellBookItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellBookItemSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "spellBookItemSpellBank", Type = "SpellBookSpellBank", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetSpellByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = true }, + { Name = "showSubtext", Type = "bool", Nilable = true }, + { Name = "dontOverride", Type = "bool", Nilable = true }, + { Name = "difficultyID", Type = "number", Nilable = true }, + { Name = "isLink", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetTalent", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "talentID", Type = "number", Nilable = false }, + { Name = "isInspect", Type = "bool", Nilable = true }, + { Name = "groupIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetTotem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetToyByItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetTradePlayerItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetTradeTargetItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetTrainerService", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "serviceIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetTraitEntry", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "entryID", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnit", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "hideStatus", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnitAura", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnitAuraByAuraInstanceID", + Type = "Function", + MayReturnNothing = true, + SecretWhenInCombat = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Obtains aura info like other functions with the caveat that the filters will always at least include the typically mutually exclusive HELPFUL|HARMFUL regardless of what the argument value is set to" }, + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnitBuff", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnitBuffByAuraInstanceID", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnitDebuff", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUnitDebuffByAuraInstanceID", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetUpgradeItem", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetWeeklyReward", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemDBID", Type = "WeeklyRewardItemDBID", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetWorldCursor", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + { + Name = "GetWorldLootObject", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitTokenString", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "data", Type = "TooltipData", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "HideHyperlinkTooltip", + Type = "Event", + LiteralName = "HIDE_HYPERLINK_TOOLTIP", + SynchronousEvent = true, + }, + { + Name = "ShowHyperlinkTooltip", + Type = "Event", + LiteralName = "SHOW_HYPERLINK_TOOLTIP", + SynchronousEvent = true, + Payload = + { + { Name = "hyperlink", Type = "string", Nilable = false }, + }, + }, + { + Name = "TooltipDataUpdate", + Type = "Event", + LiteralName = "TOOLTIP_DATA_UPDATE", + UniqueEvent = true, + Documentation = { "Sends an update to the UI that a sparse or cache lookup has resolved" }, + Payload = + { + { Name = "dataInstanceID", Type = "number", Nilable = true }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TooltipInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a705fe4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TooltipInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,171 @@ +local TooltipInfoShared = +{ + Tables = + { + { + Name = "TooltipDataItemBinding", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "Quest", Type = "TooltipDataItemBinding", EnumValue = 0 }, + { Name = "Account", Type = "TooltipDataItemBinding", EnumValue = 1 }, + { Name = "BnetAccount", Type = "TooltipDataItemBinding", EnumValue = 2 }, + { Name = "Soulbound", Type = "TooltipDataItemBinding", EnumValue = 3 }, + { Name = "BindToAccount", Type = "TooltipDataItemBinding", EnumValue = 4 }, + { Name = "BindToBnetAccount", Type = "TooltipDataItemBinding", EnumValue = 5 }, + { Name = "BindOnPickup", Type = "TooltipDataItemBinding", EnumValue = 6 }, + { Name = "BindOnEquip", Type = "TooltipDataItemBinding", EnumValue = 7 }, + { Name = "BindOnUse", Type = "TooltipDataItemBinding", EnumValue = 8 }, + { Name = "AccountUntilEquipped", Type = "TooltipDataItemBinding", EnumValue = 9 }, + { Name = "BindToAccountUntilEquipped", Type = "TooltipDataItemBinding", EnumValue = 10 }, + }, + }, + { + Name = "TooltipDataLineType", + Type = "Enumeration", + NumValues = 44, + MinValue = 0, + MaxValue = 43, + Fields = + { + { Name = "None", Type = "TooltipDataLineType", EnumValue = 0 }, + { Name = "Blank", Type = "TooltipDataLineType", EnumValue = 1 }, + { Name = "UnitName", Type = "TooltipDataLineType", EnumValue = 2 }, + { Name = "GemSocket", Type = "TooltipDataLineType", EnumValue = 3 }, + { Name = "AzeriteEssenceSlot", Type = "TooltipDataLineType", EnumValue = 4 }, + { Name = "AzeriteEssencePower", Type = "TooltipDataLineType", EnumValue = 5 }, + { Name = "LearnableSpell", Type = "TooltipDataLineType", EnumValue = 6 }, + { Name = "UnitThreat", Type = "TooltipDataLineType", EnumValue = 7 }, + { Name = "QuestObjective", Type = "TooltipDataLineType", EnumValue = 8 }, + { Name = "AzeriteItemPowerDescription", Type = "TooltipDataLineType", EnumValue = 9 }, + { Name = "RuneforgeLegendaryPowerDescription", Type = "TooltipDataLineType", EnumValue = 10 }, + { Name = "SellPrice", Type = "TooltipDataLineType", EnumValue = 11 }, + { Name = "ProfessionCraftingQuality", Type = "TooltipDataLineType", EnumValue = 12 }, + { Name = "SpellName", Type = "TooltipDataLineType", EnumValue = 13 }, + { Name = "CurrencyTotal", Type = "TooltipDataLineType", EnumValue = 14 }, + { Name = "ItemEnchantmentPermanent", Type = "TooltipDataLineType", EnumValue = 15 }, + { Name = "UnitOwner", Type = "TooltipDataLineType", EnumValue = 16 }, + { Name = "QuestTitle", Type = "TooltipDataLineType", EnumValue = 17 }, + { Name = "QuestPlayer", Type = "TooltipDataLineType", EnumValue = 18 }, + { Name = "NestedBlock", Type = "TooltipDataLineType", EnumValue = 19 }, + { Name = "ItemBinding", Type = "TooltipDataLineType", EnumValue = 20 }, + { Name = "EquipSlot", Type = "TooltipDataLineType", EnumValue = 21 }, + { Name = "ItemName", Type = "TooltipDataLineType", EnumValue = 22 }, + { Name = "Separator", Type = "TooltipDataLineType", EnumValue = 23 }, + { Name = "ToyName", Type = "TooltipDataLineType", EnumValue = 24 }, + { Name = "ToyText", Type = "TooltipDataLineType", EnumValue = 25 }, + { Name = "ToyEffect", Type = "TooltipDataLineType", EnumValue = 26 }, + { Name = "ToyDuration", Type = "TooltipDataLineType", EnumValue = 27 }, + { Name = "ToyDescription", Type = "TooltipDataLineType", EnumValue = 28 }, + { Name = "ToySource", Type = "TooltipDataLineType", EnumValue = 29 }, + { Name = "GemSocketEnchantment", Type = "TooltipDataLineType", EnumValue = 30 }, + { Name = "ItemLevel", Type = "TooltipDataLineType", EnumValue = 31 }, + { Name = "ItemUpgradeLevel", Type = "TooltipDataLineType", EnumValue = 32 }, + { Name = "SpellPassive", Type = "TooltipDataLineType", EnumValue = 33 }, + { Name = "SpellDescription", Type = "TooltipDataLineType", EnumValue = 34 }, + { Name = "ItemQuality", Type = "TooltipDataLineType", EnumValue = 35 }, + { Name = "TradeTimeRemaining", Type = "TooltipDataLineType", EnumValue = 36 }, + { Name = "FlavorText", Type = "TooltipDataLineType", EnumValue = 37 }, + { Name = "ItemSpellTriggerLearn", Type = "TooltipDataLineType", EnumValue = 38 }, + { Name = "LearnTransmogSet", Type = "TooltipDataLineType", EnumValue = 39 }, + { Name = "LearnTransmogIllusion", Type = "TooltipDataLineType", EnumValue = 40 }, + { Name = "ErrorLine", Type = "TooltipDataLineType", EnumValue = 41 }, + { Name = "DisabledLine", Type = "TooltipDataLineType", EnumValue = 42 }, + { Name = "UsageRequirement", Type = "TooltipDataLineType", EnumValue = 43 }, + }, + }, + { + Name = "TooltipDataType", + Type = "Enumeration", + NumValues = 28, + MinValue = 0, + MaxValue = 27, + Fields = + { + { Name = "Item", Type = "TooltipDataType", EnumValue = 0 }, + { Name = "Spell", Type = "TooltipDataType", EnumValue = 1 }, + { Name = "Unit", Type = "TooltipDataType", EnumValue = 2 }, + { Name = "Corpse", Type = "TooltipDataType", EnumValue = 3 }, + { Name = "Object", Type = "TooltipDataType", EnumValue = 4 }, + { Name = "Currency", Type = "TooltipDataType", EnumValue = 5 }, + { Name = "BattlePet", Type = "TooltipDataType", EnumValue = 6 }, + { Name = "UnitAura", Type = "TooltipDataType", EnumValue = 7 }, + { Name = "AzeriteEssence", Type = "TooltipDataType", EnumValue = 8 }, + { Name = "CompanionPet", Type = "TooltipDataType", EnumValue = 9 }, + { Name = "Mount", Type = "TooltipDataType", EnumValue = 10 }, + { Name = "PetAction", Type = "TooltipDataType", EnumValue = 11 }, + { Name = "Achievement", Type = "TooltipDataType", EnumValue = 12 }, + { Name = "EnhancedConduit", Type = "TooltipDataType", EnumValue = 13 }, + { Name = "EquipmentSet", Type = "TooltipDataType", EnumValue = 14 }, + { Name = "InstanceLock", Type = "TooltipDataType", EnumValue = 15 }, + { Name = "PvPBrawl", Type = "TooltipDataType", EnumValue = 16 }, + { Name = "RecipeRankInfo", Type = "TooltipDataType", EnumValue = 17 }, + { Name = "Totem", Type = "TooltipDataType", EnumValue = 18 }, + { Name = "Toy", Type = "TooltipDataType", EnumValue = 19 }, + { Name = "CorruptionCleanser", Type = "TooltipDataType", EnumValue = 20 }, + { Name = "MinimapMouseover", Type = "TooltipDataType", EnumValue = 21 }, + { Name = "Flyout", Type = "TooltipDataType", EnumValue = 22 }, + { Name = "Quest", Type = "TooltipDataType", EnumValue = 23 }, + { Name = "QuestPartyProgress", Type = "TooltipDataType", EnumValue = 24 }, + { Name = "Macro", Type = "TooltipDataType", EnumValue = 25 }, + { Name = "Debug", Type = "TooltipDataType", EnumValue = 26 }, + { Name = "Outfit", Type = "TooltipDataType", EnumValue = 27 }, + }, + }, + { + Name = "TooltipDataUsageRequirementType", + Type = "Enumeration", + NumValues = 17, + MinValue = 0, + MaxValue = 16, + Fields = + { + { Name = "RaceClass", Type = "TooltipDataUsageRequirementType", EnumValue = 0 }, + { Name = "Faction", Type = "TooltipDataUsageRequirementType", EnumValue = 1 }, + { Name = "Skill", Type = "TooltipDataUsageRequirementType", EnumValue = 2 }, + { Name = "PvPMedal", Type = "TooltipDataUsageRequirementType", EnumValue = 3 }, + { Name = "Reputation", Type = "TooltipDataUsageRequirementType", EnumValue = 4 }, + { Name = "Level", Type = "TooltipDataUsageRequirementType", EnumValue = 5 }, + { Name = "Guild", Type = "TooltipDataUsageRequirementType", EnumValue = 6 }, + { Name = "Achievement", Type = "TooltipDataUsageRequirementType", EnumValue = 7 }, + { Name = "PvPRank", Type = "TooltipDataUsageRequirementType", EnumValue = 8 }, + { Name = "EquippedItem", Type = "TooltipDataUsageRequirementType", EnumValue = 9 }, + { Name = "ShapeshiftForm", Type = "TooltipDataUsageRequirementType", EnumValue = 10 }, + { Name = "ArenaRating", Type = "TooltipDataUsageRequirementType", EnumValue = 11 }, + { Name = "EarnCurrency", Type = "TooltipDataUsageRequirementType", EnumValue = 12 }, + { Name = "Specialization", Type = "TooltipDataUsageRequirementType", EnumValue = 13 }, + { Name = "NotAlreadyKnown", Type = "TooltipDataUsageRequirementType", EnumValue = 14 }, + { Name = "NotInArena", Type = "TooltipDataUsageRequirementType", EnumValue = 15 }, + { Name = "NotInRatedBg", Type = "TooltipDataUsageRequirementType", EnumValue = 16 }, + }, + }, + { + Name = "TooltipComparisonLine", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "TooltipDataArg", + Type = "Structure", + Fields = + { + { Name = "field", Type = "string", Nilable = false }, + { Name = "stringVal", Type = "string", Nilable = true }, + { Name = "intVal", Type = "number", Nilable = true }, + { Name = "floatVal", Type = "number", Nilable = true }, + { Name = "boolVal", Type = "bool", Nilable = true }, + { Name = "colorVal", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + { Name = "guidVal", Type = "WOWGUID", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TooltipInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4902420 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TotemDocumentation.lua.annotated.lua @@ -0,0 +1,117 @@ +local Totem = +{ + Name = "Totem", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "DestroyTotem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetNumTotemSlots", + Type = "Function", + + Returns = + { + { Name = "numSlots", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotemCannotDismiss", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "cannotDismiss", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetTotemInfo", + Type = "Function", + MayReturnNothing = true, + SecretWhenTotemSlotSecret = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "haveTotem", Type = "bool", Nilable = false }, + { Name = "totemName", Type = "cstring", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotemTimeLeft", + Type = "Function", + SecretWhenTotemSlotSecret = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = true }, + }, + }, + { + Name = "TargetTotem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "TotemInfoScript", + Type = "Structure", + Fields = + { + { Name = "haveTotem", Type = "bool", Nilable = false }, + { Name = "totemName", Type = "cstring", Nilable = false }, + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "modRate", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Totem); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f76629b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ToyBoxInfoDocumentation.lua.annotated.lua @@ -0,0 +1,97 @@ +local ToyBoxInfo = +{ + Name = "ToyBoxInfo", + Type = "System", + Namespace = "C_ToyBoxInfo", + Environment = "All", + + Functions = + { + { + Name = "ClearFanfare", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsToySourceValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isToySourceValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingDefaultFilters", + Type = "Function", + + Returns = + { + { Name = "isUsingDefaultFilters", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NeedsFanfare", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "needsFanfare", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDefaultFilters", + Type = "Function", + }, + }, + + Events = + { + { + Name = "NewToyAdded", + Type = "Event", + LiteralName = "NEW_TOY_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ToysUpdated", + Type = "Event", + LiteralName = "TOYS_UPDATED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "isNew", Type = "bool", Nilable = true }, + { Name = "hasFanfare", Type = "bool", Nilable = true }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ToyBoxInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..db5921e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeInfoDocumentation.lua.annotated.lua @@ -0,0 +1,160 @@ +local TradeInfo = +{ + Name = "TradeInfo", + Type = "System", + Namespace = "C_TradeInfo", + Environment = "All", + + Functions = + { + { + Name = "AddTradeMoney", + Type = "Function", + HasRestrictions = true, + Documentation = { "Adds any cursor-held money to the current trade offer." }, + }, + { + Name = "PickupTradeMoney", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + }, + { + Name = "SetTradeMoney", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Sets the amount of money in the current trade offer." }, + + Arguments = + { + { Name = "amount", Type = "WOWMONEY", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "PlayerTradeCurrency", + Type = "Event", + LiteralName = "PLAYER_TRADE_CURRENCY", + SynchronousEvent = true, + }, + { + Name = "PlayerTradeMoney", + Type = "Event", + LiteralName = "PLAYER_TRADE_MONEY", + SynchronousEvent = true, + }, + { + Name = "TradeAcceptUpdate", + Type = "Event", + LiteralName = "TRADE_ACCEPT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "playerAccepted", Type = "number", Nilable = false }, + { Name = "targetAccepted", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeClosed", + Type = "Event", + LiteralName = "TRADE_CLOSED", + SynchronousEvent = true, + }, + { + Name = "TradeCurrencyChanged", + Type = "Event", + LiteralName = "TRADE_CURRENCY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "TradeMoneyChanged", + Type = "Event", + LiteralName = "TRADE_MONEY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "TradePlayerItemChanged", + Type = "Event", + LiteralName = "TRADE_PLAYER_ITEM_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "tradeSlotIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradePotentialBindEnchant", + Type = "Event", + LiteralName = "TRADE_POTENTIAL_BIND_ENCHANT", + SynchronousEvent = true, + Payload = + { + { Name = "canBecomeBoundForTrade", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TradePotentialRemoveTransmog", + Type = "Event", + LiteralName = "TRADE_POTENTIAL_REMOVE_TRANSMOG", + SynchronousEvent = true, + Payload = + { + { Name = "itemLink", Type = "cstring", Nilable = false }, + { Name = "tradeSlotIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeRequest", + Type = "Event", + LiteralName = "TRADE_REQUEST", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "TradeRequestCancel", + Type = "Event", + LiteralName = "TRADE_REQUEST_CANCEL", + SynchronousEvent = true, + }, + { + Name = "TradeShow", + Type = "Event", + LiteralName = "TRADE_SHOW", + SynchronousEvent = true, + }, + { + Name = "TradeTargetItemChanged", + Type = "Event", + LiteralName = "TRADE_TARGET_ITEM_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "tradeSlotIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeUpdate", + Type = "Event", + LiteralName = "TRADE_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TradeInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..26e122d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUIDocumentation.lua.annotated.lua @@ -0,0 +1,1392 @@ +local TradeSkillUI = +{ + Name = "TradeSkillUI", + Type = "System", + Namespace = "C_TradeSkillUI", + Environment = "All", + + Functions = + { + { + Name = "CanStoreEnchantInItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "canStore", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelProfessionRespec", + Type = "Function", + }, + { + Name = "CheckRespecNPC", + Type = "Function", + + Returns = + { + { Name = "canInteract", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseTradeSkill", + Type = "Function", + }, + { + Name = "ConfirmProfessionRespec", + Type = "Function", + }, + { + Name = "CraftEnchant", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "numCasts", Type = "number", Nilable = false, Default = 1 }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "itemTarget", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = true }, + { Name = "applyConcentration", Type = "bool", Nilable = true }, + }, + }, + { + Name = "CraftRecipe", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "numCasts", Type = "number", Nilable = false, Default = 1 }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + { Name = "orderID", Type = "BigUInteger", Nilable = true }, + { Name = "applyConcentration", Type = "bool", Nilable = true }, + }, + }, + { + Name = "CraftSalvage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "numCasts", Type = "number", Nilable = false, Default = 1 }, + { Name = "itemTarget", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "applyConcentration", Type = "bool", Nilable = true }, + }, + }, + { + Name = "DoesRecraftingRecipeAcceptItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAllProfessionTradeSkillLines", + Type = "Function", + + Returns = + { + { Name = "skillLineID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetBaseProfessionInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "ProfessionInfo", Nilable = false }, + }, + }, + { + Name = "GetChildProfessionInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "ProfessionInfo", Nilable = false }, + }, + }, + { + Name = "GetChildProfessionInfos", + Type = "Function", + + Returns = + { + { Name = "infos", Type = "table", InnerType = "ProfessionInfo", Nilable = false }, + }, + }, + { + Name = "GetConcentrationCurrencyID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currencyType", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCraftableCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "numAvailable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCraftingOperationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = false }, + { Name = "allocationItemGUID", Type = "WOWGUID", Nilable = true }, + { Name = "applyConcentration", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingOperationInfo", Nilable = true }, + }, + }, + { + Name = "GetCraftingOperationInfoForOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = false }, + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "applyConcentration", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingOperationInfo", Nilable = true }, + }, + }, + { + Name = "GetCraftingReagentBonusText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "craftingReagentIndex", Type = "luaIndex", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = false }, + { Name = "allocationItemGUID", Type = "WOWGUID", Nilable = true }, + }, + + Returns = + { + { Name = "bonusText", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "GetCraftingTargetItems", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + + Returns = + { + { Name = "items", Type = "table", InnerType = "CraftingTargetItem", Nilable = false }, + }, + }, + { + Name = "GetDependentReagents", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + }, + + Returns = + { + { Name = "reagents", Type = "table", InnerType = "CraftingReagent", Nilable = false }, + }, + }, + { + Name = "GetEnchantItems", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + }, + + Returns = + { + { Name = "items", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetFactionSpecificOutputItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetGatheringOperationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "GatheringOperationInfo", Nilable = true }, + }, + }, + { + Name = "GetHideUnownedFlags", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "cannotModifyHideUnowned", Type = "bool", Nilable = false }, + { Name = "alwaysShowUnowned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemCraftedQualityByItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "quality", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemCraftedQualityInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingQualityInfo", Nilable = true }, + }, + }, + { + Name = "GetItemReagentQualityByItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "quality", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemReagentQualityInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingQualityInfo", Nilable = true }, + }, + }, + { + Name = "GetItemSlotModifications", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "slotMods", Type = "table", InnerType = "CraftingItemSlotModification", Nilable = false }, + }, + }, + { + Name = "GetItemSlotModificationsForOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + }, + + Returns = + { + { Name = "slotMods", Type = "table", InnerType = "CraftingItemSlotModification", Nilable = false }, + }, + }, + { + Name = "GetOriginalCraftRecipeID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "recipeID", Type = "number", Nilable = true }, + { Name = "skillLineAbilityID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetProfessionByInventorySlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "profession", Type = "Profession", Nilable = true }, + }, + }, + { + Name = "GetProfessionChildSkillLineID", + Type = "Function", + + Returns = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetProfessionForCursorItem", + Type = "Function", + + Returns = + { + { Name = "profession", Type = "Profession", Nilable = true }, + }, + }, + { + Name = "GetProfessionInfoByRecipeID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ProfessionInfo", Nilable = false }, + }, + }, + { + Name = "GetProfessionInfoBySkillLineID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ProfessionInfo", Nilable = false }, + }, + }, + { + Name = "GetProfessionInventorySlots", + Type = "Function", + + Returns = + { + { Name = "invSlots", Type = "table", InnerType = "InventorySlots", Nilable = false }, + }, + }, + { + Name = "GetProfessionNameForSkillLineAbility", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "professionNmae", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetProfessionSkillLineID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "profession", Type = "Profession", Nilable = false }, + }, + + Returns = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetProfessionSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "profession", Type = "Profession", Nilable = false }, + }, + + Returns = + { + { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetProfessionSpells", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "professionID", Type = "number", Nilable = false }, + { Name = "skillLineID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "knownSpells", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetQualitiesForRecipe", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "qualityIDs", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetReagentDifficultyText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "craftingReagentIndex", Type = "luaIndex", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = false }, + }, + + Returns = + { + { Name = "bonusText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetReagentSlotStatus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mcrSlotID", Type = "number", Nilable = false }, + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "locked", Type = "bool", Nilable = false }, + { Name = "lockedReason", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRecipeDescription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = false }, + { Name = "allocationItemGUID", Type = "WOWGUID", Nilable = true }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRecipeInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "recipeInfo", Type = "TradeSkillRecipeInfo", Nilable = true }, + }, + }, + { + Name = "GetRecipeInfoForSkillLineAbility", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "recipeInfo", Type = "TradeSkillRecipeInfo", Nilable = true }, + }, + }, + { + Name = "GetRecipeItemQualityInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CraftingQualityInfo", Nilable = true }, + }, + }, + { + Name = "GetRecipeOutputItemData", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "reagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "allocationItemGUID", Type = "WOWGUID", Nilable = true }, + { Name = "overrideQualityID", Type = "number", Nilable = true }, + { Name = "recraftOrderID", Type = "BigUInteger", Nilable = true }, + }, + + Returns = + { + { Name = "outputInfo", Type = "CraftingRecipeOutputInfo", Nilable = false }, + }, + }, + { + Name = "GetRecipeQualityItemIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "qualityItemIDs", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetRecipeQualityReagentLink", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "dataSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "qualityIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetRecipeRequirements", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "requirements", Type = "table", InnerType = "CraftingRecipeRequirement", Nilable = false }, + }, + }, + { + Name = "GetRecipeSchematic", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + { Name = "isRecraft", Type = "bool", Nilable = false }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "schematic", Type = "CraftingRecipeSchematic", Nilable = false }, + }, + }, + { + Name = "GetRecipesTracked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isRecraft", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "recipeIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetRecraftItems", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "items", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetRecraftRemovalWarnings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "replacedReagents", Type = "table", InnerType = "CraftingReagent", Nilable = false }, + }, + + Returns = + { + { Name = "warnings", Type = "table", InnerType = "cstring", Nilable = false }, + }, + }, + { + Name = "GetRemainingRecasts", + Type = "Function", + + Returns = + { + { Name = "remaining", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSalvagableItemIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetShowLearned", + Type = "Function", + + Returns = + { + { Name = "flag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetShowUnlearned", + Type = "Function", + + Returns = + { + { Name = "flag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSkillLineForGear", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "skillLineID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSourceTypeFilter", + Type = "Function", + + Returns = + { + { Name = "sourceTypeFilter", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillDisplayName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "professionDisplayName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "HasFavoriteOrderRecipes", + Type = "Function", + + Returns = + { + { Name = "hasFavorites", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEnchantTargetValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsGuildTradeSkillsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNPCCrafting", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNearProfessionSpellFocus", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "profession", Type = "Profession", Nilable = false }, + }, + + Returns = + { + { Name = "nearFocus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOriginalCraftRecipeLearned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "learned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecipeFirstCraft", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecipeInBaseSkillLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecipeInSkillLine", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecipeProfessionLearned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "recipeProfessionLearned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecipeTracked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "isRecraft", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "tracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecraftItemEquipped", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recraftItemGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRecraftReagentValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRuneforging", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpenRecipe", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + }, + }, + { + Name = "OpenTradeSkill", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "opened", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RecraftLimitCategoryValid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + }, + + Returns = + { + { Name = "recraftValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RecraftRecipe", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "removedModifications", Type = "table", InnerType = "CraftingItemSlotModification", Nilable = true }, + { Name = "applyConcentration", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RecraftRecipeForOrder", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "orderID", Type = "BigUInteger", Nilable = false }, + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "craftingReagents", Type = "table", InnerType = "CraftingReagentInfo", Nilable = true }, + { Name = "removedModifications", Type = "table", InnerType = "CraftingItemSlotModification", Nilable = true }, + { Name = "applyConcentration", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetOnlyShowAvailableForOrders", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetProfessionChildSkillLineID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "skillLineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetRecipeTracked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "tracked", Type = "bool", Nilable = false }, + { Name = "isRecraft", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetShowLearned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetShowUnlearned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "flag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSourceTypeFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceTypeFilter", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CraftingDetailsUpdate", + Type = "Event", + LiteralName = "CRAFTING_DETAILS_UPDATE", + SynchronousEvent = true, + }, + { + Name = "NewRecipeLearned", + Type = "Event", + LiteralName = "NEW_RECIPE_LEARNED", + SynchronousEvent = true, + Payload = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "recipeLevel", Type = "luaIndex", Nilable = true }, + { Name = "baseRecipeID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ObliterumForgePendingItemChanged", + Type = "Event", + LiteralName = "OBLITERUM_FORGE_PENDING_ITEM_CHANGED", + SynchronousEvent = true, + }, + { + Name = "OpenRecipeResponse", + Type = "Event", + LiteralName = "OPEN_RECIPE_RESPONSE", + SynchronousEvent = true, + Payload = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "skillLineID", Type = "number", Nilable = false }, + { Name = "expansionSkillLineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ProfessionRespecConfirmation", + Type = "Event", + LiteralName = "PROFESSION_RESPEC_CONFIRMATION", + SynchronousEvent = true, + Payload = + { + { Name = "skillName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "TrackedRecipeUpdate", + Type = "Event", + LiteralName = "TRACKED_RECIPE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "tracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TradeSkillClose", + Type = "Event", + LiteralName = "TRADE_SKILL_CLOSE", + SynchronousEvent = true, + }, + { + Name = "TradeSkillCraftBegin", + Type = "Event", + LiteralName = "TRADE_SKILL_CRAFT_BEGIN", + SynchronousEvent = true, + Payload = + { + { Name = "recipeSpellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeSkillCraftingReagentBonusTextUpdated", + Type = "Event", + LiteralName = "TRADE_SKILL_CRAFTING_REAGENT_BONUS_TEXT_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeSkillCurrencyRewardResult", + Type = "Event", + LiteralName = "TRADE_SKILL_CURRENCY_REWARD_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "data", Type = "CraftingCurrencyResultData", Nilable = false }, + }, + }, + { + Name = "TradeSkillDataSourceChanged", + Type = "Event", + LiteralName = "TRADE_SKILL_DATA_SOURCE_CHANGED", + UniqueEvent = true, + }, + { + Name = "TradeSkillDataSourceChanging", + Type = "Event", + LiteralName = "TRADE_SKILL_DATA_SOURCE_CHANGING", + UniqueEvent = true, + }, + { + Name = "TradeSkillDetailsUpdate", + Type = "Event", + LiteralName = "TRADE_SKILL_DETAILS_UPDATE", + UniqueEvent = true, + }, + { + Name = "TradeSkillFavoritesChanged", + Type = "Event", + LiteralName = "TRADE_SKILL_FAVORITES_CHANGED", + UniqueEvent = true, + Payload = + { + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "recipeSpellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeSkillItemCraftedResult", + Type = "Event", + LiteralName = "TRADE_SKILL_ITEM_CRAFTED_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "data", Type = "CraftingItemResultData", Nilable = false }, + }, + }, + { + Name = "TradeSkillItemUpdate", + Type = "Event", + LiteralName = "TRADE_SKILL_ITEM_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "TradeSkillListUpdate", + Type = "Event", + LiteralName = "TRADE_SKILL_LIST_UPDATE", + UniqueEvent = true, + }, + { + Name = "TradeSkillNameUpdate", + Type = "Event", + LiteralName = "TRADE_SKILL_NAME_UPDATE", + SynchronousEvent = true, + }, + { + Name = "TradeSkillShow", + Type = "Event", + LiteralName = "TRADE_SKILL_SHOW", + SynchronousEvent = true, + }, + { + Name = "UpdateTradeskillCastStopped", + Type = "Event", + LiteralName = "UPDATE_TRADESKILL_CAST_STOPPED", + UniqueEvent = true, + Payload = + { + { Name = "isScrapping", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TradeSkillUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a59fe54 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TradeSkillUITypesDocumentation.lua.annotated.lua @@ -0,0 +1,437 @@ +local TradeSkillUITypes = +{ + Tables = + { + { + Name = "CraftingReagentItemFlag", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "TooltipShowsAsStatModifications", Type = "CraftingReagentItemFlag", EnumValue = 1 }, + }, + }, + { + Name = "RecipeRequirementType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "SpellFocus", Type = "RecipeRequirementType", EnumValue = 0 }, + { Name = "Totem", Type = "RecipeRequirementType", EnumValue = 1 }, + { Name = "Area", Type = "RecipeRequirementType", EnumValue = 2 }, + }, + }, + { + Name = "TradeskillOrderDuration", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "Short", Type = "TradeskillOrderDuration", EnumValue = 1 }, + { Name = "Medium", Type = "TradeskillOrderDuration", EnumValue = 2 }, + { Name = "Long", Type = "TradeskillOrderDuration", EnumValue = 3 }, + }, + }, + { + Name = "TradeskillOrderRecipient", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "Public", Type = "TradeskillOrderRecipient", EnumValue = 1 }, + { Name = "Guild", Type = "TradeskillOrderRecipient", EnumValue = 2 }, + { Name = "Private", Type = "TradeskillOrderRecipient", EnumValue = 3 }, + }, + }, + { + Name = "TradeskillOrderStatus", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Unclaimed", Type = "TradeskillOrderStatus", EnumValue = 1 }, + { Name = "Started", Type = "TradeskillOrderStatus", EnumValue = 2 }, + { Name = "Completed", Type = "TradeskillOrderStatus", EnumValue = 3 }, + { Name = "Expired", Type = "TradeskillOrderStatus", EnumValue = 4 }, + }, + }, + { + Name = "TradeskillRecipeType", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "Item", Type = "TradeskillRecipeType", EnumValue = 1 }, + { Name = "Salvage", Type = "TradeskillRecipeType", EnumValue = 2 }, + { Name = "Enchant", Type = "TradeskillRecipeType", EnumValue = 3 }, + { Name = "Gathering", Type = "TradeskillRecipeType", EnumValue = 4 }, + }, + }, + { + Name = "TradeskillRelativeDifficulty", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Optimal", Type = "TradeskillRelativeDifficulty", EnumValue = 0 }, + { Name = "Medium", Type = "TradeskillRelativeDifficulty", EnumValue = 1 }, + { Name = "Easy", Type = "TradeskillRelativeDifficulty", EnumValue = 2 }, + { Name = "Trivial", Type = "TradeskillRelativeDifficulty", EnumValue = 3 }, + }, + }, + { + Name = "TradeskillSlotDataType", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "Reagent", Type = "TradeskillSlotDataType", EnumValue = 1 }, + { Name = "ModifiedReagent", Type = "TradeskillSlotDataType", EnumValue = 2 }, + { Name = "Currency", Type = "TradeskillSlotDataType", EnumValue = 3 }, + }, + }, + { + Name = "CraftingCurrencyResultData", + Type = "Structure", + Fields = + { + { Name = "currencyID", Type = "number", Nilable = false, Default = 0 }, + { Name = "quantity", Type = "number", Nilable = false, Default = 0 }, + { Name = "operationID", Type = "number", Nilable = false, Default = 0 }, + { Name = "firstCraftReward", Type = "bool", Nilable = false, Default = false }, + { Name = "showCurrencyText", Type = "bool", Nilable = false, Default = true }, + }, + }, + { + Name = "CraftingItemResultData", + Type = "Structure", + Fields = + { + { Name = "resourcesReturned", Type = "table", InnerType = "CraftingResourceReturnInfo", Nilable = true }, + { Name = "craftingQuality", Type = "number", Nilable = true }, + { Name = "qualityProgress", Type = "number", Nilable = false, Default = 0 }, + { Name = "itemID", Type = "number", Nilable = false, Default = 0 }, + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false, Default = 0 }, + { Name = "hyperlink", Type = "string", Nilable = false }, + { Name = "isCrit", Type = "bool", Nilable = false, Default = false }, + { Name = "critBonusSkill", Type = "number", Nilable = false, Default = 0 }, + { Name = "recraftable", Type = "bool", Nilable = false, Default = false }, + { Name = "bonusCraft", Type = "bool", Nilable = false, Default = false }, + { Name = "multicraft", Type = "number", Nilable = false, Default = 0 }, + { Name = "operationID", Type = "number", Nilable = false, Default = 0 }, + { Name = "firstCraftReward", Type = "bool", Nilable = false, Default = false }, + { Name = "isEnchant", Type = "bool", Nilable = false, Default = false }, + { Name = "hasIngenuityProc", Type = "bool", Nilable = false, Default = false }, + { Name = "concentrationCurrencyID", Type = "number", Nilable = false, Default = 0 }, + { Name = "concentrationSpent", Type = "number", Nilable = false, Default = 0 }, + { Name = "ingenuityRefund", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "CraftingItemSlotModification", + Type = "Structure", + Fields = + { + { Name = "dataSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + }, + }, + { + Name = "CraftingOperationBonusStatInfo", + Type = "Structure", + Fields = + { + { Name = "bonusStatName", Type = "string", Nilable = false }, + { Name = "bonusStatValue", Type = "number", Nilable = false }, + { Name = "ratingDescription", Type = "string", Nilable = false }, + { Name = "ratingPct", Type = "number", Nilable = false }, + { Name = "bonusRatingPct", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingOperationInfo", + Type = "Structure", + Fields = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "baseDifficulty", Type = "number", Nilable = false }, + { Name = "bonusDifficulty", Type = "number", Nilable = false }, + { Name = "baseSkill", Type = "number", Nilable = false }, + { Name = "bonusSkill", Type = "number", Nilable = false }, + { Name = "isQualityCraft", Type = "bool", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "craftingQuality", Type = "number", Nilable = false }, + { Name = "craftingQualityID", Type = "number", Nilable = false }, + { Name = "craftingDataID", Type = "number", Nilable = false }, + { Name = "lowerSkillThreshold", Type = "number", Nilable = false }, + { Name = "upperSkillTreshold", Type = "number", Nilable = false }, + { Name = "guaranteedCraftingQualityID", Type = "number", Nilable = false }, + { Name = "bonusStats", Type = "table", InnerType = "CraftingOperationBonusStatInfo", Nilable = false }, + { Name = "concentrationCurrencyID", Type = "number", Nilable = false }, + { Name = "concentrationCost", Type = "number", Nilable = false }, + { Name = "ingenuityRefund", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingQualityInfo", + Type = "Structure", + Fields = + { + { Name = "quality", Type = "number", Nilable = false }, + { Name = "icon", Type = "textureAtlas", Nilable = false }, + { Name = "iconSmall", Type = "textureAtlas", Nilable = false }, + { Name = "iconInventory", Type = "textureAtlas", Nilable = false }, + { Name = "iconMixed", Type = "textureAtlas", Nilable = false }, + { Name = "iconAppear", Type = "textureAtlas", Nilable = false }, + { Name = "iconDissolve", Type = "textureAtlas", Nilable = false }, + { Name = "barFill", Type = "textureAtlas", Nilable = false }, + { Name = "barBackground", Type = "textureAtlas", Nilable = false }, + { Name = "barBackgroundCap", Type = "textureAtlas", Nilable = false }, + { Name = "barHighlight", Type = "textureAtlas", Nilable = false }, + { Name = "iconChat", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "CraftingReagent", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "currencyID", Type = "number", Nilable = true }, + }, + }, + { + Name = "CraftingReagentInfo", + Type = "Structure", + Fields = + { + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + { Name = "dataSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingReagentSlotInfo", + Type = "Structure", + Fields = + { + { Name = "mcrSlotID", Type = "number", Nilable = false }, + { Name = "requiredSkillRank", Type = "number", Nilable = false }, + { Name = "slotText", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "CraftingReagentSlotSchematic", + Type = "Structure", + Fields = + { + { Name = "reagents", Type = "table", InnerType = "CraftingReagent", Nilable = false }, + { Name = "reagentType", Type = "CraftingReagentType", Nilable = false }, + { Name = "variableQuantities", Type = "table", InnerType = "CraftingVariableQuantities", Nilable = false }, + { Name = "quantityRequired", Type = "number", Nilable = false }, + { Name = "slotInfo", Type = "CraftingReagentSlotInfo", Nilable = true }, + { Name = "dataSlotType", Type = "TradeskillSlotDataType", Nilable = false, Default = "Reagent" }, + { Name = "dataSlotIndex", Type = "luaIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "orderSource", Type = "CraftingOrderReagentSource", Nilable = true }, + { Name = "required", Type = "bool", Nilable = false }, + { Name = "hiddenInCraftingForm", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CraftingRecipeOutputInfo", + Type = "Structure", + Fields = + { + { Name = "icon", Type = "number", Nilable = false }, + { Name = "hyperlink", Type = "cstring", Nilable = true }, + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "CraftingRecipeRequirement", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "met", Type = "bool", Nilable = false }, + { Name = "type", Type = "RecipeRequirementType", Nilable = false }, + }, + }, + { + Name = "CraftingRecipeSchematic", + Type = "Structure", + Fields = + { + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "quantityMin", Type = "number", Nilable = false }, + { Name = "quantityMax", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "recipeType", Type = "TradeskillRecipeType", Nilable = false, Default = "Item" }, + { Name = "productQuality", Type = "number", Nilable = true }, + { Name = "outputItemID", Type = "number", Nilable = true }, + { Name = "reagentSlotSchematics", Type = "table", InnerType = "CraftingReagentSlotSchematic", Nilable = false }, + { Name = "isRecraft", Type = "bool", Nilable = false }, + { Name = "hasCraftingOperationInfo", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CraftingRecipeSkillLineInfo", + Type = "Structure", + Fields = + { + { Name = "professionSkillLineID", Type = "number", Nilable = false }, + { Name = "expansionSkillLineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingResourceReturnInfo", + Type = "Structure", + Fields = + { + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingTargetItem", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "hyperlink", Type = "string", Nilable = true }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "CraftingVariableQuantities", + Type = "Structure", + Fields = + { + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "GatheringOperationBonusStatInfo", + Type = "Structure", + Fields = + { + { Name = "bonusStatName", Type = "string", Nilable = false }, + { Name = "bonusStatValue", Type = "number", Nilable = false }, + { Name = "ratingDescription", Type = "string", Nilable = false }, + { Name = "ratingPct", Type = "number", Nilable = false }, + { Name = "bonusRatingPct", Type = "number", Nilable = false }, + }, + }, + { + Name = "GatheringOperationInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "maxDifficulty", Type = "number", Nilable = false }, + { Name = "baseSkill", Type = "number", Nilable = false }, + { Name = "bonusSkill", Type = "number", Nilable = false }, + { Name = "bonusStats", Type = "table", InnerType = "GatheringOperationBonusStatInfo", Nilable = false }, + }, + }, + { + Name = "ProfessionInfo", + Type = "Structure", + Fields = + { + { Name = "profession", Type = "Profession", Nilable = true }, + { Name = "professionID", Type = "number", Nilable = false }, + { Name = "sourceCounter", Type = "number", Nilable = false }, + { Name = "professionName", Type = "cstring", Nilable = false }, + { Name = "expansionName", Type = "cstring", Nilable = false }, + { Name = "skillLevel", Type = "number", Nilable = false }, + { Name = "maxSkillLevel", Type = "number", Nilable = false }, + { Name = "skillModifier", Type = "number", Nilable = false }, + { Name = "isPrimaryProfession", Type = "bool", Nilable = false }, + { Name = "parentProfessionID", Type = "number", Nilable = true }, + { Name = "parentProfessionName", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "RegularReagentInfo", + Type = "Structure", + Fields = + { + { Name = "reagent", Type = "CraftingReagent", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeSkillRecipeInfo", + Type = "Structure", + Fields = + { + { Name = "categoryID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "relativeDifficulty", Type = "TradeskillRelativeDifficulty", Nilable = true }, + { Name = "maxTrivialLevel", Type = "number", Nilable = false }, + { Name = "itemLevel", Type = "number", Nilable = false }, + { Name = "alternateVerb", Type = "cstring", Nilable = true }, + { Name = "numSkillUps", Type = "number", Nilable = false }, + { Name = "canSkillUp", Type = "bool", Nilable = false }, + { Name = "firstCraft", Type = "bool", Nilable = false }, + { Name = "sourceType", Type = "number", Nilable = true }, + { Name = "learned", Type = "bool", Nilable = false }, + { Name = "disabled", Type = "bool", Nilable = false }, + { Name = "favorite", Type = "bool", Nilable = false }, + { Name = "supportsQualities", Type = "bool", Nilable = false }, + { Name = "craftable", Type = "bool", Nilable = false, Default = true }, + { Name = "disabledReason", Type = "cstring", Nilable = true }, + { Name = "recipeID", Type = "number", Nilable = false }, + { Name = "skillLineAbilityID", Type = "number", Nilable = false }, + { Name = "previousRecipeID", Type = "number", Nilable = true }, + { Name = "nextRecipeID", Type = "number", Nilable = true }, + { Name = "icon", Type = "number", Nilable = true }, + { Name = "hyperlink", Type = "cstring", Nilable = true }, + { Name = "currentRecipeExperience", Type = "number", Nilable = true }, + { Name = "nextLevelRecipeExperience", Type = "number", Nilable = true }, + { Name = "unlockedRecipeLevel", Type = "number", Nilable = true }, + { Name = "earnedExperience", Type = "number", Nilable = true }, + { Name = "supportsCraftingStats", Type = "bool", Nilable = false, Default = false }, + { Name = "hasSingleItemOutput", Type = "bool", Nilable = false, Default = false }, + { Name = "qualityItemIDs", Type = "table", InnerType = "number", Nilable = true }, + { Name = "qualityIlvlBonuses", Type = "table", InnerType = "number", Nilable = true }, + { Name = "alwaysUsesLowestQuality", Type = "bool", Nilable = false, Default = false }, + { Name = "maxQuality", Type = "number", Nilable = true }, + { Name = "qualityIDs", Type = "table", InnerType = "number", Nilable = true }, + { Name = "canCreateMultiple", Type = "bool", Nilable = false, Default = true }, + { Name = "abilityVerb", Type = "cstring", Nilable = true }, + { Name = "abilityAllVerb", Type = "cstring", Nilable = true }, + { Name = "isRecraft", Type = "bool", Nilable = false, Default = false }, + { Name = "isDummyRecipe", Type = "bool", Nilable = false, Default = false }, + { Name = "isGatheringRecipe", Type = "bool", Nilable = false, Default = false }, + { Name = "isEnchantingRecipe", Type = "bool", Nilable = false, Default = false }, + { Name = "isSalvageRecipe", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TradeSkillUITypes); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TrainerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TrainerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1cf29d7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TrainerDocumentation.lua.annotated.lua @@ -0,0 +1,51 @@ +local Trainer = +{ + Name = "Trainer", + Type = "System", + Namespace = "C_Trainer", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "TrainerClosed", + Type = "Event", + LiteralName = "TRAINER_CLOSED", + SynchronousEvent = true, + }, + { + Name = "TrainerDescriptionUpdate", + Type = "Event", + LiteralName = "TRAINER_DESCRIPTION_UPDATE", + SynchronousEvent = true, + }, + { + Name = "TrainerServiceInfoNameUpdate", + Type = "Event", + LiteralName = "TRAINER_SERVICE_INFO_NAME_UPDATE", + UniqueEvent = true, + }, + { + Name = "TrainerShow", + Type = "Event", + LiteralName = "TRAINER_SHOW", + SynchronousEvent = true, + }, + { + Name = "TrainerUpdate", + Type = "Event", + LiteralName = "TRAINER_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Trainer); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConfigDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConfigDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d8d121a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConfigDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local TraitConfig = +{ + Name = "TraitConfig", + Type = "System", + Namespace = "C_TraitConfig", + Environment = "All", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TraitConfig); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..36668e7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TraitConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,329 @@ +local TraitConstants = +{ + Tables = + { + { + Name = "NodeOpFailureReason", + Type = "Enumeration", + NumValues = 27, + MinValue = 0, + MaxValue = 26, + Fields = + { + { Name = "None", Type = "NodeOpFailureReason", EnumValue = 0 }, + { Name = "MissingEdgeConnection", Type = "NodeOpFailureReason", EnumValue = 1 }, + { Name = "RequiredForEdge", Type = "NodeOpFailureReason", EnumValue = 2 }, + { Name = "MissingRequiredEdge", Type = "NodeOpFailureReason", EnumValue = 3 }, + { Name = "HasMutuallyExclusiveEdge", Type = "NodeOpFailureReason", EnumValue = 4 }, + { Name = "NotEnoughSourcedCurrencySpent", Type = "NodeOpFailureReason", EnumValue = 5 }, + { Name = "NotEnoughCurrencySpent", Type = "NodeOpFailureReason", EnumValue = 6 }, + { Name = "NotEnoughGoldSpent", Type = "NodeOpFailureReason", EnumValue = 7 }, + { Name = "MissingAchievement", Type = "NodeOpFailureReason", EnumValue = 8 }, + { Name = "MissingQuest", Type = "NodeOpFailureReason", EnumValue = 9 }, + { Name = "WrongSpec", Type = "NodeOpFailureReason", EnumValue = 10 }, + { Name = "WrongSelection", Type = "NodeOpFailureReason", EnumValue = 11 }, + { Name = "MaxRank", Type = "NodeOpFailureReason", EnumValue = 12 }, + { Name = "DataError", Type = "NodeOpFailureReason", EnumValue = 13 }, + { Name = "NotEnoughSourcedCurrency", Type = "NodeOpFailureReason", EnumValue = 14 }, + { Name = "NotEnoughCurrency", Type = "NodeOpFailureReason", EnumValue = 15 }, + { Name = "NotEnoughGold", Type = "NodeOpFailureReason", EnumValue = 16 }, + { Name = "SameSelection", Type = "NodeOpFailureReason", EnumValue = 17 }, + { Name = "NodeNotFound", Type = "NodeOpFailureReason", EnumValue = 18 }, + { Name = "EntryNotFound", Type = "NodeOpFailureReason", EnumValue = 19 }, + { Name = "RequiredForCondition", Type = "NodeOpFailureReason", EnumValue = 20 }, + { Name = "WrongTreeID", Type = "NodeOpFailureReason", EnumValue = 21 }, + { Name = "LevelTooLow", Type = "NodeOpFailureReason", EnumValue = 22 }, + { Name = "TreeFlaggedNoRefund", Type = "NodeOpFailureReason", EnumValue = 23 }, + { Name = "NodeNeverPurchasable", Type = "NodeOpFailureReason", EnumValue = 24 }, + { Name = "AccountDataNoMatch", Type = "NodeOpFailureReason", EnumValue = 25 }, + { Name = "NotEnoughRanksInEntry", Type = "NodeOpFailureReason", EnumValue = 26 }, + }, + }, + { + Name = "SharedStringFlag", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "InternalOnly", Type = "SharedStringFlag", EnumValue = 1 }, + }, + }, + { + Name = "TraitCombatConfigFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "ActiveForSpec", Type = "TraitCombatConfigFlags", EnumValue = 1 }, + { Name = "StarterBuild", Type = "TraitCombatConfigFlags", EnumValue = 2 }, + { Name = "SharedActionBars", Type = "TraitCombatConfigFlags", EnumValue = 4 }, + }, + }, + { + Name = "TraitCondFlag", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "IsGate", Type = "TraitCondFlag", EnumValue = 1 }, + { Name = "IsAlwaysMet", Type = "TraitCondFlag", EnumValue = 2 }, + { Name = "IsSufficient", Type = "TraitCondFlag", EnumValue = 4 }, + }, + }, + { + Name = "TraitConditionType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Available", Type = "TraitConditionType", EnumValue = 0 }, + { Name = "Visible", Type = "TraitConditionType", EnumValue = 1 }, + { Name = "Granted", Type = "TraitConditionType", EnumValue = 2 }, + { Name = "Increased", Type = "TraitConditionType", EnumValue = 3 }, + { Name = "DisplayError", Type = "TraitConditionType", EnumValue = 4 }, + { Name = "RanksAllowed", Type = "TraitConditionType", EnumValue = 5 }, + }, + }, + { + Name = "TraitConfigDbState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Ready", Type = "TraitConfigDbState", EnumValue = 0 }, + { Name = "Created", Type = "TraitConfigDbState", EnumValue = 1 }, + { Name = "Removed", Type = "TraitConfigDbState", EnumValue = 2 }, + { Name = "Deleted", Type = "TraitConfigDbState", EnumValue = 3 }, + }, + }, + { + Name = "TraitConfigType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Invalid", Type = "TraitConfigType", EnumValue = 0 }, + { Name = "Combat", Type = "TraitConfigType", EnumValue = 1 }, + { Name = "Profession", Type = "TraitConfigType", EnumValue = 2 }, + { Name = "Generic", Type = "TraitConfigType", EnumValue = 3 }, + }, + }, + { + Name = "TraitCurrencyFlag", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "ShowQuantityAsSpent", Type = "TraitCurrencyFlag", EnumValue = 1 }, + { Name = "TraitSourcedShowMax", Type = "TraitCurrencyFlag", EnumValue = 2 }, + { Name = "UseClassIcon", Type = "TraitCurrencyFlag", EnumValue = 4 }, + { Name = "UseSpecIcon", Type = "TraitCurrencyFlag", EnumValue = 8 }, + }, + }, + { + Name = "TraitCurrencyType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Gold", Type = "TraitCurrencyType", EnumValue = 0 }, + { Name = "CurrencyTypesBased", Type = "TraitCurrencyType", EnumValue = 1 }, + { Name = "TraitSourced", Type = "TraitCurrencyType", EnumValue = 2 }, + { Name = "TraitSourcedPlayerDataElement", Type = "TraitCurrencyType", EnumValue = 3 }, + }, + }, + { + Name = "TraitDefinitionSubType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "DragonflightRed", Type = "TraitDefinitionSubType", EnumValue = 0 }, + { Name = "DragonflightBlue", Type = "TraitDefinitionSubType", EnumValue = 1 }, + { Name = "DragonflightGreen", Type = "TraitDefinitionSubType", EnumValue = 2 }, + { Name = "DragonflightBronze", Type = "TraitDefinitionSubType", EnumValue = 3 }, + { Name = "DragonflightBlack", Type = "TraitDefinitionSubType", EnumValue = 4 }, + }, + }, + { + Name = "TraitEdgeType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "VisualOnly", Type = "TraitEdgeType", EnumValue = 0 }, + { Name = "DeprecatedRankConnection", Type = "TraitEdgeType", EnumValue = 1 }, + { Name = "SufficientForAvailability", Type = "TraitEdgeType", EnumValue = 2 }, + { Name = "RequiredForAvailability", Type = "TraitEdgeType", EnumValue = 3 }, + { Name = "MutuallyExclusive", Type = "TraitEdgeType", EnumValue = 4 }, + { Name = "DeprecatedSelectionOption", Type = "TraitEdgeType", EnumValue = 5 }, + }, + }, + { + Name = "TraitEdgeVisualStyle", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "TraitEdgeVisualStyle", EnumValue = 0 }, + { Name = "Straight", Type = "TraitEdgeVisualStyle", EnumValue = 1 }, + }, + }, + { + Name = "TraitNodeEntryType", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "SpendHex", Type = "TraitNodeEntryType", EnumValue = 0 }, + { Name = "SpendSquare", Type = "TraitNodeEntryType", EnumValue = 1 }, + { Name = "SpendCircle", Type = "TraitNodeEntryType", EnumValue = 2 }, + { Name = "SpendSmallCircle", Type = "TraitNodeEntryType", EnumValue = 3 }, + { Name = "DeprecatedSelect", Type = "TraitNodeEntryType", EnumValue = 4 }, + { Name = "DragAndDrop", Type = "TraitNodeEntryType", EnumValue = 5 }, + { Name = "SpendDiamond", Type = "TraitNodeEntryType", EnumValue = 6 }, + { Name = "ProfPath", Type = "TraitNodeEntryType", EnumValue = 7 }, + { Name = "ProfPerk", Type = "TraitNodeEntryType", EnumValue = 8 }, + { Name = "ProfPathUnlock", Type = "TraitNodeEntryType", EnumValue = 9 }, + { Name = "RedButton", Type = "TraitNodeEntryType", EnumValue = 10 }, + { Name = "ArmorSet", Type = "TraitNodeEntryType", EnumValue = 11 }, + { Name = "SpendInfinite", Type = "TraitNodeEntryType", EnumValue = 12 }, + { Name = "SpendCapstoneCircle", Type = "TraitNodeEntryType", EnumValue = 13 }, + { Name = "SpendCapstoneSquare", Type = "TraitNodeEntryType", EnumValue = 14 }, + }, + }, + { + Name = "TraitNodeFlag", + Type = "Enumeration", + NumValues = 9, + MinValue = 1, + MaxValue = 256, + Fields = + { + { Name = "ShowMultipleIcons", Type = "TraitNodeFlag", EnumValue = 1 }, + { Name = "NeverPurchasable", Type = "TraitNodeFlag", EnumValue = 2 }, + { Name = "TestPositionLocked", Type = "TraitNodeFlag", EnumValue = 4 }, + { Name = "TestGridPositioned", Type = "TraitNodeFlag", EnumValue = 8 }, + { Name = "ActiveAtFirstRank", Type = "TraitNodeFlag", EnumValue = 16 }, + { Name = "ShowExpandedSelection", Type = "TraitNodeFlag", EnumValue = 32 }, + { Name = "HideMaxRank", Type = "TraitNodeFlag", EnumValue = 64 }, + { Name = "HighestChosenRank", Type = "TraitNodeFlag", EnumValue = 128 }, + { Name = "ShowTierTrack", Type = "TraitNodeFlag", EnumValue = 256 }, + }, + }, + { + Name = "TraitNodeGroupFlag", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "AvailableByDefault", Type = "TraitNodeGroupFlag", EnumValue = 1 }, + }, + }, + { + Name = "TraitNodeType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Single", Type = "TraitNodeType", EnumValue = 0 }, + { Name = "Tiered", Type = "TraitNodeType", EnumValue = 1 }, + { Name = "Selection", Type = "TraitNodeType", EnumValue = 2 }, + { Name = "SubTreeSelection", Type = "TraitNodeType", EnumValue = 3 }, + }, + }, + { + Name = "TraitPointsOperationType", + Type = "Enumeration", + NumValues = 3, + MinValue = -1, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "TraitPointsOperationType", EnumValue = -1 }, + { Name = "Set", Type = "TraitPointsOperationType", EnumValue = 0 }, + { Name = "Multiply", Type = "TraitPointsOperationType", EnumValue = 1 }, + }, + }, + { + Name = "TraitSystemFlag", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "AllowMultipleLoadoutsPerTree", Type = "TraitSystemFlag", EnumValue = 1 }, + { Name = "ShowSpendConfirmation", Type = "TraitSystemFlag", EnumValue = 2 }, + { Name = "AllowEditInCombat", Type = "TraitSystemFlag", EnumValue = 4 }, + { Name = "AllowEditInChallengeMode", Type = "TraitSystemFlag", EnumValue = 8 }, + }, + }, + { + Name = "TraitSystemVariationType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "TraitSystemVariationType", EnumValue = 0 }, + { Name = "Spec", Type = "TraitSystemVariationType", EnumValue = 1 }, + }, + }, + { + Name = "TraitTreeFlag", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "CannotRefund", Type = "TraitTreeFlag", EnumValue = 1 }, + { Name = "HideSingleRankNumbers", Type = "TraitTreeFlag", EnumValue = 2 }, + }, + }, + { + Name = "TraitConsts", + Type = "Constants", + Values = + { + { Name = "MAX_COMBAT_TRAIT_CONFIGS", Type = "number", Value = 40 }, + { Name = "COMMIT_COMBAT_TRAIT_CONFIG_CHANGES_SPELL_ID", Type = "number", Value = 384255 }, + { Name = "INSPECT_TRAIT_CONFIG_ID", Type = "number", Value = -1 }, + { Name = "STARTER_BUILD_TRAIT_CONFIG_ID", Type = "number", Value = -2 }, + { Name = "VIEW_TRAIT_CONFIG_ID", Type = "number", Value = -3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TraitConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransformManipulatorConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransformManipulatorConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..58d3160 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransformManipulatorConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,80 @@ +local TransformManipulatorConstants = +{ + Tables = + { + { + Name = "TransformManipulatorAxis", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "X", Type = "TransformManipulatorAxis", EnumValue = 1 }, + { Name = "Y", Type = "TransformManipulatorAxis", EnumValue = 2 }, + { Name = "Z", Type = "TransformManipulatorAxis", EnumValue = 4 }, + }, + }, + { + Name = "TransformManipulatorControlState", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Default", Type = "TransformManipulatorControlState", EnumValue = 0 }, + { Name = "Hidden", Type = "TransformManipulatorControlState", EnumValue = 1 }, + { Name = "Dimmed", Type = "TransformManipulatorControlState", EnumValue = 2 }, + { Name = "ExternallyHighlighted", Type = "TransformManipulatorControlState", EnumValue = 3 }, + { Name = "Hovered", Type = "TransformManipulatorControlState", EnumValue = 4 }, + { Name = "Selected", Type = "TransformManipulatorControlState", EnumValue = 5 }, + { Name = "Moving", Type = "TransformManipulatorControlState", EnumValue = 6 }, + }, + }, + { + Name = "TransformManipulatorDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Positive", Type = "TransformManipulatorDirection", EnumValue = 0 }, + { Name = "Negative", Type = "TransformManipulatorDirection", EnumValue = 1 }, + }, + }, + { + Name = "TransformManipulatorEvent", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Start", Type = "TransformManipulatorEvent", EnumValue = 0 }, + { Name = "Change", Type = "TransformManipulatorEvent", EnumValue = 1 }, + { Name = "Complete", Type = "TransformManipulatorEvent", EnumValue = 2 }, + { Name = "Cancel", Type = "TransformManipulatorEvent", EnumValue = 3 }, + { Name = "Hover", Type = "TransformManipulatorEvent", EnumValue = 4 }, + { Name = "MouseDown", Type = "TransformManipulatorEvent", EnumValue = 5 }, + { Name = "MouseUp", Type = "TransformManipulatorEvent", EnumValue = 6 }, + }, + }, + { + Name = "TransformManipulatorMode", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Translate", Type = "TransformManipulatorMode", EnumValue = 0 }, + { Name = "Rotate", Type = "TransformManipulatorMode", EnumValue = 1 }, + { Name = "Scale", Type = "TransformManipulatorMode", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransformManipulatorConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..32f8dfb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,41 @@ +local TransmogConstants = +{ + Tables = + { + { + Name = "TransmogSlot", + Type = "Enumeration", + NumValues = 13, + MinValue = 0, + MaxValue = 12, + Fields = + { + { Name = "Head", Type = "TransmogSlot", EnumValue = 0 }, + { Name = "Shoulder", Type = "TransmogSlot", EnumValue = 1 }, + { Name = "Back", Type = "TransmogSlot", EnumValue = 2 }, + { Name = "Chest", Type = "TransmogSlot", EnumValue = 3 }, + { Name = "Body", Type = "TransmogSlot", EnumValue = 4 }, + { Name = "Tabard", Type = "TransmogSlot", EnumValue = 5 }, + { Name = "Wrist", Type = "TransmogSlot", EnumValue = 6 }, + { Name = "Hand", Type = "TransmogSlot", EnumValue = 7 }, + { Name = "Waist", Type = "TransmogSlot", EnumValue = 8 }, + { Name = "Legs", Type = "TransmogSlot", EnumValue = 9 }, + { Name = "Feet", Type = "TransmogSlot", EnumValue = 10 }, + { Name = "Mainhand", Type = "TransmogSlot", EnumValue = 11 }, + { Name = "Offhand", Type = "TransmogSlot", EnumValue = 12 }, + }, + }, + { + Name = "Transmog", + Type = "Constants", + Values = + { + { Name = "NoTransmogID", Type = "number", Value = 0 }, + { Name = "MainHandTransmogIsIndividualWeapon", Type = "number", Value = -1 }, + { Name = "MainHandTransmogIsPairedWeapon", Type = "number", Value = 0 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransmogConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bb41d40 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogDocumentation.lua.annotated.lua @@ -0,0 +1,321 @@ +local Transmog = +{ + Name = "Transmogrify", + Type = "System", + Namespace = "C_Transmog", + Environment = "All", + + Functions = + { + { + Name = "CanHaveSecondaryAppearanceForSlotID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slotID", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canHaveSecondaryAppearance", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ExtractTransmogIDList", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "input", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "transmogIDList", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAllSetAppearancesByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "setItems", Type = "table", InnerType = "TransmogSetItemInfo", Nilable = true }, + }, + }, + { + Name = "GetItemIDForSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetSlotForInventoryType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventoryType", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "slot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetSlotVisualInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "transmogLocation", Type = "TransmogLocation", Mixin = "TransmogLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "slotVisualInfo", Type = "TransmogSlotVisualInfo", Nilable = false }, + }, + }, + { + Name = "IsAtTransmogNPC", + Type = "Function", + + Returns = + { + { Name = "isAtNPC", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "TransmogCollectionCameraUpdate", + Type = "Event", + LiteralName = "TRANSMOG_COLLECTION_CAMERA_UPDATE", + SynchronousEvent = true, + }, + { + Name = "TransmogCollectionItemFavoriteUpdate", + Type = "Event", + LiteralName = "TRANSMOG_COLLECTION_ITEM_FAVORITE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogCollectionItemUpdate", + Type = "Event", + LiteralName = "TRANSMOG_COLLECTION_ITEM_UPDATE", + UniqueEvent = true, + }, + { + Name = "TransmogCollectionSourceAdded", + Type = "Event", + LiteralName = "TRANSMOG_COLLECTION_SOURCE_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TransmogCollectionSourceRemoved", + Type = "Event", + LiteralName = "TRANSMOG_COLLECTION_SOURCE_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TransmogCollectionUpdated", + Type = "Event", + LiteralName = "TRANSMOG_COLLECTION_UPDATED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "collectionIndex", Type = "luaIndex", Nilable = true }, + { Name = "modID", Type = "number", Nilable = true }, + { Name = "itemAppearanceID", Type = "number", Nilable = true }, + { Name = "reason", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "TransmogCosmeticCollectionSourceAdded", + Type = "Event", + LiteralName = "TRANSMOG_COSMETIC_COLLECTION_SOURCE_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TransmogSearchUpdated", + Type = "Event", + LiteralName = "TRANSMOG_SEARCH_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "searchType", Type = "TransmogSearchType", Nilable = false }, + { Name = "collectionType", Type = "TransmogCollectionType", Nilable = true }, + }, + }, + { + Name = "TransmogSetsUpdateFavorite", + Type = "Event", + LiteralName = "TRANSMOG_SETS_UPDATE_FAVORITE", + SynchronousEvent = true, + }, + { + Name = "TransmogSourceCollectabilityUpdate", + Type = "Event", + LiteralName = "TRANSMOG_SOURCE_COLLECTABILITY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + { Name = "collectable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogrifyClose", + Type = "Event", + LiteralName = "TRANSMOGRIFY_CLOSE", + SynchronousEvent = true, + }, + { + Name = "TransmogrifyItemUpdate", + Type = "Event", + LiteralName = "TRANSMOGRIFY_ITEM_UPDATE", + UniqueEvent = true, + }, + { + Name = "TransmogrifyOpen", + Type = "Event", + LiteralName = "TRANSMOGRIFY_OPEN", + SynchronousEvent = true, + }, + { + Name = "TransmogrifySuccess", + Type = "Event", + LiteralName = "TRANSMOGRIFY_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "transmogLocation", Type = "TransmogLocation", Mixin = "TransmogLocationMixin", Nilable = false }, + }, + }, + { + Name = "TransmogrifyUpdate", + Type = "Event", + LiteralName = "TRANSMOGRIFY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "transmogLocation", Type = "TransmogLocation", Mixin = "TransmogLocationMixin", Nilable = true }, + { Name = "action", Type = "cstring", Nilable = true }, + }, + }, + }, + + Tables = + { + { + Name = "TransmogPendingType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Apply", Type = "TransmogPendingType", EnumValue = 0 }, + { Name = "Revert", Type = "TransmogPendingType", EnumValue = 1 }, + { Name = "ToggleOn", Type = "TransmogPendingType", EnumValue = 2 }, + { Name = "ToggleOff", Type = "TransmogPendingType", EnumValue = 3 }, + }, + }, + { + Name = "TransmogApplyWarningInfo", + Type = "Structure", + Fields = + { + { Name = "itemLink", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "TransmogSetItemInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + { Name = "invSlot", Type = "number", Nilable = false }, + { Name = "invType", Type = "string", Nilable = false }, + }, + }, + { + Name = "TransmogSlotInfo", + Type = "Structure", + Fields = + { + { Name = "isTransmogrified", Type = "bool", Nilable = false }, + { Name = "hasPending", Type = "bool", Nilable = false }, + { Name = "isPendingCollected", Type = "bool", Nilable = false }, + { Name = "canTransmogrify", Type = "bool", Nilable = false }, + { Name = "cannotTransmogrifyReason", Type = "number", Nilable = false }, + { Name = "hasUndo", Type = "bool", Nilable = false }, + { Name = "isHideVisual", Type = "bool", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = true }, + }, + }, + { + Name = "TransmogSlotVisualInfo", + Type = "Structure", + Fields = + { + { Name = "baseSourceID", Type = "number", Nilable = false }, + { Name = "baseVisualID", Type = "number", Nilable = false }, + { Name = "appliedSourceID", Type = "number", Nilable = false }, + { Name = "appliedVisualID", Type = "number", Nilable = false }, + { Name = "pendingSourceID", Type = "number", Nilable = false }, + { Name = "pendingVisualID", Type = "number", Nilable = false }, + { Name = "hasUndo", Type = "bool", Nilable = false }, + { Name = "isHideVisual", Type = "bool", Nilable = false }, + { Name = "itemSubclass", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Transmog); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6c5e4e7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogItemsDocumentation.lua.annotated.lua @@ -0,0 +1,1228 @@ +local TransmogItems = +{ + Name = "TransmogrifyCollection", + Type = "System", + Namespace = "C_TransmogCollection", + Environment = "All", + + Functions = + { + { + Name = "AccountCanCollectSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasItemData", Type = "bool", Nilable = false }, + { Name = "canCollect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AreAllCollectionTypeFiltersChecked", + Type = "Function", + + Returns = + { + { Name = "areAllCollectionTypeFiltersChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AreAllSourceTypeFiltersChecked", + Type = "Function", + + Returns = + { + { Name = "areAllSourceTypeFiltersChecked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanAppearanceHaveIllusion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canHaveIllusion", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearNewAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "visualID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClearSearch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchType", Type = "TransmogSearchType", Nilable = false }, + }, + + Returns = + { + { Name = "completed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeleteCustomSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "customSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "EndSearch", + Type = "Function", + }, + { + Name = "GetAllAppearanceSources", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemModifiedAppearanceIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetAllFactionsShown", + Type = "Function", + + Returns = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAllRacesShown", + Type = "Function", + + Returns = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAppearanceCameraID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "variation", Type = "TransmogCameraVariation", Nilable = true }, + }, + + Returns = + { + { Name = "cameraID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAppearanceCameraIDBySource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + { Name = "variation", Type = "TransmogCameraVariation", Nilable = true }, + }, + + Returns = + { + { Name = "cameraID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAppearanceInfoBySource", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "TransmogAppearanceInfoBySourceData", Nilable = false }, + }, + }, + { + Name = "GetAppearanceSourceDrops", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "encounterInfo", Type = "table", InnerType = "TransmogAppearanceJournalEncounterInfo", Nilable = false }, + }, + }, + { + Name = "GetAppearanceSourceInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "TransmogAppearanceSourceInfoData", Nilable = false }, + }, + }, + { + Name = "GetAppearanceSources", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + { Name = "categoryType", Type = "TransmogCollectionType", Nilable = true }, + { Name = "transmogLocation", Type = "TransmogLocation", Mixin = "TransmogLocationMixin", Nilable = true }, + }, + + Returns = + { + { Name = "sources", Type = "table", InnerType = "AppearanceSourceInfo", Nilable = false }, + }, + }, + { + Name = "GetArtifactAppearanceStrings", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "hyperlink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCategoryAppearances", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + { Name = "transmogLocation", Type = "TransmogLocation", Mixin = "TransmogLocationMixin", Nilable = true }, + }, + + Returns = + { + { Name = "appearances", Type = "table", InnerType = "TransmogCategoryAppearanceInfo", Nilable = false }, + }, + }, + { + Name = "GetCategoryCollectedCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCategoryForItem", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "collectionCategory", Type = "TransmogCollectionType", Nilable = false }, + }, + }, + { + Name = "GetCategoryInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isWeapon", Type = "bool", Nilable = false, Default = false }, + { Name = "canHaveIllusions", Type = "bool", Nilable = false, Default = false }, + { Name = "canMainHand", Type = "bool", Nilable = false, Default = false }, + { Name = "canOffHand", Type = "bool", Nilable = false, Default = false }, + { Name = "canRanged", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetCategoryTotal", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "total", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetClassFilter", + Type = "Function", + + Returns = + { + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCollectedShown", + Type = "Function", + + Returns = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCustomSetHyperlinkFromItemTransmogInfoList", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemTransmogInfoList", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + + Returns = + { + { Name = "hyperlink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetCustomSetInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "customSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetCustomSetItemTransmogInfoList", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "customSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "list", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + }, + { + Name = "GetCustomSets", + Type = "Function", + + Returns = + { + { Name = "customSetID", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetFallbackWeaponAppearance", + Type = "Function", + + Returns = + { + { Name = "appearanceID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFilteredCategoryCollectedCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFilteredCategoryTotal", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "total", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIllusionInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "illusionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "TransmogIllusionInfo", Nilable = false }, + }, + }, + { + Name = "GetIllusionStrings", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "illusionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "hyperlink", Type = "string", Nilable = false }, + { Name = "sourceText", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetIllusions", + Type = "Function", + + Returns = + { + { Name = "illusions", Type = "table", InnerType = "TransmogIllusionInfo", Nilable = false }, + }, + }, + { + Name = "GetInspectItemTransmogInfoList", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "list", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + }, + { + Name = "GetIsAppearanceFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemTransmogInfoListFromCustomSetHyperlink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "hyperlink", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "list", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + }, + { + Name = "GetLatestAppearance", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "visualID", Type = "number", Nilable = false }, + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + }, + { + Name = "GetNumMaxCustomSets", + Type = "Function", + + Returns = + { + { Name = "maxCustomSets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTransmogSources", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPairedArtifactAppearance", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pairedItemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSourceIcon", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "GetSourceInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sourceInfo", Type = "AppearanceSourceInfo", Nilable = false }, + }, + }, + { + Name = "GetSourceItemID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSourceRequiredHoliday", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "holidayName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetUncollectedShown", + Type = "Function", + + Returns = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetValidAppearanceSourcesForClass", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "categoryType", Type = "TransmogCollectionType", Nilable = true }, + { Name = "transmogLocation", Type = "TransmogLocation", Mixin = "TransmogLocationMixin", Nilable = true }, + }, + + Returns = + { + { Name = "sources", Type = "table", InnerType = "AppearanceSourceInfo", Nilable = false }, + }, + }, + { + Name = "HasFavorites", + Type = "Function", + + Returns = + { + { Name = "hasFavorites", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAppearanceHiddenVisual", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isHiddenVisual", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCategoryValidForItem", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isValid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsNewAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "visualID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isNew", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSearchDBLoading", + Type = "Function", + + Returns = + { + { Name = "isLoading", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSearchInProgress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchType", Type = "TransmogSearchType", Nilable = false }, + }, + + Returns = + { + { Name = "inProgress", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSourceTypeFilterChecked", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellItemEnchantmentHiddenVisual", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "spellItemEnchantmentID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isHiddenVisual", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingDefaultFilters", + Type = "Function", + + Returns = + { + { Name = "isUsingDefaultFilters", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidCustomSetName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isApproved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidTransmogSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "TransmogSource", Nilable = false }, + }, + + Returns = + { + { Name = "valid", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ModifyCustomSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "customSetID", Type = "number", Nilable = false }, + { Name = "itemTransmogInfoList", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + }, + { + Name = "NewCustomSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "itemTransmogInfoList", Type = "table", InnerType = "ItemTransmogInfo", Nilable = false }, + }, + + Returns = + { + { Name = "customSetID", Type = "number", Nilable = true }, + }, + }, + { + Name = "PlayerCanCollectSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasItemData", Type = "bool", Nilable = false }, + { Name = "canCollect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerHasTransmog", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemAppearanceModID", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "hasTransmog", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerHasTransmogByItemInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "hasTransmog", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerHasTransmogItemModifiedAppearance", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemModifiedAppearanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasTransmog", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerKnowsSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sourceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isKnown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RenameCustomSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "customSetID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SearchProgress", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchType", Type = "TransmogSearchType", Nilable = false }, + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "SearchSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchType", Type = "TransmogSearchType", Nilable = false }, + }, + + Returns = + { + { Name = "size", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetAllCollectionTypeFilters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllFactionsShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllRacesShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetAllSourceTypeFilters", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetClassFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCollectedShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetDefaultFilters", + Type = "Function", + }, + { + Name = "SetIsAppearanceFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSearch", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchType", Type = "TransmogSearchType", Nilable = false }, + { Name = "searchText", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "completed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSearchAndFilterCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + }, + }, + { + Name = "SetSourceTypeFilter", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "checked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetUncollectedShown", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "shown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UpdateUsableAppearances", + Type = "Function", + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "TransmogCameraVariation", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "TransmogCameraVariation", EnumValue = 0 }, + { Name = "RightShoulder", Type = "TransmogCameraVariation", EnumValue = 1 }, + { Name = "CloakBackpack", Type = "TransmogCameraVariation", EnumValue = 1 }, + }, + }, + { + Name = "TransmogAppearanceInfoBySourceData", + Type = "Structure", + Fields = + { + { Name = "appearanceID", Type = "number", Nilable = false }, + { Name = "appearanceIsCollected", Type = "bool", Nilable = false }, + { Name = "sourceIsCollected", Type = "bool", Nilable = false }, + { Name = "sourceIsCollectedPermanent", Type = "bool", Nilable = false }, + { Name = "sourceIsCollectedConditional", Type = "bool", Nilable = false }, + { Name = "meetsTransmogPlayerCondition", Type = "bool", Nilable = false }, + { Name = "appearanceHasAnyNonLevelRequirements", Type = "bool", Nilable = false }, + { Name = "appearanceMeetsNonLevelRequirements", Type = "bool", Nilable = false }, + { Name = "appearanceIsUsable", Type = "bool", Nilable = false }, + { Name = "appearanceNumSources", Type = "number", Nilable = false }, + { Name = "sourceIsKnown", Type = "bool", Nilable = false }, + { Name = "canDisplayOnPlayer", Type = "bool", Nilable = false }, + { Name = "isAnySourceValidForPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogAppearanceJournalEncounterInfo", + Type = "Structure", + Fields = + { + { Name = "instance", Type = "string", Nilable = false }, + { Name = "instanceType", Type = "number", Nilable = false }, + { Name = "tiers", Type = "table", InnerType = "string", Nilable = false }, + { Name = "encounter", Type = "string", Nilable = false }, + { Name = "difficulties", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "TransmogAppearanceSourceInfoData", + Type = "Structure", + Fields = + { + { Name = "category", Type = "TransmogCollectionType", Nilable = false }, + { Name = "itemAppearanceID", Type = "number", Nilable = false }, + { Name = "canHaveIllusion", Type = "bool", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = false }, + { Name = "transmoglink", Type = "string", Nilable = false }, + { Name = "sourceType", Type = "luaIndex", Nilable = true }, + { Name = "itemSubclass", Type = "number", Nilable = false }, + }, + }, + { + Name = "TransmogCategoryAppearanceInfo", + Type = "Structure", + Fields = + { + { Name = "visualID", Type = "number", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "isHideVisual", Type = "bool", Nilable = false }, + { Name = "canDisplayOnPlayer", Type = "bool", Nilable = false }, + { Name = "uiOrder", Type = "number", Nilable = false }, + { Name = "exclusions", Type = "number", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "hasRequiredHoliday", Type = "bool", Nilable = false }, + { Name = "hasActiveRequiredHoliday", Type = "bool", Nilable = false }, + { Name = "alwaysShowItem", Type = "bool", Nilable = true, Documentation = { "For internal testing only" } }, + }, + }, + { + Name = "TransmogCategoryInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isWeapon", Type = "bool", Nilable = false, Default = false }, + { Name = "canHaveIllusions", Type = "bool", Nilable = false, Default = false }, + { Name = "canMainHand", Type = "bool", Nilable = false, Default = false }, + { Name = "canOffHand", Type = "bool", Nilable = false, Default = false }, + { Name = "canRanged", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "TransmogCustomSetInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "TransmogIllusionInfo", + Type = "Structure", + Fields = + { + { Name = "visualID", Type = "number", Nilable = false }, + { Name = "sourceID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isCollected", Type = "bool", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "isHideVisual", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransmogItems); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3b24a66 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,396 @@ +local TransmogOutfitConstants = +{ + Tables = + { + { + Name = "TransmogOutfitCostModifiersApplied", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "DebugOnlyFreeDiscountApplied", Type = "TransmogOutfitCostModifiersApplied", EnumValue = 1 }, + { Name = "VoidRacialDiscountApplied", Type = "TransmogOutfitCostModifiersApplied", EnumValue = 2 }, + { Name = "OutfitCostModifierApplied", Type = "TransmogOutfitCostModifiersApplied", EnumValue = 4 }, + { Name = "AuraDiscountApplied", Type = "TransmogOutfitCostModifiersApplied", EnumValue = 8 }, + }, + }, + { + Name = "TransmogOutfitDataFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "IsCachedLocally", Type = "TransmogOutfitDataFlags", EnumValue = 1 }, + }, + }, + { + Name = "TransmogOutfitDisplayType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Unassigned", Type = "TransmogOutfitDisplayType", EnumValue = 0 }, + { Name = "Assigned", Type = "TransmogOutfitDisplayType", EnumValue = 1 }, + { Name = "Equipped", Type = "TransmogOutfitDisplayType", EnumValue = 2 }, + { Name = "Hidden", Type = "TransmogOutfitDisplayType", EnumValue = 3 }, + { Name = "Disabled", Type = "TransmogOutfitDisplayType", EnumValue = 4 }, + }, + }, + { + Name = "TransmogOutfitEntryFlags", + Type = "Enumeration", + NumValues = 6, + MinValue = 1, + MaxValue = 32, + Fields = + { + { Name = "AutomaticallyAwardedOnLogin", Type = "TransmogOutfitEntryFlags", EnumValue = 1 }, + { Name = "UseOverrideName", Type = "TransmogOutfitEntryFlags", EnumValue = 2 }, + { Name = "OnlyAvailableDuringEvent", Type = "TransmogOutfitEntryFlags", EnumValue = 4 }, + { Name = "SortedToTopOfList", Type = "TransmogOutfitEntryFlags", EnumValue = 8 }, + { Name = "UseOverrideCostModifier", Type = "TransmogOutfitEntryFlags", EnumValue = 16 }, + { Name = "IsDefaultEquipped", Type = "TransmogOutfitEntryFlags", EnumValue = 32 }, + }, + }, + { + Name = "TransmogOutfitEntrySource", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "StampedSource", Type = "TransmogOutfitEntrySource", EnumValue = 0 }, + { Name = "AutomaticallyAwarded", Type = "TransmogOutfitEntrySource", EnumValue = 1 }, + { Name = "PlayerPurchased", Type = "TransmogOutfitEntrySource", EnumValue = 2 }, + }, + }, + { + Name = "TransmogOutfitEquipAction", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Equip", Type = "TransmogOutfitEquipAction", EnumValue = 0 }, + { Name = "EquipAndLock", Type = "TransmogOutfitEquipAction", EnumValue = 1 }, + { Name = "Remove", Type = "TransmogOutfitEquipAction", EnumValue = 2 }, + { Name = "RemoveAndLock", Type = "TransmogOutfitEquipAction", EnumValue = 3 }, + { Name = "Unlock", Type = "TransmogOutfitEquipAction", EnumValue = 4 }, + { Name = "Lock", Type = "TransmogOutfitEquipAction", EnumValue = 5 }, + }, + }, + { + Name = "TransmogOutfitSetType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Equipped", Type = "TransmogOutfitSetType", EnumValue = 0 }, + { Name = "Outfit", Type = "TransmogOutfitSetType", EnumValue = 1 }, + { Name = "CustomSet", Type = "TransmogOutfitSetType", EnumValue = 2 }, + }, + }, + { + Name = "TransmogOutfitSlot", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "Head", Type = "TransmogOutfitSlot", EnumValue = 0 }, + { Name = "ShoulderRight", Type = "TransmogOutfitSlot", EnumValue = 1 }, + { Name = "ShoulderLeft", Type = "TransmogOutfitSlot", EnumValue = 2 }, + { Name = "Back", Type = "TransmogOutfitSlot", EnumValue = 3 }, + { Name = "Chest", Type = "TransmogOutfitSlot", EnumValue = 4 }, + { Name = "Tabard", Type = "TransmogOutfitSlot", EnumValue = 5 }, + { Name = "Body", Type = "TransmogOutfitSlot", EnumValue = 6 }, + { Name = "Wrist", Type = "TransmogOutfitSlot", EnumValue = 7 }, + { Name = "Hand", Type = "TransmogOutfitSlot", EnumValue = 8 }, + { Name = "Waist", Type = "TransmogOutfitSlot", EnumValue = 9 }, + { Name = "Legs", Type = "TransmogOutfitSlot", EnumValue = 10 }, + { Name = "Feet", Type = "TransmogOutfitSlot", EnumValue = 11 }, + { Name = "WeaponMainHand", Type = "TransmogOutfitSlot", EnumValue = 12 }, + { Name = "WeaponOffHand", Type = "TransmogOutfitSlot", EnumValue = 13 }, + { Name = "WeaponRanged", Type = "TransmogOutfitSlot", EnumValue = 14 }, + }, + }, + { + Name = "TransmogOutfitSlotError", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 14, + Fields = + { + { Name = "Ok", Type = "TransmogOutfitSlotError", EnumValue = 0 }, + { Name = "NoItem", Type = "TransmogOutfitSlotError", EnumValue = 1 }, + { Name = "NotSoulbound", Type = "TransmogOutfitSlotError", EnumValue = 2 }, + { Name = "Legendary", Type = "TransmogOutfitSlotError", EnumValue = 3 }, + { Name = "InvalidItemType", Type = "TransmogOutfitSlotError", EnumValue = 4 }, + { Name = "InvalidDestination", Type = "TransmogOutfitSlotError", EnumValue = 5 }, + { Name = "Mismatch", Type = "TransmogOutfitSlotError", EnumValue = 6 }, + { Name = "SameItem", Type = "TransmogOutfitSlotError", EnumValue = 7 }, + { Name = "InvalidSource", Type = "TransmogOutfitSlotError", EnumValue = 8 }, + { Name = "InvalidSourceQuality", Type = "TransmogOutfitSlotError", EnumValue = 9 }, + { Name = "CannotUseItem", Type = "TransmogOutfitSlotError", EnumValue = 10 }, + { Name = "InvalidSlotForRace", Type = "TransmogOutfitSlotError", EnumValue = 11 }, + { Name = "NoIllusion", Type = "TransmogOutfitSlotError", EnumValue = 12 }, + { Name = "InvalidSlotForForm", Type = "TransmogOutfitSlotError", EnumValue = 13 }, + { Name = "IncompatibleWithMainHand", Type = "TransmogOutfitSlotError", EnumValue = 14 }, + }, + }, + { + Name = "TransmogOutfitSlotFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "CannotBeHidden", Type = "TransmogOutfitSlotFlags", EnumValue = 1 }, + { Name = "CanHaveIllusions", Type = "TransmogOutfitSlotFlags", EnumValue = 2 }, + { Name = "IsSecondarySlot", Type = "TransmogOutfitSlotFlags", EnumValue = 4 }, + }, + }, + { + Name = "TransmogOutfitSlotOption", + Type = "Enumeration", + NumValues = 12, + MinValue = 0, + MaxValue = 11, + Fields = + { + { Name = "None", Type = "TransmogOutfitSlotOption", EnumValue = 0 }, + { Name = "OneHandedWeapon", Type = "TransmogOutfitSlotOption", EnumValue = 1 }, + { Name = "TwoHandedWeapon", Type = "TransmogOutfitSlotOption", EnumValue = 2 }, + { Name = "RangedWeapon", Type = "TransmogOutfitSlotOption", EnumValue = 3 }, + { Name = "OffHand", Type = "TransmogOutfitSlotOption", EnumValue = 4 }, + { Name = "Shield", Type = "TransmogOutfitSlotOption", EnumValue = 5 }, + { Name = "DeprecatedReuseMe", Type = "TransmogOutfitSlotOption", EnumValue = 6 }, + { Name = "FuryTwoHandedWeapon", Type = "TransmogOutfitSlotOption", EnumValue = 7 }, + { Name = "ArtifactSpecOne", Type = "TransmogOutfitSlotOption", EnumValue = 8 }, + { Name = "ArtifactSpecTwo", Type = "TransmogOutfitSlotOption", EnumValue = 9 }, + { Name = "ArtifactSpecThree", Type = "TransmogOutfitSlotOption", EnumValue = 10 }, + { Name = "ArtifactSpecFour", Type = "TransmogOutfitSlotOption", EnumValue = 11 }, + }, + }, + { + Name = "TransmogOutfitSlotOptionFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 4, + Fields = + { + { Name = "IllusionNotAllowed", Type = "TransmogOutfitSlotOptionFlags", EnumValue = 1 }, + { Name = "DynamicOptionName", Type = "TransmogOutfitSlotOptionFlags", EnumValue = 2 }, + { Name = "DisablesOffhandSlot", Type = "TransmogOutfitSlotOptionFlags", EnumValue = 4 }, + }, + }, + { + Name = "TransmogOutfitSlotPosition", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Left", Type = "TransmogOutfitSlotPosition", EnumValue = 0 }, + { Name = "Right", Type = "TransmogOutfitSlotPosition", EnumValue = 1 }, + { Name = "Bottom", Type = "TransmogOutfitSlotPosition", EnumValue = 2 }, + }, + }, + { + Name = "TransmogOutfitSlotSaveFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "AppearanceIsNotValid", Type = "TransmogOutfitSlotSaveFlags", EnumValue = 1 }, + }, + }, + { + Name = "TransmogOutfitSlotWarning", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Ok", Type = "TransmogOutfitSlotWarning", EnumValue = 0 }, + { Name = "InvalidEquippedDestinationItem", Type = "TransmogOutfitSlotWarning", EnumValue = 1 }, + { Name = "WrongWeaponCategoryEquipped", Type = "TransmogOutfitSlotWarning", EnumValue = 2 }, + { Name = "PendingWeaponChanges", Type = "TransmogOutfitSlotWarning", EnumValue = 3 }, + { Name = "WeaponDoesNotSupportIllusions", Type = "TransmogOutfitSlotWarning", EnumValue = 4 }, + { Name = "NothingEquipped", Type = "TransmogOutfitSlotWarning", EnumValue = 5 }, + }, + }, + { + Name = "TransmogOutfitTransactionFlags", + Type = "Enumeration", + NumValues = 10, + MinValue = 1, + MaxValue = 28, + Fields = + { + { Name = "UpdateMetadata", Type = "TransmogOutfitTransactionFlags", EnumValue = 1 }, + { Name = "UpdateOutfitInfo", Type = "TransmogOutfitTransactionFlags", EnumValue = 2 }, + { Name = "CreateOutfitInfo", Type = "TransmogOutfitTransactionFlags", EnumValue = 4 }, + { Name = "UpdateSlots", Type = "TransmogOutfitTransactionFlags", EnumValue = 8 }, + { Name = "UpdateSituations", Type = "TransmogOutfitTransactionFlags", EnumValue = 16 }, + { Name = "AddNewOutfitMask", Type = "TransmogOutfitTransactionFlags", EnumValue = 20 }, + { Name = "UpdateSituationsMask", Type = "TransmogOutfitTransactionFlags", EnumValue = 18 }, + { Name = "AddOutfitAndUpdateSlots", Type = "TransmogOutfitTransactionFlags", EnumValue = 28 }, + { Name = "FullOutfitUpdateMask", Type = "TransmogOutfitTransactionFlags", EnumValue = 27 }, + { Name = "CreateAndUpdateOutfitInfoMask", Type = "TransmogOutfitTransactionFlags", EnumValue = 6 }, + }, + }, + { + Name = "TransmogOutfitTransactionType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "UpdateMetadata", Type = "TransmogOutfitTransactionType", EnumValue = 0 }, + { Name = "UpdateOutfitInfo", Type = "TransmogOutfitTransactionType", EnumValue = 1 }, + { Name = "CreateOutfitInfo", Type = "TransmogOutfitTransactionType", EnumValue = 2 }, + { Name = "UpdateSlots", Type = "TransmogOutfitTransactionType", EnumValue = 3 }, + { Name = "UpdateSituations", Type = "TransmogOutfitTransactionType", EnumValue = 4 }, + }, + }, + { + Name = "TransmogSituation", + Type = "Enumeration", + NumValues = 22, + MinValue = 0, + MaxValue = 21, + Fields = + { + { Name = "AllSpecs", Type = "TransmogSituation", EnumValue = 0 }, + { Name = "Spec", Type = "TransmogSituation", EnumValue = 1 }, + { Name = "AllLocations", Type = "TransmogSituation", EnumValue = 2 }, + { Name = "LocationRested", Type = "TransmogSituation", EnumValue = 3 }, + { Name = "LocationHouse", Type = "TransmogSituation", EnumValue = 4 }, + { Name = "LocationCharacterSelect", Type = "TransmogSituation", EnumValue = 5 }, + { Name = "LocationWorld", Type = "TransmogSituation", EnumValue = 6 }, + { Name = "LocationDelves", Type = "TransmogSituation", EnumValue = 7 }, + { Name = "LocationDungeons", Type = "TransmogSituation", EnumValue = 8 }, + { Name = "LocationRaids", Type = "TransmogSituation", EnumValue = 9 }, + { Name = "LocationArenas", Type = "TransmogSituation", EnumValue = 10 }, + { Name = "LocationBattlegrounds", Type = "TransmogSituation", EnumValue = 11 }, + { Name = "AllMovement", Type = "TransmogSituation", EnumValue = 12 }, + { Name = "MovementUnmounted", Type = "TransmogSituation", EnumValue = 13 }, + { Name = "MovementSwimming", Type = "TransmogSituation", EnumValue = 14 }, + { Name = "MovementGroundMount", Type = "TransmogSituation", EnumValue = 15 }, + { Name = "MovementFlyingMount", Type = "TransmogSituation", EnumValue = 16 }, + { Name = "AllEquipmentSets", Type = "TransmogSituation", EnumValue = 17 }, + { Name = "EquipmentSets", Type = "TransmogSituation", EnumValue = 18 }, + { Name = "AllRacialForms", Type = "TransmogSituation", EnumValue = 19 }, + { Name = "FormNative", Type = "TransmogSituation", EnumValue = 20 }, + { Name = "FormNonNative", Type = "TransmogSituation", EnumValue = 21 }, + }, + }, + { + Name = "TransmogSituationFlags", + Type = "Enumeration", + NumValues = 7, + MinValue = 1, + MaxValue = 64, + Fields = + { + { Name = "IsPlayerFacing", Type = "TransmogSituationFlags", EnumValue = 1 }, + { Name = "SpecUseTalentLoadout", Type = "TransmogSituationFlags", EnumValue = 2 }, + { Name = "AllSituation", Type = "TransmogSituationFlags", EnumValue = 4 }, + { Name = "DefaultsToOn", Type = "TransmogSituationFlags", EnumValue = 8 }, + { Name = "DynamicallyNamed", Type = "TransmogSituationFlags", EnumValue = 16 }, + { Name = "NoneSituation", Type = "TransmogSituationFlags", EnumValue = 32 }, + { Name = "DisabledSituation", Type = "TransmogSituationFlags", EnumValue = 64 }, + }, + }, + { + Name = "TransmogSituationGroupFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "DynamicallyCreatesGroups", Type = "TransmogSituationGroupFlags", EnumValue = 1 }, + }, + }, + { + Name = "TransmogSituationTrigger", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "TransmogSituationTrigger", EnumValue = 0 }, + { Name = "Manual", Type = "TransmogSituationTrigger", EnumValue = 1 }, + { Name = "TransmogUpdate", Type = "TransmogSituationTrigger", EnumValue = 2 }, + { Name = "Location", Type = "TransmogSituationTrigger", EnumValue = 3 }, + { Name = "Movement", Type = "TransmogSituationTrigger", EnumValue = 4 }, + { Name = "Specialization", Type = "TransmogSituationTrigger", EnumValue = 5 }, + { Name = "EquipmentSet", Type = "TransmogSituationTrigger", EnumValue = 6 }, + { Name = "Forms", Type = "TransmogSituationTrigger", EnumValue = 7 }, + { Name = "EventOutfit", Type = "TransmogSituationTrigger", EnumValue = 8 }, + }, + }, + { + Name = "TransmogSituationTriggerFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "CanLockOutfit", Type = "TransmogSituationTriggerFlags", EnumValue = 1 }, + { Name = "CanChangeLockedOutfit", Type = "TransmogSituationTriggerFlags", EnumValue = 2 }, + { Name = "IsPlayerFacing", Type = "TransmogSituationTriggerFlags", EnumValue = 4 }, + { Name = "SituationsAreExclusive", Type = "TransmogSituationTriggerFlags", EnumValue = 8 }, + { Name = "DisabledTrigger", Type = "TransmogSituationTriggerFlags", EnumValue = 16 }, + }, + }, + { + Name = "TransmogSituationTriggerType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "TransmogSituationTriggerType", EnumValue = 0 }, + { Name = "Manual", Type = "TransmogSituationTriggerType", EnumValue = 1 }, + { Name = "Automatic", Type = "TransmogSituationTriggerType", EnumValue = 2 }, + { Name = "TransmogUpdate", Type = "TransmogSituationTriggerType", EnumValue = 3 }, + }, + }, + { + Name = "TransmogOutfitDataConsts", + Type = "Constants", + Values = + { + { Name = "EQUIP_TRANSMOG_OUTFIT_MANUAL_SPELL_ID", Type = "number", Value = 1247613 }, + { Name = "TRANSMOG_OUTFIT_SLOT_NONE", Type = "TransmogOutfitSlot", Value = -1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransmogOutfitConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e2fd346 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogOutfitInfoDocumentation.lua.annotated.lua @@ -0,0 +1,913 @@ +local TransmogOutfitInfo = +{ + Name = "TransmogOutfitInfo", + Type = "System", + Namespace = "C_TransmogOutfitInfo", + Environment = "All", + + Functions = + { + { + Name = "AddNewOutfit", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "ChangeDisplayedOutfit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + { Name = "trigger", Type = "TransmogSituationTrigger", Nilable = false }, + { Name = "toggleLock", Type = "bool", Nilable = false }, + { Name = "allowRemoveOutfit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChangeViewedOutfit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClearAllPendingSituations", + Type = "Function", + }, + { + Name = "ClearAllPendingTransmogs", + Type = "Function", + }, + { + Name = "ClearDisplayedOutfit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "trigger", Type = "TransmogSituationTrigger", Nilable = false }, + { Name = "toggleLock", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CommitAndApplyAllPending", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "useAvailableDiscount", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CommitOutfitInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "CommitPendingSituations", + Type = "Function", + }, + { + Name = "GetActiveOutfitID", + Type = "Function", + + Returns = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAllSlotLocationInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "appearanceSlotInfo", Type = "table", InnerType = "TransmogOutfitSlotInfo", Nilable = false }, + { Name = "illusionSlotInfo", Type = "table", InnerType = "TransmogOutfitSlotInfo", Nilable = false }, + }, + }, + { + Name = "GetCollectionInfoForSlotAndOption", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "weaponOption", Type = "TransmogOutfitSlotOption", Nilable = false }, + { Name = "collectionType", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "collectionInfo", Type = "TransmogOutfitWeaponCollectionInfo", Nilable = false }, + }, + }, + { + Name = "GetCurrentlyViewedOutfitID", + Type = "Function", + + Returns = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEquippedSlotOptionFromTransmogSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "weaponOption", Type = "TransmogOutfitSlotOption", Nilable = false }, + }, + }, + { + Name = "GetIllusionDefaultIMAIDForCollectionType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "collectionType", Type = "TransmogCollectionType", Nilable = false }, + }, + + Returns = + { + { Name = "imaID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemModifiedAppearanceEffectiveCategory", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "imaID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categoryID", Type = "TransmogCollectionType", Nilable = false }, + }, + }, + { + Name = "GetLinkedSlotInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "linkedSlotInfo", Type = "TransmogOutfitLinkedSlotInfo", Nilable = false }, + }, + }, + { + Name = "GetMaxNumberOfTotalOutfitsForSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "TransmogOutfitEntrySource", Nilable = false }, + }, + + Returns = + { + { Name = "maxOutfitCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxNumberOfUsableOutfits", + Type = "Function", + + Returns = + { + { Name = "maxOutfitCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNextOutfitCost", + Type = "Function", + + Returns = + { + { Name = "outfitCost", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "GetNumberOfOutfitsUnlockedForSource", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "source", Type = "TransmogOutfitEntrySource", Nilable = false }, + }, + + Returns = + { + { Name = "unlockedOutfitCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOutfitInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "outfitsInfo", Type = "TransmogOutfitEntryInfo", Nilable = false }, + }, + }, + { + Name = "GetOutfitSituation", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "option", Type = "TransmogSituationOption", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetOutfitSituationsEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetOutfitsInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "outfitsInfo", Type = "table", InnerType = "TransmogOutfitEntryInfo", Nilable = false }, + }, + }, + { + Name = "GetPendingTransmogCost", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "cost", Type = "BigUInteger", Nilable = false }, + }, + }, + { + Name = "GetSecondarySlotState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSetSourcesForSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "transmogSetID", Type = "number", Nilable = false }, + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "sources", Type = "table", InnerType = "AppearanceSourceInfo", Nilable = false }, + }, + }, + { + Name = "GetSlotGroupInfo", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "slotGroups", Type = "table", InnerType = "TransmogOutfitSlotGroup", Nilable = false }, + }, + }, + { + Name = "GetSourceIDsForSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "transmogSetID", Type = "number", Nilable = false }, + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "sources", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetTransmogOutfitSlotForInventoryType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventoryType", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + }, + { + Name = "GetTransmogOutfitSlotFromInventorySlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "inventorySlot", Type = "InventorySlots", Nilable = false }, + }, + + Returns = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + }, + { + Name = "GetUISituationCategoriesAndOptions", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "categoryData", Type = "table", InnerType = "TransmogSituationCategory", Nilable = false }, + }, + }, + { + Name = "GetUnassignedAtlasForSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetUnassignedDisplayAtlasForSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "atlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetViewedOutfitSlotInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "type", Type = "TransmogType", Nilable = false }, + { Name = "option", Type = "TransmogOutfitSlotOption", Nilable = false }, + }, + + Returns = + { + { Name = "slotInfo", Type = "ViewedTransmogOutfitSlotInfo", Nilable = false }, + }, + }, + { + Name = "GetWeaponOptionsForSlot", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "weaponOptions", Type = "table", InnerType = "TransmogOutfitWeaponOptionInfo", Nilable = false }, + { Name = "artifactOptions", Type = "table", InnerType = "TransmogOutfitWeaponOptionInfo", Nilable = true }, + }, + }, + { + Name = "HasPendingOutfitSituations", + Type = "Function", + + Returns = + { + { Name = "hasPending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasPendingOutfitTransmogs", + Type = "Function", + + Returns = + { + { Name = "hasPending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InTransmogEvent", + Type = "Function", + + Returns = + { + { Name = "inTransmogEvent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedGearOutfitDisplayed", + Type = "Function", + + Returns = + { + { Name = "isDisplayed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedGearOutfitLocked", + Type = "Function", + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLockedOutfit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSlotWeaponSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "isWeaponSlot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsableDiscountAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsValidTransmogOutfitName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "isApproved", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupOutfit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ResetOutfitSituations", + Type = "Function", + }, + { + Name = "RevertPendingTransmog", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "type", Type = "TransmogType", Nilable = false }, + { Name = "option", Type = "TransmogOutfitSlotOption", Nilable = false }, + }, + }, + { + Name = "SetOutfitSituationsEnabled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetOutfitToCustomSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "transmogCustomSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetOutfitToOutfit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "outfitID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetOutfitToSet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "transmogSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPendingTransmog", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "type", Type = "TransmogType", Nilable = false }, + { Name = "option", Type = "TransmogOutfitSlotOption", Nilable = false }, + { Name = "transmogID", Type = "number", Nilable = false }, + { Name = "displayType", Type = "TransmogOutfitDisplayType", Nilable = false }, + }, + }, + { + Name = "SetSecondarySlotState", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetViewedWeaponOptionForSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "weaponOption", Type = "TransmogOutfitSlotOption", Nilable = false }, + }, + }, + { + Name = "SlotHasSecondary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + }, + + Returns = + { + { Name = "hasSecondary", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogEventActive", + Type = "Function", + + Returns = + { + { Name = "transmogEventActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UpdatePendingSituation", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "option", Type = "TransmogSituationOption", Nilable = false }, + { Name = "value", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "TransmogDisplayedOutfitChanged", + Type = "Event", + LiteralName = "TRANSMOG_DISPLAYED_OUTFIT_CHANGED", + SynchronousEvent = true, + }, + { + Name = "TransmogOutfitsChanged", + Type = "Event", + LiteralName = "TRANSMOG_OUTFITS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "newOutfitID", Type = "number", Nilable = true }, + }, + }, + { + Name = "ViewedTransmogOutfitChanged", + Type = "Event", + LiteralName = "VIEWED_TRANSMOG_OUTFIT_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ViewedTransmogOutfitSecondarySlotsChanged", + Type = "Event", + LiteralName = "VIEWED_TRANSMOG_OUTFIT_SECONDARY_SLOTS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ViewedTransmogOutfitSituationsChanged", + Type = "Event", + LiteralName = "VIEWED_TRANSMOG_OUTFIT_SITUATIONS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ViewedTransmogOutfitSlotRefresh", + Type = "Event", + LiteralName = "VIEWED_TRANSMOG_OUTFIT_SLOT_REFRESH", + UniqueEvent = true, + }, + { + Name = "ViewedTransmogOutfitSlotSaveSuccess", + Type = "Event", + LiteralName = "VIEWED_TRANSMOG_OUTFIT_SLOT_SAVE_SUCCESS", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "type", Type = "TransmogType", Nilable = false }, + { Name = "option", Type = "TransmogOutfitSlotOption", Nilable = false }, + }, + }, + { + Name = "ViewedTransmogOutfitSlotWeaponOptionChanged", + Type = "Event", + LiteralName = "VIEWED_TRANSMOG_OUTFIT_SLOT_WEAPON_OPTION_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "weaponOption", Type = "TransmogOutfitSlotOption", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "TransmogOutfitEntryInfo", + Type = "Structure", + Fields = + { + { Name = "outfitID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "situationCategories", Type = "table", InnerType = "cstring", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "isEventOutfit", Type = "bool", Nilable = false }, + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogOutfitLinkedSlotInfo", + Type = "Structure", + Fields = + { + { Name = "primarySlotInfo", Type = "TransmogOutfitSlotInfo", Nilable = false }, + { Name = "secondarySlotInfo", Type = "TransmogOutfitSlotInfo", Nilable = false }, + }, + }, + { + Name = "TransmogOutfitSlotGroup", + Type = "Structure", + Fields = + { + { Name = "position", Type = "TransmogOutfitSlotPosition", Nilable = false }, + { Name = "appearanceSlotInfo", Type = "table", InnerType = "TransmogOutfitSlotInfo", Nilable = false }, + { Name = "illusionSlotInfo", Type = "table", InnerType = "TransmogOutfitSlotInfo", Nilable = false }, + }, + }, + { + Name = "TransmogOutfitSlotInfo", + Type = "Structure", + Fields = + { + { Name = "slot", Type = "TransmogOutfitSlot", Nilable = false }, + { Name = "type", Type = "TransmogType", Nilable = false }, + { Name = "collectionType", Type = "TransmogCollectionType", Nilable = false }, + { Name = "slotName", Type = "cstring", Nilable = false }, + { Name = "isSecondary", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogOutfitWeaponCollectionInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isWeapon", Type = "bool", Nilable = false }, + { Name = "canHaveIllusions", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogOutfitWeaponOptionInfo", + Type = "Structure", + Fields = + { + { Name = "weaponOption", Type = "TransmogOutfitSlotOption", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TransmogSituationCategory", + Type = "Structure", + Fields = + { + { Name = "triggerID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "isRadioButton", Type = "bool", Nilable = false }, + { Name = "groupData", Type = "table", InnerType = "TransmogSituationGroup", Nilable = false }, + }, + }, + { + Name = "TransmogSituationGroup", + Type = "Structure", + Fields = + { + { Name = "groupID", Type = "number", Nilable = false }, + { Name = "secondaryID", Type = "number", Nilable = false }, + { Name = "optionData", Type = "table", InnerType = "TransmogSituationOptionData", Nilable = false }, + }, + }, + { + Name = "TransmogSituationOption", + Type = "Structure", + Fields = + { + { Name = "situationID", Type = "number", Nilable = false }, + { Name = "specID", Type = "number", Nilable = false }, + { Name = "loadoutID", Type = "number", Nilable = false }, + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TransmogSituationOptionData", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "value", Type = "bool", Nilable = false }, + { Name = "option", Type = "TransmogSituationOption", Nilable = false }, + }, + }, + { + Name = "ViewedTransmogOutfitSlotInfo", + Type = "Structure", + Fields = + { + { Name = "transmogID", Type = "number", Nilable = false }, + { Name = "displayType", Type = "TransmogOutfitDisplayType", Nilable = false }, + { Name = "isTransmogrified", Type = "bool", Nilable = false }, + { Name = "hasPending", Type = "bool", Nilable = false }, + { Name = "isPendingCollected", Type = "bool", Nilable = false }, + { Name = "canTransmogrify", Type = "bool", Nilable = false }, + { Name = "warning", Type = "TransmogOutfitSlotWarning", Nilable = false }, + { Name = "warningText", Type = "cstring", Nilable = false }, + { Name = "error", Type = "TransmogOutfitSlotError", Nilable = false }, + { Name = "errorText", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransmogOutfitInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..211a67b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSetsDocumentation.lua.annotated.lua @@ -0,0 +1,536 @@ +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 = "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 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransmogSets); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..76480a3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TransmogSharedDocumentation.lua.annotated.lua @@ -0,0 +1,139 @@ +local TransmogShared = +{ + Tables = + { + { + Name = "TransmogCollectionType", + Type = "Enumeration", + NumValues = 30, + MinValue = 0, + MaxValue = 29, + Fields = + { + { Name = "None", Type = "TransmogCollectionType", EnumValue = 0 }, + { Name = "Head", Type = "TransmogCollectionType", EnumValue = 1 }, + { Name = "Shoulder", Type = "TransmogCollectionType", EnumValue = 2 }, + { Name = "Back", Type = "TransmogCollectionType", EnumValue = 3 }, + { Name = "Chest", Type = "TransmogCollectionType", EnumValue = 4 }, + { Name = "Shirt", Type = "TransmogCollectionType", EnumValue = 5 }, + { Name = "Tabard", Type = "TransmogCollectionType", EnumValue = 6 }, + { Name = "Wrist", Type = "TransmogCollectionType", EnumValue = 7 }, + { Name = "Hands", Type = "TransmogCollectionType", EnumValue = 8 }, + { Name = "Waist", Type = "TransmogCollectionType", EnumValue = 9 }, + { Name = "Legs", Type = "TransmogCollectionType", EnumValue = 10 }, + { Name = "Feet", Type = "TransmogCollectionType", EnumValue = 11 }, + { Name = "Wand", Type = "TransmogCollectionType", EnumValue = 12 }, + { Name = "OneHAxe", Type = "TransmogCollectionType", EnumValue = 13 }, + { Name = "OneHSword", Type = "TransmogCollectionType", EnumValue = 14 }, + { Name = "OneHMace", Type = "TransmogCollectionType", EnumValue = 15 }, + { Name = "Dagger", Type = "TransmogCollectionType", EnumValue = 16 }, + { Name = "Fist", Type = "TransmogCollectionType", EnumValue = 17 }, + { Name = "Shield", Type = "TransmogCollectionType", EnumValue = 18 }, + { Name = "Holdable", Type = "TransmogCollectionType", EnumValue = 19 }, + { Name = "TwoHAxe", Type = "TransmogCollectionType", EnumValue = 20 }, + { Name = "TwoHSword", Type = "TransmogCollectionType", EnumValue = 21 }, + { Name = "TwoHMace", Type = "TransmogCollectionType", EnumValue = 22 }, + { Name = "Staff", Type = "TransmogCollectionType", EnumValue = 23 }, + { Name = "Polearm", Type = "TransmogCollectionType", EnumValue = 24 }, + { Name = "Bow", Type = "TransmogCollectionType", EnumValue = 25 }, + { Name = "Gun", Type = "TransmogCollectionType", EnumValue = 26 }, + { Name = "Crossbow", Type = "TransmogCollectionType", EnumValue = 27 }, + { Name = "Warglaives", Type = "TransmogCollectionType", EnumValue = 28 }, + { Name = "Paired", Type = "TransmogCollectionType", EnumValue = 29 }, + }, + }, + { + Name = "TransmogIllusionFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 1, + MaxValue = 2, + Fields = + { + { Name = "HideUntilCollected", Type = "TransmogIllusionFlags", EnumValue = 1 }, + { Name = "PlayerConditionGrantsOnLogin", Type = "TransmogIllusionFlags", EnumValue = 2 }, + }, + }, + { + Name = "TransmogModification", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Main", Type = "TransmogModification", EnumValue = 0 }, + { Name = "Secondary", Type = "TransmogModification", EnumValue = 1 }, + }, + }, + { + Name = "TransmogSearchType", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "Items", Type = "TransmogSearchType", EnumValue = 1 }, + { Name = "BaseSets", Type = "TransmogSearchType", EnumValue = 2 }, + { Name = "UsableSets", Type = "TransmogSearchType", EnumValue = 3 }, + }, + }, + { + Name = "TransmogSource", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "None", Type = "TransmogSource", EnumValue = 0 }, + { Name = "JournalEncounter", Type = "TransmogSource", EnumValue = 1 }, + { Name = "Quest", Type = "TransmogSource", EnumValue = 2 }, + { Name = "Vendor", Type = "TransmogSource", EnumValue = 3 }, + { Name = "WorldDrop", Type = "TransmogSource", EnumValue = 4 }, + { Name = "HiddenUntilCollected", Type = "TransmogSource", EnumValue = 5 }, + { Name = "CantCollect", Type = "TransmogSource", EnumValue = 6 }, + { Name = "Achievement", Type = "TransmogSource", EnumValue = 7 }, + { Name = "Profession", Type = "TransmogSource", EnumValue = 8 }, + { Name = "NotValidForTransmog", Type = "TransmogSource", EnumValue = 9 }, + { Name = "TradingPost", Type = "TransmogSource", EnumValue = 10 }, + }, + }, + { + Name = "TransmogType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Appearance", Type = "TransmogType", EnumValue = 0 }, + { Name = "Illusion", Type = "TransmogType", EnumValue = 1 }, + }, + }, + { + Name = "TransmogUseErrorType", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "None", Type = "TransmogUseErrorType", EnumValue = 0 }, + { Name = "PlayerCondition", Type = "TransmogUseErrorType", EnumValue = 1 }, + { Name = "Skill", Type = "TransmogUseErrorType", EnumValue = 2 }, + { Name = "Ability", Type = "TransmogUseErrorType", EnumValue = 3 }, + { Name = "Reputation", Type = "TransmogUseErrorType", EnumValue = 4 }, + { Name = "Holiday", Type = "TransmogUseErrorType", EnumValue = 5 }, + { Name = "HotRecheckFailed", Type = "TransmogUseErrorType", EnumValue = 6 }, + { Name = "Class", Type = "TransmogUseErrorType", EnumValue = 7 }, + { Name = "Race", Type = "TransmogUseErrorType", EnumValue = 8 }, + { Name = "Faction", Type = "TransmogUseErrorType", EnumValue = 9 }, + { Name = "ItemProficiency", Type = "TransmogUseErrorType", EnumValue = 10 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TransmogShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua.annotated.lua new file mode 100644 index 0000000..65e2bee --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/TutorialDocumentation.lua.annotated.lua @@ -0,0 +1,142 @@ +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 = 47, + MinValue = 1, + MaxValue = 47, + 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 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Tutorial); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7cc5506 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local UIActionConstants = +{ + Tables = + { + { + Name = "UIActionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "DefaultAction", Type = "UIActionType", EnumValue = 0 }, + { Name = "UpdateMapSystem", Type = "UIActionType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIActionConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d4c1818 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIActionDocumentation.lua.annotated.lua @@ -0,0 +1,31 @@ +local UIAction = +{ + Name = "UIActionHandlerSystem", + Type = "System", + Namespace = "C_UIActionHandler", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "HandleUIAction", + Type = "Event", + LiteralName = "HANDLE_UI_ACTION", + UniqueEvent = true, + Payload = + { + { Name = "actionType", Type = "UIActionType", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UIAction); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7c5205d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIButtonSharedDocumentation.lua.annotated.lua @@ -0,0 +1,20 @@ +local UIButtonShared = +{ + Tables = + { + { + Name = "UIButtonInfo", + Type = "Structure", + Fields = + { + { Name = "normal", Type = "textureAtlas", Nilable = false }, + { Name = "pressed", Type = "textureAtlas", Nilable = false }, + { Name = "highlight", Type = "textureAtlas", Nilable = false }, + { Name = "icon", Type = "textureAtlas", Nilable = false }, + { Name = "useNormalAsHiglight", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIButtonShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICharacterClassConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICharacterClassConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9949635 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICharacterClassConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,28 @@ +local UICharacterClassConstants = +{ + Tables = + { + { + Name = "UICharacterClasses", + Type = "Constants", + Values = + { + { Name = "Warrior", Type = "number", Value = 0 }, + { Name = "Paladin", Type = "number", Value = 0 }, + { Name = "Hunter", Type = "number", Value = 0 }, + { Name = "Rogue", Type = "number", Value = 0 }, + { Name = "Priest", Type = "number", Value = 0 }, + { Name = "DeathKnight", Type = "number", Value = 0 }, + { Name = "Shaman", Type = "number", Value = 0 }, + { Name = "Mage", Type = "number", Value = 0 }, + { Name = "Warlock", Type = "number", Value = 0 }, + { Name = "Monk", Type = "number", Value = 0 }, + { Name = "Druid", Type = "number", Value = 0 }, + { Name = "DemonHunter", Type = "number", Value = 0 }, + { Name = "Evoker", Type = "number", Value = 0 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UICharacterClassConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua.annotated.lua new file mode 100644 index 0000000..15c09eb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorDocumentation.lua.annotated.lua @@ -0,0 +1,30 @@ +local UIColor = +{ + Name = "UIColor", + Type = "System", + Namespace = "C_UIColor", + Environment = "All", + + Functions = + { + { + Name = "GetColors", + Type = "Function", + + Returns = + { + { Name = "colors", Type = "table", InnerType = "DBColorExport", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UIColor); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2fc21d5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIColorSharedDocumentation.lua.annotated.lua @@ -0,0 +1,17 @@ +local UIColorShared = +{ + Tables = + { + { + Name = "DBColorExport", + Type = "Structure", + Fields = + { + { Name = "baseTag", Type = "cstring", Nilable = false }, + { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIColorShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICovenantDisplayInfoConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICovenantDisplayInfoConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5756303 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UICovenantDisplayInfoConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local UICovenantDisplayInfoConstants = +{ + Tables = + { + { + Name = "UICovenantDisplayInfoFlags", + Type = "Enumeration", + NumValues = 3, + MinValue = 1, + MaxValue = 3, + Fields = + { + { Name = "DisplayCovenantAsJourney", Type = "UICovenantDisplayInfoFlags", EnumValue = 1 }, + { Name = "UseJourneyRewardTrack", Type = "UICovenantDisplayInfoFlags", EnumValue = 2 }, + { Name = "UseJourneyUnlockToastText", Type = "UICovenantDisplayInfoFlags", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UICovenantDisplayInfoConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d58d3f8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,82 @@ +local UIEventToastConstants = +{ + Tables = + { + { + Name = "EventToastDisplayType", + Type = "Enumeration", + NumValues = 16, + MinValue = 0, + MaxValue = 15, + Fields = + { + { Name = "NormalSingleLine", Type = "EventToastDisplayType", EnumValue = 0 }, + { Name = "NormalBlockText", Type = "EventToastDisplayType", EnumValue = 1 }, + { Name = "NormalTitleAndSubTitle", Type = "EventToastDisplayType", EnumValue = 2 }, + { Name = "NormalTextWithIcon", Type = "EventToastDisplayType", EnumValue = 3 }, + { Name = "LargeTextWithIcon", Type = "EventToastDisplayType", EnumValue = 4 }, + { Name = "NormalTextWithIconAndRarity", Type = "EventToastDisplayType", EnumValue = 5 }, + { Name = "Scenario", Type = "EventToastDisplayType", EnumValue = 6 }, + { Name = "ChallengeMode", Type = "EventToastDisplayType", EnumValue = 7 }, + { Name = "ScenarioClickExpand", Type = "EventToastDisplayType", EnumValue = 8 }, + { Name = "WeeklyRewardUnlock", Type = "EventToastDisplayType", EnumValue = 9 }, + { Name = "WeeklyRewardUpgrade", Type = "EventToastDisplayType", EnumValue = 10 }, + { Name = "FlightpointDiscovered", Type = "EventToastDisplayType", EnumValue = 11 }, + { Name = "CapstoneUnlocked", Type = "EventToastDisplayType", EnumValue = 12 }, + { Name = "SingleLineWithIcon", Type = "EventToastDisplayType", EnumValue = 13 }, + { Name = "Scoreboard", Type = "EventToastDisplayType", EnumValue = 14 }, + { Name = "HouseUpgradeAvailable", Type = "EventToastDisplayType", EnumValue = 15 }, + }, + }, + { + Name = "EventToastEventType", + Type = "Enumeration", + NumValues = 27, + MinValue = 0, + MaxValue = 26, + Fields = + { + { Name = "LevelUp", Type = "EventToastEventType", EnumValue = 0 }, + { Name = "LevelUpSpell", Type = "EventToastEventType", EnumValue = 1 }, + { Name = "LevelUpDungeon", Type = "EventToastEventType", EnumValue = 2 }, + { Name = "LevelUpRaid", Type = "EventToastEventType", EnumValue = 3 }, + { Name = "LevelUpPvP", Type = "EventToastEventType", EnumValue = 4 }, + { Name = "PetBattleNewAbility", Type = "EventToastEventType", EnumValue = 5 }, + { Name = "PetBattleFinalRound", Type = "EventToastEventType", EnumValue = 6 }, + { Name = "PetBattleCapture", Type = "EventToastEventType", EnumValue = 7 }, + { Name = "BattlePetLevelChanged", Type = "EventToastEventType", EnumValue = 8 }, + { Name = "BattlePetLevelUpAbility", Type = "EventToastEventType", EnumValue = 9 }, + { Name = "QuestBossEmote", Type = "EventToastEventType", EnumValue = 10 }, + { Name = "MythicPlusWeeklyRecord", Type = "EventToastEventType", EnumValue = 11 }, + { Name = "QuestTurnedIn", Type = "EventToastEventType", EnumValue = 12 }, + { Name = "WorldStateChange", Type = "EventToastEventType", EnumValue = 13 }, + { Name = "Scenario", Type = "EventToastEventType", EnumValue = 14 }, + { Name = "LevelUpOther", Type = "EventToastEventType", EnumValue = 15 }, + { Name = "PlayerAuraAdded", Type = "EventToastEventType", EnumValue = 16 }, + { Name = "PlayerAuraRemoved", Type = "EventToastEventType", EnumValue = 17 }, + { Name = "SpellScript", Type = "EventToastEventType", EnumValue = 18 }, + { Name = "CriteriaUpdated", Type = "EventToastEventType", EnumValue = 19 }, + { Name = "PvPTierUpdate", Type = "EventToastEventType", EnumValue = 20 }, + { Name = "SpellLearned", Type = "EventToastEventType", EnumValue = 21 }, + { Name = "TreasureItem", Type = "EventToastEventType", EnumValue = 22 }, + { Name = "WeeklyRewardUnlock", Type = "EventToastEventType", EnumValue = 23 }, + { Name = "WeeklyRewardUpgrade", Type = "EventToastEventType", EnumValue = 24 }, + { Name = "FlightpointDiscovered", Type = "EventToastEventType", EnumValue = 25 }, + { Name = "HouseUpgradeAvailable", Type = "EventToastEventType", EnumValue = 26 }, + }, + }, + { + Name = "EventToastFlags", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "DisableRightClickDismiss", Type = "EventToastFlags", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIEventToastConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7da2dcf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIEventToastManagerDocumentation.lua.annotated.lua @@ -0,0 +1,99 @@ +local UIEventToastManager = +{ + Name = "UIEventToastManagerInfo", + Type = "System", + Namespace = "C_EventToastManager", + Environment = "All", + + Functions = + { + { + Name = "GetLevelUpDisplayToastsFromLevel", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "toastInfo", Type = "table", InnerType = "EventToastInfo", Nilable = false }, + }, + }, + { + Name = "GetNextToastToDisplay", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "toastInfo", Type = "EventToastInfo", Nilable = false }, + }, + }, + { + Name = "RemoveCurrentToast", + Type = "Function", + }, + }, + + Events = + { + { + Name = "DisplayEventToastLink", + Type = "Event", + LiteralName = "DISPLAY_EVENT_TOAST_LINK", + SynchronousEvent = true, + Payload = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "DisplayEventToasts", + Type = "Event", + LiteralName = "DISPLAY_EVENT_TOASTS", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "EventToastInfo", + Type = "Structure", + Fields = + { + { Name = "eventToastID", Type = "number", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "subtitle", Type = "string", Nilable = false }, + { Name = "instructionText", Type = "string", Nilable = false }, + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "subIcon", Type = "textureAtlas", Nilable = true }, + { Name = "link", Type = "string", Nilable = false }, + { Name = "qualityString", Type = "string", Nilable = true }, + { Name = "quality", Type = "number", Nilable = true }, + { Name = "eventType", Type = "EventToastEventType", Nilable = false }, + { Name = "displayType", Type = "EventToastDisplayType", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "sortOrder", Type = "number", Nilable = false }, + { Name = "time", Type = "number", Nilable = true }, + { Name = "uiWidgetSetID", Type = "number", Nilable = true }, + { Name = "extraUiWidgetSetID", Type = "number", Nilable = true }, + { Name = "titleTooltip", Type = "string", Nilable = true }, + { Name = "subtitleTooltip", Type = "string", Nilable = true }, + { Name = "titleTooltipUiWidgetSetID", Type = "number", Nilable = true }, + { Name = "subtitleTooltipUiWidgetSetID", Type = "number", Nilable = true }, + { Name = "hideDefaultAtlas", Type = "bool", Nilable = true }, + { Name = "showSoundKitID", Type = "number", Nilable = true }, + { Name = "hideSoundKitID", Type = "number", Nilable = true }, + { Name = "colorTint", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + { Name = "flags", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIEventToastManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFileAssetSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFileAssetSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2fc16f6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFileAssetSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local UIFileAssetShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UIFileAssetShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..5555ea3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIFrameManagerDocumentation.lua.annotated.lua @@ -0,0 +1,65 @@ +local UIFrameManager = +{ + Name = "UIFrameManager", + Type = "System", + Namespace = "C_FrameManager", + Environment = "All", + + Functions = + { + { + Name = "GetFrameVisibilityState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "frameType", Type = "UIFrameType", Nilable = false }, + }, + + Returns = + { + { Name = "shouldShow", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "FrameManagerUpdateAll", + Type = "Event", + LiteralName = "FRAME_MANAGER_UPDATE_ALL", + SynchronousEvent = true, + }, + { + Name = "FrameManagerUpdateFrame", + Type = "Event", + LiteralName = "FRAME_MANAGER_UPDATE_FRAME", + SynchronousEvent = true, + Payload = + { + { Name = "type", Type = "UIFrameType", Nilable = false }, + { Name = "show", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "UIFrameType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "JailersTowerBuffs", Type = "UIFrameType", EnumValue = 0 }, + { Name = "InterruptTutorial", Type = "UIFrameType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIFrameManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bb93fac --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIGenericWidgetDisplayDocumentation.lua.annotated.lua @@ -0,0 +1,53 @@ +local UIGenericWidgetDisplay = +{ + Name = "GenericWidgetDisplay", + Type = "System", + Namespace = "C_GenericWidgetDisplay", + Environment = "All", + + Functions = + { + { + Name = "Acknowledge", + Type = "Function", + }, + { + Name = "Close", + Type = "Function", + }, + }, + + Events = + { + { + Name = "GenericWidgetDisplayShow", + Type = "Event", + LiteralName = "GENERIC_WIDGET_DISPLAY_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "info", Type = "GenericWidgetDisplayFrameInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "GenericWidgetDisplayFrameInfo", + Type = "Structure", + Fields = + { + { Name = "uiWidgetSetID", Type = "number", Nilable = true }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = true }, + { Name = "title", Type = "string", Nilable = true }, + { Name = "frameWidth", Type = "number", Nilable = false }, + { Name = "frameHeight", Type = "number", Nilable = false }, + { Name = "extraButtonText", Type = "string", Nilable = true }, + { Name = "closeButtonText", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIGenericWidgetDisplay); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8230f3c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMacrosDocumentation.lua.annotated.lua @@ -0,0 +1,89 @@ +local UIMacros = +{ + Name = "UIMacros", + Type = "System", + Namespace = "C_Macro", + Environment = "All", + + Functions = + { + { + Name = "GetMacroName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "macroId", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetSelectedMacroIcon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "macroId", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "textureNum", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "RunMacroText", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "button", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "SetMacroExecuteLineCallback", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "cb", Type = "MacroExecuteLineCallback", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "UpdateMacros", + Type = "Event", + LiteralName = "UPDATE_MACROS", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "MacroExecuteLineCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "macroLine", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIMacros); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..319b96c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIManagerDocumentation.lua.annotated.lua @@ -0,0 +1,101 @@ +local UIManager = +{ + Name = "UI", + Type = "System", + Namespace = "C_UI", + Environment = "All", + + Functions = + { + { + Name = "DoesAnyDisplayHaveNotch", + Type = "Function", + Documentation = { "True if any display attached has a notch. This does not mean the current view intersects the notch." }, + + Returns = + { + { Name = "notchPresent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTopLeftNotchSafeRegion", + Type = "Function", + Documentation = { "Region of screen left of screen notch. Zeros if no notch." }, + + Returns = + { + { Name = "left", Type = "number", Nilable = false }, + { Name = "right", Type = "number", Nilable = false }, + { Name = "top", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTopRightNotchSafeRegion", + Type = "Function", + Documentation = { "Region of screen right of screen notch. Zeros if no notch." }, + + Returns = + { + { Name = "left", Type = "number", Nilable = false }, + { Name = "right", Type = "number", Nilable = false }, + { Name = "top", Type = "number", Nilable = false }, + { Name = "bottom", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUIParent", + Type = "Function", + + Returns = + { + { Name = "uiParent", Type = "SimpleFrame", Nilable = false }, + }, + }, + { + Name = "GetWorldFrame", + Type = "Function", + + Returns = + { + { Name = "worldFrame", Type = "SimpleFrame", Nilable = false }, + }, + }, + { + Name = "Reload", + Type = "Function", + }, + { + Name = "ShouldUIParentAvoidNotch", + Type = "Function", + Documentation = { "UIParent will shift down to avoid notch if true. This does not mean there is a notch." }, + + Returns = + { + { Name = "willAvoidNotch", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "NotchedDisplayModeChanged", + Type = "Event", + LiteralName = "NOTCHED_DISPLAY_MODE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "UiScaleChanged", + Type = "Event", + LiteralName = "UI_SCALE_CHANGED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UIManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..a477bf0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIMapPinSharedDocumentation.lua.annotated.lua @@ -0,0 +1,19 @@ +local UIMapPinShared = +{ + Tables = + { + { + Name = "UIMapPinInfo", + Type = "Structure", + Fields = + { + { Name = "button", Type = "UIButtonInfo", Nilable = false }, + { Name = "buttonSelected", Type = "UIButtonInfo", Nilable = false }, + { Name = "underlay", Type = "textureAtlas", Nilable = false }, + { Name = "outerGlow", Type = "textureAtlas", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIMapPinShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..c3ba825 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoDocumentation.lua.annotated.lua @@ -0,0 +1,194 @@ +local UIModelInfo = +{ + Name = "ModelInfo", + Type = "System", + Namespace = "C_ModelInfo", + Environment = "All", + + Functions = + { + { + Name = "AddActiveModelScene", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "This function does nothing in public clients" }, + + Arguments = + { + { Name = "modelSceneFrame", Type = "ModelSceneFrame", Nilable = false }, + { Name = "modelSceneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AddActiveModelSceneActor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "This function does nothing in public clients" }, + + Arguments = + { + { Name = "modelSceneFrameActor", Type = "ModelSceneFrameActor", Nilable = false }, + { Name = "modelSceneActorID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClearActiveModelScene", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "This function does nothing in public clients" }, + + Arguments = + { + { Name = "modelSceneFrame", Type = "ModelSceneFrame", Nilable = false }, + }, + }, + { + Name = "ClearActiveModelSceneActor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "This function does nothing in public clients" }, + + Arguments = + { + { Name = "modelSceneFrameActor", Type = "ModelSceneFrameActor", Nilable = false }, + }, + }, + { + Name = "GetModelSceneActorDisplayInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "modelActorDisplayID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "actorDisplayInfo", Type = "UIModelSceneActorDisplayInfo", Nilable = false }, + }, + }, + { + Name = "GetModelSceneActorInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "modelActorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "actorInfo", Type = "UIModelSceneActorInfo", Nilable = false }, + }, + }, + { + Name = "GetModelSceneCameraInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "modelSceneCameraID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "modelSceneCameraInfo", Type = "UIModelSceneCameraInfo", Nilable = false }, + }, + }, + { + Name = "GetModelSceneInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "modelSceneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "modelSceneType", Type = "ModelSceneType", Nilable = false }, + { Name = "modelCameraIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "modelActorsIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "UiModelSceneInfoUpdated", + Type = "Event", + LiteralName = "UI_MODEL_SCENE_INFO_UPDATED", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "UIModelSceneActorDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "animation", Type = "number", Nilable = false }, + { Name = "animationVariation", Type = "number", Nilable = false }, + { Name = "animSpeed", Type = "number", Nilable = false }, + { Name = "animationKitID", Type = "number", Nilable = true }, + { Name = "spellVisualKitID", Type = "number", Nilable = true }, + { Name = "alpha", Type = "number", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "UIModelSceneActorInfo", + Type = "Structure", + Fields = + { + { Name = "modelActorID", Type = "number", Nilable = false }, + { Name = "scriptTag", Type = "cstring", Nilable = false }, + { Name = "position", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + { Name = "yaw", Type = "number", Nilable = false }, + { Name = "pitch", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + { Name = "normalizeScaleAggressiveness", Type = "number", Nilable = true }, + { Name = "useCenterForOriginX", Type = "bool", Nilable = false }, + { Name = "useCenterForOriginY", Type = "bool", Nilable = false }, + { Name = "useCenterForOriginZ", Type = "bool", Nilable = false }, + { Name = "modelActorDisplayID", Type = "number", Nilable = true }, + }, + }, + { + Name = "UIModelSceneCameraInfo", + Type = "Structure", + Fields = + { + { Name = "modelSceneCameraID", Type = "number", Nilable = false }, + { Name = "scriptTag", Type = "cstring", Nilable = false }, + { Name = "cameraType", Type = "cstring", Nilable = false }, + { Name = "target", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + { Name = "yaw", Type = "number", Nilable = false }, + { Name = "pitch", Type = "number", Nilable = false }, + { Name = "roll", Type = "number", Nilable = false }, + { Name = "zoomDistance", Type = "number", Nilable = false }, + { Name = "minZoomDistance", Type = "number", Nilable = false }, + { Name = "maxZoomDistance", Type = "number", Nilable = false }, + { Name = "zoomedTargetOffset", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + { Name = "zoomedYawOffset", Type = "number", Nilable = false }, + { Name = "zoomedPitchOffset", Type = "number", Nilable = false }, + { Name = "zoomedRollOffset", Type = "number", Nilable = false }, + { Name = "flags", Type = "ModelSceneSetting", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIModelInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2450508 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModelInfoSharedDocumentation.lua.annotated.lua @@ -0,0 +1,77 @@ +local UIModelInfoShared = +{ + Tables = + { + { + Name = "ItemTryOnReason", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Success", Type = "ItemTryOnReason", EnumValue = 0 }, + { Name = "WrongRace", Type = "ItemTryOnReason", EnumValue = 1 }, + { Name = "NotEquippable", Type = "ItemTryOnReason", EnumValue = 2 }, + { Name = "DataPending", Type = "ItemTryOnReason", EnumValue = 3 }, + }, + }, + { + Name = "ModelSceneSetting", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "AlignLightToOrbitDelta", Type = "ModelSceneSetting", EnumValue = 1 }, + }, + }, + { + Name = "ModelSceneType", + Type = "Enumeration", + NumValues = 20, + MinValue = 0, + MaxValue = 19, + Fields = + { + { Name = "MountJournal", Type = "ModelSceneType", EnumValue = 0 }, + { Name = "PetJournalCard", Type = "ModelSceneType", EnumValue = 1 }, + { Name = "ShopCard", Type = "ModelSceneType", EnumValue = 2 }, + { Name = "EncounterJournal", Type = "ModelSceneType", EnumValue = 3 }, + { Name = "PetJournalLoadout", Type = "ModelSceneType", EnumValue = 4 }, + { Name = "ArtifactTier2", Type = "ModelSceneType", EnumValue = 5 }, + { Name = "ArtifactTier2ForgingScene", Type = "ModelSceneType", EnumValue = 6 }, + { Name = "ArtifactTier2SlamEffect", Type = "ModelSceneType", EnumValue = 7 }, + { Name = "CommentatorVictoryFanfare", Type = "ModelSceneType", EnumValue = 8 }, + { Name = "ArtifactRelicTalentEffect", Type = "ModelSceneType", EnumValue = 9 }, + { Name = "PvPWarModeOrb", Type = "ModelSceneType", EnumValue = 10 }, + { Name = "PvPWarModeFire", Type = "ModelSceneType", EnumValue = 11 }, + { Name = "PartyPose", Type = "ModelSceneType", EnumValue = 12 }, + { Name = "AzeriteItemLevelUpToast", Type = "ModelSceneType", EnumValue = 13 }, + { Name = "AzeritePowers", Type = "ModelSceneType", EnumValue = 14 }, + { Name = "AzeriteRewardGlow", Type = "ModelSceneType", EnumValue = 15 }, + { Name = "HeartOfAzeroth", Type = "ModelSceneType", EnumValue = 16 }, + { Name = "WorldMapThreat", Type = "ModelSceneType", EnumValue = 17 }, + { Name = "Soulbinds", Type = "ModelSceneType", EnumValue = 18 }, + { Name = "JailersTowerAnimaGlow", Type = "ModelSceneType", EnumValue = 19 }, + }, + }, + { + Name = "UIModelSceneActorFlag", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "Deprecated1", Type = "UIModelSceneActorFlag", EnumValue = 1 }, + { Name = "UseCenterForOriginX", Type = "UIModelSceneActorFlag", EnumValue = 2 }, + { Name = "UseCenterForOriginY", Type = "UIModelSceneActorFlag", EnumValue = 4 }, + { Name = "UseCenterForOriginZ", Type = "UIModelSceneActorFlag", EnumValue = 8 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIModelInfoShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua.annotated.lua new file mode 100644 index 0000000..100f88e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIModifiedInstanceDocumentation.lua.annotated.lua @@ -0,0 +1,50 @@ +local UIModifiedInstance = +{ + Name = "UIModifiedInstance", + Type = "System", + Namespace = "C_ModifiedInstance", + Environment = "All", + + Functions = + { + { + Name = "GetModifiedInstanceInfoFromMapID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ModifiedInstanceInfo", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "ModifiedInstanceInfo", + Type = "Structure", + Fields = + { + { Name = "lfrItemLevel", Type = "number", Nilable = true }, + { Name = "normalItemLevel", Type = "number", Nilable = true }, + { Name = "heroicItemLevel", Type = "number", Nilable = true }, + { Name = "mythicItemLevel", Type = "number", Nilable = true }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIModifiedInstance); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..8f89023 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISharedDocumentation.lua.annotated.lua @@ -0,0 +1,43 @@ +local UIShared = +{ + Tables = + { + { + Name = "FontStringScaleAnimationMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "FontSize", Type = "FontStringScaleAnimationMode", EnumValue = 0, Documentation = { "Scale animations apply to the height of the font. This will cause small jumps between different font heights as the animation progresses, and may adjust the layout of text if used on a fixed-size font string." } }, + { Name = "Vertex", Type = "FontStringScaleAnimationMode", EnumValue = 1, Documentation = { "Scale animations apply to the vertices of the font. Scaling is smoother, but if used on non-slug fonts may cause significant pixelation of the font text, Layout of the text is not adjusted as the animation progresses, and the direction of scaling respects horizontal and vertical justification settings (eg. text at the bottom-right scaling up grows toward the top-left)." } }, + }, + }, + { + Name = "AnchorBinding", + Type = "Structure", + Fields = + { + { Name = "point", Type = "FramePoint", Nilable = false }, + { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, + { Name = "relativePoint", Type = "FramePoint", Nilable = false }, + { Name = "offsetX", Type = "uiUnit", Nilable = false }, + { Name = "offsetY", Type = "uiUnit", Nilable = false }, + }, + }, + { + Name = "uiBoundsRect", + Type = "Structure", + Fields = + { + { Name = "left", Type = "uiUnit", Nilable = false }, + { Name = "bottom", Type = "uiUnit", Nilable = false }, + { Name = "width", Type = "uiUnit", Nilable = false }, + { Name = "height", Type = "uiUnit", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..66c7bd6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UISystemVisibilityManagerDocumentation.lua.annotated.lua @@ -0,0 +1,53 @@ +local UISystemVisibilityManager = +{ + Name = "UISystemVisibilityManager", + Type = "System", + Namespace = "C_SystemVisibilityManager", + Environment = "All", + + Functions = + { + { + Name = "IsSystemVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "system", Type = "UISystemType", Nilable = false }, + }, + + Returns = + { + { Name = "visible", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SystemVisibilityChanged", + Type = "Event", + LiteralName = "SYSTEM_VISIBILITY_CHANGED", + UniqueEvent = true, + }, + }, + + Tables = + { + { + Name = "UISystemType", + Type = "Enumeration", + NumValues = 1, + MinValue = 0, + MaxValue = 0, + Fields = + { + { Name = "InGameNavigation", Type = "UISystemType", EnumValue = 0 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UISystemVisibilityManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureAssetSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureAssetSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..70e36d9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureAssetSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local UITextureAssetShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UITextureAssetShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..cf84bc3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITextureConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,32 @@ +local UITextureConstants = +{ + Tables = + { + { + Name = "UITextureSliceMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Stretched", Type = "UITextureSliceMode", EnumValue = 0 }, + { Name = "Tiled", Type = "UITextureSliceMode", EnumValue = 1 }, + }, + }, + { + Name = "UITextureSliceData", + Type = "Structure", + Fields = + { + { Name = "marginLeft", Type = "number", Nilable = false }, + { Name = "marginTop", Type = "number", Nilable = false }, + { Name = "marginRight", Type = "number", Nilable = false }, + { Name = "marginBottom", Type = "number", Nilable = false }, + { Name = "sliceMode", Type = "UITextureSliceMode", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UITextureConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2f06207 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UITimerDocumentation.lua.annotated.lua @@ -0,0 +1,78 @@ +local UITimer = +{ + Name = "UITimer", + Type = "System", + Namespace = "C_Timer", + Environment = "All", + + Functions = + { + { + Name = "After", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + { Name = "callback", Type = "TimerCallback", Nilable = false }, + }, + }, + { + Name = "NewTicker", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + { Name = "callback", Type = "TickerCallback", Nilable = false }, + { Name = "iterations", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "cbObject", Type = "TickerCallback", Nilable = false }, + }, + }, + { + Name = "NewTimer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + { Name = "callback", Type = "TickerCallback", Nilable = false }, + }, + + Returns = + { + { Name = "cbObject", Type = "TickerCallback", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "TickerCallback", + Type = "CallbackType", + + Arguments = + { + { Name = "cb", Type = "TimerCallback", Nilable = false }, + }, + }, + { + Name = "TimerCallback", + Type = "CallbackType", + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UITimer); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ee5e277 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerDocumentation.lua.annotated.lua @@ -0,0 +1,2254 @@ +local UIWidgetManager = +{ + Name = "UIWidgetManager", + Type = "System", + Namespace = "C_UIWidgetManager", + Environment = "All", + + Functions = + { + { + Name = "GetAllWidgetsBySetID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgets", Type = "table", InnerType = "UIWidgetInfo", Nilable = false }, + }, + }, + { + Name = "GetBelowMinimapWidgetSetID", + Type = "Function", + + Returns = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBulletTextListWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "BulletTextListWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetButtonHeaderWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "ButtonHeaderWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetCaptureBarWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "CaptureBarWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetCaptureZoneVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "CaptureZoneVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetDiscreteProgressStepsVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "DiscreteProgressStepsVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetDoubleIconAndTextWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "DoubleIconAndTextWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetDoubleStateIconRowVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "DoubleStateIconRowVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetDoubleStatusBarWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "DoubleStatusBarWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetFillUpFramesWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "FillUpFramesWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetHorizontalCurrenciesWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "HorizontalCurrenciesWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetIconAndTextWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "IconAndTextWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetIconTextAndBackgroundWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "IconTextAndBackgroundWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetIconTextAndCurrenciesWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "IconTextAndCurrenciesWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetItemDisplayVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "ItemDisplayVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetMapPinAnimationWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "MapPinAnimationWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetObjectiveTrackerWidgetSetID", + Type = "Function", + + Returns = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerBarWidgetSetID", + Type = "Function", + + Returns = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPreyHuntProgressWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "PreyHuntProgressWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetScenarioHeaderDelvesWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "ScenarioHeaderDelvesWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetScenarioHeaderTimerWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "ScenarioHeaderTimerWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetSpacerVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "SpacerVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetSpellDisplayVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "SpellDisplayVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetStackedResourceTrackerWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "StackedResourceTrackerWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetStatusBarWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "StatusBarWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTextColumnRowVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TextColumnRowVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTextWithStateWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TextWithStateWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTextWithSubtextWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TextWithSubtextWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTextureAndTextRowVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TextureAndTextRowVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTextureAndTextVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TextureAndTextVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTextureWithAnimationVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TextureWithAnimationVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetTopCenterWidgetSetID", + Type = "Function", + + Returns = + { + { Name = "setID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTugOfWarWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "TugOfWarWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetUnitPowerBarWidgetVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "UnitPowerBarWidgetVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "GetWidgetSetInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetSetInfo", Type = "UIWidgetSetInfo", Nilable = false }, + }, + }, + { + Name = "GetZoneControlVisualizationInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "widgetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "widgetInfo", Type = "ZoneControlVisualizationInfo", Nilable = true }, + }, + }, + { + Name = "RegisterUnitForWidgetUpdates", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "string", Nilable = false }, + { Name = "isGuid", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetProcessingUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + }, + { + Name = "SetProcessingUnitGuid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "UnregisterUnitForWidgetUpdates", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "string", Nilable = false }, + { Name = "isGuid", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, + + Events = + { + { + Name = "UpdateAllUiWidgets", + Type = "Event", + LiteralName = "UPDATE_ALL_UI_WIDGETS", + SynchronousEvent = true, + }, + { + Name = "UpdateUiWidget", + Type = "Event", + LiteralName = "UPDATE_UI_WIDGET", + SynchronousEvent = true, + Payload = + { + { Name = "widgetInfo", Type = "UIWidgetInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "CaptureBarWidgetFillDirectionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "RightToLeft", Type = "CaptureBarWidgetFillDirectionType", EnumValue = 0 }, + { Name = "LeftToRight", Type = "CaptureBarWidgetFillDirectionType", EnumValue = 1 }, + }, + }, + { + Name = "IconAndTextShiftTextType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "IconAndTextShiftTextType", EnumValue = 0 }, + { Name = "ShiftText", Type = "IconAndTextShiftTextType", EnumValue = 1 }, + }, + }, + { + Name = "IconAndTextWidgetState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Hidden", Type = "IconAndTextWidgetState", EnumValue = 0 }, + { Name = "Shown", Type = "IconAndTextWidgetState", EnumValue = 1 }, + { Name = "ShownWithDynamicIconFlashing", Type = "IconAndTextWidgetState", EnumValue = 2 }, + { Name = "ShownWithDynamicIconNotFlashing", Type = "IconAndTextWidgetState", EnumValue = 3 }, + }, + }, + { + Name = "IconState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Hidden", Type = "IconState", EnumValue = 0 }, + { Name = "ShowState1", Type = "IconState", EnumValue = 1 }, + { Name = "ShowState2", Type = "IconState", EnumValue = 2 }, + }, + }, + { + Name = "ItemDisplayTextDisplayStyle", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "WorldQuestReward", Type = "ItemDisplayTextDisplayStyle", EnumValue = 0 }, + { Name = "ItemNameAndInfoText", Type = "ItemDisplayTextDisplayStyle", EnumValue = 1 }, + { Name = "ItemNameOnlyCentered", Type = "ItemDisplayTextDisplayStyle", EnumValue = 2 }, + { Name = "PlayerChoiceReward", Type = "ItemDisplayTextDisplayStyle", EnumValue = 3 }, + }, + }, + { + Name = "ItemDisplayTooltipEnabledType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Enabled", Type = "ItemDisplayTooltipEnabledType", EnumValue = 0 }, + { Name = "Disabled", Type = "ItemDisplayTooltipEnabledType", EnumValue = 1 }, + }, + }, + { + Name = "MapPinAnimationType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "MapPinAnimationType", EnumValue = 0 }, + { Name = "Pulse", Type = "MapPinAnimationType", EnumValue = 1 }, + }, + }, + { + Name = "PreyHuntProgressState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Cold", Type = "PreyHuntProgressState", EnumValue = 0 }, + { Name = "Warm", Type = "PreyHuntProgressState", EnumValue = 1 }, + { Name = "Hot", Type = "PreyHuntProgressState", EnumValue = 2 }, + { Name = "Final", Type = "PreyHuntProgressState", EnumValue = 3 }, + }, + }, + { + Name = "SpellDisplayIconDisplayType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Buff", Type = "SpellDisplayIconDisplayType", EnumValue = 0 }, + { Name = "Debuff", Type = "SpellDisplayIconDisplayType", EnumValue = 1 }, + { Name = "Circular", Type = "SpellDisplayIconDisplayType", EnumValue = 2 }, + { Name = "NoBorder", Type = "SpellDisplayIconDisplayType", EnumValue = 3 }, + }, + }, + { + Name = "SpellDisplayTextShownStateType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Shown", Type = "SpellDisplayTextShownStateType", EnumValue = 0 }, + { Name = "Hidden", Type = "SpellDisplayTextShownStateType", EnumValue = 1 }, + }, + }, + { + Name = "SpellDisplayTint", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "SpellDisplayTint", EnumValue = 0 }, + { Name = "Red", Type = "SpellDisplayTint", EnumValue = 1 }, + }, + }, + { + Name = "StatusBarColorTintValue", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "StatusBarColorTintValue", EnumValue = 0 }, + { Name = "Black", Type = "StatusBarColorTintValue", EnumValue = 1 }, + { Name = "White", Type = "StatusBarColorTintValue", EnumValue = 2 }, + { Name = "Red", Type = "StatusBarColorTintValue", EnumValue = 3 }, + { Name = "Yellow", Type = "StatusBarColorTintValue", EnumValue = 4 }, + { Name = "Orange", Type = "StatusBarColorTintValue", EnumValue = 5 }, + { Name = "Purple", Type = "StatusBarColorTintValue", EnumValue = 6 }, + { Name = "Green", Type = "StatusBarColorTintValue", EnumValue = 7 }, + { Name = "Blue", Type = "StatusBarColorTintValue", EnumValue = 8 }, + }, + }, + { + Name = "StatusBarOverrideBarTextShownType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Never", Type = "StatusBarOverrideBarTextShownType", EnumValue = 0 }, + { Name = "Always", Type = "StatusBarOverrideBarTextShownType", EnumValue = 1 }, + { Name = "OnlyOnMouseover", Type = "StatusBarOverrideBarTextShownType", EnumValue = 2 }, + { Name = "OnlyNotOnMouseover", Type = "StatusBarOverrideBarTextShownType", EnumValue = 3 }, + }, + }, + { + Name = "StatusBarValueTextType", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Hidden", Type = "StatusBarValueTextType", EnumValue = 0 }, + { Name = "Percentage", Type = "StatusBarValueTextType", EnumValue = 1 }, + { Name = "Value", Type = "StatusBarValueTextType", EnumValue = 2 }, + { Name = "Time", Type = "StatusBarValueTextType", EnumValue = 3 }, + { Name = "TimeShowOneLevelOnly", Type = "StatusBarValueTextType", EnumValue = 4 }, + { Name = "ValueOverMax", Type = "StatusBarValueTextType", EnumValue = 5 }, + { Name = "ValueOverMaxNormalized", Type = "StatusBarValueTextType", EnumValue = 6 }, + }, + }, + { + Name = "TugOfWarMarkerArrowShownState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Never", Type = "TugOfWarMarkerArrowShownState", EnumValue = 0 }, + { Name = "Always", Type = "TugOfWarMarkerArrowShownState", EnumValue = 1 }, + { Name = "FlashOnMove", Type = "TugOfWarMarkerArrowShownState", EnumValue = 2 }, + }, + }, + { + Name = "TugOfWarStyleValue", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "DefaultYellow", Type = "TugOfWarStyleValue", EnumValue = 0 }, + { Name = "ArchaeologyBrown", Type = "TugOfWarStyleValue", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetBlendModeType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Opaque", Type = "UIWidgetBlendModeType", EnumValue = 0 }, + { Name = "Additive", Type = "UIWidgetBlendModeType", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetButtonEnabledState", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Disabled", Type = "UIWidgetButtonEnabledState", EnumValue = 0 }, + { Name = "Enabled", Type = "UIWidgetButtonEnabledState", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetButtonIconType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Exit", Type = "UIWidgetButtonIconType", EnumValue = 0 }, + { Name = "Speak", Type = "UIWidgetButtonIconType", EnumValue = 1 }, + { Name = "Undo", Type = "UIWidgetButtonIconType", EnumValue = 2 }, + { Name = "Checkmark", Type = "UIWidgetButtonIconType", EnumValue = 3 }, + { Name = "RedX", Type = "UIWidgetButtonIconType", EnumValue = 4 }, + }, + }, + { + Name = "UIWidgetFontType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Normal", Type = "UIWidgetFontType", EnumValue = 0 }, + { Name = "Shadow", Type = "UIWidgetFontType", EnumValue = 1 }, + { Name = "Outline", Type = "UIWidgetFontType", EnumValue = 2 }, + }, + }, + { + Name = "UIWidgetMotionType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Instant", Type = "UIWidgetMotionType", EnumValue = 0 }, + { Name = "Smooth", Type = "UIWidgetMotionType", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetOverrideState", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Inactive", Type = "UIWidgetOverrideState", EnumValue = 0 }, + { Name = "Active", Type = "UIWidgetOverrideState", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetRewardShownState", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Hidden", Type = "UIWidgetRewardShownState", EnumValue = 0 }, + { Name = "ShownEarned", Type = "UIWidgetRewardShownState", EnumValue = 1 }, + { Name = "ShownUnearned", Type = "UIWidgetRewardShownState", EnumValue = 2 }, + }, + }, + { + Name = "UIWidgetSpellButtonCooldownType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "HideCooldown", Type = "UIWidgetSpellButtonCooldownType", EnumValue = 0 }, + { Name = "ShowCooldown", Type = "UIWidgetSpellButtonCooldownType", EnumValue = 1 }, + { Name = "ShowCooldownAndDisableOnCooldown", Type = "UIWidgetSpellButtonCooldownType", EnumValue = 2 }, + }, + }, + { + Name = "UIWidgetTextFormatType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "UIWidgetTextFormatType", EnumValue = 0 }, + { Name = "TimeOneLevel", Type = "UIWidgetTextFormatType", EnumValue = 1 }, + { Name = "TimeTwoLevel", Type = "UIWidgetTextFormatType", EnumValue = 2 }, + { Name = "LeadingZeroesWithSixDigits", Type = "UIWidgetTextFormatType", EnumValue = 3 }, + }, + }, + { + Name = "UIWidgetTextSizeType", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Small12Pt", Type = "UIWidgetTextSizeType", EnumValue = 0 }, + { Name = "Medium16Pt", Type = "UIWidgetTextSizeType", EnumValue = 1 }, + { Name = "Large24Pt", Type = "UIWidgetTextSizeType", EnumValue = 2 }, + { Name = "Huge27Pt", Type = "UIWidgetTextSizeType", EnumValue = 3 }, + { Name = "Standard14Pt", Type = "UIWidgetTextSizeType", EnumValue = 4 }, + { Name = "Small10Pt", Type = "UIWidgetTextSizeType", EnumValue = 5 }, + { Name = "Small11Pt", Type = "UIWidgetTextSizeType", EnumValue = 6 }, + { Name = "Medium18Pt", Type = "UIWidgetTextSizeType", EnumValue = 7 }, + { Name = "Large20Pt", Type = "UIWidgetTextSizeType", EnumValue = 8 }, + }, + }, + { + Name = "UIWidgetTextureAndTextSizeType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Small", Type = "UIWidgetTextureAndTextSizeType", EnumValue = 0 }, + { Name = "Medium", Type = "UIWidgetTextureAndTextSizeType", EnumValue = 1 }, + { Name = "Large", Type = "UIWidgetTextureAndTextSizeType", EnumValue = 2 }, + { Name = "Huge", Type = "UIWidgetTextureAndTextSizeType", EnumValue = 3 }, + { Name = "Standard", Type = "UIWidgetTextureAndTextSizeType", EnumValue = 4 }, + { Name = "Medium2", Type = "UIWidgetTextureAndTextSizeType", EnumValue = 5 }, + }, + }, + { + Name = "UIWidgetTooltipLocation", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Default", Type = "UIWidgetTooltipLocation", EnumValue = 0 }, + { Name = "BottomLeft", Type = "UIWidgetTooltipLocation", EnumValue = 1 }, + { Name = "Left", Type = "UIWidgetTooltipLocation", EnumValue = 2 }, + { Name = "TopLeft", Type = "UIWidgetTooltipLocation", EnumValue = 3 }, + { Name = "Top", Type = "UIWidgetTooltipLocation", EnumValue = 4 }, + { Name = "TopRight", Type = "UIWidgetTooltipLocation", EnumValue = 5 }, + { Name = "Right", Type = "UIWidgetTooltipLocation", EnumValue = 6 }, + { Name = "BottomRight", Type = "UIWidgetTooltipLocation", EnumValue = 7 }, + { Name = "Bottom", Type = "UIWidgetTooltipLocation", EnumValue = 8 }, + }, + }, + { + Name = "UIWidgetUpdateAnimType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "UIWidgetUpdateAnimType", EnumValue = 0 }, + { Name = "Flash", Type = "UIWidgetUpdateAnimType", EnumValue = 1 }, + { Name = "FlashAndAnimateNumber", Type = "UIWidgetUpdateAnimType", EnumValue = 2 }, + }, + }, + { + Name = "WidgetAnimationType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "WidgetAnimationType", EnumValue = 0 }, + { Name = "Fade", Type = "WidgetAnimationType", EnumValue = 1 }, + }, + }, + { + Name = "WidgetCurrencyClass", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Currency", Type = "WidgetCurrencyClass", EnumValue = 0 }, + { Name = "Item", Type = "WidgetCurrencyClass", EnumValue = 1 }, + }, + }, + { + Name = "WidgetEnabledState", + Type = "Enumeration", + NumValues = 8, + MinValue = 0, + MaxValue = 7, + Fields = + { + { Name = "Disabled", Type = "WidgetEnabledState", EnumValue = 0 }, + { Name = "Yellow", Type = "WidgetEnabledState", EnumValue = 1 }, + { Name = "Red", Type = "WidgetEnabledState", EnumValue = 2 }, + { Name = "White", Type = "WidgetEnabledState", EnumValue = 3 }, + { Name = "Green", Type = "WidgetEnabledState", EnumValue = 4 }, + { Name = "Artifact", Type = "WidgetEnabledState", EnumValue = 5 }, + { Name = "Black", Type = "WidgetEnabledState", EnumValue = 6 }, + { Name = "BrightBlue", Type = "WidgetEnabledState", EnumValue = 7 }, + }, + }, + { + Name = "WidgetGlowAnimType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "WidgetGlowAnimType", EnumValue = 0 }, + { Name = "Pulse", Type = "WidgetGlowAnimType", EnumValue = 1 }, + }, + }, + { + Name = "WidgetIconSizeType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Small", Type = "WidgetIconSizeType", EnumValue = 0 }, + { Name = "Medium", Type = "WidgetIconSizeType", EnumValue = 1 }, + { Name = "Large", Type = "WidgetIconSizeType", EnumValue = 2 }, + { Name = "Standard", Type = "WidgetIconSizeType", EnumValue = 3 }, + }, + }, + { + Name = "WidgetIconSourceType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Spell", Type = "WidgetIconSourceType", EnumValue = 0 }, + { Name = "Item", Type = "WidgetIconSourceType", EnumValue = 1 }, + }, + }, + { + Name = "WidgetOpacityType", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "OneHundred", Type = "WidgetOpacityType", EnumValue = 0 }, + { Name = "Ninety", Type = "WidgetOpacityType", EnumValue = 1 }, + { Name = "Eighty", Type = "WidgetOpacityType", EnumValue = 2 }, + { Name = "Seventy", Type = "WidgetOpacityType", EnumValue = 3 }, + { Name = "Sixty", Type = "WidgetOpacityType", EnumValue = 4 }, + { Name = "Fifty", Type = "WidgetOpacityType", EnumValue = 5 }, + { Name = "Forty", Type = "WidgetOpacityType", EnumValue = 6 }, + { Name = "Thirty", Type = "WidgetOpacityType", EnumValue = 7 }, + { Name = "Twenty", Type = "WidgetOpacityType", EnumValue = 8 }, + { Name = "Ten", Type = "WidgetOpacityType", EnumValue = 9 }, + { Name = "Zero", Type = "WidgetOpacityType", EnumValue = 10 }, + }, + }, + { + Name = "WidgetShowGlowState", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "HideGlow", Type = "WidgetShowGlowState", EnumValue = 0 }, + { Name = "ShowGlow", Type = "WidgetShowGlowState", EnumValue = 1 }, + }, + }, + { + Name = "WidgetShownState", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Hidden", Type = "WidgetShownState", EnumValue = 0 }, + { Name = "Shown", Type = "WidgetShownState", EnumValue = 1 }, + }, + }, + { + Name = "WidgetTextHorizontalAlignmentType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Left", Type = "WidgetTextHorizontalAlignmentType", EnumValue = 0 }, + { Name = "Center", Type = "WidgetTextHorizontalAlignmentType", EnumValue = 1 }, + { Name = "Right", Type = "WidgetTextHorizontalAlignmentType", EnumValue = 2 }, + }, + }, + { + Name = "WidgetUnitPowerBarFlashMomentType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "FlashWhenMax", Type = "WidgetUnitPowerBarFlashMomentType", EnumValue = 0 }, + { Name = "FlashWhenMin", Type = "WidgetUnitPowerBarFlashMomentType", EnumValue = 1 }, + { Name = "NeverFlash", Type = "WidgetUnitPowerBarFlashMomentType", EnumValue = 2 }, + }, + }, + { + Name = "ZoneControlActiveState", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Inactive", Type = "ZoneControlActiveState", EnumValue = 0 }, + { Name = "Active", Type = "ZoneControlActiveState", EnumValue = 1 }, + }, + }, + { + Name = "ZoneControlDangerFlashType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "ShowOnGoodStates", Type = "ZoneControlDangerFlashType", EnumValue = 0 }, + { Name = "ShowOnBadStates", Type = "ZoneControlDangerFlashType", EnumValue = 1 }, + { Name = "ShowOnBoth", Type = "ZoneControlDangerFlashType", EnumValue = 2 }, + { Name = "ShowOnNeither", Type = "ZoneControlDangerFlashType", EnumValue = 3 }, + }, + }, + { + Name = "ZoneControlFillType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "SingleFillClockwise", Type = "ZoneControlFillType", EnumValue = 0 }, + { Name = "SingleFillCounterClockwise", Type = "ZoneControlFillType", EnumValue = 1 }, + { Name = "DoubleFillClockwise", Type = "ZoneControlFillType", EnumValue = 2 }, + { Name = "DoubleFillCounterClockwise", Type = "ZoneControlFillType", EnumValue = 3 }, + }, + }, + { + Name = "ZoneControlLeadingEdgeType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "NoLeadingEdge", Type = "ZoneControlLeadingEdgeType", EnumValue = 0 }, + { Name = "UseLeadingEdge", Type = "ZoneControlLeadingEdgeType", EnumValue = 1 }, + }, + }, + { + Name = "ZoneControlMode", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "BothStatesAreGood", Type = "ZoneControlMode", EnumValue = 0 }, + { Name = "State1IsGood", Type = "ZoneControlMode", EnumValue = 1 }, + { Name = "State2IsGood", Type = "ZoneControlMode", EnumValue = 2 }, + { Name = "NeitherStateIsGood", Type = "ZoneControlMode", EnumValue = 3 }, + }, + }, + { + Name = "ZoneControlState", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "State1", Type = "ZoneControlState", EnumValue = 0 }, + { Name = "State2", Type = "ZoneControlState", EnumValue = 1 }, + }, + }, + { + Name = "BulletTextListWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "enabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "lines", Type = "table", InnerType = "string", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ButtonHeaderWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "headerText", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "buttons", Type = "table", InnerType = "UIWidgetSpellButtonInfo", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CaptureBarWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "barValue", Type = "number", Nilable = false }, + { Name = "barMinValue", Type = "number", Nilable = false }, + { Name = "barMaxValue", Type = "number", Nilable = false }, + { Name = "neutralZoneSize", Type = "number", Nilable = false }, + { Name = "neutralZoneCenter", Type = "number", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "glowAnimType", Type = "WidgetGlowAnimType", Nilable = false }, + { Name = "fillDirectionType", Type = "CaptureBarWidgetFillDirectionType", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CaptureZoneVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "mode", Type = "ZoneControlMode", Nilable = false }, + { Name = "leadingEdgeType", Type = "ZoneControlLeadingEdgeType", Nilable = false }, + { Name = "dangerFlashType", Type = "ZoneControlDangerFlashType", Nilable = false }, + { Name = "zoneInfo", Type = "ZoneEntry", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DiscreteProgressStepsVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "progressMin", Type = "number", Nilable = false }, + { Name = "progressMax", Type = "number", Nilable = false }, + { Name = "progressVal", Type = "number", Nilable = false }, + { Name = "numSteps", Type = "number", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DoubleIconAndTextWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "label", Type = "string", Nilable = false }, + { Name = "leftText", Type = "string", Nilable = false }, + { Name = "leftTooltip", Type = "string", Nilable = false }, + { Name = "rightText", Type = "string", Nilable = false }, + { Name = "rightTooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DoubleStateIconRowVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "leftIcons", Type = "table", InnerType = "UIWidgetStateIconInfo", Nilable = false }, + { Name = "rightIcons", Type = "table", InnerType = "UIWidgetStateIconInfo", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DoubleStatusBarWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "leftBarMin", Type = "number", Nilable = false }, + { Name = "leftBarMax", Type = "number", Nilable = false }, + { Name = "leftBarValue", Type = "number", Nilable = false }, + { Name = "leftBarTooltip", Type = "string", Nilable = false }, + { Name = "rightBarMin", Type = "number", Nilable = false }, + { Name = "rightBarMax", Type = "number", Nilable = false }, + { Name = "rightBarValue", Type = "number", Nilable = false }, + { Name = "rightBarTooltip", Type = "string", Nilable = false }, + { Name = "barValueTextType", Type = "StatusBarValueTextType", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "leftBarTooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "rightBarTooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "fillMotionType", Type = "UIWidgetMotionType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "FillUpFramesWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "fillMin", Type = "number", Nilable = false }, + { Name = "fillMax", Type = "number", Nilable = false }, + { Name = "fillValue", Type = "number", Nilable = false }, + { Name = "numTotalFrames", Type = "number", Nilable = false }, + { Name = "numFullFrames", Type = "number", Nilable = false }, + { Name = "pulseFillingFrame", Type = "bool", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "HorizontalCurrenciesWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "currencies", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IconAndTextWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "state", Type = "IconAndTextWidgetState", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "dynamicTooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "shiftTextType", Type = "IconAndTextShiftTextType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IconTextAndBackgroundWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "IconTextAndCurrenciesWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "enabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "descriptionShownState", Type = "WidgetShownState", Nilable = false }, + { Name = "descriptionEnabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "currencies", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemDisplayVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "itemInfo", Type = "UIWidgetItemInfo", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "MapPinAnimationWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "animType", Type = "MapPinAnimationType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PreyHuntProgressWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "progressState", Type = "PreyHuntProgressState", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "currencies", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, + { Name = "headerText", Type = "string", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioHeaderDelvesWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "headerText", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "tierText", Type = "string", Nilable = false }, + { Name = "tierTooltipSpellID", Type = "number", Nilable = true }, + { Name = "currencies", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, + { Name = "spells", Type = "table", InnerType = "UIWidgetSpellInfo", Nilable = false }, + { Name = "rewardInfo", Type = "UIWidgetRewardInfo", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ScenarioHeaderTimerWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "timerMin", Type = "number", Nilable = false }, + { Name = "timerMax", Type = "number", Nilable = false }, + { Name = "timerValue", Type = "number", Nilable = false }, + { Name = "headerText", Type = "string", Nilable = false }, + { Name = "timerTooltip", Type = "string", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpacerVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "widgetWidth", Type = "number", Nilable = false }, + { Name = "widgetHeight", Type = "number", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpellDisplayVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "spellInfo", Type = "UIWidgetSpellInfo", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "StackedResourceTrackerWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "resources", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "StatusBarWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "barMin", Type = "number", Nilable = false }, + { Name = "barMax", Type = "number", Nilable = false }, + { Name = "barValue", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "barValueTextType", Type = "StatusBarValueTextType", Nilable = false }, + { Name = "overrideBarText", Type = "string", Nilable = false }, + { Name = "overrideBarTextShownType", Type = "StatusBarOverrideBarTextShownType", Nilable = false }, + { Name = "colorTint", Type = "StatusBarColorTintValue", Nilable = false }, + { Name = "partitionValues", Type = "table", InnerType = "number", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "fillMotionType", Type = "UIWidgetMotionType", Nilable = false }, + { Name = "barTextEnabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "barTextFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "barTextSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "textEnabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "textFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "glowAnimType", Type = "WidgetGlowAnimType", Nilable = false }, + { Name = "showGlowState", Type = "WidgetShowGlowState", Nilable = false }, + { Name = "fillMinOpacity", Type = "WidgetOpacityType", Nilable = false }, + { Name = "fillMaxOpacity", Type = "WidgetOpacityType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextColumnRowEntryInfo", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "enabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "hAlign", Type = "WidgetTextHorizontalAlignmentType", Nilable = false }, + { Name = "columnWidth", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextColumnRowVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "entries", Type = "table", InnerType = "TextColumnRowEntryInfo", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "fontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "bottomPadding", Type = "number", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextWithStateWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "enabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "fontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "bottomPadding", Type = "number", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "hAlign", Type = "WidgetTextHorizontalAlignmentType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextWithSubtextWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "enabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "widgetWidth", Type = "number", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "fontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "hAlign", Type = "WidgetTextHorizontalAlignmentType", Nilable = false }, + { Name = "subText", Type = "string", Nilable = false }, + { Name = "subTextSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "subTextFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "subTextHAlign", Type = "WidgetTextHorizontalAlignmentType", Nilable = false }, + { Name = "subTextEnabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + { Name = "spacing", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextureAndTextEntryInfo", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + }, + }, + { + Name = "TextureAndTextRowVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "entries", Type = "table", InnerType = "TextureAndTextEntryInfo", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextureAndTextSizeType", Nilable = false }, + { Name = "groupAlignment", Type = "UIWidgetHorizontalDirection", Nilable = false }, + { Name = "fixedWidth", Type = "number", Nilable = true }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextureAndTextVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextureAndTextSizeType", Nilable = false }, + { Name = "textFormatType", Type = "UIWidgetTextFormatType", Nilable = false }, + { Name = "updateAnimType", Type = "UIWidgetUpdateAnimType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TextureWithAnimationVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TugOfWarWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "minValue", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + { Name = "currentValue", Type = "number", Nilable = false }, + { Name = "neutralZoneCenter", Type = "number", Nilable = false }, + { Name = "neutralZoneSize", Type = "number", Nilable = false }, + { Name = "leftIconInfo", Type = "UIWidgetIconInfo", Nilable = false }, + { Name = "rightIconInfo", Type = "UIWidgetIconInfo", Nilable = false }, + { Name = "glowAnimType", Type = "WidgetGlowAnimType", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "neutralFillStyle", Type = "TugOfWarStyleValue", Nilable = false }, + { Name = "markerArrowShownState", Type = "TugOfWarMarkerArrowShownState", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UIWidgetCurrencyInfo", + Type = "Structure", + Fields = + { + { Name = "iconFileID", Type = "fileID", Nilable = false }, + { Name = "leadingText", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "isCurrencyMaxed", Type = "bool", Nilable = false }, + { Name = "textFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "textEnabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "iconSizeType", Type = "WidgetIconSizeType", Nilable = false }, + { Name = "updateAnimType", Type = "UIWidgetUpdateAnimType", Nilable = false }, + }, + }, + { + Name = "UIWidgetIconInfo", + Type = "Structure", + Fields = + { + { Name = "sourceType", Type = "WidgetIconSourceType", Nilable = false }, + { Name = "sourceID", Type = "number", Nilable = false }, + { Name = "sizeType", Type = "WidgetIconSizeType", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + }, + }, + { + Name = "UIWidgetInfo", + Type = "Structure", + Fields = + { + { Name = "widgetID", Type = "number", Nilable = false }, + { Name = "widgetSetID", Type = "number", Nilable = false }, + { Name = "widgetType", Type = "UIWidgetVisualizationType", Nilable = false }, + { Name = "unitToken", Type = "string", Nilable = true }, + }, + }, + { + Name = "UIWidgetItemInfo", + Type = "Structure", + Fields = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "stackCount", Type = "number", Nilable = true }, + { Name = "overrideItemName", Type = "string", Nilable = true }, + { Name = "infoText", Type = "string", Nilable = true }, + { Name = "overrideTooltip", Type = "string", Nilable = true }, + { Name = "textDisplayStyle", Type = "ItemDisplayTextDisplayStyle", Nilable = false }, + { Name = "tooltipEnabled", Type = "bool", Nilable = false }, + { Name = "iconSizeType", Type = "WidgetIconSizeType", Nilable = false }, + { Name = "infoTextEnabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "showAsEarned", Type = "bool", Nilable = false }, + { Name = "itemNameTextFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "itemNameTextSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "infoTextFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "infoTextSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "itemNameCustomColor", Type = "WidgetEnabledState", Nilable = false }, + { Name = "itemNameCustomColorOverrideState", Type = "UIWidgetOverrideState", Nilable = false }, + }, + }, + { + Name = "UIWidgetRewardInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "UIWidgetRewardShownState", Nilable = false }, + { Name = "earnedTooltip", Type = "string", Nilable = false }, + { Name = "unearnedTooltip", Type = "string", Nilable = false }, + }, + }, + { + Name = "UIWidgetSetInfo", + Type = "Structure", + Fields = + { + { Name = "layoutDirection", Type = "UIWidgetSetLayoutDirection", Nilable = false }, + { Name = "verticalPadding", Type = "number", Nilable = false }, + }, + }, + { + Name = "UIWidgetSpellButtonInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "icon", Type = "UIWidgetButtonIconType", Nilable = false }, + { Name = "enabledState", Type = "UIWidgetButtonEnabledState", Nilable = false }, + { Name = "cooldownType", Type = "UIWidgetSpellButtonCooldownType", Nilable = false }, + }, + }, + { + Name = "UIWidgetSpellInfo", + Type = "Structure", + Fields = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "enabledState", Type = "WidgetEnabledState", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "stackDisplay", Type = "number", Nilable = false }, + { Name = "iconSizeType", Type = "WidgetIconSizeType", Nilable = false }, + { Name = "iconDisplayType", Type = "SpellDisplayIconDisplayType", Nilable = false }, + { Name = "textShownState", Type = "SpellDisplayTextShownStateType", Nilable = false }, + { Name = "borderColor", Type = "SpellDisplayBorderColor", Nilable = false }, + { Name = "textFontType", Type = "UIWidgetFontType", Nilable = false }, + { Name = "textSizeType", Type = "UIWidgetTextSizeType", Nilable = false }, + { Name = "hAlignType", Type = "WidgetTextHorizontalAlignmentType", Nilable = false }, + { Name = "tint", Type = "SpellDisplayTint", Nilable = false }, + { Name = "showGlowState", Type = "WidgetShowGlowState", Nilable = false }, + { Name = "showAsEarned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UIWidgetStateIconInfo", + Type = "Structure", + Fields = + { + { Name = "iconState", Type = "IconState", Nilable = false }, + { Name = "state1Tooltip", Type = "string", Nilable = false }, + { Name = "state2Tooltip", Type = "string", Nilable = false }, + }, + }, + { + Name = "UIWidgetTextTooltipPair", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarWidgetVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "barMin", Type = "number", Nilable = false }, + { Name = "barMax", Type = "number", Nilable = false }, + { Name = "barValue", Type = "number", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "barValueTextType", Type = "StatusBarValueTextType", Nilable = false }, + { Name = "overrideBarText", Type = "string", Nilable = false }, + { Name = "overrideBarTextShownType", Type = "StatusBarOverrideBarTextShownType", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "fillMotionType", Type = "UIWidgetMotionType", Nilable = false }, + { Name = "flashBlendModeType", Type = "UIWidgetBlendModeType", Nilable = false }, + { Name = "sparkBlendModeType", Type = "UIWidgetBlendModeType", Nilable = false }, + { Name = "flashMomentType", Type = "WidgetUnitPowerBarFlashMomentType", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ZoneControlVisualizationInfo", + Type = "Structure", + Fields = + { + { Name = "shownState", Type = "WidgetShownState", Nilable = false }, + { Name = "mode", Type = "ZoneControlMode", Nilable = false }, + { Name = "leadingEdgeType", Type = "ZoneControlLeadingEdgeType", Nilable = false }, + { Name = "dangerFlashType", Type = "ZoneControlDangerFlashType", Nilable = false }, + { Name = "zoneEntries", Type = "table", InnerType = "ZoneEntry", Nilable = false }, + { Name = "tooltipLoc", Type = "UIWidgetTooltipLocation", Nilable = false }, + { Name = "widgetSizeSetting", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "frameTextureKit", Type = "textureKit", Nilable = false }, + { Name = "hasTimer", Type = "bool", Nilable = false }, + { Name = "orderIndex", Type = "number", Nilable = false }, + { Name = "widgetTag", Type = "string", Nilable = false }, + { Name = "inAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "outAnimType", Type = "WidgetAnimationType", Nilable = false }, + { Name = "widgetScale", Type = "UIWidgetScale", Nilable = false }, + { Name = "layoutDirection", Type = "UIWidgetLayoutDirection", Nilable = false }, + { Name = "modelSceneLayer", Type = "UIWidgetModelSceneLayer", Nilable = false }, + { Name = "scriptedAnimationEffectID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ZoneEntry", + Type = "Structure", + Fields = + { + { Name = "state", Type = "ZoneControlState", Nilable = false }, + { Name = "activeState", Type = "ZoneControlActiveState", Nilable = false }, + { Name = "fillType", Type = "ZoneControlFillType", Nilable = false }, + { Name = "min", Type = "number", Nilable = false }, + { Name = "max", Type = "number", Nilable = false }, + { Name = "current", Type = "number", Nilable = false }, + { Name = "capturePoint", Type = "number", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIWidgetManager); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3eeca83 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UIWidgetManagerSharedDocumentation.lua.annotated.lua @@ -0,0 +1,172 @@ +local UIWidgetManagerShared = +{ + Tables = + { + { + Name = "MapIconUIWidgetSetType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Tooltip", Type = "MapIconUIWidgetSetType", EnumValue = 0 }, + { Name = "BehindIcon", Type = "MapIconUIWidgetSetType", EnumValue = 1 }, + { Name = "AdventureMapDetails", Type = "MapIconUIWidgetSetType", EnumValue = 2 }, + }, + }, + { + Name = "SpellDisplayBorderColor", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "SpellDisplayBorderColor", EnumValue = 0 }, + { Name = "Black", Type = "SpellDisplayBorderColor", EnumValue = 1 }, + { Name = "White", Type = "SpellDisplayBorderColor", EnumValue = 2 }, + { Name = "Red", Type = "SpellDisplayBorderColor", EnumValue = 3 }, + { Name = "Yellow", Type = "SpellDisplayBorderColor", EnumValue = 4 }, + { Name = "Orange", Type = "SpellDisplayBorderColor", EnumValue = 5 }, + { Name = "Purple", Type = "SpellDisplayBorderColor", EnumValue = 6 }, + { Name = "Green", Type = "SpellDisplayBorderColor", EnumValue = 7 }, + { Name = "Blue", Type = "SpellDisplayBorderColor", EnumValue = 8 }, + }, + }, + { + Name = "UIWidgetFlag", + Type = "Enumeration", + NumValues = 1, + MinValue = 1, + MaxValue = 1, + Fields = + { + { Name = "UniversalWidget", Type = "UIWidgetFlag", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetHorizontalDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "LeftToRight", Type = "UIWidgetHorizontalDirection", EnumValue = 0 }, + { Name = "RightToLeft", Type = "UIWidgetHorizontalDirection", EnumValue = 1 }, + }, + }, + { + Name = "UIWidgetLayoutDirection", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Default", Type = "UIWidgetLayoutDirection", EnumValue = 0 }, + { Name = "Vertical", Type = "UIWidgetLayoutDirection", EnumValue = 1 }, + { Name = "Horizontal", Type = "UIWidgetLayoutDirection", EnumValue = 2 }, + { Name = "Overlap", Type = "UIWidgetLayoutDirection", EnumValue = 3 }, + { Name = "HorizontalForceNewRow", Type = "UIWidgetLayoutDirection", EnumValue = 4 }, + }, + }, + { + Name = "UIWidgetModelSceneLayer", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "UIWidgetModelSceneLayer", EnumValue = 0 }, + { Name = "Front", Type = "UIWidgetModelSceneLayer", EnumValue = 1 }, + { Name = "Back", Type = "UIWidgetModelSceneLayer", EnumValue = 2 }, + }, + }, + { + Name = "UIWidgetScale", + Type = "Enumeration", + NumValues = 16, + MinValue = 0, + MaxValue = 15, + Fields = + { + { Name = "OneHundred", Type = "UIWidgetScale", EnumValue = 0 }, + { Name = "Ninty", Type = "UIWidgetScale", EnumValue = 1 }, + { Name = "Eighty", Type = "UIWidgetScale", EnumValue = 2 }, + { Name = "Seventy", Type = "UIWidgetScale", EnumValue = 3 }, + { Name = "Sixty", Type = "UIWidgetScale", EnumValue = 4 }, + { Name = "Fifty", Type = "UIWidgetScale", EnumValue = 5 }, + { Name = "OneHundredTen", Type = "UIWidgetScale", EnumValue = 6 }, + { Name = "OneHundredTwenty", Type = "UIWidgetScale", EnumValue = 7 }, + { Name = "OneHundredThirty", Type = "UIWidgetScale", EnumValue = 8 }, + { Name = "OneHundredForty", Type = "UIWidgetScale", EnumValue = 9 }, + { Name = "OneHundredFifty", Type = "UIWidgetScale", EnumValue = 10 }, + { Name = "OneHundredSixty", Type = "UIWidgetScale", EnumValue = 11 }, + { Name = "OneHundredSeventy", Type = "UIWidgetScale", EnumValue = 12 }, + { Name = "OneHundredEighty", Type = "UIWidgetScale", EnumValue = 13 }, + { Name = "OneHundredNinety", Type = "UIWidgetScale", EnumValue = 14 }, + { Name = "TwoHundred", Type = "UIWidgetScale", EnumValue = 15 }, + }, + }, + { + Name = "UIWidgetSetLayoutDirection", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Vertical", Type = "UIWidgetSetLayoutDirection", EnumValue = 0 }, + { Name = "Horizontal", Type = "UIWidgetSetLayoutDirection", EnumValue = 1 }, + { Name = "Overlap", Type = "UIWidgetSetLayoutDirection", EnumValue = 2 }, + }, + }, + { + Name = "UIWidgetVisualizationType", + Type = "Enumeration", + NumValues = 32, + MinValue = 0, + MaxValue = 31, + Fields = + { + { Name = "IconAndText", Type = "UIWidgetVisualizationType", EnumValue = 0 }, + { Name = "CaptureBar", Type = "UIWidgetVisualizationType", EnumValue = 1 }, + { Name = "StatusBar", Type = "UIWidgetVisualizationType", EnumValue = 2 }, + { Name = "DoubleStatusBar", Type = "UIWidgetVisualizationType", EnumValue = 3 }, + { Name = "IconTextAndBackground", Type = "UIWidgetVisualizationType", EnumValue = 4 }, + { Name = "DoubleIconAndText", Type = "UIWidgetVisualizationType", EnumValue = 5 }, + { Name = "StackedResourceTracker", Type = "UIWidgetVisualizationType", EnumValue = 6 }, + { Name = "IconTextAndCurrencies", Type = "UIWidgetVisualizationType", EnumValue = 7 }, + { Name = "TextWithState", Type = "UIWidgetVisualizationType", EnumValue = 8 }, + { Name = "HorizontalCurrencies", Type = "UIWidgetVisualizationType", EnumValue = 9 }, + { Name = "BulletTextList", Type = "UIWidgetVisualizationType", EnumValue = 10 }, + { Name = "ScenarioHeaderCurrenciesAndBackground", Type = "UIWidgetVisualizationType", EnumValue = 11 }, + { Name = "TextureAndText", Type = "UIWidgetVisualizationType", EnumValue = 12 }, + { Name = "SpellDisplay", Type = "UIWidgetVisualizationType", EnumValue = 13 }, + { Name = "DoubleStateIconRow", Type = "UIWidgetVisualizationType", EnumValue = 14 }, + { Name = "TextureAndTextRow", Type = "UIWidgetVisualizationType", EnumValue = 15 }, + { Name = "ZoneControl", Type = "UIWidgetVisualizationType", EnumValue = 16 }, + { Name = "CaptureZone", Type = "UIWidgetVisualizationType", EnumValue = 17 }, + { Name = "TextureWithAnimation", Type = "UIWidgetVisualizationType", EnumValue = 18 }, + { Name = "DiscreteProgressSteps", Type = "UIWidgetVisualizationType", EnumValue = 19 }, + { Name = "ScenarioHeaderTimer", Type = "UIWidgetVisualizationType", EnumValue = 20 }, + { Name = "TextColumnRow", Type = "UIWidgetVisualizationType", EnumValue = 21 }, + { Name = "Spacer", Type = "UIWidgetVisualizationType", EnumValue = 22 }, + { Name = "UnitPowerBar", Type = "UIWidgetVisualizationType", EnumValue = 23 }, + { Name = "FillUpFrames", Type = "UIWidgetVisualizationType", EnumValue = 24 }, + { Name = "TextWithSubtext", Type = "UIWidgetVisualizationType", EnumValue = 25 }, + { Name = "MapPinAnimation", Type = "UIWidgetVisualizationType", EnumValue = 26 }, + { Name = "ItemDisplay", Type = "UIWidgetVisualizationType", EnumValue = 27 }, + { Name = "TugOfWar", Type = "UIWidgetVisualizationType", EnumValue = 28 }, + { Name = "ScenarioHeaderDelves", Type = "UIWidgetVisualizationType", EnumValue = 29 }, + { Name = "ButtonHeader", Type = "UIWidgetVisualizationType", EnumValue = 30 }, + { Name = "PreyHuntProgress", Type = "UIWidgetVisualizationType", EnumValue = 31 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UIWidgetManagerShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/URLDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/URLDocumentation.lua.annotated.lua new file mode 100644 index 0000000..bcd8093 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/URLDocumentation.lua.annotated.lua @@ -0,0 +1,42 @@ +local URL = +{ + Name = "URL", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "LaunchURL", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "url", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "LoadURLIndex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "index", Type = "number", Nilable = false }, + { Name = "param", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(URL); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiModelSceneConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiModelSceneConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..33aaf4f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiModelSceneConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,34 @@ +local UiModelSceneConstants = +{ + Tables = + { + { + Name = "UIModelSceneContext", + Type = "Enumeration", + NumValues = 2, + MinValue = -1, + MaxValue = 0, + Fields = + { + { Name = "None", Type = "UIModelSceneContext", EnumValue = -1 }, + { Name = "PerksProgram", Type = "UIModelSceneContext", EnumValue = 0 }, + }, + }, + { + Name = "UIModelSceneFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 1, + MaxValue = 8, + Fields = + { + { Name = "SheatheWeapon", Type = "UIModelSceneFlags", EnumValue = 1 }, + { Name = "HideWeapon", Type = "UIModelSceneFlags", EnumValue = 2 }, + { Name = "Autodress", Type = "UIModelSceneFlags", EnumValue = 4 }, + { Name = "NoCameraSpin", Type = "UIModelSceneFlags", EnumValue = 8 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UiModelSceneConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiRpcRequestManagerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiRpcRequestManagerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..86746c2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UiRpcRequestManagerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local UiRpcRequestManagerConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UiRpcRequestManagerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua.annotated.lua new file mode 100644 index 0000000..eeca7ef --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraDocumentation.lua.annotated.lua @@ -0,0 +1,498 @@ +local UnitAura = +{ + Name = "UnitAuras", + Type = "System", + Namespace = "C_UnitAuras", + Environment = "All", + + Functions = + { + { + Name = "AddPrivateAuraAnchor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "args", Type = "AddPrivateAuraAnchorArgs", Nilable = false }, + }, + + Returns = + { + { Name = "anchorID", Type = "number", Nilable = true }, + }, + }, + { + Name = "AddPrivateAuraAppliedSound", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sound", Type = "UnitPrivateAuraAppliedSoundInfo", Nilable = false }, + }, + + Returns = + { + { Name = "privateAuraSoundID", Type = "number", Nilable = true }, + }, + }, + { + Name = "AuraIsBigDefensive", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isBigDefensive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "AuraIsPrivate", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPrivate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesAuraHaveExpirationTime", + Type = "Function", + RequiresValidUnitAuraInstance = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns true if an aura instance will expire after a certain amount of time." }, + + Arguments = + { + { Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasExpirationTime", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetAuraApplicationDisplayCount", + Type = "Function", + RequiresValidUnitAuraInstance = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Formats a string for displaying the number of applications an aura has present." }, + + Arguments = + { + { Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "minDisplayCount", Type = "number", Nilable = false, Default = 2, Documentation = { "Minimum number of applications required; if the application count is below this figure an empty string will be returned." } }, + { Name = "maxDisplayCount", Type = "number", Nilable = true, Documentation = { "Maximum number of applications allowed; if the application count is above this figure then the string '*' will be returned." } }, + }, + + Returns = + { + { Name = "count", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAuraBaseDuration", + Type = "Function", + RequiresValidUnitAuraInstance = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns the base duration of the given spell (or aura). Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used" }, + + Arguments = + { + { Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "newDuration", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetAuraDataByAuraInstanceID", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetAuraDataByIndex", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetAuraDataBySlot", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetAuraDataBySpellName", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + RequiresNonSecretAura = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "spellName", Type = "cstring", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetAuraDispelTypeColor", + Type = "Function", + RequiresValidUnitAuraInstance = true, + SecretWhenUnitAuraRestricted = true, + SecretWhenCurveSecret = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Queries the dispel type associated with an aura instance and remaps it to a color via a curve, with the dispel type ID used as the 'x' value." }, + + Arguments = + { + { Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "curve", Type = "LuaColorCurveObject", Nilable = false }, + }, + + Returns = + { + { Name = "dispelTypeColor", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, + }, + }, + { + Name = "GetAuraDuration", + Type = "Function", + RequiresValidUnitAuraInstance = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "GetAuraSlots", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + { Name = "maxSlots", Type = "number", Nilable = true }, + { Name = "continuationToken", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "outContinuationToken", Type = "number", Nilable = true }, + { Name = "slots", Type = "number", Nilable = false, StrideIndex = 1 }, + }, + }, + { + Name = "GetBuffDataByIndex", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetCooldownAuraBySpellID", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "cooldownSpellID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetDebuffDataByIndex", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = true }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetPlayerAuraBySpellID", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + RequiresNonSecretAura = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetRefreshExtendedDuration", + Type = "Function", + RequiresValidUnitAuraInstance = true, + SecretWhenUnitAuraRestricted = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns the client-predicted new duration of this aura if it were cast again right now. Takes an optional spellID to use as the new duration if that cannot be derived from the aura, if that value isn't supplied the aura's spellID will be used" }, + + Arguments = + { + { Name = "auraInstanceUnit", Type = "UnitToken", Nilable = false }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "newDuration", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetUnitAuraBySpellID", + Type = "Function", + SecretWhenUnitAuraRestricted = true, + RequiresNonSecretAura = true, + SecretArguments = "AllowedWhenTainted", + Documentation = { "Returns the first instance of an aura on a unit matching a given spell ID. Returns nil if no such aura is found. Additionally can return nil if querying a unit that is not visible (eg. party members on other maps)." }, + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "aura", Type = "AuraData", Nilable = true }, + }, + }, + { + Name = "GetUnitAuraInstanceIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "filter", Type = "AuraFilters", Nilable = false }, + { Name = "maxCount", Type = "number", Nilable = true }, + { Name = "sortRule", Type = "UnitAuraSortRule", Nilable = false, Default = "Unsorted" }, + { Name = "sortDirection", Type = "UnitAuraSortDirection", Nilable = false, Default = "Normal" }, + }, + + Returns = + { + { Name = "auraInstanceIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitAuras", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "filter", Type = "AuraFilters", Nilable = false }, + { Name = "maxCount", Type = "number", Nilable = true }, + { Name = "sortRule", Type = "UnitAuraSortRule", Nilable = false, Default = "Unsorted" }, + { Name = "sortDirection", Type = "UnitAuraSortDirection", Nilable = false, Default = "Normal" }, + }, + + Returns = + { + { Name = "auras", Type = "table", InnerType = "AuraData", Nilable = false, ConditionalSecretContents = true }, + }, + }, + { + Name = "IsAuraFilteredOutByInstanceID", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenRestrictedForAddOns", Nilable = false, NeverSecret = true }, + { Name = "auraInstanceID", Type = "number", Nilable = false }, + { Name = "filter", Type = "AuraFilters", Nilable = false }, + }, + + Returns = + { + { Name = "isFiltered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemovePrivateAuraAnchor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "anchorID", Type = "number", Nilable = false }, + }, + }, + { + Name = "RemovePrivateAuraAppliedSound", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "privateAuraSoundID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPrivateWarningTextAnchor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "parent", Type = "SimpleFrame", Nilable = false }, + { Name = "anchor", Type = "AnchorBinding", Nilable = true }, + }, + }, + { + Name = "TriggerPrivateAuraShowDispelType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + }, + { + Name = "WantsAlteredForm", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "wantsAlteredForm", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "UnitAura", + Type = "Event", + LiteralName = "UNIT_AURA", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "updateInfo", Type = "UnitAuraUpdateInfo", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UnitAura); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..206904a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitAuraSharedDocumentation.lua.annotated.lua @@ -0,0 +1,37 @@ +local UnitAuraShared = +{ + Tables = + { + { + Name = "UnitAuraSortDirection", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Normal", Type = "UnitAuraSortDirection", EnumValue = 0 }, + { Name = "Reverse", Type = "UnitAuraSortDirection", EnumValue = 1 }, + }, + }, + { + Name = "UnitAuraSortRule", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Unsorted", Type = "UnitAuraSortRule", EnumValue = 0, Documentation = { "Applies no sorting to auras." } }, + { Name = "Default", Type = "UnitAuraSortRule", EnumValue = 1, Documentation = { "Sorts auras according first by whether or not the aura was applied by the player, else whether or not the player can apply the aura, and finally by aura instance ID." } }, + { Name = "BigDefensive", Type = "UnitAuraSortRule", EnumValue = 2, Documentation = { "Sorts auras according first by whether or not the aura was applied by another player, else by expiration time (longest to shortest), and finally by aura instance ID." } }, + { Name = "Expiration", Type = "UnitAuraSortRule", EnumValue = 3, Documentation = { "Sorts auras according first by whether or not the aura was applied by the player, else whether or not the player can apply the aura, then by expiration time (soonest to longest, followed by permanent auras), and finally by aura instance ID." } }, + { Name = "ExpirationOnly", Type = "UnitAuraSortRule", EnumValue = 4, Documentation = { "Sorts auras according only to expiration time." } }, + { Name = "Name", Type = "UnitAuraSortRule", EnumValue = 5, Documentation = { "Sorts auras according first by whether or not the aura was applied by the player, else whether or not the player can apply the aura, then by spell name, and finally by aura instance ID." } }, + { Name = "NameOnly", Type = "UnitAuraSortRule", EnumValue = 6, Documentation = { "Sorts auras according only their spell name." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UnitAuraShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e630576 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,71 @@ +local UnitConstants = +{ + Tables = + { + { + Name = "AddPrivateAuraAnchorArgs", + Type = "Structure", + Fields = + { + { Name = "unitToken", Type = "cstring", Nilable = false }, + { Name = "auraIndex", Type = "number", Nilable = false }, + { Name = "parent", Type = "SimpleFrame", Nilable = false }, + { Name = "showCountdownFrame", Type = "bool", Nilable = false }, + { Name = "showCountdownNumbers", Type = "bool", Nilable = false }, + { Name = "iconInfo", Type = "PrivateAuraIconInfo", Nilable = true }, + { Name = "durationAnchor", Type = "AnchorBinding", Nilable = true }, + }, + }, + { + Name = "PrivateAuraIconInfo", + Type = "Structure", + Fields = + { + { Name = "iconAnchor", Type = "AnchorBinding", Nilable = false }, + { Name = "iconWidth", Type = "uiUnit", Nilable = false }, + { Name = "iconHeight", Type = "uiUnit", Nilable = false }, + { Name = "borderScale", Type = "uiUnit", Nilable = true }, + }, + }, + { + Name = "UnitAuraUpdateInfo", + Type = "Structure", + Fields = + { + { Name = "isFullUpdate", Type = "bool", Nilable = false, Default = false }, + { Name = "removedAuraInstanceIDs", Type = "table", InnerType = "number", Nilable = true, NeverSecretContents = true }, + { Name = "addedAuras", Type = "table", InnerType = "AuraData", Nilable = true, ConditionalSecretContents = true }, + { Name = "updatedAuraInstanceIDs", Type = "table", InnerType = "number", Nilable = true, NeverSecretContents = true }, + }, + }, + { + Name = "UnitPrivateAuraAnchorInfo", + Type = "Structure", + Fields = + { + { Name = "anchorID", Type = "number", Nilable = false }, + { Name = "unitToken", Type = "string", Nilable = false }, + { Name = "auraIndex", Type = "number", Nilable = false }, + { Name = "showCountdownFrame", Type = "bool", Nilable = false }, + { Name = "showCountdownNumbers", Type = "bool", Nilable = false }, + { Name = "iconWidth", Type = "uiUnit", Nilable = true }, + { Name = "iconHeight", Type = "uiUnit", Nilable = true }, + { Name = "borderScale", Type = "uiUnit", Nilable = true }, + }, + }, + { + Name = "UnitPrivateAuraAppliedSoundInfo", + Type = "Structure", + Fields = + { + { Name = "unitToken", Type = "string", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "soundFileName", Type = "string", Nilable = true }, + { Name = "soundFileID", Type = "number", Nilable = true }, + { Name = "outputChannel", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UnitConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1d294cb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitDocumentation.lua.annotated.lua @@ -0,0 +1,4848 @@ +local Unit = +{ + Name = "Unit", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "CanEjectPassengerFromSeat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "virtualSeatIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSwitchVehicleSeat", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClosestGameObjectPosition", + Type = "Function", + MayReturnNothing = true, + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "gameObjectID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "ClosestUnitPosition", + Type = "Function", + MayReturnNothing = true, + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "creatureID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "CreateUnitHealPredictionCalculator", + Type = "Function", + + Returns = + { + { Name = "healPredictionCalculator", Type = "UnitHealPredictionCalculator", Nilable = false }, + }, + }, + { + Name = "EjectPassengerFromSeat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "virtualSeatIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetComboPoints", + Type = "Function", + SecretWhenUnitPowerRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "target", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNegativeCorruptionEffectInfo", + Type = "Function", + + Returns = + { + { Name = "corruptionEffects", Type = "table", InnerType = "CorruptionEffectInfo", Nilable = false }, + }, + }, + { + Name = "GetUnitChargedPowerPoints", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitPowerRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "pointIndices", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitEmpowerHoldAtMaxTime", + Type = "Function", + SecretWhenUnitSpellCastRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "holdAtMaxTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitEmpowerMinHoldTime", + Type = "Function", + SecretWhenUnitSpellCastRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "minHoldTime", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitEmpowerStageDuration", + Type = "Function", + SecretWhenUnitSpellCastRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitHealthModifier", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitMaxHealthModifier", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitPowerBarInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "UnitPowerBarInfo", Nilable = false }, + }, + }, + { + Name = "GetUnitPowerBarInfoByID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "barID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "UnitPowerBarInfo", Nilable = false }, + }, + }, + { + Name = "GetUnitPowerBarStrings", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "tooltip", Type = "cstring", Nilable = true }, + { Name = "cost", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetUnitPowerBarStringsByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "barID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = true }, + { Name = "tooltip", Type = "cstring", Nilable = true }, + { Name = "cost", Type = "cstring", Nilable = true }, + }, + }, + { + Name = "GetUnitPowerBarTextureInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "textureIndex", Type = "luaIndex", Nilable = false }, + { Name = "timerIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitPowerBarTextureInfoByID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "barID", Type = "number", Nilable = false }, + { Name = "textureIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "colorR", Type = "number", Nilable = false }, + { Name = "colorG", Type = "number", Nilable = false }, + { Name = "colorB", Type = "number", Nilable = false }, + { Name = "colorA", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitPowerModifier", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitSpeed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "currentSpeed", Type = "number", Nilable = false }, + { Name = "runSpeed", Type = "number", Nilable = false }, + { Name = "flightSpeed", Type = "number", Nilable = false }, + { Name = "swimSpeed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitTotalModifiedMaxHealthPercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVehicleUIIndicator", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vehicleIndicatorID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "backgroundTextureID", Type = "fileID", Nilable = false }, + { Name = "numSeatIndicators", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVehicleUIIndicatorSeat", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vehicleIndicatorID", Type = "number", Nilable = false }, + { Name = "indicatorSeatIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "virtualSeatIndex", Type = "number", Nilable = false }, + { Name = "xPos", Type = "number", Nilable = false }, + { Name = "yPos", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsFalling", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFlying", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerInGuildFromGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "IsInGuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSubmerged", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSwimming", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUnitModelReadyForUI", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerIsPVPInactive", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerVehicleHasComboPoints", + Type = "Function", + + Returns = + { + { Name = "vehicleHasComboPoints", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReportPlayerIsPVPAFK", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "ResistancePercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "resistance", Type = "number", Nilable = false }, + { Name = "casterLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPortraitTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "disableMasking", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "SetPortraitTextureFromCreatureDisplayID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + { Name = "creatureDisplayID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetUnitCursorTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "style", Type = "CursorStyle", Nilable = true }, + { Name = "includeLowPriority", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "hasCursor", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitAffectingCombat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitAlliedRaceInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isAlliedRace", Type = "bool", Nilable = false }, + { Name = "hasHeritageArmorUnlocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitArmor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "effective", Type = "number", Nilable = false }, + { Name = "real", Type = "number", Nilable = false }, + { Name = "bonus", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAttackPower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "attackPower", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAttackSpeed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "attackSpeed", Type = "number", Nilable = false }, + { Name = "offhandAttackSpeed", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitBattlePetLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitBattlePetSpeciesID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitBattlePetType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitCanAssist", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCanAttack", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCanCooperate", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCanPetBattle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCastingDuration", + Type = "Function", + MayReturnNothing = true, + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "UnitCastingInfo", + Type = "Function", + SecretWhenUnitSpellCastRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + { Name = "textureID", Type = "fileID", Nilable = false }, + { Name = "startTimeMs", Type = "number", Nilable = false }, + { Name = "endTimeMs", Type = "number", Nilable = false }, + { Name = "isTradeskill", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "castID", Type = "WOWGUID", Nilable = false }, + { Name = "notInterruptible", Type = "bool", Nilable = true }, + { Name = "castingSpellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + { Name = "delayTimeMs", Type = "number", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "UnitChannelDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "UnitChannelInfo", + Type = "Function", + SecretWhenUnitSpellCastRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "displayName", Type = "cstring", Nilable = false }, + { Name = "textureID", Type = "fileID", Nilable = false }, + { Name = "startTimeMs", Type = "number", Nilable = false }, + { Name = "endTimeMs", Type = "number", Nilable = false }, + { Name = "isTradeskill", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "notInterruptible", Type = "bool", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "isEmpowered", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "numEmpowerStages", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitChromieTimeID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "ID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitClass", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "className", Type = "cstring", Nilable = false, ConditionalSecret = true }, + { Name = "classFilename", Type = "cstring", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitClassBase", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "classFilename", Type = "cstring", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitClassFromGUID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unitGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "className", Type = "cstring", Nilable = false, ConditionalSecret = true }, + { Name = "classFilename", Type = "cstring", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitClassification", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitControllingVehicle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCreatureFamily", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitCreatureID", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "creatureID", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitCreatureType", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitDamage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "minDamage", Type = "number", Nilable = false }, + { Name = "maxDamage", Type = "number", Nilable = false }, + { Name = "offhandMinDamage", Type = "number", Nilable = false }, + { Name = "offhandMaxDamage", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + { Name = "percent", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitDetailedThreatSituation", + Type = "Function", + MayReturnNothing = true, + SecretWhenUnitThreatValuesRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "mobGUID", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isTanking", Type = "bool", Nilable = false }, + { Name = "status", Type = "number", Nilable = false }, + { Name = "scaledPercentage", Type = "number", Nilable = false }, + { Name = "rawPercentage", Type = "number", Nilable = false }, + { Name = "rawThreat", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitDistanceSquared", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "distance", Type = "number", Nilable = false }, + { Name = "checkedDistance", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitEffectiveLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitEmpoweredChannelDuration", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a duration object that includes the duration of an empowered cast channel." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "includeHoldAtMaxTime", Type = "bool", Nilable = false, Default = true, Documentation = { "If true, include the hold-at-max time of the empowered channel in the total duration." } }, + }, + + Returns = + { + { Name = "duration", Type = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "UnitEmpoweredStageDurations", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a vector of duration objects that measure the time spans for each individual stage in an empowered channel, with hold-at-max time included as the last element." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "table", InnerType = "LuaDurationObject", Nilable = false }, + }, + }, + { + Name = "UnitEmpoweredStagePercentages", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a vector of percentages that describe how much of the total duration of an empowered channel is occupied by a stage." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "includeHoldAtMaxTime", Type = "bool", Nilable = false, Default = true, Documentation = { "If true, include the hold-at-max time of the empowered channel in the total duration and add a percentage value for it." } }, + }, + + Returns = + { + { Name = "percentages", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "UnitExists", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitFactionGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + { Name = "checkDisplayRace", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "factionGroupTag", Type = "cstring", Nilable = false }, + { Name = "localized", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitFullName", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + { Name = "unitServer", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitGUID", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "WOWGUID", Nilable = true }, + }, + }, + { + Name = "UnitGetDetailedHealPrediction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "healerUnit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = true, Documentation = { "If specified, a unit to evaluate as the 'healer' for incoming heal values. If nil, healer values will be zero." } }, + { Name = "healPredictionCalculator", Type = "UnitHealPredictionCalculator", Nilable = false }, + }, + }, + { + Name = "UnitGetIncomingHeals", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "healerGUID", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitGetTotalAbsorbs", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitGetTotalHealAbsorbs", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitGroupRolesAssigned", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitGroupRolesAssignedEnum", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHPPerStamina", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHasRelicSlot", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitHasVehiclePlayerFrameUI", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitHasVehicleUI", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitHealthMax", + Type = "Function", + SecretWhenUnitHealthMaxRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHealthMissing", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Result of UnitHealthMax() - UnitHealth()" }, + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "usePredicted", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHealthPercent", + Type = "Function", + SecretWhenCurveSecret = true, + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns percent of health remaining - can be scaled via a curve for display purposes" }, + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "usePredicted", Type = "bool", Nilable = false, Default = true }, + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false, Documentation = { "If no curve is specified, a floating point percentage value. Else, the result of evaluating the curve with the percentage as the input." } }, + }, + }, + { + Name = "UnitHealth", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "usePredicted", Type = "bool", Nilable = false, Default = true }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHonor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHonorLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHonorMax", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitInAnyGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInBattleground", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "UnitInOtherParty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Checks whether this unit cannot see your party chat because it is in an instance group" }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inOtherParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInParty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInPartyIsAI", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInPartyShard", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inPartyShard", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInRaid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "UnitInRange", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + { Name = "checkedRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInSubgroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInVehicle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInVehicleControlSeat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInVehicleHidesPetFrame", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsAFK", + Type = "Function", + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsBattlePet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = true }, + }, + }, + { + Name = "UnitIsBattlePetCompanion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsBossMob", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsCharmed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsConnected", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isConnected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsControlling", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsCorpse", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDND", + Type = "Function", + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDead", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDeadOrGhost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsEnemy", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsFeignDeath", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsFriend", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsGameObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsGhost", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsGroupAssistant", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isAssistant", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsGroupLeader", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "partyCategory", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsHumanPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsInMyGuild", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsInteractable", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsLieutenant", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsMercenary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsMinion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns whether the unit is considered a minion of a player, such as a pet, totem, or guardian." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsNPCAsPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsOtherPlayersBattlePet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsOtherPlayersPet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsOwnerOrControllerOfUnit", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "controllingUnit", Type = "UnitToken", Nilable = false }, + { Name = "controlledUnit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "unitIsOwnerOrControllerOfUnit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVP", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVPFreeForAll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVPSanctuary", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPossessed", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsQuestBoss", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsRaidOfficer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsSameServer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsSpellTarget", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If the unit is currently casting a spell, returns whether spell's target unit matches the target param. Returns false if the unit is not casting a spell or the spell has no target." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsTapDenied", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsTrivial", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsUnconscious", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsUnit", + Type = "Function", + SecretWhenUnitComparisonRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit1", Type = "UnitToken", Nilable = false }, + { Name = "unit2", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsVisible", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsWildBattlePet", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitLeadsAnyGroup", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitLevel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitName", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + { Name = "unitServer", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitNameFromGUID", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unitGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + { Name = "unitServer", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitNameUnmodified", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "unitName", Type = "cstring", Nilable = false }, + { Name = "unitServer", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitNameplateShowsWidgetsOnly", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "nameplateShowsWidgetsOnly", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitNumPowerBarTimers", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitOnTaxi", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitOwnerGUID", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "ownerGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "UnitPVPName", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitPartialPower", + Type = "Function", + SecretWhenUnitPowerRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "partialPower", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPercentHealthFromGUID", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unitGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "percentHealth", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitPhaseReason", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "reason", Type = "PhaseReason", Nilable = true }, + }, + }, + { + Name = "UnitPlayerControlled", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPlayerOrPetInParty", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPlayerOrPetInRaid", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "partyIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPosition", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "positionX", Type = "number", Nilable = false }, + { Name = "positionY", Type = "number", Nilable = false }, + { Name = "positionZ", Type = "number", Nilable = false }, + { Name = "mapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPower", + Type = "Function", + SecretWhenUnitPowerRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "power", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "barID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarTimerInfo", + Type = "Function", + MayReturnNothing = true, + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "duration", Type = "number", Nilable = false }, + { Name = "expiration", Type = "number", Nilable = false }, + { Name = "barID", Type = "number", Nilable = false }, + { Name = "auraID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerDisplayMod", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "powerType", Type = "PowerType", Nilable = false }, + }, + + Returns = + { + { Name = "displayMod", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerMax", + Type = "Function", + SecretWhenUnitPowerMaxRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "maxPower", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerMissing", + Type = "Function", + SecretWhenUnitPowerRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Result of UnitPowerMax() - UnitPower()" }, + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerPercent", + Type = "Function", + SecretWhenUnitPowerRestricted = true, + SecretWhenCurveSecret = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Queries the percent of power remaining, optionally evaluating it against a supplied curve." }, + + Arguments = + { + { Name = "unitToken", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "powerType", Type = "PowerType", Nilable = true }, + { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false, Documentation = { "If no curve is specified, a floating point percentage value. Else, the result of evaluating the curve with the percentage as the input." } }, + }, + }, + { + Name = "UnitPowerType", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + { Name = "index", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "powerType", Type = "PowerType", Nilable = false }, + { Name = "powerTypeToken", Type = "string", Nilable = false }, + { Name = "rgbX", Type = "number", Nilable = false }, + { Name = "rgbY", Type = "number", Nilable = false }, + { Name = "rgbZ", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPvpClassification", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenNamePlate", Nilable = false }, + }, + + Returns = + { + { Name = "classification", Type = "PvPUnitClassification", Nilable = true }, + }, + }, + { + Name = "UnitQuestTrivialLevelRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "levelRange", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitQuestTrivialLevelRangeScaling", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "levelRange", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRace", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "localizedRaceName", Type = "cstring", Nilable = false }, + { Name = "englishRaceName", Type = "cstring", Nilable = false }, + { Name = "raceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRangedAttackPower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "attackPower", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRangedDamage", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "speed", Type = "number", Nilable = false }, + { Name = "minDamage", Type = "number", Nilable = false }, + { Name = "maxDamage", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + { Name = "percent", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitReaction", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "UnitRealmRelationship", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "realmRelationship", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "UnitSelectionColor", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "useExtendedColors", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "resultR", Type = "number", Nilable = false }, + { Name = "resultG", Type = "number", Nilable = false }, + { Name = "resultB", Type = "number", Nilable = false }, + { Name = "resultA", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSelectionType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "useExtendedColors", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSex", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "sex", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitSexBase", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "sex", Type = "UnitSex", Nilable = true }, + }, + }, + { + Name = "UnitShouldDisplayName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitShouldDisplaySpellTargetName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If the unit is currently casting a spell, returns whether the target's name should be displayed. Returns false if the unit is not casting a spell or the spell has no target." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitSpellHaste", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSpellTargetClass", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If the unit is currently casting a spell, returns the class of the spell's target unit. Returns nil if the unit is not casting a spell or the spell has no target." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "classFilename", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitSpellTargetName", + Type = "Function", + SecretReturns = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "If the unit is currently casting a spell, returns the name of the spell's target unit. Returns nil if the unit is not casting a spell or the spell has no target." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "targetName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitStagger", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitTokenPvPRestrictedForAddOns", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false, ConditionalSecret = true }, + }, + }, + { + Name = "UnitStat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "currentStat", Type = "number", Nilable = false }, + { Name = "effectiveStat", Type = "number", Nilable = false }, + { Name = "statPositiveBuff", Type = "number", Nilable = false }, + { Name = "statNegativeBuff", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSwitchToVehicleSeat", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "virtualSeatIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "UnitTargetsVehicleInRaidUI", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitThreatLeadSituation", + Type = "Function", + SecretWhenUnitThreatStateRestricted = true, + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Returns a threat state (0-3; representing none, yellow, orange, red) that indicates how far the provided unit is above the secondmost threat on the provided mob. If the unit is not first on threat, will always return red. Can return nil if the provided mob does not exist." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "mobGUID", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitThreatPercentageOfLead", + Type = "Function", + SecretWhenUnitThreatValuesRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "mobGUID", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitThreatSituation", + Type = "Function", + SecretWhenUnitThreatStateRestricted = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "mobGUID", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = true }, + }, + }, + { + Name = "UnitTokenFromGUID", + Type = "Function", + SecretWhenUnitIdentityRestricted = true, + SecretArguments = "AllowedWhenTainted", + + Arguments = + { + { Name = "unitGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "unitToken", Type = "string", Nilable = true }, + }, + }, + { + Name = "UnitTreatAsPlayerForDisplay", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "treatAsPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitTrialBankedLevels", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "bankedLevels", Type = "number", Nilable = false }, + { Name = "xpIntoCurrentLevel", Type = "number", Nilable = false }, + { Name = "xpForNextLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitTrialXP", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitUsingVehicle", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitVehicleSeatCount", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitVehicleSeatInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "virtualSeatIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "controlType", Type = "cstring", Nilable = false }, + { Name = "occupantName", Type = "cstring", Nilable = false }, + { Name = "serverName", Type = "cstring", Nilable = false }, + { Name = "ejectable", Type = "bool", Nilable = false }, + { Name = "canSwitchSeats", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitVehicleSkin", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "fileID", Nilable = false }, + }, + }, + { + Name = "UnitWeaponAttackPower", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "mainHandWeaponAttackPower", Type = "number", Nilable = false }, + { Name = "offHandWeaponAttackPower", Type = "number", Nilable = false }, + { Name = "rangedWeaponAttackPower", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitWidgetSet", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "uiWidgetSet", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitXP", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitXPMax", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "WorldLootObjectExists", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActivePlayerSpecializationChanged", + Type = "Event", + LiteralName = "ACTIVE_PLAYER_SPECIALIZATION_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ArenaCooldownsUpdate", + Type = "Event", + LiteralName = "ARENA_COOLDOWNS_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "ArenaCrowdControlSpellUpdate", + Type = "Event", + LiteralName = "ARENA_CROWD_CONTROL_SPELL_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "AutofollowBegin", + Type = "Event", + LiteralName = "AUTOFOLLOW_BEGIN", + SynchronousEvent = true, + Payload = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "AutofollowEnd", + Type = "Event", + LiteralName = "AUTOFOLLOW_END", + SynchronousEvent = true, + }, + { + Name = "CancelSummon", + Type = "Event", + LiteralName = "CANCEL_SUMMON", + SynchronousEvent = true, + }, + { + Name = "ComboTargetChanged", + Type = "Event", + LiteralName = "COMBO_TARGET_CHANGED", + SynchronousEvent = true, + }, + { + Name = "ConfirmBinder", + Type = "Event", + LiteralName = "CONFIRM_BINDER", + SynchronousEvent = true, + Payload = + { + { Name = "areaName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "ConfirmSummon", + Type = "Event", + LiteralName = "CONFIRM_SUMMON", + SynchronousEvent = true, + Payload = + { + { Name = "summonReason", Type = "number", Nilable = false }, + { Name = "skippingStartExperience", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EclipseDirectionChange", + Type = "Event", + LiteralName = "ECLIPSE_DIRECTION_CHANGE", + SynchronousEvent = true, + Payload = + { + { Name = "direction", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "HearthstoneBound", + Type = "Event", + LiteralName = "HEARTHSTONE_BOUND", + SynchronousEvent = true, + }, + { + Name = "HonorXpUpdate", + Type = "Event", + LiteralName = "HONOR_XP_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "IncomingResurrectChanged", + Type = "Event", + LiteralName = "INCOMING_RESURRECT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "IncomingSummonChanged", + Type = "Event", + LiteralName = "INCOMING_SUMMON_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "KnownTitlesUpdate", + Type = "Event", + LiteralName = "KNOWN_TITLES_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "LocalplayerPetRenamed", + Type = "Event", + LiteralName = "LOCALPLAYER_PET_RENAMED", + SynchronousEvent = true, + }, + { + Name = "MirrorTimerPause", + Type = "Event", + LiteralName = "MIRROR_TIMER_PAUSE", + SynchronousEvent = true, + Payload = + { + { Name = "timerName", Type = "cstring", Nilable = false }, + { Name = "paused", Type = "number", Nilable = false }, + }, + }, + { + Name = "MirrorTimerStart", + Type = "Event", + LiteralName = "MIRROR_TIMER_START", + SynchronousEvent = true, + Payload = + { + { Name = "timerName", Type = "cstring", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + { Name = "maxValue", Type = "number", Nilable = false }, + { Name = "scale", Type = "number", Nilable = false }, + { Name = "paused", Type = "number", Nilable = false }, + { Name = "timerLabel", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "MirrorTimerStop", + Type = "Event", + LiteralName = "MIRROR_TIMER_STOP", + SynchronousEvent = true, + Payload = + { + { Name = "timerName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "NeutralFactionSelectResult", + Type = "Event", + LiteralName = "NEUTRAL_FACTION_SELECT_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ObjectEnteredAOI", + Type = "Event", + LiteralName = "OBJECT_ENTERED_AOI", + SynchronousEvent = true, + Payload = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ObjectLeftAOI", + Type = "Event", + LiteralName = "OBJECT_LEFT_AOI", + SynchronousEvent = true, + Payload = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PartyKill", + Type = "Event", + LiteralName = "PARTY_KILL", + SecretWhenUnitIdentityRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "attackerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "targetGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PetBarUpdateUsable", + Type = "Event", + LiteralName = "PET_BAR_UPDATE_USABLE", + SynchronousEvent = true, + }, + { + Name = "PetUiUpdate", + Type = "Event", + LiteralName = "PET_UI_UPDATE", + SynchronousEvent = true, + }, + { + Name = "PlayerCanGlideChanged", + Type = "Event", + LiteralName = "PLAYER_CAN_GLIDE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "canGlide", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerDamageDoneMods", + Type = "Event", + LiteralName = "PLAYER_DAMAGE_DONE_MODS", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerEnterCombat", + Type = "Event", + LiteralName = "PLAYER_ENTER_COMBAT", + SynchronousEvent = true, + }, + { + Name = "PlayerFarsightFocusChanged", + Type = "Event", + LiteralName = "PLAYER_FARSIGHT_FOCUS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerFlagsChanged", + Type = "Event", + LiteralName = "PLAYER_FLAGS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerFocusChanged", + Type = "Event", + LiteralName = "PLAYER_FOCUS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerImpulseApplied", + Type = "Event", + LiteralName = "PLAYER_IMPULSE_APPLIED", + SynchronousEvent = true, + }, + { + Name = "PlayerIsGlidingChanged", + Type = "Event", + LiteralName = "PLAYER_IS_GLIDING_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isGliding", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerLeaveCombat", + Type = "Event", + LiteralName = "PLAYER_LEAVE_COMBAT", + SynchronousEvent = true, + }, + { + Name = "PlayerLevelChanged", + Type = "Event", + LiteralName = "PLAYER_LEVEL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "oldLevel", Type = "number", Nilable = false }, + { Name = "newLevel", Type = "number", Nilable = false }, + { Name = "real", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerLevelUp", + Type = "Event", + LiteralName = "PLAYER_LEVEL_UP", + SynchronousEvent = true, + Payload = + { + { Name = "level", Type = "number", Nilable = false }, + { Name = "healthDelta", Type = "number", Nilable = false }, + { Name = "powerDelta", Type = "number", Nilable = false }, + { Name = "numNewTalents", Type = "number", Nilable = false }, + { Name = "numNewPvpTalentSlots", Type = "number", Nilable = false }, + { Name = "strengthDelta", Type = "number", Nilable = false }, + { Name = "agilityDelta", Type = "number", Nilable = false }, + { Name = "staminaDelta", Type = "number", Nilable = false }, + { Name = "intellectDelta", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerMaxLevelUpdate", + Type = "Event", + LiteralName = "PLAYER_MAX_LEVEL_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerMountDisplayChanged", + Type = "Event", + LiteralName = "PLAYER_MOUNT_DISPLAY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerPvpKillsChanged", + Type = "Event", + LiteralName = "PLAYER_PVP_KILLS_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerPvpRankChanged", + Type = "Event", + LiteralName = "PLAYER_PVP_RANK_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerRegenDisabled", + Type = "Event", + LiteralName = "PLAYER_REGEN_DISABLED", + SynchronousEvent = true, + }, + { + Name = "PlayerRegenEnabled", + Type = "Event", + LiteralName = "PLAYER_REGEN_ENABLED", + SynchronousEvent = true, + }, + { + Name = "PlayerSoftEnemyChanged", + Type = "Event", + LiteralName = "PLAYER_SOFT_ENEMY_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerSoftFriendChanged", + Type = "Event", + LiteralName = "PLAYER_SOFT_FRIEND_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerSoftInteractChanged", + Type = "Event", + LiteralName = "PLAYER_SOFT_INTERACT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "oldTarget", Type = "WOWGUID", Nilable = false }, + { Name = "newTarget", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "PlayerSoftTargetInteraction", + Type = "Event", + LiteralName = "PLAYER_SOFT_TARGET_INTERACTION", + SynchronousEvent = true, + }, + { + Name = "PlayerSpecializationChanged", + Type = "Event", + LiteralName = "PLAYER_SPECIALIZATION_CHANGED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerStartedLooking", + Type = "Event", + LiteralName = "PLAYER_STARTED_LOOKING", + SynchronousEvent = true, + }, + { + Name = "PlayerStartedMoving", + Type = "Event", + LiteralName = "PLAYER_STARTED_MOVING", + SynchronousEvent = true, + }, + { + Name = "PlayerStartedTurning", + Type = "Event", + LiteralName = "PLAYER_STARTED_TURNING", + SynchronousEvent = true, + }, + { + Name = "PlayerStoppedLooking", + Type = "Event", + LiteralName = "PLAYER_STOPPED_LOOKING", + SynchronousEvent = true, + }, + { + Name = "PlayerStoppedMoving", + Type = "Event", + LiteralName = "PLAYER_STOPPED_MOVING", + SynchronousEvent = true, + }, + { + Name = "PlayerStoppedTurning", + Type = "Event", + LiteralName = "PLAYER_STOPPED_TURNING", + SynchronousEvent = true, + }, + { + Name = "PlayerTargetChanged", + Type = "Event", + LiteralName = "PLAYER_TARGET_CHANGED", + SynchronousEvent = true, + }, + { + Name = "PlayerTrialXpUpdate", + Type = "Event", + LiteralName = "PLAYER_TRIAL_XP_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PlayerUpdateResting", + Type = "Event", + LiteralName = "PLAYER_UPDATE_RESTING", + SynchronousEvent = true, + }, + { + Name = "PlayerXpUpdate", + Type = "Event", + LiteralName = "PLAYER_XP_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "PortraitsUpdated", + Type = "Event", + LiteralName = "PORTRAITS_UPDATED", + UniqueEvent = true, + }, + { + Name = "ProvingGroundsScoreUpdate", + Type = "Event", + LiteralName = "PROVING_GROUNDS_SCORE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "points", Type = "number", Nilable = false }, + }, + }, + { + Name = "PvpTimerUpdate", + Type = "Event", + LiteralName = "PVP_TIMER_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "RunePowerUpdate", + Type = "Event", + LiteralName = "RUNE_POWER_UPDATE", + SecretPayloads = true, + SynchronousEvent = true, + Payload = + { + { Name = "runeIndex", Type = "number", Nilable = false }, + { Name = "added", Type = "bool", Nilable = true }, + }, + }, + { + Name = "RuneTypeUpdate", + Type = "Event", + LiteralName = "RUNE_TYPE_UPDATE", + SecretPayloads = true, + SynchronousEvent = true, + Payload = + { + { Name = "runeIndex", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShowFactionSelectUi", + Type = "Event", + LiteralName = "SHOW_FACTION_SELECT_UI", + SynchronousEvent = true, + }, + { + Name = "SpellConfirmationPrompt", + Type = "Event", + LiteralName = "SPELL_CONFIRMATION_PROMPT", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "effectValue", Type = "number", Nilable = false }, + { Name = "message", Type = "cstring", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "currencyTypesID", Type = "number", Nilable = false }, + { Name = "currencyCost", Type = "number", Nilable = false }, + { Name = "currentDifficulty", Type = "number", Nilable = false }, + }, + }, + { + Name = "SpellConfirmationTimeout", + Type = "Event", + LiteralName = "SPELL_CONFIRMATION_TIMEOUT", + SynchronousEvent = true, + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "effectValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAbsorbAmountChanged", + Type = "Event", + LiteralName = "UNIT_ABSORB_AMOUNT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitAreaChanged", + Type = "Event", + LiteralName = "UNIT_AREA_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitAttack", + Type = "Event", + LiteralName = "UNIT_ATTACK", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitAttackPower", + Type = "Event", + LiteralName = "UNIT_ATTACK_POWER", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitAttackSpeed", + Type = "Event", + LiteralName = "UNIT_ATTACK_SPEED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitCheatToggleEvent", + Type = "Event", + LiteralName = "UNIT_CHEAT_TOGGLE_EVENT", + SynchronousEvent = true, + }, + { + Name = "UnitClassificationChanged", + Type = "Event", + LiteralName = "UNIT_CLASSIFICATION_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitCombat", + Type = "Event", + LiteralName = "UNIT_COMBAT", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "event", Type = "cstring", Nilable = false }, + { Name = "flagText", Type = "cstring", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + { Name = "schoolMask", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitConnection", + Type = "Event", + LiteralName = "UNIT_CONNECTION", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "isConnected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCtrOptions", + Type = "Event", + LiteralName = "UNIT_CTR_OPTIONS", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitDamage", + Type = "Event", + LiteralName = "UNIT_DAMAGE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitDefense", + Type = "Event", + LiteralName = "UNIT_DEFENSE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitDied", + Type = "Event", + LiteralName = "UNIT_DIED", + SecretWhenUnitIdentityRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "UnitDisplaypower", + Type = "Event", + LiteralName = "UNIT_DISPLAYPOWER", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitDistanceCheckUpdate", + Type = "Event", + LiteralName = "UNIT_DISTANCE_CHECK_UPDATE", + SecretPayloads = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "isInDistance", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitFaction", + Type = "Event", + LiteralName = "UNIT_FACTION", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitFlags", + Type = "Event", + LiteralName = "UNIT_FLAGS", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitFormChanged", + Type = "Event", + LiteralName = "UNIT_FORM_CHANGED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitHealAbsorbAmountChanged", + Type = "Event", + LiteralName = "UNIT_HEAL_ABSORB_AMOUNT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitHealPrediction", + Type = "Event", + LiteralName = "UNIT_HEAL_PREDICTION", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitHealth", + Type = "Event", + LiteralName = "UNIT_HEALTH", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitInRangeUpdate", + Type = "Event", + LiteralName = "UNIT_IN_RANGE_UPDATE", + SecretPayloads = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "isInRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInventoryChanged", + Type = "Event", + LiteralName = "UNIT_INVENTORY_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitLevel", + Type = "Event", + LiteralName = "UNIT_LEVEL", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitLoot", + Type = "Event", + LiteralName = "UNIT_LOOT", + SynchronousEvent = true, + Payload = + { + { Name = "unitGUID", Type = "WOWGUID", Nilable = false }, + { Name = "hasLoot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitMana", + Type = "Event", + LiteralName = "UNIT_MANA", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitMaxHealthModifiersChanged", + Type = "Event", + LiteralName = "UNIT_MAX_HEALTH_MODIFIERS_CHANGED", + SecretPayloads = true, + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "percentMaxHealthAdjusted", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitMaxhealth", + Type = "Event", + LiteralName = "UNIT_MAXHEALTH", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitMaxpower", + Type = "Event", + LiteralName = "UNIT_MAXPOWER", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "powerType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitModelChanged", + Type = "Event", + LiteralName = "UNIT_MODEL_CHANGED", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitNameUpdate", + Type = "Event", + LiteralName = "UNIT_NAME_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitOtherPartyChanged", + Type = "Event", + LiteralName = "UNIT_OTHER_PARTY_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPet", + Type = "Event", + LiteralName = "UNIT_PET", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPetExperience", + Type = "Event", + LiteralName = "UNIT_PET_EXPERIENCE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPhase", + Type = "Event", + LiteralName = "UNIT_PHASE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPortraitUpdate", + Type = "Event", + LiteralName = "UNIT_PORTRAIT_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarHide", + Type = "Event", + LiteralName = "UNIT_POWER_BAR_HIDE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarShow", + Type = "Event", + LiteralName = "UNIT_POWER_BAR_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarTimerUpdate", + Type = "Event", + LiteralName = "UNIT_POWER_BAR_TIMER_UPDATE", + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPowerFrequent", + Type = "Event", + LiteralName = "UNIT_POWER_FREQUENT", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "powerType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitPowerPointCharge", + Type = "Event", + LiteralName = "UNIT_POWER_POINT_CHARGE", + SecretWhenUnitPowerRestricted = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitPowerUpdate", + Type = "Event", + LiteralName = "UNIT_POWER_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "powerType", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "UnitQuestLogChanged", + Type = "Event", + LiteralName = "UNIT_QUEST_LOG_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitRangedAttackPower", + Type = "Event", + LiteralName = "UNIT_RANGED_ATTACK_POWER", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitRangeddamage", + Type = "Event", + LiteralName = "UNIT_RANGEDDAMAGE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitResistances", + Type = "Event", + LiteralName = "UNIT_RESISTANCES", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitSpellHaste", + Type = "Event", + LiteralName = "UNIT_SPELL_HASTE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastChannelStart", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_CHANNEL_START", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastChannelStop", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_CHANNEL_STOP", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "interruptedBy", Type = "WOWGUID", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastChannelUpdate", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_CHANNEL_UPDATE", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastDelayed", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_DELAYED", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastEmpowerStart", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_EMPOWER_START", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastEmpowerStop", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_EMPOWER_STOP", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "complete", Type = "bool", Nilable = false }, + { Name = "interruptedBy", Type = "WOWGUID", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastEmpowerUpdate", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_EMPOWER_UPDATE", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastFailed", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_FAILED", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastFailedQuiet", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_FAILED_QUIET", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastInterrupted", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_INTERRUPTED", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "interruptedBy", Type = "WOWGUID", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastInterruptible", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_INTERRUPTIBLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastNotInterruptible", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_NOT_INTERRUPTIBLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastReticleClear", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_RETICLE_CLEAR", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastReticleTarget", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_RETICLE_TARGET", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastSent", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_SENT", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "target", Type = "cstring", Nilable = false, ConditionalSecret = true }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastStart", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_START", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastStop", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_STOP", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitSpellcastSucceeded", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_SUCCEEDED", + SecretWhenUnitSpellCastRestricted = true, + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "castGUID", Type = "WOWGUID", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitStats", + Type = "Event", + LiteralName = "UNIT_STATS", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitTarget", + Type = "Event", + LiteralName = "UNIT_TARGET", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitTargetableChanged", + Type = "Event", + LiteralName = "UNIT_TARGETABLE_CHANGED", + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitThreatListUpdate", + Type = "Event", + LiteralName = "UNIT_THREAT_LIST_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitThreatSituationUpdate", + Type = "Event", + LiteralName = "UNIT_THREAT_SITUATION_UPDATE", + SynchronousEvent = true, + UniqueEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UpdateExhaustion", + Type = "Event", + LiteralName = "UPDATE_EXHAUSTION", + SynchronousEvent = true, + }, + { + Name = "UpdateMouseoverUnit", + Type = "Event", + LiteralName = "UPDATE_MOUSEOVER_UNIT", + SynchronousEvent = true, + }, + { + Name = "UpdateStealth", + Type = "Event", + LiteralName = "UPDATE_STEALTH", + SynchronousEvent = true, + }, + { + Name = "VehicleAngleUpdate", + Type = "Event", + LiteralName = "VEHICLE_ANGLE_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "normalizedPitch", Type = "number", Nilable = false }, + { Name = "radians", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "PhaseReason", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Phasing", Type = "PhaseReason", EnumValue = 0 }, + { Name = "Sharding", Type = "PhaseReason", EnumValue = 1 }, + { Name = "WarMode", Type = "PhaseReason", EnumValue = 2 }, + { Name = "ChromieTime", Type = "PhaseReason", EnumValue = 3 }, + { Name = "TimerunningHwt", Type = "PhaseReason", EnumValue = 4 }, + }, + }, + { + Name = "PvPUnitClassification", + Type = "Enumeration", + NumValues = 11, + MinValue = 0, + MaxValue = 10, + Fields = + { + { Name = "FlagCarrierHorde", Type = "PvPUnitClassification", EnumValue = 0 }, + { Name = "FlagCarrierAlliance", Type = "PvPUnitClassification", EnumValue = 1 }, + { Name = "FlagCarrierNeutral", Type = "PvPUnitClassification", EnumValue = 2 }, + { Name = "CartRunnerHorde", Type = "PvPUnitClassification", EnumValue = 3 }, + { Name = "CartRunnerAlliance", Type = "PvPUnitClassification", EnumValue = 4 }, + { Name = "AssassinHorde", Type = "PvPUnitClassification", EnumValue = 5 }, + { Name = "AssassinAlliance", Type = "PvPUnitClassification", EnumValue = 6 }, + { Name = "OrbCarrierBlue", Type = "PvPUnitClassification", EnumValue = 7 }, + { Name = "OrbCarrierGreen", Type = "PvPUnitClassification", EnumValue = 8 }, + { Name = "OrbCarrierOrange", Type = "PvPUnitClassification", EnumValue = 9 }, + { Name = "OrbCarrierPurple", Type = "PvPUnitClassification", EnumValue = 10 }, + }, + }, + { + Name = "CorruptionEffectInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "minCorruption", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitCastingInfoResult", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + { Name = "textureID", Type = "fileID", Nilable = false }, + { Name = "startTimeMs", Type = "number", Nilable = false }, + { Name = "endTimeMs", Type = "number", Nilable = false }, + { Name = "isTradeskill", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "castID", Type = "WOWGUID", Nilable = false }, + { Name = "notInterruptible", Type = "bool", Nilable = true }, + { Name = "castingSpellID", Type = "number", Nilable = false }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + { Name = "delayTimeMs", Type = "number", Nilable = false, NeverSecret = true }, + }, + }, + { + Name = "UnitChannelInfoResult", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "displayName", Type = "cstring", Nilable = false }, + { Name = "textureID", Type = "fileID", Nilable = false }, + { Name = "startTimeMs", Type = "number", Nilable = false }, + { Name = "endTimeMs", Type = "number", Nilable = false }, + { Name = "isTradeskill", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "notInterruptible", Type = "bool", Nilable = true }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "isEmpowered", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "numEmpowerStages", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "castBarID", Type = "number", Nilable = true, NeverSecret = true }, + }, + }, + { + Name = "UnitCreatureFamilyResult", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitCreatureTypeResult", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarInfo", + Type = "Structure", + Fields = + { + { Name = "ID", Type = "number", Nilable = false }, + { Name = "barType", Type = "number", Nilable = false }, + { Name = "minPower", Type = "number", Nilable = false }, + { Name = "startInset", Type = "number", Nilable = false }, + { Name = "endInset", Type = "number", Nilable = false }, + { Name = "smooth", Type = "bool", Nilable = false }, + { Name = "hideFromOthers", Type = "bool", Nilable = false }, + { Name = "showOnRaid", Type = "bool", Nilable = false }, + { Name = "opaqueSpark", Type = "bool", Nilable = false }, + { Name = "opaqueFlash", Type = "bool", Nilable = false }, + { Name = "anchorTop", Type = "bool", Nilable = false }, + { Name = "forcePercentage", Type = "bool", Nilable = false }, + { Name = "sparkUnderFrame", Type = "bool", Nilable = false }, + { Name = "flashAtMinPower", Type = "bool", Nilable = false }, + { Name = "fractionalCounter", Type = "bool", Nilable = false }, + { Name = "animateNumbers", Type = "bool", Nilable = false }, + { Name = "attachTooltipToBar", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Unit); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorAPIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorAPIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..ee6fa01 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorAPIDocumentation.lua.annotated.lua @@ -0,0 +1,490 @@ +local UnitHealPredictionCalculatorAPI = +{ + Name = "UnitHealPredictionCalculatorAPI", + Type = "ScriptObject", + Environment = "All", + + Functions = + { + { + Name = "EvaluateCurrentHealthPercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the percentage of current unit health and evaluates it against the supplied curve." }, + + Arguments = + { + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false }, + }, + }, + { + Name = "EvaluateMissingHealthPercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Calculates the percentage of missing unit health and evaluates it against the supplied curve." }, + + Arguments = + { + { Name = "curve", Type = "LuaCurveObjectBase", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "LuaCurveEvaluatedResult", Nilable = false }, + }, + }, + { + Name = "GetCurrentHealth", + Type = "Function", + Documentation = { "Returns the base amount of unit health." }, + + Arguments = + { + }, + + Returns = + { + { Name = "currentHealth", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentHealthPercent", + Type = "Function", + Documentation = { "Returns the percentage of current unit health." }, + + Arguments = + { + }, + + Returns = + { + { Name = "currentHealthPercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDamageAbsorbClampMode", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns the configured damage absorb clamping mode." }, + + Arguments = + { + }, + + Returns = + { + { Name = "damageAbsorbClampMode", Type = "UnitDamageAbsorbClampMode", Nilable = false }, + }, + }, + { + Name = "GetDamageAbsorbs", + Type = "Function", + Documentation = { "Calculates damage absorb values and clamping according to the configured options." }, + + Arguments = + { + }, + + Returns = + { + { Name = "amount", Type = "number", Nilable = false, Documentation = { "Amount of applied damage absorb affects with potential reductions from clamping included." } }, + { Name = "clamped", Type = "bool", Nilable = false, Documentation = { "If true, the value is in excess of the clamp boundary." } }, + }, + }, + { + Name = "GetHealAbsorbClampMode", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns the configured heal absorb clamping mode." }, + + Arguments = + { + }, + + Returns = + { + { Name = "healAbsorbClampMode", Type = "UnitHealAbsorbClampMode", Nilable = false }, + }, + }, + { + Name = "GetHealAbsorbMode", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns the configured heal absorb processing mode." }, + + Arguments = + { + }, + + Returns = + { + { Name = "healAbsorbMode", Type = "UnitHealAbsorbMode", Nilable = false }, + }, + }, + { + Name = "GetHealAbsorbs", + Type = "Function", + Documentation = { "Calculates heal absorb values and clamping according to the configured options." }, + + Arguments = + { + }, + + Returns = + { + { Name = "amount", Type = "number", Nilable = false, Documentation = { "Amount of applied heal absorb affects with potential reductions from incoming heals and clamping included." } }, + { Name = "clamped", Type = "bool", Nilable = false, Documentation = { "If true, the value is in excess of the clamp boundary." } }, + }, + }, + { + Name = "GetIncomingHealClampMode", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns the configured incoming heal clamping mode." }, + + Arguments = + { + }, + + Returns = + { + { Name = "incomingHealClampMode", Type = "UnitIncomingHealClampMode", Nilable = false }, + }, + }, + { + Name = "GetIncomingHealOverflowPercent", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns the configured incoming heal maximum overflow percentage." }, + + Arguments = + { + }, + + Returns = + { + { Name = "incomingHealOverflowPercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIncomingHeals", + Type = "Function", + Documentation = { "Calculates incoming heal values and clamping according to the configured options." }, + + Arguments = + { + }, + + Returns = + { + { Name = "amount", Type = "number", Nilable = false, Documentation = { "Amount of incoming heals across all units with potential reductions from heal absorb effects included." } }, + { Name = "amountFromHealer", Type = "number", Nilable = false, Documentation = { "Amount of incoming heals from the healer unit. Will never exceed the all-units value." } }, + { Name = "amountFromOthers", Type = "number", Nilable = false, Documentation = { "Amount of incoming heals from units other than theh healer. Calculated as the difference between amount and amount-from-healer." } }, + { Name = "clamped", Type = "bool", Nilable = false, Documentation = { "If true, the value is in excess of the clamp boundary." } }, + }, + }, + { + Name = "GetMaximumDamageAbsorbs", + Type = "Function", + Documentation = { "Returns the maximum clamping amount for damage absorbs." }, + + Arguments = + { + }, + + Returns = + { + { Name = "maximumDamageAbsorbs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaximumHealAbsorbs", + Type = "Function", + Documentation = { "Returns the maximum clamping amount for heal absorbs." }, + + Arguments = + { + }, + + Returns = + { + { Name = "maximumHealAbsorbs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaximumHealth", + Type = "Function", + Documentation = { "Returns the base amount of maximum unit health." }, + + Arguments = + { + }, + + Returns = + { + { Name = "maximumHealth", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaximumHealthMode", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns the configured maximum health mode." }, + + Arguments = + { + }, + + Returns = + { + { Name = "maximumHealthMode", Type = "UnitMaximumHealthMode", Nilable = false }, + }, + }, + { + Name = "GetMaximumIncomingHeals", + Type = "Function", + Documentation = { "Returns the maximum clamping amount for incoming heals." }, + + Arguments = + { + }, + + Returns = + { + { Name = "maximumIncomingHeals", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMissingHealth", + Type = "Function", + Documentation = { "Returns the base amount of missing unit health." }, + + Arguments = + { + }, + + Returns = + { + { Name = "missingHealth", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMissingHealthPercent", + Type = "Function", + Documentation = { "Returns the percentage of missing unit health." }, + + Arguments = + { + }, + + Returns = + { + { Name = "missingHealthPercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPredictedValues", + Type = "Function", + Documentation = { "Returns the raw total figures used for data calculations." }, + + Arguments = + { + }, + + Returns = + { + { Name = "predictedValues", Type = "UnitHealPredictionValues", Nilable = false }, + }, + }, + { + Name = "GetTotalDamageAbsorbs", + Type = "Function", + Documentation = { "Returns the base total amount of all applied damage absorb shields." }, + + Arguments = + { + }, + + Returns = + { + { Name = "totalDamageAbsorbs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotalHealAbsorbs", + Type = "Function", + Documentation = { "Returns the base total amount of all applied heal absorption effects." }, + + Arguments = + { + }, + + Returns = + { + { Name = "totalHealAbsorbs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotalIncomingHeals", + Type = "Function", + Documentation = { "Returns the base total amount of all incoming heals." }, + + Arguments = + { + }, + + Returns = + { + { Name = "totalIncomingHeals", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotalIncomingHealsFromHealer", + Type = "Function", + Documentation = { "Returns the base total amount of all incoming heals from the healer unit, if any." }, + + Arguments = + { + }, + + Returns = + { + { Name = "totalIncomingHealsFromHealer", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasSecretValues", + Type = "Function", + ReturnsNeverSecret = true, + Documentation = { "Returns true if the object has been configured with any secret values." }, + + Arguments = + { + }, + + Returns = + { + { Name = "hasSecretValues", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Reset", + Type = "Function", + Documentation = { "Resets all stored state on the object." }, + + Arguments = + { + }, + }, + { + Name = "ResetPredictedValues", + Type = "Function", + Documentation = { "Resets all stored healing values used for calculations." }, + + Arguments = + { + }, + }, + { + Name = "SetDamageAbsorbClampMode", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the clamping mode used when calculating damage absorb amounts." }, + + Arguments = + { + { Name = "damageAbsorbClampMode", Type = "UnitDamageAbsorbClampMode", Nilable = false }, + }, + }, + { + Name = "SetHealAbsorbClampMode", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the clamping mode used when calculating heal absorb amounts." }, + + Arguments = + { + { Name = "healAbsorbClampMode", Type = "UnitHealAbsorbClampMode", Nilable = false }, + }, + }, + { + Name = "SetHealAbsorbMode", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the processing mode used when calculating both heal absorb and incoming heal amounts." }, + + Arguments = + { + { Name = "healAbsorbMode", Type = "UnitHealAbsorbMode", Nilable = false }, + }, + }, + { + Name = "SetIncomingHealClampMode", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the clamping mode used when calculating incoming heal amounts." }, + + Arguments = + { + { Name = "incomingHealClampMode", Type = "UnitIncomingHealClampMode", Nilable = false }, + }, + }, + { + Name = "SetIncomingHealOverflowPercent", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the maximum overflow percentage for incoming heals. Increasing this to a value over 1.0 will mean that incoming heals can extend beyond maximum health." }, + + Arguments = + { + { Name = "incomingHealOverflowPercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMaximumHealthMode", + Type = "Function", + SecretArguments = "NotAllowed", + Documentation = { "Changes the calculation mode for maximum health values used for clamping." }, + + Arguments = + { + { Name = "maximumHealthMode", Type = "UnitMaximumHealthMode", Nilable = false }, + }, + }, + { + Name = "SetPredictedValues", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Sets the healing values used for all calculations." }, + + Arguments = + { + { Name = "predictedValues", Type = "UnitHealPredictionValues", Nilable = false }, + }, + }, + { + Name = "SetToDefaults", + Type = "Function", + Documentation = { "Resets all state on the object, and clears the secret values flag." }, + + Arguments = + { + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UnitHealPredictionCalculatorAPI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..e13f47e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitHealPredictionCalculatorSharedDocumentation.lua.annotated.lua @@ -0,0 +1,111 @@ +local UnitHealPredictionCalculatorShared = +{ + Tables = + { + { + Name = "UnitDamageAbsorbClampMode", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "MissingHealth", Type = "UnitDamageAbsorbClampMode", EnumValue = 0, Documentation = { "Clamp damage absorb values to the amount of missing health with incoming heals subtracted." } }, + { Name = "MissingHealthWithoutIncomingHeals", Type = "UnitDamageAbsorbClampMode", EnumValue = 1, Documentation = { "Clamp damage absorb values to the amount of missing health. Incoming heals do not decrease missing health." } }, + { Name = "MaximumHealth", Type = "UnitDamageAbsorbClampMode", EnumValue = 2, Documentation = { "Clamp damage absorb values to the amount of maximum health." } }, + }, + }, + { + Name = "UnitHealAbsorbClampMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "CurrentHealth", Type = "UnitHealAbsorbClampMode", EnumValue = 0, Documentation = { "Clamp heal absorb values to the amount of current health." } }, + { Name = "MaximumHealth", Type = "UnitHealAbsorbClampMode", EnumValue = 1, Documentation = { "Clamp heal absorb values to the amount of maximum health." } }, + }, + }, + { + Name = "UnitHealAbsorbMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "ReducedByIncomingHeals", Type = "UnitHealAbsorbMode", EnumValue = 0, Documentation = { "Reduce heal absorb values by incoming heals, and vice versa, clamping to zero where necessary." } }, + { Name = "Total", Type = "UnitHealAbsorbMode", EnumValue = 1, Documentation = { "Use heal absorb and incoming heal values as-is without any reductions." } }, + }, + }, + { + Name = "UnitIncomingHealClampMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "MissingHealth", Type = "UnitIncomingHealClampMode", EnumValue = 0, Documentation = { "Clamp incoming heal values to the amount of missing health with overflow applied." } }, + { Name = "MaximumHealth", Type = "UnitIncomingHealClampMode", EnumValue = 1, Documentation = { "Clamp incoming heal values to the amount of maximum health." } }, + }, + }, + { + Name = "UnitMaximumHealthMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Default", Type = "UnitMaximumHealthMode", EnumValue = 0, Documentation = { "Use maximum unit health as-is without adjustments." } }, + { Name = "WithAbsorbs", Type = "UnitMaximumHealthMode", EnumValue = 1, Documentation = { "Use maximum unit health with total damage absorb shields added." } }, + }, + }, + { + Name = "UnitDamageAbsorbInfo", + Type = "Structure", + Fields = + { + { Name = "amount", Type = "number", Nilable = false, Documentation = { "Amount of applied damage absorb affects with potential reductions from clamping included." } }, + { Name = "clamped", Type = "bool", Nilable = false, Documentation = { "If true, the value is in excess of the clamp boundary." } }, + }, + }, + { + Name = "UnitHealAbsorbInfo", + Type = "Structure", + Fields = + { + { Name = "amount", Type = "number", Nilable = false, Documentation = { "Amount of applied heal absorb affects with potential reductions from incoming heals and clamping included." } }, + { Name = "clamped", Type = "bool", Nilable = false, Documentation = { "If true, the value is in excess of the clamp boundary." } }, + }, + }, + { + Name = "UnitHealPredictionValues", + Type = "Structure", + Fields = + { + { Name = "health", Type = "number", Nilable = false, Default = 0 }, + { Name = "healthMax", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalIncomingHeals", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalIncomingHealsFromHealer", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalDamageAbsorbs", Type = "number", Nilable = false, Default = 0 }, + { Name = "totalHealAbsorbs", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "UnitIncomingHealInfo", + Type = "Structure", + Fields = + { + { Name = "amount", Type = "number", Nilable = false, Documentation = { "Amount of incoming heals across all units with potential reductions from heal absorb effects included." } }, + { Name = "amountFromHealer", Type = "number", Nilable = false, Documentation = { "Amount of incoming heals from the healer unit. Will never exceed the all-units value." } }, + { Name = "amountFromOthers", Type = "number", Nilable = false, Documentation = { "Amount of incoming heals from units other than theh healer. Calculated as the difference between amount and amount-from-healer." } }, + { Name = "clamped", Type = "bool", Nilable = false, Documentation = { "If true, the value is in excess of the clamp boundary." } }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UnitHealPredictionCalculatorShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua.annotated.lua new file mode 100644 index 0000000..989c965 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitRoleDocumentation.lua.annotated.lua @@ -0,0 +1,123 @@ +local UnitRole = +{ + Name = "UnitRole", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "AreClassRolesSoftSuggestions", + Type = "Function", + Documentation = { "If true, UnitGetAvailableRoles results should be treated as suggested role, not hard limits on what role the current player can display as." }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanShowSetRoleButton", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InitiateRolePoll", + Type = "Function", + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitGetAvailableRoles", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "tank", Type = "bool", Nilable = false }, + { Name = "healer", Type = "bool", Nilable = false }, + { Name = "dps", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitSetRole", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "roleStr", Type = "cstring", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitSetRoleEnum", + Type = "Function", + HasRestrictions = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "role", Type = "LFGRole", Nilable = true }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "RoleChangedInform", + Type = "Event", + LiteralName = "ROLE_CHANGED_INFORM", + SynchronousEvent = true, + Payload = + { + { Name = "changedName", Type = "cstring", Nilable = false }, + { Name = "fromName", Type = "cstring", Nilable = false }, + { Name = "oldRole", Type = "cstring", Nilable = false }, + { Name = "newRole", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "RolePollBegin", + Type = "Event", + LiteralName = "ROLE_POLL_BEGIN", + SynchronousEvent = true, + Payload = + { + { Name = "fromName", Type = "cstring", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UnitRole); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSexConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSexConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..b966433 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSexConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,23 @@ +local UnitSexConstants = +{ + Tables = + { + { + Name = "UnitSex", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Male", Type = "UnitSex", EnumValue = 0 }, + { Name = "Female", Type = "UnitSex", EnumValue = 1 }, + { Name = "None", Type = "UnitSex", EnumValue = 2 }, + { Name = "Both", Type = "UnitSex", EnumValue = 3 }, + { Name = "Neutral", Type = "UnitSex", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UnitSexConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..95d0f73 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UnitSharedDocumentation.lua.annotated.lua @@ -0,0 +1,16 @@ +local UnitShared = +{ + Tables = + { + { + Name = "UnitEventConstants", + Type = "Constants", + Values = + { + { Name = "MAX_UNIT_TOKENS_IN_EVENT", Type = "number", Value = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UnitShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua.annotated.lua new file mode 100644 index 0000000..2e42056 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/UserFeedbackDocumentation.lua.annotated.lua @@ -0,0 +1,52 @@ +local UserFeedback = +{ + Name = "UserFeedback", + Type = "System", + Namespace = "C_UserFeedback", + Environment = "All", + + Functions = + { + { + Name = "SubmitBug", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "bugInfo", Type = "cstring", Nilable = false }, + { Name = "suppressNotification", Type = "bool", Nilable = false, Default = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SubmitSuggestion", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "suggestion", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UserFeedback); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ValidateNameConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ValidateNameConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..1ac31fe --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ValidateNameConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,50 @@ +local ValidateNameConstants = +{ + Tables = + { + { + Name = "ScrubStringFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "ScrubStringFlags", EnumValue = 0 }, + { Name = "TruncateNewLines", Type = "ScrubStringFlags", EnumValue = 1 }, + { Name = "AllowBarCodes", Type = "ScrubStringFlags", EnumValue = 2 }, + { Name = "StripControlCodes", Type = "ScrubStringFlags", EnumValue = 4 }, + }, + }, + { + Name = "ValidateNameResult", + Type = "Enumeration", + NumValues = 18, + MinValue = 0, + MaxValue = 17, + Fields = + { + { Name = "Success", Type = "ValidateNameResult", EnumValue = 0 }, + { Name = "Failure", Type = "ValidateNameResult", EnumValue = 1 }, + { Name = "NoName", Type = "ValidateNameResult", EnumValue = 2 }, + { Name = "TooShort", Type = "ValidateNameResult", EnumValue = 3 }, + { Name = "TooLong", Type = "ValidateNameResult", EnumValue = 4 }, + { Name = "InvalidCharacter", Type = "ValidateNameResult", EnumValue = 5 }, + { Name = "MixedLanguages", Type = "ValidateNameResult", EnumValue = 6 }, + { Name = "Profane", Type = "ValidateNameResult", EnumValue = 7 }, + { Name = "Reserved", Type = "ValidateNameResult", EnumValue = 8 }, + { Name = "InvalidApostrophe", Type = "ValidateNameResult", EnumValue = 9 }, + { Name = "MultipleApostrophes", Type = "ValidateNameResult", EnumValue = 10 }, + { Name = "ThreeConsecutive", Type = "ValidateNameResult", EnumValue = 11 }, + { Name = "InvalidSpace", Type = "ValidateNameResult", EnumValue = 12 }, + { Name = "ConsecutiveSpaces", Type = "ValidateNameResult", EnumValue = 13 }, + { Name = "RussianConsecutiveSilentCharacters", Type = "ValidateNameResult", EnumValue = 14 }, + { Name = "RussianSilentCharacterAtBeginningOrEnd", Type = "ValidateNameResult", EnumValue = 15 }, + { Name = "DeclensionDoesntMatchBaseName", Type = "ValidateNameResult", EnumValue = 16 }, + { Name = "SpacesDisallowed", Type = "ValidateNameResult", EnumValue = 17 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ValidateNameConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VectorSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VectorSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..3376142 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VectorSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local VectorShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(VectorShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VehicleDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VehicleDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4ea3c7e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VehicleDocumentation.lua.annotated.lua @@ -0,0 +1,126 @@ +local Vehicle = +{ + Name = "Vehicle", + Type = "System", + Namespace = "C_Vehicle", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "PlayerGainsVehicleData", + Type = "Event", + LiteralName = "PLAYER_GAINS_VEHICLE_DATA", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "vehicleUIIndicatorID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerLosesVehicleData", + Type = "Event", + LiteralName = "PLAYER_LOSES_VEHICLE_DATA", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitEnteredVehicle", + Type = "Event", + LiteralName = "UNIT_ENTERED_VEHICLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "showVehicleFrame", Type = "bool", Nilable = false }, + { Name = "isControlSeat", Type = "bool", Nilable = false }, + { Name = "vehicleUIIndicatorID", Type = "number", Nilable = false }, + { Name = "vehicleGUID", Type = "WOWGUID", Nilable = false }, + { Name = "mayChooseExit", Type = "bool", Nilable = false }, + { Name = "hasPitch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitEnteringVehicle", + Type = "Event", + LiteralName = "UNIT_ENTERING_VEHICLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + { Name = "showVehicleFrame", Type = "bool", Nilable = false }, + { Name = "isControlSeat", Type = "bool", Nilable = false }, + { Name = "vehicleUIIndicatorID", Type = "number", Nilable = false }, + { Name = "vehicleGUID", Type = "WOWGUID", Nilable = false }, + { Name = "mayChooseExit", Type = "bool", Nilable = false }, + { Name = "hasPitch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitExitedVehicle", + Type = "Event", + LiteralName = "UNIT_EXITED_VEHICLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "UnitExitingVehicle", + Type = "Event", + LiteralName = "UNIT_EXITING_VEHICLE", + SynchronousEvent = true, + Payload = + { + { Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false }, + }, + }, + { + Name = "VehicleAngleShow", + Type = "Event", + LiteralName = "VEHICLE_ANGLE_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "shouldShow", Type = "number", Nilable = true }, + }, + }, + { + Name = "VehiclePassengersChanged", + Type = "Event", + LiteralName = "VEHICLE_PASSENGERS_CHANGED", + SynchronousEvent = true, + }, + { + Name = "VehiclePowerShow", + Type = "Event", + LiteralName = "VEHICLE_POWER_SHOW", + SynchronousEvent = true, + Payload = + { + { Name = "shouldShow", Type = "number", Nilable = true }, + }, + }, + { + Name = "VehicleUpdate", + Type = "Event", + LiteralName = "VEHICLE_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Vehicle); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f48ecff --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VideoDocumentation.lua.annotated.lua @@ -0,0 +1,207 @@ +local Video = +{ + Name = "Video", + Type = "System", + Namespace = "C_VideoOptions", + Environment = "All", + + Functions = + { + { + Name = "GetCurrentGameWindowSize", + Type = "Function", + + Returns = + { + { Name = "size", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetDefaultGameWindowSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "monitor", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "size", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetGameWindowSizes", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "monitor", Type = "number", Nilable = false }, + { Name = "fullscreen", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "sizes", Type = "table", InnerType = "vector2", Nilable = false }, + }, + }, + { + Name = "GetGxAdapterInfo", + Type = "Function", + + Returns = + { + { Name = "adapters", Type = "table", InnerType = "GxAdapterInfoDetails", Nilable = false }, + }, + }, + { + Name = "IsSpellVisualDensitySystemSupported", + Type = "Function", + + Returns = + { + { Name = "isSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetGameWindowSize", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AdapterListChanged", + Type = "Event", + LiteralName = "ADAPTER_LIST_CHANGED", + SynchronousEvent = true, + }, + { + Name = "DisplaySizeChanged", + Type = "Event", + LiteralName = "DISPLAY_SIZE_CHANGED", + SynchronousEvent = true, + }, + { + Name = "GlueScreenshotFailed", + Type = "Event", + LiteralName = "GLUE_SCREENSHOT_FAILED", + SynchronousEvent = true, + }, + { + Name = "GlueScreenshotStarted", + Type = "Event", + LiteralName = "GLUE_SCREENSHOT_STARTED", + SynchronousEvent = true, + }, + { + Name = "GlueScreenshotSucceeded", + Type = "Event", + LiteralName = "GLUE_SCREENSHOT_SUCCEEDED", + SynchronousEvent = true, + }, + { + Name = "GxRestarted", + Type = "Event", + LiteralName = "GX_RESTARTED", + SynchronousEvent = true, + }, + { + Name = "ScreenshotFailed", + Type = "Event", + LiteralName = "SCREENSHOT_FAILED", + SynchronousEvent = true, + }, + { + Name = "ScreenshotStarted", + Type = "Event", + LiteralName = "SCREENSHOT_STARTED", + SynchronousEvent = true, + }, + { + Name = "ScreenshotSucceeded", + Type = "Event", + LiteralName = "SCREENSHOT_SUCCEEDED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "GraphicsValidationResult", + Type = "Enumeration", + NumValues = 43, + MinValue = 0, + MaxValue = 42, + Fields = + { + { Name = "Supported", Type = "GraphicsValidationResult", EnumValue = 0 }, + { Name = "Illegal", Type = "GraphicsValidationResult", EnumValue = 1 }, + { Name = "Unsupported", Type = "GraphicsValidationResult", EnumValue = 2 }, + { Name = "Graphics", Type = "GraphicsValidationResult", EnumValue = 3 }, + { Name = "DualCore", Type = "GraphicsValidationResult", EnumValue = 4 }, + { Name = "QuadCore", Type = "GraphicsValidationResult", EnumValue = 5 }, + { Name = "CpuMem_2", Type = "GraphicsValidationResult", EnumValue = 6 }, + { Name = "CpuMem_4", Type = "GraphicsValidationResult", EnumValue = 7 }, + { Name = "CpuMem_8", Type = "GraphicsValidationResult", EnumValue = 8 }, + { Name = "Needs_5_0", Type = "GraphicsValidationResult", EnumValue = 9 }, + { Name = "Needs_6_0", Type = "GraphicsValidationResult", EnumValue = 10 }, + { Name = "NeedsRt", Type = "GraphicsValidationResult", EnumValue = 11 }, + { Name = "NeedsDx12", Type = "GraphicsValidationResult", EnumValue = 12 }, + { Name = "NeedsDx12Vrs2", Type = "GraphicsValidationResult", EnumValue = 13 }, + { Name = "NeedsAppleGpu", Type = "GraphicsValidationResult", EnumValue = 14 }, + { Name = "NeedsAmdGpu", Type = "GraphicsValidationResult", EnumValue = 15 }, + { Name = "NeedsIntelGpu", Type = "GraphicsValidationResult", EnumValue = 16 }, + { Name = "NeedsNvidiaGpu", Type = "GraphicsValidationResult", EnumValue = 17 }, + { Name = "NeedsQualcommGpu", Type = "GraphicsValidationResult", EnumValue = 18 }, + { Name = "NeedsMacOs_10_13", Type = "GraphicsValidationResult", EnumValue = 19 }, + { Name = "NeedsMacOs_10_14", Type = "GraphicsValidationResult", EnumValue = 20 }, + { Name = "NeedsMacOs_10_15", Type = "GraphicsValidationResult", EnumValue = 21 }, + { Name = "NeedsMacOs_11_0", Type = "GraphicsValidationResult", EnumValue = 22 }, + { Name = "NeedsMacOs_12_0", Type = "GraphicsValidationResult", EnumValue = 23 }, + { Name = "NeedsMacOs_13_0", Type = "GraphicsValidationResult", EnumValue = 24 }, + { Name = "NeedsWindows_10", Type = "GraphicsValidationResult", EnumValue = 25 }, + { Name = "NeedsWindows_11", Type = "GraphicsValidationResult", EnumValue = 26 }, + { Name = "MacOsUnsupported", Type = "GraphicsValidationResult", EnumValue = 27 }, + { Name = "WindowsUnsupported", Type = "GraphicsValidationResult", EnumValue = 28 }, + { Name = "LegacyUnsupported", Type = "GraphicsValidationResult", EnumValue = 29 }, + { Name = "Dx11Unsupported", Type = "GraphicsValidationResult", EnumValue = 30 }, + { Name = "Dx12Win7Unsupported", Type = "GraphicsValidationResult", EnumValue = 31 }, + { Name = "RemoteDesktopUnsupported", Type = "GraphicsValidationResult", EnumValue = 32 }, + { Name = "WineUnsupported", Type = "GraphicsValidationResult", EnumValue = 33 }, + { Name = "NvapiWineUnsupported", Type = "GraphicsValidationResult", EnumValue = 34 }, + { Name = "AppleGpuUnsupported", Type = "GraphicsValidationResult", EnumValue = 35 }, + { Name = "AmdGpuUnsupported", Type = "GraphicsValidationResult", EnumValue = 36 }, + { Name = "IntelGpuUnsupported", Type = "GraphicsValidationResult", EnumValue = 37 }, + { Name = "NvidiaGpuUnsupported", Type = "GraphicsValidationResult", EnumValue = 38 }, + { Name = "QualcommGpuUnsupported", Type = "GraphicsValidationResult", EnumValue = 39 }, + { Name = "GpuDriver", Type = "GraphicsValidationResult", EnumValue = 40 }, + { Name = "CompatMode", Type = "GraphicsValidationResult", EnumValue = 41 }, + { Name = "Unknown", Type = "GraphicsValidationResult", EnumValue = 42 }, + }, + }, + { + Name = "GxAdapterInfoDetails", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "isLowPower", Type = "bool", Nilable = false }, + { Name = "isExternal", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Video); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..d909c23 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,36 @@ +local VignetteConstants = +{ + Tables = + { + { + Name = "VignetteObjectiveType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "VignetteObjectiveType", EnumValue = 0 }, + { Name = "Defeat", Type = "VignetteObjectiveType", EnumValue = 1 }, + { Name = "DefeatShowRemainingHealth", Type = "VignetteObjectiveType", EnumValue = 2 }, + }, + }, + { + Name = "VignetteType", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Normal", Type = "VignetteType", EnumValue = 0 }, + { Name = "PvPBounty", Type = "VignetteType", EnumValue = 1 }, + { Name = "Torghast", Type = "VignetteType", EnumValue = 2 }, + { Name = "Treasure", Type = "VignetteType", EnumValue = 3 }, + { Name = "FyrakkFlight", Type = "VignetteType", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(VignetteConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f7550bb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VignetteInfoDocumentation.lua.annotated.lua @@ -0,0 +1,153 @@ +local VignetteInfo = +{ + Name = "Vignette", + Type = "System", + Namespace = "C_VignetteInfo", + Environment = "All", + + Functions = + { + { + Name = "FindBestUniqueVignette", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vignetteGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "bestUniqueVignetteIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "GetHealthPercent", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "healthPct", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetRecommendedGroupSize", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "minGroupSize", Type = "number", Nilable = false }, + { Name = "maxGroupSize", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVignetteInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "vignetteInfo", Type = "VignetteInfo", Nilable = true }, + }, + }, + { + Name = "GetVignettePosition", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "vignettePosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "vignetteFacing", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetVignettes", + Type = "Function", + + Returns = + { + { Name = "vignetteGUIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "VignetteMinimapUpdated", + Type = "Event", + LiteralName = "VIGNETTE_MINIMAP_UPDATED", + UniqueEvent = true, + Payload = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + { Name = "onMinimap", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VignettesUpdated", + Type = "Event", + LiteralName = "VIGNETTES_UPDATED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "VignetteInfo", + Type = "Structure", + Fields = + { + { Name = "vignetteGUID", Type = "WOWGUID", Nilable = false }, + { Name = "objectGUID", Type = "WOWGUID", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "isDead", Type = "bool", Nilable = false }, + { Name = "onWorldMap", Type = "bool", Nilable = false }, + { Name = "zoneInfiniteAOI", Type = "bool", Nilable = false }, + { Name = "onMinimap", Type = "bool", Nilable = false }, + { Name = "isUnique", Type = "bool", Nilable = false }, + { Name = "inFogOfWar", Type = "bool", Nilable = false }, + { Name = "atlasName", Type = "textureAtlas", Nilable = false }, + { Name = "hasTooltip", Type = "bool", Nilable = false }, + { Name = "vignetteID", Type = "number", Nilable = false }, + { Name = "type", Type = "VignetteType", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + { Name = "tooltipWidgetSet", Type = "number", Nilable = true }, + { Name = "iconWidgetSet", Type = "number", Nilable = true }, + { Name = "addPaddingAboveTooltipWidgets", Type = "bool", Nilable = true }, + { Name = "mapPin", Type = "UIMapPinInfo", Nilable = true }, + { Name = "objectiveType", Type = "VignetteObjectiveType", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(VignetteInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua.annotated.lua new file mode 100644 index 0000000..94d325a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/VoiceChatDocumentation.lua.annotated.lua @@ -0,0 +1,1472 @@ +local VoiceChat = +{ + Name = "VoiceChat", + Type = "System", + Namespace = "C_VoiceChat", + Environment = "All", + + Functions = + { + { + Name = "ActivateChannel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ActivateChannelTranscription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BeginLocalCapture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "listenToLocalUser", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanAccessSettings", + Type = "Function", + + Returns = + { + { Name = "canAccess", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanPlayerUseVoiceChat", + Type = "Function", + + Returns = + { + { Name = "canUseVoiceChat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CreateChannel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelDisplayName", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, + }, + }, + { + Name = "DeactivateChannel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "DeactivateChannelTranscription", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "EndLocalCapture", + Type = "Function", + }, + { + Name = "GetActiveChannelID", + Type = "Function", + + Returns = + { + { Name = "channelID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetActiveChannelType", + Type = "Function", + + Returns = + { + { Name = "channelType", Type = "ChatChannelType", Nilable = true }, + }, + }, + { + Name = "GetAvailableInputDevices", + Type = "Function", + + Returns = + { + { Name = "inputDevices", Type = "table", InnerType = "VoiceAudioDevice", Nilable = true }, + }, + }, + { + Name = "GetAvailableOutputDevices", + Type = "Function", + + Returns = + { + { Name = "outputDevices", Type = "table", InnerType = "VoiceAudioDevice", Nilable = true }, + }, + }, + { + Name = "GetChannel", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "channel", Type = "VoiceChatChannel", Nilable = false }, + }, + }, + { + Name = "GetChannelForChannelType", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelType", Type = "ChatChannelType", Nilable = false }, + }, + + Returns = + { + { Name = "channel", Type = "VoiceChatChannel", Nilable = false }, + }, + }, + { + Name = "GetChannelForCommunityStream", + Type = "Function", + MayReturnNothing = true, + SecretInChatMessagingLockdown = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + + Returns = + { + { Name = "channel", Type = "VoiceChatChannel", Nilable = false }, + }, + }, + { + Name = "GetCommunicationMode", + Type = "Function", + + Returns = + { + { Name = "communicationMode", Type = "CommunicationMode", Nilable = true }, + }, + }, + { + Name = "GetCurrentVoiceChatConnectionStatusCode", + Type = "Function", + + Returns = + { + { Name = "statusCode", Type = "VoiceChatStatusCode", Nilable = true }, + }, + }, + { + Name = "GetInputVolume", + Type = "Function", + + Returns = + { + { Name = "volume", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetJoinClubVoiceChannelError", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + }, + + Returns = + { + { Name = "errorReason", Type = "VoiceChannelErrorReason", Nilable = true }, + }, + }, + { + Name = "GetLocalPlayerActiveChannelMemberInfo", + Type = "Function", + + Returns = + { + { Name = "memberInfo", Type = "VoiceChatMember", Nilable = true }, + }, + }, + { + Name = "GetLocalPlayerMemberID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "memberID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMasterVolumeScale", + Type = "Function", + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMemberGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "memberGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetMemberID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "memberGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "memberID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetMemberInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "memberInfo", Type = "VoiceChatMember", Nilable = true }, + }, + }, + { + Name = "GetMemberName", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "memberName", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetMemberVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "volume", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetOutputVolume", + Type = "Function", + + Returns = + { + { Name = "volume", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetPTTButtonPressedState", + Type = "Function", + + Returns = + { + { Name = "isPressed", Type = "bool", Nilable = true }, + }, + }, + { + Name = "GetProcesses", + Type = "Function", + MayReturnNothing = true, + + Returns = + { + { Name = "processes", Type = "table", InnerType = "VoiceChatProcess", Nilable = false }, + }, + }, + { + Name = "GetPushToTalkBinding", + Type = "Function", + + Returns = + { + { Name = "keys", Type = "table", InnerType = "string", Nilable = true }, + }, + }, + { + Name = "GetRemoteTtsVoices", + Type = "Function", + + Returns = + { + { Name = "ttsVoices", Type = "table", InnerType = "VoiceTtsVoiceType", Nilable = false }, + }, + }, + { + Name = "GetTtsVoices", + Type = "Function", + + Returns = + { + { Name = "ttsVoices", Type = "table", InnerType = "VoiceTtsVoiceType", Nilable = false }, + }, + }, + { + Name = "GetVADSensitivity", + Type = "Function", + + Returns = + { + { Name = "sensitivity", Type = "number", Nilable = true }, + }, + }, + { + Name = "IsChannelJoinPending", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelType", Type = "ChatChannelType", Nilable = false }, + { Name = "clubId", Type = "ClubId", Nilable = true }, + { Name = "streamId", Type = "ClubStreamId", Nilable = true }, + }, + + Returns = + { + { Name = "isPending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDeafened", + Type = "Function", + + Returns = + { + { Name = "isDeafened", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLoggedIn", + Type = "Function", + + Returns = + { + { Name = "isLoggedIn", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMemberLocalPlayer", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isLocalPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMemberMuted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "mutedForMe", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsMemberMutedForAll", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mutedForAll", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsMemberSilenced", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "silenced", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsMuted", + Type = "Function", + + Returns = + { + { Name = "isMuted", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsParentalDisabled", + Type = "Function", + + Returns = + { + { Name = "isParentalDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsParentalMuted", + Type = "Function", + + Returns = + { + { Name = "isParentalMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerUsingVoice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isUsingVoice", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSilenced", + Type = "Function", + + Returns = + { + { Name = "isSilenced", Type = "bool", Nilable = true }, + }, + }, + { + Name = "IsSpeakForMeActive", + Type = "Function", + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpeakForMeAllowed", + Type = "Function", + + Returns = + { + { Name = "isAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTranscribing", + Type = "Function", + + Returns = + { + { Name = "isTranscribing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTranscriptionAllowed", + Type = "Function", + + Returns = + { + { Name = "isAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVoiceChatConnected", + Type = "Function", + + Returns = + { + { Name = "connected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveChannel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "Login", + Type = "Function", + + Returns = + { + { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, + }, + }, + { + Name = "Logout", + Type = "Function", + + Returns = + { + { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, + }, + }, + { + Name = "MarkChannelsDiscovered", + Type = "Function", + Documentation = { "Once the UI has enumerated all channels, use this to reset the channel discovery state, it will be updated again if appropriate" }, + }, + { + Name = "RequestJoinAndActivateCommunityStreamChannel", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false }, + }, + }, + { + Name = "RequestJoinChannelByChannelType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "channelType", Type = "ChatChannelType", Nilable = false }, + { Name = "autoActivate", Type = "bool", Nilable = true }, + }, + }, + { + Name = "SetCommunicationMode", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "communicationMode", Type = "CommunicationMode", Nilable = false }, + }, + }, + { + Name = "SetDeafened", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isDeafened", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetInputDevice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deviceID", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetInputVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMasterVolumeScale", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMemberMuted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + { Name = "muted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMemberVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + Documentation = { "Adjusts member volume across all channels" }, + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetMuted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "isMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetOutputDevice", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deviceID", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetOutputVolume", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPortraitTexture", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetPushToTalkBinding", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "keys", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "SetVADSensitivity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "sensitivity", Type = "number", Nilable = false }, + }, + }, + { + Name = "ShouldDiscoverChannels", + Type = "Function", + Documentation = { "Use this while loading to determine if the UI should attempt to rediscover the previously joined/active voice channels" }, + + Returns = + { + { Name = "shouldDiscoverChannels", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpeakRemoteTextSample", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "SpeakText", + Type = "Function", + SecretArguments = "AllowedWhenTainted", + Documentation = { "SpeakText also supports XML TTS tags on Windows including bookmarks - see SAPI XML TTS Tutorial in Microsoft's online documentation for more information." }, + + Arguments = + { + { Name = "voiceID", Type = "number", Nilable = false }, + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "rate", Type = "number", Nilable = false }, + { Name = "volume", Type = "number", Nilable = false }, + { Name = "overlap", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "StopSpeakingText", + Type = "Function", + }, + { + Name = "ToggleDeafened", + Type = "Function", + }, + { + Name = "ToggleMemberMuted", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, + }, + }, + { + Name = "ToggleMuted", + Type = "Function", + }, + }, + + Events = + { + { + Name = "VoiceChatActiveInputDeviceUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatActiveOutputDeviceUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatAudioCaptureEnergy", + Type = "Event", + LiteralName = "VOICE_CHAT_AUDIO_CAPTURE_ENERGY", + SynchronousEvent = true, + Payload = + { + { Name = "isSpeaking", Type = "bool", Nilable = false }, + { Name = "energy", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatAudioCaptureStarted", + Type = "Event", + LiteralName = "VOICE_CHAT_AUDIO_CAPTURE_STARTED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatAudioCaptureStopped", + Type = "Event", + LiteralName = "VOICE_CHAT_AUDIO_CAPTURE_STOPPED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatChannelActivated", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_ACTIVATED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelDeactivated", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_DEACTIVATED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelDisplayNameChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "channelDisplayName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelJoined", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_JOINED", + SynchronousEvent = true, + Payload = + { + { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "channelType", Type = "ChatChannelType", Nilable = false }, + { Name = "clubId", Type = "ClubId", Nilable = true }, + { Name = "streamId", Type = "ClubStreamId", Nilable = true }, + }, + }, + { + Name = "VoiceChatChannelMemberActiveStateChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberAdded", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberEnergyChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "speakingEnergy", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberGuidUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberMuteForAllChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isMutedForAll", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberMuteForMeChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isMutedForMe", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberRemoved", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberSilencedChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberSpeakingStateChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isSpeaking", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberSttMessage", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMemberVolumeChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelMuteStateChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelPttChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_PTT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "pushToTalkSetting", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelRemoved", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_REMOVED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelTranscribingChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isTranscribing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelTransmitChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "isTransmitting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannelVolumeChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_CHANNEL_VOLUME_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "channelID", Type = "number", Nilable = false }, + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatCommunicationModeChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_COMMUNICATION_MODE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "communicationMode", Type = "CommunicationMode", Nilable = false }, + }, + }, + { + Name = "VoiceChatConnectionSuccess", + Type = "Event", + LiteralName = "VOICE_CHAT_CONNECTION_SUCCESS", + SynchronousEvent = true, + }, + { + Name = "VoiceChatDeafenedChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_DEAFENED_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isDeafened", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatError", + Type = "Event", + LiteralName = "VOICE_CHAT_ERROR", + SynchronousEvent = true, + Payload = + { + { Name = "platformCode", Type = "number", Nilable = false }, + { Name = "statusCode", Type = "VoiceChatStatusCode", Nilable = false }, + }, + }, + { + Name = "VoiceChatInputDevicesUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_INPUT_DEVICES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatLogin", + Type = "Event", + LiteralName = "VOICE_CHAT_LOGIN", + SynchronousEvent = true, + Payload = + { + { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, + }, + }, + { + Name = "VoiceChatLogout", + Type = "Event", + LiteralName = "VOICE_CHAT_LOGOUT", + SynchronousEvent = true, + Payload = + { + { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, + }, + }, + { + Name = "VoiceChatMutedChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_MUTED_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatOutputDevicesUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_OUTPUT_DEVICES_UPDATED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatPendingChannelJoinState", + Type = "Event", + LiteralName = "VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE", + SynchronousEvent = true, + Payload = + { + { Name = "channelType", Type = "ChatChannelType", Nilable = false }, + { Name = "clubId", Type = "ClubId", Nilable = true }, + { Name = "streamId", Type = "ClubStreamId", Nilable = true }, + { Name = "pendingJoin", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatPttButtonPressedStateChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isPressed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatSilencedChanged", + Type = "Event", + LiteralName = "VOICE_CHAT_SILENCED_CHANGED", + SynchronousEvent = true, + Payload = + { + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatSpeakForMeActiveStatusUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatSpeakForMeFeatureStatusUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED", + SynchronousEvent = true, + }, + { + Name = "VoiceChatTtsPlaybackBookmark", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_BOOKMARK", + SynchronousEvent = true, + Payload = + { + { Name = "utteranceID", Type = "number", Nilable = false }, + { Name = "bookmarkName", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsPlaybackFailed", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_FAILED", + SynchronousEvent = true, + Payload = + { + { Name = "utteranceID", Type = "number", Nilable = false }, + { Name = "status", Type = "VoiceTtsStatusCode", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsPlaybackFinished", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_FINISHED", + SynchronousEvent = true, + Payload = + { + { Name = "utteranceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsPlaybackStarted", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_STARTED", + SynchronousEvent = true, + Payload = + { + { Name = "utteranceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsSpeakTextUpdate", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "status", Type = "VoiceTtsStatusCode", Nilable = false }, + { Name = "utteranceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsVoicesUpdate", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_VOICES_UPDATE", + SynchronousEvent = true, + }, + { + Name = "VoiceChatVadSettingsUpdated", + Type = "Event", + LiteralName = "VOICE_CHAT_VAD_SETTINGS_UPDATED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "CommunicationMode", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "PushToTalk", Type = "CommunicationMode", EnumValue = 0 }, + { Name = "OpenMic", Type = "CommunicationMode", EnumValue = 1 }, + }, + }, + { + Name = "VoiceChannelErrorReason", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Unknown", Type = "VoiceChannelErrorReason", EnumValue = 0 }, + { Name = "IsBattleNetChannel", Type = "VoiceChannelErrorReason", EnumValue = 1 }, + }, + }, + { + Name = "VoiceChatStatusCode", + Type = "Enumeration", + NumValues = 25, + MinValue = 0, + MaxValue = 24, + Fields = + { + { Name = "Success", Type = "VoiceChatStatusCode", EnumValue = 0 }, + { Name = "OperationPending", Type = "VoiceChatStatusCode", EnumValue = 1 }, + { Name = "TooManyRequests", Type = "VoiceChatStatusCode", EnumValue = 2 }, + { Name = "LoginProhibited", Type = "VoiceChatStatusCode", EnumValue = 3 }, + { Name = "ClientNotInitialized", Type = "VoiceChatStatusCode", EnumValue = 4 }, + { Name = "ClientNotLoggedIn", Type = "VoiceChatStatusCode", EnumValue = 5 }, + { Name = "ClientAlreadyLoggedIn", Type = "VoiceChatStatusCode", EnumValue = 6 }, + { Name = "ChannelNameTooShort", Type = "VoiceChatStatusCode", EnumValue = 7 }, + { Name = "ChannelNameTooLong", Type = "VoiceChatStatusCode", EnumValue = 8 }, + { Name = "ChannelAlreadyExists", Type = "VoiceChatStatusCode", EnumValue = 9 }, + { Name = "AlreadyInChannel", Type = "VoiceChatStatusCode", EnumValue = 10 }, + { Name = "TargetNotFound", Type = "VoiceChatStatusCode", EnumValue = 11 }, + { Name = "Failure", Type = "VoiceChatStatusCode", EnumValue = 12 }, + { Name = "ServiceLost", Type = "VoiceChatStatusCode", EnumValue = 13 }, + { Name = "UnableToLaunchProxy", Type = "VoiceChatStatusCode", EnumValue = 14 }, + { Name = "ProxyConnectionTimeOut", Type = "VoiceChatStatusCode", EnumValue = 15 }, + { Name = "ProxyConnectionUnableToConnect", Type = "VoiceChatStatusCode", EnumValue = 16 }, + { Name = "ProxyConnectionUnexpectedDisconnect", Type = "VoiceChatStatusCode", EnumValue = 17 }, + { Name = "Disabled", Type = "VoiceChatStatusCode", EnumValue = 18 }, + { Name = "UnsupportedChatChannelType", Type = "VoiceChatStatusCode", EnumValue = 19 }, + { Name = "InvalidCommunityStream", Type = "VoiceChatStatusCode", EnumValue = 20 }, + { Name = "PlayerSilenced", Type = "VoiceChatStatusCode", EnumValue = 21 }, + { Name = "PlayerVoiceChatParentalDisabled", Type = "VoiceChatStatusCode", EnumValue = 22 }, + { Name = "InvalidInputDevice", Type = "VoiceChatStatusCode", EnumValue = 23 }, + { Name = "InvalidOutputDevice", Type = "VoiceChatStatusCode", EnumValue = 24 }, + }, + }, + { + Name = "VoiceTtsStatusCode", + Type = "Enumeration", + NumValues = 14, + MinValue = 0, + MaxValue = 13, + Fields = + { + { Name = "Success", Type = "VoiceTtsStatusCode", EnumValue = 0 }, + { Name = "InvalidEngineType", Type = "VoiceTtsStatusCode", EnumValue = 1 }, + { Name = "EngineAllocationFailed", Type = "VoiceTtsStatusCode", EnumValue = 2 }, + { Name = "NotSupported", Type = "VoiceTtsStatusCode", EnumValue = 3 }, + { Name = "MaxCharactersExceeded", Type = "VoiceTtsStatusCode", EnumValue = 4 }, + { Name = "UtteranceBelowMinimumDuration", Type = "VoiceTtsStatusCode", EnumValue = 5 }, + { Name = "InputTextEnqueued", Type = "VoiceTtsStatusCode", EnumValue = 6 }, + { Name = "SdkNotInitialized", Type = "VoiceTtsStatusCode", EnumValue = 7 }, + { Name = "DestinationQueueFull", Type = "VoiceTtsStatusCode", EnumValue = 8 }, + { Name = "EnqueueNotNecessary", Type = "VoiceTtsStatusCode", EnumValue = 9 }, + { Name = "UtteranceNotFound", Type = "VoiceTtsStatusCode", EnumValue = 10 }, + { Name = "ManagerNotFound", Type = "VoiceTtsStatusCode", EnumValue = 11 }, + { Name = "InvalidArgument", Type = "VoiceTtsStatusCode", EnumValue = 12 }, + { Name = "InternalError", Type = "VoiceTtsStatusCode", EnumValue = 13 }, + }, + }, + { + Name = "VoiceAudioDevice", + Type = "Structure", + Fields = + { + { Name = "deviceID", Type = "string", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "isSystemDefault", Type = "bool", Nilable = false }, + { Name = "isCommsDefault", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatChannel", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "channelID", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "channelType", Type = "ChatChannelType", Nilable = false, NeverSecret = true }, + { Name = "clubId", Type = "ClubId", Nilable = false, NeverSecret = true }, + { Name = "streamId", Type = "ClubStreamId", Nilable = false, NeverSecret = true }, + { Name = "volume", Type = "number", Nilable = false, NeverSecret = true }, + { Name = "isActive", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isMuted", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isTransmitting", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "isTranscribing", Type = "bool", Nilable = false, NeverSecret = true }, + { Name = "members", Type = "table", InnerType = "VoiceChatMember", Nilable = false }, + }, + }, + { + Name = "VoiceChatMember", + Type = "Structure", + Fields = + { + { Name = "energy", Type = "number", Nilable = false }, + { Name = "memberID", Type = "number", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "isSpeaking", Type = "bool", Nilable = false }, + { Name = "isMutedForAll", Type = "bool", Nilable = false }, + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChatProcess", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "channels", Type = "table", InnerType = "VoiceChatChannel", Nilable = false }, + }, + }, + { + Name = "VoiceTtsVoiceType", + Type = "Structure", + Fields = + { + { Name = "voiceID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(VoiceChat); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9a2dcf2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarCampaignDocumentation.lua.annotated.lua @@ -0,0 +1,214 @@ +local WarCampaign = +{ + Name = "WarCampaign", + Type = "System", + Namespace = "C_CampaignInfo", + Environment = "All", + + Functions = + { + { + Name = "GetAvailableCampaigns", + Type = "Function", + + Returns = + { + { Name = "campaignIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetCampaignChapterInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignChapterID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "campaignChapterInfo", Type = "CampaignChapterInfo", Nilable = true }, + }, + }, + { + Name = "GetCampaignID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCampaignInfo", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "campaignInfo", Type = "CampaignInfo", Nilable = true }, + }, + }, + { + Name = "GetChapterIDs", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "chapterIDs", Type = "table", InnerType = "number", Nilable = true }, + }, + }, + { + Name = "GetCurrentChapterID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "currentChapterID", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetFailureReason", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "failureReason", Type = "CampaignFailureReason", Nilable = true }, + }, + }, + { + Name = "GetState", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "CampaignState", Nilable = false }, + }, + }, + { + Name = "IsCampaignQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "questID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCampaignQuest", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SortAsNormalQuest", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "campaignID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sortAsNormalQuest", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "CampaignState", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Invalid", Type = "CampaignState", EnumValue = 0 }, + { Name = "Complete", Type = "CampaignState", EnumValue = 1 }, + { Name = "InProgress", Type = "CampaignState", EnumValue = 2 }, + { Name = "Stalled", Type = "CampaignState", EnumValue = 3 }, + }, + }, + { + Name = "CampaignChapterInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "rewardQuestID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CampaignFailureReason", + Type = "Structure", + Fields = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "questID", Type = "number", Nilable = true }, + { Name = "mapID", Type = "number", Nilable = true }, + }, + }, + { + Name = "CampaignInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "uiTextureKit", Type = "textureKit", Nilable = false }, + { Name = "isWarCampaign", Type = "bool", Nilable = false }, + { Name = "usesNormalQuestIcons", Type = "bool", Nilable = false }, + { Name = "isContainerCampaign", Type = "bool", Nilable = false }, + { Name = "sortAsNormalQuest", Type = "bool", Nilable = false }, + { Name = "hideFutureChapters", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WarCampaign); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..823d7a4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,23 @@ +local WarbandSceneInfoConstants = +{ + Tables = + { + { + Name = "WarbandSceneFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 16, + Fields = + { + { Name = "DoNotInclude", Type = "WarbandSceneFlags", EnumValue = 1 }, + { Name = "HiddenUntilCollected", Type = "WarbandSceneFlags", EnumValue = 2 }, + { Name = "CannotBeSaved", Type = "WarbandSceneFlags", EnumValue = 4 }, + { Name = "AwardedAutomatically", Type = "WarbandSceneFlags", EnumValue = 8 }, + { Name = "IsDefault", Type = "WarbandSceneFlags", EnumValue = 16 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WarbandSceneInfoConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f927362 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WarbandSceneInfoDocumentation.lua.annotated.lua @@ -0,0 +1,143 @@ +local WarbandSceneInfo = +{ + Name = "WarbandSceneInfo", + Type = "System", + Namespace = "C_WarbandScene", + Environment = "All", + + Functions = + { + { + Name = "GetRandomEntryID", + Type = "Function", + + Returns = + { + { Name = "warbandSceneID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWarbandSceneEntry", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "warbandSceneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "warbandSceneEntry", Type = "WarbandSceneEntry", Nilable = false }, + }, + }, + { + Name = "HasWarbandScene", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "warbandSceneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "owned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "warbandSceneID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "favorite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SearchWarbandSceneEntries", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "searchParams", Type = "WarbandSceneSearchInfo", Nilable = false }, + }, + + Returns = + { + { Name = "matchingEntryIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "SetFavorite", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "warbandSceneID", Type = "number", Nilable = false }, + { Name = "favorite", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "NewWarbandSceneAdded", + Type = "Event", + LiteralName = "NEW_WARBAND_SCENE_ADDED", + SynchronousEvent = true, + Payload = + { + { Name = "warbandScenID", Type = "number", Nilable = false }, + }, + }, + { + Name = "WarbandSceneFavoritesUpdated", + Type = "Event", + LiteralName = "WARBAND_SCENE_FAVORITES_UPDATED", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "WarbandSceneEntry", + Type = "Structure", + Fields = + { + { Name = "warbandSceneID", Type = "number", Nilable = false, Default = 0 }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "source", Type = "cstring", Nilable = false }, + { Name = "quality", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false, Default = false }, + { Name = "hasFanfare", Type = "bool", Nilable = false, Default = false }, + { Name = "sourceType", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "WarbandSceneSearchInfo", + Type = "Structure", + Fields = + { + { Name = "ownedOnly", Type = "bool", Nilable = false, Default = false }, + { Name = "favoritesOnly", Type = "bool", Nilable = false, Default = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WarbandSceneInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..f6e00de --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsDocumentation.lua.annotated.lua @@ -0,0 +1,351 @@ +local WeeklyRewards = +{ + Name = "WeeklyRewards", + Type = "System", + Namespace = "C_WeeklyRewards", + Environment = "All", + + Functions = + { + { + Name = "AreRewardsForCurrentRewardPeriod", + Type = "Function", + + Returns = + { + { Name = "isCurrentPeriod", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanClaimRewards", + Type = "Function", + + Returns = + { + { Name = "canClaimRewards", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClaimReward", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "CloseInteraction", + Type = "Function", + }, + { + Name = "GetActivities", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = true }, + }, + + Returns = + { + { Name = "activities", Type = "table", InnerType = "WeeklyRewardActivityInfo", Nilable = false }, + }, + }, + { + Name = "GetActivityEncounterInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "table", InnerType = "WeeklyRewardActivityEncounterInfo", Nilable = false }, + }, + }, + { + Name = "GetConquestWeeklyProgress", + Type = "Function", + + Returns = + { + { Name = "weeklyProgress", Type = "ConquestWeeklyProgress", Nilable = false }, + }, + }, + { + Name = "GetDifficultyIDForActivityTier", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityTierID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "difficultyID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExampleRewardItemHyperlinks", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hyperlink", Type = "string", Nilable = false }, + { Name = "upgradeHyperlink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetItemHyperlink", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "itemDBID", Type = "WeeklyRewardItemDBID", Nilable = false }, + }, + + Returns = + { + { Name = "hyperlink", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetNextActivitiesIncrease", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "activityTierID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasSeasonData", Type = "bool", Nilable = false }, + { Name = "nextActivityTierID", Type = "number", Nilable = true }, + { Name = "nextLevel", Type = "number", Nilable = true }, + { Name = "itemLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNextMythicPlusIncrease", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mythicPlusLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasSeasonData", Type = "bool", Nilable = false }, + { Name = "nextMythicPlusLevel", Type = "number", Nilable = true }, + { Name = "itemLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetNumCompletedDungeonRuns", + Type = "Function", + + Returns = + { + { Name = "numHeroic", Type = "number", Nilable = false }, + { Name = "numMythic", Type = "number", Nilable = false }, + { Name = "numMythicPlus", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSortedProgressForActivity", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = false }, + { Name = "combineSharedDifficulty", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "progress", Type = "table", InnerType = "WeeklyRewardActivityTierProgress", Nilable = false }, + }, + }, + { + Name = "HasAvailableRewards", + Type = "Function", + + Returns = + { + { Name = "hasAvailableRewards", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasGeneratedRewards", + Type = "Function", + + Returns = + { + { Name = "hasGeneratedRewards", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasInteraction", + Type = "Function", + + Returns = + { + { Name = "isInteracting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWeeklyChestRetired", + Type = "Function", + + Returns = + { + { Name = "isRetired", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnUIInteract", + Type = "Function", + }, + { + Name = "ShouldShowFinalRetirementMessage", + Type = "Function", + + Returns = + { + { Name = "showRetirementMessage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShouldShowRetirementMessage", + Type = "Function", + + Returns = + { + { Name = "showRetirementMessage", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "WeeklyRewardsItemChanged", + Type = "Event", + LiteralName = "WEEKLY_REWARDS_ITEM_CHANGED", + SynchronousEvent = true, + }, + { + Name = "WeeklyRewardsUpdate", + Type = "Event", + LiteralName = "WEEKLY_REWARDS_UPDATE", + SynchronousEvent = true, + }, + }, + + Tables = + { + { + Name = "ConquestProgressBarDisplayType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "FirstChest", Type = "ConquestProgressBarDisplayType", EnumValue = 0 }, + { Name = "AdditionalChest", Type = "ConquestProgressBarDisplayType", EnumValue = 1 }, + { Name = "Seasonal", Type = "ConquestProgressBarDisplayType", EnumValue = 2 }, + }, + }, + { + Name = "ConquestWeeklyProgress", + Type = "Structure", + Fields = + { + { Name = "progress", Type = "number", Nilable = false }, + { Name = "maxProgress", Type = "number", Nilable = false }, + { Name = "displayType", Type = "ConquestProgressBarDisplayType", Nilable = false }, + { Name = "unlocksCompleted", Type = "number", Nilable = false }, + { Name = "maxUnlocks", Type = "number", Nilable = false }, + { Name = "sampleItemHyperlink", Type = "string", Nilable = false }, + }, + }, + { + Name = "WeeklyRewardActivityEncounterInfo", + Type = "Structure", + Fields = + { + { Name = "encounterID", Type = "number", Nilable = false }, + { Name = "bestDifficulty", Type = "number", Nilable = false }, + { Name = "uiOrder", Type = "number", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "WeeklyRewardActivityInfo", + Type = "Structure", + Fields = + { + { Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "threshold", Type = "number", Nilable = false }, + { Name = "progress", Type = "number", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "activityTierID", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "claimID", Type = "number", Nilable = true }, + { Name = "raidString", Type = "cstring", Nilable = true }, + { Name = "rewards", Type = "table", InnerType = "WeeklyRewardActivityRewardInfo", Nilable = false }, + }, + }, + { + Name = "WeeklyRewardActivityRewardInfo", + Type = "Structure", + Fields = + { + { Name = "type", Type = "CachedRewardType", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "itemDBID", Type = "WeeklyRewardItemDBID", Nilable = true }, + }, + }, + { + Name = "WeeklyRewardActivityTierProgress", + Type = "Structure", + Fields = + { + { Name = "activityTierID", Type = "number", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, + { Name = "numPoints", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WeeklyRewards); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsSharedDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsSharedDocumentation.lua.annotated.lua new file mode 100644 index 0000000..99a8a70 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WeeklyRewardsSharedDocumentation.lua.annotated.lua @@ -0,0 +1,8 @@ +local WeeklyRewardsShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WeeklyRewardsShared); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldElapsedTimerConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldElapsedTimerConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..689a42c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldElapsedTimerConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,21 @@ +local WorldElapsedTimerConstants = +{ + Tables = + { + { + Name = "WorldElapsedTimerTypes", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "WorldElapsedTimerTypes", EnumValue = 0 }, + { Name = "ChallengeMode", Type = "WorldElapsedTimerTypes", EnumValue = 1 }, + { Name = "ProvingGround", Type = "WorldElapsedTimerTypes", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WorldElapsedTimerConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua.annotated.lua new file mode 100644 index 0000000..421036d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldLootObjectDocumentation.lua.annotated.lua @@ -0,0 +1,160 @@ +local WorldLootObject = +{ + Name = "WorldLootObject", + Type = "System", + Namespace = "C_WorldLootObject", + Environment = "All", + + Functions = + { + { + Name = "DoesSlotMatchInventoryType", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + { Name = "inventoryType", Type = "InventoryType", Nilable = false }, + }, + + Returns = + { + { Name = "matches", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetWorldLootObjectDistanceSquared", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "distanceSquared", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetWorldLootObjectInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "WorldLootObjectInfo", Nilable = false }, + }, + }, + { + Name = "GetWorldLootObjectInfoByGUID", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "objectGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "WorldLootObjectInfo", Nilable = false }, + }, + }, + { + Name = "IsWorldLootObject", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isWorldLootObject", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWorldLootObjectByGUID", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "isWorldLootObject", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsWorldLootObjectInRange", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isWorldLootObjectInRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OnWorldLootObjectClick", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "isLeftClick", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "WorldLootObjectInfoUpdated", + Type = "Event", + LiteralName = "WORLD_LOOT_OBJECT_INFO_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "WorldLootObjectInfo", + Type = "Structure", + Fields = + { + { Name = "inventoryType", Type = "InventoryType", Nilable = false }, + { Name = "atMaxQuality", Type = "bool", Nilable = false }, + { Name = "isUpgrade", Type = "bool", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WorldLootObject); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua.annotated.lua new file mode 100644 index 0000000..36f9658 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldSafeLocsUIInternalDocumentation.lua.annotated.lua @@ -0,0 +1,41 @@ +local WorldSafeLocsUIInternal = +{ + Name = "WorldSafeLocsUIInternal", + Type = "System", + Namespace = "C_WorldSafeLocsUIInternal", + Environment = "All", + + Functions = + { + { + Name = "GetWorldSafeLocs", + Type = "Function", + + Returns = + { + { Name = "worldSafeLocs", Type = "table", InnerType = "WorldSafeLocInfo", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "WorldSafeLocInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "continent", Type = "number", Nilable = false }, + { Name = "loc", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, + { Name = "facing", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WorldSafeLocsUIInternal); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldStateInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldStateInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..57823f7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WorldStateInfoDocumentation.lua.annotated.lua @@ -0,0 +1,91 @@ +local WorldStateInfo = +{ + Name = "WorldStateInfo", + Type = "System", + Namespace = "C_WorldStateInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "CancelPlayerCountdown", + Type = "Event", + LiteralName = "CANCEL_PLAYER_COUNTDOWN", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "initiatedBy", Type = "WOWGUID", Nilable = false }, + { Name = "informChat", Type = "bool", Nilable = false }, + { Name = "initiatedByName", Type = "string", Nilable = true }, + }, + }, + { + Name = "StartPlayerCountdown", + Type = "Event", + LiteralName = "START_PLAYER_COUNTDOWN", + SecretInChatMessagingLockdown = true, + SynchronousEvent = true, + Payload = + { + { Name = "initiatedBy", Type = "WOWGUID", Nilable = false }, + { Name = "timeRemaining", Type = "time_t", Nilable = false }, + { Name = "totalTime", Type = "time_t", Nilable = false }, + { Name = "informChat", Type = "bool", Nilable = false }, + { Name = "initiatedByName", Type = "string", Nilable = true }, + }, + }, + { + Name = "StartTimer", + Type = "Event", + LiteralName = "START_TIMER", + SynchronousEvent = true, + Payload = + { + { Name = "timerType", Type = "StartTimerType", Nilable = false }, + { Name = "timeRemaining", Type = "time_t", Nilable = false }, + { Name = "totalTime", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "StopTimerOfType", + Type = "Event", + LiteralName = "STOP_TIMER_OF_TYPE", + SynchronousEvent = true, + Payload = + { + { Name = "timerType", Type = "StartTimerType", Nilable = false }, + }, + }, + { + Name = "WorldStateTimerStart", + Type = "Event", + LiteralName = "WORLD_STATE_TIMER_START", + SynchronousEvent = true, + Payload = + { + { Name = "timerID", Type = "number", Nilable = false }, + }, + }, + { + Name = "WorldStateTimerStop", + Type = "Event", + LiteralName = "WORLD_STATE_TIMER_STOP", + SynchronousEvent = true, + Payload = + { + { Name = "timerID", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WorldStateInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowCSConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowCSConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..93a1c5f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowCSConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,90 @@ +local WowCSConstants = +{ + Tables = + { + { + Name = "FragmentID", + Type = "Enumeration", + NumValues = 72, + MinValue = 0, + MaxValue = 255, + Fields = + { + { Name = "MirrorState", Type = "FragmentID", EnumValue = 0 }, + { Name = "EntityPosition", Type = "FragmentID", EnumValue = 1 }, + { Name = "CgObject", Type = "FragmentID", EnumValue = 2 }, + { Name = "JamDispatcher", Type = "FragmentID", EnumValue = 3 }, + { Name = "HeartbeatData", Type = "FragmentID", EnumValue = 4 }, + { Name = "FTransportLink", Type = "FragmentID", EnumValue = 5 }, + { Name = "ClientObservablesData", Type = "FragmentID", EnumValue = 6 }, + { Name = "TimerQueues", Type = "FragmentID", EnumValue = 7 }, + { Name = "TransferSuspensionData", Type = "FragmentID", EnumValue = 8 }, + { Name = "DeferredMessages", Type = "FragmentID", EnumValue = 9 }, + { Name = "FPersistableJamServers", Type = "FragmentID", EnumValue = 10 }, + { Name = "FPlayerJamServers", Type = "FragmentID", EnumValue = 11 }, + { Name = "FLootObjectList", Type = "FragmentID", EnumValue = 12 }, + { Name = "FPlayerOwnershipLink", Type = "FragmentID", EnumValue = 13 }, + { Name = "FUnitAreaTriggerLink", Type = "FragmentID", EnumValue = 14 }, + { Name = "Actor", Type = "FragmentID", EnumValue = 15 }, + { Name = "FPhaseShiftData", Type = "FragmentID", EnumValue = 16 }, + { Name = "FVendor", Type = "FragmentID", EnumValue = 17 }, + { Name = "MirroredObjectC", Type = "FragmentID", EnumValue = 18 }, + { Name = "FMeshObjectData", Type = "FragmentID", EnumValue = 19 }, + { Name = "FHousingDecor", Type = "FragmentID", EnumValue = 20 }, + { Name = "FHousingRoom", Type = "FragmentID", EnumValue = 21 }, + { Name = "FHousingRoomComponentMesh", Type = "FragmentID", EnumValue = 22 }, + { Name = "FHousingPlayerHouse", Type = "FragmentID", EnumValue = 23 }, + { Name = "FHousingHouseDecorSet", Type = "FragmentID", EnumValue = 24 }, + { Name = "FHousingHouseRoomSet", Type = "FragmentID", EnumValue = 25 }, + { Name = "FHousingDecorProxy", Type = "FragmentID", EnumValue = 26 }, + { Name = "FJamHousingCornerstone", Type = "FragmentID", EnumValue = 27 }, + { Name = "FHousingDecorActor", Type = "FragmentID", EnumValue = 28 }, + { Name = "FHousingPlotAreaTrigger", Type = "FragmentID", EnumValue = 29 }, + { Name = "FNeighborhoodMirrorData", Type = "FragmentID", EnumValue = 30 }, + { Name = "FMirroredPositionData", Type = "FragmentID", EnumValue = 31 }, + { Name = "FPlayerHouseInfo", Type = "FragmentID", EnumValue = 32 }, + { Name = "FHousingStorageMirrorData", Type = "FragmentID", EnumValue = 33 }, + { Name = "FHousingFixture", Type = "FragmentID", EnumValue = 34 }, + { Name = "FHousingHouseFixtureSet", Type = "FragmentID", EnumValue = 35 }, + { Name = "Timer", Type = "FragmentID", EnumValue = 36 }, + { Name = "FPlayerInitiativeInfo", Type = "FragmentID", EnumValue = 37 }, + { Name = "FNeighborhoodStateData", Type = "FragmentID", EnumValue = 38 }, + { Name = "FUnitAIGroupLink", Type = "FragmentID", EnumValue = 39 }, + { Name = "TagItem", Type = "FragmentID", EnumValue = 200 }, + { Name = "TagContainer", Type = "FragmentID", EnumValue = 201 }, + { Name = "TagAzeriteEmpoweredItem", Type = "FragmentID", EnumValue = 202 }, + { Name = "TagAzeriteItem", Type = "FragmentID", EnumValue = 203 }, + { Name = "TagUnit", Type = "FragmentID", EnumValue = 204 }, + { Name = "TagPlayer", Type = "FragmentID", EnumValue = 205 }, + { Name = "TagGameObject", Type = "FragmentID", EnumValue = 206 }, + { Name = "TagDynamicObject", Type = "FragmentID", EnumValue = 207 }, + { Name = "TagCorpse", Type = "FragmentID", EnumValue = 208 }, + { Name = "TagAreaTrigger", Type = "FragmentID", EnumValue = 209 }, + { Name = "TagSceneObject", Type = "FragmentID", EnumValue = 210 }, + { Name = "TagConversation", Type = "FragmentID", EnumValue = 211 }, + { Name = "TagAIGroup", Type = "FragmentID", EnumValue = 212 }, + { Name = "TagScenario", Type = "FragmentID", EnumValue = 213 }, + { Name = "TagLootObject", Type = "FragmentID", EnumValue = 214 }, + { Name = "TagActivePlayer", Type = "FragmentID", EnumValue = 215 }, + { Name = "TagActiveClientS", Type = "FragmentID", EnumValue = 216 }, + { Name = "TagActiveObjectC", Type = "FragmentID", EnumValue = 217 }, + { Name = "TagVisibleObjectC", Type = "FragmentID", EnumValue = 218 }, + { Name = "TagUnitVehicle", Type = "FragmentID", EnumValue = 219 }, + { Name = "TagHousingRoom", Type = "FragmentID", EnumValue = 220 }, + { Name = "TagMeshObject", Type = "FragmentID", EnumValue = 221 }, + { Name = "TagHousingSubdivisionObject", Type = "FragmentID", EnumValue = 222 }, + { Name = "TagHousingPoolObject", Type = "FragmentID", EnumValue = 223 }, + { Name = "TagHouseExteriorPiece", Type = "FragmentID", EnumValue = 224 }, + { Name = "TagHouseExteriorRoot", Type = "FragmentID", EnumValue = 225 }, + { Name = "TestFragment_1", Type = "FragmentID", EnumValue = 250 }, + { Name = "TestFragment_2", Type = "FragmentID", EnumValue = 251 }, + { Name = "TestFragment_3", Type = "FragmentID", EnumValue = 252 }, + { Name = "TestFragment_4", Type = "FragmentID", EnumValue = 253 }, + { Name = "TestFragment_5", Type = "FragmentID", EnumValue = 254 }, + { Name = "ReservedArchetypeSeparator", Type = "FragmentID", EnumValue = 255 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WowCSConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowEntitlementInfoDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowEntitlementInfoDocumentation.lua.annotated.lua new file mode 100644 index 0000000..18ac035 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowEntitlementInfoDocumentation.lua.annotated.lua @@ -0,0 +1,70 @@ +local WowEntitlementInfo = +{ + Name = "WowEntitlementInfo", + Type = "System", + Namespace = "C_WowEntitlementInfo", + Environment = "All", + + Functions = + { + }, + + Events = + { + { + Name = "EntitlementDelivered", + Type = "Event", + LiteralName = "ENTITLEMENT_DELIVERED", + SynchronousEvent = true, + Payload = + { + { Name = "entitlementType", Type = "WoWEntitlementType", Nilable = false }, + { Name = "textureID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "payloadID", Type = "number", Nilable = true }, + { Name = "showFancyToast", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RafEntitlementDelivered", + Type = "Event", + LiteralName = "RAF_ENTITLEMENT_DELIVERED", + SynchronousEvent = true, + Payload = + { + { Name = "entitlementType", Type = "WoWEntitlementType", Nilable = false }, + { Name = "textureID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "payloadID", Type = "number", Nilable = true }, + { Name = "showFancyToast", Type = "bool", Nilable = false }, + { Name = "rafVersion", Type = "RecruitAFriendRewardsVersion", Nilable = false }, + }, + }, + }, + + Tables = + { + { + Name = "WoWEntitlementType", + Type = "Enumeration", + NumValues = 10, + MinValue = 0, + MaxValue = 9, + Fields = + { + { Name = "Item", Type = "WoWEntitlementType", EnumValue = 0 }, + { Name = "Mount", Type = "WoWEntitlementType", EnumValue = 1 }, + { Name = "Battlepet", Type = "WoWEntitlementType", EnumValue = 2 }, + { Name = "Toy", Type = "WoWEntitlementType", EnumValue = 3 }, + { Name = "Appearance", Type = "WoWEntitlementType", EnumValue = 4 }, + { Name = "AppearanceSet", Type = "WoWEntitlementType", EnumValue = 5 }, + { Name = "GameTime", Type = "WoWEntitlementType", EnumValue = 6 }, + { Name = "Title", Type = "WoWEntitlementType", EnumValue = 7 }, + { Name = "Illusion", Type = "WoWEntitlementType", EnumValue = 8 }, + { Name = "Invalid", Type = "WoWEntitlementType", EnumValue = 9 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WowEntitlementInfo); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyConstantsDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyConstantsDocumentation.lua.annotated.lua new file mode 100644 index 0000000..7cad8b2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyConstantsDocumentation.lua.annotated.lua @@ -0,0 +1,23 @@ +local WowSurveyConstants = +{ + Tables = + { + { + Name = "SurveyDeliveryMoment", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Login", Type = "SurveyDeliveryMoment", EnumValue = 0 }, + { Name = "ProfessionTable", Type = "SurveyDeliveryMoment", EnumValue = 1 }, + { Name = "QuestTurnIn", Type = "SurveyDeliveryMoment", EnumValue = 2 }, + { Name = "ChestLooted", Type = "SurveyDeliveryMoment", EnumValue = 3 }, + { Name = "MythicPlusCompleted", Type = "SurveyDeliveryMoment", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(WowSurveyConstants); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua.annotated.lua new file mode 100644 index 0000000..4beaff6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowSurveyDocumentation.lua.annotated.lua @@ -0,0 +1,42 @@ +local WowSurvey = +{ + Name = "WowSurvey", + Type = "System", + Namespace = "C_WowSurvey", + Environment = "All", + + Functions = + { + { + Name = "OpenSurvey", + Type = "Function", + HasRestrictions = true, + }, + { + Name = "TriggerSurveyServe", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "deliveryMoment", Type = "SurveyDeliveryMoment", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SurveyDelivered", + Type = "Event", + LiteralName = "SURVEY_DELIVERED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WowSurvey); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua.annotated.lua new file mode 100644 index 0000000..fcfa481 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/WowTokenUIDocumentation.lua.annotated.lua @@ -0,0 +1,150 @@ +local WowTokenUI = +{ + Name = "WowTokenUI", + Type = "System", + Namespace = "C_WowTokenUI", + Environment = "All", + + Functions = + { + { + Name = "StartTokenSell", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "tokenGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "TokenAuctionSold", + Type = "Event", + LiteralName = "TOKEN_AUCTION_SOLD", + SynchronousEvent = true, + }, + { + Name = "TokenBuyConfirmRequired", + Type = "Event", + LiteralName = "TOKEN_BUY_CONFIRM_REQUIRED", + SynchronousEvent = true, + }, + { + Name = "TokenBuyResult", + Type = "Event", + LiteralName = "TOKEN_BUY_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "TokenCanVeteranBuyUpdate", + Type = "Event", + LiteralName = "TOKEN_CAN_VETERAN_BUY_UPDATE", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "TokenDistributionsUpdated", + Type = "Event", + LiteralName = "TOKEN_DISTRIBUTIONS_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "TokenMarketPriceUpdated", + Type = "Event", + LiteralName = "TOKEN_MARKET_PRICE_UPDATED", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "TokenRedeemBalanceUpdated", + Type = "Event", + LiteralName = "TOKEN_REDEEM_BALANCE_UPDATED", + SynchronousEvent = true, + }, + { + Name = "TokenRedeemConfirmRequired", + Type = "Event", + LiteralName = "TOKEN_REDEEM_CONFIRM_REQUIRED", + SynchronousEvent = true, + Payload = + { + { Name = "choiceType", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "TokenRedeemFrameShow", + Type = "Event", + LiteralName = "TOKEN_REDEEM_FRAME_SHOW", + SynchronousEvent = true, + }, + { + Name = "TokenRedeemGameTimeUpdated", + Type = "Event", + LiteralName = "TOKEN_REDEEM_GAME_TIME_UPDATED", + SynchronousEvent = true, + }, + { + Name = "TokenRedeemResult", + Type = "Event", + LiteralName = "TOKEN_REDEEM_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "luaIndex", Nilable = false }, + { Name = "choiceType", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "TokenSellConfirmRequired", + Type = "Event", + LiteralName = "TOKEN_SELL_CONFIRM_REQUIRED", + SynchronousEvent = true, + }, + { + Name = "TokenSellConfirmed", + Type = "Event", + LiteralName = "TOKEN_SELL_CONFIRMED", + SynchronousEvent = true, + }, + { + Name = "TokenSellResult", + Type = "Event", + LiteralName = "TOKEN_SELL_RESULT", + SynchronousEvent = true, + Payload = + { + { Name = "result", Type = "number", Nilable = false }, + }, + }, + { + Name = "TokenStatusChanged", + Type = "Event", + LiteralName = "TOKEN_STATUS_CHANGED", + SynchronousEvent = true, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WowTokenUI); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6c60904 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/XMLUtilDocumentation.lua.annotated.lua @@ -0,0 +1,79 @@ +local XMLUtil = +{ + Name = "XMLUtil", + Type = "System", + Namespace = "C_XMLUtil", + Environment = "All", + + Functions = + { + { + Name = "GetTemplateInfo", + Type = "Function", + MayReturnNothing = true, + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "XMLTemplateInfo", Nilable = false }, + }, + }, + { + Name = "GetTemplates", + Type = "Function", + + Returns = + { + { Name = "templates", Type = "table", InnerType = "XMLTemplateListInfo", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "XMLTemplateInfo", + Type = "Structure", + Fields = + { + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "width", Type = "number", Nilable = false }, + { Name = "height", Type = "number", Nilable = false }, + { Name = "keyValues", Type = "table", InnerType = "XMLTemplateKeyValue", Nilable = false }, + { Name = "inherits", Type = "cstring", Nilable = true }, + { Name = "sourceLocation", Type = "string", Nilable = false }, + }, + }, + { + Name = "XMLTemplateKeyValue", + Type = "Structure", + Fields = + { + { Name = "key", Type = "cstring", Nilable = false }, + { Name = "keyType", Type = "cstring", Nilable = false }, + { Name = "type", Type = "cstring", Nilable = false }, + { Name = "value", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "XMLTemplateListInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "type", Type = "cstring", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(XMLUtil); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua.annotated.lua new file mode 100644 index 0000000..9d27f71 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneAbilityDocumentation.lua.annotated.lua @@ -0,0 +1,57 @@ +local ZoneAbility = +{ + Name = "ZoneAbility", + Type = "System", + Namespace = "C_ZoneAbility", + Environment = "All", + + Functions = + { + { + Name = "GetActiveAbilities", + Type = "Function", + + Returns = + { + { Name = "zoneAbilities", Type = "table", InnerType = "ZoneAbilityInfo", Nilable = false }, + }, + }, + { + Name = "GetZoneAbilityIcon", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "zoneAbilitySpellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "zoneAbilityIconID", Type = "number", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "ZoneAbilityInfo", + Type = "Structure", + Fields = + { + { Name = "zoneAbilityID", Type = "number", Nilable = false }, + { Name = "uiPriority", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "textureKit", Type = "textureKit", Nilable = false }, + { Name = "tutorialText", Type = "cstring", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ZoneAbility); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua.annotated.lua new file mode 100644 index 0000000..6dd7d0d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_APIDocumentationGenerated/ZoneScriptDocumentation.lua.annotated.lua @@ -0,0 +1,71 @@ +local ZoneScript = +{ + Name = "ZoneScript", + Type = "System", + Environment = "All", + + Functions = + { + { + Name = "GetAreaText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetMinimapZoneText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetRealZoneText", + Type = "Function", + SecretArguments = "AllowedWhenUntainted", + + Arguments = + { + { Name = "mapID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetSubZoneText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetZoneText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "cstring", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ZoneScript); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml new file mode 100644 index 0000000..e1f89d3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml @@ -0,0 +1,11 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml.annotated.lua new file mode 100644 index 0000000..1780e9e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml.annotated.lua @@ -0,0 +1,6 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/AccessibilityIntrinsics.xml#L3) +--- Intrinsic +--- @class UIThemeContainerFrame : Frame, UIThemeContainerMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Blizzard_AccessibilityTemplates.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Blizzard_AccessibilityTemplates.toc new file mode 100644 index 0000000..950d05a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Blizzard_AccessibilityTemplates.toc @@ -0,0 +1,12 @@ +## Title: Blizzard_AccessibilityTemplates +## RequiredDep: Blizzard_SharedXML, Blizzard_Colors +## AllowLoad: both +[Family]\AccessibilityTemplates.lua +AccessibilityIntrinsics.xml +QuestTextContrast.lua [AllowLoadGameType mainline] +TextSizeManager.lua +TextSizeManagerGlue.lua [AllowLoad glue] +TextSizeManagerGame.lua [AllowLoad game] +UserScaledElementTemplates.lua +UserScaledElementTemplates.xml +UserScaledSliderTemplates.xml diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Mainline/AccessibilityTemplates.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Mainline/AccessibilityTemplates.lua.annotated.lua new file mode 100644 index 0000000..4dc8d81 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/Mainline/AccessibilityTemplates.lua.annotated.lua @@ -0,0 +1,113 @@ +UIThemeContainerMixin = {};--- @class UIThemeContainerMixin + +function UIThemeContainerMixin:UIThemeContainerFrame_OnPreLoad() + self.cvar = "questTextContrast"; + self.fontStrings = {}; + self.frames = {}; +end + +function UIThemeContainerMixin:UIThemeContainerFrame_OnPreShow() + self:RegisterEvent("CVAR_UPDATE"); + self:RegisterEvent("VARIABLES_LOADED"); +end + +function UIThemeContainerMixin:UIThemeContainerFrame_OnPostHide() + self:UnregisterEvent("CVAR_UPDATE"); + self:UnregisterEvent("VARIABLES_LOADED"); +end + +function UIThemeContainerMixin:UIThemeContainerFrame_OnPostEvent(event, ...) + if event == "VARIABLES_LOADED" then + self:UpdateTheme(self:GetCVarValue()); + elseif event == "CVAR_UPDATE" then + local cvar, value = ...; + self:CheckUpdateTheme(cvar, value); + end +end + +function UIThemeContainerMixin:UpdateTheme(cvarValue) + cvarValue = tonumber(cvarValue or self:GetCVarValue()); + self:UpdateFontStrings(cvarValue); + self:UpdateFrames(cvarValue); + self:UpdateBackground(cvarValue); +end + +function UIThemeContainerMixin:CheckUpdateTheme(cvar, value) + if cvar == self.cvar then + self:UpdateTheme(value); + end +end + +function UIThemeContainerMixin:GetCVarValue() + return GetCVarNumberOrDefault(self.cvar); +end + +function UIThemeContainerMixin:IsDarkMode(cvarValue) + return QuestTextContrast.UseLightText(cvarValue); +end + +local CONTRAST_LIGHT_MODE = false; +local CONTRAST_DARK_MODE = true; + +local textColors = +{ + -- key : fixedColor, color + [CONTRAST_LIGHT_MODE] = { false, PARCHMENT_MATERIAL_TEXT_COLOR, }, + [CONTRAST_DARK_MODE] = { true, STONE_MATERIAL_TEXT_COLOR, }, +}; + +function UIThemeContainerMixin:UpdateFontStrings(cvarValue) + local colorEntry = textColors[self:IsDarkMode(cvarValue)]; + local fixedColor, color = unpack(colorEntry); + + for fontString in pairs(self.fontStrings) do + fontString:SetFixedColor(fixedColor); + fontString:SetTextColor(color:GetRGB()); + end +end + +function UIThemeContainerMixin:UpdateFrames(cvarValue) + local darkMode = self:IsDarkMode(cvarValue); + + for frame in pairs(self.frames) do + frame:UpdateTheme(darkMode); + end +end + +function UIThemeContainerMixin:UpdateBackground(cvarValue) + if self.backgroundTexture then + self.backgroundTexture:SetAtlas(QuestTextContrast.GetTextureKitBackgroundAtlas(self.textureKit), TextureKitConstants.UseAtlasSize); + end +end + +function UIThemeContainerMixin:RegisterObject(container, object) + container[object] = true; +end + +function UIThemeContainerMixin:RegisterObjects(container, ...) + for i = 1, select("#", ...) do + local object = select(i, ...); + self:RegisterObject(container, object); + end +end + +function UIThemeContainerMixin:RegisterFontString(fontString) + self:RegisterObject(self.fontStrings, fontString); +end + +function UIThemeContainerMixin:RegisterFontStrings(...) + self:RegisterObjects(self.fontStrings, ...); +end + +function UIThemeContainerMixin:RegisterFrame(frame) + self:RegisterObject(self.frames, frame); +end + +function UIThemeContainerMixin:RegisterFrames(...) + self:RegisterObjects(self.frames, ...); +end + +function UIThemeContainerMixin:RegisterBackgroundTexture(texture, textureKit) + self.backgroundTexture = texture; + self.textureKit = textureKit; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/QuestTextContrast.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/QuestTextContrast.lua.annotated.lua new file mode 100644 index 0000000..d70fb13 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/QuestTextContrast.lua.annotated.lua @@ -0,0 +1,63 @@ +QuestTextContrast = {}; + +local function GetQuestTextContrastValue(cvarValue) + return tonumber(cvarValue or GetCVarNumberOrDefault("QuestTextContrast")); +end + +function QuestTextContrast.IsEnabled(cvarValue) + return GetQuestTextContrastValue(cvarValue) > 0; +end + +function QuestTextContrast.UseLightText(cvarValue) + --Use light text when the background is dark + return GetQuestTextContrastValue(cvarValue) == 4; +end + +local questBackgroundAtlas = +{ + [0] = "QuestBG-Parchment", + [1] = "QuestBG-Parchment-Accessibility", + [2] = "QuestBG-Parchment-Accessibility2", + [3] = "QuestBG-Parchment-Accessibility3", + [4] = "QuestBG-Parchment-Accessibility4", +} + +function QuestTextContrast.GetBackgroundAtlas(questTextContrastSetting) + if questTextContrastSetting ~= nil then + return questBackgroundAtlas[questTextContrastSetting]; + end + + return questBackgroundAtlas[0]; +end + +function QuestTextContrast.GetDefaultBackgroundAtlas() + return QuestTextContrast.GetBackgroundAtlas(GetQuestTextContrastValue()); +end + +function QuestTextContrast.GetTextureKitBackgroundAtlas(textureKit) + if textureKit then + local backgroundAtlas = GetFinalNameFromTextureKit("QuestBG-%s", textureKit); + local atlasInfo = C_Texture.GetAtlasInfo(backgroundAtlas); + if atlasInfo then + return backgroundAtlas; + end + end + + return QuestTextContrast.GetDefaultBackgroundAtlas(); +end + +local defaultQuestMapBackgroundTexture = +{ + [0] = "QuestDetailsBackgrounds", + [1] = "QuestDetailsBackgrounds-Accessibility", + [2] = "QuestDetailsBackgrounds-Accessibility_Light", + [3] = "QuestDetailsBackgrounds-Accessibility_Medium", + [4] = "QuestDetailsBackgrounds-Accessibility_Dark", +} + +function QuestTextContrast.GetDefaultDetailsBackgroundAtlas(cvarValue) + local contrast = GetQuestTextContrastValue(cvarValue); + if contrast ~= nil then + return defaultQuestMapBackgroundTexture[contrast]; + end +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManager.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManager.lua.annotated.lua new file mode 100644 index 0000000..d849f05 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManager.lua.annotated.lua @@ -0,0 +1,139 @@ +TextSizeManagerBase = {}; + +function TextSizeManagerBase:Init() + self.registeredObjects = {}; + self.defaultScaleWeight = 0.5; + + self:SetCVarName("userFontScale"); + self:SetMinimumScale(0.8); + self:BuildFonts(); + + local function CVarChangedCB(cvar, value) + self:UpdateFonts(value); + end + + CVarCallbackRegistry:RegisterCallback(self:GetCVarName(), CVarChangedCB); + EventUtil.ContinueAfterAllEvents(function() self:UpdateFonts() end, self:GetInitialUpdateEvents()); +end + +function TextSizeManagerBase:BuildFonts() + self.fonts = {}; + + local fontObjectNames = GetFonts(); + + for index, fontObjectName in ipairs(fontObjectNames) do + local info = GetFontInfo(fontObjectName); + if info and info.canBeUserScaled then + self.fonts[fontObjectName] = { info = info, baseHeight = info.height, object = info.fontObject }; + end + end +end + +function TextSizeManagerBase:GetFonts() + return self.fonts; +end + +function TextSizeManagerBase:GetFontBaseHeight(fontName) + local fonts = self:GetFonts(); + if fonts then + local font = fonts[fontName]; + if font then + return font.baseHeight; + end + end + + return 0; +end + +function TextSizeManagerBase:GetResizedFontHeight(fontName, value) + return self:GetFontBaseHeight(fontName) * value; +end + +function TextSizeManagerBase:SetTextScale(scale) + scale = self:GetScale(scale); + + for fontName, fontData in pairs(self.fonts) do + fontData.object:SetFontHeight(fontData.baseHeight * scale); + end + + self:UpdateRegisteredObjects(scale); + self:UpdateRegisteredSystems(scale); +end + +function TextSizeManagerBase:UpdateFonts(value) + -- trying scale for now + self:SetTextScale(value); +end + +function TextSizeManagerBase:GetMinimumScale() + return self.minScale; +end + +function TextSizeManagerBase:GetScale(scale) + return math.max(scale or self:GetSettingValue(), self:GetMinimumScale()); +end + +function TextSizeManagerBase:GetDefaultScaleWeight() + return self.defaultScaleWeight; +end + +function TextSizeManagerBase:SetMinimumScale(scale) + -- There's an absolute limit imposed on scaling, base height is like 14, definitely don't allow it to go below 7. + self.minScale = math.max(scale or 0, 0.5); +end + +function TextSizeManagerBase:SetCVarName(name) + self.cvarName = name; +end + +function TextSizeManagerBase:GetCVarName() + return self.cvarName; +end + +function TextSizeManagerBase:GetSettingValue() + return GetCVarNumberOrDefault(self:GetCVarName()); +end + +function TextSizeManagerBase:SetSettingValue(value) + SetCVar(self:GetCVarName(), value); +end + +local function GetScaleWeight(manager, registrationInfo) + if registrationInfo and registrationInfo.useScaleWeight then + return registrationInfo.scaleWeight or manager:GetDefaultScaleWeight(); + end + + return 1; +end + +function TextSizeManagerBase:GetWeightedScale(scale, registrationInfo) + local delta = scale - 1; + local weight = GetScaleWeight(self, registrationInfo); + return 1 + (delta * weight); +end + +function TextSizeManagerBase:GetScaledValue(value) + return value * self:GetScale(); +end + +function TextSizeManagerBase:GetScaledValueWeighted(value, registrationInfo) + return value * self:GetWeightedScale(self:GetScale(), registrationInfo); +end + +function TextSizeManagerBase:UpdateRegisteredObjects(scale) + for obj, registrationInfo in pairs(self.registeredObjects) do + obj:OnTextScaleUpdated(scale, registrationInfo); + end +end + +function TextSizeManagerBase:UpdateRegisteredSystems(scale) + EventRegistry:TriggerEvent("TextSizeManager.OnTextScaleUpdated", scale); +end + +function TextSizeManagerBase:RegisterObject(object, registrationInfo) + self.registeredObjects[object] = registrationInfo or object; +end + +function TextSizeManagerBase:UpdateObject(object) + object:OnTextScaleUpdated(self:GetScale(), self.registeredObjects[object]); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManagerGame.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManagerGame.lua.annotated.lua new file mode 100644 index 0000000..2539d54 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/TextSizeManagerGame.lua.annotated.lua @@ -0,0 +1,7 @@ +TextSizeManager = CreateFromMixins(TextSizeManagerBase); + +function TextSizeManager:GetInitialUpdateEvents() + return "VARIABLES_LOADED"; +end + +TextSizeManager:Init(); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.lua.annotated.lua new file mode 100644 index 0000000..68e8890 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.lua.annotated.lua @@ -0,0 +1,62 @@ +UserScaledElementMixin = {};--- @class UserScaledElementMixin + +function UserScaledElementMixin:OnLoad_UserScaledElement() + TextSizeManager:RegisterObject(self); +end + +function UserScaledElementMixin:UpdateWidth() + TextSizeManager:UpdateObject(self); +end + +function UserScaledElementMixin:GetWeightedScale(scaleContext, scale, registrationInfo) + registrationInfo = registrationInfo or self; + scale = scale or TextSizeManager:GetScale(); + + local useWeightedScale = (scaleContext == "width") or (scaleContext == "height" and registrationInfo.useScaleWeightForHeight); + if useWeightedScale then + return TextSizeManager:GetWeightedScale(scale, registrationInfo); + else + return scale; + end +end + +function UserScaledElementMixin:GetScaledDesiredDimension(scaleContext, dimensionValue, scale, registrationInfo) + if dimensionValue then + return dimensionValue * self:GetWeightedScale(scaleContext, scale, registrationInfo); + end +end + +function UserScaledElementMixin:SetDesiredWidth(desiredWidth) + self.desiredWidth = desiredWidth; + TextSizeManager:UpdateObject(self); +end + +function UserScaledElementMixin:GetDesiredWidth(registrationInfo) + return self.desiredWidth or (registrationInfo and registrationInfo.baseWidth); +end + +function UserScaledElementMixin:GetScaledDesiredWidth(scale, registrationInfo) + registrationInfo = registrationInfo or self; + return self:GetScaledDesiredDimension("width", self:GetDesiredWidth(registrationInfo), scale, registrationInfo); +end + +function UserScaledElementMixin:GetDesiredHeight(registrationInfo) + return registrationInfo and registrationInfo.baseHeight; +end + +function UserScaledElementMixin:GetScaledDesiredHeight(scale, registrationInfo) + registrationInfo = registrationInfo or self; + return self:GetScaledDesiredDimension("height", self:GetDesiredHeight(registrationInfo), scale, registrationInfo); +end + +function UserScaledElementMixin:OnTextScaleUpdated(scale, registrationInfo) + local scaledWidth = self:GetScaledDesiredWidth(scale, registrationInfo); + if scaledWidth then + self:SetWidth(scaledWidth); + end + + local scaledHeight = self:GetScaledDesiredHeight(scale, registrationInfo); + if scaledHeight then + self:SetHeight(scaledHeight); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml new file mode 100644 index 0000000..19db774 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml.annotated.lua new file mode 100644 index 0000000..781018f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml.annotated.lua @@ -0,0 +1,10 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml#L3) +--- Template +--- @class UserScaledFrameTemplate : Frame, UserScaledElementMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledElementTemplates.xml#L17) +--- Template +--- @class UserScaledFontStringTemplate : FontString, UserScaledElementMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml new file mode 100644 index 0000000..4331922 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml @@ -0,0 +1,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml.annotated.lua new file mode 100644 index 0000000..ae04c24 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml.annotated.lua @@ -0,0 +1,26 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml#L14) +--- child of UserScaledSliderTemplate +--- @class UserScaledSliderTemplate_Slider : Slider, UISliderTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml#L6) +--- child of UserScaledSliderTemplate +--- @class UserScaledSliderTemplate_Text : FontString, UserScaledFontGameHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml#L22) +--- child of UserScaledSliderTemplate +--- @class UserScaledSliderTemplate_Low : FontString, UserScaledFontGameHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml#L27) +--- child of UserScaledSliderTemplate +--- @class UserScaledSliderTemplate_High : FontString, UserScaledFontGameHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccessibilityTemplates/UserScaledSliderTemplates.xml#L3) +--- Template +--- @class UserScaledSliderTemplate : Frame, ResizeLayoutFrame +--- @field Slider UserScaledSliderTemplate_Slider +--- @field Text UserScaledSliderTemplate_Text +--- @field Low UserScaledSliderTemplate_Low +--- @field High UserScaledSliderTemplate_High + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountSaveUI/Blizzard_AccountSaveUI.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountSaveUI/Blizzard_AccountSaveUI.toc new file mode 100644 index 0000000..28aa1d3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountSaveUI/Blizzard_AccountSaveUI.toc @@ -0,0 +1,7 @@ +## Title: Blizzard_AccountSaveUI +## Author: Blizzard Entertainment +## LoadOnDemand: 1 +## AllowLoad: Glue +## Dependencies: Blizzard_GlueXML +## Category: Character Utils +Blizzard_AccountSaveUI.xml \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.lua.annotated.lua new file mode 100644 index 0000000..578ed34 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.lua.annotated.lua @@ -0,0 +1,112 @@ + +local STORE_FRONT_TO_TITLE = { + [Constants.AccountStoreConsts.WowhackStoreFrontID] = WOWHACK_ACCOUNT_STORE_TITLE, + [Constants.AccountStoreConsts.PlunderstormStoreFrontID] = PLUNDERSTORM_PLUNDER_STORE_TITLE, +}; + +local function LeaveFullscreenMode() + AccountStoreFrame:SetFullscreenMode(false); + AccountStoreUtil.SetAccountStoreShown(false); + + if EndOfMatchFrame and not EndOfMatchFrame:IsShown() and EndOfMatchFrame:HasMatchDetails() then + EndOfMatchFrame:Show(); + end +end + +AccountStoreMixin = {};--- @class AccountStoreMixin + +function AccountStoreMixin:OnLoad() + self:SetPortraitToAsset("Interface\\Icons\\UI_PlunderCoins"); + + if UIPanelWindows then + UIPanelWindows["AccountStoreFrame"] = { area = "left", pushable = 1, whileDead = 1 }; + end +end + +function AccountStoreMixin:OnShow() + PlaySound(SOUNDKIT.ACCOUNT_STORE_OPEN); + EventRegistry:TriggerEvent("AccountStore.ShownState", true); +end + +function AccountStoreMixin:OnHide() + PlaySound(SOUNDKIT.ACCOUNT_STORE_CLOSE); + EventRegistry:TriggerEvent("AccountStore.ShownState", false); + + AccountStoreUtil.CloseStaticPopups(); + + if self.inFullscreenMode then + LeaveFullscreenMode(); + end +end + +function AccountStoreMixin:SetStoreFrontID(storeFrontID) + self.storeFrontID = storeFrontID; + + self:SetTitle(STORE_FRONT_TO_TITLE[storeFrontID] or ""); + + EventRegistry:TriggerEvent("AccountStore.StoreFrontSet", storeFrontID); +end + +function AccountStoreMixin:SetFullscreenMode(enabled) + local currentMainParent = GetAppropriateTopLevelParent(); + self:SetParent(enabled and FullscreenAccountStoreContainer or currentMainParent); + FullscreenAccountStoreContainer:SetShown(enabled); + + self:ClearAllPoints(); + + if enabled then + self:SetPoint("CENTER", self:GetParent(), "CENTER", 0, 0); + else + self:SetPoint("LEFT", self:GetParent(), "LEFT", 50, 0); + end + + self.inFullscreenMode = enabled; +end + +FullscreenAccountStoreContainerMixin = {};--- @class FullscreenAccountStoreContainerMixin + +function FullscreenAccountStoreContainerMixin:OnShow() + local currParent = self:GetParent(); + if currParent == GlueParent then + return; + end + + StaticPopup_SetFullScreenFrame(self); + AlertFrame:SetFullScreenFrame(self); + AlertFrame:SetBaseAnchorFrame(AccountStoreFrameBottom); + ActionStatus:SetAlternateParentFrame(self); + + AlertFrame:BlockLeftClickingAlerts(self); +end + +function FullscreenAccountStoreContainerMixin:OnHide() + if currParent == GlueParent then + return; + end + + StaticPopup_ClearFullScreenFrame(); + AlertFrame:ClearFullScreenFrame(); + AlertFrame:ResetBaseAnchorFrame(); + ActionStatus:ClearAlternateParentFrame(); + + AlertFrame:UnblockLeftClickingAlerts(self); +end + +function FullscreenAccountStoreContainerMixin:OnKeyDown(key) + -- Since the parent is capturing input, we need to manually implement an Escape key + if key == "ESCAPE" then + LeaveFullscreenMode(); + end +end + +FullscreenLeaveAccountStoreButtonMixin = {};--- @class FullscreenLeaveAccountStoreButtonMixin + +function FullscreenLeaveAccountStoreButtonMixin:OnLoad() + local widthPadding = 80; + local width = self:GetTextWidth() + widthPadding; + self:SetWidth(width); +end + +function FullscreenLeaveAccountStoreButtonMixin:OnClick() + LeaveFullscreenMode(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.toc new file mode 100644 index 0000000..563697b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.toc @@ -0,0 +1,18 @@ +## Title: Blizzard Account Store +## AllowLoad: Both +## Author: Blizzard Entertainment +## Dependencies: Blizzard_SharedXML, Blizzard_StaticPopup +## OptionalDep: Blizzard_UIParentPanelManager +## LoadOnDemand: 1 + +Blizzard_AccountStoreUtil.lua +Blizzard_AccountStoreCategoryList.lua +Blizzard_AccountStoreCategoryList.xml +Blizzard_AccountStoreCardTemplates.lua +Blizzard_AccountStoreCardTemplates.xml +Blizzard_AccountStoreItemRack.lua +Blizzard_AccountStoreItemRack.xml +Blizzard_AccountStoreItemDisplay.lua +Blizzard_AccountStoreItemDisplay.xml +Blizzard_AccountStore.lua +Blizzard_AccountStore.xml diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml new file mode 100644 index 0000000..8421d09 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml @@ -0,0 +1,187 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml.annotated.lua new file mode 100644 index 0000000..8934f1b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml.annotated.lua @@ -0,0 +1,154 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L30) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderTopLeft : Texture, UI_Frame_InnerTopLeft + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L35) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderTopRight : Texture, UI_Frame_InnerTopRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L40) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderBottomLeft : Texture, UI_Frame_InnerBotLeftCorner + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L45) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderBottomRight : Texture, UI_Frame_InnerBotRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L50) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderTop : Texture, _UI_Frame_InnerTopTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L56) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderBottom : Texture, _UI_Frame_InnerBotTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L62) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderLeft : Texture, _UI_Frame_InnerLeftTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L68) +--- child of AccountStoreInsetFrameTemplate +--- @class AccountStoreInsetFrameTemplate_InsetBorderRight : Texture, _UI_Frame_InnerRightTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L5) +--- Template +--- @class AccountStoreInsetFrameTemplate : Frame +--- @field Bg Texture +--- @field InsetBorderTopLeft AccountStoreInsetFrameTemplate_InsetBorderTopLeft +--- @field InsetBorderTopRight AccountStoreInsetFrameTemplate_InsetBorderTopRight +--- @field InsetBorderBottomLeft AccountStoreInsetFrameTemplate_InsetBorderBottomLeft +--- @field InsetBorderBottomRight AccountStoreInsetFrameTemplate_InsetBorderBottomRight +--- @field InsetBorderTop AccountStoreInsetFrameTemplate_InsetBorderTop +--- @field InsetBorderBottom AccountStoreInsetFrameTemplate_InsetBorderBottom +--- @field InsetBorderLeft AccountStoreInsetFrameTemplate_InsetBorderLeft +--- @field InsetBorderRight AccountStoreInsetFrameTemplate_InsetBorderRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L93) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_LeftInset : Frame, AccountStoreInsetFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L100) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_RightInset : Frame, AccountStoreInsetFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L106) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_LeftDisplay : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L166) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameTopLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L171) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameTopRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L179) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameBottomLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L187) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameBottomRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L195) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameTop = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L201) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameBottom = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L207) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L213) +--- child of AccountStoreFrame_RightDisplay_ShadowOverlay (created in template ShadowOverlayTemplate) +--- @type Texture +AccountStoreFrameRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L125) +--- child of AccountStoreFrame_RightDisplay +--- @class AccountStoreFrame_RightDisplay_ShadowOverlay : Frame, ShadowOverlayTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L119) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_RightDisplay : Frame +--- @field ShadowOverlay AccountStoreFrame_RightDisplay_ShadowOverlay + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L128) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_CategoryList : Frame, AccountStoreCategoryListTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L135) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_StoreDisplay : Frame, AccountStoreItemDisplayTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L85) +--- child of AccountStoreFrame +--- @class AccountStoreFrame_PageText : FontString, GameFontHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L633) +--- child of AccountStoreFrame (created in template PortraitFrameTemplate) +--- @type PortraitFrameTemplate_CloseButton +AccountStoreFrameCloseButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L600) +--- child of AccountStoreFrame (created in template PortraitFrameTexturedBaseTemplate) +--- @type Texture +AccountStoreFrameBg = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L78) +--- @class AccountStoreFrame : Frame, PortraitFrameTemplate, PingReceiverAttributeTemplate, AccountStoreMixin +--- @field LeftInset AccountStoreFrame_LeftInset +--- @field RightInset AccountStoreFrame_RightInset +--- @field LeftDisplay AccountStoreFrame_LeftDisplay +--- @field RightDisplay AccountStoreFrame_RightDisplay +--- @field CategoryList AccountStoreFrame_CategoryList +--- @field StoreDisplay AccountStoreFrame_StoreDisplay +--- @field PageText AccountStoreFrame_PageText +AccountStoreFrame = {} +AccountStoreFrame["CloseButton"] = AccountStoreFrameCloseButton -- inherited +AccountStoreFrame["Bg"] = AccountStoreFrameBg -- inherited +AccountStoreFrame["layoutType"] = "PortraitFrameTemplate" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L167) +--- child of FullscreenAccountStoreContainer +--- @class FullscreenAccountStoreContainer_LeaveStoreButton : Button, BigRedThreeSliceButtonTemplate, FullscreenLeaveAccountStoreButtonMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStore.xml#L149) +--- @class FullscreenAccountStoreContainer : Frame, FullscreenAccountStoreContainerMixin +--- @field LeaveStoreButton FullscreenAccountStoreContainer_LeaveStoreButton +--- @field FullscreenBackground Texture +FullscreenAccountStoreContainer = {} + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.lua.annotated.lua new file mode 100644 index 0000000..c854429 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.lua.annotated.lua @@ -0,0 +1,367 @@ + +local AccountStoreCardUpdateCadenceSeconds = 1.0; +local CreatureModelSceneID = 76; +local TransmogModelSceneID = 420; +local DefaultTransmogSetAppearances = { + 169000, -- Chest + 169001, -- Waist + 169002, -- Legs + 169003, -- Boots +}; + + +AccountStoreBaseCardMixin = {};--- @class AccountStoreBaseCardMixin + +local AccountStoreBaseCardEvents = { + "UI_MODEL_SCENE_INFO_UPDATED", + "ACCOUNT_STORE_ITEM_INFO_UPDATED", +}; + +function AccountStoreBaseCardMixin:OnLoad() + self.BuyButton:SetScript("OnEnter", function() + if not self.BuyButton:IsEnabled() then + AccountStoreUtil.ShowDisabledItemInfoTooltip(self.BuyButton, self.itemInfo); + end + end); + + self.BuyButton:SetScript("OnLeave", function() + GetAppropriateTooltip():Hide(); + end); + + self.BuyButton:SetScript("OnClick", function() + self:SelectCard(); + end); + + self.ModelScene:SetScript("OnMouseWheel", function(modelSceneSelf, ...) + self:OnMouseWheel(...); + end); + + self.ModelScene:SetScript("OnEnter", function() + self:OnEnter(); + self:LockHighlight(); + end); + + self.ModelScene:SetScript("OnLeave", function() + self:OnLeave(); + self:UnlockHighlight(); + end); +end + +function AccountStoreBaseCardMixin:OnShow() + FrameUtil.RegisterFrameForEvents(self, AccountStoreBaseCardEvents); + + self:UpdateCardDisplay(); +end + +function AccountStoreBaseCardMixin:OnHide() + FrameUtil.UnregisterFrameForEvents(self, AccountStoreBaseCardEvents); +end + +function AccountStoreBaseCardMixin:OnEnter() + if not self.hoverSoundPlayed then + self.hoverSoundPlayed = true; + PlaySound(SOUNDKIT.ACCOUNT_STORE_ITEM_HOVER); + end + + local itemInfo = self.itemInfo; + local description = itemInfo.description; + if not description then + return; + end + + local tooltip = GetAppropriateTooltip(); + tooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_SetTitle(tooltip, itemInfo.name); + GameTooltip_AddNormalLine(tooltip, description); + + local isLocked = (itemInfo.mode == Enum.AccountStoreItemMode.Locked); + local isOwned = (itemInfo.status == Enum.AccountStoreItemStatus.Owned) or (itemInfo.status == Enum.AccountStoreItemStatus.Refundable); + if not isLocked and not isOwned and itemInfo.nonrefundable and (itemInfo.price > 0) then + GameTooltip_AddBlankLineToTooltip(tooltip); + GameTooltip_AddErrorLine(tooltip, ACCOUNT_STORE_NONREFUNDABLE_TOOLTIP); + end + + tooltip:Show(); +end + +function AccountStoreBaseCardMixin:OnLeave() + if not self:IsMouseOver() and not self.ModelScene:IsMouseOver() then + self.hoverSoundPlayed = false; + end + + GetAppropriateTooltip():Hide(); +end + +-- Set dynamically. +function AccountStoreBaseCardMixin:OnUpdate(dt) + self.timeSinceUpdate = (self.timeSinceUpdate or 0) + dt; + + if self.timeSinceUpdate > AccountStoreCardUpdateCadenceSeconds then + self.timeSinceUpdate = 0; + self:CheckForItemStateUpdate(); + end +end + +function AccountStoreBaseCardMixin:OnMouseWheel(delta) + CallMethodOnNearestAncestor(self, "OnMouseWheel", delta); +end + +function AccountStoreBaseCardMixin:OnEvent(event, ...) + if event == "UI_MODEL_SCENE_INFO_UPDATED" then + self:UpdateCardDisplay(); + elseif event == "ACCOUNT_STORE_ITEM_INFO_UPDATED" then + local itemID = ...; + if itemID == self.itemInfo.id then + self:SetItemID(itemID); + end + end +end + +local RefundTimeFormatter = CreateFromMixins(SecondsFormatterMixin); +RefundTimeFormatter:Init(0, SecondsFormatter.Abbreviation.OneLetter, SecondsFormatter.Interval.Minutes, true, true); +RefundTimeFormatter:SetStripIntervalWhitespace(true); +RefundTimeFormatter:SetMinInterval(SecondsFormatter.Interval.Minutes); + +function AccountStoreBaseCardMixin:SetItemID(itemID) + self.itemID = itemID; + + local itemInfo = C_AccountStore.GetItemInfo(itemID); + self.itemInfo = itemInfo; + + if not itemInfo then + self:Hide(); + return; + end + + self.Name:SetText(itemInfo.name); + + self:UpdateRefundTime(); + + local isOwned = (itemInfo.status == Enum.AccountStoreItemStatus.Owned) or (itemInfo.status == Enum.AccountStoreItemStatus.Refundable); + self.OwnedCheckmark:SetShown(isOwned); + + local displayNew = not isOwned and FlagsUtil.IsSet(self.itemInfo.flags, Enum.AccountStoreItemFlag.DisplayAsNew); + self.New:SetShown(displayNew); + + local showButton = (itemInfo.mode ~= Enum.AccountStoreItemMode.Locked); + self.BuyButton:SetShown(showButton); + + -- Card text and the model scene are anchored to the buy button which we want to adjust when it's hidden. + self.BuyButton:SetPoint("BOTTOM", 0, showButton and 25 or 0); + + if showButton then + local isRefundable = itemInfo.status == Enum.AccountStoreItemStatus.Refundable; + local canAfford = itemInfo.price <= C_AccountStore.GetCurrencyAvailable(itemInfo.currencyID); + local enabled = isRefundable or (canAfford and not isOwned); + self.BuyButton:SetEnabled(enabled); + + if isRefundable then + self.BuyButton:SetText(PLUNDERSTORE_REFUND_BUTTON_TEXT); + elseif isOwned then + self.BuyButton:SetText(PLUNDERSTORE_ALREADY_OWNED_TOOLTIP); + else + self.BuyButton:SetText(AccountStoreUtil.FormatCurrencyDisplay(itemInfo.price, itemInfo.currencyID)); + end + end + + if self:IsShown() then + self:UpdateCardDisplay(); + end +end + +function AccountStoreBaseCardMixin:SelectCard() + PlaySound(SOUNDKIT.ACCOUNT_STORE_ITEM_SELECT); + + local itemInfo = self.itemInfo; + local isRefundable = itemInfo.status == Enum.AccountStoreItemStatus.Refundable; + local confirmationFormat = isRefundable and ACCOUNT_STORE_REFUND_CONFIRMATION_FORMAT or PLUNDERSTORE_PURCHASE_CONFIRMATION_FORMAT; + local confirmation = confirmationFormat:format(itemInfo.name, AccountStoreUtil.FormatCurrencyDisplay(itemInfo.price, itemInfo.currencyID)); + + if StaticPopup_Hide then + StaticPopup_Hide("GENERIC_CONFIRMATION"); + + StaticPopup_ShowGenericConfirmation(confirmation, function () + if isRefundable then + PlaySound(SOUNDKIT.ACCOUNT_STORE_ITEM_REFUND); + C_AccountStore.RefundItem(itemInfo.id); + else + PlaySound(SOUNDKIT.ACCOUNT_STORE_ITEM_PURCHASE); + C_AccountStore.BeginPurchase(itemInfo.id); + end + end); + else + local text2 = nil; + StaticPopup_Show("ACCOUNT_STORE_BEGIN_PURCHASE_OR_REFUND", confirmation, text2, itemInfo); + end +end + +function AccountStoreBaseCardMixin:CheckForItemStateUpdate() + local refreshedItemInfo = C_AccountStore.GetItemInfo(self.itemID); + if not refreshedItemInfo then + return; + end + + refreshedItemInfo.status = Enum.AccountStoreItemStatus.Refundable; + + if refreshedItemInfo.status ~= self.itemInfo.status then + self:SetItemID(self.itemID); + elseif refreshedItemInfo.refundSecondsRemaining ~= self.itemInfo.refundSecondsRemaining then + self.itemInfo.refundSecondsRemaining = refreshedItemInfo.refundSecondsRemaining; + self:UpdateRefundTime(); + end +end + +function AccountStoreBaseCardMixin:UpdateRefundTime() + local itemInfo = self.itemInfo; + local refundable = (itemInfo.status == Enum.AccountStoreItemStatus.Refundable) and itemInfo.refundSecondsRemaining; + self.RefundText:SetShown(refundable); + self:SetScript("OnUpdate", refundable and self.OnUpdate or nil); + if refundable then + local timeString = RefundTimeFormatter:Format(itemInfo.refundSecondsRemaining); + self.RefundText:SetText(ACCOUNT_STORE_REFUND_TEXT_FORMAT:format(timeString)); + end +end + +function AccountStoreBaseCardMixin:UpdateCardDisplay() + -- Override in your derived Mixin. +end + + +AccountStoreCreatureCardMixin = {};--- @class AccountStoreCreatureCardMixin + +function AccountStoreCreatureCardMixin:UpdateCardDisplay() + if not self.itemInfo then + return; + end + + local forceUpdate = true; + self.ModelScene:SetFromModelSceneID(self.itemInfo.customUIModelSceneID or CreatureModelSceneID, forceUpdate); + + local creature = self.ModelScene:GetActorByTag("item"); + if creature then + creature:Hide(); + creature:SetOnModelLoadedCallback(function() + creature:Show(); + end); + + creature:SetModelByCreatureDisplayID(self.itemInfo.creatureDisplayID, forceUpdate); + end +end + + +AccountStoreIconCardMixin = {};--- @class AccountStoreIconCardMixin + +function AccountStoreIconCardMixin:UpdateCardDisplay() + if not self.itemInfo then + return; + end + + self.Icon:SetTexture(self.itemInfo.displayIcon); +end + + +AccountStoreTransmogSetCardMixin = {};--- @class AccountStoreTransmogSetCardMixin + +function AccountStoreTransmogSetCardMixin:UpdateCardDisplay() + if not self.itemInfo then + return; + end + + local modelSceneID = self.itemInfo.customUIModelSceneID or TransmogModelSceneID; + local forceUpdate = true; + self.ModelScene:SetFromModelSceneID(modelSceneID, forceUpdate); + + local function GetPlayerActorName() + local playerRaceName = nil; + local playerGender = nil; + if C_Glue.IsOnGlueScreen() then + local members = C_WoWLabsMatchmaking.GetCurrentParty(); + if TableIsEmpty(members) then + local characterGuid = GetCharacterGUID(GetCharacterSelection()); + if characterGuid then + local basicCharacterInfo = GetBasicCharacterInfo(characterGuid); + playerRaceName = basicCharacterInfo.raceFilename and basicCharacterInfo.raceFilename:lower(); + playerGender = basicCharacterInfo.genderEnum; + end + else + for i, member in ipairs(members) do + if member.isLocalPlayer then + playerRaceName = member.raceFilename and member.raceFilename:lower(); + playerGender = member.gender; + break; + end + end + end + else + local raceFilename = select(2, UnitRace("player")); + playerRaceName = raceFilename:lower(); + playerGender = UnitSex("player"); + end + + local useNativeForm = true; + local overrideActorName; + if playerRaceName == "dracthyr" then + useNativeForm = false; + overrideActorName = "dracthyr-alt"; + end + + return playerRaceName and playerRaceName:lower() or overrideActorName, playerGender, useNativeForm; + end + + local function SetUpPlayerActor() + if C_Glue.IsOnGlueScreen() then + local playerRaceName, playerGender, useNativeForm = GetPlayerActorName(); + local overrideActorName = nil; + local forceAlternateForm = nil; + local playerActor = self.ModelScene:GetPlayerActor(overrideActorName, forceAlternateForm, playerRaceName, playerGender); + if playerActor then + playerActor:ReleaseFrontEndCharacterDisplays(); + end + + local members = C_WoWLabsMatchmaking.GetCurrentParty(); + if TableIsEmpty(members) then + local flags = select(4, C_ModelInfo.GetModelSceneInfoByID(modelSceneID)); + local sheatheWeapons = bit.band(flags, Enum.UIModelSceneFlags.SheatheWeapon) == Enum.UIModelSceneFlags.SheatheWeapon; + local hideWeapons = bit.band(flags, Enum.UIModelSceneFlags.HideWeapon) == Enum.UIModelSceneFlags.HideWeapon; + local autoDress = bit.band(flags, Enum.UIModelSceneFlags.Autodress) == Enum.UIModelSceneFlags.Autodress; + playerActor:SetPlayerModelFromGlues(GetCharacterSelection() - 1, sheatheWeapons, autoDress, hideWeapons, useNativeForm); + else + for i, member in ipairs(members) do + if member.isLocalPlayer then + playerActor:SetFrontEndLobbyModelFromDefaultCharacterDisplay(i - 1); + end + end + end + + return playerActor; + else + local playerRaceName, playerGender, useNativeForm = GetPlayerActorName(); + local flags = select(4, C_ModelInfo.GetModelSceneInfoByID(modelSceneID)); + local sheatheWeapons = bit.band(flags, Enum.UIModelSceneFlags.SheatheWeapon) == Enum.UIModelSceneFlags.SheatheWeapon; + local hideWeapons = bit.band(flags, Enum.UIModelSceneFlags.HideWeapon) == Enum.UIModelSceneFlags.HideWeapon; + local autoDress = bit.band(flags, Enum.UIModelSceneFlags.Autodress) == Enum.UIModelSceneFlags.Autodress; + local itemModifiedAppearanceIDs = nil; -- We set these below. + local overrideActorName = nil; + local forceAlternateForm = nil; + SetupPlayerForModelScene(self.ModelScene, overrideActorName, itemModifiedAppearanceIDs, sheatheWeapons, autoDress, hideWeapons, useNativeForm, playerRaceName, playerGender); + return self.ModelScene:GetPlayerActor(overrideActorName, forceAlternateForm, playerRaceName, playerGender); + end + end + + local playerActor = SetUpPlayerActor(); + + local displayDefaultArmor = bit.band(self.itemInfo.flags, Enum.AccountStoreItemFlag.DisplayDefaultArmor) == Enum.AccountStoreItemFlag.DisplayDefaultArmor; + if displayDefaultArmor then + for i, itemModifiedAppearanceID in ipairs(DefaultTransmogSetAppearances) do + playerActor:TryOn(itemModifiedAppearanceID); + end + end + + for i, itemModifiedAppearanceID in ipairs(C_TransmogSets.GetAllSourceIDs(self.itemInfo.transmogSetID)) do + playerActor:TryOn(itemModifiedAppearanceID); + end +end + + +-- Duplicate behavior here. +AccountStoreMountCardMixin = AccountStoreCreatureCardMixin; \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml new file mode 100644 index 0000000..c842c07 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml @@ -0,0 +1,129 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml.annotated.lua new file mode 100644 index 0000000..6bef4ba --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml.annotated.lua @@ -0,0 +1,55 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L6) +--- child of AccountStoreBaseCardTemplate +--- @class AccountStoreBaseCardTemplate_BuyButton : Button, SharedButtonSmallTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L13) +--- child of AccountStoreBaseCardTemplate +--- @class AccountStoreBaseCardTemplate_ModelScene : ModelScene, PanningModelSceneMixinTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L20) +--- child of AccountStoreBaseCardTemplate +--- @class AccountStoreBaseCardTemplate_OwnedCheckmark : Frame +--- @field OwnedCheckmark Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L33) +--- child of AccountStoreBaseCardTemplate +--- @class AccountStoreBaseCardTemplate_New : Frame, NewFeatureLabelTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L41) +--- child of AccountStoreBaseCardTemplate +--- @class AccountStoreBaseCardTemplate_Name : FontString, GameFontNormalMed3 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L48) +--- child of AccountStoreBaseCardTemplate +--- @class AccountStoreBaseCardTemplate_RefundText : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L4) +--- Template +--- @class AccountStoreBaseCardTemplate : Button, AccountStoreBaseCardMixin +--- @field BuyButton AccountStoreBaseCardTemplate_BuyButton +--- @field ModelScene AccountStoreBaseCardTemplate_ModelScene +--- @field OwnedCheckmark AccountStoreBaseCardTemplate_OwnedCheckmark +--- @field New AccountStoreBaseCardTemplate_New +--- @field Name AccountStoreBaseCardTemplate_Name +--- @field RefundText AccountStoreBaseCardTemplate_RefundText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L68) +--- Template +--- @class AccountStoreCreatureCardTemplate : Button, AccountStoreBaseCardTemplate, AccountStoreCreatureCardMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L82) +--- Template +--- @class AccountStoreIconCardTemplate : Button, AccountStoreBaseCardTemplate, AccountStoreIconCardMixin +--- @field Icon Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L105) +--- Template +--- @class AccountStoreTransmogSetCardTemplate : Button, AccountStoreBaseCardTemplate, AccountStoreTransmogSetCardMixin +--- @field CardTexture Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCardTemplates.xml#L120) +--- Template +--- @class AccountStoreMountCardTemplate : Button, AccountStoreBaseCardTemplate, AccountStoreMountCardMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.lua.annotated.lua new file mode 100644 index 0000000..135738b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.lua.annotated.lua @@ -0,0 +1,78 @@ + +AccountStoreCategoryMixin = {};--- @class AccountStoreCategoryMixin + +function AccountStoreCategoryMixin:OnClick() + PlaySound(SOUNDKIT.ACCOUNT_STORE_CATEGORY_SELECT); + EventRegistry:TriggerEvent("AccountStore.CategorySelected", self.categoryID); +end + +function AccountStoreCategoryMixin:SetCategory(categoryID) + self.categoryID = categoryID; + + local categoryInfo = C_AccountStore.GetCategoryInfo(categoryID); + self.Text:SetText(categoryInfo.name); + self.Icon:SetTexture(categoryInfo.icon); +end + + +AccountStoreCategoryListMixin = {};--- @class AccountStoreCategoryListMixin + +function AccountStoreCategoryListMixin:OnLoad() + self.SelectionHighlight = self.ScrollBox.SelectionHighlight; + + self:InitScrollBox(); + + self:AddStaticEventMethod(EventRegistry, "AccountStore.StoreFrontSet", self.OnStoreFrontSet); + self:AddStaticEventMethod(EventRegistry, "AccountStore.CategorySelected", self.OnCategorySelected); +end + +function AccountStoreCategoryListMixin:InitScrollBox() + local view = CreateScrollBoxListLinearView(); + view:SetElementInitializer("AccountStoreCategoryTemplate", function(button, elementData) + button:SetCategory(elementData.categoryID); + end); + view:SetPadding(16, 0, 0, 0, 0); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); + + self.selectionBehavior = ScrollUtil.AddSelectionBehavior(self.ScrollBox, SelectionBehaviorFlags.Intrusive); + local function SelectionBehaviorCallback(selectionBehaviorSelf, elementData, selected) + if not selected then + self.SelectionHighlight:Hide(); + else + local button = self.ScrollBox:FindFrame(elementData); + if button then + self:SetRowSelectedState(button); + end + end + end + + self.selectionBehavior:RegisterCallback(SelectionBehaviorMixin.Event.OnSelectionChanged, SelectionBehaviorCallback, self); +end + +function AccountStoreCategoryListMixin:OnStoreFrontSet(storeFrontID) + self:SetCategories(C_AccountStore.GetCategories(storeFrontID)); +end + +function AccountStoreCategoryListMixin:OnCategorySelected(categoryID) + local button = self.ScrollBox:FindFrameByPredicate(function(frame, elementData) + return elementData.categoryID == categoryID; + end); + + if button then + self:SetRowSelectedState(button); + end +end + +function AccountStoreCategoryListMixin:SetCategories(categories) + local dataProvider = CreateDataProviderWithAssignedKey(categories, "categoryID"); + self.ScrollBox:SetDataProvider(dataProvider, ScrollBoxConstants.RetainScrollPosition); + + -- Start with the first category selected. + EventRegistry:TriggerEvent("AccountStore.CategorySelected", categories[1]); +end + +function AccountStoreCategoryListMixin:SetRowSelectedState(rowButton) + self.SelectionHighlight:SetPoint("CENTER", rowButton, "CENTER", 0, 2); + self.SelectionHighlight:Show(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml new file mode 100644 index 0000000..8d6fa5c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml.annotated.lua new file mode 100644 index 0000000..a2f8a6b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml.annotated.lua @@ -0,0 +1,35 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml#L13) +--- child of AccountStoreCategoryTemplate +--- @class AccountStoreCategoryTemplate_Text : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml#L4) +--- Template +--- @class AccountStoreCategoryTemplate : Button, AccountStoreCategoryMixin +--- @field Category Texture +--- @field Text AccountStoreCategoryTemplate_Text +--- @field Icon Texture +--- @field CircleMask MaskTexture +--- @field IconFrame Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml#L66) +--- child of AccountStoreCategoryListTemplate_ScrollBox +--- @class AccountStoreCategoryListTemplate_ScrollBox_SelectionHighlight : Frame +--- @field Highlight Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml#L60) +--- child of AccountStoreCategoryListTemplate +--- @class AccountStoreCategoryListTemplate_ScrollBox : Frame, WowScrollBoxList +--- @field SelectionHighlight AccountStoreCategoryListTemplate_ScrollBox_SelectionHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml#L78) +--- child of AccountStoreCategoryListTemplate +--- @class AccountStoreCategoryListTemplate_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreCategoryList.xml#L58) +--- Template +--- @class AccountStoreCategoryListTemplate : Frame, CallbackRegistrantTemplate, AccountStoreCategoryListMixin +--- @field ScrollBox AccountStoreCategoryListTemplate_ScrollBox +--- @field ScrollBar AccountStoreCategoryListTemplate_ScrollBar + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.lua.annotated.lua new file mode 100644 index 0000000..d6908d5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.lua.annotated.lua @@ -0,0 +1,184 @@ + +AccountStoreItemDisplayMixin = {};--- @class AccountStoreItemDisplayMixin + +local AccountStoreItemDisplayEvents = { + "ACCOUNT_STORE_CURRENCY_AVAILABLE_UPDATED", + "ACCOUNT_STORE_FRONT_UPDATED", + "ACCOUNT_STORE_TRANSACTION_ERROR", +}; + +function AccountStoreItemDisplayMixin:InitializeStore(storeFrontID) + -- First store, or store change + if (not self.storeFrontID) or (storeFrontID ~= self.storeFrontID) then + self.categoryLastPage = {}; -- Last page viewed for each category + self.currentPage = 0; + self.storeFrontID = storeFrontID; + end + + self.areItemsAvailable = false; + if self.currentItemRack then + local items = {}; + self.currentItemRack:SetItems(items); + end + if self.categoryTypeToItemRack then + for cateogryType, itemRack in pairs(self.categoryTypeToItemRack) do + itemRack:Hide(); + end + else + self.categoryTypeToItemRack = {}; + end +end + +function AccountStoreItemDisplayMixin:OnLoad() + self:InitializeStore(); + + self.Footer.PrevPageButton:SetScript("OnClick", function() + PlaySound(SOUNDKIT.ACCOUNT_STORE_PAGE_NAVIGATION); + self:SetPage(self.currentPage - 1); + end); + + self.Footer.NextPageButton:SetScript("OnClick", function() + PlaySound(SOUNDKIT.ACCOUNT_STORE_PAGE_NAVIGATION); + self:SetPage(self.currentPage + 1); + end); + + self.Footer.CurrencyAvailable:SetScript("OnEnter", function(onEnterSelf) + local tooltip = GetAppropriateTooltip(); + tooltip:SetOwner(onEnterSelf, "ANCHOR_RIGHT"); + + local accountStoreCurrencyID = C_AccountStore.GetCurrencyIDForStore(Constants.AccountStoreConsts.PlunderstormStoreFrontID); + if accountStoreCurrencyID then + AccountStoreUtil.AddCurrencyTotalTooltip(tooltip, accountStoreCurrencyID); + tooltip:Show(); + end + end); + + self.Footer.CurrencyAvailable:SetScript("OnLeave", function() GetAppropriateTooltip():Hide(); end); + + self:AddStaticEventMethod(EventRegistry, "AccountStore.StoreFrontSet", self.OnStoreFrontSet); + self:AddStaticEventMethod(EventRegistry, "AccountStore.CategorySelected", self.OnCategorySelected); +end + +function AccountStoreItemDisplayMixin:OnShow() + CallbackRegistrantMixin.OnShow(self); + + self.areItemsAvailable = false; + + FrameUtil.RegisterFrameForEvents(self, AccountStoreItemDisplayEvents); +end + +function AccountStoreItemDisplayMixin:OnHide() + CallbackRegistrantMixin.OnHide(self); + AccountStoreUtil.CloseStaticPopups(); + + local items = {}; + self.currentItemRack:SetItems(items); + + FrameUtil.UnregisterFrameForEvents(self, AccountStoreItemDisplayEvents); +end + +function AccountStoreItemDisplayMixin:OnEvent(event, ...) + if event == "ACCOUNT_STORE_CURRENCY_AVAILABLE_UPDATED" then + local currencyID = ...; + if currencyID == self.currencyID then + self:UpdateCurrencyAvailable(); + end + elseif event == "ACCOUNT_STORE_FRONT_UPDATED" then + local storeFrontID = ...; + if storeFrontID == self.storeFrontID then + self.areItemsAvailable = true; + local forceUpdate = true; + self:OnCategorySelected(self.categoryID, forceUpdate); + self.currentItemRack:Show(); + end + elseif event == "ACCOUNT_STORE_TRANSACTION_ERROR" then + local resultCode = ...; + StaticPopup_Show("ACCOUNT_STORE_TRANSACTION_ERROR"); + end +end + +function AccountStoreItemDisplayMixin:OnMouseWheel(delta) + self:SetPage(self.currentPage + ((delta < 0) and 1 or -1)); +end + +function AccountStoreItemDisplayMixin:OnStoreFrontSet(storeFrontID) + self:InitializeStore(storeFrontID); + + if self.storeFrontID then + C_AccountStore.RequestStoreFrontInfoUpdate(self.storeFrontID); + self.currencyID = C_AccountStore.GetCurrencyIDForStore(self.storeFrontID); + self:UpdateCurrencyAvailable(); + end +end + +function AccountStoreItemDisplayMixin:OnCategorySelected(categoryID, forceUpdate) + local pageForceUpdate = forceUpdate; + if categoryID ~= self.categoryID or forceUpdate then + self.categoryID = categoryID; + self.categoryItems = C_AccountStore.GetCategoryItems(categoryID); + + local categoryInfo = C_AccountStore.GetCategoryInfo(categoryID); + local categoryType = categoryInfo.type; + local itemRack = GetOrCreateTableEntryByCallback(self.categoryTypeToItemRack, categoryType, GenerateClosure(self.CreateItemRack, self, categoryType)); + + if self.currentItemRack then + self.currentItemRack:Hide(); + end + + self.currentItemRack = itemRack; + pageForceUpdate = true; + end + + local pageToShow = self.categoryLastPage[categoryID] or 1; + self:SetPage(pageToShow, pageForceUpdate); + self.currentItemRack:Show(); +end + +function AccountStoreItemDisplayMixin:CreateItemRack(categoryType) + local itemRack = CreateFrame("Frame", nil, self, "AccountStoreItemRackTemplate"); + itemRack:SetCategoryType(categoryType); + itemRack:SetPoint("TOPLEFT"); + itemRack:SetPoint("BOTTOMRIGHT"); + self.categoryTypeToItemRack[categoryType] = itemRack; + return itemRack; +end + +function AccountStoreItemDisplayMixin:GetMaxPage() + return math.ceil(#self.categoryItems / self.currentItemRack:GetMaxCards()); +end + +function AccountStoreItemDisplayMixin:SetPage(page, forceUpdate) + local maxPage = self:GetMaxPage(); + page = Clamp(page, 1, maxPage); + + if page == self.currentPage and not forceUpdate then + return; + end + + self.currentPage = page; + + local items = {}; + if self.areItemsAvailable then + local maxCardsPerPage = self.currentItemRack:GetMaxCards(); + for i = 1, page * maxCardsPerPage do + local itemIndex = (page - 1) * maxCardsPerPage + i; + table.insert(items, self.categoryItems[itemIndex]); + end + self.categoryLastPage[self.categoryID] = page; + end + + self.currentItemRack:SetItems(items); + + self.Footer.PrevPageButton:SetEnabled(page > 1); + self.Footer.NextPageButton:SetEnabled(page < maxPage); + self.Footer.PageText:SetText(ACCOUNT_STORE_PAGE_WIDGET_FORMAT:format(page, maxPage)); +end + +function AccountStoreItemDisplayMixin:UpdateCurrencyAvailable() + local currencyID = self.currencyID; + self.Footer.CurrencyAvailable:SetText(AccountStoreUtil.FormatCurrencyDisplayWithWarning(currencyID)); + + if self.currentItemRack then + self.currentItemRack:Refresh(); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml new file mode 100644 index 0000000..49ab998 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml.annotated.lua new file mode 100644 index 0000000..e9de00f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml.annotated.lua @@ -0,0 +1,31 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml#L8) +--- child of AccountStoreItemDisplayTemplate_Footer +--- @class AccountStoreItemDisplayTemplate_Footer_NextPageButton : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml#L18) +--- child of AccountStoreItemDisplayTemplate_Footer +--- @class AccountStoreItemDisplayTemplate_Footer_PrevPageButton : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml#L31) +--- child of AccountStoreItemDisplayTemplate_Footer +--- @class AccountStoreItemDisplayTemplate_Footer_CurrencyAvailable : FontString, GameFontHighlightLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml#L38) +--- child of AccountStoreItemDisplayTemplate_Footer +--- @class AccountStoreItemDisplayTemplate_Footer_PageText : FontString, GameFontHighlightLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml#L6) +--- child of AccountStoreItemDisplayTemplate +--- @class AccountStoreItemDisplayTemplate_Footer : Frame +--- @field NextPageButton AccountStoreItemDisplayTemplate_Footer_NextPageButton +--- @field PrevPageButton AccountStoreItemDisplayTemplate_Footer_PrevPageButton +--- @field CurrencyAvailable AccountStoreItemDisplayTemplate_Footer_CurrencyAvailable +--- @field PageText AccountStoreItemDisplayTemplate_Footer_PageText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemDisplay.xml#L4) +--- Template +--- @class AccountStoreItemDisplayTemplate : Frame, CallbackRegistrantTemplate, AccountStoreItemDisplayMixin +--- @field Footer AccountStoreItemDisplayTemplate_Footer + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.lua.annotated.lua new file mode 100644 index 0000000..f967977 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.lua.annotated.lua @@ -0,0 +1,56 @@ + + +local function GenerateAccountStoreCategoryInfo(cardTemplate, maxCards) + return { + cardTemplate = cardTemplate, + maxCards = maxCards + }; +end + +local AccountStoreCategoryToInfo = { + [Enum.AccountStoreCategoryType.Creature] = GenerateAccountStoreCategoryInfo("AccountStoreCreatureCardTemplate", 4), + [Enum.AccountStoreCategoryType.TransmogSet] = GenerateAccountStoreCategoryInfo("AccountStoreTransmogSetCardTemplate", 2), + [Enum.AccountStoreCategoryType.Mount] = GenerateAccountStoreCategoryInfo("AccountStoreMountCardTemplate", 1), + [Enum.AccountStoreCategoryType.Icon] = GenerateAccountStoreCategoryInfo("AccountStoreIconCardTemplate", 4), +}; + + +AccountStoreItemRackMixin = {};--- @class AccountStoreItemRackMixin + +function AccountStoreItemRackMixin:SetCategoryType(categoryType) + local categoryInfo = AccountStoreCategoryToInfo[categoryType]; + self.cardPool = CreateFramePool("BUTTON", self, categoryInfo.cardTemplate); + self.maxCards = categoryInfo.maxCards; +end + +function AccountStoreItemRackMixin:SetItems(items) + self.items = items; + self:Refresh(); +end + +function AccountStoreItemRackMixin:Refresh() + self.cardPool:ReleaseAll(); + + local items = self.items; + local function AccountStoreItemRackFactoryFunction(index) + local card = self.cardPool:Acquire(); + card:SetItemID(items[index]); + return card; + end + + local anchorPoint = (self.maxCards == 1) and "TOP" or "TOPLEFT"; + local initialAnchor = AnchorUtil.CreateAnchor(anchorPoint, self, anchorPoint); + local stride = 2; + local paddingX = 5; + local paddingY = 5; + local layout = AnchorUtil.CreateGridLayout(GridLayoutMixin.Direction.TopLeftToBottomRight, stride, paddingX, paddingY); + AnchorUtil.GridLayoutFactoryByCount(AccountStoreItemRackFactoryFunction, math.min(#items, self:GetMaxCards()), initialAnchor, layout); + + for card in self.cardPool:EnumerateActive() do + card:Show(); + end +end + +function AccountStoreItemRackMixin:GetMaxCards() + return self.maxCards; +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml new file mode 100644 index 0000000..7f39ea9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml.annotated.lua new file mode 100644 index 0000000..af2c8ac --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml.annotated.lua @@ -0,0 +1,6 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreItemRack.xml#L4) +--- Template +--- @class AccountStoreItemRackTemplate : Frame, CallbackRegistrantTemplate, AccountStoreItemRackMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreUtil.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreUtil.lua.annotated.lua new file mode 100644 index 0000000..1d076ce --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AccountStore/Blizzard_AccountStoreUtil.lua.annotated.lua @@ -0,0 +1,144 @@ + +local AccountStoreWarningThresholdPercentage = 0.66; +local AlertIconTexture = [[Interface\DialogFrame\UI-Dialog-Icon-AlertNew]]; + +local function PrependWarning(text) + return CreateSimpleTextureMarkup(AlertIconTexture, 12, 12) .. " " .. text; +end + +AccountStoreUtil = {}; + +StaticPopupDialogs["ACCOUNT_STORE_TRANSACTION_ERROR"] = { + text = NORMAL_FONT_COLOR:WrapTextInColorCode(ACCOUNT_STORE_INCOMPLETE_TRANSACTION), + button1 = OKAY, + showAlert = true, + hideOnEscape = 1, + timeout = 0, + whileDead = 1, +} + +local ACCOUNT_STORE_STATIC_POPUPS = { + "ACCOUNT_STORE_TRANSACTION_ERROR", +}; + +function AccountStoreUtil.CloseStaticPopups() + for i, popup in ipairs(ACCOUNT_STORE_STATIC_POPUPS) do + if StaticPopup_Visible(popup) then + StaticPopup_Hide(popup); + end + end +end + +function AccountStoreUtil.SetAccountStoreShown(shown) + if AccountStoreFrame:IsShown() == shown then + return; + end + + if shown then + if ShowUIPanel then + ShowUIPanel(AccountStoreFrame); + else + AccountStoreFrame:Show(); + end + else + if HideUIPanel then + HideUIPanel(AccountStoreFrame); + else + AccountStoreFrame:Hide(); + end + end +end + +function AccountStoreUtil.ToggleAccountStore() + AccountStoreUtil.SetAccountStoreShown(not AccountStoreFrame:IsShown()); +end + +function AccountStoreUtil.FormatCurrencyDisplay(currencyAmount, accountStoreCurrencyID) + local currencyInfo = C_AccountStore.GetCurrencyInfo(accountStoreCurrencyID); + if not currencyInfo.icon then + return ""; + end + + return BreakUpLargeNumbers(currencyAmount) .. " " .. CreateSimpleTextureMarkup(currencyInfo.icon, 12, 12); +end + +function AccountStoreUtil.IsCurrencyAtWarningThreshold(accountStoreCurrencyID) + local currencyInfo = C_AccountStore.GetCurrencyInfo(accountStoreCurrencyID); + if currencyInfo and currencyInfo.maxQuantity then + return currencyInfo.amount >= (currencyInfo.maxQuantity * AccountStoreWarningThresholdPercentage); + end + + return false; +end + +function AccountStoreUtil.FormatCurrencyDisplayWithWarning(accountStoreCurrencyID, currencyAmount, hideIcon) + local currencyInfo = accountStoreCurrencyID and C_AccountStore.GetCurrencyInfo(accountStoreCurrencyID) or nil; + if not currencyInfo then + return ""; + end + + local function AppendIcon(text) + return text .. " " .. CreateSimpleTextureMarkup(currencyInfo.icon, 12, 12); + end + + currencyAmount = BreakUpLargeNumbers(currencyAmount or currencyInfo.amount); + local showWarning = false; + if currencyInfo.maxQuantity then + if currencyInfo.amount >= currencyInfo.maxQuantity then + currencyAmount = RED_FONT_COLOR:WrapTextInColorCode(currencyAmount); + showWarning = true; + elseif currencyInfo.amount >= (currencyInfo.maxQuantity * AccountStoreWarningThresholdPercentage) then + currencyAmount = NORMAL_FONT_COLOR:WrapTextInColorCode(currencyAmount); + showWarning = true; + end + end + + local currencyText = currencyAmount; + if not hideIcon then + currencyText = AppendIcon(currencyText); + end + + if showWarning then + currencyText = PrependWarning(currencyText); + end + + return currencyText; +end + +function AccountStoreUtil.AddCurrencyTotalTooltip(tooltip, accountStoreCurrencyID) + local currencyInfo = C_AccountStore.GetCurrencyInfo(accountStoreCurrencyID); + if not currencyInfo then + return false; + end + + GameTooltip_AddNormalLine(tooltip, currencyInfo.name); + + if currencyInfo.maxQuantity then + if currencyInfo.amount >= currencyInfo.maxQuantity then + local text = PrependWarning(ACCOUNT_STORE_CURRENCY_MAX_TOOLTIP_FORMAT:format(currencyInfo.name)); + GameTooltip_AddNormalLine(tooltip, text); + elseif currencyInfo.amount >= (currencyInfo.maxQuantity * AccountStoreWarningThresholdPercentage) then + local text = PrependWarning(ACCOUNT_STORE_CURRENCY_APPROACHING_MAX_TOOLTIP_FORMAT:format(currencyInfo.name)); + GameTooltip_AddNormalLine(tooltip, text); + end + + GameTooltip_AddHighlightLine(tooltip, ACCOUNT_STORE_CURRENCY_TOTAL_TOOLTIP_FORMAT:format(BreakUpLargeNumbers(currencyInfo.amount), BreakUpLargeNumbers(currencyInfo.maxQuantity))); + return true; + end + + -- No tooltip needed. + return false; +end + +function AccountStoreUtil.ShowDisabledItemInfoTooltip(frame, itemInfo) + local tooltip = GetAppropriateTooltip(); + tooltip:SetOwner(frame, "ANCHOR_RIGHT"); + + if itemInfo.status == Enum.AccountStoreItemStatus.Refundable then + tooltip:SetText(PLUNDERSTORE_REFUNDABLE_TOOLTIP); + elseif itemInfo.status == Enum.AccountStoreItemStatus.Owned then + tooltip:SetText(HIGHLIGHT_FONT_COLOR:WrapTextInColorCode(AccountStoreUtil.FormatCurrencyDisplay(itemInfo.price, itemInfo.currencyID))); + else + tooltip:SetText(PLUNDERSTORE_INSUFFICIENT_FUNDS_TOOLTIP); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Blizzard_AchievementUI_Mainline.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Blizzard_AchievementUI_Mainline.toc new file mode 100644 index 0000000..99c383e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Blizzard_AchievementUI_Mainline.toc @@ -0,0 +1,9 @@ +## Title: Blizzard_AchievementUI +## Secure: 1 +## Author: Blizzard Entertainment +## Version: 1.0 +## LoadOnDemand: 1 +## AllowLoadGameType: mainline +Mainline\Blizzard_AchievementUI.lua +Mainline\Blizzard_AchievementUI.xml +Mainline\Localization.lua \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.lua.annotated.lua new file mode 100644 index 0000000..31e2c7d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.lua.annotated.lua @@ -0,0 +1,3631 @@ + +UIPanelWindows["AchievementFrame"] = { area = "doublewide", pushable = 0, xoffset = 80, whileDead = 1 }; + +ACHIEVEMENT_GOLD_BORDER_COLOR = CreateColor(1, 0.675, 0.125); +ACHIEVEMENT_RED_BORDER_COLOR = CreateColor(0.7, 0.15, 0.05); +ACHIEVEMENT_BLUE_BORDER_COLOR = CreateColor(0.129, 0.671, 0.875); +ACHIEVEMENT_YELLOW_BORDER_COLOR = CreateColor(0.4, 0.2, 0.0); + +ACHIEVEMENTCOMPARISON_PLAYERSHIELDFONT1 = GameFontNormal; +ACHIEVEMENTCOMPARISON_PLAYERSHIELDFONT2 = GameFontNormalSmall; +ACHIEVEMENTCOMPARISON_FRIENDSHIELDFONT1 = GameFontNormalSmall; +ACHIEVEMENTCOMPARISON_FRIENDSHIELDFONT2 = GameFontNormalSmall; + +ACHIEVEMENTUI_CATEGORIESWIDTH = 175; + +ACHIEVEMENTUI_PROGRESSIVEHEIGHT = 50; +ACHIEVEMENTUI_PROGRESSIVEWIDTH = 42; + +ACHIEVEMENTUI_MAX_SUMMARY_ACHIEVEMENTS = 4; + +ACHIEVEMENTUI_MAXCONTENTWIDTH = 330; +ACHIEVEMENTUI_CRITERIACHECKWIDTH = 20; +local ACHIEVEMENTUI_FONTHEIGHT; -- set in AchievementButton_OnLoad +local ACHIEVEMENTUI_MAX_LINES_COLLAPSED = 3; -- can show 3 lines of text when achievement is collapsed + +ACHIEVEMENTUI_DEFAULTSUMMARYACHIEVEMENTS = {6, 503, 116, 545, 1017}; +ACHIEVEMENTUI_SUMMARYCATEGORIES = {92, 96, 97, 15522, 95, 168, 169, 201, 155, 15117, 15246}; -- Additions/Subtractions may require minor anchoring changes to the category frames in $parentCategories. +ACHIEVEMENTUI_DEFAULTGUILDSUMMARYACHIEVEMENTS = {5362, 4860, 4989, 4947}; +ACHIEVEMENTUI_GUILDSUMMARYCATEGORIES = {15088, 15077, 15078, 15079, 15080, 15089}; + +ACHIEVEMENT_CATEGORY_NORMAL_R = 0; +ACHIEVEMENT_CATEGORY_NORMAL_G = 0; +ACHIEVEMENT_CATEGORY_NORMAL_B = 0; +ACHIEVEMENT_CATEGORY_NORMAL_A = .9; + +ACHIEVEMENT_CATEGORY_HIGHLIGHT_R = 0; +ACHIEVEMENT_CATEGORY_HIGHLIGHT_G = .6; +ACHIEVEMENT_CATEGORY_HIGHLIGHT_B = 0; +ACHIEVEMENT_CATEGORY_HIGHLIGHT_A = .65; + +ACHIEVEMENTBUTTON_LABELWIDTH = 320; + +ACHIEVEMENT_COMPARISON_SUMMARY_ID = -1; +ACHIEVEMENT_COMPARISON_STATS_SUMMARY_ID = -2; + +ACHIEVEMENT_FILTER_ALL = 1; +ACHIEVEMENT_FILTER_COMPLETE = 2; +ACHIEVEMENT_FILTER_INCOMPLETE = 3; + +local FORCE_COLUMNS_MAX_WIDTH = 220; -- if no columns normally, force 2 if max criteria width is <= this and number of criteria >= MIN_CRITERIA +local FORCE_COLUMNS_MIN_CRITERIA = 20; +local FORCE_COLUMNS_LEFT_OFFSET = -10; -- offset for left column +local FORCE_COLUMNS_RIGHT_OFFSET = 24; -- offset for right column +local FORCE_COLUMNS_RIGHT_COLUMN_SPACE = 150; -- max room for first entry of the right column due to achievement shield + +AchievementFrameFilterStrings = {ACHIEVEMENT_FILTER_ALL_EXPLANATION, +ACHIEVEMENT_FILTER_COMPLETE_EXPLANATION, ACHIEVEMENT_FILTER_INCOMPLETE_EXPLANATION}; + +local FEAT_OF_STRENGTH_ID = 81; +local GUILD_FEAT_OF_STRENGTH_ID = 15093; +local GUILD_CATEGORY_ID = 15076; +local TEXTURES_OFFSET = 0; -- 0.5 when in guild view + +local ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS = 5; +local ACHIEVEMENT_FRAME_SHOW_ALL_RESULTS_INDEX = ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS + 1; + +local guildMemberRequestFrame; + +local trackedAchievements = {}; +local achievementFunctions; +local function updateTrackedAchievements(achievementIDs) + trackedAchievements = {}; + for i, id in ipairs(achievementIDs) do + trackedAchievements[id] = true; + end +end + +local AchievementCategoryIndex = 1; +local GuildCategoryIndex = 2; +local StatisticsCategoryIndex = 3; +local g_achievementSelectionBehavior = nil; +local g_achievementSelections = {{},{},{}}; +local function GetSelectedAchievement() + local categoryIndex = achievementFunctions.categoryIndex; + return g_achievementSelections[categoryIndex].id or 0; +end + +local g_categorySelections = {{},{},{}}; +local function GetSelectedCategory() + local categoryIndex = achievementFunctions.categoryIndex; + return g_categorySelections[categoryIndex].id or 0; +end + +local function SetSelectedAchievement(elementData) + local categoryIndex = achievementFunctions.categoryIndex; + g_achievementSelections[categoryIndex] = elementData or {}; +end + +local function ClearSelectedCategories() + g_categorySelections = {{},{},{}}; +end + +local function InGuildView() + return achievementFunctions == GUILD_ACHIEVEMENT_FUNCTIONS; +end + +local function IsCategoryFeatOfStrength(category) + return category == FEAT_OF_STRENGTH_ID or category == GUILD_FEAT_OF_STRENGTH_ID +end + +local function AchievementFrameCategories_MakeCategoryList(source, fakeSummaryId) + local categories = {}; + if fakeSummaryId then + tinsert(categories, { id = fakeSummaryId }); + end + + for i, id in next, source do + local _, parent = GetCategoryInfo(id); + if ( parent == -1 or parent == GUILD_CATEGORY_ID ) then + tinsert(categories, { id = id }); + end + end + + local _, parent; + for i = #source, 1, -1 do + _, parent = GetCategoryInfo(source[i]); + for j, category in next, categories do + if ( category.id == parent ) then + category.parent = true; + category.collapsed = true; + local elementData = { + id = source[i], + parent = category.id, + hidden = true, + isChild = (type(category.id) == "number"), + }; + tinsert(categories, j+1, elementData); + end + end + end + return categories; +end + +ACHIEVEMENT_FUNCTIONS = { + categoryIndex = AchievementCategoryIndex, + categories = AchievementFrameCategories_MakeCategoryList(GetCategoryList(), "summary"), +} + +GUILD_ACHIEVEMENT_FUNCTIONS = { + categoryIndex = GuildCategoryIndex, + categories = AchievementFrameCategories_MakeCategoryList(GetGuildCategoryList(), "summary"), +} + +STAT_FUNCTIONS = { + categoryIndex = StatisticsCategoryIndex, + categories = AchievementFrameCategories_MakeCategoryList(GetStatisticsCategoryList()), +} + +COMPARISON_ACHIEVEMENT_FUNCTIONS = { + categoryIndex = AchievementCategoryIndex, + categories = AchievementFrameCategories_MakeCategoryList(GetCategoryList()), +} + +COMPARISON_STAT_FUNCTIONS = { + categoryIndex = StatisticsCategoryIndex, + categories = AchievementFrameCategories_MakeCategoryList(GetStatisticsCategoryList()), +} + +achievementFunctions = ACHIEVEMENT_FUNCTIONS; + +local function AchievementFrame_GetOrSelectCurrentCategory() + local category = GetSelectedCategory(); + if category == 0 then + AchievementFrameCategories_SelectDefaultElementData(); + return GetSelectedCategory(); + end + return category; +end + +local function AchievementFrame_OnAchievementLinkedInChat(achievementID) + local chatType = ChatFrameUtil.GetActiveChatType(); + if chatType == "WHISPER" then + C_AchievementTelemetry.LinkAchievementInWhisper(achievementID); + elseif chatType == "CHANNEL" then + local editBox = ChatFrameUtil.GetActiveWindow(); + local _localID, _channelName, _instanceID, isCommunitiesChannel = GetChannelName(editBox:GetChannelTarget()) + if isCommunitiesChannel then + C_AchievementTelemetry.LinkAchievementInClub(achievementID); + end + end +end + +-- [[ AchievementFrame ]] -- + +function AchievementFrame_ToggleAchievementFrame(toggleStatFrame, toggleGuildView) + AchievementFrameComparison:Hide(); + if C_GameRules.IsGameRuleActive(Enum.GameRule.AchievementsPanelDisabled) then + return; + end + + AchievementFrameTab_OnClick = AchievementFrameBaseTab_OnClick; + if ( not toggleStatFrame ) then + if ( AchievementFrame:IsShown() and AchievementFrame.selectedTab == 1 ) then + HideUIPanel(AchievementFrame); + else + AchievementFrame_SetTabs(); + ShowUIPanel(AchievementFrame); + if ( toggleGuildView ) then + AchievementFrameTab_OnClick(2); + else + AchievementFrameTab_OnClick(1); + end + end + return; + end + if ( AchievementFrame:IsShown() and AchievementFrame.selectedTab == 3 ) then + HideUIPanel(AchievementFrame); + else + ShowUIPanel(AchievementFrame); + AchievementFrame_SetTabs(); + AchievementFrameTab_OnClick(3); + end +end + +function AchievementFrame_DisplayComparison (unit) + ClearSelectedCategories(); + + AchievementFrameTab_OnClick = AchievementFrameComparisonTab_OnClick; + AchievementFrameTab_OnClick(1); + AchievementFrame_SetComparisonTabs(); + ShowUIPanel(AchievementFrame); + AchievementFrame_ShowSubFrame(AchievementFrameComparison, AchievementFrameComparison.AchievementContainer); + AchievementFrameComparison_SetUnit(unit); + AchievementFrameComparison_ForceUpdate(); +end + +function AchievementFrame_OnLoad (self) + PanelTemplates_SetNumTabs(self, 3); + self.selectedTab = 1; + PanelTemplates_UpdateTabs(self); + + local function IsFilterSelected(filter) + return ACHIEVEMENTUI_SELECTEDFILTER == filter.func; + end + + local function SetFilterSelected(filter) + if filter.func ~= ACHIEVEMENTUI_SELECTEDFILTER then + ACHIEVEMENTUI_SELECTEDFILTER = filter.func; + AchievementFrameAchievements_ForceUpdate(); + end + end + + AchievementFrameFilterDropdown:SetWidth(112); + AchievementFrameFilterDropdown:SetFrameLevel(AchievementFrameFilterDropdown:GetFrameLevel() + 1); + AchievementFrameFilterDropdown:SetupMenu(function(dropdown, rootDescription) + rootDescription:SetTag("MENU_ACHIEVEMENT_FILTER", block); + + for i, filter in ipairs(AchievementFrameFilters) do + local radio = rootDescription:CreateRadio(filter.text, IsFilterSelected, SetFilterSelected, filter); + radio:SetTooltip(function(tooltip, elementDescription) + GameTooltip_SetTitle(tooltip, ACHIEVEMENT_FILTER_TITLE); + GameTooltip_AddNormalLine(tooltip, AchievementFrameFilterStrings[i]); + end); + end + end); + + self.PlaceholderHiddenDescription:SetWidth(ACHIEVEMENTUI_MAXCONTENTWIDTH); +end + +function AchievementFrame_OnShow (self) + PlaySound(SOUNDKIT.ACHIEVEMENT_MENU_OPEN); + AchievementFrame.Header.Points:SetText(BreakUpLargeNumbers(GetTotalAchievementPoints())); + UpdateMicroButtons(); + + C_AchievementTelemetry.ShowAchievements(); + + local gameRule = Enum.GameRule.RestrictedAchievementCategoryID; + local restrictedCategoryID = C_GameRules.IsGameRuleActive(gameRule) and C_GameRules.GetGameRuleAsFloat(gameRule) or nil; + AchievementFrame_SetRestrictedMode(self, restrictedCategoryID); +end + +function AchievementFrame_OnHide (self) + PlaySound(SOUNDKIT.ACHIEVEMENT_MENU_CLOSE); + AchievementFrame_HideSearchPreview(); + self.SearchResults:Hide(); + self.SearchBox:SetText(""); + UpdateMicroButtons(); +end + +function AchievementFrame_SetRestrictedMode (self, restrictedCategoryID) + self.restrictedCategoryID = restrictedCategoryID; + + local isRestricted = restrictedCategoryID ~= nil; + self.Header:SetShown(not isRestricted); + self.SearchBox:SetShown(not isRestricted); + if isRestricted then + self.searchProgressBar:Hide(); + end + + PanelTemplates_SetAllTabsShown(self, not isRestricted); + + AchievementFrame_UpdateAndSelectCategory(restrictedCategoryID); +end + +function AchievementFrame_HideFilterDropdown (self) + self.FilterDropdown:Hide(); + self.Header.LeftDDLInset:Hide(); +end + +function AchievementFrame_TryShowFilterDropdown (self) + if not self.restrictedCategoryID then + self.FilterDropdown:Show(); + self.Header.LeftDDLInset:Show(); + end +end + +function AchievementFrame_ForceUpdate () + if ( AchievementFrameAchievements:IsShown() ) then + AchievementFrameAchievements_ForceUpdate(); + elseif ( AchievementFrameStats:IsShown() ) then + AchievementFrameStats_UpdateDataProvider(); + elseif ( AchievementFrameComparison:IsShown() ) then + AchievementFrameComparison_ForceUpdate(); + end +end + +function AchievementFrame_SetTabs() + PanelTemplates_ShowTab(AchievementFrame, 2); + AchievementFrameTab3:SetPoint("LEFT", AchievementFrameTab2, "RIGHT", -5, 0); +end + +function AchievementFrame_SetComparisonTabs() + PanelTemplates_HideTab(AchievementFrame, 2); + AchievementFrameTab3:SetPoint("LEFT", AchievementFrameTab1, "RIGHT", -5, 0); +end + +function AchievementFrame_UpdateTabs(clickedTab) + AchievementFrame.SearchResults:Hide(); + PanelTemplates_Tab_OnClick(_G["AchievementFrameTab"..clickedTab], AchievementFrame); + for i = 1, 3 do + local tab = _G["AchievementFrameTab"..i]; + local y = i == clickedTab and -5 or -3; + tab.Text:SetPoint("CENTER", 0, y); + end +end + +function AchievementFrame_RefreshView() + if InGuildView() then + TEXTURES_OFFSET = 0.5; + AchievementFrameAchievements.Background:SetTexCoord(0, 1, 0.5, 1); + AchievementFrameSummary.Background:SetTexCoord(0, 1, 0.5, 1); + AchievementFrame.Header.Points:SetVertexColor(0, 1, 0); + AchievementFrame.Header.Title:SetText(GUILD_ACHIEVEMENTS_TITLE); + local shield = AchievementFrame.Header.Shield; + shield:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Guild"); + shield:SetTexCoord(0.63281250, 0.67187500, 0.13085938, 0.16601563); + shield:SetHeight(18); + local bkgR, bkgG, bkgB, borderR, borderG, borderB, emblemR, emblemG, emblemB, emblemFilename = GetGuildLogoInfo(); + if ( emblemFilename ) then + AchievementFrameGuildEmblemLeft:SetTexture(emblemFilename); + AchievementFrameGuildEmblemRight:SetTexture(emblemFilename); + local r, g, b = ACHIEVEMENT_YELLOW_BORDER_COLOR:GetRGB(); + AchievementFrameGuildEmblemLeft:SetVertexColor(r, g, b, 0.5); + AchievementFrameGuildEmblemRight:SetVertexColor(r, g, b, 0.5); + end + else + TEXTURES_OFFSET = 0; + AchievementFrameAchievements.Background:SetTexCoord(0, 1, 0, 0.5); + AchievementFrameSummary.Background:SetTexCoord(0, 1, 0, 0.5); + AchievementFrame.Header.Points:SetVertexColor(1, 1, 1); + AchievementFrame.Header.Title:SetText(ACHIEVEMENT_TITLE); + local shield = AchievementFrame.Header.Shield; + shield:SetTexture("Interface\\AchievementFrame\\UI-Achievement-TinyShield"); + shield:SetTexCoord(0, 0.625, 0, 0.625); + shield:SetHeight(20); + end + + AchievementFrame.Header.Points:SetText(BreakUpLargeNumbers(GetTotalAchievementPoints(InGuildView()))); +end + +local function OpenToSelectedCategory() + -- Build out the data provider of our new categories, then get or select an appropriate category. + AchievementFrameCategories_UpdateDataProvider(); + return AchievementFrame_GetOrSelectCurrentCategory(); +end + +local function InitAchievementPage() + local category = OpenToSelectedCategory(); + if category == "summary" then + AchievementFrame_ShowSubFrame(AchievementFrameSummary); + AchievementFrameSummary_Update(); + else + AchievementFrame_ShowSubFrame(AchievementFrameAchievements); + AchievementFrameAchievements_UpdateDataProvider(); + + -- Restore selection + local achievementId = GetSelectedAchievement(); + if achievementId > 0 then + AchievementFrame_SelectAndScrollToAchievementId(AchievementFrameAchievements.ScrollBox, achievementId); + end + end + + AchievementFrame_RefreshView(); +end; + +function AchievementFrameBaseTab_OnClick (tabIndex) + AchievementFrame_UpdateTabs(tabIndex); + + if tabIndex == AchievementCategoryIndex then + achievementFunctions = ACHIEVEMENT_FUNCTIONS; + InitAchievementPage(); + AchievementFrameWaterMark:SetTexture("Interface\\AchievementFrame\\UI-Achievement-AchievementWatermark"); + AchievementFrameCategoriesBG:SetTexCoord(0, 0.5, 0, 1); + AchievementFrameGuildEmblemLeft:Hide(); + AchievementFrameGuildEmblemRight:Hide(); + elseif tabIndex == GuildCategoryIndex then + achievementFunctions = GUILD_ACHIEVEMENT_FUNCTIONS; + InitAchievementPage(); + AchievementFrameWaterMark:SetTexture(); + AchievementFrameCategoriesBG:SetTexCoord(0.5, 1, 0, 1); + AchievementFrameGuildEmblemLeft:Show(); + AchievementFrameGuildEmblemRight:Show(); + elseif tabIndex == StatisticsCategoryIndex then + achievementFunctions = STAT_FUNCTIONS; + OpenToSelectedCategory(); + AchievementFrame_ShowSubFrame(AchievementFrameStats); + AchievementFrameWaterMark:SetTexture("Interface\\AchievementFrame\\UI-Achievement-StatWatermark"); + AchievementFrameCategoriesBG:SetTexCoord(0, 0.5, 0, 1); + AchievementFrameGuildEmblemLeft:Hide(); + AchievementFrameGuildEmblemRight:Hide(); + end + + SwitchAchievementSearchTab(tabIndex); +end + +AchievementFrameTab_OnClick = AchievementFrameBaseTab_OnClick; + +function AchievementFrameComparisonTab_OnClick (tabIndex) + local oldGuildView = InGuildView(); + + if tabIndex == AchievementCategoryIndex then + achievementFunctions = COMPARISON_ACHIEVEMENT_FUNCTIONS; + OpenToSelectedCategory(); + AchievementFrame_ShowSubFrame(AchievementFrameComparison, AchievementFrameComparison.AchievementContainer); + AchievementFrameWaterMark:SetTexture("Interface\\AchievementFrame\\UI-Achievement-AchievementWatermark"); + AchievementFrameComparison_UpdateDataProvider(); + elseif tabIndex == StatisticsCategoryIndex then + achievementFunctions = COMPARISON_STAT_FUNCTIONS; + OpenToSelectedCategory(); + AchievementFrame_ShowSubFrame(AchievementFrameComparison, AchievementFrameComparison.StatContainer); + AchievementFrameWaterMark:SetTexture("Interface\\AchievementFrame\\UI-Achievement-StatWatermark"); + AchievementFrameComparison_UpdateStatsDataProvider(); + end + + if oldGuildView then + AchievementFrame_RefreshView(); + AchievementFrameGuildEmblemLeft:Hide(); + AchievementFrameGuildEmblemRight:Hide(); + end + + AchievementFrameCategoriesBG:SetTexCoord(0, 0.5, 0, 1); + AchievementFrame_UpdateTabs(tabIndex); + SwitchAchievementSearchTab(tabIndex); +end + +local subFramesList; +local function GetOrCreateAchievementSubFramesList() + if not subFramesList then + subFramesList = { + AchievementFrameSummary, + AchievementFrameAchievements, + AchievementFrameStats, + AchievementFrameComparison, + AchievementFrameComparison.AchievementContainer, + AchievementFrameComparison.StatContainer + }; + end + return subFramesList; +end + +function AchievementFrame_ShowSubFrame(...) + for _, subFrame in ipairs(GetOrCreateAchievementSubFramesList()) do + local show = false; + for i = 1, select("#", ...) do + if subFrame == select(i, ...) then + show = true; + break; + end + end + subFrame:SetShown(show); + end +end + +-- [[ AchievementFrameCategories ]] -- + +AchievementCategoryTemplateMixin = {};--- @class AchievementCategoryTemplateMixin + +function AchievementCategoryTemplateMixin:OnLoad() + AchievementCategoryButton_Localize(self.Button); + + self.Button:SetScript("OnClick", function() + AchievementFrameCategories_OnCategoryClicked(self); + end); +end + +function AchievementCategoryTemplateMixin:OnClick(buttonName, down) + AchievementFrameCategories_OnCategoryClicked(self); +end + +function AchievementCategoryTemplateMixin:Init(elementData) + if ( elementData.isChild ) then + self.Button:SetWidth(ACHIEVEMENTUI_CATEGORIESWIDTH - 25); + self.Button.Label:SetFontObject("GameFontHighlight"); + self.parentID = elementData.parent; + self.Button.Background:SetVertexColor(0.6, 0.6, 0.6); + else + self.Button:SetWidth(ACHIEVEMENTUI_CATEGORIESWIDTH - 10); + self.Button.Label:SetFontObject("GameFontNormal"); + self.parentID = elementData.parent; + self.Button.Background:SetVertexColor(1, 1, 1); + end + + local categoryName, parentID, flags; + local numAchievements, numCompleted; + + local id = elementData.id; + + -- kind of janky + if ( id == "summary" ) then + categoryName = ACHIEVEMENT_SUMMARY_CATEGORY; + numAchievements, numCompleted = GetNumCompletedAchievements(InGuildView()); + else + categoryName, parentID, flags = GetCategoryInfo(id); + numAchievements, numCompleted = AchievementFrame_GetCategoryTotalNumAchievements(id, true); + end + + self.Button.Label:SetText(categoryName); + self.categoryID = id; + self.flags = flags; + + -- For the tooltip + self.Button.name = categoryName; + if ( id == FEAT_OF_STRENGTH_ID ) then + -- This is the feat of strength category since it's sorted to the end of the list + self.Button.text = FEAT_OF_STRENGTH_DESCRIPTION; + self.Button.showTooltipFunc = AchievementFrameCategory_FeatOfStrengthTooltip; + elseif ( id == GUILD_FEAT_OF_STRENGTH_ID ) then + self.Button.text = GUILD_FEAT_OF_STRENGTH_DESCRIPTION; + self.Button.showTooltipFunc = AchievementFrameCategory_FeatOfStrengthTooltip; + elseif ( AchievementFrame.selectedTab == 1 or AchievementFrame.selectedTab == 2 ) then + self.Button.text = nil; + self.Button.numAchievements = numAchievements; + self.Button.numCompleted = numCompleted; + self.Button.numCompletedText = numCompleted.."/"..numAchievements; + self.Button.showTooltipFunc = AchievementFrameCategory_StatusBarTooltip; + else + self.Button.showTooltipFunc = nil; + end + + self:UpdateSelectionState(elementData.selected); +end + +function AchievementCategoryTemplateMixin:UpdateSelectionState(selected) + if selected then + self.Button:LockHighlight(); + else + self.Button:UnlockHighlight(); + end +end + +AchievementCategoryTemplateButtonMixin = {};--- @class AchievementCategoryTemplateButtonMixin + +function AchievementCategoryTemplateButtonMixin:OnEnter() + if ( self.showTooltipFunc ) then + self.showTooltipFunc(self); + end +end + +function AchievementCategoryTemplateButtonMixin:OnLeave() + GameTooltip:SetMinimumWidth(0, false); + GameTooltip:Hide(); +end + +function AchievementFrameCategories_OnLoad (self) + self:RegisterEvent("ADDON_LOADED"); + + local view = CreateScrollBoxListLinearView(); + view:SetElementInitializer("AchievementCategoryTemplate", function(frame, elementData) + frame:Init(elementData); + end); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); +end + +function AchievementFrameCategories_FindCategoryElement(categories, category) + local _index, elementData = FindInTableIf(categories, function(elementData) + return elementData.id == category; + end); + + return elementData; +end + +function AchievementFrameCategories_ExpandToCategory(category) + local elementData = AchievementFrameCategories_FindCategoryElement(achievementFunctions.categories, category); + + -- If the category was not found in the current tab, try the opposite tab (guild vs personal achievements). + if not elementData then + local alternateCategories, alternateTabIndex; + + if InGuildView() then + alternateCategories = ACHIEVEMENT_FUNCTIONS.categories; + alternateTabIndex = AchievementCategoryIndex; + else + alternateCategories = GUILD_ACHIEVEMENT_FUNCTIONS.categories; + alternateTabIndex = GuildCategoryIndex; + end + + elementData = AchievementFrameCategories_FindCategoryElement(alternateCategories, category); + + -- If found in the other tab, switch to it. + if elementData then + AchievementFrameBaseTab_OnClick(alternateTabIndex); + end + end + + if elementData and elementData.isChild then + local openID = elementData.parent; + for _, iterElementData in ipairs(achievementFunctions.categories) do + iterElementData.hidden = iterElementData.isChild and iterElementData.parent ~= openID; + end + end +end + +function AchievementFrameCategories_SelectElementData(elementData, ignoreCollapse) + local categoryIndex = achievementFunctions.categoryIndex; + local selection = g_categorySelections[categoryIndex]; + local category = elementData.id; + local categoryChanged = selection.id ~= category; + + -- Don't modify any collapsed state if we're transitioning from a child to it's parent. + local changeCollapsed = not ignoreCollapse and not (elementData.parent and selection.parent == category); + local oldCollapsed = elementData.collapsed; + local isChild = elementData.isChild; + + local categories = achievementFunctions.categories; + for index, iterElementData in ipairs(categories) do + if iterElementData.selected then + iterElementData.selected = false; + local frame = AchievementFrameCategories.ScrollBox:FindFrame(iterElementData); + if frame then + frame:UpdateSelectionState(false); + end + end + + if not isChild and changeCollapsed then + if not iterElementData.isChild then + iterElementData.collapsed = true; + end + end + end + + if not isChild then + local newCollapsed = newCollapsed; + if changeCollapsed then + newCollapsed = not oldCollapsed; + if not elementData.isChild then + elementData.collapsed = newCollapsed; + end + end + + for index, iterElementData in ipairs(categories) do + if iterElementData.parent == category then + iterElementData.hidden = newCollapsed; + elseif iterElementData.parent ~= nil and iterElementData.isChild then + iterElementData.hidden = true; + end + end + end + + elementData.selected = true; + g_categorySelections[categoryIndex] = elementData; + + local frame = AchievementFrameCategories.ScrollBox:FindFrame(elementData); + if frame then + frame:UpdateSelectionState(true); + end + + -- No change in the contents of the list. We only changed the selection. + if not isChild and changeCollapsed then + AchievementFrameCategories_UpdateDataProvider(); + end + + if categoryChanged then + AchievementFrameCategories_OnCategoryChanged(category); + end +end + +function AchievementFrameCategories_OnCategoryClicked(button) + AchievementFrameCategories_SelectElementData(button:GetElementData()); +end + +function AchievementFrameCategories_OnShow (self) + AchievementFrameCategories_UpdateDataProvider(); + AchievementFrame_GetOrSelectCurrentCategory(); +end + +function AchievementFrameCategories_SelectDefaultElementData() + if not AchievementFrameCategories.ScrollBox:HasDataProvider() then + AchievementFrameCategories_UpdateDataProvider(); + end + + local elementData = AchievementFrameCategories.ScrollBox:ScrollToElementDataIndex(1, ScrollBoxConstants.AlignCenter); + if elementData then + AchievementFrameCategories_SelectElementData(elementData); + end +end + +function AchievementFrameCategories_UpdateDataProvider () + local restrictedCategoryID = AchievementFrame.restrictedCategoryID; + local newDataProvider = CreateDataProvider(); + for index, category in ipairs(achievementFunctions.categories) do + if not category.hidden then + if restrictedCategoryID then + if (category.id == restrictedCategoryID) or (category.parent == restrictedCategoryID) then + newDataProvider:Insert(category); + end + else + newDataProvider:Insert(category); + end + end; + end + + AchievementFrameCategories.ScrollBox:SetDataProvider(newDataProvider); +end + +function AchievementFrameCategory_StatusBarTooltip(self) + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip:SetMinimumWidth(128, true); + GameTooltip:SetText(self.name, 1, 1, 1, nil, true); + GameTooltip_ShowStatusBar(GameTooltip, 0, self.numAchievements, self.numCompleted, self.numCompletedText); + GameTooltip:Show(); +end + +function AchievementFrameCategory_FeatOfStrengthTooltip(self) + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip:SetText(self.name, 1, 1, 1); + GameTooltip:AddLine(self.text, nil, nil, nil, true); + GameTooltip:Show(); +end + +function AchievementFrameCategories_UpdateTooltip() + AchievementFrameCategories.ScrollBox:ForEachFrame(function(frame, elementData) + if frame.showTooltipFunc and frame:IsMouseOver() then + frame:showTooltipFunc(); + end + end); +end + +function AchievementFrameCategories_OnCategoryChanged(category) + if ( category == "summary" ) then + if ( achievementFunctions == ACHIEVEMENT_FUNCTIONS or achievementFunctions == GUILD_ACHIEVEMENT_FUNCTIONS ) then + AchievementFrame_ShowSubFrame(AchievementFrameSummary); + AchievementFrameSummary_Update(); + end + else + if ( achievementFunctions == ACHIEVEMENT_FUNCTIONS or achievementFunctions == GUILD_ACHIEVEMENT_FUNCTIONS ) then + AchievementFrame_ShowSubFrame(AchievementFrameAchievements); + AchievementFrameAchievements_UpdateDataProvider(); + if IsCategoryFeatOfStrength(category) then + AchievementFrame_HideFilterDropdown(AchievementFrame); + else + AchievementFrame_TryShowFilterDropdown(AchievementFrame); + end + elseif ( achievementFunctions == COMPARISON_ACHIEVEMENT_FUNCTIONS ) then + AchievementFrame_ShowSubFrame(AchievementFrameComparison, AchievementFrameComparison.AchievementContainer); + AchievementFrameComparison_UpdateDataProvider(); + AchievementFrameComparison_UpdateStatusBars(category); + elseif ( achievementFunctions == STAT_FUNCTIONS ) then + AchievementFrame_ShowSubFrame(AchievementFrameStats); + AchievementFrameStats_UpdateDataProvider(); + else + AchievementFrame_ShowSubFrame(AchievementFrameComparison, AchievementFrameComparison.StatContainer); + AchievementFrameComparison_UpdateStatsDataProvider(); + end + + local numAchievements, numCompleted, completedOffset = ACHIEVEMENTUI_SELECTEDFILTER(category); + local fosShown = numAchievements == 0 and IsCategoryFeatOfStrength(category); + AchievementFrameAchievementsFeatOfStrengthText:SetShown(fosShown); + if fosShown then + local asGuild = AchievementFrame.selectedTab == 2; + AchievementFrameAchievementsFeatOfStrengthText:SetText(asGuild and GUILD_FEAT_OF_STRENGTH_DESCRIPTION or FEAT_OF_STRENGTH_DESCRIPTION); + end + end +end + +local AchievementFrameShownEvents = +{ + "ACHIEVEMENT_EARNED", + "CRITERIA_UPDATE", + "RECEIVED_ACHIEVEMENT_MEMBER_LIST", + "ACHIEVEMENT_SEARCH_UPDATED", +}; + +function AchievementFrameAchievements_OnShow(self) + FrameUtil.RegisterFrameForEvents(self, AchievementFrameShownEvents); + + if IsCategoryFeatOfStrength(GetSelectedCategory()) then + AchievementFrame_HideFilterDropdown(AchievementFrame); + else + AchievementFrame_TryShowFilterDropdown(AchievementFrame); + end +end + +function AchievementFrameAchievements_OnHide(self) + FrameUtil.UnregisterFrameForEvents(self, AchievementFrameShownEvents); + + AchievementFrame_HideFilterDropdown(AchievementFrame); +end + +function AchievementFrameComparison_UpdateStatusBars (id) + local numAchievements, numCompleted = GetCategoryNumAchievements(id); + local name = GetCategoryInfo(id); + + if ( id == ACHIEVEMENT_COMPARISON_SUMMARY_ID ) then + name = ACHIEVEMENT_SUMMARY_CATEGORY; + end + + local statusBar = AchievementFrameComparison.Summary.Player.StatusBar; + statusBar:SetMinMaxValues(0, numAchievements); + statusBar:SetValue(numCompleted); + statusBar.Title:SetText(string.format(ACHIEVEMENTS_COMPLETED_CATEGORY, name)); + statusBar.Text:SetText(numCompleted.."/"..numAchievements); + + local friendCompleted = GetComparisonCategoryNumAchievements(id); + statusBar = AchievementFrameComparison.Summary.Friend.StatusBar; + statusBar:SetMinMaxValues(0, numAchievements); + statusBar:SetValue(friendCompleted); + statusBar.Text:SetText(friendCompleted.."/"..numAchievements); +end + +-- [[ AchievementFrameAchievements ]] -- + +function AchievementFrameAchievements_OnLoad (self) + self:RegisterEvent("ADDON_LOADED"); + + local function AchievementResetter(button) + if SelectionBehaviorMixin.IsIntrusiveSelected(button) then + local objectives = button:GetObjectiveFrame(); + objectives:Clear(); + end + end + + local view = CreateScrollBoxListLinearView(); + view:SetElementExtentCalculator(function(dataIndex, elementData) + if SelectionBehaviorMixin.IsElementDataIntrusiveSelected(elementData) then + return AchievementTemplateMixin.CalculateSelectedHeight(elementData); + else + return ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT; + end + end); + local function AchievementInitializer(button, elementData) + button:Init(elementData); + end; + view:SetElementInitializer("AchievementTemplate", AchievementInitializer); + view:SetElementResetter(AchievementResetter); + view:SetPadding(2,0,0,4,0); + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); + + g_achievementSelectionBehavior = ScrollUtil.AddSelectionBehavior(self.ScrollBox, SelectionBehaviorFlags.Deselectable, SelectionBehaviorFlags.Intrusive); + g_achievementSelectionBehavior:RegisterCallback(SelectionBehaviorMixin.Event.OnSelectionChanged, function(o, elementData, selected) + if selected then + SetSelectedAchievement(elementData); + else + SetSelectedAchievement(nil); + end + + local button = self.ScrollBox:FindFrame(elementData); + if button then + button:SetSelected(selected); + end + end, self); + + ScrollUtil.AddResizableChildrenBehavior(self.ScrollBox); +end + +function AchievementFrameAchievements_GetSelectedElementData() + return g_achievementSelectionBehavior:GetFirstSelectedElementData(); +end + +function AchievementFrameAchievements_GetSelectedAchievementId() + local elementData = AchievementFrameAchievements_GetSelectedElementData(); + return elementData and elementData.id or 0; +end + +function AchievementFrameAchievements_OnAchievementEarned(achievementId) + AchievementFrameAchievements_UpdateDataProvider(); + + if AchievementFrameAchievements_GetSelectedAchievementId() == achievementId then + AchievementFrame_SelectAndScrollToAchievementId(AchievementFrameAchievements.ScrollBox, achievementId); + end + + AchievementFrameCategories_UpdateTooltip(); + + AchievementFrame.Header.Points:SetText(BreakUpLargeNumbers(GetTotalAchievementPoints(InGuildView()))); +end + +function AchievementFrameAchievements_OnCriteriaUpdate() + local selectedElementData = AchievementFrameAchievements_GetSelectedElementData(); + if selectedElementData then + local button = AchievementFrameAchievements.ScrollBox:FindFrame(selectedElementData); + if button then + button:Init(selectedElementData); + end + end +end + +function AchievementFrameAchievements_UpdateTrackedAchievements() + if (Kiosk.IsEnabled()) then + return; + end + + updateTrackedAchievements(C_ContentTracking.GetTrackedIDs(Enum.ContentTrackingType.Achievement)); +end + +function AchievementFrameAchievements_OnEvent (self, event, ...) + if (Kiosk.IsEnabled()) then + return; + end + if ( event == "ADDON_LOADED" ) then + AchievementFrameAchievements_UpdateTrackedAchievements(); + elseif ( event == "ACHIEVEMENT_EARNED" ) then + if not AchievementFrameCategories.ScrollBox:HasDataProvider() then + AchievementFrameCategories_UpdateDataProvider(); + end + + local achievementID = ...; + AchievementFrameAchievements_OnAchievementEarned(achievementID); + elseif ( event == "CRITERIA_UPDATE" ) then + AchievementFrameAchievements_OnCriteriaUpdate(); + elseif ( event == "RECEIVED_ACHIEVEMENT_MEMBER_LIST" ) then + local achievementID = ...; + -- check if we initiated the request from a meta criteria and we're still over it + if ( guildMemberRequestFrame and guildMemberRequestFrame.id == achievementID ) then + -- update the tooltip + local func = guildMemberRequestFrame:GetScript("OnEnter"); + if ( func ) then + func(guildMemberRequestFrame); + end + end + elseif ( event == "ACHIEVEMENT_SEARCH_UPDATED" ) then + AchievementFrame.SearchBox.fullSearchFinished = true; + AchievementFrame_UpdateSearch(self); + end +end + +function AchievementFrameAchievementsBackdrop_OnLoad (self) + self:SetFrameLevel(self:GetFrameLevel()+1); +end + +function AchievementFrameAchievements_UpdateDataProvider() + local category = AchievementFrame_GetOrSelectCurrentCategory(); + if category == "summary" then + return; + end + + local numAchievements, numCompleted, completedOffset = ACHIEVEMENTUI_SELECTEDFILTER(category); + local fosShown = numAchievements == 0 and IsCategoryFeatOfStrength(category); + AchievementFrameAchievementsFeatOfStrengthText:SetShown(fosShown); + if fosShown then + local asGuild = AchievementFrame.selectedTab == 2; + AchievementFrameAchievementsFeatOfStrengthText:SetText(asGuild and GUILD_FEAT_OF_STRENGTH_DESCRIPTION or FEAT_OF_STRENGTH_DESCRIPTION); + end + + local newDataProvider = CreateDataProvider(); + for index = 1, numAchievements do + if index <= numAchievements then + local filteredIndex = index + completedOffset; + local id = GetAchievementInfo(category, filteredIndex); + newDataProvider:Insert({category = category, index = filteredIndex, id = id}); + end + end + AchievementFrameAchievements.ScrollBox:SetDataProvider(newDataProvider); +end + +-- Called from the options menu or once the complete filter is changed. +function AchievementFrameAchievements_ForceUpdate() + AchievementFrameAchievements_UpdateDataProvider(); + + local achievementId = GetSelectedAchievement(); + if achievementId > 0 then + AchievementFrame_SelectAndScrollToAchievementId(AchievementFrameAchievements.ScrollBox, achievementId); + end +end + +-- [[ Achievement Icon ]] -- + +function AchievementIcon_Desaturate (self) + self.bling:SetVertexColor(.6, .6, .6, 1); + self.frame:SetVertexColor(.75, .75, .75, 1); + self.texture:SetVertexColor(.55, .55, .55, 1); +end + +function AchievementIcon_Saturate (self) + self.bling:SetVertexColor(1, 1, 1, 1); + self.frame:SetVertexColor(1, 1, 1, 1); + self.texture:SetVertexColor(1, 1, 1, 1); +end + +function AchievementIcon_OnLoad (self) + self.Desaturate = AchievementIcon_Desaturate; + self.Saturate = AchievementIcon_Saturate; +end + +-- [[ Achievement Shield ]] -- + +function AchievementShield_Desaturate (self) + self.Icon:SetTexCoord(.5, 1, TEXTURES_OFFSET, TEXTURES_OFFSET + 0.5); +end + +function AchievementShield_Saturate (self) + self.Icon:SetTexCoord(0, .5, TEXTURES_OFFSET, TEXTURES_OFFSET + 0.5); +end + +function AchievementShield_OnLoad (self) + self.Desaturate = AchievementShield_Desaturate; + self.Saturate = AchievementShield_Saturate; +end + +-- [[ AchievementButton ]] -- + +ACHIEVEMENTBUTTON_DESCRIPTIONHEIGHT = 20; +ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT = 84; +ACHIEVEMENTBUTTON_CRITERIAROWHEIGHT = 15; +ACHIEVEMENTBUTTON_METAROWHEIGHT = 28; +ACHIEVEMENTBUTTON_MAXHEIGHT = 232; +ACHIEVEMENTBUTTON_TEXTUREHEIGHT = 128; +GUILDACHIEVEMENTBUTTON_MINHEIGHT = 128; + +AchievementTemplateMixin = {};--- @class AchievementTemplateMixin + +function AchievementTemplateMixin:OnLoad() + self.DateCompleted = self.Shield.DateCompleted; + + AchievementButton_Localize(self); + + if ( not ACHIEVEMENTUI_FONTHEIGHT ) then + local _, fontHeight = self.Description:GetFont(); + ACHIEVEMENTUI_FONTHEIGHT = fontHeight; + end + self.Description:SetHeight(ACHIEVEMENTUI_FONTHEIGHT * ACHIEVEMENTUI_MAX_LINES_COLLAPSED); + self.Description:SetWidth(ACHIEVEMENTUI_MAXCONTENTWIDTH); + self.HiddenDescription:SetWidth(ACHIEVEMENTUI_MAXCONTENTWIDTH); + + self.Tracked:SetScript("OnClick", GenerateClosure(self.OnCheckClicked, self)); + self.Shield:SetScript("OnClick", GenerateClosure(self.OnShieldClicked, self)); + + self:Collapse(); +end + +function AchievementTemplateMixin:ProcessClick(buttonName, down) + local handled = false; + if IsModifiedClick() then + local elementData = self:GetElementData(); + if IsModifiedClick("CHATLINK") then + local achievementLink = GetAchievementLink(elementData.id); + if achievementLink then + handled = ChatFrameUtil.InsertLink(achievementLink); + if handled then + AchievementFrame_OnAchievementLinkedInChat(elementData.id); + end + + if not handled and SocialPostFrame and Social_IsShown() then + Social_InsertLink(achievementLink); + handled = true; + end + end + end + if not handled and IsModifiedClick("QUESTWATCHTOGGLE") then + self:ToggleTracking(elementData.id); + handled = true; + end + end + + if not handled then + g_achievementSelectionBehavior:ToggleSelect(self); + end +end + +function AchievementTemplateMixin:OnClick(buttonName, down) + self:ProcessClick(buttonName, down); +end + +function AchievementTemplateMixin:OnEnter() + self.Highlight:Show(); + + if ( not self.id ) then + return; -- This happens when we create buttons + end + + EventRegistry:TriggerEvent("AchievementFrameAchievement.OnEnter", self, self.id); +end + +function AchievementTemplateMixin:OnLeave() + if not self:IsSelected() then + self.Highlight:Hide(); + end + EventRegistry:TriggerEvent("AchievementFrameAchievement.OnLeave", self); +end + +function AchievementTemplateMixin:UpdatePlusMinusTexture() + local id = self.id; + if ( not id ) then + return; -- This happens when we create buttons + end + + local display = false; + if ( GetAchievementNumCriteria(id) ~= 0 ) then + display = true; + elseif ( self.completed and GetPreviousAchievement(id) ) then + display = true; + elseif ( not self.completed and GetAchievementGuildRep(id) ) then + display = true; + end + + if ( display ) then + self.PlusMinus:Show(); + if ( self.collapsed and self.saturatedStyle ) then + self.PlusMinus:SetTexCoord(0, .5, TEXTURES_OFFSET, TEXTURES_OFFSET + 0.25); + elseif ( self.collapsed ) then + self.PlusMinus:SetTexCoord(.5, 1, TEXTURES_OFFSET, TEXTURES_OFFSET + 0.25); + elseif ( self.saturatedStyle ) then + self.PlusMinus:SetTexCoord(0, .5, TEXTURES_OFFSET + 0.25, TEXTURES_OFFSET + 0.50); + else + self.PlusMinus:SetTexCoord(.5, 1, TEXTURES_OFFSET + 0.25, TEXTURES_OFFSET + 0.50); + end + else + self.PlusMinus:Hide(); + end +end + +function AchievementTemplateMixin:SetSelected(selected) + self:Init(self:GetElementData()); + + SetFocusedAchievement(self.id); +end + +function AchievementTemplateMixin:IsSelected() + return SelectionBehaviorMixin.IsIntrusiveSelected(self); +end + +function AchievementTemplateMixin:GetObjectiveFrame() + if self.useOffscreenObjectiveFrame then + return AchievementFrameAchievementsObjectivesOffScreen; + end + return AchievementFrameAchievementsObjectives; +end + +function AchievementTemplateMixin:Init(elementData) + self.index = elementData.index; + self.id = elementData.id; + local category = elementData.category; + + -- reset button info to get proper saturation/desaturation + self.completed = nil; + + -- title + if InGuildView() then + self.TitleBar:SetAlpha(1); + self.Icon.frame:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Guild"); + self.Icon.frame:SetTexCoord(0.25976563, 0.40820313, 0.50000000, 0.64453125); + self.Icon.frame:SetPoint("CENTER", 2, 2); + local bottomTsunami = self.BottomTsunami1; + bottomTsunami:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + bottomTsunami:SetTexCoord(0, 0.72265, 0.58984375, 0.65234375); + bottomTsunami:SetAlpha(0.2); + local topTsunami = self.TopTsunami1; + topTsunami:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + topTsunami:SetTexCoord(0.72265, 0, 0.65234375, 0.58984375); + topTsunami:SetAlpha(0.15); + self.Glow:SetTexCoord(0, 1, 0.26171875, 0.51171875); + else + self.TitleBar:SetAlpha(0.8); + self.Icon.frame:SetTexture("Interface\\AchievementFrame\\UI-Achievement-IconFrame"); + self.Icon.frame:SetTexCoord(0, 0.5625, 0, 0.5625); + self.Icon.frame:SetPoint("CENTER", -1, 2); + local bottomTsunami = self.BottomTsunami1; + bottomTsunami:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + bottomTsunami:SetTexCoord(0, 0.72265, 0.51953125, 0.58203125); + bottomTsunami:SetAlpha(0.35); + local topTsunami = self.TopTsunami1; + topTsunami:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + topTsunami:SetTexCoord(0.72265, 0, 0.58203125, 0.51953125); + topTsunami:SetAlpha(0.3); + self.Glow:SetTexCoord(0, 1, 0.00390625, 0.25390625); + end + + local id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy; + if self.index then + id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy = GetAchievementInfo(category, self.index); + else + -- Social + id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy = GetAchievementInfo(self.id); + category = GetAchievementCategory(self.id); + end + + local saturatedStyle; + if ( bit.band(flags, ACHIEVEMENT_FLAGS_ACCOUNT) == ACHIEVEMENT_FLAGS_ACCOUNT ) then + self.accountWide = true; + saturatedStyle = "account"; + else + self.accountWide = nil; + if ( InGuildView() ) then + saturatedStyle = "guild"; + else + saturatedStyle = "normal"; + end + end + self.Label:SetWidth(ACHIEVEMENTBUTTON_LABELWIDTH); + self.Label:SetText(name); + + if ( GetPreviousAchievement(id) ) then + -- If this is a progressive achievement, show the total score. + AchievementShield_SetPoints(AchievementButton_GetProgressivePoints(id), self.Shield.Points, AchievementPointsFont, AchievementPointsFontSmall); + else + AchievementShield_SetPoints(points, self.Shield.Points, AchievementPointsFont, AchievementPointsFontSmall); + end + + if ( points > 0 ) then + self.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields]]); + else + self.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields-NoPoints]]); + end + + if ( isGuild ) then + self.Shield.Points:Show(); + self.Shield.wasEarnedByMe = nil; + self.Shield.earnedBy = nil; + else + self.Shield.wasEarnedByMe = not (completed and not wasEarnedByMe); + self.Shield.earnedBy = earnedBy; + end + + self.Shield.id = id; + self.Description:SetText(description); + self.HiddenDescription:SetText(description); + self.numLines = math.ceil(self.HiddenDescription:GetHeight() / ACHIEVEMENTUI_FONTHEIGHT); + self.Icon.texture:SetTexture(icon); + if ( completed or wasEarnedByMe ) then + self.completed = true; + self.DateCompleted:SetText(FormatShortDate(day, month, year)); + self.DateCompleted:Show(); + if ( self.saturatedStyle ~= saturatedStyle ) then + self:Saturate(); + end + else + self.completed = nil; + self.DateCompleted:Hide(); + self:Desaturate(); + end + + if ( rewardText == "" ) then + self.Reward:Hide(); + self.RewardBackground:Hide(); + else + self.Reward:SetText(rewardText); + self.Reward:Show(); + self.RewardBackground:Show(); + if ( self.completed ) then + self.RewardBackground:SetVertexColor(1, 1, 1); + else + self.RewardBackground:SetVertexColor(0.35, 0.35, 0.35); + end + end + + local noSound = true; + if ( C_ContentTracking.IsTracking(Enum.ContentTrackingType.Achievement, id) ) then + self:SetAsTracked(true, noSound); + else + self:SetAsTracked(false, noSound); + self.Tracked:Hide(); + end + + self:UpdatePlusMinusTexture(); + + if SelectionBehaviorMixin.IsElementDataIntrusiveSelected(elementData) then + local height = self:DisplayObjectives(self.id, self.completed); + self:Expand(height); + + self.Highlight:Show(); + + if ( not completed or (not wasEarnedByMe and not isGuild) ) then + self.Tracked:Show(); + end + else + local objectives = self:GetObjectiveFrame(); + if objectives.id == self.id then + objectives:Hide(); + end + + if ( not self:IsMouseOver() ) then + self.Highlight:Hide(); + end + + self:Collapse(); + end +end + +function AchievementTemplateMixin:Collapse() + if ( self.collapsed ) then + return; + end + + self.collapsed = true; + self:UpdatePlusMinusTexture(); + self:SetHeight(ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT); + self.Background:SetTexCoord(0, 1, 1-(ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT / 256), 1); + if ( not self.Tracked:GetChecked() ) then + self.Tracked:Hide(); + end + self.Tabard:Hide(); + self.GuildCornerL:Hide(); + self.GuildCornerR:Hide(); + + self.Description:Show(); + self.HiddenDescription:Hide(); + + if ( not self:IsMouseOver() ) then + self.Highlight:Hide(); + end +end + +function AchievementTemplateMixin:Expand(height) + if ( not self.collapsed and self:GetHeight() == height ) then + return; + end + + self.collapsed = nil; + self:UpdatePlusMinusTexture() + if ( InGuildView() ) then + if ( height < GUILDACHIEVEMENTBUTTON_MINHEIGHT ) then + height = GUILDACHIEVEMENTBUTTON_MINHEIGHT; + end + if ( self.completed ) then + self.Tabard:Show(); + self.Shield:SetFrameLevel(self.Tabard:GetFrameLevel() + 1); + SetLargeGuildTabardTextures("player", self.Tabard.Emblem, self.Tabard.Background, self.Tabard.Border); + end + self.GuildCornerL:Show(); + self.GuildCornerR:Show(); + end + self:SetHeight(height); + self:GetHeight(); -- debug check + self.Background:SetTexCoord(0, 1, math.max(0, 1-(height / 256)), 1); + + self.HiddenDescription:Show(); + self.Description:Hide(); +end + +function AchievementTemplateMixin:Saturate() + if ( InGuildView() ) then + self.Background:SetTexture("Interface\\AchievementFrame\\UI-GuildAchievement-Parchment-Horizontal"); + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.83203125, 0.91015625); + self:SetBackdropBorderColor(ACHIEVEMENT_RED_BORDER_COLOR:GetRGB()); + self.Shield.Points:SetVertexColor(0, 1, 0); + self.saturatedStyle = "guild"; + else + self.Background:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Parchment-Horizontal"); + if ( self.accountWide ) then + self.TitleBar:SetTexture("Interface\\AchievementFrame\\AccountLevel-AchievementHeader"); + self.TitleBar:SetTexCoord(0, 1, 0, 0.375); + self:SetBackdropBorderColor(ACHIEVEMENT_BLUE_BORDER_COLOR:GetRGB()); + self.saturatedStyle = "account"; + else + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.66015625, 0.73828125); + self:SetBackdropBorderColor(ACHIEVEMENT_RED_BORDER_COLOR:GetRGB()); + self.saturatedStyle = "normal"; + end + self.Shield.Points:SetVertexColor(1, 1, 1); + end + self.Glow:SetVertexColor(1.0, 1.0, 1.0); + self.Icon:Saturate(); + self.Shield:Saturate(); + self.Reward:SetVertexColor(1, .82, 0); + self.Label:SetVertexColor(1, 1, 1); + self.Description:SetTextColor(0, 0, 0, 1); + self.Description:SetShadowOffset(0, 0); + self:UpdatePlusMinusTexture(); +end + +function AchievementTemplateMixin:Desaturate() + self.saturatedStyle = nil; + if ( InGuildView() ) then + self.Background:SetTexture("Interface\\AchievementFrame\\UI-GuildAchievement-Parchment-Horizontal-Desaturated"); + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.74609375, 0.82421875); + else + self.Background:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Parchment-Horizontal-Desaturated"); + if ( self.accountWide ) then + self.TitleBar:SetTexture("Interface\\AchievementFrame\\AccountLevel-AchievementHeader"); + self.TitleBar:SetTexCoord(0, 1, 0.40625, 0.78125); + else + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.91796875, 0.99609375); + end + end + self.Glow:SetVertexColor(.22, .17, .13); + self.Icon:Desaturate(); + self.Shield:Desaturate(); + self.Shield.Points:SetVertexColor(.65, .65, .65); + self.Reward:SetVertexColor(.8, .8, .8); + self.Label:SetVertexColor(.65, .65, .65); + self.Description:SetTextColor(1, 1, 1, 1); + self.Description:SetShadowOffset(1, -1); + self:UpdatePlusMinusTexture(); + self:SetBackdropBorderColor(.5, .5, .5); +end + +-- Mirrors the implementations of AchievementObjectives_DisplayCriteria and +-- AchievementObjectives_DisplayProgressiveAchievement. +function AchievementTemplateMixin.CalculateSelectedHeight(elementData) + local totalHeight = ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT; + local objectivesHeight = 0; + + + -- text check width + if ( not AchievementFrame.textCheckWidth ) then + AchievementFrame.PlaceholderName:SetText("- "); + AchievementFrame.textCheckWidth = AchievementFrame.PlaceholderName:GetStringWidth(); + end + + + local id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy = GetAchievementInfo(elementData.category, elementData.index); + if completed and GetPreviousAchievement(id) then + local achievementCount = 1; + + local nextID = id; + while GetPreviousAchievement(nextID) do + achievementCount = achievementCount + 1; + nextID = GetPreviousAchievement(nextID); + end + + local MaxAchievementsPerRow = 6; + objectivesHeight = math.ceil(achievementCount / MaxAchievementsPerRow) * ACHIEVEMENTUI_PROGRESSIVEHEIGHT; + else + local numExtraCriteriaRows = 0; + local maxCriteriaWidth = 0; + local textStrings = 0; + local progressBars = 0; + local metas = 0; + local numMetaRows = 0; + local numCriteriaRows = 0; + if not completed then + local requiresRep = GetAchievementGuildRep(id); + if requiresRep then + numExtraCriteriaRows = numExtraCriteriaRows + 1; + end + end + + local numCriteria = GetAchievementNumCriteria(id); + for i = 1, numCriteria do + local criteriaString, criteriaType, criteriaCompleted, quantity, reqQuantity, charName, criteriaFlags, assetID, quantityString = GetAchievementCriteriaInfo(id, i); + + if criteriaType == CRITERIA_TYPE_ACHIEVEMENT and assetID then + metas = metas + 1; + if metas == 1 or (math.fmod(metas, 2) ~= 0) then + numMetaRows = numMetaRows + 1; + end + + elseif bit.band(criteriaFlags, EVALUATION_TREE_FLAG_PROGRESS_BAR) == EVALUATION_TREE_FLAG_PROGRESS_BAR then + progressBars = progressBars + 1; + numCriteriaRows = numCriteriaRows + 1; + else + textStrings = textStrings + 1; + + local stringWidth = 0; + local maxCriteriaContentWidth; + if criteriaCompleted then + maxCriteriaContentWidth = ACHIEVEMENTUI_MAXCONTENTWIDTH - ACHIEVEMENTUI_CRITERIACHECKWIDTH; + AchievementFrame.PlaceholderName:SetText(criteriaString); + stringWidth = math.min(AchievementFrame.PlaceholderName:GetStringWidth(), maxCriteriaContentWidth); + else + maxCriteriaContentWidth = ACHIEVEMENTUI_MAXCONTENTWIDTH - AchievementFrame.textCheckWidth; + local dashedString = "- "..criteriaString; + AchievementFrame.PlaceholderName:SetText(dashedString); + stringWidth = math.min(AchievementFrame.PlaceholderName:GetStringWidth() - AchievementFrame.textCheckWidth, maxCriteriaContentWidth); -- don't want the "- " to be included in the width + end + + if AchievementFrame.PlaceholderName:GetWidth() > maxCriteriaContentWidth then + AchievementFrame.PlaceholderName:SetWidth(maxCriteriaContentWidth); + end + + maxCriteriaWidth = math.max(maxCriteriaWidth, stringWidth + ACHIEVEMENTUI_CRITERIACHECKWIDTH); + numCriteriaRows = numCriteriaRows + 1; + end + end + + if textStrings > 0 and progressBars > 0 then + elseif textStrings > 1 then + local numColumns = math.floor(ACHIEVEMENTUI_MAXCONTENTWIDTH / maxCriteriaWidth); + local forceColumns = numColumns == 1 and textStrings >= FORCE_COLUMNS_MIN_CRITERIA and maxCriteriaWidth <= FORCE_COLUMNS_MAX_WIDTH; + if forceColumns then + numColumns = 2; + end + + if numColumns > 1 then + numCriteriaRows = math.ceil(numCriteriaRows/numColumns); + end + end + + numCriteriaRows = numCriteriaRows + numExtraCriteriaRows; + + local height = numMetaRows * ACHIEVEMENTBUTTON_METAROWHEIGHT + numCriteriaRows * ACHIEVEMENTBUTTON_CRITERIAROWHEIGHT; + if metas > 0 or progressBars > 0 then + height = height + 10; + end + + objectivesHeight = height; + end + + totalHeight = totalHeight + objectivesHeight; + + AchievementFrame.PlaceholderHiddenDescription:SetText(description); + local numLines = math.ceil(AchievementFrame.PlaceholderHiddenDescription:GetHeight() / ACHIEVEMENTUI_FONTHEIGHT); + if (totalHeight ~= ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT) or (numLines > ACHIEVEMENTUI_MAX_LINES_COLLAPSED) then + local descriptionHeight = AchievementFrame.PlaceholderHiddenDescription:GetHeight(); + totalHeight = totalHeight + descriptionHeight - ACHIEVEMENTBUTTON_DESCRIPTIONHEIGHT; + + if rewardText ~= "" then + totalHeight = totalHeight + 4; + end + end + + if InGuildView() and totalHeight < GUILDACHIEVEMENTBUTTON_MINHEIGHT then + return GUILDACHIEVEMENTBUTTON_MINHEIGHT; + end + return totalHeight; +end + +function AchievementTemplateMixin:DisplayObjectives(id, completed) + local objectivesFrame = self:GetObjectiveFrame(); + local topAnchor = self.HiddenDescription; + objectivesFrame:ClearAllPoints(); + objectivesFrame.completed = completed; + local height = ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT; + + if ( completed and GetPreviousAchievement(id) ) then + objectivesFrame:Clear(); + objectivesFrame:SetParent(self); + AchievementObjectives_DisplayProgressiveAchievement(objectivesFrame, id); + objectivesFrame:SetPoint("TOP", topAnchor, "BOTTOM", 0, -8); + else + objectivesFrame:Clear(); + objectivesFrame:SetParent(self); + AchievementObjectives_DisplayCriteria(objectivesFrame, id); + if ( objectivesFrame:GetHeight() > 0 ) then + objectivesFrame:SetPoint("TOP", topAnchor, "BOTTOM", 0, -8); + objectivesFrame:SetPoint("LEFT", self.Icon, "RIGHT", -5, -25); + objectivesFrame:SetPoint("RIGHT", self.Shield, "LEFT", -10, 0); + end + end + + objectivesFrame:Show(); + + height = height + objectivesFrame:GetHeight(); + + if ( height ~= ACHIEVEMENTBUTTON_COLLAPSEDHEIGHT or self.numLines > ACHIEVEMENTUI_MAX_LINES_COLLAPSED ) then + local descriptionHeight = self.HiddenDescription:GetHeight(); + height = height + descriptionHeight - ACHIEVEMENTBUTTON_DESCRIPTIONHEIGHT; + if ( self.Reward:IsShown() ) then + height = height + 4; + end + end + + objectivesFrame.id = id; + return height; +end + +function AchievementTemplateMixin:ToggleTracking() + local id = self.id; + if ( trackedAchievements[id] ) then + C_ContentTracking.StopTracking(Enum.ContentTrackingType.Achievement, id, Enum.ContentTrackingStopType.Manual); + self:SetAsTracked(false); + return; + end + + local count = #C_ContentTracking.GetTrackedIDs(Enum.ContentTrackingType.Achievement); + if ( count >= Constants.ContentTrackingConsts.MaxTrackedAchievements ) then + UIErrorsFrame:AddMessage(format(ACHIEVEMENT_WATCH_TOO_MANY, Constants.ContentTrackingConsts.MaxTrackedAchievements), 1.0, 0.1, 0.1, 1.0); + return; + end + + local _, _, _, completed, _, _, _, _, _, _, _, isGuild, wasEarnedByMe = GetAchievementInfo(id) + if ( (completed and isGuild) or wasEarnedByMe ) then + UIErrorsFrame:AddMessage(ERR_ACHIEVEMENT_WATCH_COMPLETED, 1.0, 0.1, 0.1, 1.0); + return; + end + + self:SetAsTracked(true); + local trackingError = C_ContentTracking.StartTracking(Enum.ContentTrackingType.Achievement, id); + if trackingError then + ContentTrackingUtil.DisplayTrackingError(trackingError); + end + + return true; +end + +function AchievementTemplateMixin:SetAsTracked(tracked, noSound) + self.Check:SetShown(tracked); + self.Tracked:ApplyChecked(tracked, noSound); + if tracked then + self.Tracked:Show(); + elseif not SelectionBehaviorMixin.IsIntrusiveSelected(self) then + self.Tracked:Hide(); + end + + self.Label:SetWidth(self.Label:GetStringWidth() + 4); -- This +4 here is to fudge around any string width issues that arize from resizing a string set to its string width. See bug 144418 for an example. +end + +function AchievementTemplateMixin:OnCheckClicked(o, buttonName, down) + self:ToggleTracking(); +end + +function AchievementTemplateMixin:OnShieldClicked(o, buttonName, down) + self:ProcessClick(buttonName, down); +end + +AchivementButtonCheckMixin = {};--- @class AchivementButtonCheckMixin + +function AchivementButtonCheckMixin:ApplyChecked(checked, noSound) + if not noSound then + if checked then + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); + else + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_OFF); + end + end + self:SetChecked(checked); +end + +function AchivementButtonCheckMixin:OnEnter() + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + if ( self:GetChecked() ) then + GameTooltip:SetText(UNTRACK_ACHIEVEMENT_TOOLTIP, nil, nil, nil, nil, true); + else + GameTooltip:SetText(TRACK_ACHIEVEMENT_TOOLTIP, nil, nil, nil, nil, true); + end +end + +function AchivementButtonCheckMixin:OnLeave() + GameTooltip:Hide(); +end + +function AchievementShield_SetPoints(points, pointString, normalFont, smallFont) + if ( points == 0 ) then + pointString:SetText(""); + return; + end + if ( points < 100 ) then + pointString:SetFontObject(normalFont); + else + pointString:SetFontObject(smallFont); + end + pointString:SetText(points); +end + +function AchievementButton_ResetTable (t) + for k, v in next, t do + v:Hide(); + end +end + +AchievementsObjectivesMixin = {};--- @class AchievementsObjectivesMixin + +function AchievementsObjectivesMixin:OnLoad() + self.pools = CreateFramePoolCollection(); + self.pools:CreatePool("FRAME", self, "AchievementCriteriaTemplate"); + self.pools:CreatePool("STATUSBAR", self, "AchievementProgressBarTemplate"); + self.pools:CreatePool("FRAME", self, "MiniAchievementTemplate"); + self.pools:CreatePool("BUTTON", self, "MetaCriteriaTemplate"); + self:Clear(); +end + +function AchievementsObjectivesMixin:OnHide() + self:Clear(); +end + +function AchievementsObjectivesMixin:Clear() + self.pools:ReleaseAll(); + self.criterias = {}; + self.progressBars = {}; + self.miniAchivements = {}; + self.metas = {}; + + self.RepCriteria:Hide(); + + self:ClearAllPoints(); + self:SetHeight(0); +end + +function AchievementsObjectivesMixin:GetElementAtIndex(template, collection, index, localizer) + local found = collection[index]; + if found then + return found; + end + + local pool = self.pools:GetPool(template); + local frame = pool:Acquire(); + table.insert(collection, frame); + localizer(frame); + frame:Show(); + return frame; +end + +function AchievementsObjectivesMixin:GetCriteria(index) + return self:GetElementAtIndex("AchievementCriteriaTemplate", self.criterias, index, AchievementFrame_LocalizeCriteria); +end + +function AchievementsObjectivesMixin:GetProgressBar(index) + return self:GetElementAtIndex("AchievementProgressBarTemplate", self.progressBars, index, AchievementButton_LocalizeProgressBar); +end + +function AchievementsObjectivesMixin:GetMiniAchievement(index) + return self:GetElementAtIndex("MiniAchievementTemplate", self.miniAchivements, index, AchievementButton_LocalizeMiniAchievement); +end + +function AchievementsObjectivesMixin:GetMeta(index) + local frame = self:GetElementAtIndex("MetaCriteriaTemplate", self.metas, index, AchievementButton_LocalizeMetaAchievement); + + if ( InGuildView() ) then + frame.Border:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Guild"); + frame.Border:SetTexCoord(0.89062500, 0.97070313, 0.00195313, 0.08203125); + else + frame.Border:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Progressive-IconBorder"); + frame.Border:SetTexCoord(0, 0.65625, 0, 0.65625); + end + + return frame; +end + +function AchievementButton_GetProgressivePoints(achievementID) + local points; + local _, _, progressivePoints, completed = GetAchievementInfo(achievementID); + + while GetPreviousAchievement(achievementID) do + achievementID = GetPreviousAchievement(achievementID); + _, _, points, completed = GetAchievementInfo(achievementID); + progressivePoints = progressivePoints+points; + end + + if ( progressivePoints ) then + return progressivePoints; + else + return 0; + end +end + +local achievementList = {}; + +function AchievementObjectives_DisplayProgressiveAchievement (objectivesFrame, id) + local ACHIEVEMENTMODE_PROGRESSIVE = 2; + local baseAchievementID = id; + + local achievementList = achievementList; + for i in next, achievementList do + achievementList[i] = nil; + end + + tinsert(achievementList, 1, baseAchievementID); + while GetPreviousAchievement(baseAchievementID) do + tinsert(achievementList, 1, GetPreviousAchievement(baseAchievementID)); + baseAchievementID = GetPreviousAchievement(baseAchievementID); + end + + local i = 0; + for index, achievementID in ipairs(achievementList) do + local _, achievementName, points, completed, month, day, year, description, flags, iconpath = GetAchievementInfo(achievementID); + flags = flags or 0; -- bug 360115 + local miniAchievement = objectivesFrame:GetMiniAchievement(index); + + miniAchievement:Show(); + miniAchievement:ClearAllPoints(); + miniAchievement:SetParent(objectivesFrame); + miniAchievement.Icon:SetTexture(iconpath); + if ( index == 1 ) then + miniAchievement:SetPoint("TOPLEFT", objectivesFrame, "TOPLEFT", -4, -4); + elseif ( mod(index, 6) == 1 ) then + miniAchievement:SetPoint("TOPLEFT", objectivesFrame:GetMiniAchievement(index-6), "BOTTOMLEFT", 0, -8); + else + miniAchievement:SetPoint("TOPLEFT", objectivesFrame:GetMiniAchievement(index-1), "TOPRIGHT", 4, 0); + end + + if ( points > 0 ) then + miniAchievement.Points:SetText(points); + miniAchievement.Points:Show(); + miniAchievement.Shield:SetTexture([[Interface\AchievementFrame\UI-Achievement-Progressive-Shield]]); + else + miniAchievement.Points:Hide(); + miniAchievement.Shield:SetTexture([[Interface\AchievementFrame\UI-Achievement-Progressive-Shield-NoPoints]]); + end + + miniAchievement.numCriteria = 0; + if ( bit.band(flags, ACHIEVEMENT_FLAGS_HAS_PROGRESS_BAR) ~= ACHIEVEMENT_FLAGS_HAS_PROGRESS_BAR ) then + for criteriaIndex = 1, GetAchievementNumCriteria(achievementID) do + local criteriaString, criteriaType, criteriaCompleted = GetAchievementCriteriaInfo(achievementID, criteriaIndex); + if ( criteriaCompleted == false ) then + criteriaString = "|CFF808080 - " .. criteriaString .. "|r"; + else + criteriaString = "|CFF00FF00 - " .. criteriaString .. "|r"; + end + miniAchievement["criteria" .. criteriaIndex] = criteriaString; + miniAchievement.numCriteria = criteriaIndex; + end + end + miniAchievement.name = achievementName; + miniAchievement.desc = description; + if ( month ) then + miniAchievement.date = FormatShortDate(day, month, year); + end + i = index; + end + + objectivesFrame:SetHeight(math.ceil(i/6) * ACHIEVEMENTUI_PROGRESSIVEHEIGHT); + objectivesFrame:SetWidth(math.min(i, 6) * ACHIEVEMENTUI_PROGRESSIVEWIDTH); + objectivesFrame.mode = ACHIEVEMENTMODE_PROGRESSIVE; +end + +function AchievementFrame_GetCategoryNumAchievements_All (categoryID) + local numAchievements, numCompleted, numIncomplete = GetCategoryNumAchievements(categoryID); + return numAchievements, numCompleted, 0; +end + +function AchievementFrame_GetCategoryNumAchievements_Complete (categoryID) + local numAchievements, numCompleted, numIncomplete = GetCategoryNumAchievements(categoryID); + return numCompleted, numCompleted, 0; +end + +function AchievementFrame_GetCategoryNumAchievements_Incomplete (categoryID) + local numAchievements, numCompleted, numIncomplete = GetCategoryNumAchievements(categoryID); + return numIncomplete, 0, numAchievements-numIncomplete; +end + +ACHIEVEMENTUI_SELECTEDFILTER = AchievementFrame_GetCategoryNumAchievements_All; + +AchievementFrameFilters = { + {text = ACHIEVEMENTFRAME_FILTER_ALL, func = AchievementFrame_GetCategoryNumAchievements_All}, + {text = ACHIEVEMENTFRAME_FILTER_COMPLETED, func = AchievementFrame_GetCategoryNumAchievements_Complete}, + {text = ACHIEVEMENTFRAME_FILTER_INCOMPLETE, func = AchievementFrame_GetCategoryNumAchievements_Incomplete} +}; + +function AchievementFrame_SetFilter(value) + local filter = AchievementFrameFilters[value]; + if filter.func ~= ACHIEVEMENTUI_SELECTEDFILTER then + ACHIEVEMENTUI_SELECTEDFILTER = filter.func; + AchievementFrameAchievements_ForceUpdate(); + AchievementFrameFilterDropdown:GenerateMenu(); + end +end + +function AchievementObjectives_DisplayCriteria (objectivesFrame, id) + if ( not id ) then + return; + end + + local yOffset = 0; + local ACHIEVEMENTMODE_CRITERIA = 1; + local numMetaRows = 0; + local numCriteriaRows = 0; + local numExtraCriteriaRows = 0; + + local function AddExtraCriteriaRow() + numExtraCriteriaRows = numExtraCriteriaRows + 1; + yOffset = -numExtraCriteriaRows * ACHIEVEMENTBUTTON_CRITERIAROWHEIGHT; + end + + local requiresRep, hasRep, repLevel; + if ( not objectivesFrame.completed ) then + requiresRep, hasRep, repLevel = GetAchievementGuildRep(id); + if ( requiresRep ) then + local gender = UnitSex("player"); + local factionStandingtext = GetText("FACTION_STANDING_LABEL"..repLevel, gender); + objectivesFrame.RepCriteria:SetFormattedText(ACHIEVEMENT_REQUIRES_GUILD_REPUTATION, factionStandingtext); + if ( hasRep ) then + objectivesFrame.RepCriteria:SetTextColor(0, 1, 0); + else + objectivesFrame.RepCriteria:SetTextColor(1, 0, 0); + end + objectivesFrame.RepCriteria:Show(); + AddExtraCriteriaRow(); + end + end + + local numCriteria = GetAchievementNumCriteria(id); + if ( numCriteria == 0 and not requiresRep ) then + objectivesFrame.mode = ACHIEVEMENTMODE_CRITERIA; + objectivesFrame:SetHeight(0); + return; + end + + -- text check width + if ( not objectivesFrame.textCheckWidth ) then + local criteria = objectivesFrame:GetCriteria(1); + criteria.Name:SetText("- "); + objectivesFrame.textCheckWidth = criteria.Name:GetStringWidth(); + end + + local frameLevel = objectivesFrame:GetFrameLevel() + 1; + + local textStrings, progressBars, metas = 0, 0, 0; + local firstMetaCriteria; + + local maxCriteriaWidth = 0; + local yPos; + for i = 1, numCriteria do + local criteriaString, criteriaType, completed, quantity, reqQuantity, charName, flags, assetID, quantityString = GetAchievementCriteriaInfo(id, i); + + if ( criteriaType == CRITERIA_TYPE_ACHIEVEMENT and assetID ) then + metas = metas + 1; + local metaCriteria = objectivesFrame:GetMeta(metas); + metaCriteria:ClearAllPoints(); + + if ( metas == 1 ) then + -- this will be anchored below, we need to know how many text criteria there are + firstMetaCriteria = metaCriteria; + numMetaRows = numMetaRows + 1; + elseif ( math.fmod(metas, 2) == 0 ) then + local anchorMeta = objectivesFrame:GetMeta(metas-1); + metaCriteria:SetPoint("LEFT", anchorMeta, "RIGHT", 35, 0); + else + local anchorMeta = objectivesFrame:GetMeta(metas-2); + metaCriteria:SetPoint("TOPLEFT", anchorMeta, "BOTTOMLEFT", -0, 2); + numMetaRows = numMetaRows + 1; + end + + local achievementId, achievementName, points, achievementCompleted, month, day, year, description, achFlags, iconpath = GetAchievementInfo(assetID); + + if ( month ) then + metaCriteria.date = FormatShortDate(day, month, year) + else + metaCriteria.date = nil; + end + + metaCriteria.id = achievementId; + metaCriteria.Label:SetText(achievementName); + metaCriteria.Icon:SetTexture(iconpath); + + -- have to check if criteria is completed here, can't just check if achievement is completed. + -- This is because the criteria could have modifiers on it that prevent completion even though the achievement is earned. + if ( objectivesFrame.completed and completed ) then + metaCriteria.Check:Show(); + metaCriteria.Border:SetVertexColor(1, 1, 1, 1); + metaCriteria.Icon:SetVertexColor(1, 1, 1, 1); + metaCriteria.Label:SetShadowOffset(0, 0) + metaCriteria.Label:SetTextColor(0, 0, 0, 1); + elseif ( completed ) then + metaCriteria.Check:Show(); + metaCriteria.Border:SetVertexColor(1, 1, 1, 1); + metaCriteria.Icon:SetVertexColor(1, 1, 1, 1); + metaCriteria.Label:SetShadowOffset(1, -1) + metaCriteria.Label:SetTextColor(0, 1, 0, 1); + else + metaCriteria.Check:Hide(); + metaCriteria.Border:SetVertexColor(.75, .75, .75, 1); + metaCriteria.Icon:SetVertexColor(.55, .55, .55, 1); + metaCriteria.Label:SetShadowOffset(1, -1) + metaCriteria.Label:SetTextColor(.6, .6, .6, 1); + end + + metaCriteria:SetParent(objectivesFrame); + metaCriteria:Show(); + elseif ( bit.band(flags, EVALUATION_TREE_FLAG_PROGRESS_BAR) == EVALUATION_TREE_FLAG_PROGRESS_BAR ) then + -- Display this criteria as a progress bar! + progressBars = progressBars + 1; + local progressBar = objectivesFrame:GetProgressBar(progressBars); + + if ( progressBars == 1 ) then + progressBar:SetPoint("TOP", objectivesFrame, "TOP", 4, -4 + yOffset); + else + progressBar:SetPoint("TOP", objectivesFrame:GetProgressBar(progressBars-1), "BOTTOM", 0, 0); + end + + progressBar.Text:SetText(string.format("%s", quantityString)); + progressBar:SetMinMaxValues(0, reqQuantity); + progressBar:SetValue(quantity); + + progressBar:SetParent(objectivesFrame); + progressBar:Show(); + + numCriteriaRows = numCriteriaRows + 1; + else + textStrings = textStrings + 1; + local criteria = objectivesFrame:GetCriteria(textStrings); + criteria:ClearAllPoints(); + if ( textStrings == 1 ) then + if ( numCriteria == 1 ) then + criteria:SetPoint("TOP", objectivesFrame, "TOP", -14, yOffset); + else + criteria:SetPoint("TOPLEFT", objectivesFrame, "TOPLEFT", 0, yOffset); + end + + else + criteria:SetPoint("TOPLEFT", objectivesFrame:GetCriteria(textStrings-1), "BOTTOMLEFT", 0, 0); + end + + if ( objectivesFrame.completed and completed ) then + criteria.Name:SetTextColor(0, 0, 0, 1); + criteria.Name:SetShadowOffset(0, 0); + elseif ( completed ) then + criteria.Name:SetTextColor(0, 1, 0, 1); + criteria.Name:SetShadowOffset(1, -1); + else + criteria.Name:SetTextColor(.6, .6, .6, 1); + criteria.Name:SetShadowOffset(1, -1); + end + + local stringWidth = 0; + local maxCriteriaContentWidth; + if ( completed ) then + maxCriteriaContentWidth = ACHIEVEMENTUI_MAXCONTENTWIDTH - ACHIEVEMENTUI_CRITERIACHECKWIDTH; + criteria.Check:SetPoint("LEFT", 18, -3); + criteria.Name:SetPoint("LEFT", criteria.Check, "RIGHT", 0, 2); + criteria.Check:Show(); + criteria.Name:SetText(criteriaString); + stringWidth = math.min(criteria.Name:GetStringWidth(), maxCriteriaContentWidth); + else + maxCriteriaContentWidth = ACHIEVEMENTUI_MAXCONTENTWIDTH - objectivesFrame.textCheckWidth; + criteria.Check:SetPoint("LEFT", 0, -3); + criteria.Name:SetPoint("LEFT", criteria.Check, "RIGHT", 5, 2); + criteria.Check:Hide(); + criteria.Name:SetText("- "..criteriaString); + stringWidth = math.min(criteria.Name:GetStringWidth() - objectivesFrame.textCheckWidth, maxCriteriaContentWidth); -- don't want the "- " to be included in the width + end + if ( criteria.Name:GetWidth() > maxCriteriaContentWidth ) then + criteria.Name:SetWidth(maxCriteriaContentWidth); + end + criteria:SetParent(objectivesFrame); + criteria:Show(); + criteria:SetWidth(stringWidth + ACHIEVEMENTUI_CRITERIACHECKWIDTH); + maxCriteriaWidth = math.max(maxCriteriaWidth, stringWidth + ACHIEVEMENTUI_CRITERIACHECKWIDTH); + numCriteriaRows = numCriteriaRows + 1; + end + end + + if ( textStrings > 0 and progressBars > 0 ) then + -- If we have text criteria and progressBar criteria, display the progressBar criteria first and position the textStrings under them. + local criTable = objectivesFrame:GetCriteria(1); + criTable:ClearAllPoints(); + if ( textStrings == 1 ) then + criTable:SetPoint("TOP", objectivesFrame:GetProgressBar(progressBars), "BOTTOM", -14, -4); + else + criTable:SetPoint("TOP", objectivesFrame:GetProgressBar(progressBars), "BOTTOM", 0, -4); + criTable:SetPoint("LEFT", objectivesFrame, "LEFT", 0, 0); + end + elseif ( textStrings > 1 ) then + -- Figure out if we can make multiple columns worth of criteria instead of one long one + local numColumns = math.floor(ACHIEVEMENTUI_MAXCONTENTWIDTH/maxCriteriaWidth); + -- But if we have a lot of criteria, force 2 columns + local forceColumns = false; + if ( numColumns == 1 and textStrings >= FORCE_COLUMNS_MIN_CRITERIA and maxCriteriaWidth <= FORCE_COLUMNS_MAX_WIDTH ) then + numColumns = 2; + forceColumns = true; + -- if top right criteria would run into the achievement shield, move them all down 1 row + -- this assumes description is 1 or 2 lines, otherwise this wouldn't be a problem + -- If uncommented, you'll need to account for this in AchievementTemplateMixin.CalculateSelectedHeight. + --if ( AchievementButton_GetCriteria(2).Name:GetStringWidth() > FORCE_COLUMNS_RIGHT_COLUMN_SPACE and progressBars == 0 ) then + -- AddExtraCriteriaRow(); + --end + end + + if ( numColumns > 1 ) then + local step; + local rows = 1; + local position = 0; + local criTable = objectivesFrame.criterias; + for i=1, #criTable do + position = position + 1; + if ( position > numColumns ) then + position = position - numColumns; + rows = rows + 1; + end + + if ( rows == 1 ) then + criTable[i]:ClearAllPoints(); + local xOffset = 0; + if ( forceColumns ) then + if ( position == 1 ) then + xOffset = FORCE_COLUMNS_LEFT_OFFSET; + elseif ( position == 2 ) then + xOffset = FORCE_COLUMNS_RIGHT_OFFSET; + end + end + criTable[i]:SetPoint("TOPLEFT", objectivesFrame, "TOPLEFT", (position - 1)*(ACHIEVEMENTUI_MAXCONTENTWIDTH/numColumns) + xOffset, yOffset); + else + criTable[i]:ClearAllPoints(); + criTable[i]:SetPoint("TOPLEFT", criTable[position + ((rows - 2) * numColumns)], "BOTTOMLEFT", 0, 0); + end + end + numCriteriaRows = math.ceil(numCriteriaRows/numColumns); + end + end + + numCriteriaRows = numCriteriaRows + numExtraCriteriaRows; + + if ( firstMetaCriteria ) then + local yOffsetMeta = -8 - numCriteriaRows * ACHIEVEMENTBUTTON_CRITERIAROWHEIGHT; + if ( metas == 1 ) then + firstMetaCriteria:SetPoint("TOP", objectivesFrame, "TOP", 0, yOffsetMeta); + else + firstMetaCriteria:SetPoint("TOPLEFT", objectivesFrame, "TOPLEFT", 20, yOffsetMeta); + end + end + + local height = numMetaRows * ACHIEVEMENTBUTTON_METAROWHEIGHT + numCriteriaRows * ACHIEVEMENTBUTTON_CRITERIAROWHEIGHT; + if ( metas > 0 or progressBars > 0 ) then + height = height + 10; + end + + objectivesFrame:SetHeight(height); + objectivesFrame.mode = ACHIEVEMENTMODE_CRITERIA; +end + +-- [[ StatsFrames ]]-- + +AchievementStatTemplateMixin = {};--- @class AchievementStatTemplateMixin + +function AchievementStatTemplateMixin:OnLoad() + self.Value:SetVertexColor(1, 0.97, 0.6); + self:SetPushedTextOffset(0,0); +end + +function AchievementStatTemplateMixin:OnClick() + if ( self.isHeader ) then + local category = self.id; + AchievementFrame_UpdateAndSelectCategory(category); + end +end + +function AchievementStatTemplateMixin:OnEnter() + if ( self.Text:IsTruncated() ) then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip:SetText(self.Text:GetText(), 1, 1, 1, 1, true); + end + EventRegistry:TriggerEvent("AchievementFrameAchievement.OnEnter", self, self.id); +end + +function AchievementStatTemplateMixin:OnLeave() + GameTooltip:Hide(); + EventRegistry:TriggerEvent("AchievementFrameAchievement.OnLeave", self); +end + +function AchievementStatTemplateMixin:Init(elementData) + local category = elementData.id; + local colorIndex = elementData.colorIndex; + if elementData.header then + -- show header + self.Left:Show(); + self.Middle:Show(); + self.Right:Show(); + local text; + if ( category == ACHIEVEMENT_COMPARISON_STATS_SUMMARY_ID ) then + text = ACHIEVEMENT_SUMMARY_CATEGORY; + else + text = GetCategoryInfo(category); + end + self.Title:SetText(text); + self.Title:Show(); + self.Value:SetText(""); + self:SetText(""); + self:SetHeight(24); + self.Background:Hide(); + self.isHeader = true; + self.id = category; + else + local id, name = GetAchievementInfo(category); + + self.id = id; + + self:SetText(name); + self.Background:Show(); + -- Color every other line yellow + if ( colorIndex == 1 ) then + self.Background:SetTexCoord(0, 1, 0.1875, 0.3671875); + self.Background:SetBlendMode("BLEND"); + self.Background:SetAlpha(1.0); + self:SetHeight(24); + else + self.Background:SetTexCoord(0, 1, 0.375, 0.5390625); + self.Background:SetBlendMode("ADD"); + self.Background:SetAlpha(0.5); + self:SetHeight(24); + end + + -- Figure out the criteria + -- Just show the first criteria for now + local criteriaString, criteriaType, completed, quantityNumber, reqQuantity, charName, flags, assetID, quantity; + if ( not isSummary ) then + quantity = GetStatistic(id); + else + criteriaString, criteriaType, completed, quantityNumber, reqQuantity, charName, flags, assetID, quantity = GetAchievementCriteriaInfo(category); + end + if ( not quantity ) then + quantity = "--"; + end + self.Value:SetText(quantity); + + -- Hide the header images + self.Title:Hide(); + self.Left:Hide(); + self.Middle:Hide(); + self.Right:Hide(); + self.isHeader = false; + end +end + +function AchievementFrameStats_OnEvent (self, event, ...) + if ( event == "CRITERIA_UPDATE" ) then + AchievementFrameStats_UpdateDataProvider(); + end +end + +function AchievementFrameStats_OnLoad (self) + local view = CreateScrollBoxListLinearView(); + view:SetElementInitializer("AchievementStatTemplate", function(button, elementData) + button:Init(elementData); + end); + view:SetPadding(2,0,0,4,0); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); +end + +function AchievementFrameStats_OnShow(self) + self:RegisterEvent("CRITERIA_UPDATE"); +end + +function AchievementFrameStats_OnHide(self) + self:UnregisterEvent("CRITERIA_UPDATE"); +end + +function AchievementFrameStats_UpdateDataProvider () + local category = AchievementFrame_GetOrSelectCurrentCategory(); + if category == "summary" then + return; + end + + local numStats = GetCategoryNumAchievements(category); + local categories = {}; + + if ( achievementFunctions.lastCategory ~= category ) then + -- build a list of shown category and stat id's + tinsert(categories, {id = category, header = true}); + for i=1, numStats do + local quantity, skip, id = GetStatistic(category, i); + if ( not skip ) then + tinsert(categories, {id = id}); + end + end + + -- add all the subcategories and their stat id's + for i, cat in next, STAT_FUNCTIONS.categories do + if ( cat.parent == category ) then + tinsert(categories, {id = cat.id, header = true}); + numStats = GetCategoryNumAchievements(cat.id); + for k=1, numStats do + local quantity, skip, id = GetStatistic(cat.id, k); + if ( not skip ) then + tinsert(categories, {id = id}); + end + end + end + end + achievementFunctions.lastCategory = category; + + local newDataProvider = CreateDataProvider(); + for index = 1, #categories do + local stat = categories[index]; + stat.colorIndex = mod(index, 2); + newDataProvider:Insert(stat); + end + AchievementFrameStats.ScrollBox:SetDataProvider(newDataProvider); + end +end + + +-- [[ Summary Frame ]] -- +function AchievementFrameSummary_OnShow() + if ( achievementFunctions ~= COMPARISON_ACHIEVEMENT_FUNCTIONS and achievementFunctions ~= COMPARISON_STAT_FUNCTIONS ) then + AchievementFrameSummary:SetWidth(530); + else + AchievementFrameComparisonDark:Hide(); + AchievementFrameComparisonWatermark:Hide(); + AchievementFrameComparison:SetWidth(650); + AchievementFrameSummary:SetWidth(650); + end +end + +function AchievementFrameSummary_Update() + AchievementFrameSummary_Refresh(); + AchievementFrameSummaryCategoriesStatusBar_Update(); + AchievementFrameSummary_UpdateAchievements(GetLatestCompletedAchievements(InGuildView())); +end + +function AchievementFrameSummary_UpdateSummaryProgressBars(categories) + for i = 1, 12 do + local statusBar = _G["AchievementFrameSummaryCategoriesCategory"..i]; + if ( i <= #categories ) then + local categoryName = GetCategoryInfo(categories[i]); + statusBar.Label:SetText(categoryName); + statusBar:Show(); + statusBar:SetID(categories[i]); + AchievementFrameSummaryCategory_OnShow(statusBar); -- to calculate progress + else + statusBar:Hide(); + end + end +end + +function AchievementFrameSummary_Refresh() + if not InGuildView() then + for i = 1, ACHIEVEMENTUI_MAX_SUMMARY_ACHIEVEMENTS do + local button = _G["AchievementFrameSummaryAchievement"..i]; + if ( button ) then + button.Icon.frame:SetTexture("Interface\\AchievementFrame\\UI-Achievement-IconFrame"); + button.Icon.frame:SetTexCoord(0, 0.5625, 0, 0.5625); + button.Icon.frame:SetPoint("CENTER", -1, 2); + button.Glow:SetTexCoord(0, 1, 0.00390625, 0.25390625); + button.TitleBar:SetAlpha(0.5); + end + end + AchievementFrameSummary_UpdateSummaryProgressBars(ACHIEVEMENTUI_SUMMARYCATEGORIES); + else + for i = 1, ACHIEVEMENTUI_MAX_SUMMARY_ACHIEVEMENTS do + local button = _G["AchievementFrameSummaryAchievement"..i]; + if ( button ) then + AchievementFrameSummaryAchievement_SetGuildTextures(button) + end + end + AchievementFrameSummary_UpdateSummaryProgressBars(ACHIEVEMENTUI_GUILDSUMMARYCATEGORIES); + end +end + +function AchievementFrameSummary_UpdateAchievements(...) + local numAchievements = select("#", ...); + local id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy; + local buttons = AchievementFrameSummaryAchievements.buttons; + local button, anchorTo, achievementID; + local defaultAchievementCount = 1; + + for i=1, ACHIEVEMENTUI_MAX_SUMMARY_ACHIEVEMENTS do + if ( buttons ) then + button = buttons[i]; + end + if ( not button ) then + button = CreateFrame("Button", "AchievementFrameSummaryAchievement"..i, AchievementFrameSummaryAchievements, "SummaryAchievementTemplate"); + if ( i == 1 ) then + button:SetPoint("TOPLEFT",AchievementFrameSummaryAchievementsHeader, "BOTTOMLEFT", 18, 2 ); + button:SetPoint("TOPRIGHT",AchievementFrameSummaryAchievementsHeader, "BOTTOMRIGHT", -18, 2 ); + else + anchorTo = _G["AchievementFrameSummaryAchievement"..i-1]; + button:SetPoint("TOPLEFT",anchorTo, "BOTTOMLEFT", 0, 3 ); + button:SetPoint("TOPRIGHT",anchorTo, "BOTTOMRIGHT", 0, 3 ); + end + if ( InGuildView() ) then + AchievementFrameSummaryAchievement_SetGuildTextures(button); + end + if ( not buttons ) then + buttons = AchievementFrameSummaryAchievements.buttons; + end + button.isSummary = true; + AchievementFrameSummary_LocalizeButton(button); + end; + + if ( i <= numAchievements ) then + achievementID = select(i, ...); + id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy = GetAchievementInfo(achievementID); + + local saturatedStyle; + if ( bit.band(flags, ACHIEVEMENT_FLAGS_ACCOUNT) == ACHIEVEMENT_FLAGS_ACCOUNT ) then + button.accountWide = true; + saturatedStyle = "account"; + else + button.accountWide = nil; + if ( InGuildView() ) then + saturatedStyle = "guild"; + else + saturatedStyle = "normal"; + end + end + + button.Label:SetText(name); + button.Description:SetText(description); + AchievementShield_SetPoints(points, button.Shield.Points, GameFontNormal, GameFontNormalSmall); + if ( points > 0 ) then + button.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields]]); + else + button.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields-NoPoints]]); + end + + if ( isGuild ) then + button.Shield.wasEarnedByMe = nil; + button.Shield.earnedBy = nil; + else + button.Shield.wasEarnedByMe = not (completed and not wasEarnedByMe); + button.Shield.earnedBy = earnedBy; + end + + button.Icon.texture:SetTexture(icon); + button.id = id; + + if ( completed ) then + button.DateCompleted:SetText(FormatShortDate(day, month, year)); + else + button.DateCompleted:SetText(""); + end + + if ( button.saturatedStyle ~= saturatedStyle ) then + button:Saturate(); + end + button.tooltipTitle = nil; + button:Show(); + else + local tAchievements; + if ( InGuildView() ) then + tAchievements = ACHIEVEMENTUI_DEFAULTGUILDSUMMARYACHIEVEMENTS; + else + tAchievements = ACHIEVEMENTUI_DEFAULTSUMMARYACHIEVEMENTS; + end + for j=defaultAchievementCount, ACHIEVEMENTUI_MAX_SUMMARY_ACHIEVEMENTS do + achievementID = tAchievements[defaultAchievementCount]; + if ( not achievementID ) then + break; + end + id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy = GetAchievementInfo(achievementID); + if ( completed ) then + defaultAchievementCount = defaultAchievementCount+1; + else + button.Label:SetText(name); + button.Description:SetText(description); + AchievementShield_SetPoints(points, button.Shield.Points, GameFontNormal, GameFontNormalSmall); + if ( points > 0 ) then + button.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields]]); + else + button.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields-NoPoints]]); + end + button.Shield.wasEarnedByMe = not (completed and not wasEarnedByMe); + button.Shield.earnedBy = earnedBy; + button.Icon.texture:SetTexture(icon); + button.id = id; + if ( month ) then + button.DateCompleted:SetText(FormatShortDate(day, month, year)); + else + button.DateCompleted:SetText(""); + end + button:Show(); + defaultAchievementCount = defaultAchievementCount+1; + button:Desaturate(); + button.tooltipTitle = SUMMARY_ACHIEVEMENT_INCOMPLETE; + button.tooltip = SUMMARY_ACHIEVEMENT_INCOMPLETE_TEXT; + break; + end + end + end + end + if ( numAchievements == 0 ) then + AchievementFrameSummaryAchievementsEmptyText:Show(); + else + AchievementFrameSummaryAchievementsEmptyText:Hide(); + end +end + +function AchievementFrameSummaryCategoriesStatusBar_Update() + local total, completed = GetNumCompletedAchievements(InGuildView()); + AchievementFrameSummaryCategoriesStatusBar:SetMinMaxValues(0, total); + AchievementFrameSummaryCategoriesStatusBar:SetValue(completed); + AchievementFrameSummaryCategoriesStatusBarText:SetText(BreakUpLargeNumbers(completed).."/"..BreakUpLargeNumbers(total)); +end + +function AchievementFrameSummaryAchievement_OnLoad(self) + AchievementComparisonPlayerButton_OnLoad(self); + AchievementFrameSummaryAchievements.buttons = AchievementFrameSummaryAchievements.buttons or {}; + tinsert(AchievementFrameSummaryAchievements.buttons, self); + self.TitleBar:SetVertexColor(1,1,1,0.5); + self.DateCompleted:Show(); +end + +function AchievementFrameSummaryAchievement_SetGuildTextures(button) + button.Icon.frame:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Guild"); + button.Icon.frame:SetTexCoord(0.25976563, 0.40820313, 0.50000000, 0.64453125); + button.Icon.frame:SetPoint("CENTER", 0, 2); + button.Glow:SetTexCoord(0, 1, 0.26171875, 0.51171875); + button.TitleBar:SetAlpha(1); +end + +function AchievementFrameSummaryAchievement_OnClick(self) + if ( IsModifiedClick("CHATLINK") ) then + local achievementLink = GetAchievementLink(self.id); + if ( achievementLink ) then + if ( ChatFrameUtil.InsertLink(achievementLink) ) then + AchievementFrame_OnAchievementLinkedInChat(self.id); + return; + elseif ( SocialPostFrame and Social_IsShown() ) then + Social_InsertLink(achievementLink); + return; + end + end + end + + local id = self.id + local nextID, completed = GetNextAchievement(id); + if ( nextID and completed ) then + local newID; + while ( nextID and completed ) do + newID, completed = GetNextAchievement(nextID); + if ( completed ) then + nextID = newID; + end + end + id = nextID; + end + + AchievementFrame_SelectAchievement(id); +end + +function AchievementFrameSummaryAchievement_OnEnter(self) + self.Highlight:Show(); + if ( self.tooltipTitle ) then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip:SetText(self.tooltipTitle,1,1,1); + GameTooltip:AddLine(self.tooltip, nil, nil, nil, true); + GameTooltip:Show(); + end +end + +function AchievementFrameSummaryCategoryButton_OnClick (self) + local category = self:GetParent():GetID(); + AchievementFrame_UpdateAndSelectCategory(category); +end + +function AchievementFrameSummaryCategory_OnLoad (self) + self:SetMinMaxValues(0, 100); + self:SetValue(0); +end + +function AchievementFrame_GetCategoryTotalNumAchievements (id, showAll) + -- Not recursive because we only have one deep and this saves time. + local totalAchievements, totalCompleted = 0, 0; + local numAchievements, numCompleted = GetCategoryNumAchievements(id, showAll); + totalAchievements = totalAchievements + numAchievements; + totalCompleted = totalCompleted + numCompleted; + + local categories = achievementFunctions.categories; + for index, elementData in ipairs(categories) do + if ( elementData.parent == id ) then + numAchievements, numCompleted = GetCategoryNumAchievements(elementData.id, showAll); + totalAchievements = totalAchievements + numAchievements; + totalCompleted = totalCompleted + numCompleted; + end + end + + return totalAchievements, totalCompleted; +end + +function AchievementFrameSummaryCategory_OnEvent (self, event, ...) + AchievementFrameSummaryCategory_OnShow(self); +end + +function AchievementFrameSummaryCategory_OnShow (self) + local totalAchievements, totalCompleted = AchievementFrame_GetCategoryTotalNumAchievements(self:GetID(), true); + + self.Text:SetText(string.format("%d/%d", totalCompleted, totalAchievements)); + self:SetMinMaxValues(0, totalAchievements); + self:SetValue(totalCompleted); + self:RegisterEvent("ACHIEVEMENT_EARNED"); +end + +function AchievementFrameSummaryCategory_OnHide (self) + self:UnregisterEvent("ACHIEVEMENT_EARNED"); +end + +AchievementMetaCriteriaMixin = {};--- @class AchievementMetaCriteriaMixin + +function AchievementMetaCriteriaMixin:OnClick() + AchievementFrame_SelectAchievement(self.id); +end + +function AchievementMetaCriteriaMixin:OnEnter() + if self.date then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip:AddLine(string.format(ACHIEVEMENT_META_COMPLETED_DATE, self.date), 1, 1, true); + AchievementFrameAchievements_CheckGuildMembersTooltip(self); + GameTooltip:Show(); + end +end + +function AchievementMetaCriteriaMixin:OnLeave() + GameTooltip:Hide(); + guildMemberRequestFrame = nil; +end + +function AchievementFrame_UpdateAndSelectCategory(category) + local currentCategory = GetSelectedCategory(); + if currentCategory == category then + return; + end + + -- Assume the category is not in our data provider. + AchievementFrameCategories_ExpandToCategory(category); + AchievementFrameCategories_UpdateDataProvider(); + + -- Select the category. + local scrollBox = AchievementFrameCategories.ScrollBox; + local dataProvider = scrollBox:GetDataProvider(); + if dataProvider then + local elementData = dataProvider:FindElementDataByPredicate(function(elementData) + return elementData.id == category; + end); + if elementData then + AchievementFrameCategories_SelectElementData(elementData); + scrollBox:ScrollToElementData(elementData, ScrollBoxConstants.AlignCenter); + end + end +end + +function AchievementFrame_SelectAchievement(id, forceSelect) + if ( (not AchievementFrame:IsShown() and not forceSelect) or (not C_AchievementInfo.IsValidAchievement(id)) ) then + return; + end + + local achCompleted = select(4, GetAchievementInfo(id)); + if ( achCompleted and (ACHIEVEMENTUI_SELECTEDFILTER == AchievementFrameFilters[ACHIEVEMENT_FILTER_INCOMPLETE].func) ) then + AchievementFrame_SetFilter(ACHIEVEMENT_FILTER_ALL); + elseif ( (not achCompleted) and (ACHIEVEMENTUI_SELECTEDFILTER == AchievementFrameFilters[ACHIEVEMENT_FILTER_COMPLETE].func) ) then + AchievementFrame_SetFilter(ACHIEVEMENT_FILTER_ALL); + end + + -- Figure out if this is part of a progressive achievement; if it is and it's incomplete, make sure the previous level was completed. + -- If not, find the first incomplete achievement in the chain and display that instead. + local displayedId = AchievementFrame_FindDisplayedAchievement(id); + local category = GetAchievementCategory(displayedId); + AchievementFrame_UpdateAndSelectCategory(category); + + -- Scroll to the achievement and select it. + local scrollBox = nil; + if AchievementFrameComparison:IsShown() then + AchievementFrame_SelectAndScrollToAchievementId(AchievementFrameComparison.AchievementContainer.ScrollBox, displayedId); + else + AchievementFrame_SelectAndScrollToAchievementId(AchievementFrameAchievements.ScrollBox, displayedId); + end +end + +function AchievementFrame_SelectAndScrollToAchievementId(scrollBox, achievementId) + local dataProvider = scrollBox:GetDataProvider(); + if dataProvider then + local elementData = dataProvider:FindElementDataByPredicate(function(elementData) + return elementData.id == achievementId; + end); + if elementData then + g_achievementSelectionBehavior:SelectElementData(elementData); + -- Selection expands and modifies the size. We need to update the scroll box for the alignment to be correct. + scrollBox:FullUpdate(ScrollBoxConstants.UpdateImmediately); + scrollBox:ScrollToElementData(elementData, ScrollBoxConstants.AlignCenter); + end + end +end + +function AchievementFrame_ViewStatisticByAchievementID(achievementID) + local category = GetAchievementCategory(achievementID); + AchievementFrame_UpdateAndSelectCategory(category); + + local scrollBox = nil; + if AchievementFrameComparison:IsShown() then + scrollBox = AchievementFrameComparison.StatContainer.ScrollBox; + else + scrollBox = AchievementFrameStats.ScrollBox; + end + + local achievementElementData = scrollBox:ScrollToElementDataByPredicate(function(elementData) + return elementData.id == achievementID; + end, ScrollBoxConstants.AlignCenter); +end + +AchievementComparisonTemplateMixin = {};--- @class AchievementComparisonTemplateMixin + +function AchievementComparisonTemplateMixin:OnLoad() + AchievementComparisonButton_Localize(self); +end + +function AchievementComparisonTemplateMixin:Init(elementData) + local category = elementData.category; + local index = elementData.index; + local id, name, points, completed, month, day, year, description, flags, icon, rewardText, isGuild, wasEarnedByMe, earnedBy = GetAchievementInfo(category, index); + + assertsafe(id ~= nil, "Missing AchievementInfo for category '%d' index '%d'", category, index); + + if ( GetPreviousAchievement(id) ) then + -- If this is a progressive achievement, show the total score. + points = AchievementButton_GetProgressivePoints(id); + end + + if ( self.id ~= id ) then + self.id = id; + + local player = self.Player; + local friend = self.Friend; + + local saturatedStyle = "normal"; + if ( bit.band(flags, ACHIEVEMENT_FLAGS_ACCOUNT) == ACHIEVEMENT_FLAGS_ACCOUNT ) then + player.accountWide = true; + friend.accountWide = true; + saturatedStyle = "account"; + else + player.accountWide = nil; + friend.accountWide = nil; + end + + local friendCompleted, friendMonth, friendDay, friendYear = GetAchievementComparisonInfo(id); + player.Label:SetText(name); + + player.Description:SetText(description); + + player.Icon.texture:SetTexture(icon); + friend.Icon.texture:SetTexture(icon); + + if ( points > 0 ) then + player.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields]]); + friend.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields]]); + else + player.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields-NoPoints]]); + friend.Shield.Icon:SetTexture([[Interface\AchievementFrame\UI-Achievement-Shields-NoPoints]]); + end + AchievementShield_SetPoints(points, player.Shield.Points, ACHIEVEMENTCOMPARISON_PLAYERSHIELDFONT1, ACHIEVEMENTCOMPARISON_PLAYERSHIELDFONT2); + AchievementShield_SetPoints(points, friend.Shield.Points, ACHIEVEMENTCOMPARISON_FRIENDSHIELDFONT1, ACHIEVEMENTCOMPARISON_FRIENDSHIELDFONT2); + + player.Shield.wasEarnedByMe = not (completed and not wasEarnedByMe); + player.Shield.earnedBy = earnedBy; + + if ( completed ) then + player.completed = true; + player.DateCompleted:SetText(FormatShortDate(day, month, year)); + player.DateCompleted:Show(); + if ( player.saturatedStyle ~= saturatedStyle ) then + player:Saturate(); + end + else + player.completed = nil; + player.DateCompleted:Hide(); + player:Desaturate(); + end + + if ( friendCompleted ) then + friend.completed = true; + friend.Status:SetText(FormatShortDate(friendDay, friendMonth, friendYear)); + if ( friend.saturatedStyle ~= saturatedStyle ) then + friend:Saturate(); + end + else + friend.completed = nil; + friend.Status:SetText(INCOMPLETE); + friend:Desaturate(); + end + end +end + +function AchievementFrameComparison_OnLoad (self) + do + local view = CreateScrollBoxListLinearView(); + view:SetElementInitializer("AchievementComparisonTemplate", function(frame, elementData) + frame:Init(elementData); + end); + ScrollUtil.InitScrollBoxListWithScrollBar(self.AchievementContainer.ScrollBox, self.AchievementContainer.ScrollBar, view); + end + + do + local view = CreateScrollBoxListLinearView(); + view:SetElementInitializer("AchievementComparisonStatTemplate", function(frame, elementData) + frame:Init(elementData); + end); + ScrollUtil.InitScrollBoxListWithScrollBar(self.StatContainer.ScrollBox, self.StatContainer.ScrollBar, view); + end + + self:RegisterEvent("INSPECT_ACHIEVEMENT_READY"); +end + +local AchievementFrameComparisonShownEvents = +{ + "ACHIEVEMENT_EARNED", + "UNIT_PORTRAIT_UPDATE", + "PORTRAITS_UPDATED", + "DISPLAY_SIZE_CHANGED", +}; + +function AchievementFrameComparison_OnShow(self) + AchievementFrameStats:Hide(); + AchievementFrameAchievements:Hide(); + AchievementFrame:SetWidth(890); + SetUIPanelAttribute(AchievementFrame, "xOffset", 38); + UpdateUIPanelPositions(AchievementFrame); + AchievementFrame.isComparison = true; + C_AchievementInfo.SetPortraitTexture(AchievementFrameComparisonHeaderPortrait); + FrameUtil.RegisterFrameForEvents(self, AchievementFrameComparisonShownEvents); + AchievementFrameComparison_ForceUpdate(); +end + +function AchievementFrameComparison_OnHide(self) + AchievementFrame.selectedTab = nil; + AchievementFrame:SetWidth(768); + SetUIPanelAttribute(AchievementFrame, "xOffset", 80); + UpdateUIPanelPositions(AchievementFrame); + AchievementFrame.isComparison = false; + ClearAchievementComparisonUnit(); + FrameUtil.UnregisterFrameForEvents(self, AchievementFrameComparisonShownEvents); +end + +function AchievementFrameComparison_OnEvent (self, event, ...) + if event == "INSPECT_ACHIEVEMENT_READY" then + ClearSelectedCategories(); + local category = AchievementFrame_GetOrSelectCurrentCategory(); + AchievementFrameComparison_UpdateStatusBars(category); + AchievementFrameComparisonHeader.Points:SetText(GetComparisonAchievementPoints()); + elseif event == "DISPLAY_SIZE_CHANGED" then + C_AchievementInfo.SetPortraitTexture(AchievementFrameComparisonHeaderPortrait); + elseif event == "PORTRAITS_UPDATED" then + C_AchievementInfo.SetPortraitTexture(AchievementFrameComparisonHeaderPortrait); + elseif event == "UNIT_PORTRAIT_UPDATE" then + local updateUnit = ...; + if UnitName(updateUnit) == AchievementFrameComparisonHeaderName:GetText() then + C_AchievementInfo.SetPortraitTexture(AchievementFrameComparisonHeaderPortrait); + end + end + + AchievementFrameComparison_ForceUpdate(); +end + +function AchievementFrameComparison_SetUnit (unit) + ClearAchievementComparisonUnit(); + SetAchievementComparisonUnit(unit); + + AchievementFrameComparisonHeader.Points:SetText(GetComparisonAchievementPoints()); + AchievementFrameComparisonHeaderName:SetText(GetUnitName(unit)); + C_AchievementInfo.SetPortraitTexture(AchievementFrameComparisonHeaderPortrait); + AchievementFrameComparisonHeaderPortrait.unit = unit; + AchievementFrameComparisonHeaderPortrait.race = UnitRace(unit); + AchievementFrameComparisonHeaderPortrait.sex = UnitSex(unit); +end + +function AchievementFrameComparison_ForceUpdate () + if ( achievementFunctions == COMPARISON_ACHIEVEMENT_FUNCTIONS ) then + AchievementFrameComparison_UpdateDataProvider(); + elseif ( achievementFunctions == COMPARISON_STAT_FUNCTIONS ) then + AchievementFrameComparison_UpdateStatsDataProvider(); + end +end + +function AchievementFrameComparison_UpdateDataProvider () + local category = AchievementFrame_GetOrSelectCurrentCategory(); + if category == "summary" then + return; + end + + local numAchievements = GetCategoryNumAchievements(category); + local newDataProvider = CreateDataProvider(); + for index = 1, numAchievements do + newDataProvider:Insert({ index = index, category = category }); + end + AchievementFrameComparison.AchievementContainer.ScrollBox:SetDataProvider(newDataProvider); +end + +function AchievementFrameComparison_UpdateStatsDataProvider () + local category = GetSelectedCategory(); + local numStats = GetCategoryNumAchievements(category); + + local categories = {}; + if ( achievementFunctions.lastCategory ~= category ) then + -- build a list of shown category and stat id's + tinsert(categories, {id = category, header = true}); + + for i = 1, numStats do + tinsert(categories, {id = GetAchievementInfo(category, i)}); + end + achievementFunctions.lastCategory = category; + end + + -- add all the subcategories and their stat id's + for i, cat in next, achievementFunctions.categories do + if ( cat.parent == category ) then + tinsert(categories, {id = cat.id, header = true}); + numStats = GetCategoryNumAchievements(cat.id); + for k=1, numStats do + tinsert(categories, {id = GetAchievementInfo(cat.id, k)}); + end + end + end + + local newDataProvider = CreateDataProvider(); + for index = 1, #categories do + local stat = categories[index]; + stat.colorIndex = mod(index, 2); + newDataProvider:Insert(stat); + end + AchievementFrameComparison.StatContainer.ScrollBox:SetDataProvider(newDataProvider); +end + +function AchievementFrameComparisonStat_OnLoad (self) + self.Value:SetVertexColor(1, 0.97, 0.6); + self.FriendValue:SetVertexColor(1, 0.97, 0.6); +end + +AchivementComparisonStatMixin = {};--- @class AchivementComparisonStatMixin + +function AchivementComparisonStatMixin:Init(elementData) + local category = elementData.id; + local colorIndex = elementData.colorIndex; + if elementData.header then + self.Left:Show(); + self.Middle:Show(); + self.Right:Show(); + self.Left2:Show(); + self.Middle2:Show(); + self.Right2:Show(); + self.Title:SetText(GetCategoryInfo(category)); + self.Title:Show(); + self.FriendValue:SetText(""); + self.Value:SetText(""); + self.Text:SetText(""); + self:SetHeight(24); + self.Background:Hide(); + self.isHeader = true; + self.id = id; + else + local id, name = GetAchievementInfo(category); + + self.id = id; + + self.Background:Show(); + -- Color every other line yellow + if ( colorIndex == 1 ) then + self.Background:SetTexCoord(0, 1, 0.1875, 0.3671875); + self.Background:SetBlendMode("BLEND"); + self.Background:SetAlpha(1.0); + self:SetHeight(24); + else + self.Background:SetTexCoord(0, 1, 0.375, 0.5390625); + self.Background:SetBlendMode("ADD"); + self.Background:SetAlpha(0.5); + self:SetHeight(24); + end + + -- Figure out the criteria + local numCriteria = GetAchievementNumCriteria(id); + if ( numCriteria == 0 ) then + -- This is no good! + end + -- Just show the first criteria for now + local criteriaString, criteriaType, completed, quantityNumber, reqQuantity, charName, flags, assetID, quantity, friendQuantity; + if ( not isSummary ) then + friendQuantity = GetComparisonStatistic(id); + quantity = GetStatistic(id); + else + criteriaString, criteriaType, completed, quantityNumber, reqQuantity, charName, flags, assetID, quantity = GetAchievementCriteriaInfo(category); + end + if ( not quantity ) then + quantity = "--"; + end + if ( not friendQuantity ) then + friendQuantity = "--"; + end + + self.Value:SetText(quantity); + + -- We're gonna use self.text here to measure string width for friendQuantity. This saves us many strings! + self.Text:SetText(friendQuantity); + local width = self.Text:GetStringWidth(); + if ( width > self.FriendValue:GetWidth() ) then + self.FriendValue:SetFontObject("AchievementFont_Small"); + self.Mouseover:Show(); + self.Mouseover.tooltip = friendQuantity; + else + self.FriendValue:SetFontObject("GameFontHighlightRight"); + self.Mouseover:Hide(); + self.Mouseover.tooltip = nil; + end + + self.Text:SetText(name); + self.FriendValue:SetText(friendQuantity); + + -- Hide the header images + self.Title:Hide(); + self.Left:Hide(); + self.Middle:Hide(); + self.Right:Hide(); + self.Left2:Hide(); + self.Middle2:Hide(); + self.Right2:Hide(); + self.isHeader = false; + end +end + +function AchievementComparisonPlayerButton_Saturate (self) + local name = self:GetName(); + if ( InGuildView() ) then + self.Background:SetTexture("Interface\\AchievementFrame\\UI-GuildAchievement-Parchment-Horizontal"); + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.83203125, 0.91015625); + self:SetBackdropBorderColor(ACHIEVEMENT_RED_BORDER_COLOR:GetRGB()); + self.Shield.Points:SetVertexColor(0, 1, 0); + self.saturatedStyle = "guild"; + else + self.Background:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Parchment-Horizontal"); + self.Shield.Points:SetVertexColor(1, 1, 1); + if ( self.accountWide ) then + self.TitleBar:SetTexture("Interface\\AchievementFrame\\AccountLevel-AchievementHeader"); + self.TitleBar:SetTexCoord(0, 1, 0, 0.375); + self:SetBackdropBorderColor(ACHIEVEMENT_BLUE_BORDER_COLOR:GetRGB()); + self.saturatedStyle = "account"; + else + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.66015625, 0.73828125); + self:SetBackdropBorderColor(ACHIEVEMENT_RED_BORDER_COLOR:GetRGB()); + self.saturatedStyle = "normal"; + end + end + if ( self.isSummary ) then + if ( self.accountWide ) then + self.TitleBar:SetAlpha(1); + else + self.TitleBar:SetAlpha(0.5); + end + end + self.Glow:SetVertexColor(1.0, 1.0, 1.0); + self.Icon:Saturate(); + self.Shield:Saturate(); + self.Label:SetVertexColor(1, 1, 1); + self.Description:SetTextColor(0, 0, 0, 1); + self.Description:SetShadowOffset(0, 0); +end + +function AchievementComparisonPlayerButton_Desaturate (self) + self.saturatedStyle = nil; + local name = self:GetName(); + if ( InGuildView() ) then + self.Background:SetTexture("Interface\\AchievementFrame\\UI-GuildAchievement-Parchment-Horizontal-Desaturated"); + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.74609375, 0.82421875); + else + self.Background:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Parchment-Horizontal-Desaturated"); + if ( self.accountWide ) then + self.TitleBar:SetTexture("Interface\\AchievementFrame\\AccountLevel-AchievementHeader"); + self.TitleBar:SetTexCoord(0, 1, 0.40625, 0.78125); + else + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0, 1, 0.91796875, 0.99609375); + end + end + if ( self.isSummary ) then + if ( self.accountWide ) then + self.TitleBar:SetAlpha(1); + else + self.TitleBar:SetAlpha(0.5); + end + end + self.Glow:SetVertexColor(.22, .17, .13); + self.Icon:Desaturate(); + self.Shield:Desaturate(); + self.Shield.Points:SetVertexColor(.65, .65, .65); + self.Label:SetVertexColor(.65, .65, .65); + self.Description:SetTextColor(1, 1, 1, 1); + self.Description:SetShadowOffset(1, -1); + self:SetBackdropBorderColor(.5, .5, .5); +end + +function AchievementComparisonPlayerButton_OnLoad (self) + self.Saturate = AchievementComparisonPlayerButton_Saturate; + self.Desaturate = AchievementComparisonPlayerButton_Desaturate; + + self:Desaturate(); +end + +function AchievementComparisonFriendButton_Saturate (self) + if ( self.accountWide ) then + self.TitleBar:SetTexture("Interface\\AchievementFrame\\AccountLevel-AchievementHeader"); + self.TitleBar:SetTexCoord(0.3, 0.575, 0, 0.375); + self.saturatedStyle = "account"; + self:SetBackdropBorderColor(ACHIEVEMENT_BLUE_BORDER_COLOR:GetRGB()); + else + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0.3, 0.575, 0.66015625, 0.73828125); + self.saturatedStyle = "normal"; + self:SetBackdropBorderColor(ACHIEVEMENT_RED_BORDER_COLOR:GetRGB()); + end + self.Background:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Parchment-Horizontal"); + self.Glow:SetVertexColor(1.0, 1.0, 1.0); + self.Icon:Saturate(); + self.Shield:Saturate(); + self.Shield.Points:SetVertexColor(1, 1, 1); + self.Status:SetVertexColor(1, .82, 0); +end + +function AchievementComparisonFriendButton_Desaturate (self) + self.saturatedStyle = nil; + if ( self.accountWide ) then + self.TitleBar:SetTexture("Interface\\AchievementFrame\\AccountLevel-AchievementHeader"); + self.TitleBar:SetTexCoord(0.3, 0.575, 0.40625, 0.78125); + else + self.TitleBar:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Borders"); + self.TitleBar:SetTexCoord(0.3, 0.575, 0.74609375, 0.82421875); + end + self.Background:SetTexture("Interface\\AchievementFrame\\UI-Achievement-Parchment-Horizontal-Desaturated"); + self.Glow:SetVertexColor(.22, .17, .13); + self.Icon:Desaturate(); + self.Shield:Desaturate(); + self.Shield.Points:SetVertexColor(.65, .65, .65); + self.Status:SetVertexColor(.65, .65, .65); + self:SetBackdropBorderColor(.5, .5, .5); +end + +function AchievementComparisonFriendButton_OnLoad (self) + self.Saturate = AchievementComparisonFriendButton_Saturate; + self.Desaturate = AchievementComparisonFriendButton_Desaturate; + + self:Desaturate(); +end + +function AchievementFrame_IsComparison() + return AchievementFrame.isComparison; +end + +-- +-- Guild Members Display +-- + +function AchievementMeta_OnLeave(self) + GameTooltip:Hide(); + guildMemberRequestFrame = nil; +end + +function AchievementShield_OnEnter(self) + local parent = self:GetParent(); + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + if ( parent.accountWide ) then + if ( parent.completed ) then + GameTooltip:AddLine(ACCOUNT_WIDE_ACHIEVEMENT_COMPLETED); + else + GameTooltip:AddLine(ACCOUNT_WIDE_ACHIEVEMENT); + end + GameTooltip:Show(); + return; + end + if ( self.earnedBy ) then + GameTooltip:AddLine(ACCOUNT_WIDE_ACHIEVEMENT_COMPLETED); + local me = UnitName("player") + local tooltipLine = self.wasEarnedByMe and ACHIEVEMENT_COMPLETED_BY or ACHIEVEMENT_NOT_COMPLETED_BY; + GameTooltip_AddNormalLine(GameTooltip, tooltipLine:format(me)); + GameTooltip:Show(); + return; + else + GameTooltip_AddNormalLine(GameTooltip, CHARACTER_ACHIEVEMENT_DESCRIPTION); + end + -- pass-through to the achievement button + local func = parent:GetScript("OnEnter"); + if ( func ) then + func(parent); + end + + AchievementFrameAchievements_CheckGuildMembersTooltip(self); + GameTooltip:Show(); +end + +function AchievementShield_OnLeave(self) + -- pass-through to the achievement button + local parent = self:GetParent(); + local func = parent:GetScript("OnLeave"); + if ( func ) then + func(parent); + end + GameTooltip:Hide(); + guildMemberRequestFrame = nil; +end + +function AchievementFrameAchievements_CheckGuildMembersTooltip(requestFrame) + if ( InGuildView() ) then + local achievementId = requestFrame.id; + local _, achievementName, points, achievementCompleted, month, day, year, description, flags, iconpath = GetAchievementInfo(achievementId); + -- check if achievement has names, only if completed + if ( achievementCompleted and bit.band(flags, ACHIEVEMENT_FLAGS_SHOW_GUILD_MEMBERS) == ACHIEVEMENT_FLAGS_SHOW_GUILD_MEMBERS ) then + local numMembers = GetGuildAchievementNumMembers(achievementId); + if ( numMembers == 0 ) then + -- we may not have the members from the server yet + guildMemberRequestFrame = requestFrame; + GetGuildAchievementMembers(achievementId); + else + -- add a line break if the tooltip shows completed date (meta tooltip) + if ( GameTooltip:NumLines() > 0 ) then + GameTooltip:AddLine(" "); + end + GameTooltip:AddLine(GUILD_ACHIEVEMENT_EARNED_BY, 1, 1, 1); + local leftMemberName; + for i = 1, numMembers do + if ( leftMemberName ) then + GameTooltip:AddDoubleLine(leftMemberName, GetGuildAchievementMemberInfo(achievementId, i)); + leftMemberName = nil; + else + leftMemberName = GetGuildAchievementMemberInfo(achievementId, i); + end + end + -- check for leftover name + if ( leftMemberName ) then + GameTooltip:AddLine(leftMemberName); + end + end + -- otherwise check if criteria has names + elseif ( bit.band(flags, ACHIEVEMENT_FLAGS_SHOW_CRITERIA_MEMBERS) == ACHIEVEMENT_FLAGS_SHOW_CRITERIA_MEMBERS ) then + local numCriteria = GetAchievementNumCriteria(achievementId); + local firstName = true; + for i = 1, numCriteria do + local criteriaString, _, completed, _, _, charName = GetAchievementCriteriaInfo(achievementId, i); + if ( completed and charName ) then + if ( firstName ) then + if ( achievementCompleted ) then + GameTooltip:AddLine(GUILD_ACHIEVEMENT_EARNED_BY, 1, 1, 1); + else + GameTooltip:AddLine(INCOMPLETE, 1, 1, 1); + end + firstName = false; + end + GameTooltip:AddDoubleLine(criteriaString, charName, 0, 1, 0); + end + end + end + end +end + +-- If this achievement is part of a chain, find the first incomplete achievement in the chain. +function AchievementFrame_FindDisplayedAchievement(baseAchievementID) + local id = baseAchievementID; + local _, _, _, completed = GetAchievementInfo(id); + if ( not completed and GetPreviousAchievement(id) ) then + local prevID = GetPreviousAchievement(id); + _, _, _, completed = GetAchievementInfo(prevID); + while ( prevID and not completed ) do + id = prevID; + prevID = GetPreviousAchievement(id); + if ( prevID ) then + _, _, _, completed = GetAchievementInfo(prevID); + end + end + elseif ( completed ) then + local nextID; + nextID, completed = GetNextAchievement(id); + if ( nextID and completed ) then + local newID + while ( nextID and completed ) do + newID, completed = GetNextAchievement(nextID); + if ( completed ) then + nextID = newID; + end + end + id = nextID; + end + end + + return id; +end + +function AchievementFrame_HideSearchPreview() + local searchPreviewContainer = AchievementFrame.SearchPreviewContainer; + local searchPreviews = searchPreviewContainer.searchPreviews; + searchPreviewContainer:Hide(); + + for index = 1, ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS do + searchPreviews[index]:Hide(); + end + + searchPreviewContainer.ShowAllSearchResults:Hide(); + AchievementFrame.searchProgressBar:Hide(); +end + +function AchievementFrame_UpdateSearchPreview() + if ( not AchievementFrame.SearchBox:HasFocus() or strlen(AchievementFrame.SearchBox:GetText()) < MIN_CHARACTER_SEARCH) then + AchievementFrame_HideSearchPreview(); + return; + end + + AchievementFrame.SearchBox.searchPreviewUpdateDelay = 0; + + if ( AchievementFrame.SearchBox:GetScript("OnUpdate") == nil ) then + AchievementFrame.SearchBox:SetScript("OnUpdate", AchievementFrameSearchBox_OnUpdate); + end +end + +-- There is a delay before the search is updated to avoid a search progress bar if the search +-- completes within the grace period. +local ACHIEVEMENT_SEARCH_PREVIEW_UPDATE_DELAY = 0.3; +function AchievementFrameSearchBox_OnUpdate (self, elapsed) + if ( self.fullSearchFinished ) then + AchievementFrame_ShowSearchPreviewResults(); + self.searchPreviewUpdateDelay = 0; + self:SetScript("OnUpdate", nil); + return; + end + + self.searchPreviewUpdateDelay = self.searchPreviewUpdateDelay + elapsed; + + if ( self.searchPreviewUpdateDelay > ACHIEVEMENT_SEARCH_PREVIEW_UPDATE_DELAY ) then + self.searchPreviewUpdateDelay = 0; + self:SetScript("OnUpdate", nil); + + if ( AchievementFrame.searchProgressBar:GetScript("OnUpdate") == nil ) then + AchievementFrame.searchProgressBar:SetScript("OnUpdate", AchievementFrameSearchProgressBar_OnUpdate); + + local searchPreviewContainer = AchievementFrame.SearchPreviewContainer; + local searchPreviews = searchPreviewContainer.searchPreviews; + for index = 1, ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS do + searchPreviews[index]:Hide(); + end + + searchPreviewContainer.ShowAllSearchResults:Hide(); + + searchPreviewContainer.BorderAnchor:SetPoint("BOTTOM", 0, -5); + searchPreviewContainer.Background:Show(); + searchPreviewContainer:Show(); + + AchievementFrame.searchProgressBar:Show(); + return; + end + end +end + +-- If the searcher does not finish within the update delay then a search progress bar is displayed that +-- will fill until the search is finished and then display the search preview results. +function AchievementFrameSearchProgressBar_OnUpdate(self, elapsed) + local _, maxValue = self:GetMinMaxValues(); + local actualProgress = GetAchievementSearchProgress() / GetAchievementSearchSize() * maxValue; + local displayedProgress = self:GetValue(); + + self:SetValue(actualProgress); + + if ( self:GetValue() >= maxValue ) then + self:SetScript("OnUpdate", nil); + self:SetValue(0); + AchievementFrame_ShowSearchPreviewResults(); + end +end + +function AchievementFrame_ShowSearchPreviewResults() + AchievementFrame.searchProgressBar:Hide(); + + local numResults = GetNumFilteredAchievements(); + + if ( numResults > 0 ) then + AchievementFrame_SetSearchPreviewSelection(1); + end + + local searchPreviewContainer = AchievementFrame.SearchPreviewContainer; + local searchPreviews = searchPreviewContainer.searchPreviews; + local lastButton; + for index = 1, ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS do + local searchPreview = searchPreviews[index]; + if ( index <= numResults ) then + local achievementID = GetFilteredAchievementID(index); + local _, name, _, _, _, _, _, description, _, icon, _, _, _, _ = GetAchievementInfo(achievementID); + searchPreview.Name:SetText(name); + searchPreview.Icon:SetTexture(icon); + searchPreview.achievementID = achievementID; + searchPreview:Show(); + lastButton = searchPreview; + else + searchPreview.achievementID = nil; + searchPreview:Hide(); + end + end + + if ( numResults > 5 ) then + searchPreviewContainer.ShowAllSearchResults:Show(); + lastButton = searchPreviewContainer.ShowAllSearchResults; + searchPreviewContainer.ShowAllSearchResults.Text:SetText(string.format(ENCOUNTER_JOURNAL_SHOW_SEARCH_RESULTS, numResults)); + else + searchPreviewContainer.ShowAllSearchResults:Hide(); + end + + if (lastButton) then + searchPreviewContainer.BorderAnchor:SetPoint("BOTTOM", lastButton, "BOTTOM", 0, -5); + searchPreviewContainer.Background:Hide(); + searchPreviewContainer:Show(); + else + searchPreviewContainer:Hide(); + end +end + +function AchievementFrameSearchBox_OnTextChanged(self) + SearchBoxTemplate_OnTextChanged(self); + + if ( strlen(self:GetText()) >= MIN_CHARACTER_SEARCH ) then + AchievementFrame.SearchBox.fullSearchFinished = SetAchievementSearchString(self:GetText()); + if ( not AchievementFrame.SearchBox.fullSearchFinished ) then + AchievementFrame_UpdateSearchPreview(); + else + AchievementFrame_ShowSearchPreviewResults(); + end + else + AchievementFrame_HideSearchPreview(); + end +end + +AchievementFullSearchResultsButtonMixin = {};--- @class AchievementFullSearchResultsButtonMixin + +function AchievementFullSearchResultsButtonMixin:Init(elementData) + local index = elementData.index; + + local achievementID = GetFilteredAchievementID(index); + local _, name, _, completed, _, _, _, description, _, icon, _, _, _, _ = GetAchievementInfo(achievementID); + + self.Name:SetText(name); + self.Icon:SetTexture(icon); + self.achievementID = achievementID; + + if ( completed ) then + self.ResultType:SetText(ACHIEVEMENTFRAME_FILTER_COMPLETED); + else + self.ResultType:SetText(ACHIEVEMENTFRAME_FILTER_INCOMPLETE); + end + + local categoryID = GetAchievementCategory(achievementID); + local categoryName, parentCategoryID = GetCategoryInfo(categoryID); + local path = categoryName; + while ( parentCategoryID ~= -1 ) do + categoryName, parentCategoryID = GetCategoryInfo(parentCategoryID); + path = categoryName.." > "..path; + end + + self.Path:SetText(path); +end + +function AchievementFrameSearchBoxContainer_OnLoad(self) + local view = CreateScrollBoxListLinearView(); + view:SetElementInitializer("AchievementFullSearchResultsButtonTemplate", function(button, elementData) + button:Init(elementData); + end); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); +end + +function AchievementFrameSearchBox_OnLoad(self) + SearchBoxTemplate_OnLoad(self); + self.HasStickyFocus = function() + local ancestry = self:GetParent().SearchPreviewContainer; + return DoesAncestryIncludeAny(ancestry, GetMouseFoci()); + end +end + +function AchievementFrameSearchBox_OnShow(self) + self:SetFrameLevel(self:GetParent():GetFrameLevel() + 7); + AchievementFrame_SetSearchPreviewSelection(1); + self.fullSearchFinished = false; + self.searchPreviewUpdateDelay = 0; +end + +function AchievementFrameSearchBox_OnEnterPressed(self) + -- If the search is not finished yet we have to wait to show the full search results. + if ( not self.fullSearchFinished or strlen(self:GetText()) < MIN_CHARACTER_SEARCH ) then + return; + end + + local searchPreviewContainer = AchievementFrame.SearchPreviewContainer; + if ( self.selectedIndex == ACHIEVEMENT_FRAME_SHOW_ALL_RESULTS_INDEX ) then + if ( searchPreviewContainer.ShowAllSearchResults:IsShown() ) then + searchPreviewContainer.ShowAllSearchResults:Click(); + end + else + local preview = searchPreviewContainer.searchPreviews[self.selectedIndex]; + if ( preview:IsShown() ) then + preview:Click(); + end + end +end + +function AchievementFrameSearchBox_OnFocusLost(self) + SearchBoxTemplate_OnEditFocusLost(self); + AchievementFrame_HideSearchPreview(); +end + +function AchievementFrameSearchBox_OnFocusGained(self) + SearchBoxTemplate_OnEditFocusGained(self); + AchievementFrame.SearchResults:Hide(); + AchievementFrame_UpdateSearchPreview(); +end + +function AchievementFrameSearchBox_OnKeyDown(self, key) + if ( key == "UP" ) then + AchievementFrame_SetSearchPreviewSelection(AchievementFrame.SearchBox.selectedIndex - 1); + elseif ( key == "DOWN" ) then + AchievementFrame_SetSearchPreviewSelection(AchievementFrame.SearchBox.selectedIndex + 1); + end +end + +function AchievementFrame_SetSearchPreviewSelection(selectedIndex) + local searchPreviewContainer = AchievementFrame.SearchPreviewContainer; + local searchPreviews = searchPreviewContainer.searchPreviews; + local numShown = 0; + for index = 1, ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS do + local searchPreview = searchPreviews[index]; + searchPreview.SelectedTexture:Hide(); + + if ( searchPreview:IsShown() ) then + numShown = numShown + 1; + end + end + + if ( searchPreviewContainer.ShowAllSearchResults:IsShown() ) then + numShown = numShown + 1; + end + + searchPreviewContainer.ShowAllSearchResults.SelectedTexture:Hide(); + + if ( numShown <= 0 ) then + -- Default to the first entry. + selectedIndex = 1; + else + selectedIndex = (selectedIndex - 1) % numShown + 1; + end + + AchievementFrame.SearchBox.selectedIndex = selectedIndex; + + if ( selectedIndex == ACHIEVEMENT_FRAME_SHOW_ALL_RESULTS_INDEX ) then + searchPreviewContainer.ShowAllSearchResults.SelectedTexture:Show(); + else + searchPreviewContainer.searchPreviews[selectedIndex].SelectedTexture:Show(); + end +end + +function AcheivementFullSearchResultsButton_OnClick(self) + if (self.achievementID) then + AchievementFrame_SelectSearchItem(self.achievementID); + AchievementFrame.SearchResults:Hide(); + end +end + +function AchievementFrame_ShowFullSearch() + AchievementFrame_UpdateFullSearchResults(); + + if ( GetNumFilteredAchievements() == 0 ) then + AchievementFrame.SearchResults:Hide(); + return; + end + + AchievementFrame_HideSearchPreview(); + AchievementFrame.SearchBox:ClearFocus(); + AchievementFrame.SearchResults:Show(); +end + +function AchievementFrameSearch_InitButton(button, result) + local achievementID = GetFilteredAchievementID(index); + local _, name, _, completed, _, _, _, description, _, icon, _, _, _, _ = GetAchievementInfo(achievementID); + + result.Name:SetText(name); + result.Icon:SetTexture(icon); + result.achievementID = achievementID; + + if ( completed ) then + result.resultType:SetText(ACHIEVEMENTFRAME_FILTER_COMPLETED); + else + result.resultType:SetText(ACHIEVEMENTFRAME_FILTER_INCOMPLETE); + end + + local categoryID = GetAchievementCategory(achievementID); + local categoryName, parentCategoryID = GetCategoryInfo(categoryID); + local path = categoryName; + while ( parentCategoryID ~= -1 ) do + categoryName, parentCategoryID = GetCategoryInfo(parentCategoryID); + path = categoryName.." > "..path; + end + + result.path:SetText(path); +end + +function AchievementFrame_UpdateFullSearchResults() + local numResults = GetNumFilteredAchievements(); + + local newDataProvider = CreateDataProviderByIndexCount(numResults); + AchievementFrame.SearchResults.ScrollBox:SetDataProvider(newDataProvider); + + AchievementFrame.SearchResults.TitleText:SetText(string.format(ENCOUNTER_JOURNAL_SEARCH_RESULTS, AchievementFrame.SearchBox:GetText(), numResults)); +end + +function AchievementFrame_SelectSearchItem(id) + local isStatistic = select(15, GetAchievementInfo(id)); + if isStatistic then + AchievementFrame_ViewStatisticByAchievementID(id); + else + AchievementFrame_SelectAchievement(id, true); + end +end + +function AchievementSearchPreviewButton_OnShow(self) + self:SetFrameLevel(self:GetParent():GetFrameLevel() + 10); +end + +function AchievementSearchPreviewButton_OnLoad(self) + local searchPreviewContainer = AchievementFrame.SearchPreviewContainer; + local searchPreviews = searchPreviewContainer.searchPreviews; + for index = 1, ACHIEVEMENT_FRAME_NUM_SEARCH_PREVIEWS do + if ( searchPreviews[index] == self ) then + self.previewIndex = index; + break; + end + end +end + +function AchievementSearchPreviewButton_OnEnter(self) + AchievementFrame_SetSearchPreviewSelection(self.previewIndex); +end + +function AchievementSearchPreviewButton_OnClick(self) + if ( self.achievementID ) then + AchievementFrame_SelectSearchItem(self.achievementID); + AchievementFrame.SearchResults:Hide(); + AchievementFrame_HideSearchPreview(); + AchievementFrame.SearchBox:ClearFocus(); + end +end + +function AchievementFrameShowAllSearchResults_OnEnter() + AchievementFrame_SetSearchPreviewSelection(ACHIEVEMENT_FRAME_SHOW_ALL_RESULTS_INDEX); +end + +function AchievementFrame_UpdateSearch(self) + if ( AchievementFrame.SearchResults:IsShown() ) then + AchievementFrame_UpdateFullSearchResults(); + else + AchievementFrame_UpdateSearchPreview(); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml new file mode 100644 index 0000000..ecaca61 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml @@ -0,0 +1,2706 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AchievementFrameSummaryCategory_OnLoad(self); + + + AchievementFrameSummaryCategory_OnShow(self); + + + AchievementFrameSummaryCategory_OnEvent(self, event, ...); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + if ( self.name ) then + GameTooltip:AddDoubleLine(self.name, self.date, nil, nil, nil, .5, .5, .5); + end + if ( self.desc ) then + GameTooltip:AddLine(self.desc, 1, 1, 1, true); + end + if ( self.numCriteria ) then + if ( self.numCriteria > 30 ) then + for i = 1, self.numCriteria, 2 do + GameTooltip:AddDoubleLine(self["criteria"..i], self["criteria"..(i+1)]); + end + else + for i = 1, self.numCriteria do + GameTooltip:AddLine(self["criteria"..i]); + end + end + end + GameTooltip:Show(); + + + GameTooltip:Hide(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + self:SetStatusBarColor(0, .6, 0, 1); + self:SetMinMaxValues(0, 100); + self:SetValue(0); + self:GetStatusBarTexture():SetDrawLayer("BORDER"); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AchievementIcon_OnLoad(self); + + + + + + + + + + + + + + + + + + + + + + + + + + + + if ( button == "LeftButton" ) then + self:GetParent():GetParent():Click(); + end + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AchievementIcon_OnLoad(self); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AchievementShield_OnLoad(self); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AchievementFrameSummaryAchievement_OnClick(self, button, down); + + + AchievementFrameSummaryAchievement_OnEnter(self, motion); + + + self.Highlight:Hide(); + GameTooltip:Hide(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + local tooltip = self.tooltip; + if ( tooltip ) then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip:SetText(tooltip, nil, nil, nil, nil, true); + end + + + GameTooltip:Hide(); + + + + + + + AchievementFrameComparisonStat_OnLoad(self); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + self:RegisterEvent("ACHIEVEMENT_EARNED"); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + --Temporaries + SetPortraitTexture(_G[self:GetName().."Portrait"], "player"); + self:SetFrameLevel(self:GetParent():GetFrameLevel() + 4); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + local parent = self:GetParent(); + parent.Summary:Show(); + parent.Watermark:Hide(); + parent.Dark:Show(); + + + local parent = self:GetParent(); + parent.Summary:Hide(); + + + + + + + + + + + + + + + + + + + + + + + + + + + local parent = self:GetParent(); + parent.Watermark:Show(); + parent.Dark:Hide(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + self:SetFrameLevel(self:GetParent():GetFrameLevel() + 11); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + PlaySound(SOUNDKIT.IG_SPELLBOOK_OPEN); + + + PlaySound(SOUNDKIT.IG_SPELLBOOK_CLOSE); + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml.annotated.lua new file mode 100644 index 0000000..a3747e2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml.annotated.lua @@ -0,0 +1,1506 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L4) +--- Template +--- @class AchivementGoldBorderBackdrop : Frame, TooltipBackdropTemplate +--- @field backdropColorAlpha number # 0 +--- @field backdropBorderColor any # ACHIEVEMENT_GOLD_BORDER_COLOR + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L40) +--- child of AchievementSearchPreviewButton +--- @class AchievementSearchPreviewButton_Name : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L14) +--- Template +--- Adds itself to the parent inside the array `searchPreviews` +--- @class AchievementSearchPreviewButton : Button +--- @field SelectedTexture Texture +--- @field IconFrame Texture +--- @field Icon Texture +--- @field Name AchievementSearchPreviewButton_Name + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L80) +--- child of AchievementFullSearchResultsButtonTemplate +--- @class AchievementFullSearchResultsButtonTemplate_Name : FontString, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L87) +--- child of AchievementFullSearchResultsButtonTemplate +--- @class AchievementFullSearchResultsButtonTemplate_Path : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L94) +--- child of AchievementFullSearchResultsButtonTemplate +--- @class AchievementFullSearchResultsButtonTemplate_ResultType : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L62) +--- Template +--- @class AchievementFullSearchResultsButtonTemplate : Button, AchievementFullSearchResultsButtonMixin +--- @field IconFrame Texture +--- @field Icon Texture +--- @field Name AchievementFullSearchResultsButtonTemplate_Name +--- @field Path AchievementFullSearchResultsButtonTemplate_Path +--- @field ResultType AchievementFullSearchResultsButtonTemplate_ResultType + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoryTemplate +--- @class AchievementFrameSummaryCategoryTemplate_Button : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L118) +--- child of AchievementFrameSummaryCategoryTemplate +--- @class AchievementFrameSummaryCategoryTemplate_Label : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoryTemplate +--- @class AchievementFrameSummaryCategoryTemplate_Text : FontString, GameFontHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L114) +--- Template +--- @class AchievementFrameSummaryCategoryTemplate : StatusBar +--- @field Label AchievementFrameSummaryCategoryTemplate_Label +--- @field Text AchievementFrameSummaryCategoryTemplate_Text + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L224) +--- child of AchievementCheckButtonTemplate +--- @class AchievementCheckButtonTemplate_Text : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L220) +--- Template +--- @class AchievementCheckButtonTemplate : CheckButton, AchivementButtonCheckMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L246) +--- Template +--- @class AchievementFrameTabButtonTemplate : Button +--- @field LeftActive Texture +--- @field RightActive Texture +--- @field MiddleActive Texture +--- @field Left Texture +--- @field Right Texture +--- @field Middle Texture +--- @field LeftHighlight Texture +--- @field RightHighlight Texture +--- @field MiddleHighlight Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L343) +--- child of AchievementFrameAchievementsObjectivesTemplate +--- @class AchievementFrameAchievementsObjectivesTemplate_RepCriteria : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L340) +--- Template +--- @class AchievementFrameAchievementsObjectivesTemplate : Frame, AchievementsObjectivesMixin +--- @field RepCriteria AchievementFrameAchievementsObjectivesTemplate_RepCriteria + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L356) +--- @class AchievementFrameAchievementsObjectives : Frame, AchievementFrameAchievementsObjectivesTemplate +AchievementFrameAchievementsObjectives = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L357) +--- Template +--- @class AchievementGuildTabardTemplate : Frame +--- @field Background Texture +--- @field Border Texture +--- @field Emblem Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L421) +--- child of MiniAchievementTemplate +--- @class MiniAchievementTemplate_Points : FontString, GameFontWhiteSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L388) +--- Template +--- @class MiniAchievementTemplate : Frame +--- @field Icon Texture +--- @field Border Texture +--- @field Shield Texture +--- @field Points MiniAchievementTemplate_Points + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L488) +--- child of MetaCriteriaTemplate +--- @class MetaCriteriaTemplate_Label : FontString, AchievementCriteriaFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L457) +--- Template +--- @class MetaCriteriaTemplate : Button, AchievementMetaCriteriaMixin +--- @field Icon Texture +--- @field Border Texture +--- @field Check Texture +--- @field Label MetaCriteriaTemplate_Label + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L526) +--- child of AchievementProgressBarTemplate +--- @class AchievementProgressBarTemplate_Text : FontString, GameFontHighlightSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L510) +--- Template +--- @class AchievementProgressBarTemplate : StatusBar +--- @field Text AchievementProgressBarTemplate_Text + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L578) +--- child of AchievementHeaderStatusBarTemplate +--- @class AchievementHeaderStatusBarTemplate_Title : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L583) +--- child of AchievementHeaderStatusBarTemplate +--- @class AchievementHeaderStatusBarTemplate_Text : FontString, GameFontHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L571) +--- Template +--- @class AchievementHeaderStatusBarTemplate : StatusBar +--- @field Title AchievementHeaderStatusBarTemplate_Title +--- @field Text AchievementHeaderStatusBarTemplate_Text +--- @field Left Texture +--- @field Right Texture +--- @field Middle Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L642) +--- child of AchievementCategoryTemplate_Button +--- @class AchievementCategoryTemplate_Button_Label : FontString, GameFontNormalLeftBottom + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L625) +--- child of AchievementCategoryTemplate +--- @class AchievementCategoryTemplate_Button : Button, AchievementCategoryTemplateButtonMixin +--- @field Background Texture +--- @field Label AchievementCategoryTemplate_Button_Label + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L622) +--- Template +--- @class AchievementCategoryTemplate : Frame, AchievementCategoryTemplateMixin +--- @field Button AchievementCategoryTemplate_Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L668) +--- Template +--- @class AchievementIconFrameTemplate : Frame +--- @field bling Texture +--- @field texture Texture +--- @field frame Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L716) +--- child of AchievementCriteriaTemplate +--- @class AchievementCriteriaTemplate_Name : FontString, AchievementCriteriaFont, TruncatedTooltipFontStringTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L703) +--- Template +--- @class AchievementCriteriaTemplate : Frame +--- @field Check Texture +--- @field Name AchievementCriteriaTemplate_Name + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L885) +--- child of AchievementTemplate +--- @class AchievementTemplate_Highlight : Frame +--- @field TopLeft Texture +--- @field BottomLeft Texture +--- @field TopRight Texture +--- @field BottomRight Texture +--- @field Top Texture +--- @field Bottom Texture +--- @field Left Texture +--- @field Right Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L947) +--- child of AchievementTemplate +--- @class AchievementTemplate_Icon : Frame, AchievementIconFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L953) +--- child of AchievementTemplate +--- @class AchievementTemplate_Tabard : Frame, AchievementGuildTabardTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L974) +--- child of AchievementTemplate_Shield +--- @class AchievementTemplate_Shield_Points : FontString, AchievementPointsFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L980) +--- child of AchievementTemplate_Shield +--- @class AchievementTemplate_Shield_DateCompleted : FontString, AchievementDateFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L958) +--- child of AchievementTemplate +--- @class AchievementTemplate_Shield : Button +--- @field Icon Texture +--- @field Points AchievementTemplate_Shield_Points +--- @field DateCompleted AchievementTemplate_Shield_DateCompleted + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1005) +--- child of AchievementTemplate +--- @class AchievementTemplate_Tracked : CheckButton, AchievementCheckButtonTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L838) +--- child of AchievementTemplate +--- @class AchievementTemplate_Label : FontString, GameFontHighlightMedium + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L844) +--- child of AchievementTemplate +--- @class AchievementTemplate_Reward : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L850) +--- child of AchievementTemplate +--- @class AchievementTemplate_Description : FontString, AchievementDescriptionFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L856) +--- child of AchievementTemplate +--- @class AchievementTemplate_HiddenDescription : FontString, AchievementDescriptionFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L733) +--- Template +--- @class AchievementTemplate : EventButton, TooltipBorderBackdropTemplate, AchievementTemplateMixin +--- @field Highlight AchievementTemplate_Highlight +--- @field Icon AchievementTemplate_Icon +--- @field Tabard AchievementTemplate_Tabard +--- @field Shield AchievementTemplate_Shield +--- @field objectives Frame +--- @field Tracked AchievementTemplate_Tracked +--- @field Background Texture +--- @field BottomLeftTsunami Texture +--- @field BottomRightTsunami Texture +--- @field TopLeftTsunami Texture +--- @field TopRightTsunami Texture +--- @field BottomTsunami1 Texture +--- @field TopTsunami1 Texture +--- @field TitleBar Texture +--- @field Glow Texture +--- @field RewardBackground Texture +--- @field GuildCornerL Texture +--- @field GuildCornerR Texture +--- @field Label AchievementTemplate_Label +--- @field Reward AchievementTemplate_Reward +--- @field Description AchievementTemplate_Description +--- @field HiddenDescription AchievementTemplate_HiddenDescription +--- @field Check Texture +--- @field PlusMinus Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1068) +--- child of ComparisonPlayerTemplate +--- @class ComparisonPlayerTemplate_Icon : Frame +--- @field bling Texture +--- @field texture Texture +--- @field frame Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1122) +--- child of ComparisonPlayerTemplate_Shield +--- @class ComparisonPlayerTemplate_Shield_Points : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1106) +--- child of ComparisonPlayerTemplate +--- @class ComparisonPlayerTemplate_Shield : Frame +--- @field Icon Texture +--- @field Points ComparisonPlayerTemplate_Shield_Points + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1044) +--- child of ComparisonPlayerTemplate +--- @class ComparisonPlayerTemplate_Label : FontString, GameFontHighlightMedium + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1050) +--- child of ComparisonPlayerTemplate +--- @class ComparisonPlayerTemplate_DateCompleted : FontString, AchievementDateFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1056) +--- child of ComparisonPlayerTemplate +--- @class ComparisonPlayerTemplate_Description : FontString, AchievementDescriptionFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1012) +--- Template +--- @class ComparisonPlayerTemplate : Frame, TooltipBorderBackdropTemplate +--- @field Icon ComparisonPlayerTemplate_Icon +--- @field Shield ComparisonPlayerTemplate_Shield +--- @field Background Texture +--- @field TitleBar Texture +--- @field Glow Texture +--- @field Label ComparisonPlayerTemplate_Label +--- @field DateCompleted ComparisonPlayerTemplate_DateCompleted +--- @field Description ComparisonPlayerTemplate_Description + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1145) +--- child of SummaryAchievementTemplate +--- @class SummaryAchievementTemplate_Highlight : Frame +--- @field TopLeft Texture +--- @field BottomLeft Texture +--- @field TopRight Texture +--- @field BottomRight Texture +--- @field Top Texture +--- @field Bottom Texture +--- @field Left Texture +--- @field Right Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1138) +--- Template +--- @class SummaryAchievementTemplate : Frame, ComparisonPlayerTemplate +--- @field backdropBorderColor any # ACHIEVEMENT_RED_BORDER_COLOR +--- @field backdropBorderColorAlpha number # 0.5 +--- @field Highlight SummaryAchievementTemplate_Highlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1228) +--- child of AchievementComparisonTemplate +--- @class AchievementComparisonTemplate_Player : Frame, ComparisonPlayerTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1276) +--- child of AchievementComparisonTemplate_Friend +--- @class AchievementComparisonTemplate_Friend_Icon : Frame +--- @field bling Texture +--- @field texture Texture +--- @field frame Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1328) +--- child of AchievementComparisonTemplate_Friend_Shield +--- @class AchievementComparisonTemplate_Friend_Shield_Points : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1312) +--- child of AchievementComparisonTemplate_Friend +--- @class AchievementComparisonTemplate_Friend_Shield : Frame +--- @field Icon Texture +--- @field Points AchievementComparisonTemplate_Friend_Shield_Points + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1268) +--- child of AchievementComparisonTemplate_Friend +--- @class AchievementComparisonTemplate_Friend_Status : FontString, AchievementDateFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1233) +--- child of AchievementComparisonTemplate +--- @class AchievementComparisonTemplate_Friend : Frame, TooltipBorderBackdropTemplate +--- @field Icon AchievementComparisonTemplate_Friend_Icon +--- @field Shield AchievementComparisonTemplate_Friend_Shield +--- @field Background Texture +--- @field TitleBar Texture +--- @field Glow Texture +--- @field Status AchievementComparisonTemplate_Friend_Status + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1222) +--- Template +--- @class AchievementComparisonTemplate : Frame, AchievementComparisonTemplateMixin +--- @field Player AchievementComparisonTemplate_Player +--- @field Friend AchievementComparisonTemplate_Friend + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1378) +--- child of AchievementStatTemplate +--- @class AchievementStatTemplate_Title : FontString, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1383) +--- child of AchievementStatTemplate +--- @class AchievementStatTemplate_Value : FontString, GameFontHighlightRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1351) +--- Template +--- @class AchievementStatTemplate : Button, AchievementStatTemplateMixin +--- @field Background Texture +--- @field Left Texture +--- @field Right Texture +--- @field Middle Texture +--- @field Title AchievementStatTemplate_Title +--- @field Value AchievementStatTemplate_Value + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1454) +--- child of AchievementComparisonStatTemplate +--- @class AchievementComparisonStatTemplate_Title : FontString, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1459) +--- child of AchievementComparisonStatTemplate +--- @class AchievementComparisonStatTemplate_Text : FontString, GameFontHighlightLeft + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1464) +--- child of AchievementComparisonStatTemplate +--- @class AchievementComparisonStatTemplate_Value : FontString, GameFontHighlightRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1470) +--- child of AchievementComparisonStatTemplate +--- @class AchievementComparisonStatTemplate_FriendValue : FontString, GameFontHighlightRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1405) +--- Template +--- @class AchievementComparisonStatTemplate : Frame, AchivementComparisonStatMixin +--- @field Mouseover Frame +--- @field Background Texture +--- @field Left Texture +--- @field Right Texture +--- @field Middle Texture +--- @field Left2 Texture +--- @field Right2 Texture +--- @field Middle2 Texture +--- @field Title AchievementComparisonStatTemplate_Title +--- @field Text AchievementComparisonStatTemplate_Text +--- @field Value AchievementComparisonStatTemplate_Value +--- @field FriendValue AchievementComparisonStatTemplate_FriendValue + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1690) +--- child of AchievementFrame_Header +--- @class AchievementFrame_Header_Title : FontString, GameFontNormalSmall, AutoScalingFontStringMixin +--- @field minLineHeight number # 8 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1713) +--- child of AchievementFrame_Header +--- @class AchievementFrame_Header_Points : FontString, GameFontHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1660) +--- child of AchievementFrame +--- @class AchievementFrame_Header : Frame +--- @field Left Texture +--- @field Right Texture +--- @field PointBorder Texture +--- @field Title AchievementFrame_Header_Title +--- @field LeftDDLInset Texture +--- @field RightDDLInset Texture +--- @field Points AchievementFrame_Header_Points +--- @field Shield Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1740) +--- child of AchievementFrameCategories +--- @class AchievementFrameCategories_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1747) +--- child of AchievementFrameCategories +--- @class AchievementFrameCategories_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1729) +--- child of AchievementFrame +--- @class AchievementFrameCategories : Frame, AchivementGoldBorderBackdrop +--- @field ScrollBox AchievementFrameCategories_ScrollBox +--- @field ScrollBar AchievementFrameCategories_ScrollBar +AchievementFrameCategories = {} +AchievementFrameCategories["backdropColorAlpha"] = 0 -- inherited +AchievementFrameCategories["backdropBorderColor"] = ACHIEVEMENT_GOLD_BORDER_COLOR -- inherited +AchievementFrameCategories["layoutType"] = "TooltipDefaultLayout" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1800) +--- child of AchievementFrameAchievements +--- @class AchievementFrameAchievements_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1807) +--- child of AchievementFrameAchievements +--- @class AchievementFrameAchievements_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1777) +--- child of AchievementFrameAchievements +--- @class AchievementFrameAchievementsFeatOfStrengthText : FontString, GameFontHighlight +AchievementFrameAchievementsFeatOfStrengthText = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1755) +--- child of AchievementFrame +--- @class AchievementFrameAchievements : Frame +--- @field ScrollBox AchievementFrameAchievements_ScrollBox +--- @field ScrollBar AchievementFrameAchievements_ScrollBar +--- @field Background Texture +AchievementFrameAchievements = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1829) +--- child of AchievementFrameStats +--- @class AchievementFrameStatsBG : Frame +AchievementFrameStatsBG = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1850) +--- child of AchievementFrameStats +--- @class AchievementFrameStats_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1857) +--- child of AchievementFrameStats +--- @class AchievementFrameStats_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1816) +--- child of AchievementFrame +--- @class AchievementFrameStats : Frame +--- @field ScrollBox AchievementFrameStats_ScrollBox +--- @field ScrollBar AchievementFrameStats_ScrollBar +AchievementFrameStats = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1909) +--- child of AchievementFrameSummaryAchievementsHeader +--- @class AchievementFrameSummaryAchievementsHeaderHeader : Texture +AchievementFrameSummaryAchievementsHeaderHeader = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1916) +--- child of AchievementFrameSummaryAchievementsHeader +--- @class AchievementFrameSummaryAchievementsHeaderTitle : FontString, GameFontNormal +AchievementFrameSummaryAchievementsHeaderTitle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1901) +--- child of AchievementFrameSummaryAchievements +--- @class AchievementFrameSummaryAchievementsHeader : Frame +AchievementFrameSummaryAchievementsHeader = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1893) +--- child of AchievementFrameSummaryAchievements +--- @class AchievementFrameSummaryAchievementsEmptyText : FontString, GameFontHighlight +AchievementFrameSummaryAchievementsEmptyText = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1885) +--- child of AchievementFrameSummary +--- @class AchievementFrameSummaryAchievements : Frame +AchievementFrameSummaryAchievements = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1942) +--- child of AchievementFrameSummaryCategoriesHeader +--- @class AchievementFrameSummaryCategoriesHeaderTexture : Texture +AchievementFrameSummaryCategoriesHeaderTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1949) +--- child of AchievementFrameSummaryCategoriesHeader +--- @class AchievementFrameSummaryCategoriesHeaderTitle : FontString, GameFontNormal +AchievementFrameSummaryCategoriesHeaderTitle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1934) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesHeader : Frame +AchievementFrameSummaryCategoriesHeader = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1965) +--- child of AchievementFrameSummaryCategoriesStatusBar +--- @class AchievementFrameSummaryCategoriesStatusBarTitle : FontString, GameFontNormal +AchievementFrameSummaryCategoriesStatusBarTitle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1970) +--- child of AchievementFrameSummaryCategoriesStatusBar +--- @class AchievementFrameSummaryCategoriesStatusBarText : FontString, GameFontHighlight +AchievementFrameSummaryCategoriesStatusBarText = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1976) +--- child of AchievementFrameSummaryCategoriesStatusBar +--- @class AchievementFrameSummaryCategoriesStatusBarLeft : Texture +AchievementFrameSummaryCategoriesStatusBarLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1983) +--- child of AchievementFrameSummaryCategoriesStatusBar +--- @class AchievementFrameSummaryCategoriesStatusBarRight : Texture +AchievementFrameSummaryCategoriesStatusBarRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1990) +--- child of AchievementFrameSummaryCategoriesStatusBar +--- @class AchievementFrameSummaryCategoriesStatusBarMiddle : Texture +AchievementFrameSummaryCategoriesStatusBarMiddle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2000) +--- child of AchievementFrameSummaryCategoriesStatusBar +--- @class AchievementFrameSummaryCategoriesStatusBarFillBar : Texture +AchievementFrameSummaryCategoriesStatusBarFillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1958) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesStatusBar : StatusBar +AchievementFrameSummaryCategoriesStatusBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory1 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory1Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory1 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory1Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory1 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory1Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory1 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory1Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory1 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory1Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory1 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory1FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2009) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory1 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory1 = {} +AchievementFrameSummaryCategoriesCategory1["Text"] = AchievementFrameSummaryCategoriesCategory1Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory2 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory2Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory2 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory2Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory2 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory2Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory2 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory2Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory2 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory2Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory2 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory2FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2014) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory2 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory2 = {} +AchievementFrameSummaryCategoriesCategory2["Text"] = AchievementFrameSummaryCategoriesCategory2Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory3 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory3Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory3 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory3Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory3 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory3Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory3 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory3Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory3 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory3Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory3 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory3FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2019) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory3 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory3 = {} +AchievementFrameSummaryCategoriesCategory3["Text"] = AchievementFrameSummaryCategoriesCategory3Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory4 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory4Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory4 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory4Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory4 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory4Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory4 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory4Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory4 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory4Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory4 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory4FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2024) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory4 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory4 = {} +AchievementFrameSummaryCategoriesCategory4["Text"] = AchievementFrameSummaryCategoriesCategory4Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory5 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory5Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory5 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory5Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory5 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory5Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory5 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory5Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory5 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory5Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory5 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory5FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2029) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory5 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory5 = {} +AchievementFrameSummaryCategoriesCategory5["Text"] = AchievementFrameSummaryCategoriesCategory5Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory6 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory6Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory6 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory6Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory6 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory6Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory6 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory6Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory6 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory6Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory6 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory6FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2034) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory6 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory6 = {} +AchievementFrameSummaryCategoriesCategory6["Text"] = AchievementFrameSummaryCategoriesCategory6Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory7 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory7Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory7 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory7Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory7 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory7Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory7 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory7Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory7 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory7Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory7 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory7FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2039) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory7 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory7 = {} +AchievementFrameSummaryCategoriesCategory7["Text"] = AchievementFrameSummaryCategoriesCategory7Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory8 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory8Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory8 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory8Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory8 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory8Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory8 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory8Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory8 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory8Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory8 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory8FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2044) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory8 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory8 = {} +AchievementFrameSummaryCategoriesCategory8["Text"] = AchievementFrameSummaryCategoriesCategory8Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory9 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory9Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory9 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory9Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory9 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory9Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory9 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory9Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory9 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory9Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory9 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory9FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2049) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory9 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory9 = {} +AchievementFrameSummaryCategoriesCategory9["Text"] = AchievementFrameSummaryCategoriesCategory9Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory10 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory10Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory10 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory10Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory10 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory10Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory10 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory10Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory10 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory10Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory10 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory10FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2054) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory10 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory10 = {} +AchievementFrameSummaryCategoriesCategory10["Text"] = AchievementFrameSummaryCategoriesCategory10Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory11 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory11Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory11 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory11Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory11 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory11Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory11 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory11Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory11 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory11Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory11 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory11FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2059) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory11 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory11 = {} +AchievementFrameSummaryCategoriesCategory11["Text"] = AchievementFrameSummaryCategoriesCategory11Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L165) +--- child of AchievementFrameSummaryCategoryTemplateButton +--- @class AchievementFrameSummaryCategoryTemplate_Button_Highlight : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L159) +--- child of AchievementFrameSummaryCategoriesCategory12 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Button +AchievementFrameSummaryCategoriesCategory12Button = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L123) +--- child of AchievementFrameSummaryCategoriesCategory12 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type AchievementFrameSummaryCategoryTemplate_Text +AchievementFrameSummaryCategoriesCategory12Text = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L129) +--- child of AchievementFrameSummaryCategoriesCategory12 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory12Left = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L136) +--- child of AchievementFrameSummaryCategoriesCategory12 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory12Right = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L143) +--- child of AchievementFrameSummaryCategoriesCategory12 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory12Middle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L152) +--- child of AchievementFrameSummaryCategoriesCategory12 (created in template AchievementFrameSummaryCategoryTemplate) +--- @type Texture +AchievementFrameSummaryCategoriesCategory12FillBar = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2064) +--- child of AchievementFrameSummaryCategories +--- @class AchievementFrameSummaryCategoriesCategory12 : StatusBar, AchievementFrameSummaryCategoryTemplate +AchievementFrameSummaryCategoriesCategory12 = {} +AchievementFrameSummaryCategoriesCategory12["Text"] = AchievementFrameSummaryCategoriesCategory12Text -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1927) +--- child of AchievementFrameSummary +--- @class AchievementFrameSummaryCategories : Frame +AchievementFrameSummaryCategories = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1866) +--- child of AchievementFrame +--- @class AchievementFrameSummary : Frame +--- @field Background Texture +AchievementFrameSummary = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2094) +--- child of AchievementFrameComparisonHeader +--- @class AchievementFrameComparisonHeaderBG : Texture +AchievementFrameComparisonHeaderBG = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2103) +--- child of AchievementFrameComparisonHeader +--- @class AchievementFrameComparisonHeaderPortrait : Texture +AchievementFrameComparisonHeaderPortrait = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2112) +--- child of AchievementFrameComparisonHeader +--- @class AchievementFrameComparisonHeaderPortraitBg : Texture +AchievementFrameComparisonHeaderPortraitBg = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2121) +--- child of AchievementFrameComparisonHeader +--- @class AchievementFrameComparisonHeaderName : FontString, GameFontNormalLeft +AchievementFrameComparisonHeaderName = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2127) +--- child of AchievementFrameComparisonHeader +--- @class AchievementFrameComparisonHeader_Points : FontString, GameFontHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2087) +--- child of AchievementFrameComparison +--- @class AchievementFrameComparisonHeader : Frame +--- @field Points AchievementFrameComparisonHeader_Points +--- @field Shield Texture +AchievementFrameComparisonHeader = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2175) +--- child of AchievementFrameComparison_Summary_Player +--- @class AchievementFrameComparison_Summary_Player_StatusBar : StatusBar, AchievementHeaderStatusBarTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2165) +--- child of AchievementFrameComparison_Summary_Player +--- @class AchievementFrameComparisonBackground : Texture +AchievementFrameComparisonBackground = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2155) +--- child of AchievementFrameComparison_Summary +--- @class AchievementFrameComparison_Summary_Player : Frame, TooltipBorderBackdropTemplate +--- @field backdropBorderColor any # ACHIEVEMENT_YELLOW_BORDER_COLOR +--- @field StatusBar AchievementFrameComparison_Summary_Player_StatusBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2204) +--- child of AchievementFrameComparison_Summary_Friend +--- @class AchievementFrameComparison_Summary_Friend_StatusBar : StatusBar, AchievementHeaderStatusBarTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2194) +--- child of AchievementFrameComparison_Summary_Friend +--- @class AchievementFrameComparisonBackground : Texture +AchievementFrameComparisonBackground = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2184) +--- child of AchievementFrameComparison_Summary +--- @class AchievementFrameComparison_Summary_Friend : Frame, TooltipBorderBackdropTemplate +--- @field backdropBorderColor any # ACHIEVEMENT_YELLOW_BORDER_COLOR +--- @field StatusBar AchievementFrameComparison_Summary_Friend_StatusBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2149) +--- child of AchievementFrameComparison +--- @class AchievementFrameComparison_Summary : Frame +--- @field Player AchievementFrameComparison_Summary_Player +--- @field Friend AchievementFrameComparison_Summary_Friend + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2214) +--- child of AchievementFrameComparison_AchievementContainer +--- @class AchievementFrameComparison_AchievementContainer_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2221) +--- child of AchievementFrameComparison_AchievementContainer +--- @class AchievementFrameComparison_AchievementContainer_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2212) +--- child of AchievementFrameComparison +--- @class AchievementFrameComparison_AchievementContainer : Frame +--- @field ScrollBox AchievementFrameComparison_AchievementContainer_ScrollBox +--- @field ScrollBar AchievementFrameComparison_AchievementContainer_ScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2248) +--- child of AchievementFrameComparison_StatContainer +--- @class AchievementFrameComparison_StatContainer_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2255) +--- child of AchievementFrameComparison_StatContainer +--- @class AchievementFrameComparison_StatContainer_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2242) +--- child of AchievementFrameComparison +--- @class AchievementFrameComparison_StatContainer : Frame +--- @field ScrollBox AchievementFrameComparison_StatContainer_ScrollBox +--- @field ScrollBar AchievementFrameComparison_StatContainer_ScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2275) +--- child of AchievementFrameComparison +--- @class AchievementFrameComparisonBackground : Texture +AchievementFrameComparisonBackground = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2080) +--- child of AchievementFrame +--- @class AchievementFrameComparison : Frame +--- @field Summary AchievementFrameComparison_Summary +--- @field AchievementContainer AchievementFrameComparison_AchievementContainer +--- @field StatContainer AchievementFrameComparison_StatContainer +--- @field Dark Texture +--- @field Watermark Texture +AchievementFrameComparison = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2309) +--- child of AchievementFrame +--- @class AchievementFrameCloseButton : Button, UIPanelCloseButton +AchievementFrameCloseButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2321) +--- child of AchievementFrame +--- @class AchievementFrameTab1 : Button, AchievementFrameTabButtonTemplate +AchievementFrameTab1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2332) +--- child of AchievementFrame +--- @class AchievementFrameTab2 : Button, AchievementFrameTabButtonTemplate +AchievementFrameTab2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2340) +--- child of AchievementFrame +--- @class AchievementFrameTab3 : Button, AchievementFrameTabButtonTemplate +AchievementFrameTab3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2348) +--- child of AchievementFrame +--- @class AchievementFrameFilterDropdown : DropdownButton, WowStyle1FilterDropdownTemplate +--- @field resizeToText boolean # false +AchievementFrameFilterDropdown = {} +AchievementFrameFilterDropdown["resizeToText"] = false +AchievementFrameFilterDropdown["text"] = FILTER -- inherited +AchievementFrameFilterDropdown["disableFontObject"] = "GameFontDisable" -- inherited +AchievementFrameFilterDropdown["menuRelativePoint"] = "BOTTOMLEFT" -- inherited +AchievementFrameFilterDropdown["menuPointX"] = 6 -- inherited +AchievementFrameFilterDropdown["menuPointY"] = 2 -- inherited +AchievementFrameFilterDropdown["resizeToTextPadding"] = 60 -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L44) +--- child of AchievementFrame_SearchBox (created in template SearchBoxTemplate) +--- @type SearchBoxTemplate_ClearButton +AchievementFrameClearButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L35) +--- child of AchievementFrame_SearchBox (created in template SearchBoxTemplate) +--- @type Texture +AchievementFrameSearchIcon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2356) +--- child of AchievementFrame +--- @class AchievementFrame_SearchBox : EditBox, SearchBoxTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2425) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_SearchPreview1 : Button, AchievementSearchPreviewButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2430) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_SearchPreview2 : Button, AchievementSearchPreviewButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2435) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_SearchPreview3 : Button, AchievementSearchPreviewButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2440) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_SearchPreview4 : Button, AchievementSearchPreviewButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2445) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_SearchPreview5 : Button, AchievementSearchPreviewButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2467) +--- child of AchievementFrame_SearchPreviewContainer_ShowAllSearchResults +--- @class AchievementFrame_SearchPreviewContainer_ShowAllSearchResults_Text : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2450) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_ShowAllSearchResults : Button +--- @field SelectedTexture Texture +--- @field Text AchievementFrame_SearchPreviewContainer_ShowAllSearchResults_Text + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2386) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_BorderAnchor : Texture, UI_Frame_BotCornerLeft + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2392) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_BotRightCorner : Texture, UI_Frame_BotCornerRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2398) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_BottomBorder : Texture, _UI_Frame_Bot + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2404) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_LeftBorder : Texture, _UI_Frame_LeftTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2410) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_RightBorder : Texture, _UI_Frame_RightTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2416) +--- child of AchievementFrame_SearchPreviewContainer +--- @class AchievementFrame_SearchPreviewContainer_TopBorder : Texture, _UI_Frame_Bot + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2371) +--- child of AchievementFrame +--- @class AchievementFrame_SearchPreviewContainer : Frame +--- @field SearchPreview1 AchievementFrame_SearchPreviewContainer_SearchPreview1 +--- @field SearchPreview2 AchievementFrame_SearchPreviewContainer_SearchPreview2 +--- @field SearchPreview3 AchievementFrame_SearchPreviewContainer_SearchPreview3 +--- @field SearchPreview4 AchievementFrame_SearchPreviewContainer_SearchPreview4 +--- @field SearchPreview5 AchievementFrame_SearchPreviewContainer_SearchPreview5 +--- @field ShowAllSearchResults AchievementFrame_SearchPreviewContainer_ShowAllSearchResults +--- @field Background Texture +--- @field BorderAnchor AchievementFrame_SearchPreviewContainer_BorderAnchor +--- @field BotRightCorner AchievementFrame_SearchPreviewContainer_BotRightCorner +--- @field BottomBorder AchievementFrame_SearchPreviewContainer_BottomBorder +--- @field LeftBorder AchievementFrame_SearchPreviewContainer_LeftBorder +--- @field RightBorder AchievementFrame_SearchPreviewContainer_RightBorder +--- @field TopBorder AchievementFrame_SearchPreviewContainer_TopBorder +--- @field searchPreviews table + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2517) +--- child of AchievementFrame_searchProgressBar +--- @class AchievementFrame_searchProgressBar_Text : FontString, GameFontHighlightSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2501) +--- child of AchievementFrame +--- @class AchievementFrame_searchProgressBar : StatusBar +--- @field bg Texture +--- @field Text AchievementFrame_searchProgressBar_Text +--- @field BorderLeft Texture +--- @field BorderRight Texture +--- @field BorderCenter Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2663) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_CloseButton : Button, UIPanelCloseButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2673) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2680) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2583) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TitleText : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2590) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopLeftCorner : Texture, UI_Frame_TopCornerLeft + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2595) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopRightCorner : Texture, UI_Frame_TopCornerRightSimple + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2600) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopBorder : Texture, _UI_Frame_Top + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2606) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_BottomLeftCorner : Texture, UI_Frame_BotCornerLeft + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2611) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_BottomRightCorner : Texture, UI_Frame_BotCornerRight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2616) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_BottomBorder : Texture, _UI_Frame_Bot + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2622) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_LeftBorder : Texture, _UI_Frame_LeftTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2628) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_RightBorder : Texture, _UI_Frame_RightTile + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2636) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopTileStreaks : Texture, _UI_Frame_TopTileStreaks + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2644) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopLeftCorner2 : Texture, UI_Frame_TopCornerLeft + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2649) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopRightCorner2 : Texture, UI_Frame_TopCornerRightSimple + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2654) +--- child of AchievementFrame_SearchResults +--- @class AchievementFrame_SearchResults_TopBorder2 : Texture, _UI_Frame_Top + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L2567) +--- child of AchievementFrame +--- @class AchievementFrame_SearchResults : Frame +--- @field CloseButton AchievementFrame_SearchResults_CloseButton +--- @field ScrollBox AchievementFrame_SearchResults_ScrollBox +--- @field ScrollBar AchievementFrame_SearchResults_ScrollBar +--- @field TitleText AchievementFrame_SearchResults_TitleText +--- @field TopLeftCorner AchievementFrame_SearchResults_TopLeftCorner +--- @field TopRightCorner AchievementFrame_SearchResults_TopRightCorner +--- @field TopBorder AchievementFrame_SearchResults_TopBorder +--- @field BottomLeftCorner AchievementFrame_SearchResults_BottomLeftCorner +--- @field BottomRightCorner AchievementFrame_SearchResults_BottomRightCorner +--- @field BottomBorder AchievementFrame_SearchResults_BottomBorder +--- @field LeftBorder AchievementFrame_SearchResults_LeftBorder +--- @field RightBorder AchievementFrame_SearchResults_RightBorder +--- @field TopTileStreaks AchievementFrame_SearchResults_TopTileStreaks +--- @field TopLeftCorner2 AchievementFrame_SearchResults_TopLeftCorner2 +--- @field TopRightCorner2 AchievementFrame_SearchResults_TopRightCorner2 +--- @field TopBorder2 AchievementFrame_SearchResults_TopBorder2 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1516) +--- child of AchievementFrame +--- @class AchievementFrame_PlaceholderName : FontString, AchievementCriteriaFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1519) +--- child of AchievementFrame +--- @class AchievementFrame_PlaceholderHiddenDescription : FontString, AchievementDescriptionFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1541) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderLeft : Texture +AchievementFrameMetalBorderLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1548) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderRight : Texture +AchievementFrameMetalBorderRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1555) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderBottom : Texture +AchievementFrameMetalBorderBottom = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1563) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderTop : Texture +AchievementFrameMetalBorderTop = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1571) +--- child of AchievementFrame +--- @class AchievementFrameCategoriesBG : Texture +AchievementFrameCategoriesBG = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1581) +--- child of AchievementFrame +--- @class AchievementFrameWaterMark : Texture +AchievementFrameWaterMark = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1587) +--- child of AchievementFrame +--- @class AchievementFrameGuildEmblemLeft : Texture +AchievementFrameGuildEmblemLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1594) +--- child of AchievementFrame +--- @class AchievementFrameGuildEmblemRight : Texture +AchievementFrameGuildEmblemRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1601) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderTopLeft : Texture +AchievementFrameMetalBorderTopLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1608) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderTopRight : Texture +AchievementFrameMetalBorderTopRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1615) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderBottomLeft : Texture +AchievementFrameMetalBorderBottomLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1622) +--- child of AchievementFrame +--- @class AchievementFrameMetalBorderBottomRight : Texture +AchievementFrameMetalBorderBottomRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1629) +--- child of AchievementFrame +--- @class AchievementFrameWoodBorderTopLeft : Texture +AchievementFrameWoodBorderTopLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1636) +--- child of AchievementFrame +--- @class AchievementFrameWoodBorderTopRight : Texture +AchievementFrameWoodBorderTopRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1643) +--- child of AchievementFrame +--- @class AchievementFrameWoodBorderBottomLeft : Texture +AchievementFrameWoodBorderBottomLeft = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1650) +--- child of AchievementFrame +--- @class AchievementFrameWoodBorderBottomRight : Texture +AchievementFrameWoodBorderBottomRight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AchievementUI/Mainline/Blizzard_AchievementUI.xml#L1505) +--- @class AchievementFrame : Frame, BackdropTemplate +--- @field backdropInfo any # BACKDROP_ACHIEVEMENTS_0_64 +--- @field Header AchievementFrame_Header +--- @field Categories AchievementFrameCategories +--- @field Tab1 AchievementFrameTab1 +--- @field Tab2 AchievementFrameTab2 +--- @field Tab3 AchievementFrameTab3 +--- @field FilterDropdown AchievementFrameFilterDropdown +--- @field SearchBox AchievementFrame_SearchBox +--- @field SearchPreviewContainer AchievementFrame_SearchPreviewContainer +--- @field searchProgressBar AchievementFrame_searchProgressBar +--- @field SearchResults AchievementFrame_SearchResults +--- @field PlaceholderName AchievementFrame_PlaceholderName +--- @field PlaceholderHiddenDescription AchievementFrame_PlaceholderHiddenDescription +--- @field Background Texture +--- @field BackgroundBlackCover Texture +AchievementFrame = {} +AchievementFrame["Categories"] = AchievementFrameCategories +AchievementFrame["Tab1"] = AchievementFrameTab1 +AchievementFrame["Tab2"] = AchievementFrameTab2 +AchievementFrame["Tab3"] = AchievementFrameTab3 +AchievementFrame["FilterDropdown"] = AchievementFrameFilterDropdown +AchievementFrame["backdropInfo"] = BACKDROP_ACHIEVEMENTS_0_64 + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Localization.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Localization.lua.annotated.lua new file mode 100644 index 0000000..78c58a9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AchievementUI/Mainline/Localization.lua.annotated.lua @@ -0,0 +1,105 @@ +function AchievementFrameSummary_LocalizeButton (button) + +end + +function AchievementButton_LocalizeMiniAchievement (frame) + +end + +function AchievementButton_LocalizeProgressBar (frame) + +end + +function AchievementButton_LocalizeMetaAchievement (frame) + +end + +function AchievementFrame_LocalizeCriteria (frame) + +end + +function AchievementCategoryButton_Localize(button) + +end + +function AchievementButton_Localize(button) + +end + +function AchievementComparisonButton_Localize(button) + +end + +local l10nTable = { + deDE = {}, + enGB = {}, + enUS = {}, + esES = {}, + esMX = {}, + frFR = {}, + itIT = {}, + koKR = {}, + ptBR = {}, + ptPT = {}, + ruRU = {}, + zhCN = {}, + zhTW = { + localize = function() + AchievementFrameSummary_LocalizeButton = function(button) + button.DateCompleted:SetWidth(150); + button.DateCompleted:SetPoint("TOPRIGHT", -63, -6); + button.Label:SetPoint("TOP", 0, -4); + button.Description:SetPoint("TOP", 0, -27); + button.Description:SetFontObject("AchievementFont_Small"); + button.Shield.Points:SetPoint("CENTER", -1, 4); + end + + AchievementButton_LocalizeMiniAchievement = function(frame) + frame.Points:SetFontObject("GameFontWhite"); + end + + AchievementButton_LocalizeProgressBar = function(frame) + frame.Text:SetPoint("TOP", 0, 1); + end + + AchievementButton_LocalizeMetaAchievement = function(frame) + frame.Label:SetFontObject("AchievementFont_Small"); + end + + AchievementFrame_LocalizeCriteria = function(frame) + frame.Name:SetFontObject("AchievementFont_Small"); + end + + AchievementButton_Localize = function(button) + button.DateCompleted:SetWidth(80); + button.DateCompleted:SetJustifyH("CENTER"); + button.Description:SetFontObject("AchievementFont_Small"); + button.HiddenDescription:SetFontObject("AchievementFont_Small"); + button.Shield:SetPoint("TOPRIGHT", -10, 0); + button.Tabard:SetPoint("TOPRIGHT", -7, -4); + end + + ACHIEVEMENTCOMPARISON_FRIENDSHIELDFONT1 = GameFontBlack; + ACHIEVEMENTCOMPARISON_FRIENDSHIELDFONT2 = GameFontBlack; + + AchievementComparisonButton_Localize = function(button) + button.Player.Label:SetPoint("TOP", 0, -4); + button.Player.Description:SetPoint("TOP", 0, -27); + button.Player.Description:SetFontObject("AchievementFont_Small"); + button.Friend.Status:SetFontObject("GameFontBlack"); + button.Friend.Status:SetPoint("BOTTOM", 20, 4); + button.Friend.Shield.Points:SetFontObject("GameFontBlack"); + end + + AchievementCategoryButton_Localize = function(button) + button.Label:SetPoint("TOPRIGHT", -8, -6); + button.Label:SetPoint("BOTTOMLEFT", 16, 2); + end + end, + + localizeFrames = function() + end, + }, +}; + +SetupLocalization(l10nTable); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Blizzard_ActionBar_Mainline.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Blizzard_ActionBar_Mainline.toc new file mode 100644 index 0000000..737cf6e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Blizzard_ActionBar_Mainline.toc @@ -0,0 +1,60 @@ +## Title: Blizzard_ActionBar +## Author: Blizzard Entertainment +## DefaultState: enabled +## Dependencies: Blizzard_StoreUI, Blizzard_QuickKeybind, Blizzard_UIParent, Blizzard_EditMode, Blizzard_UIPanels_Game, Blizzard_TextStatusBar, Blizzard_Flyout, Blizzard_Colors, Blizzard_HelpPlate, Blizzard_MicroMenu +## AllowLoad: Game +Shared\ActionButtonUtil.lua +Mainline\ActionButtonUtilOverrides.lua +Shared\ActionButtonSpellAlerts.lua +Shared\ActionButtonSpellAlerts.xml +Mainline\AssistedCombatManager.lua +Shared\StatusTrackingBar.lua +Mainline\StatusTrackingBarTemplate.xml +Shared\ExpBar.lua +Mainline\ExpBarOverrides.lua +Mainline\ExpBar.xml +Shared\ReputationBar.lua +Mainline\ReputationBarOverrides.lua +Shared\ReputationBar.xml +Mainline\AzeriteBar.lua +Mainline\AzeriteBar.xml +Mainline\ArtifactBar.lua +Mainline\ArtifactBar.xml +Mainline\HonorBar.lua +Mainline\HonorBar.xml +Mainline\HouseFavorBar.lua +Mainline\HouseFavorBar.xml +Shared\ActionButton.lua +Mainline\ActionButtonOverrides.lua [AllowLoadGameType mainline] +WoWLabs\ActionButtonOverrides.lua [AllowLoadGameType plunderstorm] +Shared\ActionButtonComponentTemplate.xml +Mainline\ActionButtonTemplate.xml +Shared\ActionBar.lua +Shared\ActionBarTemplate.xml +Shared\MultiActionBars.lua +Shared\MultiActionBars.xml +Shared\MainActionBar.lua +Mainline\MainActionBarOverrides.lua +Mainline\MainActionBar.xml +Shared\VehicleLeaveButton.lua +Shared\VehicleLeaveButton.xml +Shared\StatusTrackingManager.lua +Mainline\StatusTrackingManagerOverrides.lua +Mainline\StatusTrackingBar.xml +Shared\StanceBar.lua +Mainline\StanceBar.xml +Shared\ExtraActionBar.lua +Shared\ExtraActionBar.xml +Shared\PossessActionBar.lua +Mainline\PossessActionBar.xml +WoWLabs\CustomActionBarOverlays.lua [AllowLoadGameType plunderstorm] +WoWLabs\CustomActionBarOverlays.xml [AllowLoadGameType plunderstorm] +Shared\PetActionBar.lua +Mainline\PetActionBar.xml +Shared\MultiCastActionBarFrame.lua +Shared\MultiCastActionBarFrame.xml +Shared\SpellFlyout.lua +Shared\SpellFlyout.xml +WoWLabs\KeybindReminder.lua [AllowLoadGameType plunderstorm] +WoWLabs\KeybindReminder.xml [AllowLoadGameType plunderstorm] +Shared\Localization.lua diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonOverrides.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonOverrides.lua.annotated.lua new file mode 100644 index 0000000..1e0432d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonOverrides.lua.annotated.lua @@ -0,0 +1,30 @@ + +function BaseActionButtonMixin:UpdateButtonArt() + if (not self.SlotArt or not self.SlotBackground) then + return; + end + + if (self.bar and not self.bar.hideBarArt) then + self.SlotArt:Show(); + self.SlotBackground:Hide(); + + self:SetNormalAtlas("UI-HUD-ActionBar-IconFrame"); + self.NormalTexture:SetDrawLayer("OVERLAY"); + self.NormalTexture:SetSize(46, 45); + + self:SetPushedAtlas("UI-HUD-ActionBar-IconFrame-Down"); + self.PushedTexture:SetDrawLayer("OVERLAY"); + self.PushedTexture:SetSize(46, 45); + else + self.SlotArt:Hide(); + self.SlotBackground:Show(); + + self:SetNormalAtlas("UI-HUD-ActionBar-IconFrame-AddRow"); + self.NormalTexture:SetDrawLayer("OVERLAY"); + self.NormalTexture:SetSize(51, 51); + + self:SetPushedAtlas("UI-HUD-ActionBar-IconFrame-AddRow-Down"); + self.PushedTexture:SetDrawLayer("OVERLAY"); + self.PushedTexture:SetSize(51, 51); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml new file mode 100644 index 0000000..c0e379e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml @@ -0,0 +1,209 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml.annotated.lua new file mode 100644 index 0000000..4e60f5c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml.annotated.lua @@ -0,0 +1,92 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L85) +--- child of ActionButtonTemplate_TextOverlayContainer +--- @class ActionButtonTemplate_TextOverlayContainer_HotKey : FontString, NumberFontNormalSmallGray + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L92) +--- child of ActionButtonTemplate_TextOverlayContainer +--- @class ActionButtonTemplate_TextOverlayContainer_Count : FontString, NumberFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L82) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_TextOverlayContainer : Frame, ActionButtonTextOverlayContainerMixin +--- @field HotKey ActionButtonTemplate_TextOverlayContainer_HotKey +--- @field Count ActionButtonTemplate_TextOverlayContainer_Count + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L104) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_AutoCastOverlay : Frame, AutoCastOverlayTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L111) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_Cooldown : Cooldown, CooldownFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L120) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_lossOfControlCooldown : Cooldown, CooldownFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L130) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_chargeCooldown : Cooldown, CooldownFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L43) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_Name : FontString, GameFontHighlightSmallOutline + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L75) +--- child of ActionButtonTemplate +--- @class ActionButtonTemplate_SpellHighlightAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L4) +--- Template +--- @class ActionButtonTemplate : CheckButton, ActionButtonSpellFXTemplate, FlyoutButtonTemplate, BaseActionButtonMixin +--- @field enableSpellFX boolean # true +--- @field enableLOCCooldown boolean # true +--- @field popupDirection string # UP +--- @field popupOffset number # -4 +--- @field popupCrossAxisSize number # 47 +--- @field openArrowOffset number # 2 +--- @field closedArrowOffset number # 4 +--- @field arrowMainAxisSize number # 18 +--- @field arrowCrossAxisSize number # 7 +--- @field hotkeyTextKeyboardX number # -4 +--- @field hotkeyTextKeyboardY number # -5 +--- @field hotkeyTextGamepadX number # 0 +--- @field hotkeyTextGamepadY number # 0 +--- @field TextOverlayContainer ActionButtonTemplate_TextOverlayContainer +--- @field AutoCastOverlay ActionButtonTemplate_AutoCastOverlay +--- @field cooldown ActionButtonTemplate_Cooldown +--- @field lossOfControlCooldown ActionButtonTemplate_lossOfControlCooldown +--- @field chargeCooldown ActionButtonTemplate_chargeCooldown +--- @field icon Texture +--- @field IconMask MaskTexture +--- @field SlotBackground Texture +--- @field SlotArt Texture +--- @field Flash Texture +--- @field Name ActionButtonTemplate_Name +--- @field Border Texture +--- @field NewActionTexture Texture +--- @field SpellHighlightTexture Texture +--- @field LevelLinkLockIcon Texture +--- @field SpellHighlightAnim ActionButtonTemplate_SpellHighlightAnim +--- @field NormalTexture Texture +--- @field HighlightTexture Texture +--- @field PushedTexture Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L172) +--- Explicitly protected +--- Template +--- @class ActionBarButtonCodeTemplate : CheckButton, SecureActionButtonTemplate, QuickKeybindButtonTemplate, ActionButtonSpellFXTemplate, ActionBarActionButtonDerivedMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L189) +--- Explicitly protected +--- Template +--- @class ActionBarButtonTemplate : CheckButton, ActionButtonTemplate, ActionBarButtonCodeTemplate, ActionBarButtonMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ActionButtonTemplate.xml#L198) +--- Template +--- @class SmallActionButtonTemplate : CheckButton, ActionButtonTemplate, SmallActionButtonMixin +--- @field hotkeyX number # -3 +--- @field hotkeyY number # -4 + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonUtilOverrides.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonUtilOverrides.lua.annotated.lua new file mode 100644 index 0000000..da5183c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ActionButtonUtilOverrides.lua.annotated.lua @@ -0,0 +1,41 @@ + +local MicroButtonNames = { + "CharacterMicroButton", + "ProfessionMicroButton", + "PlayerSpellsMicroButton", + "AchievementMicroButton", + "QuestLogMicroButton", + "GuildMicroButton", + "LFDMicroButton", + "CollectionsMicroButton", + "EJMicroButton", + "MainMenuMicroButton", + "QuickJoinToastButton", +} + +function ActionButtonUtil.SetAllQuickKeybindButtonHighlights(show) + for _, actionBar in ipairs(ActionButtonUtil.ActionBarButtonNames) do + for i = 1, NUM_ACTIONBAR_BUTTONS do + _G[actionBar..i]:DoModeChange(show); + end + end + for i = 1, NUM_SPECIAL_BUTTONS do + PetActionBar.actionButtons[i]:DoModeChange(show); + StanceBar.actionButtons[i]:DoModeChange(show); + end + ExtraActionButton1:DoModeChange(show); + MainActionBar.ActionBarPageNumber.UpButton:DoModeChange(show); + MainActionBar.ActionBarPageNumber.DownButton:DoModeChange(show); + + for _, bagButton in MainMenuBarBagManager:EnumerateBagButtons() do + bagButton:DoModeChange(show); + end + + for _, microButton in ipairs(MicroButtonNames) do + _G[microButton]:DoModeChange(show); + end + + if HUDInventoryUtil then + HUDInventoryUtil.DoQuickKeybindModeChange(show); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.lua.annotated.lua new file mode 100644 index 0000000..7f964a3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.lua.annotated.lua @@ -0,0 +1,131 @@ +local barAtlas = "UI-HUD-ExperienceBar-Fill-ArtifactPower"; +local gainFlareAtlas = "UI-HUD-ExperienceBar-Flare-ArtifactPower-2x-Flipbook"; +local levelUpAtlas = "UI-HUD-ExperienceBar-Fill-ArtifactPower-2x-Flipbook"; + +ArtifactBarMixin = {};--- @class ArtifactBarMixin + +function ArtifactBarMixin:IsArtifactMaxed() + return HasArtifactEquipped() and C_ArtifactUI.IsEquippedArtifactMaxed(); +end + +function ArtifactBarMixin:Update() + local artifactItemID = C_ArtifactUI.GetEquippedArtifactItemID(); + if artifactItemID then + local item = Item:CreateFromItemID(artifactItemID); + item:ContinueOnItemLoad(function() + local artifactItemID, _, _, _, artifactTotalXP, artifactPointsSpent, _, _, _, _, _, _, artifactTier = C_ArtifactUI.GetEquippedArtifactInfo(); + local numPointsAvailableToSpend, xp, xpForNextPoint = ArtifactBarGetNumArtifactTraitsPurchasableFromXP(artifactPointsSpent, artifactTotalXP, artifactTier); + + self:SetBarValues(xp, 0, xpForNextPoint, numPointsAvailableToSpend + artifactPointsSpent); + + self.StatusBar.artifactItemID = artifactItemID; + self.xp = xp; + self.totalXP = artifactTotalXP; + self.xpForNextPoint = xpForNextPoint; + self.numPointsAvailableToSpend = numPointsAvailableToSpend; + self:Show(); + self.Tick:SetShown(numPointsAvailableToSpend > 0); + self.StatusBar.Underlay:SetShown(numPointsAvailableToSpend > 0); + self.StatusBar.Overlay:Show(); + self.StatusBar.Overlay:SetAlpha(numPointsAvailableToSpend > 0 and .35 or .25); + self:UpdateTick(); + end); + end +end + +function ArtifactBarMixin:UpdateOverlayFrameText() + if ( self.OverlayFrame.Text:IsShown() ) then + local xp = self.StatusBar:GetAnimatedValue(); + local _, xpForNextPoint = self.StatusBar:GetMinMaxValues(); + if ( xpForNextPoint > 0 ) then + self.OverlayFrame.Text:SetFormattedText(ARTIFACT_POWER_BAR, BreakUpLargeNumbers(xp), BreakUpLargeNumbers(xpForNextPoint)); + end + end +end + +function ArtifactBarMixin:AnimatedValueChangedCallback() + self:UpdateOverlayFrameText(); + self:UpdateTick(); +end + +function ArtifactBarMixin:OnLoad() + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("UNIT_INVENTORY_CHANGED"); + self:RegisterEvent("ARTIFACT_XP_UPDATE"); + self:RegisterEvent("UPDATE_EXTRA_ACTIONBAR"); + self:RegisterEvent("CVAR_UPDATE"); + + self.StatusBar:SetBarTexture(barAtlas); + self.StatusBar:SetAnimationTextures(gainFlareAtlas, levelUpAtlas); + self.StatusBar:SetOnAnimatedValueChangedCallback(self:AnimatedValueChangedCallback()); + self.StatusBar:SetIsMaxLevelFunctionOverride(function() return self:IsArtifactMaxed(); end); +end + +function ArtifactBarMixin:OnEvent(event, ...) + if( self:IsVisible() ) then + if ( event == "ARTIFACT_XP_UPDATE" or event == "UNIT_INVENTORY_CHANGED" or event == "PLAYER_ENTERING_WORLD" or event == "UPDATE_EXTRA_ACTIONBAR") then + self:Update(); + elseif ( event == "CVAR_UPDATE" ) then + local name, value = ...; + if ( name == "xpBarText" ) then + self:UpdateTextVisibility(); + end + end + end +end + +function ArtifactBarMixin:OnShow() + self:UpdateTextVisibility(); +end + +function ArtifactBarMixin:OnEnter() + self:ShowText(); + self:UpdateOverlayFrameText(); + self.Tick:OnEnter(); +end + +function ArtifactBarMixin:OnLeave() + self:HideText(); + self.Tick:OnLeave(); +end + +function ArtifactBarMixin:UpdateTick() + self.Tick:UpdateTick(); +end + +function ArtifactBarGetNumArtifactTraitsPurchasableFromXP(pointsSpent, artifactXP, artifactTier) + local numPoints = 0; + local xpForNextPoint = C_ArtifactUI.GetCostForPointAtRank(pointsSpent, artifactTier); + while artifactXP >= xpForNextPoint and xpForNextPoint > 0 do + artifactXP = artifactXP - xpForNextPoint; + + pointsSpent = pointsSpent + 1; + numPoints = numPoints + 1; + + xpForNextPoint = C_ArtifactUI.GetCostForPointAtRank(pointsSpent, artifactTier); + end + return numPoints, artifactXP, xpForNextPoint; +end + +ArtifactTickMixin = { }--- @class ArtifactTickMixin +function ArtifactTickMixin:UpdateTick() + if ( self:IsShown() ) then + local xp = self:GetParent().xp; + local xpForNextPoint = self:GetParent().xpForNextPoint; + if ( xpForNextPoint > 0 ) then + self:SetPoint("CENTER", self:GetParent(), "LEFT", (xp / xpForNextPoint) * self:GetParent():GetWidth(), 0); + end + end +end + +function ArtifactTickMixin:OnEnter() + local arfifactTickParent = self:GetParent(); + GameTooltip_SetDefaultAnchor(GameTooltip, UIParent); + GameTooltip:SetText(ARTIFACT_POWER_TOOLTIP_TITLE:format(BreakUpLargeNumbers(arfifactTickParent.totalXP, true), BreakUpLargeNumbers(arfifactTickParent.xp, true), BreakUpLargeNumbers(arfifactTickParent.xpForNextPoint, true)), HIGHLIGHT_FONT_COLOR:GetRGB()); + GameTooltip:AddLine(ARTIFACT_POWER_TOOLTIP_BODY:format(arfifactTickParent.numPointsAvailableToSpend), nil, nil, nil, true); + GameTooltip:Show(); +end + +function ArtifactTickMixin:OnLeave() + GameTooltip_Hide(); +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml new file mode 100644 index 0000000..78b8c73 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml.annotated.lua new file mode 100644 index 0000000..ab748cb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml.annotated.lua @@ -0,0 +1,14 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml#L9) +--- child of ArtifactStatusBarTemplate +--- @class ArtifactStatusBarTemplate_Tick : Button, ArtifactTickMixin +--- @field Normal Texture +--- @field Highlight Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ArtifactBar.xml#L3) +--- Template +--- @class ArtifactStatusBarTemplate : Frame, StatusTrackingBarTemplate, ArtifactBarMixin +--- @field fadeOutEntireBarAtMaxLevel boolean # true +--- @field Tick ArtifactStatusBarTemplate_Tick + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AssistedCombatManager.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AssistedCombatManager.lua.annotated.lua new file mode 100644 index 0000000..6f9a234 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AssistedCombatManager.lua.annotated.lua @@ -0,0 +1,364 @@ +-- alternative name: OnePunchManager + +AssistedCombatManager = { + rotationSpells = { }; +}; + +function AssistedCombatManager:Init() + self.init = true; + + CVarCallbackRegistry:RegisterCallback("assistedCombatIconUpdateRate", AssistedCombatManager.ProcessCVars, AssistedCombatManager); + CVarCallbackRegistry:RegisterCallback("assistedCombatHighlight", AssistedCombatManager.ProcessCVars, AssistedCombatManager); + + AssistedCombatManager:ProcessCVars(); +end + +function AssistedCombatManager:OnSpellsChanged() + -- mark existing spells unused with 0 + local hasChanges = false; + for k in pairs(self.rotationSpells) do + self.rotationSpells[k] = 0; + end + -- mark current spells with 1 + local rotationSpells = C_AssistedCombat.GetRotationSpells(); + for i, spellID in ipairs(rotationSpells) do + if not hasChanges and not self.rotationSpells[spellID] then + hasChanges = true; + end + self.rotationSpells[spellID] = 1; + end + -- remove unused spells + for k, v in pairs(self.rotationSpells) do + if v == 0 then + hasChanges = true; + self.rotationSpells[k] = nil; + end + end + + local actionSpellID = C_AssistedCombat.GetActionSpell(); + self:SetActionSpell(actionSpellID); + + local hadShapeshiftForms = self.hasShapeshiftForms; + self.hasShapeshiftForms = GetNumShapeshiftForms() > 0; + + if not hasChanges and self.hasShapeshiftForms == hadShapeshiftForms then + return; + end + + -- OnSpellsChanged will fire after VARIABLES_LOADED and PLAYER_ENTERING_WORLD + if not self.init then + self:Init(); + elseif self:IsAssistedHighlightActive() then + self:UpdateAssistedHighlightCandidateActionButtonsList() + end + + -- Because SPELLS_CHANGED fires at the end of frame, systems responding to synchronous events + -- would get the wrong info if they rely on AssistedCombatManager:IsRotationSpell or anything that calls it. + EventRegistry:TriggerEvent("AssistedCombatManager.RotationSpellsUpdated"); +end + +function AssistedCombatManager:SetActionSpell(actionSpellID) + if self.actionSpellID == actionSpellID then + return; + end + + self.spellDescription = nil; + + if self.spellDataLoadedCancelCallback then + self.spellDataLoadedCancelCallback(); + self.spellDataLoadedCancelCallback = nil; + end + + if actionSpellID then + -- store the spell description now so there are no sparse headaches later + local spell = Spell:CreateFromSpellID(actionSpellID); + self.spellDataLoadedCancelCallback = spell:ContinueWithCancelOnSpellLoad(function() + self.spellDescription = spell:GetSpellDescription(actionSpellID); + self.spellDataLoadedCancelCallback = nil; + end); + end + + self.actionSpellID = actionSpellID; + EventRegistry:TriggerEvent("AssistedCombatManager.OnSetActionSpell", actionSpellID); +end + +function AssistedCombatManager:HasActionSpell() + return not not self.actionSpellID; +end + +function AssistedCombatManager:GetActionSpellID() + return self.actionSpellID; +end + +function AssistedCombatManager:GetActionSpellDescription() + return self.spellDescription; +end + +function AssistedCombatManager:IsRotationSpell(spellID) + return not not self.rotationSpells[spellID]; +end + +function AssistedCombatManager:SetCanHighlightSpellbookSpells(on) + self.canHighlightSpellbookSpells = on; + EventRegistry:TriggerEvent("AssistedCombatManager.OnSetCanHighlightSpellbookSpells"); +end + +function AssistedCombatManager:ShouldHighlightSpellbookSpell(spellID) + if not self.canHighlightSpellbookSpells and not self:IsAssistedHighlightActive() then + return false; + end + + return self:IsHighlightableSpellbookSpell(spellID); +end + +function AssistedCombatManager:IsHighlightableSpellbookSpell(spellID) + if not self:IsRotationSpell(spellID) then + return false; + end + + if self:IsAssistedHighlightActive() then + return true; + else + if not self:HasActionSpell() then + return false; + end + + return C_ActionBar.HasAssistedCombatActionButtons(); + end +end + +function AssistedCombatManager:IsAssistedHighlightActive() + return not not self.useAssistedHighlight; +end + +function AssistedCombatManager:ShouldDowngradeSpellAlertForButton(actionButton) + if not actionButton.action then + return false; + end + + local usingAssistedCombat = self:IsAssistedHighlightActive() or C_ActionBar.HasAssistedCombatActionButtons(); + if not usingAssistedCombat then + return false; + end + + -- Only spells that are part of the rotation should have downgrade spell alerts + local type, id, subType = GetActionInfo(actionButton.action); + if type == "spell" or (type == "macro" and subType == "spell") then + return self:IsRotationSpell(id); + end + + return false; +end + +function AssistedCombatManager:IsRecommendedAssistedHighlightButton(actionButton) + if not self:IsAssistedHighlightActive() then + return false; + end + if not actionButton.AssistedCombatHighlightFrame then + return false; + end + return actionButton.AssistedCombatHighlightFrame:IsShown(); +end + +function AssistedCombatManager:ProcessCVars() + local updateRate = tonumber(GetCVar("assistedCombatIconUpdateRate")); + self.updateRate = Clamp(updateRate, 0, 1); + + local wasUsingAssistedHighlight = self.useAssistedHighlight or false; + self.useAssistedHighlight = GetCVarBool("assistedCombatHighlight"); + + self:UpdateAssistedHighlightState(wasUsingAssistedHighlight); +end + +function AssistedCombatManager:GetUpdateRate() + return self.updateRate or 0; +end + +function AssistedCombatManager:OnPlayerRegenChanged() + self.affectingCombat = UnitAffectingCombat("player"); + self:ForceUpdateAtEndOfFrame(); +end + +-- This will be called when a conditional macro changes which spell will be cast, +-- or when an action changes, like dragging a spell on/off or swapping the main action bar. +function AssistedCombatManager:OnActionButtonActionChanged(actionButton) + local spellID = self:GetActionButtonSpellForAssistedHighlight(actionButton); + self.assistedHighlightCandidateActionButtons[actionButton] = spellID; + self:SetAssistedHighlightFrameShown(actionButton, self.lastNextCastSpellID and spellID == self.lastNextCastSpellID); + + if self.hasShapeshiftForms then + self:ForceUpdateAtEndOfFrame(); + end +end + +-- Will return a spellID for an actionButton that holds a rotation spell (ignoring AssistedRotation button) +-- or any macro (since a macro can contain multiple spells or include non-spells), nil otherwise +function AssistedCombatManager:GetActionButtonSpellForAssistedHighlight(actionButton) + if actionButton.action then + local type, id, subType = GetActionInfo(actionButton.action); + if type == "macro" then + if subType == "spell" then + return id; + else + -- This macro doesn't display a spell right now, but it could contain one. + -- 0 won't match a spell but will keep this button as a candidate. + return 0; + end + elseif type == "spell" and subType ~= "assistedcombat" then + if self:IsRotationSpell(id) then + return id; + end + end + end + return nil; +end + +function AssistedCombatManager:SetAssistedHighlightFrameShown(actionButton, shown) + local highlightFrame = actionButton.AssistedCombatHighlightFrame; + if shown then + if not highlightFrame then + highlightFrame = CreateFrame("FRAME", nil, actionButton, "ActionBarButtonAssistedCombatHighlightTemplate"); + actionButton.AssistedCombatHighlightFrame = highlightFrame; + highlightFrame:SetPoint("CENTER"); + highlightFrame:SetFrameLevel(MainActionBar:GetEndCapsFrameLevel() - 1); + -- have to do this to get a single frame of the flipbook instead of the whole texture + highlightFrame.Flipbook.Anim:Play(); + highlightFrame.Flipbook.Anim:Stop(); + -- stance buttons are smaller + if not actionButton.action then + highlightFrame.Flipbook:SetSize(48, 48); + end + end + highlightFrame:Show(); + if self.affectingCombat then + highlightFrame.Flipbook.Anim:Play(); + else + highlightFrame.Flipbook.Anim:Stop(); + end + elseif highlightFrame then + highlightFrame:Hide(); + end +end + +function AssistedCombatManager:UpdateAllAssistedHighlightFramesForSpell(spellID) + if self.assistedHighlightCandidateActionButtons then + local hasHighlightedActionButton = false; + for actionButton, actionSpellID in pairs(self.assistedHighlightCandidateActionButtons) do + local show = actionSpellID == spellID; + hasHighlightedActionButton = hasHighlightedActionButton or show; + self:SetAssistedHighlightFrameShown(actionButton, show); + end + -- don't highlight anything on the stance bar if there's already a highlight on a normal action button + for i = 1, StanceBar.numForms or 0 do + local actionButton = StanceBar.actionButtons[i]; + local show = not hasHighlightedActionButton and spellID and actionButton.spellID == spellID; + self:SetAssistedHighlightFrameShown(actionButton, show); + end + end +end + +function AssistedCombatManager:BuildAssistedHighlightCandidateActionButtonsList() + self.assistedHighlightCandidateActionButtons = { }; + ActionBarButtonEventsFrame:ForEachFrame(function(actionButton) + local spellID = self:GetActionButtonSpellForAssistedHighlight(actionButton); + if spellID then + self.assistedHighlightCandidateActionButtons[actionButton] = spellID; + end + end); +end + +function AssistedCombatManager:UpdateAssistedHighlightCandidateActionButtonsList() + if self.assistedHighlightCandidateActionButtons then + for actionButton in pairs(self.assistedHighlightCandidateActionButtons) do + local spellID = self:GetActionButtonSpellForAssistedHighlight(actionButton); + self.assistedHighlightCandidateActionButtons[actionButton] = spellID; + end + end +end + +function AssistedCombatManager:UpdateAssistedHighlightState(wasActive) + local isActive = self:IsAssistedHighlightActive(); + if isActive then + if not self.updateFrame then + self.updateFrame = CreateFrame("FRAME"); + end + if not wasActive then + self:BuildAssistedHighlightCandidateActionButtonsList(); + + self.lastNextCastSpellID = nil; + self.updateTimeLeft = 0; + self.updateFrame:SetScript("OnUpdate", function(_frame, elapsed) self:OnUpdate(elapsed); end); + + EventRegistry:RegisterCallback("ActionButton.OnActionChanged", self.OnActionButtonActionChanged, self); + EventRegistry:RegisterFrameEventAndCallback("PLAYER_REGEN_ENABLED", self.OnPlayerRegenChanged, self); + EventRegistry:RegisterFrameEventAndCallback("PLAYER_REGEN_DISABLED", self.OnPlayerRegenChanged, self); + end + elseif wasActive then + local spellID = nil; -- hide all + self:UpdateAllAssistedHighlightFramesForSpell(spellID); + -- this must be after UpdateAllAssistedHighlightFramesForSpell + self.assistedHighlightCandidateActionButtons = nil; + + self.lastNextCastSpellID = nil; + self.updateFrame:SetScript("OnUpdate", nil); + + EventRegistry:UnregisterCallback("ActionButton.OnActionChanged", self); + EventRegistry:UnregisterFrameEventAndCallback("PLAYER_REGEN_ENABLED", self); + EventRegistry:UnregisterFrameEventAndCallback("PLAYER_REGEN_DISABLED", self); + end + + if isActive ~= wasActive then + EventRegistry:TriggerEvent("AssistedCombatManager.OnSetUseAssistedHighlight", isActive); + end +end + +function AssistedCombatManager:ForceUpdateAtEndOfFrame() + self.updateTimeLeft = 0; + self.lastNextCastSpellID = nil; +end + +function AssistedCombatManager:OnUpdate(elapsed) + self.updateTimeLeft = self.updateTimeLeft - elapsed; + if self.updateTimeLeft <= 0 then + self.updateTimeLeft = self:GetUpdateRate(); + + local checkForVisibleButton = true; + local spellID = C_AssistedCombat.GetNextCastSpell(checkForVisibleButton); + + if spellID ~= self.lastNextCastSpellID then + self.lastNextCastSpellID = spellID; + self:UpdateAllAssistedHighlightFramesForSpell(spellID); + EventRegistry:TriggerEvent("AssistedCombatManager.OnAssistedHighlightSpellChange"); + end + end +end + +function AssistedCombatManager:AddSpellTooltipLine(tooltip, spellID, overriddenSpellID) + local usingRotation = C_ActionBar.HasAssistedCombatActionButtons(); + local usingHighlight = self:IsAssistedHighlightActive(); + if not usingRotation and not usingHighlight then + return false; + end + + local addLine = self:IsRotationSpell(spellID) or self:IsRotationSpell(overriddenSpellID); + -- if still no, check if the overriddenSpellID is itself overriden + if not addLine and overriddenSpellID then + local overrideSpellID = C_Spell.GetOverrideSpell(overriddenSpellID); + addLine = self:IsRotationSpell(overrideSpellID); + end + + if addLine then + local text = ASSISTED_COMBAT_SPELL_INCLUDED; + if not usingRotation then + text = ASSISTED_COMBAT_HIGHLIGHT_SPELL_INCLUDED; + elseif not usingHighlight then + text = ASSISTED_COMBAT_ROTATION_SPELL_INCLUDED; + end + GameTooltip_AddColoredLine(tooltip, text, LIGHTBLUE_FONT_COLOR); + return true; + end + + return false; +end + +EventRegistry:RegisterFrameEventAndCallback("SPELLS_CHANGED", AssistedCombatManager.OnSpellsChanged, AssistedCombatManager); diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.lua.annotated.lua new file mode 100644 index 0000000..c0e3296 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.lua.annotated.lua @@ -0,0 +1,137 @@ +local AZERITE_XP_BAR_EVENTS = { + "PLAYER_ENTERING_WORLD", + "AZERITE_ITEM_EXPERIENCE_CHANGED", + "CVAR_UPDATE", + "BAG_UPDATE", +}; + +local barAtlas = "UI-HUD-ExperienceBar-Fill-ArtifactPower"; +local gainFlareAtlas = "UI-HUD-ExperienceBar-Flare-ArtifactPower-2x-Flipbook"; +local levelUpAtlas = "UI-HUD-ExperienceBar-Fill-ArtifactPower-2x-Flipbook"; + +AzeriteBarMixin = {};--- @class AzeriteBarMixin + +function AzeriteBarMixin:GetLevel() + local azeriteItem = C_AzeriteItem.FindActiveAzeriteItem(); + if not azeriteItem then + return nil; + end + + if C_AzeriteItem.IsUnlimitedLevelingUnlocked() then + return C_AzeriteItem.GetUnlimitedPowerLevel(azeriteItem); + end + + return C_AzeriteItem.GetPowerLevel(azeriteItem); +end + +function AzeriteBarMixin:Update() + local azeriteItemLocation = C_AzeriteItem.FindActiveAzeriteItem(); + local xp, totalLevelXp; + if not azeriteItemLocation or AzeriteUtil.IsAzeriteItemLocationBankTab(azeriteItemLocation) then + xp, totalLevelXp = 0, 1; + self.level = -1; + else + xp, totalLevelXp = C_AzeriteItem.GetAzeriteItemXPInfo(azeriteItemLocation); + self.level = self:GetLevel(); + end + self.xpToNextLevel = totalLevelXp - xp; + + self:SetBarValues(xp, 0, totalLevelXp, self.level); + self:UpdatePointsTooltip(); +end + +function AzeriteBarMixin:UpdateOverlayFrameText() + if ( self.OverlayFrame.Text:IsShown() ) then + local xp = self.StatusBar:GetAnimatedValue(); + local _, totalLevelXP = self.StatusBar:GetMinMaxValues(); + self.OverlayFrame.Text:SetFormattedText(AZERITE_POWER_BAR, FormatPercentage(xp / totalLevelXP, true)); + end +end + +function AzeriteBarMixin:AnimatedValueChangedCallback() + self:UpdateOverlayFrameText(); + self:UpdatePointsTooltip(); +end + +function AzeriteBarMixin:OnLoad() + self.StatusBar:SetBarTexture(barAtlas); + self.StatusBar:SetAnimationTextures(gainFlareAtlas, levelUpAtlas); + self.StatusBar:SetOnAnimatedValueChangedCallback(function() self:AnimatedValueChangedCallback(); end) + self.StatusBar:SetIsMaxLevelFunctionOverride(function() return C_AzeriteItem.IsAzeriteItemAtMaxLevel(); end); +end + +function AzeriteBarMixin:OnEvent(event, ...) + if ( self:IsVisible() ) then + if ( event == "PLAYER_ENTERING_WORLD" or event == "AZERITE_ITEM_EXPERIENCE_CHANGED") then + self:Update(); + elseif ( event == "CVAR_UPDATE" ) then + local name, value = ...; + if ( name == "xpBarText" ) then + self:UpdateTextVisibility(); + end + elseif ( event == "BAG_UPDATE" ) then + local bagID = ...; + if bagID > NUM_TOTAL_EQUIPPED_BAG_SLOTS then + self:Update(); + end + end + end +end + +function AzeriteBarMixin:OnShow() + FrameUtil.RegisterFrameForEvents(self, AZERITE_XP_BAR_EVENTS); + self:UpdateTextVisibility(); +end + +function AzeriteBarMixin:OnHide() + FrameUtil.UnregisterFrameForEvents(self, AZERITE_XP_BAR_EVENTS); +end + +function AzeriteBarMixin:OnEnter() + self:ShowText(); + self:UpdateOverlayFrameText(); + + local azeriteItemLocation = C_AzeriteItem.FindActiveAzeriteItem(); + if AzeriteUtil.IsAzeriteItemLocationBankTab(azeriteItemLocation) then + GameTooltip_SetDefaultAnchor(GameTooltip, UIParent); + GameTooltip:SetText(HEART_OF_AZEROTH_MISSING_ERROR, HIGHLIGHT_FONT_COLOR:GetRGB()); + else + self:SetupPointsTooltip(); + end +end + +function AzeriteBarMixin:OnLeave() + self:HideText(); + GameTooltip_Hide(); + + local azeriteItemLocation = C_AzeriteItem.FindActiveAzeriteItem(); + if AzeriteUtil.IsAzeriteItemLocationBankTab(azeriteItemLocation) then + self:CancelItemLoadCallback(); + end +end + +function AzeriteBarMixin:CancelItemLoadCallback() + if self.itemDataLoadedCancelFunc then + self.itemDataLoadedCancelFunc(); + self.itemDataLoadedCancelFunc = nil; + end +end + +function AzeriteBarMixin:SetupPointsTooltip() + local azeriteItemLocation = C_AzeriteItem.FindActiveAzeriteItem(); + local azeriteItem = Item:CreateFromItemLocation(azeriteItemLocation); + + self.itemDataLoadedCancelFunc = azeriteItem:ContinueWithCancelOnItemLoad(function() + local azeriteItemName = azeriteItem:GetItemName(); + GameTooltip_SetDefaultAnchor(GameTooltip, UIParent); + GameTooltip:SetText(AZERITE_POWER_TOOLTIP_TITLE:format(self.level, self.xpToNextLevel), HIGHLIGHT_FONT_COLOR:GetRGB()); + GameTooltip:AddLine(AZERITE_POWER_TOOLTIP_BODY:format(azeriteItemName)); + GameTooltip:Show(); + end); +end + +function AzeriteBarMixin:UpdatePointsTooltip() + if ( GameTooltip:IsOwned(self) ) then + self:SetupPointsTooltip(); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml new file mode 100644 index 0000000..d4606d1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml.annotated.lua new file mode 100644 index 0000000..ba38f75 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml.annotated.lua @@ -0,0 +1,7 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/AzeriteBar.xml#L3) +--- Template +--- @class AzeriteBarTemplate : Frame, StatusTrackingBarTemplate, AzeriteBarMixin +--- @field fadeOutEntireBarAtMaxLevel boolean # true + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml new file mode 100644 index 0000000..72ca364 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml.annotated.lua new file mode 100644 index 0000000..d204237 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml.annotated.lua @@ -0,0 +1,18 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml#L20) +--- child of ExpStatusBarTemplate +--- @class ExpStatusBarTemplate_ExhaustionTick : Button, ExhaustionTickMixin +--- @field hideAtBarEdge boolean # true +--- @field yOffset number # 2 +--- @field Normal Texture +--- @field Highlight Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/ExpBar.xml#L3) +--- Template +--- @class ExpStatusBarTemplate : Frame, StatusTrackingBarTemplate, ExpBarMixin +--- @field fadeOutEntireBarAtMaxLevel boolean # true +--- @field isExpBar boolean # true +--- @field ExhaustionTick ExpStatusBarTemplate_ExhaustionTick +--- @field ExhaustionLevelFillBar Texture + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBarOverrides.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBarOverrides.lua.annotated.lua new file mode 100644 index 0000000..57a0e0e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ExpBarOverrides.lua.annotated.lua @@ -0,0 +1,55 @@ + +local unrestedBarAtlas = "UI-HUD-ExperienceBar-Fill-Experience"; +local unrestedGainFlareAtlas = "UI-HUD-ExperienceBar-Flare-XP-2x-Flipbook"; +local unrestedLevelUpAtlas = "UI-HUD-ExperienceBar-Fill-Experience-2x-Flipbook"; + +local restedBarAtlas = "UI-HUD-ExperienceBar-Fill-Rested"; +local restedGainFlareAtlas = "UI-HUD-ExperienceBar-Flare-Rested-2x-Flipbook"; +local restedLevelUpAtlas = "UI-HUD-ExperienceBar-Fill-Rested-2x-Flipbook"; + +function ExpBarMixin:UpdateCurrentText() + self:SetBarText(XP_STATUS_BAR_TEXT:format(self.currXP, self.maxBar)); +end + +function ExpBarMixin:UpdateStatusBarTextures(isRested) + self.StatusBar:SetBarTexture(isRested and restedBarAtlas or unrestedBarAtlas); + self.StatusBar:SetAnimationTextures(isRested and restedGainFlareAtlas or unrestedGainFlareAtlas, + isRested and restedLevelUpAtlas or unrestedLevelUpAtlas); +end + +function ExhaustionTickMixin:ExhaustionToolTipText() + local exhaustionStateID, exhaustionStateName, exhaustionStateMultiplier = GetRestState(); + if(not exhaustionStateID) then + return; + end + + local currXP, nextXP = self:GetParent():GetLevelData(); + local percentXP = math.ceil(currXP/nextXP*100); + + local tooltip = GetAppropriateTooltip(); + GameTooltip_SetDefaultAnchor(tooltip, UIParent); + GameTooltip_SetTitle(tooltip, XP_TEXT:format(BreakUpLargeNumbers(currXP), BreakUpLargeNumbers(nextXP), percentXP)); + GameTooltip_AddHighlightLine(tooltip, EXHAUST_TOOLTIP1:format(exhaustionStateName, exhaustionStateMultiplier * 100)); + + if not IsResting() and (exhaustionStateID == 4 or exhaustionStateID == 5) then + GameTooltip_AddHighlightLine(tooltip, EXHAUST_TOOLTIP2); + end + + if GameLimitedMode_IsBankedXPActive() then + local bankedLevels = UnitTrialBankedLevels("player"); + local bankedXP = UnitTrialXP("player"); + + if bankedLevels > 0 or bankedXP > 0 then + GameTooltip_AddBlankLineToTooltip(tooltip); + GameTooltip_AddNormalLine(tooltip, XP_TEXT_BANKED_XP_HEADER); + end + + if bankedLevels > 0 then + GameTooltip_AddHighlightLine(tooltip, TRIAL_CAP_BANKED_LEVELS_TOOLTIP:format(bankedLevels)); + elseif bankedXP > 0 then + GameTooltip_AddHighlightLine(tooltip, TRIAL_CAP_BANKED_XP_TOOLTIP); + end + end + + GameTooltip:Show(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.lua.annotated.lua new file mode 100644 index 0000000..349865b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.lua.annotated.lua @@ -0,0 +1,68 @@ +local barAtlas = "UI-HUD-ExperienceBar-Fill-Honor"; +local gainFlareAtlas = "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook"; +local levelUpAtlas = "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook"; + +HonorBarMixin = {};--- @class HonorBarMixin + +function HonorBarMixin:Update() + local current = UnitHonor("player"); + local maxHonor = UnitHonorMax("player"); + local level = UnitHonorLevel("player"); + self:SetBarValues(current, 0, maxHonor, level); +end + +function HonorBarMixin:UpdateOverlayFrameText() + local current = UnitHonor("player"); + local maxHonor = UnitHonorMax("player"); + + if ( not current or not maxHonor ) then + return; + end + + self:SetBarText(HONOR_BAR:format(current, maxHonor)); +end + +function HonorBarMixin:OnLoad() + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("HONOR_XP_UPDATE"); + self:RegisterEvent("CVAR_UPDATE"); + self:RegisterEvent("ZONE_CHANGED"); + self:RegisterEvent("ZONE_CHANGED_NEW_AREA"); + self.StatusBar:SetOnAnimatedValueChangedCallback(function() self:UpdateOverlayFrameText() end); + self.StatusBar.OnFinishedCallback = function(...) + self.StatusBar:OnAnimFinished(...); + end + + self.StatusBar:SetBarTexture(barAtlas); + self.StatusBar:SetAnimationTextures(gainFlareAtlas, levelUpAtlas); +end + +function HonorBarMixin:OnEvent(event, ...) + if( event == "CVAR_UPDATE") then + local cvar = ...; + if( cvar == "xpBarText" ) then + self:UpdateTextVisibility(); + end + elseif ( event == "PLAYER_ENTERING_WORLD" or event == "HONOR_XP_UPDATE" or event == "ZONE_CHANGED" + or event == "ZONE_CHANGED_NEW_AREA" ) then + self:Update(); + end +end + +function HonorBarMixin:UpdateTick() + return; +end + +function HonorBarMixin:OnShow() + return; +end + +function HonorBarMixin:OnEnter() + self:UpdateOverlayFrameText(); + self:ShowText(); + return; +end + +function HonorBarMixin:OnLeave() + self:HideText(); +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml new file mode 100644 index 0000000..3f6637f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml.annotated.lua new file mode 100644 index 0000000..f95abd4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml.annotated.lua @@ -0,0 +1,6 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/HonorBar.xml#L3) +--- Template +--- @class HonorStatusBarTemplate : Frame, StatusTrackingBarTemplate, HonorBarMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.lua.annotated.lua new file mode 100644 index 0000000..c45f6e7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.lua.annotated.lua @@ -0,0 +1,86 @@ +local HouseFavorBarEvents = { + "PLAYER_ENTERING_WORLD", + "HOUSE_LEVEL_FAVOR_UPDATED", + "CVAR_UPDATE", +}; + +local barAtlas = "UI-HUD-ExperienceBar-Fill-ArtifactPower"; +local gainFlareAtlas = "UI-HUD-ExperienceBar-Flare-ArtifactPower-2x-Flipbook"; +local levelUpAtlas = "UI-HUD-ExperienceBar-Fill-ArtifactPower-2x-Flipbook"; + +HouseFavorBarMixin = {};--- @class HouseFavorBarMixin + +function HouseFavorBarMixin:Update() + local current, minBar, maxBar, level = 0, 0, 1, 1; + if self.houseLevelFavor then + current = self.houseLevelFavor.houseFavor; + level = self.houseLevelFavor.houseLevel; + minBar = C_Housing.GetHouseLevelFavorForLevel(level); + maxBar = C_Housing.GetHouseLevelFavorForLevel(level + 1); + end + if maxBar ~= 0 then + self:SetBarValues(current, minBar, maxBar, level); + end +end + +function HouseFavorBarMixin:UpdateOverlayFrameText() + if self.OverlayFrame.Text:IsShown() then + local xp = self.StatusBar:GetAnimatedValue(); + local _, totalLevelXP = self.StatusBar:GetMinMaxValues(); + self.OverlayFrame.Text:SetFormattedText(HOUSING_DASHBOARD_NEIGHBORHOOD_FAVOR, xp, totalLevelXP); + end +end + +function HouseFavorBarMixin:AnimatedValueChangedCallback() + self:UpdateOverlayFrameText(); +end + +function HouseFavorBarMixin:OnLoad() + self.StatusBar:SetBarTexture(barAtlas); + self.StatusBar:SetAnimationTextures(gainFlareAtlas, levelUpAtlas); + self.StatusBar:SetOnAnimatedValueChangedCallback(function() self:AnimatedValueChangedCallback(); end) + self.StatusBar:SetIsMaxLevelFunctionOverride(function() + if self.houseLevelFavor then + return self.houseLevelFavor.houseLevel >= C_Housing.GetMaxHouseLevel(); + end + + return false; + end); +end + +function HouseFavorBarMixin:OnEvent(event, ...) + if event == "HOUSE_LEVEL_FAVOR_UPDATED" then + local houseLevelFavor = ...; + if houseLevelFavor.houseGUID == C_Housing.GetTrackedHouseGuid() then + self.houseLevelFavor = houseLevelFavor; + self:Update(); + end + elseif event == "CVAR_UPDATE" then + local name, value = ...; + if name == "xpBarText" then + self:UpdateTextVisibility(); + elseif name == "trackedHouseFavor" then + self.trackedHouseGUID = value; + end + end +end + +function HouseFavorBarMixin:OnShow() + FrameUtil.RegisterFrameForEvents(self, HouseFavorBarEvents); + self:UpdateTextVisibility(); + C_Housing.GetCurrentHouseLevelFavor(C_Housing.GetTrackedHouseGuid()); +end + +function HouseFavorBarMixin:OnHide() + FrameUtil.UnregisterFrameForEvents(self, HouseFavorBarEvents); +end + +function HouseFavorBarMixin:OnEnter() + self:ShowText(); + self:UpdateOverlayFrameText(); +end + +function HouseFavorBarMixin:OnLeave() + self:HideText(); +end + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml new file mode 100644 index 0000000..064886e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml.annotated.lua new file mode 100644 index 0000000..33a44be --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml.annotated.lua @@ -0,0 +1,6 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/HouseFavorBar.xml#L3) +--- Template +--- @class HouseFavorBarTemplate : Frame, StatusTrackingBarTemplate, HouseFavorBarMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml new file mode 100644 index 0000000..3f01caf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml @@ -0,0 +1,176 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml.annotated.lua new file mode 100644 index 0000000..54d3818 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml.annotated.lua @@ -0,0 +1,96 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L3) +--- Explicitly protected +--- Template +--- @class MainBarActionBarButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field showButtonArt boolean # true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L10) +--- Template +--- @class HorizontalDividerTemplate : Frame, NineSliceCodeTemplate +--- @field ignoreInLayout boolean # true +--- @field layoutType string # ThreeSliceVerticalLayout +--- @field layoutTextureKit string # ui-hud-actionbar-frame-divider + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L20) +--- Template +--- @class VerticalDividerTemplate : Frame, NineSliceCodeTemplate +--- @field ignoreInLayout boolean # true +--- @field layoutType string # ThreeSliceHorizontalLayout +--- @field layoutTextureKit string # ui-hud-actionbar-frame-divider + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L92) +--- child of MainActionBar +--- @class MainActionBar_EndCaps : Frame +--- @field ignoreInLayout boolean # true +--- @field LeftEndCap Texture +--- @field RightEndCap Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L132) +--- child of MainActionBar_ActionBarPageNumber +--- @class MainActionBar_ActionBarPageNumber_UpButton : Button, QuickKeybindButtonTemplate, MainActionBarUpButtonMixin +--- @field commandName string # NEXTACTIONPAGE + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L149) +--- child of MainActionBar_ActionBarPageNumber +--- @class MainActionBar_ActionBarPageNumber_DownButton : Button, QuickKeybindButtonTemplate, MainActionBarDownButtonMixin +--- @field commandName string # PREVIOUSACTIONPAGE + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L123) +--- child of MainActionBar_ActionBarPageNumber +--- @class MainActionBar_ActionBarPageNumber_Text : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L114) +--- child of MainActionBar +--- @class MainActionBar_ActionBarPageNumber : Frame, ResizeLayoutFrame +--- @field ignoreInLayout boolean # true +--- @field UpButton MainActionBar_ActionBarPageNumber_UpButton +--- @field DownButton MainActionBar_ActionBarPageNumber_DownButton +--- @field Text MainActionBar_ActionBarPageNumber_Text + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L53) +--- child of MainActionBar +--- @class MainActionBar_BorderArt : Texture +--- @field ignoreInLayout boolean # true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/MainActionBar.xml#L29) +--- @class MainActionBar : Frame, EditModeActionBarTemplate, MainActionBarMixin +--- @field buttonTemplate string # MainBarActionBarButtonTemplate +--- @field commandNamePrefix string # ACTION +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.MainBar +--- @field skipAutomaticPositioning any # ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +--- @field isNormalBar boolean # true +--- @field enableDividers boolean # true +--- @field dynamicEndCaps boolean # true +--- @field EndCaps MainActionBar_EndCaps +--- @field ActionBarPageNumber MainActionBar_ActionBarPageNumber +--- @field BorderArt MainActionBar_BorderArt +--- @field QuickKeybindBottomShadow Texture +--- @field QuickKeybindRightShadow Texture +--- @field QuickKeybindGlowLarge Texture +--- @field QuickKeybindGlowSmall Texture +MainActionBar = {} +MainActionBar["buttonTemplate"] = "MainBarActionBarButtonTemplate" +MainActionBar["commandNamePrefix"] = "ACTION" +MainActionBar["isHorizontal"] = true +MainActionBar["numRows"] = 1 +MainActionBar["numButtons"] = 12 +MainActionBar["addButtonsToTop"] = true +MainActionBar["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MainActionBar["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MainActionBar["systemIndex"] = Enum.EditModeActionBarSystemIndices.MainBar +MainActionBar["skipAutomaticPositioning"] = ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +MainActionBar["isNormalBar"] = true +MainActionBar["enableDividers"] = true +MainActionBar["dynamicEndCaps"] = true +MainActionBar["system"] = Enum.EditModeSystem.ActionBar -- inherited +MainActionBar["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MainActionBar["addSystemIndexToName"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBarOverrides.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBarOverrides.lua.annotated.lua new file mode 100644 index 0000000..6537551 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/MainActionBarOverrides.lua.annotated.lua @@ -0,0 +1,20 @@ + +function MainActionBarMixin:UpdateEndCaps(overrideHideEndCaps) + local factionGroup = UnitFactionGroup("player"); + local showEndCaps = false; + + if ( factionGroup and factionGroup ~= "Neutral" ) then + + if ( factionGroup == "Alliance" ) then + self.EndCaps.LeftEndCap:SetAtlas("ui-hud-actionbar-gryphon-left"); + self.EndCaps.RightEndCap:SetAtlas("ui-hud-actionbar-gryphon-right"); + elseif ( factionGroup == "Horde" ) then + self.EndCaps.LeftEndCap:SetAtlas("ui-hud-actionbar-wyvern-left"); + self.EndCaps.RightEndCap:SetAtlas("ui-hud-actionbar-wyvern-right"); + end + + showEndCaps = true; + end + + self.EndCaps:SetShown(showEndCaps and not overrideHideEndCaps); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml new file mode 100644 index 0000000..3f8825e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml.annotated.lua new file mode 100644 index 0000000..9e81ba5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml.annotated.lua @@ -0,0 +1,45 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml#L15) +--- child of PetActionButtonTemplate +--- @class PetActionButtonTemplate_SpellHighlightAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml#L3) +--- Explicitly protected +--- Template +--- @class PetActionButtonTemplate : CheckButton, QuickKeybindButtonTemplate, SecureFrameTemplate, SmallActionButtonTemplate, PetActionButtonMixin +--- @field SpellHighlightTexture Texture +--- @field SpellHighlightAnim PetActionButtonTemplate_SpellHighlightAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/PetActionBar.xml#L33) +--- @class PetActionBar : Frame, EditModeActionBarTemplate, PetActionBarMixin +--- @field buttonTemplate string # PetActionButtonTemplate +--- @field commandNamePrefix string # BONUSACTION +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 10 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # PET_BAR_SHOWGRID +--- @field hideGridEventName string # PET_BAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.PetActionBar +--- @field systemNameString any # HUD_EDIT_MODE_PET_ACTION_BAR_LABEL +--- @field defaultHideSelection boolean # true +--- @field skipAutomaticPositioning any # ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +PetActionBar = {} +PetActionBar["buttonTemplate"] = "PetActionButtonTemplate" +PetActionBar["commandNamePrefix"] = "BONUSACTION" +PetActionBar["isHorizontal"] = true +PetActionBar["numRows"] = 1 +PetActionBar["numButtons"] = 10 +PetActionBar["addButtonsToRight"] = true +PetActionBar["addButtonsToTop"] = true +PetActionBar["showGridEventName"] = "PET_BAR_SHOWGRID" +PetActionBar["hideGridEventName"] = "PET_BAR_HIDEGRID" +PetActionBar["systemIndex"] = Enum.EditModeActionBarSystemIndices.PetActionBar +PetActionBar["systemNameString"] = HUD_EDIT_MODE_PET_ACTION_BAR_LABEL +PetActionBar["defaultHideSelection"] = true +PetActionBar["skipAutomaticPositioning"] = ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +PetActionBar["system"] = Enum.EditModeSystem.ActionBar -- inherited +PetActionBar["addSystemIndexToName"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml new file mode 100644 index 0000000..9b62b8f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml.annotated.lua new file mode 100644 index 0000000..ae7e08e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml.annotated.lua @@ -0,0 +1,33 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml#L3) +--- Explicitly protected +--- Template +--- @class PossessButtonTemplate : CheckButton, SecureFrameTemplate, SmallActionButtonTemplate, PossessButtonMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/PossessActionBar.xml#L13) +--- @class PossessActionBar : Frame, EditModeActionBarTemplate, PossessActionBarMixin +--- @field buttonTemplate string # PossessButtonTemplate +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 2 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field noSpacers boolean # true +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.PossessActionBar +--- @field systemNameString any # HUD_EDIT_MODE_POSSESS_ACTION_BAR_LABEL +--- @field defaultHideSelection boolean # true +PossessActionBar = {} +PossessActionBar["buttonTemplate"] = "PossessButtonTemplate" +PossessActionBar["isHorizontal"] = true +PossessActionBar["numRows"] = 1 +PossessActionBar["numButtons"] = 2 +PossessActionBar["addButtonsToRight"] = true +PossessActionBar["addButtonsToTop"] = true +PossessActionBar["noSpacers"] = true +PossessActionBar["systemIndex"] = Enum.EditModeActionBarSystemIndices.PossessActionBar +PossessActionBar["systemNameString"] = HUD_EDIT_MODE_POSSESS_ACTION_BAR_LABEL +PossessActionBar["defaultHideSelection"] = true +PossessActionBar["system"] = Enum.EditModeSystem.ActionBar -- inherited +PossessActionBar["addSystemIndexToName"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ReputationBarOverrides.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ReputationBarOverrides.lua.annotated.lua new file mode 100644 index 0000000..1c2aed1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/ReputationBarOverrides.lua.annotated.lua @@ -0,0 +1,47 @@ + +local blueBarAtlas = "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Blue"; +local barAtlases = +{ + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Red", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Red", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Orange", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Yellow", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", +}; + +local blueGainFlareAtlas = "UI-HUD-ExperienceBar-Flare-Rested-2x-Flipbook"; +local gainFlareAtlases = +{ + "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-ArtifactPower-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", +}; + +local blueLevelUpAtlas = "UI-HUD-ExperienceBar-Fill-Rested-2x-Flipbook"; +local levelUpAtlases = +{ + "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-ArtifactPower-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", +}; + +function ReputationStatusBarMixin:UpdateBarTextures(reactionLevel, overrideUseBlueBar) + local deferUntilNextLevelYes = true; + self.StatusBar:SetBarTexture(overrideUseBlueBar and blueBarAtlas or barAtlases[reactionLevel], deferUntilNextLevelYes); + self.StatusBar:SetAnimationTextures(overrideUseBlueBar and blueGainFlareAtlas or gainFlareAtlases[reactionLevel], + overrideUseBlueBar and blueLevelUpAtlas or levelUpAtlases[reactionLevel], + deferUntilNextLevelYes); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml new file mode 100644 index 0000000..4b2b65b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml.annotated.lua new file mode 100644 index 0000000..8e0ecaa --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml.annotated.lua @@ -0,0 +1,35 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml#L3) +--- Explicitly protected +--- Template +--- @class StanceButtonTemplate : CheckButton, QuickKeybindButtonTemplate, SecureFrameTemplate, SmallActionButtonTemplate, StanceButtonMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StanceBar.xml#L12) +--- @class StanceBar : Frame, EditModeActionBarTemplate, StanceBarMixin +--- @field buttonTemplate string # StanceButtonTemplate +--- @field commandNamePrefix string # SHAPESHIFT +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 10 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field noSpacers boolean # true +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.StanceBar +--- @field systemNameString any # HUD_EDIT_MODE_STANCE_BAR_LABEL +--- @field defaultHideSelection boolean # true +StanceBar = {} +StanceBar["buttonTemplate"] = "StanceButtonTemplate" +StanceBar["commandNamePrefix"] = "SHAPESHIFT" +StanceBar["isHorizontal"] = true +StanceBar["numRows"] = 1 +StanceBar["numButtons"] = 10 +StanceBar["addButtonsToRight"] = true +StanceBar["addButtonsToTop"] = true +StanceBar["noSpacers"] = true +StanceBar["systemIndex"] = Enum.EditModeActionBarSystemIndices.StanceBar +StanceBar["systemNameString"] = HUD_EDIT_MODE_STANCE_BAR_LABEL +StanceBar["defaultHideSelection"] = true +StanceBar["system"] = Enum.EditModeSystem.ActionBar -- inherited +StanceBar["addSystemIndexToName"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml new file mode 100644 index 0000000..60220dc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml.annotated.lua new file mode 100644 index 0000000..a0fd138 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml.annotated.lua @@ -0,0 +1,51 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L11) +--- child of StatusTrackingBarContainerTemplate +--- @class StatusTrackingBarContainerTemplate_FadeInAnimation : AnimationGroup, StatusTrackingBarContainerAnimationMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L17) +--- child of StatusTrackingBarContainerTemplate +--- @class StatusTrackingBarContainerTemplate_FadeOutAnimation : AnimationGroup, StatusTrackingBarContainerFadeOutAnimationMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L23) +--- child of StatusTrackingBarContainerTemplate +--- @class StatusTrackingBarContainerTemplate_MaxLevelFadeOutAnimation : AnimationGroup, StatusTrackingBarContainerFadeOutAnimationMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L3) +--- Template +--- Adds itself to the parent inside the array `barContainers` +--- @class StatusTrackingBarContainerTemplate : Frame, StatusTrackingBarContainerMixin +--- @field BarFrameTexture Texture +--- @field FadeInAnimation StatusTrackingBarContainerTemplate_FadeInAnimation +--- @field FadeOutAnimation StatusTrackingBarContainerTemplate_FadeOutAnimation +--- @field MaxLevelFadeOutAnimation StatusTrackingBarContainerTemplate_MaxLevelFadeOutAnimation + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L41) +--- child of StatusTrackingBarManager +--- @class MainStatusTrackingBarContainer : Frame, StatusTrackingBarContainerTemplate, EditModeStatusTrackingBar1SystemTemplate, EditModeStatusTrackingBarContainerMixin +MainStatusTrackingBarContainer = {} +MainStatusTrackingBarContainer["systemIndex"] = Enum.EditModeStatusTrackingBarSystemIndices.StatusTrackingBar1 -- inherited +MainStatusTrackingBarContainer["systemNameString"] = HUD_EDIT_MODE_STATUS_TRACKING_BAR_LABEL -- inherited +MainStatusTrackingBarContainer["addSystemIndexToName"] = true -- inherited +MainStatusTrackingBarContainer["system"] = Enum.EditModeSystem.StatusTrackingBar -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L49) +--- child of StatusTrackingBarManager +--- @class SecondaryStatusTrackingBarContainer : Frame, StatusTrackingBarContainerTemplate, EditModeStatusTrackingBar2SystemTemplate, EditModeStatusTrackingBarContainerMixin +SecondaryStatusTrackingBarContainer = {} +SecondaryStatusTrackingBarContainer["systemIndex"] = Enum.EditModeStatusTrackingBarSystemIndices.StatusTrackingBar2 -- inherited +SecondaryStatusTrackingBarContainer["systemNameString"] = HUD_EDIT_MODE_STATUS_TRACKING_BAR_LABEL -- inherited +SecondaryStatusTrackingBarContainer["addSystemIndexToName"] = true -- inherited +SecondaryStatusTrackingBarContainer["defaultHideSelection"] = true -- inherited +SecondaryStatusTrackingBarContainer["system"] = Enum.EditModeSystem.StatusTrackingBar -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBar.xml#L35) +--- @class StatusTrackingBarManager : Frame, StatusTrackingManagerMixin +--- @field MainStatusTrackingBarContainer MainStatusTrackingBarContainer +--- @field SecondaryStatusTrackingBarContainer SecondaryStatusTrackingBarContainer +--- @field barContainers table +StatusTrackingBarManager = {} +StatusTrackingBarManager["MainStatusTrackingBarContainer"] = MainStatusTrackingBarContainer +StatusTrackingBarManager["SecondaryStatusTrackingBarContainer"] = SecondaryStatusTrackingBarContainer + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml new file mode 100644 index 0000000..d105084 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml.annotated.lua new file mode 100644 index 0000000..cdf89c6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml.annotated.lua @@ -0,0 +1,25 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml#L9) +--- child of StatusTrackingBarTemplate +--- @class StatusTrackingBarTemplate_StatusBar : StatusBar, GradualAnimatedStatusBarTemplate, TextStatusBarMixin +--- @field supportsAnimation boolean # true +--- @field Background Texture +--- @field Underlay Texture +--- @field Overlay Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml#L37) +--- child of StatusTrackingBarTemplate_OverlayFrame +--- @class StatusTrackingBarTemplate_OverlayFrame_Text : FontString, TextStatusBarText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml#L34) +--- child of StatusTrackingBarTemplate +--- @class StatusTrackingBarTemplate_OverlayFrame : Frame +--- @field Text StatusTrackingBarTemplate_OverlayFrame_Text + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingBarTemplate.xml#L3) +--- Template +--- @class StatusTrackingBarTemplate : Frame, StatusTrackingBarMixin +--- @field StatusBar StatusTrackingBarTemplate_StatusBar +--- @field OverlayFrame StatusTrackingBarTemplate_OverlayFrame + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingManagerOverrides.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingManagerOverrides.lua.annotated.lua new file mode 100644 index 0000000..0234d31 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Mainline/StatusTrackingManagerOverrides.lua.annotated.lua @@ -0,0 +1,66 @@ + +function StatusTrackingManagerMixin:RegisterEvents() + self:RegisterEvent("UPDATE_FACTION"); + self:RegisterEvent("MAJOR_FACTION_RENOWN_LEVEL_CHANGED"); + self:RegisterEvent("ENABLE_XP_GAIN"); + self:RegisterEvent("DISABLE_XP_GAIN"); + self:RegisterEvent("CVAR_UPDATE"); + self:RegisterEvent("UPDATE_EXPANSION_LEVEL"); + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("HONOR_XP_UPDATE"); + self:RegisterEvent("ZONE_CHANGED"); + self:RegisterEvent("ZONE_CHANGED_NEW_AREA"); + self:RegisterEvent("UNIT_INVENTORY_CHANGED"); + self:RegisterEvent("ARTIFACT_XP_UPDATE"); + self:RegisterEvent("AZERITE_ITEM_EXPERIENCE_CHANGED"); + self:RegisterEvent("PLAYER_EQUIPMENT_CHANGED"); + self:RegisterEvent("TRACKED_HOUSE_CHANGED"); + self:RegisterEvent("PLAYER_MAX_LEVEL_UPDATE"); + self:RegisterUnitEvent("UNIT_LEVEL", "player"); +end + +function StatusTrackingManagerMixin:CanShowBar(barIndex) + if barIndex == StatusTrackingBarInfo.BarsEnum.Reputation then + local watchedFactionData = C_Reputation.GetWatchedFactionData(); + return watchedFactionData and watchedFactionData.name ~= ""; + elseif barIndex == StatusTrackingBarInfo.BarsEnum.Honor then + return IsWatchingHonorAsXP() or C_PvP.IsActiveBattlefield() or IsInActiveWorldPVP(); + elseif barIndex == StatusTrackingBarInfo.BarsEnum.Artifact then + return HasArtifactEquipped() and not C_ArtifactUI.IsEquippedArtifactMaxed() and not C_ArtifactUI.IsEquippedArtifactDisabled(); + elseif barIndex == StatusTrackingBarInfo.BarsEnum.Experience then + return GameRulesUtil.CanShowExperienceBar(); + elseif barIndex == StatusTrackingBarInfo.BarsEnum.Azerite then + local azeriteItem = C_AzeriteItem.FindActiveAzeriteItem(); + return not C_AzeriteItem.IsAzeriteItemAtMaxLevel() and azeriteItem and azeriteItem:IsEquipmentSlot() and C_AzeriteItem.IsAzeriteItemEnabled(azeriteItem); + elseif barIndex == StatusTrackingBarInfo.BarsEnum.HouseFavor then + return C_Housing.GetTrackedHouseGuid(); + end + + return false; +end + +function StatusTrackingBarContainerMixin:InitializeBars() + local barWidth = self:GetWidth() - 6; + local barHeight = self:GetHeight() - 6; + local function AddBar(barIndex, template) + local bar = CreateFrame("FRAME", nil, self, template); + bar.barIndex = barIndex; + bar:ClearAllPoints(); + bar:SetPoint("BOTTOMLEFT", self, "BOTTOMLEFT", 1, 5); + bar.StatusBar:SetSize(barWidth, barHeight); + bar:SetSize(barWidth, barHeight); + + if bar.fadeOutEntireBarAtMaxLevel then + bar.StatusBar:SetLevelUpMaxAlphaAnimation(self.MaxLevelFadeOutAnimation); + end + + self.bars[barIndex] = bar; + end + + AddBar(StatusTrackingBarInfo.BarsEnum.Reputation, "ReputationStatusBarTemplate"); + AddBar(StatusTrackingBarInfo.BarsEnum.Honor, "HonorStatusBarTemplate"); + AddBar(StatusTrackingBarInfo.BarsEnum.Artifact, "ArtifactStatusBarTemplate"); + AddBar(StatusTrackingBarInfo.BarsEnum.Experience, "ExpStatusBarTemplate"); + AddBar(StatusTrackingBarInfo.BarsEnum.Azerite, "AzeriteBarTemplate"); + AddBar(StatusTrackingBarInfo.BarsEnum.HouseFavor, "HouseFavorBarTemplate"); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBar.lua.annotated.lua new file mode 100644 index 0000000..ca2c691 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBar.lua.annotated.lua @@ -0,0 +1,365 @@ +ActionBarMixin = {}--- @class ActionBarMixin + +function ActionBarMixin:ActionBar_OnLoad() + self.numButtonsShowable = self.numButtons; + self.minButtonPadding = 2; + self.buttonPadding = self.minButtonPadding; + self.actionButtons = {}; + self.shownButtonContainers = {}; + + local actionBarName = self:GetName(); + + -- Create action buttons + for i=1, self.numButtons do + local buttonContainer = CreateFrame("Frame", actionBarName.."ButtonContainer"..i, self, "ActionBarButtonContainerTemplate", i); + + -- Different naming for these bars is to avoid errors with legacy code + -- Ideally this wouldn't be needed + local buttonName; + if self == MainActionBar then + buttonName = "ActionButton"..i; + elseif self == StanceBar then + buttonName = "StanceButton"..i; + elseif self == PetActionBar then + buttonName = "PetActionButton"..i; + elseif self == PossessActionBar then + buttonName = "PossessButton"..i; + else + buttonName = actionBarName.."Button"..i; + end + + local actionButton = CreateFrame("CheckButton", buttonName, buttonContainer, self.buttonTemplate, i); + actionButton:SetPoint("CENTER"); + actionButton.bar = self; + actionButton.container = buttonContainer; + actionButton.index = i; + + if self.commandNamePrefix then + actionButton.commandName = self.commandNamePrefix.."BUTTON"..i; + end + + table.insert(self.actionButtons, actionButton); + + buttonContainer:SetSize(actionButton:GetWidth(), actionButton:GetHeight()); + end + + self:UpdateShownButtons(); + self:UpdateGridLayout(); + + if self.showGridEventName then + self:RegisterEvent(self.showGridEventName); + end + if self.hideGridEventName then + self:RegisterEvent(self.hideGridEventName); + end +end + +function ActionBarMixin:ActionBar_OnEvent(event, ...) + if event == self.showGridEventName then + self:SetShowGrid(true, ACTION_BUTTON_SHOW_GRID_REASON_EVENT); + elseif event == self.hideGridEventName then + self:SetShowGrid(false, ACTION_BUTTON_SHOW_GRID_REASON_EVENT); + end +end + +function ActionBarMixin:CacheGridSettings() + self.oldGridSettings = { + numLaidOutObjects = #self.shownButtonContainers, + numRows = self.numRows, + isHorizontal = self.isHorizontal, + addButtonsToRight = self.addButtonsToRight, + addButtonsToTop = self.addButtonsToTop, + buttonPadding = self.buttonPadding, + }; +end + +function ActionBarMixin:ShouldUpdateGrid() + if self.oldGridSettings == nil then + return true; + end + + if self.oldGridSettings.numLaidOutObjects ~= #self.shownButtonContainers + or self.oldGridSettings.numRows ~= self.numRows + or self.oldGridSettings.isHorizontal ~= self.isHorizontal + or self.oldGridSettings.addButtonsToRight ~= self.addButtonsToRight + or self.oldGridSettings.addButtonsToTop ~= self.addButtonsToTop + or self.oldGridSettings.buttonPadding ~= self.buttonPadding then + return true; + end + + return false; +end + +function ActionBarMixin:UpdateGridLayout() + if not self:ShouldUpdateGrid() then + return; + end + + -- Stride is the number of buttons per row (or column if we are vertical) + -- Set stride so that if we can have the same number of icons per row we do + local stride = math.ceil(#self.shownButtonContainers / self.numRows); + + -- Set button padding. User can set padding through edit mode + local buttonPadding = math.max(self.minButtonPadding, self.buttonPadding); + + -- Multipliers determine the direction the bar grows for grid layouts + -- Positive means right/up + -- Negative means left/down + local xMultiplier = self.addButtonsToRight and 1 or -1; + local yMultiplier = self.addButtonsToTop and 1 or -1; + + -- Create the grid layout according to whether we are horizontal or vertical + local layout; + if self.isHorizontal then + layout = GridLayoutUtil.CreateStandardGridLayout(stride, buttonPadding, buttonPadding, xMultiplier, yMultiplier); + else + layout = GridLayoutUtil.CreateVerticalGridLayout(stride, buttonPadding, buttonPadding, xMultiplier, yMultiplier); + end + + -- Need to change where the buttons anchor based on how the bar grows + local anchorPoint; + if self.addButtonsToLeft then + anchorPoint = "LEFT"; + elseif self.addButtonsToTop then + if self.addButtonsToRight then + anchorPoint = "BOTTOMLEFT"; + else + anchorPoint = "BOTTOMRIGHT"; + end + else + if self.addButtonsToRight then + anchorPoint = "TOPLEFT"; + else + anchorPoint = "TOPRIGHT"; + end + end + + -- Apply the layout and then update our size + GridLayoutUtil.ApplyGridLayout(self.shownButtonContainers, AnchorUtil.CreateAnchor(anchorPoint, self, anchorPoint), layout); + self:Layout(); + self:UpdateSpellFlyoutDirection(); + self:CacheGridSettings(); +end + +function ActionBarMixin:SetShowGrid(showGrid, reason) + if not showGrid and KeybindFrames_InQuickKeybindMode() then + return; -- Don't hide grid if we are in QuickKeybindMode + end + + -- SetShowGrid overrides "Always Show Buttons" being false, showAllButtons overrides "Bar Visible" setting + -- When dragging spells or going through spell collection, we want to override both + if reason == ACTION_BUTTON_SHOW_GRID_REASON_EVENT or reason == ACTION_BUTTON_SHOW_GRID_REASON_SPELLCOLLECTION then + -- Use bit flags to ensure we don't re-hide the bar for one reason while another reason is still active + -- IE dropping a dragged spell while the Spellbook is still open + if showGrid then + self.showAllButtons = bit.bor(self.showAllButtons or 0, reason); + else + self.showAllButtons = bit.band(self.showAllButtons or 0, bit.bnot(reason)); + end + end + + for i, actionButton in pairs(self.actionButtons) do + actionButton:SetShowGrid(showGrid, reason); + end + + self:UpdateFrameStrata(showGrid, reason); + self:UpdateShownButtons(); + + if self.UpdateVisibility then + self:UpdateVisibility(); + end +end + +function ActionBarMixin:GetShowAllButtons() + return self.showAllButtons and self.showAllButtons > 0 or false; +end + +-- If you are dragging a spell then raise the bar's frame strata +-- Do this so bars can appear above talents UI since it's pretty big and likely covers your bars +-- Don't do for other cursor types (specifically items since we don't want bars to cover bag slots when dragging items) +-- The current intent is to raise this when dragging from the spellbook/talents +local cursorTypesThatRaiseActionBar = tInvert({ "spell", "petaction", "flyout", "outfit" }); + +function ActionBarMixin:ShouldRaise(showGrid, reason) + if showGrid and (reason == ACTION_BUTTON_SHOW_GRID_REASON_EVENT) then + local cursorType = GetCursorInfo(); + if cursorType then + return cursorTypesThatRaiseActionBar[cursorType] ~= nil; + end + end + + return false; +end + +function ActionBarMixin:UpdateFrameStrata(showGrid, reason) + self:SetFrameStrata(self:ShouldRaise(showGrid, reason) and "TOOLTIP" or "MEDIUM"); +end + +function ActionBarMixin:UpdateShownButtons() + table.wipe(self.shownButtonContainers); + + for i, actionButton in pairs(self.actionButtons) do + local showButton = actionButton.index <= self.numButtonsShowable -- Show button if it is within the num buttons which are showable + and not actionButton:GetAttribute("statehidden") -- and it isn't being hidden by an attribute + and (actionButton:GetShowGrid() or actionButton:HasAction()); -- And either the grid is being shown or the button has an action + + actionButton:SetShown(showButton); + + local showButtonContainer = showButton or (not self.noSpacers and i <= self.numButtonsShowable); + actionButton.container:SetShown(showButtonContainer); + if showButtonContainer then + table.insert(self.shownButtonContainers, actionButton.container); + end + end + + -- If visible buttons changed then we may need to update the dividers we're showing between buttons + if self.UpdateDividers then + self:UpdateDividers(); + end +end + +function ActionBarMixin:UpdateSpellFlyoutDirection() + local direction = self.isHorizontal and "UP" or "LEFT"; + + local actionBarCenterX, actionBarCenterY = self:GetCenter(); + if actionBarCenterX and actionBarCenterY then + if self.isHorizontal then + local halfScreen = GetScreenHeight() / 2; + direction = actionBarCenterY < halfScreen and "UP" or "DOWN"; + else + local halfScreen = GetScreenWidth() / 2; + direction = actionBarCenterX > halfScreen and "LEFT" or "RIGHT"; + end + end + + if self.flyoutDirection ~= direction then + self.flyoutDirection = direction; + + for i, actionButton in pairs(self.actionButtons) do + if actionButton.UpdateFlyout then + actionButton:UpdateFlyout(); + end + end + end +end + +function ActionBarMixin:GetSpellFlyoutDirection() + if not self.flyoutDirection then + self:UpdateSpellFlyoutDirection(); + end + + return self.flyoutDirection; +end + +EditModeActionBarMixin = {}--- @class EditModeActionBarMixin + +function EditModeActionBarMixin:EditModeActionBar_OnLoad() + self:ActionBar_OnLoad(); + self:OnSystemLoad(); + + self.isShownExternal = self:IsShown(); + + self:RegisterEvent("PLAYER_REGEN_ENABLED"); + self:RegisterEvent("PLAYER_REGEN_DISABLED"); +end + +function EditModeActionBarMixin:SetupVisibilityFunctionOverrides() + -- This is called from EditModeSystemMixin. + -- Need to override all the show/hide methods so that we can manage our visibility based on settings + self.IsShownBase = self.IsShown; + self.IsShown = self.IsShownOverride; + self.SetShownBase = self.SetShown; + self.SetShown = self.SetShownOverride; + self.ShowBase = self.Show; + self.Show = self.ShowOverride; + self.HideBase = self.Hide; + self.Hide = self.HideOverride; +end + +function EditModeActionBarMixin:EditModeActionBar_OnEvent(event, ...) + if event == "PLAYER_REGEN_ENABLED" or event == "PLAYER_REGEN_DISABLED" then + -- Update shown state when combat state changes to account for bar visibility setting + -- Apparently regen being enabled/disabled is a good way to tell whether the player's combat state has changed + self:UpdateVisibility(); + end +end + +function EditModeActionBarMixin:ShouldUpdateGrid() + if self:IsInitialized() and not self.gridInitialized then + self.gridInitialized = true; + return true; + end + + return ActionBarMixin.ShouldUpdateGrid(self); +end + +function EditModeActionBarMixin:IsShownOverride() + -- This is needed since the bar may technically be hidden due to visibility settings but we don't actually want things to + -- interpret it as truly hidden since a lot of things will use this info to know whether they need to show/hide the bar + -- and that literal shown state doesn't accurately represent what the bar's state is + if self.visibility and self.visibility ~= "Always" then + return self.isShownExternal; + end + + -- If the bar isn't using visibility settings then just return the base IsShown + return self:IsShownBase(); +end + +function EditModeActionBarMixin:SetShownOverride(shown) + if shown then + self:ShowOverride(); + else + self:HideOverride(); + end +end + +function EditModeActionBarMixin:ShowOverride() + self.isShownExternal = true; + + -- Action bars may have fancy visibility rules which we have to follow rather than just directly showing/hiding + self:UpdateVisibility(); +end + +function EditModeActionBarMixin:HideOverride() + self.isShownExternal = false; + + if self:ShouldBreakSnappedFramesOnHide() then + self:BreakSnappedFrames(); + end + + -- Action bars may have fancy visibility rules which we have to follow rather than just directly showing/hiding + self:UpdateVisibility(); +end + +function EditModeActionBarMixin:UpdateVisibility() + if not self.visibility then + -- If we don't have visiblity settings, then just follow whatever we are told to do externally + self:SetShownBase(self.isShownExternal or self.editModeForceShow); + elseif not self.isShownExternal then + -- If we are being hidden externally then don't change that + self:HideBase(); + elseif self:GetShowAllButtons() then + -- If we are showing all buttons likely due to an icon being dragged or viewing spell collection UI then show the bar + self:ShowBase(); + elseif EditModeManagerFrame:IsEditModeActive() then + -- If edit mode manager is showing then show + self:ShowBase(); + elseif self.visibility == "InCombat" or self.visibility == "OutOfCombat" then + -- If we care about combat visibility, update visibility based on whether you're in combat + local isInCombat = UnitAffectingCombat("player"); + + if self.visibility == "InCombat" then + self:SetShownBase(isInCombat); + else -- Out of combat + self:SetShownBase(not isInCombat); + end + elseif self.visibility == "Hidden" then + -- If we are set to be hidden then hide + self:HideBase(); + else + -- If no other rules, show the bar + self:ShowBase(); + end + + EditModeManagerFrame:UpdateActionBarLayout(self); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml new file mode 100644 index 0000000..6e8d952 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml.annotated.lua new file mode 100644 index 0000000..c84c745 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml.annotated.lua @@ -0,0 +1,14 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml#L3) +--- Template +--- @class ActionBarButtonContainerTemplate : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml#L7) +--- Template +--- @class ActionBarTemplate : Frame, ResizeLayoutFrame, ActionBarMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionBarTemplate.xml#L57) +--- Template +--- @class EditModeActionBarTemplate : Frame, ActionBarTemplate, EditModeActionBarSystemTemplate, EditModeActionBarMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButton.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButton.lua.annotated.lua new file mode 100644 index 0000000..3b47f1e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButton.lua.annotated.lua @@ -0,0 +1,1993 @@ +ATTACK_BUTTON_FLASH_TIME = 0.4; +RANGE_INDICATOR = "●"; + +COOLDOWN_TYPE_LOSS_OF_CONTROL = 1; +COOLDOWN_TYPE_NORMAL = 2; + +local countdownForCooldownsCVarName = "countdownForCooldowns"; + +ACTION_HIGHLIGHT_MARKS = { }; +ON_BAR_HIGHLIGHT_MARKS = { }; + +ACTION_BUTTON_SHOW_GRID_REASON_CVAR = 1; +ACTION_BUTTON_SHOW_GRID_REASON_EVENT = 2; +ACTION_BUTTON_SHOW_GRID_REASON_SPELLCOLLECTION = 4; + +ActionButtonBindingHighlightCallbackRegistry = CreateFromMixins(CallbackRegistryMixin); +ActionButtonBindingHighlightCallbackRegistry:SetUndefinedEventsAllowed(true); +ActionButtonBindingHighlightCallbackRegistry:OnLoad(); + +local ActionButtonCastType = +{ + Cast = 1, + Channel = 2, + Empowered = 3, +} + +function MarkNewActionHighlight(action) + ACTION_HIGHLIGHT_MARKS[action] = true; +end + +function ClearNewActionHighlight(action, preventIdenticalActionsFromClearing) + ACTION_HIGHLIGHT_MARKS[action] = nil; + + if preventIdenticalActionsFromClearing then + return; + end + + -- If we're unhighlighting this one because it was used/moused over/etc... + -- then go find all other current actions that match this one that are also + -- marked for highlight and unmark them. The next time they update the highlight + -- will update; may need to actually force update the action button in some cases + -- and that means that ACTION_HIGHLIGHT_MARKS needs to store more information + local unmarkedType, unmarkedID = GetActionInfo(action); + + for actionKey, markValue in pairs(ACTION_HIGHLIGHT_MARKS) do + if markValue then + local actionType, actionID = GetActionInfo(actionKey); + if actionType == unmarkedType and actionID == unmarkedID then + ACTION_HIGHLIGHT_MARKS[actionKey] = nil; + end + end + end +end + +-- Keys within ON_BAR_HIGHLIGHT_MARKS and ACTION_HIGHLIGHT_MARKS are vulnerable to taint from +-- talent and spellbook code. Will require some investigation. +local function SecureGetNewActionHighlightMark(action) + return ACTION_HIGHLIGHT_MARKS[action]; +end + +function GetNewActionHighlightMark(action) + return securecallfunction(SecureGetNewActionHighlightMark, action); +end + +function ClearOnBarHighlightMarks() + ON_BAR_HIGHLIGHT_MARKS = {}; +end + +local function SecureGetOnBarHighlightMark(action) + return ON_BAR_HIGHLIGHT_MARKS[action]; +end + +function GetOnBarHighlightMark(action) + return securecallfunction(SecureGetOnBarHighlightMark, action); +end + +local function UpdateOnBarHighlightMarks(actionButtonSlots) + if actionButtonSlots then + ON_BAR_HIGHLIGHT_MARKS = tInvert(actionButtonSlots); + else + ClearOnBarHighlightMarks(); + end +end + +function UpdateOnBarHighlightMarksBySpell(spellID) + UpdateOnBarHighlightMarks(C_ActionBar.FindSpellActionButtons(spellID)); +end + +function UpdateOnBarHighlightMarksByFlyout(flyoutID) + UpdateOnBarHighlightMarks(C_ActionBar.FindFlyoutActionButtons(flyoutID)); +end + +function UpdateOnBarHighlightMarksByPetAction(petAction) + UpdateOnBarHighlightMarks(C_ActionBar.FindPetActionButtons(petAction)); +end + +function GetActionButtonForID(id) + if OverrideActionBar and OverrideActionBar:IsShown() then + if id > NUM_OVERRIDE_BUTTONS then + return; + end + + return _G["OverrideActionBarButton"..id]; + end + + return _G["ActionButton"..id]; +end + +function TryUseActionButton(self, checkingFromDown) + local isKeyPress = true; + local isSecureAction = true; + local usedActionButton = SecureActionButton_OnClick(self, "LeftButton", checkingFromDown, isKeyPress, isSecureAction); + if usedActionButton then + if GetNewActionHighlightMark(self.action) then + ClearNewActionHighlight(self.action); + self:UpdateHighlightMark(); + end + end + self:UpdateState(); +end + +local isInPetBattle = C_PetBattles.IsInBattle; +local function CheckPetActionButtonEvent(id, isDown) + if isInPetBattle() and PetBattleFrame then + if isDown then + PetBattleFrame_ButtonDown(id); + else + PetBattleFrame_ButtonUp(id); + end + return true; + end + + return false; +end + +function ActionButtonDown(id) + if CheckPetActionButtonEvent(id, true) then + return; + end + + local button = GetActionButtonForID(id); + if button then + if button:GetButtonState() == "NORMAL" then + button:SetButtonState("PUSHED"); + end + + TryUseActionButton(button, true); + end +end + +function ActionButtonUp(id) + if CheckPetActionButtonEvent(id, false) then + return; + end + + local button = GetActionButtonForID(id); + if button then + if ( button:GetButtonState() == "PUSHED" ) then + button:SetButtonState("NORMAL"); + end + + TryUseActionButton(button, false); + end +end + +function ActionBar_PageUp() + local nextPage; + for i=C_ActionBar.GetActionBarPage() + 1, NUM_ACTIONBAR_PAGES do + if ( VIEWABLE_ACTION_BAR_PAGES[i] ) then + nextPage = i; + break; + end + end + + if ( not nextPage ) then + nextPage = 1; + end + C_ActionBar.SetActionBarPage(nextPage); +end + +function ActionBar_PageDown() + local prevPage; + for i=C_ActionBar.GetActionBarPage() - 1, 1, -1 do + if ( VIEWABLE_ACTION_BAR_PAGES[i] ) then + prevPage = i; + break; + end + end + + if ( not prevPage ) then + for i=NUM_ACTIONBAR_PAGES, 1, -1 do + if ( VIEWABLE_ACTION_BAR_PAGES[i] ) then + prevPage = i; + break; + end + end + end + C_ActionBar.SetActionBarPage(prevPage); +end + +ActionBarButtonEventsFrameMixin = {};--- @class ActionBarButtonEventsFrameMixin + +function ActionBarButtonEventsFrameMixin:OnLoad() + self.frames = {}; + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("ACTIONBAR_SLOT_CHANGED"); + self:RegisterEvent("UPDATE_BINDINGS"); + self:RegisterEvent("GAME_PAD_ACTIVE_CHANGED"); + self:RegisterEvent("UPDATE_SHAPESHIFT_FORM"); + self:RegisterEvent("ACTIONBAR_UPDATE_COOLDOWN"); + self:RegisterEvent("PET_BAR_UPDATE"); + self:RegisterUnitEvent("UNIT_FLAGS", "pet"); + self:RegisterUnitEvent("UNIT_AURA", "pet"); + self:RegisterEvent("PLAYER_MOUNT_DISPLAY_CHANGED"); + + CVarCallbackRegistry:SetCVarCachable(countdownForCooldownsCVarName); + CVarCallbackRegistry:RegisterCallback(countdownForCooldownsCVarName, self.OnCountdownForCooldownsChanged, self); +end + +function ActionBarButtonEventsFrameMixin:OnEvent(event, ...) + -- pass event down to the buttons + for k, frame in pairs(self.frames) do + frame:OnEvent(event, ...); + end +end + +function ActionBarButtonEventsFrameMixin:OnCountdownForCooldownsChanged() + for k, frame in pairs(self.frames) do + ActionButton_UpdateCooldownNumberHidden(frame); + end +end + +function ActionBarButtonEventsFrameMixin:RegisterFrame(frame) + tinsert(self.frames, frame); +end + +function ActionBarButtonEventsFrameMixin:ForEachFrame(func) + for k, frame in pairs(self.frames) do + func(frame); + end +end + +ActionBarActionEventsFrameMixin = {};--- @class ActionBarActionEventsFrameMixin + +function ActionBarActionEventsFrameMixin:OnLoad() + self.frames = {}; + --self:RegisterEvent("ACTIONBAR_UPDATE_USABLE"); replaced with ACTION_USABLE_CHANGED + self:RegisterEvent("SPELL_UPDATE_CHARGES"); + self:RegisterEvent("UPDATE_INVENTORY_ALERTS"); + self:RegisterEvent("TRADE_SKILL_SHOW"); + self:RegisterEvent("TRADE_SKILL_CLOSE"); + self:RegisterEvent("ARCHAEOLOGY_CLOSED"); + self:RegisterEvent("PLAYER_ENTER_COMBAT"); + self:RegisterEvent("PLAYER_LEAVE_COMBAT"); + self:RegisterEvent("START_AUTOREPEAT_SPELL"); + self:RegisterEvent("STOP_AUTOREPEAT_SPELL"); + self:RegisterEvent("UNIT_ENTERED_VEHICLE"); + self:RegisterEvent("UNIT_EXITED_VEHICLE"); + self:RegisterEvent("COMPANION_UPDATE"); + self:RegisterEvent("UNIT_INVENTORY_CHANGED"); + self:RegisterEvent("UNIT_SPELLCAST_SENT"); + self:RegisterUnitEvent("UNIT_SPELLCAST_INTERRUPTED", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_SUCCEEDED", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_FAILED", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_START", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_STOP", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_CHANNEL_START", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_CHANNEL_STOP", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_RETICLE_TARGET", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_RETICLE_CLEAR", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_EMPOWER_START", "player"); + self:RegisterUnitEvent("UNIT_SPELLCAST_EMPOWER_STOP", "player"); + + self:RegisterEvent("LEARNED_SPELL_IN_SKILL_LINE"); + self:RegisterEvent("PET_STABLE_UPDATE"); + self:RegisterEvent("PET_STABLE_SHOW"); + self:RegisterEvent("SPELL_ACTIVATION_OVERLAY_GLOW_SHOW"); + self:RegisterEvent("SPELL_ACTIVATION_OVERLAY_GLOW_HIDE"); + self:RegisterEvent("UPDATE_SUMMONPETS_ACTION"); + self:RegisterUnitEvent("LOSS_OF_CONTROL_ADDED", "player"); + self:RegisterUnitEvent("LOSS_OF_CONTROL_UPDATE", "player"); + self:RegisterEvent("SPELL_UPDATE_ICON"); + + EventRegistry:RegisterCallback("AssistedCombatManager.OnSetActionSpell", function(o) + -- May not be the best way, but it is a unique string which is what the event system cares about + self:OnEvent("AssistedCombatManager.OnSetActionSpell"); + end); +end + + +function ActionBarActionEventsFrameMixin:IsSpellcastEvent(event) + if ( event == "UNIT_SPELLCAST_INTERRUPTED" or + event == "UNIT_SPELLCAST_SUCCEEDED" or + event == "UNIT_SPELLCAST_START" or + event == "UNIT_SPELLCAST_STOP" or + event == "UNIT_SPELLCAST_CHANNEL_START" or + event == "UNIT_SPELLCAST_CHANNEL_STOP" or + event == "UNIT_SPELLCAST_RETICLE_TARGET" or + event == "UNIT_SPELLCAST_RETICLE_CLEAR" or + event == "UNIT_SPELLCAST_EMPOWER_START" or + event == "UNIT_SPELLCAST_EMPOWER_STOP" or + event == "UNIT_SPELLCAST_SENT" or + event == "UNIT_SPELLCAST_FAILED") then + return true; + else + return false; + end +end + +function ActionBarActionEventsFrameMixin:OnEvent(event, ...) + if ( event == "UNIT_INVENTORY_CHANGED" ) then + local unit = ...; + if ( unit == "player" and self.tooltipOwner and GameTooltip:GetOwner() == self.tooltipOwner ) then + self.tooltipOwner:SetTooltip(); + end + elseif ( self:IsSpellcastEvent(event) ) then + for k, frame in pairs(self.frames) do + local spellID; + local unit = ...; + + if(event == "UNIT_SPELLCAST_SENT") then + spellID = select(4, ...); + else + spellID = select(3, ...); + end + + if (unit == "player" and frame:MatchesActiveButtonSpellID(spellID)) then + frame:OnEvent(event, ...); + end + end + else + for k, frame in pairs(self.frames) do + frame:OnEvent(event, ...); + end + end +end + +function ActionBarActionEventsFrameMixin:RegisterFrame(frame) + self.frames[frame] = frame; +end + +function ActionBarActionEventsFrameMixin:UnregisterFrame(frame) + self.frames[frame] = nil; +end + +ActionBarButtonUpdateFrameMixin = {};--- @class ActionBarButtonUpdateFrameMixin + +function ActionBarButtonUpdateFrameMixin:OnLoad() + self.frames = {}; +end + +function ActionBarButtonUpdateFrameMixin:OnUpdate(elapsed) + for k, frame in pairs(self.frames) do + frame:OnUpdate(elapsed); + end +end + +function ActionBarButtonUpdateFrameMixin:RegisterFrame(frame) + self.frames[frame] = frame; +end + +function ActionBarButtonUpdateFrameMixin:UnregisterFrame(frame) + self.frames[frame] = nil; +end + +ActionBarButtonRangeCheckFrameMixin = {};--- @class ActionBarButtonRangeCheckFrameMixin + +function ActionBarButtonRangeCheckFrameMixin:OnLoad() + self.actions = {}; + self:RegisterEvent("ACTION_RANGE_CHECK_UPDATE"); +end + +function ActionBarButtonRangeCheckFrameMixin:OnEvent(event, ...) + local action, inRange, checksRange = ...; + + -- pass event down to the buttons + local frames = self.actions[action]; + if frames then + for k, frame in pairs(frames) do + frame:OnEvent(event, ...); + end + end +end + +function ActionBarButtonRangeCheckFrameMixin:RegisterFrame(action, frame) + if not self.actions[action] then + self.actions[action] = {}; + end + if self.actions[action][frame] then + return; + end + self.actions[action][frame] = frame; + C_ActionBar.EnableActionRangeCheck(action, true); +end + +function ActionBarButtonRangeCheckFrameMixin:UnregisterFrame(action, frame) + if not self.actions[action] or not self.actions[action][frame] then + return; + end + self.actions[action][frame] = nil; + C_ActionBar.EnableActionRangeCheck(action, false); +end + +ActionBarButtonUsableWatcherFrameMixin = {};--- @class ActionBarButtonUsableWatcherFrameMixin + +function ActionBarButtonUsableWatcherFrameMixin:OnLoad() + self.actions = {}; + self:RegisterEvent("ACTION_USABLE_CHANGED"); +end + +function ActionBarButtonUsableWatcherFrameMixin:OnEvent(event, ...) + local changes = ...; + + -- pass event down to the buttons + for _, change in ipairs(changes) do + local frames = self.actions[change.slot]; + if frames then + for k, frame in pairs(frames) do + frame:UpdateUsable(change.slot, change.usable, change.noMana); + end + end + end +end + +function ActionBarButtonUsableWatcherFrameMixin:RegisterFrame(action, frame) + if not self.actions[action] then + self.actions[action] = {}; + end + if self.actions[action][frame] then + return; + end + self.actions[action][frame] = frame; +end + +function ActionBarButtonUsableWatcherFrameMixin:UnregisterFrame(action, frame) + if not self.actions[action] or not self.actions[action][frame] then + return; + end + self.actions[action][frame] = nil; +end + +ActionBarActionButtonMixin = {};--- @class ActionBarActionButtonMixin + +function ActionBarActionButtonMixin:OnLoad() + self.SetButtonStateBase = self.SetButtonState; + self.SetButtonState = self.SetButtonStateOverride; + + self.flashing = 0; + self.flashtime = 0; + self:SetAttribute("type", "action"); + self:SetAttribute("typerelease", "actionrelease"); + self:SetAttribute("checkselfcast", true); + self:SetAttribute("checkfocuscast", true); + self:SetAttribute("checkmouseovercast", true); + self:SetAttribute("useparent-unit", true); + self:SetAttribute("useparent-actionpage", true); + self:RegisterForDrag("LeftButton", "RightButton"); + self:RegisterForClicks("AnyUp", "LeftButtonDown", "RightButtonDown"); + ActionBarButtonEventsFrame:RegisterFrame(self); + self:UpdateAction(); + self:UpdateHotkeys(self.buttonType); + + self.QuickKeybindHighlightTexture:ClearAllPoints(); + self.QuickKeybindHighlightTexture:SetPoint("CENTER"); + self.QuickKeybindHighlightTexture:SetSize(46, 45); + + ActionButton_UpdateCooldownNumberHidden(self); +end + +function ActionBarActionButtonMixin:UpdateHotkeys(actionButtonType) + local id; + if ( not actionButtonType ) then + actionButtonType = "ACTIONBUTTON"; + id = self:GetID(); + else + if ( actionButtonType == "MULTICASTACTIONBUTTON" ) then + id = self.buttonIndex; + else + id = self:GetID(); + end + end + + self.bindingAction = actionButtonType..id; + if C_GameRules.GetActiveGameMode() == Enum.GameMode.Plunderstorm then + self.bindingAction = "WOWLABS_"..self.bindingAction; + end + local hotkey = self.HotKey; + local key = GetBindingKey(self.bindingAction) or + GetBindingKey("CLICK "..self:GetName()..":LeftButton"); + + local text = GetBindingText(key, 1); + if ( text == "" ) then + hotkey:SetText(RANGE_INDICATOR); + hotkey:Hide(); + else + local frameWidth, frameHeight = self:GetSize(); + if ( IsBindingForGamePad(key) ) then + -- Allow gamepad binding to go all the way across and overlap the border for more space + hotkey:SetSize(frameWidth, 16); + hotkey:SetPoint("TOPRIGHT", self, "TOPRIGHT", self.hotkeyTextGamepadX or 0, self.hotkeyTextGamepadY or 0); + else + -- Tuck in KBM binding a bit to be inside the border + hotkey:SetSize(frameWidth-8, 10); + hotkey:SetPoint("TOPRIGHT", self, "TOPRIGHT", self.hotkeyTextKeyboardX or 0, self.hotkeyTextKeyboardY or 0); + end + hotkey:SetText(text); + hotkey:Show(); + end +end + +function ActionBarActionButtonMixin:UpdatePressAndHoldAction() + local pressAndHoldAction = false; + + if self.action then + local actionType, id = GetActionInfo(self.action); + if actionType == "spell" then + pressAndHoldAction = C_Spell.IsPressHoldReleaseSpell(id); + end + end + + self:SetAttribute("pressAndHoldAction", pressAndHoldAction); +end + +function ActionBarActionButtonMixin:OnAttributeChanged(name, value) + BaseActionButtonMixin.BaseActionButtonMixin_OnAttributeChanged(self, name, value); + self:UpdateAction(); +end + +function ActionBarActionButtonMixin:UpdateAction(force) + local action = self:CalculateAction(); + if ( action ~= self.action or force ) then + if self.action then + self:UnregisterActionBarButtonCheckFrames(self.action); + end + self.action = action; + if self.action and self:IsVisible() then + self:RegisterActionBarButtonCheckFrames(self.action); + end + + C_ActionBar.RegisterActionUIButton(self, action, self.cooldown); + + self:UpdateAssistedCombatRotationFrame(); + + self:Update(); + + -- If on an action bar and layout fields are set, ask it to update visibility of its buttons + if (self.index and self.bar) then + self.bar:UpdateShownButtons(); + end + + EventRegistry:TriggerEvent("ActionButton.OnActionChanged", self); + end +end + +function ActionBarActionButtonMixin:Update() + local action = self.action; + local icon = self.icon; + local texture = C_ActionBar.GetActionTexture(action); + + icon:SetDesaturated(false); + local type, id = GetActionInfo(action); + if ( C_ActionBar.HasAction(action) ) then + if ( not self.eventsRegistered ) then + ActionBarActionEventsFrame:RegisterFrame(self); + self.eventsRegistered = true; + end + self:UpdateState(); + self:UpdateUsable(); + self:UpdateProfessionQuality(); + self:UpdateTypeOverlay(); + ActionButton_UpdateCooldown(self); + self:UpdateFlash(); + self:UpdateHighlightMark(); + self:UpdateSpellHighlightMark(); + else + if ( self.eventsRegistered ) then + ActionBarActionEventsFrame:UnregisterFrame(self); + self.eventsRegistered = nil; + end + + ClearActionButtonCooldowns(self.cooldown, self.chargeCooldown, self.lossOfControlCooldown); + + self:ClearFlash(); + self:SetChecked(false); + self:ClearProfessionQuality(); + self:ClearTypeOverlay(); + + if self.LevelLinkLockIcon then + self.LevelLinkLockIcon:SetShown(false); + end + end + + self:UpdatePressAndHoldAction(); + + -- Add a green border if button is an equipped item + local border = self.Border; + if border then + if ( C_ActionBar.IsEquippedAction(action) ) then + border:SetVertexColor(0, 1.0, 0, 0.5); + border:Show(); + else + border:Hide(); + end + end + + -- Update Action Text + local actionName = self.Name; + if actionName then + if ( not C_ActionBar.IsConsumableAction(action) and not C_ActionBar.IsStackableAction(action) and (C_ActionBar.IsItemAction(action) or C_ActionBar.GetActionUseCount(action) == 0) ) then + actionName:SetText(C_ActionBar.GetActionText(action)); + else + actionName:SetText(""); + end + end + + -- Update icon and hotkey text + if ( texture ) then + icon:SetTexture(texture); + icon:Show(); + self:UpdateCount(); + else + self.Count:SetText(""); + icon:Hide(); + ClearActionButtonCooldowns(self.cooldown, self.chargeCooldown, self.lossOfControlCooldown); + local hotkey = self.HotKey; + if ( hotkey:GetText() == RANGE_INDICATOR ) then + hotkey:Hide(); + else + hotkey:SetVertexColor(ACTIONBAR_HOTKEY_FONT_COLOR:GetRGB()); + end + end + + -- Update flyout appearance + self:UpdateFlyout(); + + self:UpdateSpellAlert(); + + -- Update tooltip + if ( GameTooltip:GetOwner() == self ) then + self:SetTooltip(); + end + + self.feedback_action = action; +end + +function ActionBarActionButtonMixin:UpdateHighlightMark() + if ( self.NewActionTexture ) then + self.NewActionTexture:SetShown(GetNewActionHighlightMark(self.action)); -- TODO: Should bindings support this, or should we force SetShown to take a bool? + end +end + +-- Shared between the action bar and the pet bar. +function SharedActionButton_RefreshSpellHighlight(button, shown) + if ( shown ) then + button.SpellHighlightTexture:Show(); + button.SpellHighlightAnim:Play(); + else + button.SpellHighlightTexture:Hide(); + button.SpellHighlightAnim:Stop(); + end +end + +function ActionBarActionButtonMixin:UpdateSpellHighlightMark() + if ( self.SpellHighlightTexture and self.SpellHighlightAnim ) then + SharedActionButton_RefreshSpellHighlight(self, GetOnBarHighlightMark(self.action)); + end +end + +function ActionBarActionButtonMixin:HasAction() + return C_ActionBar.HasAction(self.action); +end + +function ActionBarActionButtonMixin:UpdateState() + local action = self.action; + local isChecked = (C_ActionBar.IsCurrentAction(action) or C_ActionBar.IsAutoRepeatAction(action)) and not C_ActionBar.IsAutoCastPetAction(action); + self:SetChecked(isChecked); +end + +function ActionBarActionButtonMixin:UpdateUsable(action, isUsable, notEnoughMana) + local icon = self.icon; + + assertsafe(action == nil or action == self.action); + if isUsable == nil or notEnoughMana == nil then + isUsable, notEnoughMana = C_ActionBar.IsUsableAction(self.action); + end + if ( isUsable ) then + icon:SetVertexColor(1.0, 1.0, 1.0); + elseif ( notEnoughMana ) then + icon:SetVertexColor(0.5, 0.5, 1.0); + else + icon:SetVertexColor(0.4, 0.4, 0.4); + end + + local isLevelLinkLocked = C_LevelLink and C_LevelLink.IsActionLocked(self.action); + if not icon:IsDesaturated() then + icon:SetDesaturated(isLevelLinkLocked); + end + + if self.LevelLinkLockIcon then + self.LevelLinkLockIcon:SetShown(isLevelLinkLocked); + end + self:EvaluateState(); +end + +function ActionBarActionButtonMixin:EvaluateState() +return; +end + +function ActionBarActionButtonMixin:CreateTextureOverlayFrame() + return CreateFrame("Frame", nil, self, "ActionButtonTextureOverlayTemplate"); +end + +function ActionBarActionButtonMixin:UpdateProfessionQuality() + if C_ActionBar.IsItemAction(self.action) then + local qualityInfo = C_ActionBar.GetProfessionQualityInfo and C_ActionBar.GetProfessionQualityInfo(self.action); + if qualityInfo then + if not self.ProfessionQualityOverlayFrame then + self.ProfessionQualityOverlayFrame = self:CreateTextureOverlayFrame(); + self.ProfessionQualityOverlayFrame:SetPoint("TOPLEFT", 14, -14); + end + + self.ProfessionQualityOverlayFrame:Show(); + self.ProfessionQualityOverlayFrame.Texture:SetAtlas(qualityInfo.iconInventory, TextureKitConstants.UseAtlasSize); + return; + end + end + self:ClearProfessionQuality(); +end + +function ActionBarActionButtonMixin:ClearProfessionQuality() + if self.ProfessionQualityOverlayFrame then + self.ProfessionQualityOverlayFrame:Hide(); + end +end + +function ActionBarActionButtonMixin:GetOrCreateTypeOverlay(atlas) + if not self.TypeIconOverlayFrame then + self.TypeIconOverlayFrame = self:CreateTextureOverlayFrame(); + self.TypeIconOverlayFrame:SetPoint("CENTER", self, "BOTTOM", 0, 3); + self.TypeIconOverlayFrame:SetFrameLevel(self:GetFrameLevel() + 100); + self.TypeIconOverlayFrame.Texture:SetSize(21, 24); + end + + self.TypeIconOverlayFrame.Texture:SetAtlas(atlas, TextureKitConstants.IgnoreAtlasSize); + return self.TypeIconOverlayFrame; +end + +function ActionBarActionButtonMixin:UpdateTypeOverlay() + if self.TypeIconOverlayFrame then + self.TypeIconOverlayFrame:Hide(); + end + + local strategy = GameRulesUtil.GetActionButtonTypeOverlayStrategy(); + if strategy == GameRulesUtil.ActionButtonTypeOverlayStrategy.None then + return; + end + + if strategy == GameRulesUtil.ActionButtonTypeOverlayStrategy.HighlightMana then + local typeOverlayFrameAtlas = "plunderstorm-icon-utility"; + + local actionType, actionID = GetActionInfo(self.action); + if (actionType == "spell") and actionID then + local costTable = C_Spell.GetSpellPowerCost(actionID); + if costTable then + for _i, costInfo in pairs(costTable) do + if costInfo.type == Enum.PowerType.Mana then + typeOverlayFrameAtlas = "plunderstorm-icon-offensive"; + break; + end + end + end + end + + local typeIconOverlayFrame = self:GetOrCreateTypeOverlay(typeOverlayFrameAtlas); + typeIconOverlayFrame:Show(); + elseif strategy == GameRulesUtil.ActionButtonTypeOverlayStrategy.ManaAndEnergy then + local typeOverlayFrameAtlas = nil; + + local actionType, actionID = GetActionInfo(self.action); + if (actionType == "spell") and actionID then + local costTable = C_Spell.GetSpellPowerCost(actionID); + if costTable then + for _i, costInfo in pairs(costTable) do + -- Mana is high priority if a spell costs both. + if costInfo.type == Enum.PowerType.Mana then + typeOverlayFrameAtlas = "plunderstorm-icon-offensive"; + break; + elseif costInfo.type == Enum.PowerType.Energy then + typeOverlayFrameAtlas = "plunderstorm-icon-utility"; + end + end + end + end + + if typeOverlayFrameAtlas then + local typeIconOverlayFrame = self:GetOrCreateTypeOverlay(typeOverlayFrameAtlas); + typeIconOverlayFrame:Show(); + end + end +end + +function ActionBarActionButtonMixin:ClearTypeOverlay() + if self.TypeIconOverlayFrame then + self.TypeIconOverlayFrame:Hide(); + end +end + +function ActionBarActionButtonMixin:UpdateCount() + self.Count:SetText(C_ActionBar.GetActionDisplayCount(self.action, self.maxDisplayCount)); +end + +-- Determine whether cooldowns display countdown numbers for action bar buttons and spell flyout buttons. +function ActionButton_UpdateCooldownNumberHidden(actionButton) + local shouldBeHidden = CVarCallbackRegistry:GetCVarValueBool(countdownForCooldownsCVarName) ~= true; + actionButton.cooldown:SetHideCountdownNumbers(shouldBeHidden); +end + +local defaultCooldownInfo = { startTime = 0; duration = 0; isEnabled = false; modRate = 0 }; +local defaultChargeInfo = { currentCharges = 0; maxCharges = 0; cooldownStartTime = 0; cooldownDuration = 0; chargeModRate = 0 }; +local defaultLossOfControlInfo = { startTime = 0; duration = 0; modRate = 0 }; + +-- Shared between action bar buttons and spell flyout buttons. +function ActionButton_UpdateCooldown(self) + local chargeInfo; + local cooldownInfo; + local lossOfControlInfo = {}; + local actionType, actionID = nil, nil; + if (self.action) then + actionType, actionID = GetActionInfo(self.action); + end + local auraData = nil; + local passiveCooldownSpellID = nil; + local onEquipPassiveSpellID = nil; + + if(actionID) then + onEquipPassiveSpellID = C_ActionBar.GetItemActionOnEquipSpellID(self.action); + end + + if (onEquipPassiveSpellID) then + passiveCooldownSpellID = C_UnitAuras.GetCooldownAuraBySpellID(onEquipPassiveSpellID); + elseif ((actionType and actionType == "spell") and actionID ) then + passiveCooldownSpellID = C_UnitAuras.GetCooldownAuraBySpellID(actionID); + elseif(self.spellID) then + passiveCooldownSpellID = C_UnitAuras.GetCooldownAuraBySpellID(self.spellID); + end + + if(passiveCooldownSpellID and passiveCooldownSpellID ~= 0) then + auraData = C_UnitAuras.GetPlayerAuraBySpellID(passiveCooldownSpellID); + end + + if(auraData) then + local currentTime = GetTime(); + local timeUntilExpire = auraData.expirationTime - currentTime; + local howMuchTimeHasPassed = auraData.duration - timeUntilExpire; + + lossOfControlInfo.startTime = currentTime - howMuchTimeHasPassed; + lossOfControlInfo.duration = auraData.expirationTime - currentTime; + lossOfControlInfo.modRate = auraData.timeMod; + cooldownInfo = {}; + cooldownInfo.startTime = currentTime - howMuchTimeHasPassed; + cooldownInfo.duration = auraData.duration + cooldownInfo.modRate = auraData.timeMod; + cooldownInfo.isEnabled = 1; + chargeInfo = defaultChargeInfo; -- auraData does not contain charge counts + elseif (self.spellID) then + cooldownInfo = C_Spell.GetSpellCooldown(self.spellID) or defaultCooldownInfo; + chargeInfo = C_Spell.GetSpellCharges(self.spellID) or defaultChargeInfo; + + local locStart, locDuration = C_Spell.GetSpellLossOfControlCooldown(self.spellID); + lossOfControlInfo.startTime = locStart; + lossOfControlInfo.duration = locDuration; + lossOfControlInfo.modRate = cooldownInfo.modRate; + else + cooldownInfo = C_ActionBar.GetActionCooldown(self.action); + chargeInfo = C_ActionBar.GetActionCharges(self.action); + + local locStart, locDuration = C_ActionBar.GetActionLossOfControlCooldown(self.action); + lossOfControlInfo.startTime = locStart; + lossOfControlInfo.duration = locDuration; + lossOfControlInfo.modRate = cooldownInfo.modRate; + end + + if not self.enableLOCCooldown then + lossOfControlInfo = defaultLossOfControlInfo; + end + + ActionButton_ApplyCooldown(self.cooldown, cooldownInfo, self.chargeCooldown, chargeInfo, self.lossOfControlCooldown, lossOfControlInfo); +end + +-- Create a pristine instance of Cooldown frame to mitigate potential secret leaks through overwriting methods. +local CooldownPrototype = CreateFrame("Cooldown"); + +-- Secure version of CooldownFrame_Set - manually call methods passing in cooldown as self +local function SecureCooldown_SetOrClear(cooldown, start, duration, enable, modRate) + if enable and enable ~= 0 and start > 0 and duration > 0 then + CooldownPrototype.SetCooldown(cooldown, start, duration, modRate); + else + CooldownPrototype.Clear(cooldown); + end +end + +-- This excessive argument list is required because SecureDelegates will not (and should not) clear taint off values inside of tables. +local function SecureCooldown_ApplyCooldown( + lossOfControlCooldown, + lossOfControlStartTime, + lossOfControlDuration, + lossOfControlModRate, + normalCooldown, + cooldownStartTime, + cooldownDuration, + cooldownIsEnabled, + cooldownModRate, + chargeCooldown, + chargeMaxCharges, + chargeCurrentCharges, + chargeCooldownStartTime, + chargeCooldownDuration, + chargeModRate +) + local showLossOfControlCooldown = (lossOfControlStartTime + lossOfControlDuration) > (cooldownStartTime + cooldownDuration); + local showChargeCooldown = not showLossOfControlCooldown and chargeMaxCharges > 1 and chargeCurrentCharges < chargeMaxCharges; + local showNormalCooldown = not showLossOfControlCooldown and cooldownDuration > 0 and cooldownIsEnabled; + + if lossOfControlCooldown then + SecureCooldown_SetOrClear(lossOfControlCooldown, lossOfControlStartTime, lossOfControlDuration, showLossOfControlCooldown, lossOfControlModRate); + end + SecureCooldown_SetOrClear(chargeCooldown, chargeCooldownStartTime, chargeCooldownDuration, showChargeCooldown, chargeModRate); + SecureCooldown_SetOrClear(normalCooldown, cooldownStartTime, cooldownDuration, showNormalCooldown, cooldownModRate); +end +local SecureCooldown_ApplyCooldownDelegate = CreateSecureDelegate(SecureCooldown_ApplyCooldown); + +function ActionButton_ApplyCooldown(normalCooldown, cooldownInfo, chargeCooldown, chargeInfo, lossOfControlCooldown, lossOfControlInfo) + cooldownInfo = cooldownInfo or defaultCooldownInfo; + chargeInfo = chargeInfo or defaultChargeInfo; + lossOfControlInfo = lossOfControlInfo or defaultLossOfControlInfo; + + SecureCooldown_ApplyCooldownDelegate( + lossOfControlCooldown, + lossOfControlInfo.startTime, + lossOfControlInfo.duration, + lossOfControlInfo.modRate, + normalCooldown, + cooldownInfo.startTime, + cooldownInfo.duration, + cooldownInfo.isEnabled, + cooldownInfo.modRate, + chargeCooldown, + chargeInfo.maxCharges, + chargeInfo.currentCharges, + chargeInfo.cooldownStartTime, + chargeInfo.cooldownDuration, + chargeInfo.chargeModRate + ); +end + +function ClearActionButtonCooldowns(normalCooldown, chargeCooldown, lossOfControlCooldown) + CooldownPrototype.Clear(normalCooldown); + CooldownPrototype.Clear(chargeCooldown); + if lossOfControlCooldown then + CooldownPrototype.Clear(lossOfControlCooldown); + end +end + +function ActionBarActionButtonMixin:UpdateSpellAlert() + local spellType, id, subType = GetActionInfo(self.action); + + local show = (spellType == "spell" or spellType == "macro") and C_SpellActivationOverlay.IsSpellOverlayed(id); + if show then + ActionButtonSpellAlertManager:ShowAlert(self); + else + ActionButtonSpellAlertManager:HideAlert(self); + end + + self:EvaluateTutorials(spellType, id); +end + +function ActionBarActionButtonMixin:UpdateAssistedCombatRotationFrame() + local show = C_ActionBar.IsAssistedCombatAction(self.action); + local assistedCombatRotationFrame = self.AssistedCombatRotationFrame; + -- create frame if needed + if show and not assistedCombatRotationFrame then + assistedCombatRotationFrame = CreateFrame("Frame", nil, self, "ActionBarButtonAssistedCombatRotationTemplate"); + self.AssistedCombatRotationFrame = assistedCombatRotationFrame; + end + + if assistedCombatRotationFrame then + assistedCombatRotationFrame:UpdateState(); + end +end + +-- Override as needed +function ActionBarActionButtonMixin:EvaluateTutorials(spellType, id) +end + +ActionBarOverlayGlowAnimInMixin = {};--- @class ActionBarOverlayGlowAnimInMixin + +function ActionBarOverlayGlowAnimInMixin:OnPlay() + local frame = self:GetParent(); + local frameWidth, frameHeight = frame:GetSize(); + frame.spark:SetSize(frameWidth, frameHeight); + frame.spark:SetAlpha(0.3); + frame.innerGlow:SetSize(frameWidth / 2, frameHeight / 2); + frame.innerGlow:SetAlpha(1.0); + frame.innerGlowOver:SetAlpha(1.0); + frame.outerGlow:SetSize(frameWidth * 2, frameHeight * 2); + frame.outerGlow:SetAlpha(1.0); + frame.outerGlowOver:SetAlpha(1.0); + frame.ants:SetSize(frameWidth * 0.85, frameHeight * 0.85) + frame.ants:SetAlpha(0); + frame:Show(); +end + +function ActionBarOverlayGlowAnimInMixin:OnFinished() + local frame = self:GetParent(); + local frameWidth, frameHeight = frame:GetSize(); + frame.spark:SetAlpha(0); + frame.innerGlow:SetAlpha(0); + frame.innerGlow:SetSize(frameWidth, frameHeight); + frame.innerGlowOver:SetAlpha(0.0); + frame.outerGlow:SetSize(frameWidth, frameHeight); + frame.outerGlowOver:SetAlpha(0.0); + frame.outerGlowOver:SetSize(frameWidth, frameHeight); + frame.ants:SetAlpha(1.0); +end + +ActionButtonInterruptAnimInMixin = {};--- @class ActionButtonInterruptAnimInMixin +function ActionButtonInterruptAnimInMixin:OnFinished() + self:GetParent():GetParent():Hide(); +end + +function ActionBarActionButtonMixin:MatchesActiveButtonSpellID(spellID) + if(not spellID) then + return false; + end + + local actionType, id, subType = GetActionInfo(self.action); + if actionType == "item" then + id = C_ActionBar.GetSpell(self.action); + end + return id == spellID; +end + +function ActionBarActionButtonMixin:RegisterActionBarButtonCheckFrames(action) + ActionBarButtonRangeCheckFrame:RegisterFrame(action, self); + ActionBarButtonUsableWatcherFrame:RegisterFrame(action, self); +end + +function ActionBarActionButtonMixin:UnregisterActionBarButtonCheckFrames(action) + ActionBarButtonRangeCheckFrame:UnregisterFrame(action, self); + ActionBarButtonUsableWatcherFrame:UnregisterFrame(action, self); +end + +function ActionBarActionButtonMixin:OnEvent(event, ...) + local arg1 = ...; + if ((event == "UNIT_INVENTORY_CHANGED" and arg1 == "player") or event == "LEARNED_SPELL_IN_SKILL_LINE") then + if ( GameTooltip:GetOwner() == self ) then + self:SetTooltip(); + end + elseif ( event == "ACTIONBAR_SLOT_CHANGED" ) then + if ( arg1 == 0 or arg1 == tonumber(self.action) ) then + ClearNewActionHighlight(self.action, true); + self:UpdateAction(true); + end + elseif ( event == "PLAYER_ENTERING_WORLD" ) then + self:Update(); + elseif ( event == "UPDATE_SHAPESHIFT_FORM" ) then + -- need to listen for UPDATE_SHAPESHIFT_FORM because attack icons change when the shapeshift form changes + -- This is NOT intended to update everything about shapeshifting; most stuff should be handled by ActionBar-specific events such as UPDATE_BONUS_ACTIONBAR, UPDATE_USABLE, etc. + local texture = C_ActionBar.GetActionTexture(self.action); + if (texture) then + self.icon:SetTexture(texture); + end + elseif ( event == "UPDATE_BINDINGS" or event == "GAME_PAD_ACTIVE_CHANGED" ) then + self:UpdateHotkeys(self.buttonType); + -- All event handlers below this line are only set when the button has an action + elseif ( event == "UNIT_FLAGS" or event == "UNIT_AURA" or event == "PET_BAR_UPDATE" ) then + -- Pet actions can also change the state of action buttons. + self.flashDirty = true; + self.stateDirty = true; + self:CheckNeedsUpdate(); + elseif ( (event == "ACTIONBAR_UPDATE_STATE") or + ((event == "UNIT_ENTERED_VEHICLE" or event == "UNIT_EXITED_VEHICLE") and (arg1 == "player")) or + ((event == "COMPANION_UPDATE") and (arg1 == "MOUNT")) ) then + self:UpdateState(); + elseif ( event == "PLAYER_MOUNT_DISPLAY_CHANGED" ) then + self:UpdateUsable(); + elseif ( event == "LOSS_OF_CONTROL_UPDATE" ) then + ActionButton_UpdateCooldown(self); + elseif ( event == "ACTIONBAR_UPDATE_COOLDOWN" or event == "LOSS_OF_CONTROL_ADDED" ) then + ActionButton_UpdateCooldown(self); + -- Update tooltip + if ( GameTooltip:GetOwner() == self ) then + self:SetTooltip(); + end + elseif ( event == "TRADE_SKILL_SHOW" or event == "TRADE_SKILL_CLOSE" or event == "ARCHAEOLOGY_CLOSED" ) then + self:UpdateState(); + elseif ( event == "PLAYER_ENTER_COMBAT" ) then + if ( C_ActionBar.IsAttackAction(self.action) ) then + self:StartFlash(); + end + elseif ( event == "PLAYER_LEAVE_COMBAT" ) then + if ( C_ActionBar.IsAttackAction(self.action) ) then + self:StopFlash(); + end + elseif ( event == "START_AUTOREPEAT_SPELL" ) then + if ( C_ActionBar.IsAutoRepeatAction(self.action) ) then + self:StartFlash(); + end + elseif ( event == "STOP_AUTOREPEAT_SPELL" ) then + if ( self:IsFlashing() and not C_ActionBar.IsAttackAction(self.action) ) then + self:StopFlash(); + end + elseif ( event == "PET_STABLE_UPDATE" or event == "PET_STABLE_SHOW") then + -- Has to update everything for now, but this event should happen infrequently + self:Update(); + elseif ( event == "SPELL_ACTIVATION_OVERLAY_GLOW_SHOW" ) then + local actionType, id, subType = GetActionInfo(self.action); + if ( actionType == "spell" and id == arg1 ) then + ActionButtonSpellAlertManager:ShowAlert(self); + elseif ( actionType == "macro" and subType == "spell" ) then + if ( id == arg1 ) then + ActionButtonSpellAlertManager:ShowAlert(self); + end + elseif (actionType == "flyout" and FlyoutHasSpell(id, arg1)) then + ActionButtonSpellAlertManager:ShowAlert(self); + end + elseif ( event == "SPELL_ACTIVATION_OVERLAY_GLOW_HIDE" ) then + local actionType, id, subType = GetActionInfo(self.action); + if ( actionType == "spell" and id == arg1 ) then + ActionButtonSpellAlertManager:HideAlert(self); + elseif ( actionType == "macro" and subType == "spell" ) then + if (id == arg1 ) then + ActionButtonSpellAlertManager:HideAlert(self); + end + elseif (actionType == "flyout" and FlyoutHasSpell(id, arg1)) then + ActionButtonSpellAlertManager:HideAlert(self); + end + elseif ( event == "SPELL_UPDATE_CHARGES" ) then + self:UpdateCount(); + elseif ( event == "UPDATE_SUMMONPETS_ACTION" ) then + local actionType, id = GetActionInfo(self.action); + if (actionType == "summonpet") then + local texture = C_ActionBar.GetActionTexture(self.action); + if (texture) then + self.icon:SetTexture(texture); + end + end + elseif ( event == "SPELL_UPDATE_ICON" ) then + self:Update(); + elseif ( event == "ACTION_RANGE_CHECK_UPDATE" ) then + local inRange, checksRange = select(2, ...); + ActionButton_UpdateRangeIndicator(self, checksRange, inRange); + elseif (event == "UNIT_SPELLCAST_INTERRUPTED") then + self:PlaySpellInterruptedAnim(); + elseif (event == "UNIT_SPELLCAST_START") then + self:PlaySpellCastAnim(ActionButtonCastType.Cast); + elseif (event == "UNIT_SPELLCAST_STOP") then + self:StopSpellCastAnim(true, ActionButtonCastType.Cast); + self:StopTargettingReticleAnim(); + elseif(event == "UNIT_SPELLCAST_SUCCEEDED") then + self:StopSpellCastAnim(false, ActionButtonCastType.Cast); + self:StopTargettingReticleAnim(); + elseif(event == "UNIT_SPELLCAST_SENT" or event == "UNIT_SPELLCAST_FAILED") then + self:StopTargettingReticleAnim(); + elseif (event == "UNIT_SPELLCAST_EMPOWER_START") then + self:PlaySpellCastAnim(ActionButtonCastType.Empowered); + elseif(event == "UNIT_SPELLCAST_EMPOWER_STOP") then + local _, _, _, castComplete = ...; + local interrupted = not castComplete; + if(interrupted) then + self:PlaySpellInterruptedAnim(); + else + self:StopSpellCastAnim(interrupted, ActionButtonCastType.Empowered); + end + elseif (event == "UNIT_SPELLCAST_CHANNEL_START") then + self:PlaySpellCastAnim(ActionButtonCastType.Channel); + elseif (event == "UNIT_SPELLCAST_CHANNEL_STOP") then + self:StopSpellCastAnim(false, ActionButtonCastType.Channel); + elseif (event == "UNIT_SPELLCAST_RETICLE_TARGET") then + self:PlayTargettingReticleAnim(); + elseif (event == "UNIT_SPELLCAST_RETICLE_CLEAR") then + self:StopTargettingReticleAnim(); + elseif event == "AssistedCombatManager.OnSetActionSpell" then + self:UpdateAssistedCombatRotationFrame(); + end +end + +function ActionBarActionButtonMixin:SetTooltip() + local inQuickKeybind = KeybindFrames_InQuickKeybindMode(); + if ( GetCVar("UberTooltips") == "1" or inQuickKeybind ) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + if ( self.bar and (self.bar == MultiBarBottomRight or self.bar == MultiBarRight or self.bar == MultiBarLeft) ) then + GameTooltip:SetOwner(self, "ANCHOR_LEFT"); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + end + if ( GameTooltip:SetAction(self.action) ) then + self.UpdateTooltip = self.SetTooltip; + else + self.UpdateTooltip = nil; + end +end + +function ActionBarActionButtonMixin:CheckNeedsUpdate() + local needsUpdate = (self.stateDirty or self.flashDirty or self:IsFlashing()) and self:IsVisible(); + if (needsUpdate ~= self.needsUpdate) then + if needsUpdate then + ActionBarButtonUpdateFrame:RegisterFrame(self); + else + ActionBarButtonUpdateFrame:UnregisterFrame(self); + end + self.needsUpdate = needsUpdate; + end +end + +function ActionBarActionButtonMixin:OnUpdate(elapsed) + if ( self.stateDirty ) then + self:UpdateState(); + self.stateDirty = nil; + end + + if ( self.flashDirty ) then + self:UpdateFlash(); + self.flashDirty = nil; + end + + if ( self:IsFlashing() ) then + local flashtime = self.flashtime; + flashtime = flashtime - elapsed; + + if ( flashtime <= 0 ) then + local overtime = -flashtime; + if ( overtime >= ATTACK_BUTTON_FLASH_TIME ) then + overtime = 0; + end + flashtime = ATTACK_BUTTON_FLASH_TIME - overtime; + + local flashTexture = self.Flash; + if ( flashTexture:IsShown() ) then + flashTexture:Hide(); + else + flashTexture:Show(); + end + end + + self.flashtime = flashtime; + end + + self:CheckNeedsUpdate(); +end + +function ActionBarActionButtonMixin:OnShow() + self:CheckNeedsUpdate(); + if self.action then + self:Update(); + self:RegisterActionBarButtonCheckFrames(self.action); + end +end + +function ActionBarActionButtonMixin:OnHide() + self:CheckNeedsUpdate(); + if self.action then + self:UnregisterActionBarButtonCheckFrames(self.action); + end +end + +function ActionBarActionButtonMixin:SpellFXEnabled() + return self.enableSpellFX; +end + +function ActionBarActionButtonMixin:ClearReticle() + if (not self:SpellFXEnabled()) then + return; + end + + if(self.TargetReticleAnimFrame:IsShown()) then + self.TargetReticleAnimFrame:Hide(); + end +end + +function ActionBarActionButtonMixin:ClearInterruptDisplay() + if (not self:SpellFXEnabled()) then + return; + end + + if(self.InterruptDisplay:IsShown()) then + self.InterruptDisplay:Hide(); + end +end + +function ActionBarActionButtonMixin:PlaySpellCastAnim(actionButtonCastType) + if (not self:SpellFXEnabled()) then + return; + end + + self.cooldown:SetSwipeColor(0, 0, 0, 0); + self.hideCooldownFrame = true; + self:ClearInterruptDisplay(); + self:ClearReticle(); + self.SpellCastAnimFrame:Setup(actionButtonCastType); + self.actionButtonCastType = actionButtonCastType; +end + +function ActionBarActionButtonMixin:PlayTargettingReticleAnim() + if (not self:SpellFXEnabled()) then + return; + end + + if(self.InterruptDisplay:IsShown()) then + self.InterruptDisplay:Hide(); + end + if not C_ActionBar.IsAssistedCombatAction(self.action) then + self.TargetReticleAnimFrame:Setup(); + end +end + +function ActionBarActionButtonMixin:StopTargettingReticleAnim() + if (not self:SpellFXEnabled()) then + return; + end + + if (self.TargetReticleAnimFrame:IsShown()) then + self.TargetReticleAnimFrame:Hide(); + end +end + +function ActionBarActionButtonMixin:StopSpellCastAnim(forceStop, actionButtonCastType) + if (not self:SpellFXEnabled()) then + return; + end + + self:StopTargettingReticleAnim(); + + if (self.actionButtonCastType == actionButtonCastType) then + if(forceStop) then + self.SpellCastAnimFrame:Hide(); + elseif(self.SpellCastAnimFrame.Fill.CastingAnim:IsPlaying()) then + self.SpellCastAnimFrame:FinishAnimAndPlayBurst(); + end + self.actionButtonCastType = nil; + end +end + +function ActionBarActionButtonMixin:PlaySpellInterruptedAnim() + if (not self:SpellFXEnabled()) then + return; + end + + self:StopSpellCastAnim(true, self.actionButtonCastType); + --Hide if it's already showing to clear the anim. + if(self.InterruptDisplay:IsShown()) then + self.InterruptDisplay:Hide(); + end + self.InterruptDisplay:Show(); +end + +-- Shared between the action bar and the pet bar. +function ActionButton_UpdateRangeIndicator(self, checksRange, inRange) + if ( self.HotKey:GetText() == RANGE_INDICATOR ) then + if ( checksRange ) then + self.HotKey:Show(); + if ( inRange ) then + self.HotKey:SetVertexColor(ACTIONBAR_HOTKEY_FONT_COLOR:GetRGB()); + else + self.HotKey:SetVertexColor(RED_FONT_COLOR:GetRGB()); + end + else + self.HotKey:Hide(); + end + else + if ( checksRange and not inRange ) then + self.HotKey:SetVertexColor(RED_FONT_COLOR:GetRGB()); + else + self.HotKey:SetVertexColor(ACTIONBAR_HOTKEY_FONT_COLOR:GetRGB()); + end + end +end + +function ActionBarActionButtonMixin:GetPagedID() + return self.action; +end + +function ActionBarActionButtonMixin:UpdateFlash() + local action = self.action; + local actionType, actionID, actionSubtype = GetActionInfo(action); + + if ( (C_ActionBar.IsAttackAction(action) and C_ActionBar.IsCurrentAction(action)) or C_ActionBar.IsAutoRepeatAction(action) ) then + self:StartFlash(); + + if ( actionSubtype == "pet" ) then + self:GetCheckedTexture():SetAlpha(0.5); + else + self:GetCheckedTexture():SetAlpha(1.0); + end + else + self:StopFlash(); + end + + if ( self.AutoCastOverlay ) then + -- Outfit actions. + local isLockedOutfit = actionType == "outfit" and C_TransmogOutfitInfo.IsLockedOutfit(actionID); + local isLockedEquippedGear = C_ActionBar.IsEquippedGearOutfitAction(action) and C_TransmogOutfitInfo.IsEquippedGearOutfitLocked(); + + -- Pet actions. + local isAutoCastPetAction = C_ActionBar.IsAutoCastPetAction(action); + local isEnabledAutoCastPetAction = C_ActionBar.IsEnabledAutoCastPetAction(action); + + self.AutoCastOverlay:SetShown(isLockedOutfit or isLockedEquippedGear or isAutoCastPetAction); + self.AutoCastOverlay:ShowAutoCastEnabled(isLockedOutfit or isLockedEquippedGear or isEnabledAutoCastPetAction); + end +end + +function ActionBarActionButtonMixin:ClearFlash() + if ( self.AutoCastOverlay ) then + self.AutoCastOverlay:ShowAutoCastEnabled(false); + self.AutoCastOverlay:Hide(); + end +end + +function ActionBarActionButtonMixin:StartFlash() + self.flashing = 1; + self.flashtime = 0; + self:UpdateState(); + self:CheckNeedsUpdate(); +end + +function ActionBarActionButtonMixin:StopFlash() + self.flashing = 0; + self.Flash:Hide(); + self:UpdateState(); + self:CheckNeedsUpdate(); +end + +function ActionBarActionButtonMixin:IsFlashing() + if ( self.flashing == 1 ) then + return 1; + end + + return nil; +end + +-- Shared between action bar buttons and spell flyout buttons +function ActionBarActionButtonMixin:UpdateFlyout(isButtonDownOverride) + BaseActionButtonMixin.UpdateFlyout(self, isButtonDownOverride); +end + +function ActionBarActionButtonMixin:SetButtonStateOverride(state) + self:SetButtonStateBase(state); +end + +function ActionBarActionButtonMixin:OnClick(button, down) + if ( KeybindFrames_InQuickKeybindMode() ) then + local cursorType = GetCursorInfo(); + if ( cursorType ) then + local slotID = self:CalculateAction(button); + C_ActionBar.PutActionInSlot(slotID); + end + else + if button == "RightButton" and C_ActionBar.IsAutoCastPetAction(self.action) then + if not down then + C_ActionBar.ToggleAutoCastPetAction(self.action); + end + else + local actionBarLocked = Settings.GetValue("lockActionBars"); + + local isModifiedClickLockedBarDoNothing = IsModifiedClick("PICKUPACTION"); + if GetCursorInfo() then + -- If we have something on the cursor then we don't care whether it was a modified click + -- as far as lockedBarDoNothing goes + isModifiedClickLockedBarDoNothing = false; + end + + local lockedBarDoNothing = actionBarLocked and down and isModifiedClickLockedBarDoNothing; + local unlockedBarDoNothing = not actionBarLocked and (self:GetAttribute("pressAndHoldAction") and down); + if lockedBarDoNothing or unlockedBarDoNothing then + return; + end + + local isKeyPress = false; + local isSecureAction = true; + SecureActionButton_OnClick(self, button, down, isKeyPress, isSecureAction); + end + end +end + +function ActionBarActionButtonMixin:OnDragStart() + if ( not Settings.GetValue("lockActionBars") or IsModifiedClick("PICKUPACTION") ) then + -- If an IconSelectorPopupFrame is active, we do not want to remove the action from the bar, just copy it to the mouse. + local ignoreActionRemoval = IsAnyIconSelectorPopupFrameShown(); + PickupAction(self.action, ignoreActionRemoval); + + SpellFlyout:Hide(); + self:UpdateState(); + self:UpdateFlash(); + end +end + +function ActionBarActionButtonMixin:OnReceiveDrag() + PlaceAction(self.action); + self:UpdateState(); + self:UpdateFlash(); +end + +function ActionBarActionButtonMixin:OnEnter() + if (self.NewActionTexture) then + ClearNewActionHighlight(self.action); + self:UpdateAction(true); + end + self:SetTooltip(); + ActionBarButtonEventsFrame.tooltipOwner = self; + ActionBarActionEventsFrame.tooltipOwner = self; + if self.bindingAction then + ActionButtonBindingHighlightCallbackRegistry:TriggerEvent(self.bindingAction, true); + end +end + +function ActionBarActionButtonMixin:OnLeave() + GameTooltip:Hide(); + ActionBarButtonEventsFrame.tooltipOwner = nil; + ActionBarActionEventsFrame.tooltipOwner = nil; + if self.bindingAction then + ActionButtonBindingHighlightCallbackRegistry:TriggerEvent(self.bindingAction, false); + end +end + + +-- Can be overridden by ActionButtonOverrides. +ActionBarButtonEventsDerivedFrameMixin = CreateFromMixins(ActionBarButtonEventsFrameMixin);--- @class ActionBarButtonEventsDerivedFrameMixin : ActionBarButtonEventsFrameMixin +ActionBarActionButtonDerivedMixin = CreateFromMixins(ActionBarActionButtonMixin);--- @class ActionBarActionButtonDerivedMixin : ActionBarActionButtonMixin + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnLoad() + ActionBarActionButtonMixin.OnLoad(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnAttributeChanged() + ActionBarActionButtonMixin.OnAttributeChanged(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnEvent(event, ...) + ActionBarActionButtonMixin.OnEvent(self, event, ...); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnClick(button, down) + ActionBarActionButtonMixin.OnClick(self, button, down); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnClick(self, button, down); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnPostClick() + ActionBarActionButtonMixin.UpdateState(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnDragStart() + ActionBarActionButtonMixin.OnDragStart(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnReceiveDrag() + ActionBarActionButtonMixin.OnReceiveDrag(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnDragStop() + +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnEnter() + ActionBarActionButtonMixin.OnEnter(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnEnter(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnLeave() + ActionBarActionButtonMixin.OnLeave(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnLeave(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnShow() + ActionBarActionButtonMixin.OnShow(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnShow(self); +end + +function ActionBarActionButtonDerivedMixin:ActionBarActionButtonDerivedMixin_OnHide() + ActionBarActionButtonMixin.OnHide(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnHide(self); +end + + +BaseActionButtonMixin = {}--- @class BaseActionButtonMixin + +function BaseActionButtonMixin:BaseActionButtonMixin_OnLoad() + FlyoutButtonMixin.OnLoad(self); + + self:UpdateButtonArt(); + self:UpdateFlyout(); + + self.NormalTexture:SetDrawLayer("OVERLAY"); + self.PushedTexture:SetDrawLayer("OVERLAY"); +end + +function BaseActionButtonMixin:BaseActionButtonMixin_OnEnter() + FlyoutButtonMixin.OnEnter(self); +end + +function BaseActionButtonMixin:BaseActionButtonMixin_OnLeave() + FlyoutButtonMixin.OnLeave(self); +end + +function BaseActionButtonMixin:BaseActionButtonMixin_OnDragStart() + FlyoutButtonMixin.OnDragStart(self); +end + +function BaseActionButtonMixin:BaseActionButtonMixin_OnAttributeChanged(name, value) + self:UpdateFlyout(); +end + +function BaseActionButtonMixin:GetShowGrid() + local showGridAttribute = self:GetAttribute("showgrid"); + return showGridAttribute and showGridAttribute > 0 or false; +end + +function BaseActionButtonMixin:SetShowGrid(showGrid, reason) + assert(reason); + + if ( issecure() and self:GetShowGrid() ~= showGrid ) then + local showGridAttribute = self:GetAttribute("showgrid"); + if ( showGrid ) then + self:SetAttribute("showgrid", bit.bor(showGridAttribute or 0, reason)); + else + self:SetAttribute("showgrid", bit.band(showGridAttribute or 0, bit.bnot(reason))); + end + end +end + +function BaseActionButtonMixin:UpdateButtonArt() + -- Overridden for various game flavors. +end + +-- Shared between action bar buttons and spell flyout buttons +function BaseActionButtonMixin:UpdateFlyout(isButtonDownOverride) + if not self.HasPopup then + return; + end + + -- Attempt to resolve the action on this button to a flyout, either by + -- having the secure "type" attribute explicitly set to "flyout" or by + -- configuring it as a regular "action" with a slot ID that itself holds + -- a flyout. + -- + -- This is intended to support case where a button inherits from a + -- fully-featured button template such as ActionBarButtonTemplate, or + -- a barebones combo of ActionButtonTemplate + SecureActionButtonTemplate. + + local effectiveButton = SecureButton_GetEffectiveButton(self); + local popupDirection = SecureButton_GetModifiedAttribute(self, "flyoutDirection", effectiveButton); + local actionType = SecureButton_GetModifiedAttribute(self, "type", effectiveButton); + + if actionType == nil or actionType == "action" then + local slotID; + + if self.CalculateAction then + slotID = self:CalculateAction(); + else + slotID = self.action; + end + + if slotID then + actionType = GetActionInfo(slotID); + end + end + + -- If an explicit popup direction hasn't been supplied and the button is on an action bar then use the direction from the action bar. + if not popupDirection and self.bar then + popupDirection = self.bar:GetSpellFlyoutDirection(); + end + + -- FlyoutButtonMixin stores the direction of the popout on a field + -- on the button itself, which needs securely updating from the value + -- stored in the attribute if defined. + + if popupDirection then + self:SetPopupDirection(popupDirection); + end + + if actionType == "flyout" and SpellFlyout then + self:SetPopup(SpellFlyout); + else + self:ClearPopup(); + end +end + +ActionBarButtonMixin = {};--- @class ActionBarButtonMixin + +function ActionBarButtonMixin:ActionBarButtonMixin_OnLoad() + BaseActionButtonMixin.BaseActionButtonMixin_OnLoad(self); + ActionBarActionButtonDerivedMixin.ActionBarActionButtonDerivedMixin_OnLoad(self); +end + +function ActionBarButtonMixin:ActionBarButtonMixin_OnEnter() + BaseActionButtonMixin.BaseActionButtonMixin_OnEnter(self); + ActionBarActionButtonDerivedMixin.ActionBarActionButtonDerivedMixin_OnEnter(self); +end + +function ActionBarButtonMixin:ActionBarButtonMixin_OnLeave() + BaseActionButtonMixin.BaseActionButtonMixin_OnLeave(self); + ActionBarActionButtonDerivedMixin.ActionBarActionButtonDerivedMixin_OnLeave(self); +end + +function ActionBarButtonMixin:ActionBarButtonMixin_OnDragStart() + BaseActionButtonMixin.BaseActionButtonMixin_OnDragStart(self); + ActionBarActionButtonDerivedMixin.ActionBarActionButtonDerivedMixin_OnDragStart(self); +end + +SmallActionButtonMixin = {}--- @class SmallActionButtonMixin + +function SmallActionButtonMixin:SmallActionButtonMixin_OnLoad() + BaseActionButtonMixin.BaseActionButtonMixin_OnLoad(self); + + self.HotKey:ClearAllPoints(); + self.HotKey:SetPoint("TOPRIGHT", self.hotkeyX or 0, self.hotkeyY or 0); + + self.Count:ClearAllPoints(); + self.Count:SetPoint("BOTTOMRIGHT", self, "BOTTOMRIGHT", -3, 1); + + self.IconMask:SetSize(45, 45); + + self.AutoCastOverlay:SetSize(31, 31); + self.AutoCastOverlay:ClearAllPoints(); + self.AutoCastOverlay:SetPoint("CENTER", 0.5, -0.5); + + self.HighlightTexture:SetSize(31.6, 30.9); + self.CheckedTexture:SetSize(31.6, 30.9); + + if self.QuickKeybindHighlightTexture then + self.QuickKeybindHighlightTexture:ClearAllPoints(); + self.QuickKeybindHighlightTexture:SetPoint("CENTER"); + self.QuickKeybindHighlightTexture:SetSize(31.6, 30.9); + end + + self.NewActionTexture:SetSize(31.6, 30.9); + self.SpellHighlightTexture:SetSize(31.6, 30.9); + self.Border:SetSize(31.6, 30.9); + self.Flash:SetSize(31.6, 30.9); + + self.cooldown:ClearAllPoints(); + self.cooldown:SetPoint("TOPLEFT", self.icon, "TOPLEFT", 1.7, -1.7); + self.cooldown:SetPoint("BOTTOMRIGHT", self.icon, "BOTTOMRIGHT", -1, 1); +end + +function SmallActionButtonMixin:UpdateButtonArt() + BaseActionButtonMixin.UpdateButtonArt(self); + + -- Gotta set these texture sizes here since BaseActionButtonMixin.UpdateButtonArt changes their size + self.NormalTexture:SetSize(35, 35); + self.PushedTexture:SetSize(35, 35); +end + +ActionButtonInterruptFrameMixin = { };--- @class ActionButtonInterruptFrameMixin + +function ActionButtonInterruptFrameMixin:OnShow() + self.Base.AnimIn:Play(); + self.Highlight.AnimIn:Play(); +end + +function ActionButtonInterruptFrameMixin:OnHide() + self.Base.AnimIn:Stop(); + self.Highlight.AnimIn:Stop(); +end + +ActionButtonCastingAnimFrameMixin = { };--- @class ActionButtonCastingAnimFrameMixin + +function ActionButtonCastingAnimFrameMixin:Setup(actionButtonCastType) + local startTime, endTime, totalTimeInSeconds; + + local isChannelCast = actionButtonCastType == ActionButtonCastType.Channel; + local isEmpoweredCast = actionButtonCastType == ActionButtonCastType.Empowered; + local _; + if (isChannelCast or isEmpoweredCast) then + _, _, _, startTime, endTime = UnitChannelInfo("player"); + else + _, _, _, startTime, endTime = UnitCastingInfo("player"); + end + + self.EndBurst:Hide(); + + local fillFrame = self.Fill; + fillFrame.CastFill:ClearAllPoints(); + local castingAnim = self.Fill.CastingAnim; + local finishCastAnim = self.EndBurst.FinishCastAnim; + + castingAnim:Stop(); + finishCastAnim:Stop(); + if (isChannelCast) then + fillFrame.CastFill:SetAtlas("UI-HUD-ActionBar-Channel-Fill", true); + fillFrame.InnerGlowTexture:SetAtlas("UI-HUD-ActionBar-Channel-InnerGlow", true); + fillFrame.CastFill:SetPoint("CENTER", 45, 0); + fillFrame.CastingAnim.CastFillTranslation:SetOffset(-43, 0); + else + fillFrame.CastFill:SetAtlas("UI-HUD-ActionBar-Cast-Fill", true); + fillFrame.InnerGlowTexture:SetAtlas("UI-HUD-ActionBar-Casting-InnerGlow", true); + fillFrame.CastFill:SetPoint("CENTER", -45, 0); + fillFrame.CastingAnim.CastFillTranslation:SetOffset(43, 0); + end + + if not isEmpoweredCast and (not startTime or not endTime) then + + totalTimeInSeconds = 0; + else + totalTimeInSeconds = (endTime - startTime) / 1000; + end + + castingAnim.CastFillTranslation:SetDuration(totalTimeInSeconds); + castingAnim:Play(); + self:Show(); +end + +function ActionButtonCastingAnimFrameMixin:OnHide() + local parent = self:GetParent(); + parent:ClearReticle(); + parent.cooldown:SetSwipeColor(0, 0, 0, 1); + ActionButton_UpdateCooldown(parent); +end + +function ActionButtonCastingAnimFrameMixin:FinishAnimAndPlayBurst() + self.Fill.CastingAnim:Stop(); + self.Fill.CastingAnim:OnFinished(); +end + +ActionButtonCastingAnimationFillMixin = { };--- @class ActionButtonCastingAnimationFillMixin + +function ActionButtonCastingAnimationFillMixin:OnFinished() + local endBurst = self:GetParent():GetParent().EndBurst; + endBurst:Show(); + endBurst.FinishCastAnim:Play(); +end + +ActionButtonCastingFinishAnimMixin = { };--- @class ActionButtonCastingFinishAnimMixin +function ActionButtonCastingFinishAnimMixin:OnFinished() + self:GetParent():GetParent():Hide(); + local parentButton = self:GetParent():GetParent():GetParent(); + self:GetParent():GetParent():GetParent():StopSpellCastAnim(false, parentButton.actionButtonCastType); +end + +ActionButtonTargetReticleFrameMixin = { };--- @class ActionButtonTargetReticleFrameMixin +function ActionButtonTargetReticleFrameMixin:Setup() + self.HighlightAnim:Play(); + self:Show(); +end + +ActionButtonCooldownFlashMixin = { };--- @class ActionButtonCooldownFlashMixin +function ActionButtonCooldownFlashMixin:Setup() + self.FlashAnim:Play(); + self:Show(); +end + +ActionButtonCooldownFlashAnimMixin = { };--- @class ActionButtonCooldownFlashAnimMixin +function ActionButtonCooldownFlashAnimMixin:OnFinished() + self:GetParent():Hide(); +end + +-- This is done to preserve old hierarchy, while allowing for proper layering of the HotKey text +ActionButtonTextOverlayContainerMixin = {};--- @class ActionButtonTextOverlayContainerMixin +function ActionButtonTextOverlayContainerMixin:OnLoad() + local parentActionButton = self:GetParent(); + parentActionButton.HotKey = self.HotKey; + parentActionButton.Count = self.Count; +end + +ActionBarButtonAssistedCombatRotationFrameMixin = { };--- @class ActionBarButtonAssistedCombatRotationFrameMixin + +function ActionBarButtonAssistedCombatRotationFrameMixin:OnLoad() + local actionButton = self:GetParent(); + local frameWidth, frameHeight = actionButton:GetSize(); + self:SetSize(frameWidth * 1.4, frameHeight * 1.4); + self:SetPoint("CENTER", actionButton, "CENTER", -2, 1); + + if MainActionBar then + self:SetFrameLevel(MainActionBar:GetEndCapsFrameLevel() + 1); + end + + self.updateTimeLeft = 0; + + self:RegisterEvent("PLAYER_ENTERING_WORLD"); +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:OnShow() + self:RegisterEvent("PLAYER_REGEN_ENABLED"); + self:RegisterEvent("PLAYER_REGEN_DISABLED"); + + self:UpdateGlow(); + self:EvaluateTutorials(); +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:OnHide() + self:UnregisterEvent("PLAYER_REGEN_ENABLED"); + self:UnregisterEvent("PLAYER_REGEN_DISABLED"); +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:OnEvent(event) + if event == "PLAYER_ENTERING_WORLD" then + self:SetFrameLevel(MainActionBar:GetEndCapsFrameLevel() + 1); + -- action bars go through setup on PEW too so this needs to wait + RunNextFrame(function() + -- gotta check since we're doing things out of order now + if self:IsShown() then + self:EvaluateTutorials(); + end + end); + self:UnregisterEvent("PLAYER_ENTERING_WORLD"); + elseif event == "ASSISTED_COMBAT_ACTION_SPELL_CAST" then + HelpTip:Acknowledge(UIParent, ASSISTED_COMBAT_ROTATION_ACTION_BUTTON_HELPTIP); + self:UnregisterEvent("ASSISTED_COMBAT_ACTION_SPELL_CAST"); + else + self:UpdateGlow(); + end +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:OnUpdate(elapsed) + self.updateTimeLeft = self.updateTimeLeft - elapsed; + if self.updateTimeLeft <= 0 then + local actionButton = self:GetParent(); + C_ActionBar.ForceUpdateAction(actionButton.action); + self.updateTimeLeft = AssistedCombatManager:GetUpdateRate(); + end +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:UpdateState() + local actionButton = self:GetParent(); + local show = C_ActionBar.IsAssistedCombatAction(actionButton.action); + local isShown = self:IsShown(); + if show ~= isShown then + self:SetShown(show); + EventRegistry:TriggerEvent("ActionButton.OnAssistedCombatRotationFrameChanged", actionButton, show); + end +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:UpdateGlow() + local affectingCombat = UnitAffectingCombat("player"); + if affectingCombat then + self.InactiveTexture:Hide(); + self.ActiveFrame:Show(); + self.ActiveFrame.GlowAnim:Play(); + else + self.InactiveTexture:Show(); + self.ActiveFrame:Hide(); + end +end + +function ActionBarButtonAssistedCombatRotationFrameMixin:EvaluateTutorials() + local actionButton = self:GetParent(); + if not actionButton.bar then + return; + end + + if GetCVarBitfield("closedInfoFramesAccountWide", Enum.FrameTutorialAccount.AssistedCombatRotationActionButton) then + return; + end + + -- the action spell can be dragged to multiple action buttons + HelpTip:Hide(UIParent, ASSISTED_COMBAT_ROTATION_ACTION_BUTTON_HELPTIP); + + local targetPoint = HelpTip.Point.TopEdgeCenter; + local offsetX = 0; + local offsetY = -8; + + local direction = actionButton.bar:GetSpellFlyoutDirection(); + if direction == "DOWN" then + targetPoint = HelpTip.Point.BottomEdgeCenter; + offsetX = 0; + offsetY = 8; + elseif direction == "LEFT" then + targetPoint = HelpTip.Point.LeftEdgeCenter; + offsetX = 8; + offsetY = 0; + elseif direction == "RIGHT" then + targetPoint = HelpTip.Point.RightEdgeCenter; + offsetX = -8; + offsetY = 0; + end + + local helpTipInfo = { + text = ASSISTED_COMBAT_ROTATION_ACTION_BUTTON_HELPTIP, + buttonStyle = HelpTip.ButtonStyle.Close, + cvarBitfield = "closedInfoFramesAccountWide", + bitfieldFlag = Enum.FrameTutorialAccount.AssistedCombatRotationActionButton, + targetPoint = targetPoint, + offsetX = offsetX, + offsetY = offsetY, + system = helptipSystem, + autoHideWhenTargetHides = true, + }; + HelpTip:Show(UIParent, helpTipInfo, self); + + self:RegisterEvent("ASSISTED_COMBAT_ACTION_SPELL_CAST"); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml new file mode 100644 index 0000000..f511f31 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml @@ -0,0 +1,337 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml.annotated.lua new file mode 100644 index 0000000..07fbcbd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml.annotated.lua @@ -0,0 +1,166 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L3) +--- Template +--- @class ActionBarFlyoutButton_IconFrame : Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L50) +--- child of ActionBarButtonAssistedCombatRotationTemplate_ActiveFrame +--- @class ActionBarButtonAssistedCombatRotationTemplate_ActiveFrame_GlowAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L19) +--- child of ActionBarButtonAssistedCombatRotationTemplate +--- @class ActionBarButtonAssistedCombatRotationTemplate_ActiveFrame : Frame +--- @field Border Texture +--- @field Glow Texture +--- @field Mask MaskTexture +--- @field GlowAnim ActionBarButtonAssistedCombatRotationTemplate_ActiveFrame_GlowAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L8) +--- Template +--- @class ActionBarButtonAssistedCombatRotationTemplate : Frame, ActionBarButtonAssistedCombatRotationFrameMixin +--- @field ActiveFrame ActionBarButtonAssistedCombatRotationTemplate_ActiveFrame +--- @field InactiveTexture Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L80) +--- child of ActionBarButtonAssistedCombatHighlightTemplate_Flipbook +--- @class ActionBarButtonAssistedCombatHighlightTemplate_Flipbook_Anim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L74) +--- child of ActionBarButtonAssistedCombatHighlightTemplate +--- @class ActionBarButtonAssistedCombatHighlightTemplate_Flipbook : Texture +--- @field Anim ActionBarButtonAssistedCombatHighlightTemplate_Flipbook_Anim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L67) +--- Template +--- @class ActionBarButtonAssistedCombatHighlightTemplate : Frame +--- @field Flipbook ActionBarButtonAssistedCombatHighlightTemplate_Flipbook + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L89) +--- @class ActionBarButtonEventsFrame : Frame, ActionBarButtonEventsDerivedFrameMixin +ActionBarButtonEventsFrame = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L96) +--- @class ActionBarActionEventsFrame : Frame, ActionBarActionEventsFrameMixin +ActionBarActionEventsFrame = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L103) +--- @class ActionBarButtonUpdateFrame : Frame, ActionBarButtonUpdateFrameMixin +ActionBarButtonUpdateFrame = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L110) +--- @class ActionBarButtonRangeCheckFrame : Frame, ActionBarButtonRangeCheckFrameMixin +ActionBarButtonRangeCheckFrame = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L117) +--- @class ActionBarButtonUsableWatcherFrame : Frame, ActionBarButtonUsableWatcherFrameMixin +ActionBarButtonUsableWatcherFrame = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L124) +--- Template +--- @class ActionButtonTextureOverlayTemplate : Frame +--- @field Texture Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L170) +--- child of ActionButtonCastingAnimFrameTemplate_Fill +--- @class ActionButtonCastingAnimFrameTemplate_Fill_CastingAnim : AnimationGroup, ActionButtonCastingAnimationFillMixin +--- @field CastFillTranslation Translation + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L142) +--- child of ActionButtonCastingAnimFrameTemplate +--- @class ActionButtonCastingAnimFrameTemplate_Fill : Frame +--- @field InnerGlowTexture Texture +--- @field CastFill Texture +--- @field FillMask MaskTexture +--- @field CastingAnim ActionButtonCastingAnimFrameTemplate_Fill_CastingAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L203) +--- child of ActionButtonCastingAnimFrameTemplate_EndBurst +--- @class ActionButtonCastingAnimFrameTemplate_EndBurst_FinishCastAnim : AnimationGroup, ActionButtonCastingFinishAnimMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L180) +--- child of ActionButtonCastingAnimFrameTemplate +--- @class ActionButtonCastingAnimFrameTemplate_EndBurst : Frame +--- @field GlowRing Texture +--- @field EndMask MaskTexture +--- @field FinishCastAnim ActionButtonCastingAnimFrameTemplate_EndBurst_FinishCastAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L136) +--- Template +--- @class ActionButtonCastingAnimFrameTemplate : Frame, ActionButtonCastingAnimFrameMixin +--- @field Fill ActionButtonCastingAnimFrameTemplate_Fill +--- @field EndBurst ActionButtonCastingAnimFrameTemplate_EndBurst + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L246) +--- child of ActionButtonTargetReticleFrameTemplate +--- @class ActionButtonTargetReticleFrameTemplate_HighlightAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L216) +--- Template +--- @class ActionButtonTargetReticleFrameTemplate : Frame, ActionButtonTargetReticleFrameMixin +--- @field Base Texture +--- @field Highlight Texture +--- @field Mask MaskTexture +--- @field HighlightAnim ActionButtonTargetReticleFrameTemplate_HighlightAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L278) +--- child of ActionButtonInterruptTemplate_Highlight +--- @class ActionButtonInterruptTemplate_Highlight_AnimIn : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L255) +--- child of ActionButtonInterruptTemplate +--- @class ActionButtonInterruptTemplate_Highlight : Frame +--- @field HighlightTexture Texture +--- @field Mask MaskTexture +--- @field AnimIn ActionButtonInterruptTemplate_Highlight_AnimIn + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L298) +--- child of ActionButtonInterruptTemplate_Base +--- @class ActionButtonInterruptTemplate_Base_AnimIn : AnimationGroup, ActionButtonInterruptAnimInMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L283) +--- child of ActionButtonInterruptTemplate +--- @class ActionButtonInterruptTemplate_Base : Frame +--- @field Base Texture +--- @field AnimIn ActionButtonInterruptTemplate_Base_AnimIn + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L253) +--- Template +--- @class ActionButtonInterruptTemplate : Frame, ActionButtonInterruptFrameMixin +--- @field Highlight ActionButtonInterruptTemplate_Highlight +--- @field Base ActionButtonInterruptTemplate_Base + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L323) +--- child of ActionButtonCooldownFlashTemplate +--- @class ActionButtonCooldownFlashTemplate_FlashAnim : AnimationGroup, ActionButtonCooldownFlashAnimMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L312) +--- Template +--- @class ActionButtonCooldownFlashTemplate : Frame, ActionButtonCooldownFlashMixin +--- @field Flipbook Texture +--- @field FlashAnim ActionButtonCooldownFlashTemplate_FlashAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L330) +--- child of ActionButtonSpellFXTemplate +--- @class ActionButtonSpellFXTemplate_InterruptDisplay : Frame, ActionButtonInterruptTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L331) +--- child of ActionButtonSpellFXTemplate +--- @class ActionButtonSpellFXTemplate_SpellCastAnimFrame : Frame, ActionButtonCastingAnimFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L332) +--- child of ActionButtonSpellFXTemplate +--- @class ActionButtonSpellFXTemplate_TargetReticleAnimFrame : Frame, ActionButtonTargetReticleFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L333) +--- child of ActionButtonSpellFXTemplate +--- @class ActionButtonSpellFXTemplate_CooldownFlash : Frame, ActionButtonCooldownFlashTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonComponentTemplate.xml#L328) +--- Template +--- @class ActionButtonSpellFXTemplate : CheckButton +--- @field InterruptDisplay ActionButtonSpellFXTemplate_InterruptDisplay +--- @field SpellCastAnimFrame ActionButtonSpellFXTemplate_SpellCastAnimFrame +--- @field TargetReticleAnimFrame ActionButtonSpellFXTemplate_TargetReticleAnimFrame +--- @field CooldownFlash ActionButtonSpellFXTemplate_CooldownFlash + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.lua.annotated.lua new file mode 100644 index 0000000..0220a6f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.lua.annotated.lua @@ -0,0 +1,145 @@ +ActionButtonSpellAlertManager = { + activeAlerts = { }; -- tracks which buttons have alerts + SpellAlertType = EnumUtil.MakeEnum( + "Default", + "AssistedCombatRotation" + ); +}; + +local self = ActionButtonSpellAlertManager; + +local function GetAlertFrame(actionButton, create) + local alertType = self.activeAlerts[actionButton]; + local frame; + if alertType == self.SpellAlertType.Default then + frame = actionButton.SpellActivationAlert; + if not frame and create then + frame = CreateFrame("Frame", nil, actionButton, "ActionButtonSpellAlertTemplate"); + actionButton.SpellActivationAlert = frame; + local frameWidth, frameHeight = actionButton:GetSize(); + actionButton.SpellActivationAlert:SetSize(frameWidth * 1.4, frameHeight * 1.4); + actionButton.SpellActivationAlert:SetPoint("CENTER", actionButton, "CENTER", 0, 0); + end + elseif alertType == self.SpellAlertType.AssistedCombatRotation then + local assistedCombatRotationFrame = actionButton.AssistedCombatRotationFrame; + frame = assistedCombatRotationFrame.SpellActivationAlert; + if not frame and create then + frame = CreateFrame("Frame", nil, assistedCombatRotationFrame, "ActionButtonSpellAlertTemplate"); + assistedCombatRotationFrame.SpellActivationAlert = frame; + frame:SetAllPoints(); + -- replace textures + frame.ProcStartFlipbook:SetAtlas("OneButton_ProcStart_Flipbook"); + frame.ProcLoopFlipbook:SetAtlas("OneButton_ProcLoop_Flipbook"); + end + end + return frame; +end + +-- Spell alerts for buttons on normal action bars should use the altGlow instead if any +-- action bar has an AssistedCombatRotation action, as players should be focusing on that. +-- The alert for an AssistedCombatRotation action button still uses the regular anim. +local function CheckAndSetArtStyle(actionButton) + local alertType = self.activeAlerts[actionButton]; + if alertType == self.SpellAlertType.AssistedCombatRotation then + return; + end + + if not actionButton.bar or not actionButton.bar.isNormalBar then + return; + end + + local alertFrame = GetAlertFrame(actionButton); + if not alertFrame then + assertsafe(false, "Missing spell alert frame for %s", actionButton:GetDebugName()); + return; + end + + if AssistedCombatManager:ShouldDowngradeSpellAlertForButton(actionButton) then + alertFrame.ProcStartFlipbook:Hide(); + alertFrame.ProcLoopFlipbook:Hide(); + alertFrame.ProcAltGlow:Show(); + else + alertFrame.ProcStartFlipbook:Show(); + alertFrame.ProcLoopFlipbook:Show(); + alertFrame.ProcAltGlow:Hide(); + end +end + +local function HideAlert(actionButton) + local alertFrame = GetAlertFrame(actionButton); + if not alertFrame then + assertsafe(false, "Missing spell alert frame for %s", actionButton:GetDebugName()); + return; + end + + alertFrame:Hide(); + alertFrame.ProcStartAnim:Stop(); + self.activeAlerts[actionButton] = nil; +end + +local function ShowAlert(actionButton, alertType) + -- if there is an alert already, it must be a different type so hide it + if self.activeAlerts[actionButton] then + HideAlert(actionButton); + end + + self.activeAlerts[actionButton] = alertType; + local create = true; + local alertFrame = GetAlertFrame(actionButton, create); + alertFrame:Show(); + CheckAndSetArtStyle(actionButton); + alertFrame.ProcStartAnim:Play(); +end + +do + local function RefreshArtStyles() + self.useAltGlow = C_ActionBar.HasAssistedCombatActionButtons(); + for actionButton, alertType in pairs(self.activeAlerts) do + CheckAndSetArtStyle(actionButton); + end + end + EventRegistry:RegisterCallback("ActionButton.OnAssistedCombatRotationFrameChanged", RefreshArtStyles); + EventRegistry:RegisterCallback("AssistedCombatManager.OnAssistedHighlightSpellChange", RefreshArtStyles); + EventRegistry:RegisterCallback("AssistedCombatManager.OnSetUseAssistedHighlight", RefreshArtStyles); + EventRegistry:RegisterCallback("AssistedCombatManager.RotationSpellsUpdated", RefreshArtStyles); +end + +-- public functions + +function ActionButtonSpellAlertManager:ShowAlert(actionButton) + local currentAlertType = self.activeAlerts[actionButton]; + local alertType = self.SpellAlertType.Default; + if actionButton.action and C_ActionBar.IsAssistedCombatAction(actionButton.action) then + alertType = self.SpellAlertType.AssistedCombatRotation; + end + if currentAlertType ~= alertType then + ShowAlert(actionButton, alertType); + end +end + +function ActionButtonSpellAlertManager:HideAlert(actionButton) + local currentAlertType = self.activeAlerts[actionButton]; + if currentAlertType then + HideAlert(actionButton, alertType); + end +end + +function ActionButtonSpellAlertManager:HasAlert(actionButton) + local alertType = self.activeAlerts[actionButton]; + local hasAlert = not not alertType; + return hasAlert, alertType; +end + +ActionButtonSpellAlertMixin = {};--- @class ActionButtonSpellAlertMixin + +function ActionButtonSpellAlertMixin:OnLoad() + self.ProcStartAnim:SetScript("OnFinished", function() + self.ProcLoop:Play(); + end); +end + +function ActionButtonSpellAlertMixin:OnHide() + if self.ProcLoop:IsPlaying() then + self.ProcLoop:Stop(); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml new file mode 100644 index 0000000..bc19fbf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml.annotated.lua new file mode 100644 index 0000000..0bd0ad6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml.annotated.lua @@ -0,0 +1,20 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml#L22) +--- child of ActionButtonSpellAlertTemplate +--- @class ActionButtonSpellAlertTemplate_ProcLoop : AnimationGroup +--- @field FlipAnim FlipBook + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml#L27) +--- child of ActionButtonSpellAlertTemplate +--- @class ActionButtonSpellAlertTemplate_ProcStartAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ActionButtonSpellAlerts.xml#L4) +--- Template +--- @class ActionButtonSpellAlertTemplate : Frame, ActionButtonSpellAlertMixin +--- @field ProcStartFlipbook Texture +--- @field ProcLoopFlipbook Texture +--- @field ProcAltGlow Texture +--- @field ProcLoop ActionButtonSpellAlertTemplate_ProcLoop +--- @field ProcStartAnim ActionButtonSpellAlertTemplate_ProcStartAnim + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonUtil.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonUtil.lua.annotated.lua new file mode 100644 index 0000000..c3ba1ca --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ActionButtonUtil.lua.annotated.lua @@ -0,0 +1,368 @@ +CURRENT_ACTIONBAR_PAGE = 1; +NUM_ACTIONBAR_PAGES = 6; +NUM_ACTIONBAR_BUTTONS = 12; +NUM_OVERRIDE_BUTTONS = 6; +NUM_SPECIAL_BUTTONS = 10; + +-- Table of action bar pages and whether they're viewable or not +VIEWABLE_ACTION_BAR_PAGES = {1, 1, 1, 1, 1, 1}; + +ActionButtonUtil = {}; + +ActionButtonUtil.ActionBarActionStatus = { + NotMissing = 1, -- Action is either Passive, unlearned, or is on an active bar + MissingFromAllBars = 2, -- Not on any action bar + OnInactiveBonusBar = 3, -- On a bar belonging to a different stance + OnDisabledActionBar = 4, -- On a bar that's been disabled via settings +}; + +ActionButtonUtil.ActionBarType = { + MainActionBar = 1, + MultiActionBar = 2, + StanceBar = 3, + PetBar = 4, + PossessActionBar = 5, + BonusBar = 6, + VehicleBar = 16, + TempShapeshiftBar = 17, + OverrideBar = 18, +}; + +ActionButtonUtil.ActionBarButtonNames = { + "ActionButton", + "MultiBarBottomLeftButton", + "MultiBarBottomRightButton", + "MultiBarLeftButton", + "MultiBarRightButton", + "MultiBar5Button", + "MultiBar6Button", + "MultiBar7Button", +}; + +function ActionButtonUtil.ShowAllActionButtonGrids() + MainActionBar:SetShowGrid(true, ACTION_BUTTON_SHOW_GRID_REASON_EVENT); + MultiActionBar_ShowAllGrids(ACTION_BUTTON_SHOW_GRID_REASON_EVENT); +end + +function ActionButtonUtil.HideAllActionButtonGrids() + MainActionBar:SetShowGrid(false, ACTION_BUTTON_SHOW_GRID_REASON_EVENT); + MultiActionBar_HideAllGrids(ACTION_BUTTON_SHOW_GRID_REASON_EVENT); +end + +function ActionButtonUtil.SetAllQuickKeybindButtonHighlights(show) + -- Override me! +end + +function ActionButtonUtil.ShowAllQuickKeybindButtonHighlights() + ActionButtonUtil.SetAllQuickKeybindButtonHighlights(true); +end + +function ActionButtonUtil.HideAllQuickKeybindButtonHighlights() + ActionButtonUtil.SetAllQuickKeybindButtonHighlights(false); +end + +-- Calculates page number for provided action bar slot index +function ActionButtonUtil.GetPageForSlot(slot) + return math.floor((slot - 1) / NUM_ACTIONBAR_BUTTONS) + 1; +end + +-- Returns true if spell is currently slotted into any active Action Bar +-- See GetActionBarsForSpell for what constitutes active vs inactive +-- excludeNonPlayerBars = [BOOLEAN] -- Skips bars whose spells are not owned by the player (ex Pet, Possess, Vehicle, etc) (Default: false) +-- excludeSpecialPlayerBars = [BOOLEAN] -- Skips bars whose spells are owned by the player but not set by them (ie Stance) (Default: false) +function ActionButtonUtil.IsSpellOnAnyActiveActionBar(spellID, excludeNonPlayerBars, excludeSpecialPlayerBars) + local barsWithSpell = ActionButtonUtil.GetActionBarsForSpell(spellID, excludeNonPlayerBars, excludeSpecialPlayerBars); + if not barsWithSpell then + return false; + end + + for _, barEntry in pairs(barsWithSpell) do + if barEntry.isActive then + return true; + end + end + + return false; +end + +--[[ +-- Returns all action bars the spell is slotted into, their bar type, and their active status +-- excludeNonPlayerBars = [BOOLEAN] -- Skips bars whose spells are not owned by the player (ex Pet, Possess, Vehicle, etc) (Default: false) +-- excludeSpecialPlayerBars = [BOOLEAN] -- Skips bars whose spells are owned by the player but not set by them (ie Stance) (Default: false) +-- Bar types: +-- MainActionBar: Active if not hidden by OverrideBar AND (page 1 is not overriden by a special bar OR spell is on a page other than page 1) +-- MultiActionBar: Active if not disabled via Action Bar settings +-- StanceBar: Active if loaded and currently shown +-- PetBar: Active if loaded and currently shown +-- PossessActionBar: Active if loaded and currently shown +-- BonusBar: Active if specific bonus bar is actively overriding first page of MainActionBar, usually meaning player is in stance that bar belongs to +-- VehicleBar: Active if loaded and currently shown, either through OverrideBar or overriding first page of MainActionBar +-- TempShapeshiftBar: Active if loaded and currently shown as overriding first page of MainActionBar +-- OverrideBar = Active if loaded and currently shown, either through OverrideBar or overriding first page of MainActionBar +--]] +function ActionButtonUtil.GetActionBarsForSpell(spellID, excludeNonPlayerBars, excludeSpecialPlayerBars) + local bars = {}; + + -- First, get all action bar slots this spell is in, then we can determine which bars those slots are part of + local playerActionBarSlots = C_ActionBar.FindSpellActionButtons(spellID); + if playerActionBarSlots ~= nil then + ActionButtonUtil.AddPlayerActionBarsContainingSlots(playerActionBarSlots, bars, excludeNonPlayerBars); + end + + -- FindSpellActionButtons does not cover special bars like Stance and Pet bars, so now check those + if not excludeSpecialPlayerBars then + if StanceBar then + for i = 1, NUM_SPECIAL_BUTTONS do + local stanceBtn = StanceBar.actionButtons[i]; + local stanceSpellID = select(4, GetShapeshiftFormInfo(stanceBtn:GetID())); + if stanceSpellID == spellID then + bars["stance"] = {barFrame = StanceBar:GetName(), barType = ActionButtonUtil.ActionBarType.StanceBar, isActive = StanceBar:IsShown()}; + break; + end + end + end + end + if not excludeNonPlayerBars then + if PetActionBar then + -- C_ActionBar.GetPetActionPetBarIndices works with PetAction actionIDs, not their spellIDs, so can't use that here + for i = 1, NUM_SPECIAL_BUTTONS do + local petSpellID = select(7, GetPetActionInfo(i)); + if petSpellID == spellID then + bars["pet"] = {barFrame = PetActionBar:GetName(), barType = ActionButtonUtil.ActionBarType.PetBar, isActive = PetActionBar:IsShown()}; + break; + end + end + end + if PossessActionBar then + for i = 1, NUM_POSSESS_SLOTS do + local possessSpellID = select(2, GetPossessInfo(i)); + if possessSpellID == spellID then + bars["possess"] = {barFrame = PossessActionBar:GetName(), barType = ActionButtonUtil.ActionBarType.PossessActionBar, isActive = PossessActionBar:IsShown()}; + break; + end + end + end + end + + return not TableIsEmpty(bars) and bars or nil; +end + +--[[ +-- Returns all action bars the PetAction is slotted into, their bar type, and their active status +-- See ActionButtonUtil.GetActionBarsForSpell for a breakdown of how active status is determined per bar type +-- ]] +function ActionButtonUtil.GetActionBarsForPetAction(actionID) + local bars = {}; + + local playerActionBarSlots = C_ActionBar.FindPetActionButtons(actionID); + if playerActionBarSlots ~= nil then + local excludeNonPlayerBars = false; + ActionButtonUtil.AddPlayerActionBarsContainingSlots(playerActionBarSlots, bars, excludeNonPlayerBars); + end + + local petActionBarSlots = C_ActionBar.GetPetActionPetBarIndices(actionID); + if petActionBarSlots then + bars["pet"] = {barFrame = PetActionBar:GetName(), barType = ActionButtonUtil.ActionBarType.PetBar, isActive = PetActionBar:IsShown()}; + end + + return not TableIsEmpty(bars) and bars or nil; +end + +--[[ +-- Returns all action bars the Flyout is slotted into, their bar type, and their active status +-- See ActionButtonUtil.GetActionBarsForSpell for a breakdown of how active status is determined per bar type +-- ]] +function ActionButtonUtil.GetActionBarsForFlyout(actionID) + local bars = {}; + + local playerActionBarSlots = C_ActionBar.FindFlyoutActionButtons(actionID); + if playerActionBarSlots ~= nil then + local excludeNonPlayerBars = false; + ActionButtonUtil.AddPlayerActionBarsContainingSlots(playerActionBarSlots, bars, excludeNonPlayerBars); + end + + return not TableIsEmpty(bars) and bars or nil; +end + +function ActionButtonUtil.AddPlayerActionBarsContainingSlots(slots, bars, excludeNonPlayerBars) + -- Pre-retrieve page numbers for various override bars + local vehicleBarPage = C_ActionBar.GetVehicleBarIndex(); + local overrideBarPage = C_ActionBar.GetOverrideBarIndex(); + local tempShapeshiftBarPage = C_ActionBar.GetTempShapeshiftBarIndex(); + local currentBonusBarIndex = C_ActionBar.GetBonusBarIndex(); + + local isMainActionBarActive = ActionBarController_GetCurrentActionBarState() == LE_ACTIONBAR_STATE_MAIN; + local isMainActionBarDefaultFirstPageActive = isMainActionBarActive and not (C_ActionBar.HasBonusActionBar() or C_ActionBar.HasOverrideActionBar() or C_ActionBar.HasVehicleActionBar() or C_ActionBar.HasTempShapeshiftActionBar()); + + for _, slot in ipairs(slots) do + -- First, calculate the page for slot index, then we can find the bar using that page + local page = ActionButtonUtil.GetPageForSlot(slot); + if not bars[page] then + local barEntry = nil; + local multiActionBar = MultiActionBar_GetBarForPage(page); + + -- MultiActionBars + if multiActionBar then + barEntry = { + barFrame = multiActionBar:GetName(), + barType = ActionButtonUtil.ActionBarType.MultiActionBar, + isActive = multiActionBar:IsShown() -- ActionBar IsShown is overriden to reflect whether it is disabled via settings + }; + -- Various Override bars + elseif not excludeNonPlayerBars and (page == vehicleBarPage or page == overrideBarPage or page == tempShapeshiftBarPage) then + if OverrideActionBar and OverrideActionBar:IsShown() then + barEntry = {barFrame = OverrideActionBar:GetName(), isActive = true}; + else + barEntry = {barFrame = MainActionBar:GetName(), isActive = isMainActionBarActive}; + end + + if page == vehicleBarPage then + barEntry.barType = ActionButtonUtil.ActionBarType.VehicleBar; + elseif page == overrideBarPage then + barEntry.barType = ActionButtonUtil.ActionBarType.OverrideBar; + elseif page == tempShapeshiftBarPage then + barEntry.barType = ActionButtonUtil.ActionBarType.TempShapeshiftBar; + end + else + -- Bonus Bar + local slotBonusBarIndex = C_ActionBar.GetBonusBarIndexForSlot(slot); + if slotBonusBarIndex then + barEntry = { + barFrame = MainActionBar:GetName(), + barType = ActionButtonUtil.ActionBarType.BonusBar, + isActive = slotBonusBarIndex == currentBonusBarIndex -- Mismatched bonus bar indices likely means we're in a different stance + }; + -- Default Primary Action Bar + elseif VIEWABLE_ACTION_BAR_PAGES[page] == 1 then + barEntry = { + barFrame = MainActionBar:GetName(), + barType = ActionButtonUtil.ActionBarType.MainActionBar, + isActive = page ~= 1 or isMainActionBarDefaultFirstPageActive + }; + end + end + + if barEntry then + bars[page] = barEntry; + end + end + end +end + +-- Returns first ActionButton frame found containing the provided spell +-- excludeNonPlayerBars = [BOOLEAN] -- Skips bars whose spells are not owned by the player (ex Pet, Possess, Vehicle, etc) (Default: false) +-- excludeSpecialPlayerBars = [BOOLEAN] -- Skips bars whose spells are owned by the player but not set by them (ie Stance) (Default: false) +function ActionButtonUtil.GetActionButtonBySpellID(spellID, excludeNonPlayerBars, excludeSpecialPlayerBars) + if type(spellID) ~= "number" then + return nil; + end + + for _, actionBar in ipairs(ActionButtonUtil.ActionBarButtonNames) do + for i = 1, NUM_ACTIONBAR_BUTTONS do + local btn = _G[actionBar..i]; + local _, actionSpellID = GetActionInfo(btn.action); + + if actionSpellID == spellID then + return btn; + end + end + end + + if not excludeSpecialPlayerBars then + for i = 1, NUM_SPECIAL_BUTTONS do + -- Stance Bar buttons + local stanceBtn = StanceBar.actionButtons[i]; + local stanceSpellID = select(4, GetShapeshiftFormInfo(stanceBtn:GetID())); + if stanceSpellID == spellID then + return stanceBtn; + end + end + end + + if not excludeNonPlayerBars then + for i = 1, NUM_SPECIAL_BUTTONS do + -- Pet Bar buttons + local petBtn = PetActionBar.actionButtons[i]; + local petSpellID = select(7, GetPetActionInfo(i)); + if petSpellID == spellID then + return petBtn; + end + end + + if PossessActionBar then + for i = 1, NUM_POSSESS_SLOTS do + local possessButton = PossessActionBar.actionButtons[i]; + local possessSpellID = select(2, GetPossessInfo(i)); + if possessSpellID == spellID then + return possessButton; + end + end + end + end + + return nil; +end + +-- Determine a standard action bar "status" based on the status of bars a spell is on, if any +function ActionButtonUtil.GetActionBarStatusForSpell(spellID, excludeNonPlayerBars, excludeSpecialPlayerBars) + if not spellID or C_Spell.IsSpellPassive(spellID) then + return ActionButtonUtil.ActionBarActionStatus.NotMissing; + end + + local barsWithSpell = ActionButtonUtil.GetActionBarsForSpell(spellID, excludeNonPlayerBars, excludeSpecialPlayerBars); + + return ActionButtonUtil.GetActionBarStatusFromBars(barsWithSpell); +end + +-- Determine a standard action bar "status" based on the status of bars a spell is on, if any +function ActionButtonUtil.GetActionBarStatusForPetAction(petActionID) + if not petActionID or C_PetInfo.IsPetActionPassive(petActionID) then + return ActionButtonUtil.ActionBarActionStatus.NotMissing; + end + + local barsWithPetAction = ActionButtonUtil.GetActionBarsForPetAction(petActionID); + + return ActionButtonUtil.GetActionBarStatusFromBars(barsWithPetAction); +end + +-- Determine a standard action bar "status" based on the status of bars a spell is on, if any +function ActionButtonUtil.GetActionBarStatusForFlyout(flyoutActionID) + if not flyoutActionID then + return ActionButtonUtil.ActionBarActionStatus.NotMissing; + end + + local barsWithFlyout = ActionButtonUtil.GetActionBarsForFlyout(flyoutActionID); + + return ActionButtonUtil.GetActionBarStatusFromBars(barsWithFlyout); +end + +function ActionButtonUtil.GetActionBarStatusFromBars(barsWithAction) + if not barsWithAction then + return ActionButtonUtil.ActionBarActionStatus.MissingFromAllBars; + end + + -- Evaluate whether bars are active, and if not, what type of inactive bar + local isOnInactiveBonusBar, isOnDisabledBar = false, false; + for _, barEntry in pairs(barsWithAction) do + if barEntry.isActive then + return ActionButtonUtil.ActionBarActionStatus.NotMissing; + end + + -- Inactive MultiActionBar means bar is disabled in settings + if barEntry.barType == ActionButtonUtil.ActionBarType.MultiActionBar then + isOnDisabledBar = true; + -- Inactive Bonus Bar means bar belongs to a different stance + elseif barEntry.barType == ActionButtonUtil.ActionBarType.BonusBar then + isOnInactiveBonusBar = true; + end + end + + -- Action being on a disabled bar for all stances takes priority over being on another stance's bar + if isOnDisabledBar then + return ActionButtonUtil.ActionBarActionStatus.OnDisabledActionBar; + elseif isOnInactiveBonusBar then + return ActionButtonUtil.ActionBarActionStatus.OnInactiveBonusBar; + else + return ActionButtonUtil.ActionBarActionStatus.MissingFromAllBars; + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExpBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExpBar.lua.annotated.lua new file mode 100644 index 0000000..40cee2c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExpBar.lua.annotated.lua @@ -0,0 +1,197 @@ + +ExpBarMixin = {};--- @class ExpBarMixin + +function ExpBarMixin:GetMaxLevel() + -- Timerunners levels can go above the purchased max level to the max current expansion level + return GameRulesUtil.GetEffectiveMaxLevelForPlayer(); +end + +function ExpBarMixin:IsCapped() + if GameLimitedMode_IsBankedXPActive() then + local restrictedLevel = GameLimitedMode_GetLevelLimit(); + return UnitLevel("player") >= restrictedLevel; + end + + return false; +end + +function ExpBarMixin:GetLevelData() + local currXP = self:IsCapped() and UnitTrialXP("player") or UnitXP("player"); + local nextXP = UnitXPMax("player"); + local level = UnitLevel("player"); + local bankedLevels = UnitTrialBankedLevels("player"); + + return currXP, nextXP, level, bankedLevels; +end + +function ExpBarMixin:Update() + local level; + self.currXP, self.maxBar, level = self:GetLevelData(); + if self:IsCapped() then + local isRested = false; + self:UpdateStatusBarTextures(isRested); + + self:SetBarValues(1, 0, 1, level, self:GetMaxLevel()); + else + local minBar = 0; + self:SetBarValues(self.currXP, minBar, self.maxBar, level, self:GetMaxLevel()); + end + + self:UpdateCurrentText(); +end + +function ExpBarMixin:UpdateCurrentText() + -- Override me! +end + +function ExpBarMixin:OnLoad() + self.StatusBar:InitializeTextStatusBar(); + + self:Update(); + + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("PLAYER_XP_UPDATE"); + self:RegisterEvent("CVAR_UPDATE"); +end + +function ExpBarMixin:OnEvent(event, ...) + if( event == "CVAR_UPDATE") then + local cvar = ...; + if( cvar == "xpBarText" ) then + self:UpdateTextVisibility(); + end + elseif ( event == "PLAYER_XP_UPDATE" or event == "PLAYER_ENTERING_WORLD" ) then + self:Update(); + end +end + +function ExpBarMixin:OnShow() + self:UpdateTextVisibility(); +end + +function ExpBarMixin:OnEnter() + self.StatusBar:UpdateTextString(); + self:ShowText(); + self:UpdateCurrentText(); + + if GameLimitedMode_IsBankedXPActive() then + local rLevel = GetRestrictedAccountData(); + if UnitLevel("player") >= rLevel then + local trialXP = UnitTrialXP("player"); + if trialXP > 0 and IsTrialAccount() then + MicroButtonPulse(StoreMicroButton); + end + end + end + + self.ExhaustionTick:ExhaustionToolTipText(); +end + +function ExpBarMixin:OnLeave() + self:HideText(); + GameTooltip:Hide(); +end + +function ExpBarMixin:OnValueChanged() + if ( not self:IsShown() ) then + return; + end + self:Update(); +end + +function ExpBarMixin:UpdateTick() + self.ExhaustionTick:UpdateTickPosition(); + self.ExhaustionTick:UpdateExhaustionColor(); +end + +function ExpBarMixin:UpdateStatusBarTextures(isRested) + -- Override me! +end + +ExhaustionTickMixin = {};--- @class ExhaustionTickMixin + +function ExhaustionTickMixin:ExhaustionToolTipText() + -- Override me! +end + +function ExhaustionTickMixin:OnLoad() + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("PLAYER_XP_UPDATE"); + self:RegisterEvent("UPDATE_EXHAUSTION"); + self:RegisterEvent("PLAYER_LEVEL_UP"); + self:RegisterEvent("PLAYER_UPDATE_RESTING"); +end + +function ExhaustionTickMixin:UpdateTickPosition() + local playerCurrXP = UnitXP("player"); + local playerMaxXP = UnitXPMax("player"); + local exhaustionThreshold = GetXPExhaustion(); + local exhaustionStateID = GetRestState(); + + if ( exhaustionStateID and exhaustionStateID >= 3 ) then + self:SetPoint("CENTER", self:GetParent() , "RIGHT", 0, 0); + end + + if ( not exhaustionThreshold or exhaustionThreshold <= 0 or IsPlayerAtEffectiveMaxLevel() or IsXPUserDisabled() ) then + -- Hide exhaustion if player has no exhaustion, player is max level, or XP is turned off + self:Hide(); + self:GetParent().ExhaustionLevelFillBar:Hide(); + else + local widthRatio = max((playerCurrXP + exhaustionThreshold) / playerMaxXP, 0); + if (self.hideAtBarEdge) then + self:SetShown(widthRatio >= 0.01 and widthRatio <= 0.99); -- Hide pip at edges of bar since it doesn't look good at edges + else + self:SetShown(true); + end + + local exhaustionTickSet = max(widthRatio * (self:GetParent():GetWidth()), 0); + self:ClearAllPoints(); + + if ( exhaustionTickSet > self:GetParent():GetWidth() ) then + self:GetParent().ExhaustionLevelFillBar:Hide(); + else + self:SetPoint("CENTER", self:GetParent(), "LEFT", exhaustionTickSet, self.yOffset or 0); + self:GetParent().ExhaustionLevelFillBar:Show(); + self:GetParent().ExhaustionLevelFillBar:SetWidth(exhaustionTickSet); + self:GetParent().ExhaustionLevelFillBar:SetTexCoord(0, widthRatio, 0, 1); + end + end +end + +function ExhaustionTickMixin:UpdateExhaustionColor() + local exhaustionStateID = GetRestState(); + if ( exhaustionStateID == 1 ) then + local isRested = true; + self:GetParent():UpdateStatusBarTextures(isRested); + elseif ( exhaustionStateID == 2 ) then + local isRested = false; + self:GetParent():UpdateStatusBarTextures(isRested); + end +end + +function ExhaustionTickMixin:OnEvent(event, ...) + if (IsRestrictedAccount()) then + local rlevel = GetRestrictedAccountData(); + if (UnitLevel("player") >= rlevel) then + local isRested = true; + self:GetParent():UpdateStatusBarTextures(isRested); + + self:Hide(); + self:GetParent().ExhaustionLevelFillBar:Hide(); + self:UnregisterAllEvents(); + return; + end + end + if ( event == "PLAYER_ENTERING_WORLD" or event == "PLAYER_XP_UPDATE" or event == "UPDATE_EXHAUSTION" or event == "PLAYER_LEVEL_UP" ) then + self:UpdateTickPosition(); + end + + if ( event == "PLAYER_ENTERING_WORLD" or event == "UPDATE_EXHAUSTION" ) then + self:UpdateExhaustionColor(); + end + + if ( not self:IsShown() ) then + self:Hide(); + end +end + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.lua.annotated.lua new file mode 100644 index 0000000..13f9378 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.lua.annotated.lua @@ -0,0 +1,88 @@ + + +local DefaultExtraActionStyle = "Interface\\ExtraButton\\Default"; + +function ExtraActionBar_OnLoad (self) + self:SetFrameLevel(self:GetFrameLevel() + 2); + self:SetAlpha(0.0) +end + +function ExtraActionBar_Update() + local bar = ExtraActionBarFrame; + if ( C_ActionBar.HasExtraActionBar() ) then + bar:Show(); + local texture = C_ActionBar.GetOverrideBarSkin() or DefaultExtraActionStyle; + bar.button.style:SetTexture(texture); + bar.button:UpdateUsable(); + ExtraAbilityContainer:AddFrame(bar, ExtraActionButtonPriority); + bar.outro:Stop(); + bar.intro:Play(); + elseif( bar:IsShown() ) then + if KeybindFrames_InQuickKeybindMode() then + ExtraActionBar_ForceEmpty(); + else + bar.intro:Stop(); + bar.outro:Play(); + end + else + ExtraAbilityContainer:RemoveFrame(self); + end +end + +function ExtraActionBar_ForceEmpty() + local bar = ExtraActionBarFrame; + bar.button.style:Hide(); + bar.button.icon:SetAlpha(0); +end + +function ExtraActionBar_ForceShowIfNeeded() + local bar = ExtraActionBarFrame; + if not bar:IsShown() then + ExtraActionBar_ForceEmpty(); + bar.button:Show(); + bar:Show(); + bar.button:UpdateUsable(); + ExtraAbilityContainer:AddFrame(bar, ExtraActionButtonPriority); + bar.outro:Stop(); + bar.intro:Play(); + end +end + +function ExtraActionBar_CancelForceShow() + local bar = ExtraActionBarFrame; + if not C_ActionBar.HasExtraActionBar() and bar:IsShown() then + bar.button.style:Show(); + bar.button.icon:SetAlpha(1); + bar:Hide(); + bar:SetAlpha(0.0); + bar:Hide(); + ExtraAbilityContainer:RemoveFrame(bar); + end +end + +function ExtraActionButtonKey(id, isDown) + if not C_ActionBar.HasExtraActionBar() then + return; + end + + local button = _G["ExtraActionButton"..id]; + if isDown then + if ( button:GetButtonState() == "NORMAL" ) then + button:SetButtonState("PUSHED"); + end + TryUseActionButton(button, isDown); + else + if ( button:GetButtonState() == "PUSHED" ) then + button:SetButtonState("NORMAL"); + TryUseActionButton(button, isDown); + end + end +end + +ExtraActionButtonMixin = {};--- @class ExtraActionButtonMixin + +function ExtraActionButtonMixin:ExtraActionButton_OnLoad() + self.QuickKeybindHighlightTexture:ClearAllPoints(); + self.QuickKeybindHighlightTexture:SetPoint("TOPLEFT", self, "TOPLEFT", 0, -1); + self.QuickKeybindHighlightTexture:SetPoint("BOTTOMRIGHT", self, "BOTTOMRIGHT", 1.8, -1); +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml new file mode 100644 index 0000000..916ca3d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml @@ -0,0 +1,129 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + self:GetParent():SetAlpha(1.0); + + + + + + + + self:GetParent():SetAlpha(0.0); + self:GetParent():Hide(); + ExtraAbilityContainer:RemoveFrame(self:GetParent()); + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml.annotated.lua new file mode 100644 index 0000000..13766d2 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml.annotated.lua @@ -0,0 +1,97 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L48) +--- child of ExtraActionButtonTemplate +--- @class ExtraActionButtonTemplate_Cooldown : Cooldown, CooldownFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L54) +--- child of ExtraActionButtonTemplate +--- @class ExtraActionButtonTemplate_lossOfControlCooldown : Cooldown, CooldownFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L64) +--- child of ExtraActionButtonTemplate +--- @class ExtraActionButtonTemplate_chargeCooldown : Cooldown, CooldownFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L19) +--- child of ExtraActionButtonTemplate +--- @class ExtraActionButtonTemplate_HotKey : FontString, NumberFontNormalGray + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L25) +--- child of ExtraActionButtonTemplate +--- @class ExtraActionButtonTemplate_Count : FontString, NumberFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L3) +--- Explicitly protected +--- Template +--- @class ExtraActionButtonTemplate : CheckButton, ActionBarButtonCodeTemplate, ExtraActionButtonMixin +--- @field isExtra boolean # true +--- @field buttonType string # EXTRAACTIONBUTTON +--- @field cooldown ExtraActionButtonTemplate_Cooldown +--- @field lossOfControlCooldown ExtraActionButtonTemplate_lossOfControlCooldown +--- @field chargeCooldown ExtraActionButtonTemplate_chargeCooldown +--- @field icon Texture +--- @field IconMask MaskTexture +--- @field HotKey ExtraActionButtonTemplate_HotKey +--- @field Count ExtraActionButtonTemplate_Count +--- @field Flash Texture +--- @field style Texture +--- @field HighlightTexture Texture +--- @field PushedTexture Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L48) +--- child of ExtraActionButton1 (created in template ExtraActionButtonTemplate) +--- @type ExtraActionButtonTemplate_Cooldown +ExtraActionButton1Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L7) +--- child of ExtraActionButton1 (created in template ExtraActionButtonTemplate) +--- @type Texture +ExtraActionButton1Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L19) +--- child of ExtraActionButton1 (created in template ExtraActionButtonTemplate) +--- @type ExtraActionButtonTemplate_HotKey +ExtraActionButton1HotKey = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L25) +--- child of ExtraActionButton1 (created in template ExtraActionButtonTemplate) +--- @type ExtraActionButtonTemplate_Count +ExtraActionButton1Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L32) +--- child of ExtraActionButton1 (created in template ExtraActionButtonTemplate) +--- @type Texture +ExtraActionButton1Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L116) +--- Explicitly protected +--- child of ExtraActionBarFrame +--- @class ExtraActionButton1 : CheckButton, ExtraActionButtonTemplate +--- @field commandName string # EXTRAACTIONBUTTON1 +ExtraActionButton1 = {} +ExtraActionButton1["commandName"] = "EXTRAACTIONBUTTON1" +ExtraActionButton1["isExtra"] = true -- inherited +ExtraActionButton1["buttonType"] = "EXTRAACTIONBUTTON" -- inherited +ExtraActionButton1["cooldown"] = ExtraActionButton1Cooldown -- inherited +ExtraActionButton1["icon"] = ExtraActionButton1Icon -- inherited +ExtraActionButton1["HotKey"] = ExtraActionButton1HotKey -- inherited +ExtraActionButton1["Count"] = ExtraActionButton1Count -- inherited +ExtraActionButton1["Flash"] = ExtraActionButton1Flash -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L96) +--- child of ExtraActionBarFrame +--- @class ExtraActionBarFrame_intro : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L104) +--- child of ExtraActionBarFrame +--- @class ExtraActionBarFrame_outro : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ExtraActionBar.xml#L93) +--- Implicitly protected +--- @class ExtraActionBarFrame : Frame +--- @field button ExtraActionButton1 # Explicitly protected +--- @field intro ExtraActionBarFrame_intro +--- @field outro ExtraActionBarFrame_outro +ExtraActionBarFrame = {} +ExtraActionBarFrame["button"] = ExtraActionButton1 + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/Localization.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/Localization.lua.annotated.lua new file mode 100644 index 0000000..9a7becf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/Localization.lua.annotated.lua @@ -0,0 +1,21 @@ +local l10nTable = { + deDE = {}, + enGB = {}, + enUS = {}, + esES = {}, + esMX = {}, + frFR = {}, + itIT = {}, + koKR = {}, + ptBR = {}, + ptPT = {}, + ruRU = {}, + zhCN = { + localizeFrames = function() + RANGE_INDICATOR = "•"; + end, + }, + zhTW = {}, +}; + +SetupLocalization(l10nTable); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MainActionBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MainActionBar.lua.annotated.lua new file mode 100644 index 0000000..dc770bc --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MainActionBar.lua.annotated.lua @@ -0,0 +1,168 @@ +MAIN_MENU_BAR_MARGIN = 75; -- number of art pixels on one side, used by UIParent_ManageFramePositions. It's not the art's full size, don't care about the gryphon's tail. + +MainActionBarMixin = {};--- @class MainActionBarMixin + +function MainActionBarMixin:OnLoad() + self:RegisterEvent("ACTIONBAR_PAGE_CHANGED"); + self:RegisterEvent("NEUTRAL_FACTION_SELECT_RESULT"); + + self.state = "player"; + MainActionBar.ActionBarPageNumber.Text:SetText(C_ActionBar.GetActionBarPage()); +end + +function MainActionBarMixin:OnShow() + MicroMenu:ResetMicroMenuPosition(); +end + +function MainActionBarMixin:SetYOffset(yOffset) + self.yOffset = yOffset; +end + +function MainActionBarMixin:GetYOffset() + return self.yOffset; +end + +function MainActionBarMixin:OnEvent(event, ...) + if ( event == "ACTIONBAR_PAGE_CHANGED" ) then + MainActionBar.ActionBarPageNumber.Text:SetText(C_ActionBar.GetActionBarPage()); + elseif ( event == "NEUTRAL_FACTION_SELECT_RESULT" ) then + self:UpdateEndCaps(); + end +end + +function MainActionBarMixin:AttachToFrame(frame) + self.attachedFrame = frame; + if not self.preAttachPoints then + self.preAttachPoints = RegionUtil.GetPointsArray(self); + self:ClearAllPoints(); + end + + self:SetParent(frame); +end + +function MainActionBarMixin:DetachFromFrame(frame) + if self.attachedFrame == frame then + self.attachedFrame = nil; + + self:SetParent(UIParent); + if self.preAttachPoints then + RegionUtil.ApplyRegionPoints(self, self.preAttachPoints); + self.preAttachPoints = nil; + end + end +end + +function MainActionBarMixin:IsInDefaultPosition() + return not self.attachedFrame and EditModeSystemMixin.IsInDefaultPosition(self); +end + +function MainActionBarMixin:SetQuickKeybindModeEffectsShown(showEffects) + self.QuickKeybindBottomShadow:SetShown(showEffects); + self.QuickKeybindGlowSmall:SetShown(showEffects); + self.QuickKeybindGlowLarge:SetShown(showEffects); + local useRightShadow = MultiBarRight:IsShown(); + self.QuickKeybindRightShadow:SetShown(useRightShadow and showEffects); +end + +function MainActionBarMixin:UpdateEndCaps(forceHide) + self.EndCaps:SetShown(not forceHide); +end + +function MainActionBarMixin:EditModeSetScale(newScale) + if (self.BorderArt) then + self.BorderArt:SetScale(newScale); + end + + -- For end caps and page number, only scale down, not up + self.EndCaps:SetScale(newScale < 1 and newScale or 1); + self.ActionBarPageNumber:SetScale(newScale < 1 and newScale or 1); +end + +function MainActionBarMixin:UpdateDividers() + if (not self.enableDividers) then + return; + end + + if not self.HorizontalDividersPool then + self.HorizontalDividersPool = CreateFramePool("FRAME", self, "HorizontalDividerTemplate"); + self.VerticalDividersPool = CreateFramePool("FRAME", self, "VerticalDividerTemplate"); + end + self.HorizontalDividersPool:ReleaseAll(); + self.VerticalDividersPool:ReleaseAll(); + + if self.hideBarArt or self.numRows > 1 or self.buttonPadding > self.minButtonPadding then + return; + end + + local dividersPool = self.isHorizontal and self.HorizontalDividersPool or self.VerticalDividersPool; + local wasLastButtonShown = false; + for i, actionButton in pairs(self.actionButtons) do + if actionButton:IsShown() then + if wasLastButtonShown then + local divider = dividersPool:Acquire(); + divider:ClearAllPoints(); + if self.isHorizontal then + divider:SetPoint("TOP", actionButton, "TOP", 0, 0); + divider:SetPoint("BOTTOM", actionButton, "BOTTOM", 0, 0); + divider:SetPoint("RIGHT", actionButton, "LEFT", 5, 0); + else + divider:SetPoint("LEFT", actionButton, "LEFT", 0, 0); + divider:SetPoint("RIGHT", actionButton, "RIGHT", 0, 0); + divider:SetPoint("BOTTOM", actionButton, "TOP", 0, -5); + end + divider:Show(); + end + wasLastButtonShown = true; + else + wasLastButtonShown = false; + end + end +end + +function MainActionBarMixin:GetEndCapsFrameLevel() + return self.EndCaps:GetFrameLevel(); +end + +MainActionBarUpButtonMixin = {};--- @class MainActionBarUpButtonMixin + +function MainActionBarUpButtonMixin:OnClick() + if ( not KeybindFrames_InQuickKeybindMode() ) then + ActionBar_PageUp(); + PlaySound(SOUNDKIT.U_CHAT_SCROLL_BUTTON); + end +end + +function MainActionBarUpButtonMixin:OnLeave() + GameTooltip:Hide(); +end + +MainActionBarDownButtonMixin = {};--- @class MainActionBarDownButtonMixin + +function MainActionBarDownButtonMixin:OnClick() + if ( not KeybindFrames_InQuickKeybindMode() ) then + ActionBar_PageDown(); + PlaySound(SOUNDKIT.U_CHAT_SCROLL_BUTTON); + end +end + +function MainActionBarDownButtonMixin:OnLeave() + GameTooltip:Hide(); +end + +-- For arrow buttons that need to swap their textures between two styles. +-- Currently used by Classic. +MainActionBarSwappableButtonMixin = {};--- @class MainActionBarSwappableButtonMixin + +function MainActionBarSwappableButtonMixin:SwapToDefaultAtlas() + self:SetNormalAtlas(self:GetNormalTexture().defaultAtlas); + self:SetPushedAtlas(self:GetPushedTexture().defaultAtlas); + self:SetDisabledAtlas(self:GetDisabledTexture().defaultAtlas); + self:SetHighlightAtlas(self:GetHighlightTexture().defaultAtlas); +end + +function MainActionBarSwappableButtonMixin:SwapToAlternateAtlas() + self:SetNormalAtlas(self:GetNormalTexture().alternateAtlas); + self:SetPushedAtlas(self:GetPushedTexture().alternateAtlas); + self:SetDisabledAtlas(self:GetDisabledTexture().alternateAtlas); + self:SetHighlightAtlas(self:GetHighlightTexture().alternateAtlas); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.lua.annotated.lua new file mode 100644 index 0000000..ab4787a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.lua.annotated.lua @@ -0,0 +1,166 @@ +RIGHT_ACTIONBAR_PAGE = 3; +LEFT_ACTIONBAR_PAGE = 4; +BOTTOMRIGHT_ACTIONBAR_PAGE = 5; +BOTTOMLEFT_ACTIONBAR_PAGE = 6; + +MULTIBAR_5_ACTIONBAR_PAGE = 13; +MULTIBAR_6_ACTIONBAR_PAGE = 14; +MULTIBAR_7_ACTIONBAR_PAGE = 15; + +NUM_MULTIBAR_BUTTONS = 12; +VERTICAL_MULTI_BAR_HEIGHT = 503; +VERTICAL_MULTI_BAR_WIDTH = 41; +VERTICAL_MULTI_BAR_VERTICAL_SPACING = 20; +VERTICAL_MULTI_BAR_HORIZONTAL_SPACING = 2; +VERTICAL_MULTI_BAR_MIN_SCALE = 0.8333; + +local function IsMultibarVisible(index) + if index == 1 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_2"); + elseif index == 2 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_3"); + elseif index == 3 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_4"); + elseif index == 4 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_5"); + elseif index == 5 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_6"); + elseif index == 6 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_7"); + elseif index == 7 then + return Settings.GetValue("PROXY_SHOW_ACTIONBAR_8"); + end +end + +function MultiActionButtonDown (barName, id) + local bar = _G[barName]; + local button = bar.actionButtons[id]; + if ( button:GetButtonState() == "NORMAL" ) then + button:SetButtonState("PUSHED"); + end + TryUseActionButton(button, true); +end + +function MultiActionButtonUp (barName, id) + local bar = _G[barName]; + local button = bar.actionButtons[id]; + if ( button:GetButtonState() == "PUSHED" ) then + button:SetButtonState("NORMAL"); + TryUseActionButton(button, false); + end +end + +function IsNormalActionBarState() + return MainActionBar:IsShown(); +end + +local multiActionBarTable; +local function GetMultiActionBars() + if not multiActionBarTable then + -- Double check on the off chance this gets called when the bars aren't yet loaded in + if not MultiBarBottomLeft or not MultiBarBottomRight or not MultiBarRight or not MultiBarLeft or not MultiBar5 or not MultiBar6 or not MultiBar7 then + return nil; + end + + -- Lazy initialize & cache the table + multiActionBarTable = { + [BOTTOMLEFT_ACTIONBAR_PAGE] = { bar = MultiBarBottomLeft, getIsVisible = MultiBar1_IsVisible }, + [BOTTOMRIGHT_ACTIONBAR_PAGE] = { bar = MultiBarBottomRight, getIsVisible = MultiBar2_IsVisible }, + [RIGHT_ACTIONBAR_PAGE] = { bar = MultiBarRight, getIsVisible = MultiBar3_IsVisible }, + [LEFT_ACTIONBAR_PAGE] = { bar = MultiBarLeft, getIsVisible = MultiBar4_IsVisible }, + [MULTIBAR_5_ACTIONBAR_PAGE] = { bar = MultiBar5, getIsVisible = MultiBar5_IsVisible }, + [MULTIBAR_6_ACTIONBAR_PAGE] = { bar = MultiBar6, getIsVisible = MultiBar6_IsVisible }, + [MULTIBAR_7_ACTIONBAR_PAGE] = { bar = MultiBar7, getIsVisible = MultiBar7_IsVisible }, + }; + end + + return multiActionBarTable; +end + +local function UpdateMultiActionBar(frame, var, pageVar) + if var == nil then + -- if var is nil that means settings were not loaded when this was called, so do nothing + return; + end + + if var and IsNormalActionBarState() then + frame:SetShown(true); + VIEWABLE_ACTION_BAR_PAGES[pageVar] = nil; + else + frame:SetShown(false); + VIEWABLE_ACTION_BAR_PAGES[pageVar] = 1; + end +end + +function MultiActionBar_Update () + local multiActionBarEntries = GetMultiActionBars(); + if multiActionBarEntries then + for page, barEntry in pairs(multiActionBarEntries) do + UpdateMultiActionBar(barEntry.bar, barEntry.getIsVisible(), page); + end + end +end + +function MultiActionBar_ShowAllGrids (reason) + local multiActionBarEntries = GetMultiActionBars(); + if multiActionBarEntries then + for _, barEntry in pairs(multiActionBarEntries) do + barEntry.bar:SetShowGrid(true, reason); + end + end +end + +function MultiActionBar_HideAllGrids (reason) + local multiActionBarEntries = GetMultiActionBars(); + if multiActionBarEntries then + for _, barEntry in pairs(multiActionBarEntries) do + barEntry.bar:SetShowGrid(false, reason); + end + end +end + +function MultiActionBar_SetAllQuickKeybindModeEffectsShown(showEffects) + local multiActionBarEntries = GetMultiActionBars(); + if multiActionBarEntries then + for _, barEntry in pairs(multiActionBarEntries) do + barEntry.bar.QuickKeybindGlow:SetShown(showEffects); + end + end +end + +function MultiActionBar_GetBarForPage(page) + local bars = GetMultiActionBars(); + return (bars and bars[page]) and bars[page].bar or nil; +end + +function Multibar_EmptyFunc (show) + +end + +function MultiBar1_IsVisible() + return IsMultibarVisible(1); +end + +function MultiBar2_IsVisible() + return IsMultibarVisible(2); +end + +function MultiBar3_IsVisible() + return IsMultibarVisible(3); +end + +function MultiBar4_IsVisible() + return IsMultibarVisible(4); +end + +function MultiBar5_IsVisible() + return IsMultibarVisible(5); +end + +function MultiBar6_IsVisible() + return IsMultibarVisible(6); +end + +function MultiBar7_IsVisible() + return IsMultibarVisible(7); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml new file mode 100644 index 0000000..bf30363 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml.annotated.lua new file mode 100644 index 0000000..0b33c42 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml.annotated.lua @@ -0,0 +1,256 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L3) +--- Explicitly protected +--- Template +--- @class MultiBar1ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR1BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L9) +--- Explicitly protected +--- Template +--- @class MultiBar2ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR2BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L15) +--- Explicitly protected +--- Template +--- @class MultiBar3ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR3BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L21) +--- Explicitly protected +--- Template +--- @class MultiBar4ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR4BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L27) +--- Explicitly protected +--- Template +--- @class MultiBar5ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR5BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L33) +--- Explicitly protected +--- Template +--- @class MultiBar6ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR6BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L39) +--- Explicitly protected +--- Template +--- @class MultiBar7ButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field buttonType string # MULTIACTIONBAR7BUTTON + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L45) +--- @class MultiBarBottomLeft : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar1ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR1 +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.Bar2 +--- @field skipAutomaticPositioning any # ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +--- @field isNormalBar boolean # true +--- @field QuickKeybindGlow Texture +MultiBarBottomLeft = {} +MultiBarBottomLeft["buttonTemplate"] = "MultiBar1ButtonTemplate" +MultiBarBottomLeft["commandNamePrefix"] = "MULTIACTIONBAR1" +MultiBarBottomLeft["isHorizontal"] = true +MultiBarBottomLeft["numRows"] = 1 +MultiBarBottomLeft["numButtons"] = 12 +MultiBarBottomLeft["addButtonsToRight"] = true +MultiBarBottomLeft["addButtonsToTop"] = true +MultiBarBottomLeft["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBarBottomLeft["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBarBottomLeft["systemIndex"] = Enum.EditModeActionBarSystemIndices.Bar2 +MultiBarBottomLeft["skipAutomaticPositioning"] = ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +MultiBarBottomLeft["isNormalBar"] = true +MultiBarBottomLeft["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBarBottomLeft["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBarBottomLeft["addSystemIndexToName"] = true -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L75) +--- @class MultiBarBottomRight : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar2ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR2 +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.Bar3 +--- @field skipAutomaticPositioning any # ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +--- @field QuickKeybindGlow Texture +MultiBarBottomRight = {} +MultiBarBottomRight["buttonTemplate"] = "MultiBar2ButtonTemplate" +MultiBarBottomRight["commandNamePrefix"] = "MULTIACTIONBAR2" +MultiBarBottomRight["isHorizontal"] = true +MultiBarBottomRight["numRows"] = 1 +MultiBarBottomRight["numButtons"] = 12 +MultiBarBottomRight["addButtonsToRight"] = true +MultiBarBottomRight["addButtonsToTop"] = true +MultiBarBottomRight["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBarBottomRight["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBarBottomRight["systemIndex"] = Enum.EditModeActionBarSystemIndices.Bar3 +MultiBarBottomRight["skipAutomaticPositioning"] = ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +MultiBarBottomRight["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBarBottomRight["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBarBottomRight["addSystemIndexToName"] = true -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L104) +--- @class MultiBarLeft : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar4ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR4 +--- @field isHorizontal boolean # false +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # false +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.RightBar2 +--- @field isNormalBar boolean # true +--- @field QuickKeybindGlow Texture +MultiBarLeft = {} +MultiBarLeft["buttonTemplate"] = "MultiBar4ButtonTemplate" +MultiBarLeft["commandNamePrefix"] = "MULTIACTIONBAR4" +MultiBarLeft["isHorizontal"] = false +MultiBarLeft["numRows"] = 1 +MultiBarLeft["numButtons"] = 12 +MultiBarLeft["addButtonsToRight"] = true +MultiBarLeft["addButtonsToTop"] = false +MultiBarLeft["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBarLeft["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBarLeft["systemIndex"] = Enum.EditModeActionBarSystemIndices.RightBar2 +MultiBarLeft["isNormalBar"] = true +MultiBarLeft["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBarLeft["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBarLeft["addSystemIndexToName"] = true -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L133) +--- @class MultiBarRight : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar3ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR3 +--- @field isHorizontal boolean # false +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # false +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.RightBar1 +--- @field isNormalBar boolean # true +--- @field QuickKeybindGlow Texture +MultiBarRight = {} +MultiBarRight["buttonTemplate"] = "MultiBar3ButtonTemplate" +MultiBarRight["commandNamePrefix"] = "MULTIACTIONBAR3" +MultiBarRight["isHorizontal"] = false +MultiBarRight["numRows"] = 1 +MultiBarRight["numButtons"] = 12 +MultiBarRight["addButtonsToRight"] = true +MultiBarRight["addButtonsToTop"] = false +MultiBarRight["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBarRight["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBarRight["systemIndex"] = Enum.EditModeActionBarSystemIndices.RightBar1 +MultiBarRight["isNormalBar"] = true +MultiBarRight["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBarRight["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBarRight["addSystemIndexToName"] = true -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L162) +--- @class MultiBar5 : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar5ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR5 +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.ExtraBar1 +--- @field isNormalBar boolean # true +--- @field QuickKeybindGlow Texture +MultiBar5 = {} +MultiBar5["buttonTemplate"] = "MultiBar5ButtonTemplate" +MultiBar5["commandNamePrefix"] = "MULTIACTIONBAR5" +MultiBar5["isHorizontal"] = true +MultiBar5["numRows"] = 1 +MultiBar5["numButtons"] = 12 +MultiBar5["addButtonsToRight"] = true +MultiBar5["addButtonsToTop"] = true +MultiBar5["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBar5["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBar5["systemIndex"] = Enum.EditModeActionBarSystemIndices.ExtraBar1 +MultiBar5["isNormalBar"] = true +MultiBar5["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBar5["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBar5["addSystemIndexToName"] = true -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L191) +--- @class MultiBar6 : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar6ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR6 +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.ExtraBar2 +--- @field isNormalBar boolean # true +--- @field QuickKeybindGlow Texture +MultiBar6 = {} +MultiBar6["buttonTemplate"] = "MultiBar6ButtonTemplate" +MultiBar6["commandNamePrefix"] = "MULTIACTIONBAR6" +MultiBar6["isHorizontal"] = true +MultiBar6["numRows"] = 1 +MultiBar6["numButtons"] = 12 +MultiBar6["addButtonsToRight"] = true +MultiBar6["addButtonsToTop"] = true +MultiBar6["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBar6["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBar6["systemIndex"] = Enum.EditModeActionBarSystemIndices.ExtraBar2 +MultiBar6["isNormalBar"] = true +MultiBar6["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBar6["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBar6["addSystemIndexToName"] = true -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiActionBars.xml#L220) +--- @class MultiBar7 : Frame, EditModeActionBarTemplate +--- @field buttonTemplate string # MultiBar7ButtonTemplate +--- @field commandNamePrefix string # MULTIACTIONBAR7 +--- @field isHorizontal boolean # true +--- @field numRows number # 1 +--- @field numButtons number # 12 +--- @field addButtonsToRight boolean # true +--- @field addButtonsToTop boolean # true +--- @field showGridEventName string # ACTIONBAR_SHOWGRID +--- @field hideGridEventName string # ACTIONBAR_HIDEGRID +--- @field systemIndex any # Enum.EditModeActionBarSystemIndices.ExtraBar3 +--- @field isNormalBar boolean # true +--- @field QuickKeybindGlow Texture +MultiBar7 = {} +MultiBar7["buttonTemplate"] = "MultiBar7ButtonTemplate" +MultiBar7["commandNamePrefix"] = "MULTIACTIONBAR7" +MultiBar7["isHorizontal"] = true +MultiBar7["numRows"] = 1 +MultiBar7["numButtons"] = 12 +MultiBar7["addButtonsToRight"] = true +MultiBar7["addButtonsToTop"] = true +MultiBar7["showGridEventName"] = "ACTIONBAR_SHOWGRID" +MultiBar7["hideGridEventName"] = "ACTIONBAR_HIDEGRID" +MultiBar7["systemIndex"] = Enum.EditModeActionBarSystemIndices.ExtraBar3 +MultiBar7["isNormalBar"] = true +MultiBar7["system"] = Enum.EditModeSystem.ActionBar -- inherited +MultiBar7["systemNameString"] = HUD_EDIT_MODE_ACTION_BAR_LABEL -- inherited +MultiBar7["addSystemIndexToName"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.lua.annotated.lua new file mode 100644 index 0000000..50daa99 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.lua.annotated.lua @@ -0,0 +1,1080 @@ + +-- globals +MULTICASTACTIONBAR_SLIDETIME = 0.09; +MULTICASTACTIONBAR_YPOS = 0; +MULTICASTACTIONBAR_XPOS = 30; +NUM_MULTI_CAST_PAGES = 3; +NUM_MULTI_CAST_BUTTONS_PER_PAGE = 4; -- NOTE: must match MAX_TOTEMS!!! + +-- locals +local MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET = 4; +local MULTI_CAST_FLYOUT_BUTTON_OFFSET = 2; +local MULTI_CAST_FLYOUT_CLOSE_SEC = 3; + +local SLOT_EMPTY_TCOORDS = { + [EARTH_TOTEM_SLOT] = { + left = 66 / 128, + right = 96 / 128, + top = 3 / 256, + bottom = 33 / 256, + }, + [FIRE_TOTEM_SLOT] = { + left = 67 / 128, + right = 97 / 128, + top = 100 / 256, + bottom = 130 / 256, + }, + [WATER_TOTEM_SLOT] = { + left = 39 / 128, + right = 69 / 128, + top = 209 / 256, + bottom = 239 / 256, + }, + [AIR_TOTEM_SLOT] = { + left = 66 / 128, + right = 96 / 128, + top = 36 / 256, + bottom = 66 / 256, + }, +}; +local SLOT_OVERLAY_TCOORDS = { + [EARTH_TOTEM_SLOT] = { + left = 1 / 128, + right = 35 / 128, + top = 172 / 256, + bottom = 206 / 256, + }, + [FIRE_TOTEM_SLOT] = { + left = 36 / 128, + right = 70 / 128, + top = 172 / 256, + bottom = 206 / 256, + }, + [WATER_TOTEM_SLOT] = { + left = 1 / 128, + right = 35 / 128, + top = 207 / 256, + bottom = 240 / 256, + }, + [AIR_TOTEM_SLOT] = { + left = 36 / 128, + right = 70 / 128, + top = 137 / 256, + bottom = 171 / 256, + }, +}; + +local FLYOUT_UP_BUTTON_TCOORDS = { + ["summon"] = { + left = 99 / 128, + right = 127 / 128, + top = 84 / 256, + bottom = 102 / 256, + }, + [EARTH_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 160 / 256, + bottom = 178 / 256, + }, + [FIRE_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 122 / 256, + bottom = 140 / 256, + }, + [WATER_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 199 / 256, + bottom = 217 / 256, + }, + [AIR_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 237 / 256, + bottom = 255 / 256, + }, +}; +local FLYOUT_DOWN_BUTTON_TCOORDS = { + ["summon"] = { + left = 99 / 128, + right = 127 / 128, + top = 65 / 256, + bottom = 83 / 256, + }, + [EARTH_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 141 / 256, + bottom = 159 / 256, + }, + [FIRE_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 103 / 256, + bottom = 121 / 256, + }, + [WATER_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 180 / 256, + bottom = 198 / 256, + }, + [AIR_TOTEM_SLOT] = { + left = 99 / 128, + right = 127 / 128, + top = 218 / 256, + bottom = 236 / 256, + }, +}; +local FLYOUT_TOP_TCOORDS = { + ["summon"] = { + left = 33 / 128, + right = 65 / 128, + top = 1 / 256, + bottom = 23 / 256, + }, + [EARTH_TOTEM_SLOT] = { + left = 0 / 128, + right = 32 / 128, + top = 46 / 256, + bottom = 68 / 256, + }, + [FIRE_TOTEM_SLOT] = { + left = 33 / 128, + right = 65 / 128, + top = 46 / 256, + bottom = 68 / 256, + }, + [WATER_TOTEM_SLOT] = { + left = 0 / 128, + right = 32 / 128, + top = 1 / 256, + bottom = 23 / 256, + }, + [AIR_TOTEM_SLOT] = { + left = 0 / 128, + right = 32 / 128, + top = 91 / 256, + bottom = 113 / 256, + }, +}; +local FLYOUT_MIDDLE_TCOORDS = { + ["summon"] = { + left = 33 / 128, + right = 65 / 128, + top = 23 / 256, + bottom = 43 / 256, + }, + [EARTH_TOTEM_SLOT] = { + left = 0 / 128, + right = 32 / 128, + top = 68 / 256, + bottom = 88 / 256, + }, + [FIRE_TOTEM_SLOT] = { + left = 33 / 128, + right = 65 / 128, + top = 68 / 256, + bottom = 88 / 256, + }, + [WATER_TOTEM_SLOT] = { + left = 0 / 128, + right = 32 / 128, + top = 23 / 256, + bottom = 43 / 256, + }, + [AIR_TOTEM_SLOT] = { + left = 0 / 128, + right = 32 / 128, + top = 113 / 256, + bottom = 133 / 256, + }, +}; + +-- knownMultiCastSummonSpells +-- index: TOTEM_MULTI_CAST_SUMMON_SPELLS +-- value: spellId if the spell is known, nil otherwise +local knownMultiCastSummonSpells = { }; +-- knownMultiCastRecallSpells +-- index: TOTEM_MULTI_CAST_RECALL_SPELLS +-- value: spellId if the spell is known, nil otherwise +local knownMultiCastRecallSpells = { }; + +local function _ComputeMultiCastSlot(id) + return mod(id - 1, NUM_MULTI_CAST_BUTTONS_PER_PAGE) + 1; +end + +-- +-- MultiCastActionBar +-- + +function MultiCastActionBarFrame_OnLoad(self) + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("UPDATE_MULTI_CAST_ACTIONBAR"); + + self.currentPage = 1; + MultiCastSummonSpellButton:SetID(self.currentPage); + + self.numActiveSlots = 0; +end + +function MultiCastActionBarFrame_OnEvent(self, event, ...) + if ( event == "PLAYER_ENTERING_WORLD" or event == "UPDATE_MULTI_CAST_ACTIONBAR" ) then + MultiCastActionBarFrame_Update(self); + if ( HasMultiCastActionBar() ) then + ShowMultiCastActionBar(); + LockMultiCastActionBar(); + else + UnlockMultiCastActionBar(); + HideMultiCastActionBar(); + end + end +end + +function MultiCastActionBarFrame_OnUpdate(self, elapsed) + local yPos; + if ( self.slideTimer and (self.slideTimer < self.timeToSlide) ) then + self.completed = false; + if ( self.mode == "show" ) then + yPos = (self.slideTimer/self.timeToSlide) * MULTICASTACTIONBAR_YPOS; + self:SetPoint("BOTTOMLEFT", self:GetParent(), "TOPLEFT", MULTICASTACTIONBAR_XPOS, yPos); + self.state = "showing"; + self:Show(); + elseif ( self.mode == "hide" ) then + yPos = (1 - (self.slideTimer/self.timeToSlide)) * MULTICASTACTIONBAR_YPOS; + self:SetPoint("BOTTOMLEFT", self:GetParent(), "TOPLEFT", MULTICASTACTIONBAR_XPOS, yPos); + self.state = "hiding"; + end + self.slideTimer = self.slideTimer + elapsed; + else + self.completed = true; + if ( self.mode == "show" ) then + self:SetPoint("BOTTOMLEFT", self:GetParent(), "TOPLEFT", MULTICASTACTIONBAR_XPOS, MULTICASTACTIONBAR_YPOS); + self.state = "top"; + --Move the chat frame and edit box up a bit + elseif ( self.mode == "hide" ) then + self:SetPoint("BOTTOMLEFT", self:GetParent(), "TOPLEFT", MULTICASTACTIONBAR_XPOS, 0); + self.state = "bottom"; + self:Hide(); + --Move the chat frame and edit box back down to original position + end + self.mode = "none"; + end +end + +function ShowMultiCastActionBar(doNotSlide) + if ( (not MainActionBar.busy) and (not UnitHasVehicleUI("player")) ) then --Don't change while we're animating out MainActionBar for vehicle UI + if ( (MultiCastActionBarFrame.mode ~= "show" and MultiCastActionBarFrame.state ~= "top") or (not UIParent:IsShown())) then + MultiCastActionBarFrame:Show(); + if ( MultiCastActionBarFrame.completed ) then + MultiCastActionBarFrame.slideTimer = 0; + end + MultiCastActionBarFrame.timeToSlide = MULTICASTACTIONBAR_SLIDETIME; + MultiCastActionBarFrame.mode = "show"; + end + end +end + +function HideMultiCastActionBar() + if ( (not MainActionBar.busy) and (not UnitHasVehicleUI("player")) ) then --Don't change while we're animating out MainActionBar for vehicle UI + if ( (MultiCastActionBarFrame:IsShown()) or (not UIParent:IsShown())) then + if ( MultiCastActionBarFrame.completed ) then + MultiCastActionBarFrame.slideTimer = 0; + end + MultiCastActionBarFrame.timeToSlide = MULTICASTACTIONBAR_SLIDETIME; + MultiCastActionBarFrame.mode = "hide"; + end + end +end + +function LockMultiCastActionBar() + MultiCastActionBarFrame.locked = true; +end + +function UnlockMultiCastActionBar() + MultiCastActionBarFrame.locked = false; +end + +function MultiCastActionBarFrame_Update(self) + local currentPage = self.currentPage; + + -- update the action buttons and slot buttons + local slot; + local actionButton, slotButton; + local actionIndex; + local slotIndex = 1; + local inverseSlotIndex; + local pageOffset; + local actionId; + for i = 1, NUM_MULTI_CAST_BUTTONS_PER_PAGE do + slot = SHAMAN_TOTEM_PRIORITIES[i]; + if ( GetTotemInfo(slot) and GetMultiCastTotemSpells(slot) ) then + -- update the slot button + slotButton = _G["MultiCastSlotButton"..slotIndex]; + MultiCastSlotButton_Update(slotButton, slot); + -- update the action buttons using this totem slot on each page + for j = 1, NUM_MULTI_CAST_PAGES do + pageOffset = (j-1) * NUM_MULTI_CAST_BUTTONS_PER_PAGE; + actionIndex = pageOffset + slotIndex; + actionButton = _G["MultiCastActionButton"..actionIndex]; + actionButton.slotButton = slotButton; + actionId = pageOffset + slot; + MultiCastActionButton_Update(actionButton, actionId, actionIndex, slot); + -- if this is the current page, store a reference to the action button on the slot button + if ( j == currentPage ) then + slotButton.actionButton = actionButton; + end + end + slotIndex = slotIndex + 1; + else + inverseSlotIndex = NUM_MULTI_CAST_BUTTONS_PER_PAGE - i + slotIndex; + -- hide the slot button + slotButton = _G["MultiCastSlotButton"..inverseSlotIndex]; + MultiCastSlotButton_Update(slotButton, 0); + -- hide the action buttons for this button index on each page + for j = 1, NUM_MULTI_CAST_PAGES do + pageOffset = (j-1) * NUM_MULTI_CAST_BUTTONS_PER_PAGE; + actionIndex = pageOffset + inverseSlotIndex; + actionButton = _G["MultiCastActionButton"..actionIndex]; + actionButton.slotButton = nil; + actionId = pageOffset + slot; + MultiCastActionButton_Update(actionButton, actionId, actionIndex, 0); + end + slotButton.actionButton = nil; + end + end + + self.numActiveSlots = slotIndex - 1; + if ( self.numActiveSlots == 0 ) then + self:Hide(); + return; + end + self:Show(); + + -- update the multi cast spells + MultiCastSummonSpellButton_Update(MultiCastSummonSpellButton); + MultiCastRecallSpellButton_Update(MultiCastRecallSpellButton); +end + +function HasMultiCastActionBar() + return MultiCastActionBarFrame.numActiveSlots and MultiCastActionBarFrame.numActiveSlots > 0; +end + +function HasMultiCastActionPage(page) + return ( page >= 1 and page <= NUM_MULTI_CAST_PAGES and knownMultiCastSummonSpells[page] ); +end + +function ChangeMultiCastActionPage(page) + local prevPage = MultiCastActionBarFrame.currentPage; + if ( page ~= prevPage and HasMultiCastActionPage(page) ) then + MultiCastActionBarFrame.currentPage = page; + MultiCastSummonSpellButton:SetID(page); + _G["MultiCastActionPage"..prevPage]:Hide(); + _G["MultiCastActionPage"..page]:Show(); + MultiCastActionBarFrame_Update(MultiCastActionBarFrame); + end +end + + +-- +-- MultiCastSlotButton +-- + + +function MultiCastSlotButton_OnEvent(self, event, ...) + if ( event == "MODIFIER_STATE_CHANGED" ) then + if ( IsModifiedClick("SHOWMULTICASTFLYOUT") and self:IsMouseOver() ) then + MultiCastSlotButton_OnEnter(self); + end + end +end + +function MultiCastSlotButton_OnEnter(self) + if ( MultiCastFlyoutFrame.parent ~= self ) then + MultiCastFlyoutFrameOpenButton_Show(MultiCastFlyoutFrameOpenButton, "slot", self); + end +--[[ + self:RegisterEvent("MODIFIER_STATE_CHANGED"); + if ( IsModifiedClick("SHOWMULTICASTFLYOUT") ) then + local slot = self:GetID(); + MultiCastFlyoutFrame_ToggleFlyout(MultiCastFlyoutFrame, "slot", self); + end +--]] +end + +function MultiCastSlotButton_OnLeave(self) + GameTooltip:Hide(); + MultiCastFlyoutFrameOpenButton_Hide(MultiCastFlyoutFrameOpenButton); +end + +function MultiCastSlotButton_Update(self, slot) + self:SetID(slot); + if ( slot == 0 ) then + self:Hide(); + else + -- fixup textures + local tcoords = SLOT_OVERLAY_TCOORDS[slot]; + self.overlayTex:SetTexCoord(tcoords.left, tcoords.right, tcoords.top, tcoords.bottom); + tcoords = SLOT_EMPTY_TCOORDS[slot]; + self.background:SetTexCoord(tcoords.left, tcoords.right, tcoords.top, tcoords.bottom); + + self:Show(); + end +end + + +-- +-- MultiCastActionButton +-- + +function MultiCastActionButton_OnLoad(self) + -- fixup textures + local name = self:GetName(); + local normalTexture = _G[name.."NormalTexture"]; + normalTexture:SetWidth(50); + normalTexture:SetHeight(50); + + -- setup action button stuff + self.buttonType = "MULTICASTACTIONBUTTON"; + self.buttonIndex = self:GetID(); + ActionBarActionButtonDerivedMixin.ActionBarActionButtonDerivedMixin_OnLoad(self); +end + +function MultiCastActionButton_OnEvent(self, event, ...) + ActionBarActionButtonDerivedMixin.ActionBarActionButtonDerivedMixin_OnEvent(self, event, ...); + if ( event == "MODIFIER_STATE_CHANGED" ) then + if ( IsModifiedClick("SHOWMULTICASTFLYOUT") and self:IsMouseOver() ) then + MultiCastActionButton_OnEnter(self); + end + end +end + +function MultiCastActionButton_OnShow(self) + if ( not self.slotButton ) then + self:Hide(); + end +end + +function MultiCastActionButton_OnEnter(self) + MultiCastSlotButton_OnEnter(self.slotButton); + self:SetTooltip(); +end + +function MultiCastActionButton_OnLeave(self) + GameTooltip:Hide(); + MultiCastFlyoutFrameOpenButton_Hide(MultiCastFlyoutFrameOpenButton); +end + +function MultiCastActionButton_OnPostClick(self, button, down) + self:UpdateState(); + MultiCastFlyoutFrame_Hide(MultiCastFlyoutFrame, true); +end + +function MultiCastActionButton_Update(self, id, index, slot) + self:SetID(id); + self.buttonIndex = index; + if ( slot == 0 ) then + self:Hide(); + else + self:UpdateAction(); + ActionBarActionButtonDerivedMixin.Update(self); + self:UpdateHotkeys(self.buttonType); + + -- fixup textures + local tcoords; + tcoords = SLOT_OVERLAY_TCOORDS[slot]; + self.overlayTex:SetTexCoord(tcoords.left, tcoords.right, tcoords.top, tcoords.bottom); + self:Show(); + end +end + +function MultiCastActionButtonDown(id) + local button = _G["MultiCastActionButton"..id]; + if ( button:GetButtonState() == "NORMAL" ) then + button:SetButtonState("PUSHED"); + end + TryUseActionButton(button, true); +end + +function MultiCastActionButtonUp(id) + local button = _G["MultiCastActionButton"..id]; + if ( button:GetButtonState() == "PUSHED" ) then + button:SetButtonState("NORMAL"); + TryUseActionButton(button, false); + end + MultiCastFlyoutFrame_Hide(MultiCastFlyoutFrame, true); +end + + +-- +-- MultiCastFlyoutButton +-- + +function MultiCastFlyoutButton_OnLoad(self) + self:RegisterForClicks("AnyUp"); + + local parent = self:GetParent(); + tinsert(parent.buttons, self); +end + +function MultiCastFlyoutButton_OnClick(self) + local parent = self:GetParent(); + + if ( self.spellId ) then + local type = parent.type; + if ( type == "page" ) then + ChangeMultiCastActionPage(self.page); + elseif ( type == "slot" ) then + SetMultiCastSpell(parent.parent.actionButton:CalculateAction(), self.spellId); + end + end + + MultiCastFlyoutFrame_Hide(parent, true); +end + +function MultiCastFlyoutButton_OnEnter(self) + MultiCastFlyoutButton_SetTooltip(self); +end + +function MultiCastFlyoutButton_OnLeave(self) + GameTooltip:Hide(); +end + +function MultiCastFlyoutButton_SetTooltip(self) + if ( self.spellId ) then + if ( self.spellId == 0 ) then + if ( GetCVarBool("UberTooltips") ) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + GameTooltip:SetText(MULTI_CAST_TOOLTIP_NO_TOTEM, HIGHLIGHT_FONT_COLOR.r, HIGHLIGHT_FONT_COLOR.g, HIGHLIGHT_FONT_COLOR.b); + self.UpdateTooltip = nil; + else + if ( GetCVarBool("UberTooltips") ) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + if ( GameTooltip:SetSpellByID(self.spellId, false, true) ) then + self.UpdateTooltip = MultiCastFlyoutButton_SetTooltip; + else + self.UpdateTooltip = nil; + end + end + end +end + + +-- +-- MultiCastFlyoutFrame +-- + +function MultiCastFlyoutFrame_OnShow(self) + MultiCastFlyoutFrameOpenButton_Hide(MultiCastFlyoutFrameOpenButton, true); +end + +function MultiCastFlyoutFrame_OnHide(self) + self.type = nil; + self.parent = nil; +end + +function MultiCastFlyoutFrame_OnEnter(self) +end + +function MultiCastFlyoutFrame_OnLeave(self) +--[[ + if ( not self:IsMouseOver() ) then + self.closeCountdownSec = MULTI_CAST_FLYOUT_CLOSE_SEC; + end +--]] +end + +function MultiCastFlyoutFrame_OnUpdate(self, elapsed) +--[[ + local closeCountdownSec = self.closeCountdownSec; + if ( closeCountdownSec ) then + closeCountdownSec = closeCountdownSec - elapsed; + if ( closeCountdownSec <= 0 ) then + self.closeCountdownSec = nil; + self:Hide(); + else + self.closeCountdownSec = closeCountdownSec; + end + end +--]] +end + +function MultiCastFlyoutFrame_Hide(self, forceHide) + if ( forceHide or not self:IsMouseOver() ) then + if ( self.parent ) then + if ( self.parent:IsMouseOver() ) then + MultiCastFlyoutFrameOpenButton_Show(MultiCastFlyoutFrameOpenButton, self.type, self.parent); + else + self.parent:UnregisterEvent("MODIFIER_STATE_CHANGED"); + end + end + self:Hide(); + end +end + +function MultiCastFlyoutFrame_ToggleFlyout(self, type, parent) + if ( self:IsShown() and self.parent == parent ) then + MultiCastFlyoutFrame_Hide(self, true); + else + local toptcoords; + local midtcoords; + local closetcoords; + if ( type == "slot" ) then + local actionId = parent:GetID(); + local slot = _ComputeMultiCastSlot(actionId); + if ( MultiCastFlyoutFrame_LoadSlotSpells(self, slot, GetMultiCastTotemSpells(actionId)) ) then + toptcoords = FLYOUT_TOP_TCOORDS[slot]; + midtcoords = FLYOUT_MIDDLE_TCOORDS[slot]; + closetcoords = FLYOUT_DOWN_BUTTON_TCOORDS[slot]; + end + elseif ( type == "page" ) then + if ( MultiCastFlyoutFrame_LoadPageSpells(self) ) then + toptcoords = FLYOUT_TOP_TCOORDS["summon"]; + midtcoords = FLYOUT_MIDDLE_TCOORDS["summon"]; + closetcoords = FLYOUT_DOWN_BUTTON_TCOORDS["summon"]; + end + end + if ( toptcoords ) then + self.type = type; + self.parent = parent; + self:SetPoint("BOTTOM", parent, "TOP", 0, 0); + self:Show(); + + self.top:SetTexCoord(toptcoords.left, toptcoords.right, toptcoords.top, toptcoords.bottom); + self.middle:SetTexCoord(midtcoords.left, midtcoords.right, midtcoords.top, midtcoords.bottom); + MultiCastFlyoutFrameCloseButton.normalTexture:SetTexCoord(closetcoords.left, closetcoords.right, closetcoords.top, closetcoords.bottom); + end + end +end + +function MultiCastFlyoutFrame_LoadPageSpells(self) + local numKnownSpells = 0; + for i, spellId in ipairs(TOTEM_MULTI_CAST_SUMMON_SPELLS) do + if ( knownMultiCastSummonSpells[i] ) then + numKnownSpells = numKnownSpells + 1; + end + end + if ( numKnownSpells == 0 ) then + return false; + end + + self.buttons = self.buttons or {}; + local buttons = self.buttons; + local numButtons = #buttons; + + local totalHeight = 0; + local button; + local name, _, icon; + local buttonIndex = 1; + for i, spellId in ipairs(TOTEM_MULTI_CAST_SUMMON_SPELLS) do + if ( knownMultiCastSummonSpells[i] ) then + -- create the button + if ( buttonIndex <= numButtons ) then + button = buttons[buttonIndex]; + if ( buttonIndex == 1 ) then + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET; + else + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_OFFSET; + end + else + button = CreateFrame("Button", "MultiCastFlyoutButton"..buttonIndex, self, "MultiCastFlyoutButtonTemplate"); + if ( buttonIndex == 1 ) then + -- this is the first button, anchor it to the frame + button:SetPoint("BOTTOM", self, "BOTTOM", 0, MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET); + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET; + else + -- this is not the first button, anchor it to the previous button + button:SetPoint("BOTTOM", buttons[buttonIndex - 1], "TOP", 0, MULTI_CAST_FLYOUT_BUTTON_OFFSET); + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_OFFSET; + end + end + totalHeight = totalHeight + button:GetHeight(); + + -- setup the button + button.page = i; + button.spellId = spellId; + icon = C_Spell.GetSpellTexture(spellId); + button.icon:SetTexture(icon); + button.icon:SetTexCoord(0.0, 1.0, 0.0, 1.0); + + button:Show(); + + buttonIndex = buttonIndex + 1; + end + end + -- hide unused buttons + for i = buttonIndex, numButtons do + buttons[i]:Hide(); + end + + self:SetHeight(totalHeight + 2 + MultiCastFlyoutFrameCloseButton:GetHeight()); + + return true; +end + +function MultiCastFlyoutFrame_LoadSlotSpells(self, slot, ...) + local numSpells = select("#", ...); + if ( numSpells == 0 ) then + return false; + end + -- add one to numSpells to represent the "none" slot + numSpells = numSpells + 1; + + self.buttons = self.buttons or {}; + local buttons = self.buttons; + local numButtons = #buttons; + + local totalHeight = 0; + local button; + local spellId; + local name, _, icon; + local tcoords; + local tcoordLeft, tcoordRight, tcoordTop, tcoordBottom; + for i = 1, numSpells do + -- create the button + if ( i <= numButtons ) then + button = buttons[i]; + if ( i == 1 ) then + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET; + else + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_OFFSET; + end + else + button = CreateFrame("Button", "MultiCastFlyoutButton"..i, self, "MultiCastFlyoutButtonTemplate"); + button:ClearAllPoints(); + if ( i == 1 ) then + -- this is the first button, anchor it to the frame + button:SetPoint("BOTTOM", self, "BOTTOM", 0, MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET); + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_INITIAL_OFFSET; + else + -- this is not the first button, anchor it to the previous button + button:SetPoint("BOTTOM", buttons[i - 1], "TOP", 0, MULTI_CAST_FLYOUT_BUTTON_OFFSET); + totalHeight = totalHeight + MULTI_CAST_FLYOUT_BUTTON_OFFSET; + end + end + totalHeight = totalHeight + button:GetHeight(); + + -- setup the button + if ( i == 1 ) then + -- the first button clears your slot + spellId = 0; + icon = "Interface\\Buttons\\UI-TotemBar"; + tcoords = SLOT_EMPTY_TCOORDS[slot]; + tcoordLeft, tcoordRight, tcoordTop, tcoordBottom = tcoords.left, tcoords.right, tcoords.top, tcoords.bottom; + else + spellId = select(i - 1, ...); + icon = C_Spell.GetSpellTexture(spellId); + tcoordLeft, tcoordRight, tcoordTop, tcoordBottom = 0.0, 1.0, 0.0, 1.0; + end + button.spellId = spellId; + button.icon:SetTexture(icon); + button.icon:SetTexCoord(tcoordLeft, tcoordRight, tcoordTop, tcoordBottom); + + button:Show(); + end + -- hide unused buttons + for i = numSpells + 1, numButtons do + buttons[i]:Hide(); + end + + self:SetHeight(totalHeight + 2 + MultiCastFlyoutFrameCloseButton:GetHeight()); + + return true; +end + + +-- +-- MultiCastFlyoutFrameCloseButton +-- + +function MultiCastFlyoutFrameCloseButton_OnClick(self) + self:GetParent():Hide(); +end + + +-- +-- MultiCastFlyoutFrameOpenButton +-- + +function MultiCastFlyoutFrameOpenButton_OnClick(self) + MultiCastFlyoutFrame_ToggleFlyout(MultiCastFlyoutFrame, self.type, self.parent); +end + +function MultiCastFlyoutFrameOpenButton_OnLeave(self) + self:Hide(); +end + +function MultiCastFlyoutFrameOpenButton_Show(self, type, parent) + local tcoords; + if ( type == "page" ) then + tcoords = FLYOUT_UP_BUTTON_TCOORDS["summon"]; + elseif ( type == "slot" ) then + local slot = _ComputeMultiCastSlot(parent:GetID()); + tcoords = FLYOUT_UP_BUTTON_TCOORDS[slot]; + end + if ( tcoords ) then + self.normalTexture:SetTexCoord(tcoords.left, tcoords.right, tcoords.top, tcoords.bottom); + self.type = type; + self.parent = parent; + self:SetParent(parent); + self:SetPoint("BOTTOM", parent, "TOP", 0, 0); + self:Show(); + end +end + +function MultiCastFlyoutFrameOpenButton_Hide(self, force) + if ( force or (not self:IsMouseOver() and not self.parent:IsMouseOver()) ) then + self.type = nil; + self:Hide(); + end +end + + +-- +-- MultiCastSpellButton +-- + +function MultiCastSpellButton_OnLoad(self) + self:RegisterForClicks("AnyUp"); + + local name = self:GetName(); + local normalTexture = _G[name.."NormalTexture"]; + normalTexture:SetWidth(50); + normalTexture:SetHeight(50); +end + +function MultiCastSpellButton_OnEvent(self, event, ...) + if ( event == "UPDATE_BINDINGS" or event == "GAME_PAD_ACTIVE_CHANGED" ) then + self:UpdateHotkeys(self.buttonType); + elseif ( event == "ACTIONBAR_UPDATE_COOLDOWN" ) then + MultiCastSpellButton_UpdateCooldown(self); + elseif ( event == "ACTIONBAR_UPDATE_STATE" ) then + MultiCastSpellButton_UpdateState(self); + end +end + +function MultiCastSpellButton_OnEnter(self) + MultiCastSpellButton_SetTooltip(self); +end + +function MultiCastSpellButton_OnLeave(self) + GameTooltip:Hide(); +end + +function MultiCastSpellButton_SetTooltip(self) + if ( GetCVarBool("UberTooltips") ) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + if ( GameTooltip:SetSpellByID(self.spellId, false, true) ) then + self.UpdateTooltip = MultiCastSpellButton_SetTooltip; + else + self.UpdateTooltip = nil; + end +end + +function MultiCastSpellButton_UpdateCooldown(self) + local cooldown = _G[self:GetName().."Cooldown"]; + local cooldownInfo = C_Spell.GetSpellCooldown(self.spellId); + if ( cooldownInfo ) then + CooldownFrame_Set(cooldown, cooldownInfo.startTime, cooldownInfo.duration, cooldownInfo.isEnabled); + else + CooldownFrame_Clear(cooldown); + end +end + +function MultiCastSpellButton_UpdateState(self) + if ( C_Spell.IsCurrentSpell(self.spellId) ) then + self:SetChecked(true); + else + self:SetChecked(false); + end +end + + +-- +-- MultiCastSummonSpellButton +-- + +function MultiCastSummonSpellButton_OnLoad(self) + self.buttonType = "MULTICASTSUMMONBUTTON"; + MultiCastSpellButton_OnLoad(self); +end + +function MultiCastSummonSpellButton_OnEvent(self, event, ...) + MultiCastSpellButton_OnEvent(self, event, ...); +--[[ + if ( event == "MODIFIER_STATE_CHANGED" ) then + if ( IsModifiedClick("SHOWMULTICASTFLYOUT") and self:IsMouseOver() ) then + MultiCastSummonSpellButton_OnEnter(self); + end + end +--]] +end + +function MultiCastSummonSpellButton_OnClick(self) + MultiCastSummonSpellButtonUp(self:GetID()); +end + +function MultiCastSummonSpellButton_OnEnter(self) + MultiCastSpellButton_OnEnter(self); + + if ( MultiCastFlyoutFrame.parent ~= self ) then + MultiCastFlyoutFrameOpenButton_Show(MultiCastFlyoutFrameOpenButton, "page", self); + end +--[[ + self:RegisterEvent("MODIFIER_STATE_CHANGED"); + if ( IsModifiedClick("SHOWMULTICASTFLYOUT") ) then + MultiCastFlyoutFrame_ToggleFlyout(MultiCastFlyoutFrame, "page", self); + end +--]] +end + +function MultiCastSummonSpellButton_OnLeave(self) + MultiCastSpellButton_OnLeave(self); + MultiCastFlyoutFrameOpenButton_Hide(MultiCastFlyoutFrameOpenButton); +end + +function MultiCastSummonSpellButton_Update(self) + -- first update which multi-cast spells we actually know + for index, spellId in ipairs(TOTEM_MULTI_CAST_SUMMON_SPELLS) do + local spellBank = Enum.SpellBookSpellBank.Player; + local includeOverrides = false; + knownMultiCastSummonSpells[index] = (C_SpellBook.IsSpellInSpellBook(spellId, spellBank, includeOverrides) and spellId) or nil; + end + + -- update the spell button + local spellId = knownMultiCastSummonSpells[self:GetID()]; + self.spellId = spellId; + if ( HasMultiCastActionBar() and spellId ) then + local icon = C_Spell.GetSpellTexture(spellId); + local buttonName = self:GetName(); + _G[buttonName.."Icon"]:SetTexture(icon); + + if ( not self.eventsRegistered ) then + self:RegisterEvent("UPDATE_BINDINGS"); + self:RegisterEvent("GAME_PAD_ACTIVE_CHANGED"); + self:RegisterEvent("ACTIONBAR_UPDATE_STATE"); + self:RegisterEvent("ACTIONBAR_UPDATE_COOLDOWN"); + self.eventsRegistered = true; + end + self:UpdateHotkeys(self.buttonType); + MultiCastSpellButton_UpdateCooldown(self); + + if ( GameTooltip:GetOwner() == self ) then + MultiCastSpellButton_SetTooltip(self); + end + + -- reanchor the first slot button take make room for this button + local width = self:GetWidth(); + local xOffset = width + 8 + 3; + local page; + for i = 1, NUM_MULTI_CAST_PAGES do + page = _G["MultiCastActionPage"..i]; + page:SetPoint("BOTTOMLEFT", page:GetParent(), "BOTTOMLEFT", xOffset, 3); + end + MultiCastSlotButton1:SetPoint("BOTTOMLEFT", self:GetParent(), "BOTTOMLEFT", xOffset, 3); + + self:Show(); + else + if ( self.eventsRegistered ) then + self:UnregisterEvent("UPDATE_BINDINGS"); + self:UnregisterEvent("GAME_PAD_ACTIVE_CHANGED"); + self:UnregisterEvent("ACTIONBAR_UPDATE_STATE"); + self:UnregisterEvent("ACTIONBAR_UPDATE_COOLDOWN"); + self.eventsRegistered = false; + end + + -- reanchor the first slot button take the place of this button + local xOffset = 3; + local page; + for i = 1, NUM_MULTI_CAST_PAGES do + page = _G["MultiCastActionPage"..i]; + page:SetPoint("BOTTOMLEFT", page:GetParent(), "BOTTOMLEFT", xOffset, 3); + end + MultiCastSlotButton1:SetPoint("BOTTOMLEFT", self:GetParent(), "BOTTOMLEFT", xOffset, 3); + + self:Hide(); + end +end + +function MultiCastSummonSpellButtonUp(id) + CastSpellByID(TOTEM_MULTI_CAST_SUMMON_SPELLS[id]); +end + + +-- +-- MultiCastRecallSpellButton +-- + +function MultiCastRecallSpellButton_OnLoad(self) + self.buttonType = "MULTICASTRECALLBUTTON"; + MultiCastSpellButton_OnLoad(self); +end + +function MultiCastRecallSpellButton_OnClick(self) + MultiCastRecallSpellButtonUp(self:GetID()); +end + +function MultiCastRecallSpellButton_Update(self) + -- first update which multi-cast spells we actually know + for index, spellId in ipairs(TOTEM_MULTI_CAST_RECALL_SPELLS) do + local spellBank = Enum.SpellBookSpellBank.Player; + local includeOverrides = false; + knownMultiCastRecallSpells[index] = (C_SpellBook.IsSpellInSpellBook(spellId, spellBank, includeOverrides) and spellId) or nil; + end + + -- update the spell button + local spellId = knownMultiCastRecallSpells[self:GetID()]; + self.spellId = spellId; + if ( HasMultiCastActionBar() and spellId ) then + local icon = C_Spell.GetSpellTexture(spellId); + local buttonName = self:GetName(); + _G[buttonName.."Icon"]:SetTexture(icon); + + if ( not self.eventsRegistered ) then + self:RegisterEvent("UPDATE_BINDINGS"); + self:RegisterEvent("GAME_PAD_ACTIVE_CHANGED"); + self:RegisterEvent("ACTIONBAR_UPDATE_STATE"); + self:RegisterEvent("ACTIONBAR_UPDATE_COOLDOWN"); + self.eventsRegistered = true; + end + self:UpdateHotkeys(self.buttonType); + MultiCastSpellButton_UpdateCooldown(self); + + if ( GameTooltip:GetOwner() == self ) then + MultiCastSpellButton_SetTooltip(self); + end + + -- anchor to the last shown slot + local activeSlots = MultiCastActionBarFrame.numActiveSlots; + if ( activeSlots > 0 ) then + self:SetPoint("LEFT", _G["MultiCastSlotButton"..activeSlots], "RIGHT", 8, 0); + end + + self:Show(); + else + if ( self.eventsRegistered ) then + self:UnregisterEvent("UPDATE_BINDINGS"); + self:UnregisterEvent("GAME_PAD_ACTIVE_CHANGED"); + self:UnregisterEvent("ACTIONBAR_UPDATE_STATE"); + self:UnregisterEvent("ACTIONBAR_UPDATE_COOLDOWN"); + self.eventsRegistered = false; + end + + self:Hide(); + end +end + +function MultiCastRecallSpellButtonUp(id) + CastSpellByID(TOTEM_MULTI_CAST_RECALL_SPELLS[id]); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml new file mode 100644 index 0000000..e20cd05 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml @@ -0,0 +1,382 @@ + + + + + + + + + + + + + + + + + + + + + + MultiCastSlotButton_OnEvent(self, event, ...); + + + MultiCastSlotButton_OnEnter(self); + + + MultiCastSlotButton_OnLeave(self); + + + + + + + + + + + + + + + + + + + MultiCastActionButton_OnLoad(self); + + + MultiCastActionButton_OnEvent(self, event, ...); + + + MultiCastActionButton_OnShow(self); + + + MultiCastActionButton_OnEnter(self); + + + MultiCastActionButton_OnLeave(self); + + + MultiCastActionButton_OnPostClick(self, button, down); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MultiCastFlyoutButton_OnLoad(self); + + + MultiCastFlyoutButton_OnClick(self); + + + MultiCastFlyoutButton_OnEnter(self); + + + MultiCastFlyoutButton_OnLeave(self); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml.annotated.lua new file mode 100644 index 0000000..0f310c8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml.annotated.lua @@ -0,0 +1,952 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L3) +--- Template +--- @class MultiCastSlotButtonTemplate : CheckButton +--- @field background Texture +--- @field overlayTex Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L34) +--- Explicitly protected +--- Template +--- @class MultiCastActionButtonTemplate : CheckButton, ActionBarButtonTemplate +--- @field overlayTex Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L74) +--- child of MultiCastSpellButton +--- @class MultiCastSpellButton_HotKey : FontString, NumberFontNormalSmallGray + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L67) +--- Explicitly protected +--- Template +--- @class MultiCastSpellButton : CheckButton, SecureFrameTemplate, ActionButtonTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L99) +--- Template +--- @class MultiCastFlyoutButtonTemplate : CheckButton +--- @field icon Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L167) +--- child of MultiCastFlyoutFrame +--- @class MultiCastFlyoutFrameCloseButton : Button +--- @field normalTexture Texture +MultiCastFlyoutFrameCloseButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L145) +--- child of MultiCastFlyoutFrame +--- @class MultiCastFlyoutFrameTop : Texture +MultiCastFlyoutFrameTop = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L153) +--- child of MultiCastFlyoutFrame +--- @class MultiCastFlyoutFrameMiddle : Texture +MultiCastFlyoutFrameMiddle = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L136) +--- child of MultiCastActionBarFrame +--- @class MultiCastFlyoutFrame : Frame +--- @field top MultiCastFlyoutFrameTop +--- @field middle MultiCastFlyoutFrameMiddle +MultiCastFlyoutFrame = {} +MultiCastFlyoutFrame["top"] = MultiCastFlyoutFrameTop +MultiCastFlyoutFrame["middle"] = MultiCastFlyoutFrameMiddle + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L195) +--- child of MultiCastActionBarFrame +--- @class MultiCastFlyoutFrameOpenButton : Button +--- @field normalTexture Texture +MultiCastFlyoutFrameOpenButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L221) +--- child of MultiCastSummonSpellButton +--- @class MultiCastSummonSpellButtonFlyoutButton : Button +MultiCastSummonSpellButtonFlyoutButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L74) +--- child of MultiCastSummonSpellButton (created in template MultiCastSpellButton) +--- @type MultiCastSpellButton_HotKey +MultiCastSummonSpellButtonHotKey = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L82) +--- child of MultiCastSummonSpellButton (created in template MultiCastSpellButton) +--- @type Texture +MultiCastSummonSpellButtonHighlight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastSummonSpellButton (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastSummonSpellButtonCooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastSummonSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastSummonSpellButtonIcon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastSummonSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastSummonSpellButtonFlash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastSummonSpellButton (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastSummonSpellButtonName = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastSummonSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastSummonSpellButtonBorder = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastSummonSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastSummonSpellButtonNormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L215) +--- Explicitly protected +--- child of MultiCastActionBarFrame +--- @class MultiCastSummonSpellButton : CheckButton, MultiCastSpellButton +--- @field flyoutButton MultiCastSummonSpellButtonFlyoutButton +MultiCastSummonSpellButton = {} +MultiCastSummonSpellButton["flyoutButton"] = MultiCastSummonSpellButtonFlyoutButton +MultiCastSummonSpellButton["enableSpellFX"] = true -- inherited +MultiCastSummonSpellButton["enableLOCCooldown"] = true -- inherited +MultiCastSummonSpellButton["popupDirection"] = "UP" -- inherited +MultiCastSummonSpellButton["popupOffset"] = -4 -- inherited +MultiCastSummonSpellButton["popupCrossAxisSize"] = 47 -- inherited +MultiCastSummonSpellButton["openArrowOffset"] = 2 -- inherited +MultiCastSummonSpellButton["closedArrowOffset"] = 4 -- inherited +MultiCastSummonSpellButton["arrowMainAxisSize"] = 18 -- inherited +MultiCastSummonSpellButton["arrowCrossAxisSize"] = 7 -- inherited +MultiCastSummonSpellButton["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastSummonSpellButton["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastSummonSpellButton["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastSummonSpellButton["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastSummonSpellButton["cooldown"] = MultiCastSummonSpellButtonCooldown -- inherited +MultiCastSummonSpellButton["icon"] = MultiCastSummonSpellButtonIcon -- inherited +MultiCastSummonSpellButton["Flash"] = MultiCastSummonSpellButtonFlash -- inherited +MultiCastSummonSpellButton["Name"] = MultiCastSummonSpellButtonName -- inherited +MultiCastSummonSpellButton["Border"] = MultiCastSummonSpellButtonBorder -- inherited +MultiCastSummonSpellButton["NormalTexture"] = MultiCastSummonSpellButtonNormalTexture -- inherited +MultiCastSummonSpellButton["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastSummonSpellButton["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastSummonSpellButton["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L261) +--- child of MultiCastActionBarFrame +--- @class MultiCastSlotButton1 : CheckButton, MultiCastSlotButtonTemplate +MultiCastSlotButton1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L266) +--- child of MultiCastActionBarFrame +--- @class MultiCastSlotButton2 : CheckButton, MultiCastSlotButtonTemplate +MultiCastSlotButton2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L271) +--- child of MultiCastActionBarFrame +--- @class MultiCastSlotButton3 : CheckButton, MultiCastSlotButtonTemplate +MultiCastSlotButton3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L276) +--- child of MultiCastActionBarFrame +--- @class MultiCastSlotButton4 : CheckButton, MultiCastSlotButtonTemplate +MultiCastSlotButton4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton1 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton1Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton1 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton1Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton1 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton1Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton1 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton1Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton1 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton1Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton1 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton1NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L287) +--- Explicitly protected +--- child of MultiCastActionPage1 +--- @class MultiCastActionButton1 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton1 = {} +MultiCastActionButton1["enableSpellFX"] = true -- inherited +MultiCastActionButton1["enableLOCCooldown"] = true -- inherited +MultiCastActionButton1["popupDirection"] = "UP" -- inherited +MultiCastActionButton1["popupOffset"] = -4 -- inherited +MultiCastActionButton1["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton1["openArrowOffset"] = 2 -- inherited +MultiCastActionButton1["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton1["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton1["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton1["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton1["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton1["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton1["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton1["cooldown"] = MultiCastActionButton1Cooldown -- inherited +MultiCastActionButton1["icon"] = MultiCastActionButton1Icon -- inherited +MultiCastActionButton1["Flash"] = MultiCastActionButton1Flash -- inherited +MultiCastActionButton1["Name"] = MultiCastActionButton1Name -- inherited +MultiCastActionButton1["Border"] = MultiCastActionButton1Border -- inherited +MultiCastActionButton1["NormalTexture"] = MultiCastActionButton1NormalTexture -- inherited +MultiCastActionButton1["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton1["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton1["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton2 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton2Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton2 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton2Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton2 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton2Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton2 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton2Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton2 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton2Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton2 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton2NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L292) +--- Explicitly protected +--- child of MultiCastActionPage1 +--- @class MultiCastActionButton2 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton2 = {} +MultiCastActionButton2["enableSpellFX"] = true -- inherited +MultiCastActionButton2["enableLOCCooldown"] = true -- inherited +MultiCastActionButton2["popupDirection"] = "UP" -- inherited +MultiCastActionButton2["popupOffset"] = -4 -- inherited +MultiCastActionButton2["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton2["openArrowOffset"] = 2 -- inherited +MultiCastActionButton2["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton2["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton2["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton2["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton2["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton2["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton2["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton2["cooldown"] = MultiCastActionButton2Cooldown -- inherited +MultiCastActionButton2["icon"] = MultiCastActionButton2Icon -- inherited +MultiCastActionButton2["Flash"] = MultiCastActionButton2Flash -- inherited +MultiCastActionButton2["Name"] = MultiCastActionButton2Name -- inherited +MultiCastActionButton2["Border"] = MultiCastActionButton2Border -- inherited +MultiCastActionButton2["NormalTexture"] = MultiCastActionButton2NormalTexture -- inherited +MultiCastActionButton2["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton2["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton2["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton3 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton3Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton3 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton3Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton3 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton3Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton3 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton3Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton3 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton3Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton3 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton3NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L297) +--- Explicitly protected +--- child of MultiCastActionPage1 +--- @class MultiCastActionButton3 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton3 = {} +MultiCastActionButton3["enableSpellFX"] = true -- inherited +MultiCastActionButton3["enableLOCCooldown"] = true -- inherited +MultiCastActionButton3["popupDirection"] = "UP" -- inherited +MultiCastActionButton3["popupOffset"] = -4 -- inherited +MultiCastActionButton3["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton3["openArrowOffset"] = 2 -- inherited +MultiCastActionButton3["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton3["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton3["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton3["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton3["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton3["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton3["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton3["cooldown"] = MultiCastActionButton3Cooldown -- inherited +MultiCastActionButton3["icon"] = MultiCastActionButton3Icon -- inherited +MultiCastActionButton3["Flash"] = MultiCastActionButton3Flash -- inherited +MultiCastActionButton3["Name"] = MultiCastActionButton3Name -- inherited +MultiCastActionButton3["Border"] = MultiCastActionButton3Border -- inherited +MultiCastActionButton3["NormalTexture"] = MultiCastActionButton3NormalTexture -- inherited +MultiCastActionButton3["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton3["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton3["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton4 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton4Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton4 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton4Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton4 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton4Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton4 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton4Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton4 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton4Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton4 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton4NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L302) +--- Explicitly protected +--- child of MultiCastActionPage1 +--- @class MultiCastActionButton4 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton4 = {} +MultiCastActionButton4["enableSpellFX"] = true -- inherited +MultiCastActionButton4["enableLOCCooldown"] = true -- inherited +MultiCastActionButton4["popupDirection"] = "UP" -- inherited +MultiCastActionButton4["popupOffset"] = -4 -- inherited +MultiCastActionButton4["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton4["openArrowOffset"] = 2 -- inherited +MultiCastActionButton4["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton4["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton4["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton4["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton4["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton4["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton4["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton4["cooldown"] = MultiCastActionButton4Cooldown -- inherited +MultiCastActionButton4["icon"] = MultiCastActionButton4Icon -- inherited +MultiCastActionButton4["Flash"] = MultiCastActionButton4Flash -- inherited +MultiCastActionButton4["Name"] = MultiCastActionButton4Name -- inherited +MultiCastActionButton4["Border"] = MultiCastActionButton4Border -- inherited +MultiCastActionButton4["NormalTexture"] = MultiCastActionButton4NormalTexture -- inherited +MultiCastActionButton4["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton4["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton4["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L281) +--- Implicitly protected +--- child of MultiCastActionBarFrame +--- @class MultiCastActionPage1 : Frame +MultiCastActionPage1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton5 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton5Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton5 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton5Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton5 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton5Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton5 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton5Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton5 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton5Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton5 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton5NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L315) +--- Explicitly protected +--- child of MultiCastActionPage2 +--- @class MultiCastActionButton5 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton5 = {} +MultiCastActionButton5["enableSpellFX"] = true -- inherited +MultiCastActionButton5["enableLOCCooldown"] = true -- inherited +MultiCastActionButton5["popupDirection"] = "UP" -- inherited +MultiCastActionButton5["popupOffset"] = -4 -- inherited +MultiCastActionButton5["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton5["openArrowOffset"] = 2 -- inherited +MultiCastActionButton5["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton5["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton5["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton5["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton5["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton5["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton5["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton5["cooldown"] = MultiCastActionButton5Cooldown -- inherited +MultiCastActionButton5["icon"] = MultiCastActionButton5Icon -- inherited +MultiCastActionButton5["Flash"] = MultiCastActionButton5Flash -- inherited +MultiCastActionButton5["Name"] = MultiCastActionButton5Name -- inherited +MultiCastActionButton5["Border"] = MultiCastActionButton5Border -- inherited +MultiCastActionButton5["NormalTexture"] = MultiCastActionButton5NormalTexture -- inherited +MultiCastActionButton5["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton5["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton5["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton6 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton6Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton6 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton6Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton6 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton6Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton6 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton6Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton6 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton6Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton6 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton6NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L320) +--- Explicitly protected +--- child of MultiCastActionPage2 +--- @class MultiCastActionButton6 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton6 = {} +MultiCastActionButton6["enableSpellFX"] = true -- inherited +MultiCastActionButton6["enableLOCCooldown"] = true -- inherited +MultiCastActionButton6["popupDirection"] = "UP" -- inherited +MultiCastActionButton6["popupOffset"] = -4 -- inherited +MultiCastActionButton6["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton6["openArrowOffset"] = 2 -- inherited +MultiCastActionButton6["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton6["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton6["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton6["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton6["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton6["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton6["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton6["cooldown"] = MultiCastActionButton6Cooldown -- inherited +MultiCastActionButton6["icon"] = MultiCastActionButton6Icon -- inherited +MultiCastActionButton6["Flash"] = MultiCastActionButton6Flash -- inherited +MultiCastActionButton6["Name"] = MultiCastActionButton6Name -- inherited +MultiCastActionButton6["Border"] = MultiCastActionButton6Border -- inherited +MultiCastActionButton6["NormalTexture"] = MultiCastActionButton6NormalTexture -- inherited +MultiCastActionButton6["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton6["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton6["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton7 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton7Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton7 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton7Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton7 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton7Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton7 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton7Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton7 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton7Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton7 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton7NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L325) +--- Explicitly protected +--- child of MultiCastActionPage2 +--- @class MultiCastActionButton7 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton7 = {} +MultiCastActionButton7["enableSpellFX"] = true -- inherited +MultiCastActionButton7["enableLOCCooldown"] = true -- inherited +MultiCastActionButton7["popupDirection"] = "UP" -- inherited +MultiCastActionButton7["popupOffset"] = -4 -- inherited +MultiCastActionButton7["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton7["openArrowOffset"] = 2 -- inherited +MultiCastActionButton7["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton7["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton7["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton7["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton7["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton7["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton7["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton7["cooldown"] = MultiCastActionButton7Cooldown -- inherited +MultiCastActionButton7["icon"] = MultiCastActionButton7Icon -- inherited +MultiCastActionButton7["Flash"] = MultiCastActionButton7Flash -- inherited +MultiCastActionButton7["Name"] = MultiCastActionButton7Name -- inherited +MultiCastActionButton7["Border"] = MultiCastActionButton7Border -- inherited +MultiCastActionButton7["NormalTexture"] = MultiCastActionButton7NormalTexture -- inherited +MultiCastActionButton7["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton7["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton7["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton8 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton8Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton8 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton8Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton8 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton8Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton8 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton8Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton8 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton8Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton8 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton8NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L330) +--- Explicitly protected +--- child of MultiCastActionPage2 +--- @class MultiCastActionButton8 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton8 = {} +MultiCastActionButton8["enableSpellFX"] = true -- inherited +MultiCastActionButton8["enableLOCCooldown"] = true -- inherited +MultiCastActionButton8["popupDirection"] = "UP" -- inherited +MultiCastActionButton8["popupOffset"] = -4 -- inherited +MultiCastActionButton8["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton8["openArrowOffset"] = 2 -- inherited +MultiCastActionButton8["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton8["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton8["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton8["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton8["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton8["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton8["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton8["cooldown"] = MultiCastActionButton8Cooldown -- inherited +MultiCastActionButton8["icon"] = MultiCastActionButton8Icon -- inherited +MultiCastActionButton8["Flash"] = MultiCastActionButton8Flash -- inherited +MultiCastActionButton8["Name"] = MultiCastActionButton8Name -- inherited +MultiCastActionButton8["Border"] = MultiCastActionButton8Border -- inherited +MultiCastActionButton8["NormalTexture"] = MultiCastActionButton8NormalTexture -- inherited +MultiCastActionButton8["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton8["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton8["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L309) +--- Implicitly protected +--- child of MultiCastActionBarFrame +--- @class MultiCastActionPage2 : Frame +MultiCastActionPage2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton9 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton9Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton9 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton9Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton9 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton9Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton9 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton9Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton9 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton9Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton9 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton9NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L343) +--- Explicitly protected +--- child of MultiCastActionPage3 +--- @class MultiCastActionButton9 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton9 = {} +MultiCastActionButton9["enableSpellFX"] = true -- inherited +MultiCastActionButton9["enableLOCCooldown"] = true -- inherited +MultiCastActionButton9["popupDirection"] = "UP" -- inherited +MultiCastActionButton9["popupOffset"] = -4 -- inherited +MultiCastActionButton9["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton9["openArrowOffset"] = 2 -- inherited +MultiCastActionButton9["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton9["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton9["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton9["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton9["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton9["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton9["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton9["cooldown"] = MultiCastActionButton9Cooldown -- inherited +MultiCastActionButton9["icon"] = MultiCastActionButton9Icon -- inherited +MultiCastActionButton9["Flash"] = MultiCastActionButton9Flash -- inherited +MultiCastActionButton9["Name"] = MultiCastActionButton9Name -- inherited +MultiCastActionButton9["Border"] = MultiCastActionButton9Border -- inherited +MultiCastActionButton9["NormalTexture"] = MultiCastActionButton9NormalTexture -- inherited +MultiCastActionButton9["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton9["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton9["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton10 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton10Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton10 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton10Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton10 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton10Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton10 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton10Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton10 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton10Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton10 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton10NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L348) +--- Explicitly protected +--- child of MultiCastActionPage3 +--- @class MultiCastActionButton10 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton10 = {} +MultiCastActionButton10["enableSpellFX"] = true -- inherited +MultiCastActionButton10["enableLOCCooldown"] = true -- inherited +MultiCastActionButton10["popupDirection"] = "UP" -- inherited +MultiCastActionButton10["popupOffset"] = -4 -- inherited +MultiCastActionButton10["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton10["openArrowOffset"] = 2 -- inherited +MultiCastActionButton10["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton10["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton10["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton10["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton10["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton10["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton10["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton10["cooldown"] = MultiCastActionButton10Cooldown -- inherited +MultiCastActionButton10["icon"] = MultiCastActionButton10Icon -- inherited +MultiCastActionButton10["Flash"] = MultiCastActionButton10Flash -- inherited +MultiCastActionButton10["Name"] = MultiCastActionButton10Name -- inherited +MultiCastActionButton10["Border"] = MultiCastActionButton10Border -- inherited +MultiCastActionButton10["NormalTexture"] = MultiCastActionButton10NormalTexture -- inherited +MultiCastActionButton10["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton10["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton10["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton11 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton11Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton11 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton11Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton11 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton11Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton11 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton11Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton11 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton11Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton11 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton11NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L353) +--- Explicitly protected +--- child of MultiCastActionPage3 +--- @class MultiCastActionButton11 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton11 = {} +MultiCastActionButton11["enableSpellFX"] = true -- inherited +MultiCastActionButton11["enableLOCCooldown"] = true -- inherited +MultiCastActionButton11["popupDirection"] = "UP" -- inherited +MultiCastActionButton11["popupOffset"] = -4 -- inherited +MultiCastActionButton11["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton11["openArrowOffset"] = 2 -- inherited +MultiCastActionButton11["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton11["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton11["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton11["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton11["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton11["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton11["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton11["cooldown"] = MultiCastActionButton11Cooldown -- inherited +MultiCastActionButton11["icon"] = MultiCastActionButton11Icon -- inherited +MultiCastActionButton11["Flash"] = MultiCastActionButton11Flash -- inherited +MultiCastActionButton11["Name"] = MultiCastActionButton11Name -- inherited +MultiCastActionButton11["Border"] = MultiCastActionButton11Border -- inherited +MultiCastActionButton11["NormalTexture"] = MultiCastActionButton11NormalTexture -- inherited +MultiCastActionButton11["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton11["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton11["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastActionButton12 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastActionButton12Cooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastActionButton12 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton12Icon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastActionButton12 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton12Flash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastActionButton12 (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastActionButton12Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastActionButton12 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton12Border = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastActionButton12 (created in template ActionButtonTemplate) +--- @type Texture +MultiCastActionButton12NormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L358) +--- Explicitly protected +--- child of MultiCastActionPage3 +--- @class MultiCastActionButton12 : CheckButton, MultiCastActionButtonTemplate +MultiCastActionButton12 = {} +MultiCastActionButton12["enableSpellFX"] = true -- inherited +MultiCastActionButton12["enableLOCCooldown"] = true -- inherited +MultiCastActionButton12["popupDirection"] = "UP" -- inherited +MultiCastActionButton12["popupOffset"] = -4 -- inherited +MultiCastActionButton12["popupCrossAxisSize"] = 47 -- inherited +MultiCastActionButton12["openArrowOffset"] = 2 -- inherited +MultiCastActionButton12["closedArrowOffset"] = 4 -- inherited +MultiCastActionButton12["arrowMainAxisSize"] = 18 -- inherited +MultiCastActionButton12["arrowCrossAxisSize"] = 7 -- inherited +MultiCastActionButton12["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastActionButton12["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastActionButton12["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastActionButton12["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastActionButton12["cooldown"] = MultiCastActionButton12Cooldown -- inherited +MultiCastActionButton12["icon"] = MultiCastActionButton12Icon -- inherited +MultiCastActionButton12["Flash"] = MultiCastActionButton12Flash -- inherited +MultiCastActionButton12["Name"] = MultiCastActionButton12Name -- inherited +MultiCastActionButton12["Border"] = MultiCastActionButton12Border -- inherited +MultiCastActionButton12["NormalTexture"] = MultiCastActionButton12NormalTexture -- inherited +MultiCastActionButton12["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastActionButton12["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastActionButton12["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L337) +--- Implicitly protected +--- child of MultiCastActionBarFrame +--- @class MultiCastActionPage3 : Frame +MultiCastActionPage3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L74) +--- child of MultiCastRecallSpellButton (created in template MultiCastSpellButton) +--- @type MultiCastSpellButton_HotKey +MultiCastRecallSpellButtonHotKey = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L82) +--- child of MultiCastRecallSpellButton (created in template MultiCastSpellButton) +--- @type Texture +MultiCastRecallSpellButtonHighlight = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L111) +--- child of MultiCastRecallSpellButton (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Cooldown +MultiCastRecallSpellButtonCooldown = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L23) +--- child of MultiCastRecallSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastRecallSpellButtonIcon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L36) +--- child of MultiCastRecallSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastRecallSpellButtonFlash = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L43) +--- child of MultiCastRecallSpellButton (created in template ActionButtonTemplate) +--- @type ActionButtonTemplate_Name +MultiCastRecallSpellButtonName = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L49) +--- child of MultiCastRecallSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastRecallSpellButtonBorder = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L146) +--- child of MultiCastRecallSpellButton (created in template ActionButtonTemplate) +--- @type Texture +MultiCastRecallSpellButtonNormalTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L365) +--- Explicitly protected +--- child of MultiCastActionBarFrame +--- @class MultiCastRecallSpellButton : CheckButton, MultiCastSpellButton +MultiCastRecallSpellButton = {} +MultiCastRecallSpellButton["enableSpellFX"] = true -- inherited +MultiCastRecallSpellButton["enableLOCCooldown"] = true -- inherited +MultiCastRecallSpellButton["popupDirection"] = "UP" -- inherited +MultiCastRecallSpellButton["popupOffset"] = -4 -- inherited +MultiCastRecallSpellButton["popupCrossAxisSize"] = 47 -- inherited +MultiCastRecallSpellButton["openArrowOffset"] = 2 -- inherited +MultiCastRecallSpellButton["closedArrowOffset"] = 4 -- inherited +MultiCastRecallSpellButton["arrowMainAxisSize"] = 18 -- inherited +MultiCastRecallSpellButton["arrowCrossAxisSize"] = 7 -- inherited +MultiCastRecallSpellButton["hotkeyTextKeyboardX"] = -4 -- inherited +MultiCastRecallSpellButton["hotkeyTextKeyboardY"] = -5 -- inherited +MultiCastRecallSpellButton["hotkeyTextGamepadX"] = 0 -- inherited +MultiCastRecallSpellButton["hotkeyTextGamepadY"] = 0 -- inherited +MultiCastRecallSpellButton["cooldown"] = MultiCastRecallSpellButtonCooldown -- inherited +MultiCastRecallSpellButton["icon"] = MultiCastRecallSpellButtonIcon -- inherited +MultiCastRecallSpellButton["Flash"] = MultiCastRecallSpellButtonFlash -- inherited +MultiCastRecallSpellButton["Name"] = MultiCastRecallSpellButtonName -- inherited +MultiCastRecallSpellButton["Border"] = MultiCastRecallSpellButtonBorder -- inherited +MultiCastRecallSpellButton["NormalTexture"] = MultiCastRecallSpellButtonNormalTexture -- inherited +MultiCastRecallSpellButton["arrowNormalTexture"] = "UI-HUD-ActionBar-Flyout" -- inherited +MultiCastRecallSpellButton["arrowDownTexture"] = "UI-HUD-ActionBar-Flyout-Down" -- inherited +MultiCastRecallSpellButton["arrowOverTexture"] = "UI-HUD-ActionBar-Flyout-Mouseover" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/MultiCastActionBarFrame.xml#L128) +--- Implicitly protected +--- @class MultiCastActionBarFrame : Frame, UIParentBottomManagedFrameTemplate +--- @field layoutIndex number # 203 +--- @field align string # left +--- @field layoutOnBottom boolean # true +MultiCastActionBarFrame = {} +MultiCastActionBarFrame["layoutIndex"] = 203 +MultiCastActionBarFrame["align"] = "left" +MultiCastActionBarFrame["layoutOnBottom"] = true +MultiCastActionBarFrame["layoutParent"] = UIParentBottomManagedFrameContainer -- inherited +MultiCastActionBarFrame["hideWhenActionBarIsOverriden"] = true -- inherited +MultiCastActionBarFrame["ignoreInLayoutWhenActionBarIsOverriden"] = false -- inherited +MultiCastActionBarFrame["isBottomManagedFrame"] = true -- inherited +MultiCastActionBarFrame["isManagedFrame"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PetActionBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PetActionBar.lua.annotated.lua new file mode 100644 index 0000000..b6ef3df --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PetActionBar.lua.annotated.lua @@ -0,0 +1,387 @@ +NUM_PET_ACTION_SLOTS = 10; + +PET_DEFENSIVE_TEXTURE = "Interface\\Icons\\Ability_Defend"; +PET_AGGRESSIVE_TEXTURE = "Interface\\Icons\\Ability_Racial_BloodRage"; +PET_DEFENSIVEASSIST_TEXTURE = "Interface\\Icons\\Ability_Defend"; +PET_PASSIVE_TEXTURE = "Interface\\Icons\\Ability_Seal"; +PET_ASSIST_TEXTURE = "Interface\\Icons\\Ability_Hunter_Pet_Assist"; +PET_ATTACK_TEXTURE = "Interface\\Icons\\Ability_GhoulFrenzy"; +PET_FOLLOW_TEXTURE = "Interface\\Icons\\Ability_Tracking"; +PET_WAIT_TEXTURE = "Interface\\Icons\\Spell_Nature_TimeStop"; +PET_DISMISS_TEXTURE = "Interface\\Icons\\Spell_Shadow_Teleport"; +PET_MOVE_TO_TEXTURE = "Interface\\Icons\\Ability_Hunter_Pet_Goto"; + +PET_ACTION_HIGHLIGHT_MARKS = {}; + +PetActionBarMixin = {};--- @class PetActionBarMixin + +local function HasPetActionHighlightMark(index) + return PET_ACTION_HIGHLIGHT_MARKS[index]; +end + +local function CancelSpellLoadCallback(button) + if button.spellDataLoadedCancelFunc then + button.spellDataLoadedCancelFunc(); + button.spellDataLoadedCancelFunc = nil; + end +end + +function PetActionBarMixin:ClearPetActionHighlightMarks() + PET_ACTION_HIGHLIGHT_MARKS = {}; +end + +function PetActionBarMixin:UpdatePetActionHighlightMarks(petAction) + local petBarIndices = C_ActionBar.GetPetActionPetBarIndices(petAction); + if petBarIndices then + PET_ACTION_HIGHLIGHT_MARKS = tInvert(petBarIndices); + else + self:ClearPetActionHighlightMarks(); + end +end + +function PetActionBarMixin:OnHide() + self.mode = "none"; + for i=1, NUM_PET_ACTION_SLOTS, 1 do + CancelSpellLoadCallback(self.actionButtons[i]); + end +end + +function PetActionBarMixin:OnLoad() + self:RegisterEvent("PLAYER_CONTROL_LOST"); + self:RegisterEvent("PLAYER_CONTROL_GAINED"); + self:RegisterEvent("PLAYER_FARSIGHT_FOCUS_CHANGED"); + self:RegisterEvent("UNIT_PET"); + self:RegisterEvent("UNIT_FLAGS"); + self:RegisterEvent("PET_BAR_UPDATE"); + self:RegisterEvent("PET_BAR_UPDATE_COOLDOWN"); + self:RegisterEvent("PET_BAR_UPDATE_USABLE"); + self:RegisterEvent("PET_UI_UPDATE"); + self:RegisterEvent("PLAYER_TARGET_CHANGED"); + self:RegisterEvent("UPDATE_VEHICLE_ACTIONBAR"); + self:RegisterEvent("PLAYER_MOUNT_DISPLAY_CHANGED"); + self:RegisterUnitEvent("UNIT_AURA", "pet"); + self:Update(); + if ( PetHasActionBar() ) then + self:Show(); + self:LockPetActionBar(); + end +end + +function PetActionBarMixin:OnEvent(event, ...) + local arg1 = ...; + if ( event == "PET_BAR_UPDATE" or (event == "UNIT_PET" and arg1 == "player") or event == "PET_UI_UPDATE" or event == "UPDATE_VEHICLE_ACTIONBAR") then + if ( PetHasActionBar() and UnitIsVisible("pet") ) then + self:Update(); + self:Show(); + self:LockPetActionBar(); + self:UpdateShownButtons(); + else + self:UnlockPetActionBar(); + self:Hide(); + end + elseif ( event == "PLAYER_CONTROL_LOST" or event == "PLAYER_CONTROL_GAINED" or event == "PLAYER_FARSIGHT_FOCUS_CHANGED" or event == "PET_BAR_UPDATE_USABLE" or event == "PLAYER_TARGET_CHANGED" or event == "PLAYER_MOUNT_DISPLAY_CHANGED" ) then + self:Update(self); + elseif ( (event == "UNIT_FLAGS") or (event == "UNIT_AURA") ) then + if ( arg1 == "pet" ) then + self:Update(); + end + elseif ( event =="PET_BAR_UPDATE_COOLDOWN" ) then + self:UpdateCooldowns(); + end +end + +function PetActionBarMixin:OnUpdate(elapsed) + if ( self.slideTimer and (self.slideTimer < self.timeToSlide) ) then + self.completed = nil; + self.slideTimer = self.slideTimer + elapsed; + else + self.completed = 1; + if ( self.mode == "hide" ) then + self:Hide(); + end + self.mode = "none"; + end + + local rangeTimer = self.rangeTimer; + if ( rangeTimer ) then + rangeTimer = rangeTimer - elapsed; + if ( rangeTimer <= 0 ) then + for i=1, NUM_PET_ACTION_SLOTS, 1 do + local name, texture, isToken, isActive, autoCastAllowed, autoCastEnabled, spellID, checksRange, inRange = GetPetActionInfo(i); + ActionButton_UpdateRangeIndicator(self.actionButtons[i], checksRange, inRange); + end + rangeTimer = TOOLTIP_UPDATE_TIME; + end + self.rangeTimer = rangeTimer; + end +end + +function PetActionBarMixin:Update() + local petActionButton, petActionIcon, petAutoCastOverlay; + for i=1, NUM_PET_ACTION_SLOTS, 1 do + petActionButton = self.actionButtons[i]; + petActionIcon = petActionButton.icon; + petAutoCastOverlay = petActionButton.AutoCastOverlay; + local name, texture, isToken, isActive, autoCastAllowed, autoCastEnabled, spellID = GetPetActionInfo(i); + if ( not isToken ) then + petActionIcon:SetTexture(texture); + petActionButton.tooltipName = name; + else + petActionIcon:SetTexture(_G[texture]); + petActionButton.tooltipName = _G[name]; + end + petActionButton.isToken = isToken; + if spellID then + local spell = Spell:CreateFromSpellID(spellID); + petActionButton.spellDataLoadedCancelFunc = spell:ContinueWithCancelOnSpellLoad(function() + petActionButton.tooltipSubtext = spell:GetSpellSubtext(); + end); + end + if ( isActive ) then + if ( IsPetAttackAction(i) ) then + petActionButton:StartFlash(); + -- the checked texture looks a little confusing at full alpha (looks like you have an extra ability selected) + petActionButton:GetCheckedTexture():SetAlpha(0.5); + else + petActionButton:StopFlash(); + petActionButton:GetCheckedTexture():SetAlpha(1.0); + end + petActionButton:SetChecked(true); + else + petActionButton:StopFlash(); + petActionButton:SetChecked(false); + end + petAutoCastOverlay:SetShown(autoCastAllowed); + petAutoCastOverlay:ShowAutoCastEnabled(autoCastEnabled); + if ( texture ) then + if ( GetPetActionSlotUsable(i) ) then + petActionIcon:SetVertexColor(1, 1, 1); + else + petActionIcon:SetVertexColor(0.4, 0.4, 0.4); + end + petActionIcon:Show(); + else + petActionIcon:Hide(); + end + + SharedActionButton_RefreshSpellHighlight(petActionButton, HasPetActionHighlightMark(i)); + end + self:UpdateCooldowns(); + if ( not PetHasActionBar() ) then + --ControlReleased(); + self:Hide(); + end + self.rangeTimer = -1; +end + +function PetActionBarMixin:UpdateCooldowns() + for i=1, NUM_PET_ACTION_SLOTS, 1 do + local cooldown = self.actionButtons[i].cooldown; + local start, duration, enable = GetPetActionCooldown(i); + CooldownFrame_Set(cooldown, start, duration, enable); + + -- Update tooltip + local actionButton = self.actionButtons[i]; + if ( GameTooltip:GetOwner() == actionButton ) then + actionButton:OnEnter(actionButton); + end + end +end + +function PetActionBarMixin:PetActionButtonDown(id) + local button = self.actionButtons[id]; + if ( button:GetButtonState() == "NORMAL" ) then + button:SetButtonState("PUSHED"); + end + if (GetCVarBool("ActionButtonUseKeyDown")) then + CastPetAction(id); + end +end + +function PetActionBarMixin:PetActionButtonUp(id) + local button = self.actionButtons[id]; + if ( button:GetButtonState() == "PUSHED" ) then + button:SetButtonState("NORMAL"); + if(not GetCVarBool("ActionButtonUseKeyDown")) then + CastPetAction(id); + end + end +end + +function PetActionBarMixin:LockPetActionBar() + self.locked = 1; +end + +function PetActionBarMixin:UnlockPetActionBar() + self.locked = nil; +end + +function PetActionBarMixin:ShouldShowBackgroundArt() + return MainMenuBar:IsShown() + and self:IsInDefaultPosition() + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.Orientation) + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.NumRows) + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.IconSize) + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.IconPadding); +end + +function PetActionBarMixin:SetBackgroundArtShown(shown) + if (self.BackgroundArtTextures) then + for index, texture in ipairs(self.BackgroundArtTextures) do + texture:SetShown(shown); + end + end +end + +PetActionButtonMixin = {}--- @class PetActionButtonMixin + +function PetActionButtonMixin:PetActionButtonMixin_OnLoad() + SmallActionButtonMixin.SmallActionButtonMixin_OnLoad(self); + + self:RegisterForDrag("LeftButton", "RightButton"); + self:RegisterForClicks("AnyUp"); + self:RegisterEvent("UPDATE_BINDINGS"); + self:RegisterEvent("GAME_PAD_ACTIVE_CHANGED"); + self:SetHotkeys(); + self.cooldown:SetSwipeColor(0, 0, 0); +end + +function PetActionButtonMixin:PetActionButtonMixin_OnEvent(event, ...) + if ( event == "UPDATE_BINDINGS" or event == "GAME_PAD_ACTIVE_CHANGED" ) then + self:SetHotkeys(); + return; + end +end + +function PetActionButtonMixin:PetActionButtonMixin_PreClick() + self:SetChecked(false); +end + +function PetActionButtonMixin:PetActionButtonMixin_OnClick(button, down) + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnClick(self, button, down); + + if ( not KeybindFrames_InQuickKeybindMode() ) then + if ( IsModifiedClick() and IsModifiedClick("PICKUPACTION") ) then + PickupPetAction(self:GetID()); + return; + else + if ( button == "LeftButton" ) then + CastPetAction(self:GetID()); + else + TogglePetAutocast(self:GetID()); + end + end + end +end + +function PetActionButtonMixin:PetActionButtonMixin_OnDragStart() + BaseActionButtonMixin.BaseActionButtonMixin_OnDragStart(self); + + if ( not Settings.GetValue("lockActionBars") or IsModifiedClick("PICKUPACTION")) then + self:SetChecked(false); + PickupPetAction(self:GetID()); + PetActionBar:Update(); + end +end + +function PetActionButtonMixin:PetActionButtonMixin_OnReceiveDrag() + local cursorType = GetCursorInfo(); + if (cursorType == "petaction") then + self:SetChecked(false); + PickupPetAction(self:GetID()); + PetActionBar:Update(); + end +end + +function PetActionButtonMixin:PetActionButtonMixin_OnEnter() + BaseActionButtonMixin.BaseActionButtonMixin_OnEnter(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnEnter(self); + + if ( not self.tooltipName ) then + return; + end + + local uber = GetCVar("UberTooltips"); + if ( uber == "0" and not KeybindFrames_InQuickKeybindMode() ) then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + local bindingText = GetBindingText(GetBindingKey("BONUSACTIONBUTTON"..self:GetID())); + if (bindingText and bindingText ~= "") then + GameTooltip:SetText(self.tooltipName..NORMAL_FONT_COLOR_CODE.." ("..bindingText..")"..FONT_COLOR_CODE_CLOSE, 1.0, 1.0, 1.0); + else + GameTooltip:SetText(self.tooltipName, 1.0, 1.0, 1.0); + end + if ( self.tooltipSubtext ) then + GameTooltip:AddLine(self.tooltipSubtext, 0.5, 0.5, 0.5, true); + end + GameTooltip:Show(); + self.UpdateTooltip = nil; + else + GameTooltip_SetDefaultAnchor(GameTooltip, self); + if (GameTooltip:SetPetAction(self:GetID())) then + self.UpdateTooltip = self.OnEnter; + else + self.UpdateTooltip = nil; + end + end +end + +function PetActionButtonMixin:PetActionButtonMixin_OnLeave() + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnLeave(self); + BaseActionButtonMixin.BaseActionButtonMixin_OnLeave(self); + + GameTooltip:Hide(); +end + +function PetActionButtonMixin:PetActionButtonMixin_OnUpdate(elapsed) + if ( self:IsFlashing() ) then + local flashtime = self.flashtime; + flashtime = flashtime - elapsed; + + if ( flashtime <= 0 ) then + local overtime = -flashtime; + if ( overtime >= ATTACK_BUTTON_FLASH_TIME ) then + overtime = 0; + end + flashtime = ATTACK_BUTTON_FLASH_TIME - overtime; + + local flashTexture = self.Flash; + if ( flashTexture:IsShown() ) then + flashTexture:Hide(); + else + flashTexture:Show(); + end + end + + self.flashtime = flashtime; + end +end + +function PetActionButtonMixin:SetHotkeys() + local binding = GetBindingText(GetBindingKey("BONUSACTIONBUTTON"..self:GetID()), true); + local hotkey = self.HotKey; + if ( binding == "" ) then + hotkey:SetText(RANGE_INDICATOR); + hotkey:Hide(); + else + hotkey:SetText(binding); + hotkey:Show(); + end +end + +function PetActionButtonMixin:StartFlash() + self.flashing = true; + self.flashtime = 0; +end + +function PetActionButtonMixin:StopFlash() + self.flashing = false; + self.Flash:Hide(); +end + +function PetActionButtonMixin:IsFlashing() + return self.flashing; +end + +function PetActionButtonMixin:HasAction() + return GetPetActionInfo(self.index); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PossessActionBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PossessActionBar.lua.annotated.lua new file mode 100644 index 0000000..7304d0b --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/PossessActionBar.lua.annotated.lua @@ -0,0 +1,115 @@ +NUM_POSSESS_SLOTS = 2; +POSSESS_CANCEL_SLOT = 2; + +PossessActionBarMixin = {};--- @class PossessActionBarMixin + +function PossessActionBarMixin:PossessActionBar_OnLoad() + self:SetShowGrid(true, ACTION_BUTTON_SHOW_GRID_REASON_CVAR); +end + +function PossessActionBarMixin:Update() + if ( not MainActionBar.busy and not UnitHasVehicleUI("player") ) then --Don't change while we're animating out MainActionBar for vehicle UI + if ( C_ActionBar.IsPossessBarVisible() ) then + if ( not self:IsShown() ) then + self:Show(); + end + + self:UpdateState(); + elseif ( self:IsShown() ) then + self:Hide(); + end + end +end + +function PossessActionBarMixin:UpdateState() + local texture, spellID, enabled; + local button, icon, cooldown; + + for i=1, NUM_POSSESS_SLOTS do + -- Possess Icon + button = self.actionButtons[i]; + icon = button.icon; + texture, spellID, enabled = GetPossessInfo(i); + icon:SetTexture(texture); + + --Cooldown stuffs + cooldown = button.cooldown; + cooldown:Hide(); + + button:SetChecked(false); + button:Enable(); + icon:SetVertexColor(1.0, 1.0, 1.0); + icon:SetDesaturated(false); + end + + self:UpdateShownButtons(); +end + +function PossessActionBarMixin:ShouldShowBackgroundArt() + return MainMenuBar:IsShown() + and self:IsInDefaultPosition() + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.Orientation) + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.NumRows) + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.IconSize) + and self:IsSystemSettingDefault(Enum.EditModeActionBarSetting.IconPadding); +end + +function PossessActionBarMixin:SetBackgroundArtShown(shown) + if (self.BackgroundArtTextures) then + for index, texture in ipairs(self.BackgroundArtTextures) do + texture:SetShown(shown); + end + end +end + +PossessButtonMixin = {};--- @class PossessButtonMixin + +function PossessButtonMixin:OnLoad() + self.cooldown:SetSwipeColor(0, 0, 0); +end + +function PossessButtonMixin:OnClick() + self:SetChecked(false); + + local id = self:GetID(); + if ( id == POSSESS_CANCEL_SLOT ) then + if ( UnitOnTaxi("player") ) then + TaxiRequestEarlyLanding(); + + -- Show that the request for landing has been received. + local icon = self.icon; + icon:SetDesaturated(true); + self:SetChecked(true); + self:Disable(); + elseif ( UnitControllingVehicle("player") and CanExitVehicle() ) then + VehicleExit(); + else + CancelPetPossess(); + end + end +end + +function PossessButtonMixin:OnEnter() + local id = self:GetID(); + + if ( GetCVar("UberTooltips") == "1" ) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + + if ( id == POSSESS_CANCEL_SLOT ) then + GameTooltip:SetText(CANCEL); + else + GameTooltip:SetPossession(id); + end +end + +function PossessButtonMixin:OnLeave() + GameTooltip:Hide(); +end + +function PossessButtonMixin:HasAction() + local texture, spellID, enabled = GetPossessInfo(self.index); + return enabled; +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.lua.annotated.lua new file mode 100644 index 0000000..3b6ec0e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.lua.annotated.lua @@ -0,0 +1,197 @@ +local blueBarAtlas = "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Blue"; +local barAtlases = +{ + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Red", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Red", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Orange", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Yellow", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", + "UI-HUD-ExperienceBar-Fill-Reputation-Faction-Green", +}; + +local blueGainFlareAtlas = "UI-HUD-ExperienceBar-Flare-Rested-2x-Flipbook"; +local gainFlareAtlases = +{ + "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Faction-Orange-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-ArtifactPower-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Flare-Reputation-2x-Flipbook", +}; + +local blueLevelUpAtlas = "UI-HUD-ExperienceBar-Fill-Rested-2x-Flipbook"; +local levelUpAtlases = +{ + "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Honor-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-ArtifactPower-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", + "UI-HUD-ExperienceBar-Fill-Reputation-2x-Flipbook", +}; + +ReputationStatusBarMixin = {};--- @class ReputationStatusBarMixin + +function ReputationStatusBarMixin:UpdateCurrentText() + local maxLevel = self:GetMaxLevel(); + if maxLevel and self.StatusBar.level and self.StatusBar.level >= maxLevel then + self:SetBarText(self.name); + else + self:SetBarText(self.name:format(self.value, self.max)); + end +end + +function ReputationStatusBarMixin:GetMaxLevel() + local watchedFactionData = C_Reputation.GetWatchedFactionData(); + if not watchedFactionData or watchedFactionData.factionID == 0 then + return nil; + end + + local factionID = watchedFactionData.factionID; + if C_Reputation.IsFactionParagonForCurrentPlayer(factionID) then + return nil; + end + + if C_Reputation.IsMajorFaction(factionID) then + local renownLevelsInfo = C_MajorFactions.GetRenownLevels(factionID); + return renownLevelsInfo[#renownLevelsInfo].level; + end + + local reputationInfo = C_GossipInfo.GetFriendshipReputation(factionID); + local friendshipID = reputationInfo.friendshipFactionID; + if friendshipID > 0 then + local repRankInfo = C_GossipInfo.GetFriendshipReputationRanks(factionID); + return repRankInfo.maxLevel; + end + + return MAX_REPUTATION_REACTION; +end + +function ReputationStatusBarMixin:Update() + local watchedFactionData = C_Reputation.GetWatchedFactionData(); + if not watchedFactionData or watchedFactionData.factionID == 0 then + return; + end + + local reactionLevel = watchedFactionData.reaction; + local overrideUseBlueBar = false; + + local factionID = watchedFactionData.factionID; + local isShowingNewFaction = self.factionID ~= factionID; + if isShowingNewFaction then + self.factionID = factionID; + local reputationInfo = C_GossipInfo.GetFriendshipReputation(factionID); + self.friendshipID = reputationInfo.friendshipFactionID; + end + + -- do something different for friendships + local level; + local maxLevel = self:GetMaxLevel(); + + local minBar, maxBar, value = watchedFactionData.currentReactionThreshold, watchedFactionData.nextReactionThreshold, watchedFactionData.currentStanding; + if C_Reputation.IsFactionParagonForCurrentPlayer(factionID) then + local currentValue, threshold, _, hasRewardPending = C_Reputation.GetFactionParagonInfo(factionID); + minBar, maxBar = 0, threshold; + if currentValue and threshold then + value = currentValue % threshold; + end + level = maxLevel; + if hasRewardPending then + value = value + threshold; + end + if C_Reputation.IsMajorFaction(factionID) then + overrideUseBlueBar = true; + end + elseif C_Reputation.IsMajorFaction(factionID) then + local majorFactionData = C_MajorFactions.GetMajorFactionData(factionID); + minBar, maxBar = 0, majorFactionData.renownLevelThreshold; + level = majorFactionData.renownLevel; + overrideUseBlueBar = true; + elseif self.friendshipID > 0 then + local repInfo = C_GossipInfo.GetFriendshipReputation(factionID); + local repRankInfo = C_GossipInfo.GetFriendshipReputationRanks(factionID); + level = repRankInfo.currentLevel; + if repInfo.nextThreshold then + minBar, maxBar, value = repInfo.reactionThreshold, repInfo.nextThreshold, repInfo.standing; + else + -- max rank, make it look like a full bar + minBar, maxBar, value = 0, 1, 1; + end + reactionLevel = 5; -- Friendships always use same + else + level = watchedFactionData.reaction; + end + + local isCapped = (level and maxLevel) and level >= maxLevel; + + -- Normalize values + maxBar = maxBar - minBar; + value = value - minBar; + if isCapped and maxBar == 0 then + maxBar = 1; + value = 1; + end + minBar = 0; + + self:SetBarValues(value, minBar, maxBar, level, maxLevel); + + local name = watchedFactionData.name; + local needsAccountWideLabel = C_Reputation.IsAccountWideReputation(factionID); + if needsAccountWideLabel then + name = name .. " " .. REPUTATION_STATUS_BAR_LABEL_ACCOUNT_WIDE; + end + + if isCapped then + self:SetBarText(name); + else + name = name.." %d / %d"; + self:SetBarText(name:format(value, maxBar)); + end + + -- Update bar texture based on faction data. + self:UpdateBarTextures(reactionLevel, overrideUseBlueBar); + + self.name = name; + self.value = value; + self.max = maxBar; + + -- When showing new faction, force status bar to update instantly + if isShowingNewFaction then + self.StatusBar:ProcessChangesInstantly(); + end +end + +function ReputationStatusBarMixin:OnLoad() + self:RegisterEvent("CVAR_UPDATE"); +end + +function ReputationStatusBarMixin:OnEvent(event, ...) + if( event == "CVAR_UPDATE") then + local cvar = ...; + if( cvar == "xpBarText" ) then + self:UpdateTextVisibility(); + end + end +end + +function ReputationStatusBarMixin:OnEnter() + self:ShowText(); + self:UpdateCurrentText(); + ReputationParagonWatchBar_OnEnter(self); +end + +function ReputationStatusBarMixin:OnShow() + self:UpdateTextVisibility(); +end + +function ReputationStatusBarMixin:OnLeave() + self:HideText(); + ReputationParagonWatchBar_OnLeave(self); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml new file mode 100644 index 0000000..585e6a0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml.annotated.lua new file mode 100644 index 0000000..bd4065a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml.annotated.lua @@ -0,0 +1,6 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/ReputationBar.xml#L3) +--- Template +--- @class ReputationStatusBarTemplate : Frame, StatusTrackingBarTemplate, ReputationStatusBarMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.lua.annotated.lua new file mode 100644 index 0000000..db0170e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.lua.annotated.lua @@ -0,0 +1,385 @@ + +local SPELLFLYOUT_DEFAULT_SPACING = 4; +local SPELLFLYOUT_INITIAL_SPACING = 9; +local SPELLFLYOUT_FINAL_SPACING = 9; + +SpellFlyoutOpenReason = EnumUtil.MakeEnum("GlyphPending", "GlyphActivated");--- @type {["GlyphPending"]: 1, ["GlyphActivated"]: 2} See [SpellFlyoutOpenReason](lua://SpellFlyoutOpenReason) + +SpellFlyoutPopupButtonMixin = {};--- @class SpellFlyoutPopupButtonMixin + +function SpellFlyoutPopupButtonMixin:OnLoad() + self:RegisterForDrag("LeftButton"); + _G[self:GetName().."Count"]:SetPoint("BOTTOMRIGHT", 0, 0); + self.maxDisplayCount = 99; +end + +function SpellFlyoutPopupButtonMixin:OnClick() + EventRegistry:TriggerEvent("SpellFlyoutPopupButtonMixin.OnClick", self); + + if ( IsModifiedClick("CHATLINK") ) then + if ( MacroFrameText and MacroFrameText:HasFocus() ) then + if ( self.spellName ) then + ChatFrameUtil.InsertLink(self.spellName); + end + else + local tradeSkillLink = C_Spell.GetSpellTradeSkillLink(self.spellID); + if ( tradeSkillLink ) then + ChatFrameUtil.InsertLink(tradeSkillLink); + else + local spellLink = C_Spell.GetSpellLink(self.spellID); + ChatFrameUtil.InsertLink(spellLink); + end + end + self:UpdateState(); + else + if ( HasPendingGlyphCast() ) then + if ( HasAttachedGlyph(self.spellID) ) then + if ( IsPendingGlyphRemoval() ) then + StaticPopup_Show("CONFIRM_GLYPH_REMOVAL", nil, nil, {name = GetCurrentGlyphNameForSpell(self.spellID), id = self.spellID}); + else + StaticPopup_Show("CONFIRM_GLYPH_PLACEMENT", nil, nil, {name = GetPendingGlyphName(), currentName = GetCurrentGlyphNameForSpell(self.spellID), id = self.spellID}); + end + else + AttachGlyphToSpell(self.spellID); + end + return; + end + local spellID = C_Spell.GetSpellIDForSpellIdentifier(self.spellID); + if ( self.offSpec ) then + return; + elseif ( spellID ) then + CastSpellByID(spellID); + self:ClosePopup(); + elseif ( self.spellName ) then + CastSpellByName(self.spellName); + self:ClosePopup(); + end + end +end + +function SpellFlyoutPopupButtonMixin:OnDragStart() + if (not self.isActionBar or not Settings.GetValue("lockActionBars") or IsModifiedClick("PICKUPACTION")) then + if (self.spellID) then + C_Spell.PickupSpell(self.spellID); + end + end +end + +function SpellFlyoutPopupButtonMixin:SetTooltip() + if ( GetCVar("UberTooltips") == "1" or self.showFullTooltip ) then + if (self.isActionBar) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT", 4, 4); + end + if ( GameTooltip:SetSpellByID(self.spellID) ) then + self.UpdateTooltip = self.SetTooltip; + else + self.UpdateTooltip = nil; + end + else + local parent = self:GetParent():GetParent():GetParent(); + if ( parent == MultiBarBottomRight or parent == MultiBarRight or parent == MultiBarLeft ) then + GameTooltip:SetOwner(self, "ANCHOR_LEFT"); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + local spellName = C_Spell.GetSpellName(self.spellID); + GameTooltip:SetText(spellName, HIGHLIGHT_FONT_COLOR.r, HIGHLIGHT_FONT_COLOR.g, HIGHLIGHT_FONT_COLOR.b); + self.UpdateTooltip = nil; + end +end + +function SpellFlyoutPopupButtonMixin:OnLeave() + GameTooltip:Hide(); +end + +function SpellFlyoutPopupButtonMixin:UpdateCooldown() + ActionButton_UpdateCooldown(self); +end + +function SpellFlyoutPopupButtonMixin:UpdateState() + if ( C_Spell.IsCurrentSpell(self.spellID) ) then + self:SetChecked(true); + else + self:SetChecked(false); + end +end + +function SpellFlyoutPopupButtonMixin:UpdateUsable() + local isUsable, notEnoughMana = C_Spell.IsSpellUsable(self.spellID); + local name = self:GetName(); + local icon = _G[name.."Icon"]; + if ( isUsable or not self.isActionBar) then + icon:SetVertexColor(1.0, 1.0, 1.0); + elseif ( notEnoughMana ) then + icon:SetVertexColor(0.5, 0.5, 1.0); + else + icon:SetVertexColor(0.4, 0.4, 0.4); + end +end + +function SpellFlyoutPopupButtonMixin:UpdateGlyphState(reason) + self.GlyphIcon:SetShown(HasAttachedGlyph(self.spellID)); + if (HasPendingGlyphCast() and IsSpellValidForPendingGlyph(self.spellID)) then + self.AbilityHighlight:Show(); + self.AbilityHighlightAnim:Play(); + if (reason == SpellFlyoutOpenReason.GlyphActivated) then + if (IsPendingGlyphRemoval()) then + self.GlyphIcon:Hide(); + else + self.AbilityHighlightAnim:Stop(); + self.AbilityHighlight:Hide(); + self.GlyphIcon:Show(); + self.GlyphActivate:Show(); + self.GlyphTranslation:Show(); + self.GlyphActivateAnim:Play(); + SpellFlyout.glyphActivating = true; + end + end + else + self.AbilityHighlightAnim:Stop(); + self.AbilityHighlight:Hide(); + end +end + +function SpellFlyoutPopupButtonMixin:UpdateCount() + local text = _G[self:GetName().."Count"]; + text:SetText(C_Spell.GetSpellDisplayCount(self.spellID, self.maxDisplayCount)); +end + +SpellFlyoutMixin = {};--- @class SpellFlyoutMixin + +function SpellFlyoutMixin:OnLoad() + self.eventsRegistered = false; +end + +function SpellFlyoutMixin:OnEvent(event, ...) + if (event == "SPELL_UPDATE_COOLDOWN") then + local i = 1; + local button = _G["SpellFlyoutPopupButton"..i]; + while (button and button:IsShown()) do + button:UpdateCooldown(); + i = i+1; + button = _G["SpellFlyoutPopupButton"..i]; + end + elseif (event == "CURRENT_SPELL_CAST_CHANGED") then + local i = 1; + local button = _G["SpellFlyoutPopupButton"..i]; + while (button and button:IsShown()) do + button:UpdateState(); + i = i+1; + button = _G["SpellFlyoutPopupButton"..i]; + end + elseif (event == "SPELL_UPDATE_USABLE") then + local i = 1; + local button = _G["SpellFlyoutPopupButton"..i]; + while (button and button:IsShown()) do + button:UpdateUsable(); + i = i+1; + button = _G["SpellFlyoutPopupButton"..i]; + end + elseif (event == "BAG_UPDATE") then + local i = 1; + local button = _G["SpellFlyoutPopupButton"..i]; + while (button and button:IsShown()) do + button:UpdateCount(); + button:UpdateUsable(); + i = i+1; + button = _G["SpellFlyoutPopupButton"..i]; + end + elseif (event == "SPELL_FLYOUT_UPDATE") then + local i = 1; + local button = _G["SpellFlyoutPopupButton"..i]; + while (button and button:IsShown()) do + button:UpdateCooldown(); + button:UpdateState(); + button:UpdateUsable(); + button:UpdateCount(); + button:UpdateGlyphState(); + i = i+1; + button = _G["SpellFlyoutPopupButton"..i]; + end + elseif (event == "PET_STABLE_UPDATE" or event == "PET_STABLE_SHOW") then + self:Close(); + elseif (event == "ACTIONBAR_PAGE_CHANGED") then + self:Close(); + end +end + +function SpellFlyoutMixin:Toggle(flyoutButton, flyoutID, isActionBar, specID, showFullTooltip, reason) + if (self:IsShown() and self.glyphActivating) then + return; + end + + if self:IsShown() then + local sameButton = self:IsAttachedToButton(flyoutButton); + + self:Close(); + + if sameButton then + return; + end + end + + local offSpec = specID and (specID ~= 0); + + local _, _, numSlots, isKnown = GetFlyoutInfo(flyoutID); + self.isActionBar = isActionBar; + + -- Make sure this flyout is known or we are showing an offSpec flyout + if ((not isKnown and not offSpec) or numSlots == 0) then + return; + end + + local direction = flyoutButton:GetPopupDirection(); + + -- Update all spell buttons for this flyout + local prevButton = nil; + local numButtons = 0; + for i=1, numSlots do + local spellID, overrideSpellID, isKnownSlot, spellName, slotSpecID = GetFlyoutSlotInfo(flyoutID, i); + local visible = true; + + -- Ignore Call Pet spells if there isn't a pet in that slot + local petIndex, petName = GetCallPetSpellInfo(spellID); + if (isActionBar and petIndex and (not petName or petName == "")) then + visible = false; + end + + if ( ((not offSpec or slotSpecID == 0) and visible and isKnownSlot) or (offSpec and slotSpecID == specID) ) then + local button = _G["SpellFlyoutPopupButton"..numButtons+1]; + if (not button) then + button = CreateFrame("CHECKBUTTON", "SpellFlyoutPopupButton"..numButtons+1, SpellFlyout, "SpellFlyoutPopupButtonTemplate"); + end + + button:ClearAllPoints(); + if (direction == "UP") then + if (prevButton) then + button:SetPoint("BOTTOM", prevButton, "TOP", 0, SPELLFLYOUT_DEFAULT_SPACING); + else + button:SetPoint("BOTTOM", 0, SPELLFLYOUT_INITIAL_SPACING); + end + elseif (direction == "DOWN") then + if (prevButton) then + button:SetPoint("TOP", prevButton, "BOTTOM", 0, -SPELLFLYOUT_DEFAULT_SPACING); + else + button:SetPoint("TOP", 0, -SPELLFLYOUT_INITIAL_SPACING); + end + elseif (direction == "LEFT") then + if (prevButton) then + button:SetPoint("RIGHT", prevButton, "LEFT", -SPELLFLYOUT_DEFAULT_SPACING, 0); + else + button:SetPoint("RIGHT", -SPELLFLYOUT_INITIAL_SPACING, 0); + end + elseif (direction == "RIGHT") then + if (prevButton) then + button:SetPoint("LEFT", prevButton, "RIGHT", SPELLFLYOUT_DEFAULT_SPACING, 0); + else + button:SetPoint("LEFT", SPELLFLYOUT_INITIAL_SPACING, 0); + end + end + + button:Show(); + button.showFullTooltip = showFullTooltip; + button.isActionBar = isActionBar; + + _G[button:GetName().."Icon"]:SetTexture(C_Spell.GetSpellTexture(overrideSpellID)); + _G[button:GetName().."Icon"]:SetDesaturated(offSpec); + button.offSpec = offSpec; + button.spellID = spellID; + button.spellName = spellName; + if ( offSpec ) then + button:Disable(); + else + button:Enable(); + end + button:UpdateCooldown(); + button:UpdateState(); + button:UpdateUsable(); + button:UpdateCount(); + button:UpdateGlyphState(reason); + + prevButton = button; + numButtons = numButtons+1; + end + end + + -- Hide unused buttons + local unusedButtonIndex = numButtons+1; + while (_G["SpellFlyoutPopupButton"..unusedButtonIndex]) do + _G["SpellFlyoutPopupButton"..unusedButtonIndex]:Hide(); + unusedButtonIndex = unusedButtonIndex+1; + end + + if (numButtons == 0) then + return; + end + + self:SetFrameStrata("DIALOG"); + self:SetWidthPadding(8); + self:SetHeightPadding(8); + self:Layout(); + self:SetBorderColor(0.7, 0.7, 0.7); + + flyoutButton:TogglePopup(); +end + +function SpellFlyoutMixin:CloseIfWorldMapMaximized() + if (WorldMapFrame:IsMaximized()) then + self:Close(); + end +end + +function SpellFlyoutMixin:OnShow() + if (self.eventsRegistered == false) then + self:RegisterEvent("SPELL_UPDATE_COOLDOWN"); + self:RegisterEvent("CURRENT_SPELL_CAST_CHANGED"); + self:RegisterEvent("SPELL_UPDATE_USABLE"); + self:RegisterEvent("BAG_UPDATE"); + self:RegisterEvent("ACTIONBAR_PAGE_CHANGED"); + self:RegisterEvent("PET_STABLE_UPDATE"); + self:RegisterEvent("PET_STABLE_SHOW"); + self:RegisterEvent("SPELL_FLYOUT_UPDATE"); + EventRegistry:RegisterCallback("WorldMapMaximized", self.Close, self); + EventRegistry:RegisterCallback("WorldMapOnShow", self.CloseIfWorldMapMaximized, self); + self.eventsRegistered = true; + end +end + +function SpellFlyoutMixin:OnHide() + FlyoutPopupMixin.OnHide(self); + + if (self.eventsRegistered == true) then + self:UnregisterEvent("SPELL_UPDATE_COOLDOWN"); + self:UnregisterEvent("CURRENT_SPELL_CAST_CHANGED"); + self:UnregisterEvent("SPELL_UPDATE_USABLE"); + self:UnregisterEvent("BAG_UPDATE"); + self:UnregisterEvent("ACTIONBAR_PAGE_CHANGED"); + self:UnregisterEvent("PET_STABLE_UPDATE"); + self:UnregisterEvent("PET_STABLE_SHOW"); + self:UnregisterEvent("SPELL_FLYOUT_UPDATE"); + EventRegistry:UnregisterCallback("WorldMapMaximized", self.Close); + EventRegistry:UnregisterCallback("WorldMapOnShow", self.CloseIfWorldMapMaximized); + self.eventsRegistered = false; + end + + self.glyphActivating = false; +end + +function SpellFlyoutMixin:GetFlyoutButtonForSpell(spellID) + if (not self:IsShown()) then + return nil; + end + + local i = 1; + local button = _G["SpellFlyoutPopupButton"..i]; + while (button and button:IsShown()) do + if (button.spellID == spellID) then + return button; + end + i = i+1; + button = _G["SpellFlyoutPopupButton"..i]; + end + return nil; +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml new file mode 100644 index 0000000..05427ee --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SpellFlyout.glyphActivating = nil; + self:GetParent().GlyphActivate:Hide(); + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml.annotated.lua new file mode 100644 index 0000000..3e79260 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml.annotated.lua @@ -0,0 +1,26 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml#L39) +--- child of SpellFlyoutPopupButtonTemplate +--- @class SpellFlyoutPopupButtonTemplate_GlyphActivateAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml#L55) +--- child of SpellFlyoutPopupButtonTemplate +--- @class SpellFlyoutPopupButtonTemplate_AbilityHighlightAnim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml#L3) +--- Explicitly protected +--- Template +--- @class SpellFlyoutPopupButtonTemplate : CheckButton, SmallActionButtonTemplate, FlyoutPopupButtonTemplate, SecureFrameTemplate, SpellFlyoutPopupButtonMixin +--- @field GlyphIcon Texture +--- @field GlyphActivate Texture +--- @field AbilityHighlight Texture +--- @field GlyphTranslation Texture +--- @field GlyphActivateAnim SpellFlyoutPopupButtonTemplate_GlyphActivateAnim +--- @field AbilityHighlightAnim SpellFlyoutPopupButtonTemplate_AbilityHighlightAnim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/SpellFlyout.xml#L62) +--- Explicitly protected +--- @class SpellFlyout : Frame, SecureFrameTemplate, ResizeLayoutFrame, FlyoutPopupTemplate, SpellFlyoutMixin +SpellFlyout = {} + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StanceBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StanceBar.lua.annotated.lua new file mode 100644 index 0000000..a43a1f7 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StanceBar.lua.annotated.lua @@ -0,0 +1,148 @@ +------------------------------------------------------- +------- StanceBar (Shapsfit,Auras,Aspects) Code ------- +------------------------------------------------------- +StanceBarMixin = {};--- @class StanceBarMixin + +function StanceBarMixin:OnLoad() + self:RegisterEvent("UPDATE_SHAPESHIFT_COOLDOWN"); + self:SetShowGrid(true, ACTION_BUTTON_SHOW_GRID_REASON_CVAR); +end + +function StanceBarMixin:OnEvent(event) + if(event == "UPDATE_SHAPESHIFT_COOLDOWN") then + self:UpdateState(); + end +end + +function StanceBarMixin:OnShow() + self:Update(); +end + +function StanceBarMixin:ShouldShow() + return self.numForms > 0 + and not C_ActionBar.IsPossessBarVisible() + and ActionBarController_GetCurrentActionBarState() ~= LE_ACTIONBAR_STATE_OVERRIDE; +end + +function StanceBarMixin:Update() + self.numForms = GetNumShapeshiftForms(); + if (self.editModeForceShow and self.numForms == 0) then + self.numForms = 10; + end + + self.numButtonsShowable = self.numForms or self.numButtons; + if ( self.numForms > 0) then + self:UpdateBackgroundArt(); + self:UpdateState(); + end + + -- Don't update shown if action bars are busy + -- This is often related to vehicle bars or pet battles + if not ActionBarBusy() then + self:SetShown(self:ShouldShow()); + end +end + +function StanceBarMixin:ShouldShowBackgroundArt() + return false; -- Override me! +end + +function StanceBarMixin:SetBackgroundArtShown(shown) + -- Override me! +end + +function StanceBarMixin:UpdateBackgroundArt() + -- Override me! +end + +function StanceBarMixin:UpdateState() + local numForms = GetNumShapeshiftForms(); + local texture, isActive, isCastable; + local icon, cooldown; + local start, duration, enable; + + for i, button in pairs(self.actionButtons) do + icon = button.icon; + if ( i <= numForms ) then + texture, isActive, isCastable, button.spellID = GetShapeshiftFormInfo(i); + icon:SetTexture(texture); + + --Cooldown stuffs + cooldown = button.cooldown; + if ( texture ) then + cooldown:Show(); + else + cooldown:Hide(); + end + start, duration, enable = GetShapeshiftFormCooldown(i); + CooldownFrame_Set(cooldown, start, duration, enable); + + if ( isActive ) then + self.lastSelected = button:GetID(); + button:SetChecked(true); + else + button:SetChecked(false); + end + + if ( isCastable ) then + icon:SetVertexColor(1.0, 1.0, 1.0); + else + icon:SetVertexColor(0.4, 0.4, 0.4); + end + end + end + + self:UpdateShownButtons(); + -- Must update grid layout here since stance bar doesn't keep button containers active as spacers, + -- meaning newly active buttons aren't yet part of the grid layout (and therefore won't be visible until they are) + -- If the number of active buttons hasn't changed, ActionBarMixin's ShouldUpdateGrid will detect that and avoid the update. + self:UpdateGridLayout(); +end + +function StanceBarMixin:Select(id) + self.lastSelected = id; + CastShapeshiftForm(id); +end + +StanceButtonMixin = {}--- @class StanceButtonMixin + +function StanceButtonMixin:StanceButtonMixin_OnLoad() + SmallActionButtonMixin.SmallActionButtonMixin_OnLoad(self); + + self.cooldown:SetSwipeColor(0, 0, 0); + self:RegisterForClicks("AnyUp"); +end + +function StanceButtonMixin:StanceButtonMixin_OnClick(button, down) + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnClick(self, button, down); + + if ( not KeybindFrames_InQuickKeybindMode() ) then + self:SetChecked(not self:GetChecked()); + StanceBar:Select(self:GetID()); + end +end + +function StanceButtonMixin:StanceButtonMixin_OnEnter() + BaseActionButtonMixin.BaseActionButtonMixin_OnEnter(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnEnter(self); + + if ( GetCVarBool("UberTooltips") or KeybindFrames_InQuickKeybindMode() ) then + GameTooltip_SetDefaultAnchor(GameTooltip, self); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + end + GameTooltip:SetShapeshift(self:GetID()); + self.UpdateTooltip = self.StanceButtonMixin_OnEnter; +end + +function StanceButtonMixin:StanceButtonMixin_OnLeave() + BaseActionButtonMixin.BaseActionButtonMixin_OnLeave(self); + QuickKeybindButtonTemplateMixin.QuickKeybindButtonOnLeave(self); + + GameTooltip_Hide(); +end + +-- Used by action bar template +function StanceButtonMixin:HasAction() + return GetShapeshiftFormInfo(self.index); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingBar.lua.annotated.lua new file mode 100644 index 0000000..d5081cf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingBar.lua.annotated.lua @@ -0,0 +1,54 @@ +StatusTrackingBarMixin = { }--- @class StatusTrackingBarMixin + +--Override this in your bar.lua function +function StatusTrackingBarMixin:Update() + error("Implement an update function on your bar"); +end + +--Override this to update the bar tick (if the bar has one) +--Called when the bar is resized (RightBottomBar enabled/disabled) +function StatusTrackingBarMixin:UpdateTick() + +end + +function StatusTrackingBarMixin:UpdateAll() + self:Update(); + self:UpdateTick(); + self:UpdateTextVisibility(); +end + +function StatusTrackingBarMixin:SetBarText(barText) + self.OverlayFrame.Text:SetText(barText); +end + +function StatusTrackingBarMixin:ShowText() + self:SetTextLocked(true); +end + +function StatusTrackingBarMixin:HideText() + self:SetTextLocked(false); +end + +function StatusTrackingBarMixin:SetBarValues(currentValue, minBar, maxBar, level, maxLevel) + if (self.supportsAnimation) then + self.StatusBar:SetAnimatedValues(currentValue, minBar, maxBar, level, maxLevel); + else + self.StatusBar:SetMinMaxValues(minBar, maxBar); + self.StatusBar:SetValue(currentValue); + end +end + +function StatusTrackingBarMixin:ShouldBarTextBeDisplayed() + return GetCVarBool("xpBarText") or self.textLocked or StatusTrackingBarManager:IsTextLocked(); +end + +function StatusTrackingBarMixin:SetTextLocked(locked) + if ( self.textLocked ~= locked ) then + self.textLocked = locked; + self:UpdateTextVisibility(); + end +end + +function StatusTrackingBarMixin:UpdateTextVisibility() + self.OverlayFrame.Text:SetShown(self:ShouldBarTextBeDisplayed()); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingManager.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingManager.lua.annotated.lua new file mode 100644 index 0000000..39b333f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/StatusTrackingManager.lua.annotated.lua @@ -0,0 +1,412 @@ + +StatusTrackingBarInfo = { }; + +-- Used for indexing bars +StatusTrackingBarInfo.BarsEnum = { + None = -1, + Reputation = 1, + Honor = 2, + Artifact = 3, + Experience = 4, + Azerite = 5, + HouseFavor = 6, +} + +StatusTrackingBarInfo.BarPriorities = { + [StatusTrackingBarInfo.BarsEnum.Azerite] = 0, + [StatusTrackingBarInfo.BarsEnum.Reputation] = 1, + [StatusTrackingBarInfo.BarsEnum.Honor] = 2, + [StatusTrackingBarInfo.BarsEnum.Artifact] = 3, + [StatusTrackingBarInfo.BarsEnum.Experience] = 4, + [StatusTrackingBarInfo.BarsEnum.HouseFavor] = 5, +} + +StatusTrackingManagerMixin = { };--- @class StatusTrackingManagerMixin + +function StatusTrackingManagerMixin:OnLoad() + self.shownBarIndices = {}; + + self:RegisterEvents(); +end + +function StatusTrackingManagerMixin:RegisterEvents() + -- Override me! +end + +function StatusTrackingManagerMixin:OnEvent(event, ...) + if event == "CVAR_UPDATE" then + self:UpdateBarTextVisibility(); + end + + if UnitExists("player") then + for _, barContainer in ipairs(self.barContainers) do + barContainer:UpdateShownBarAll(); + end + + self:UpdateBarsShown(); + end +end + +function StatusTrackingManagerMixin:CanShowBar(barIndex) + -- Override me! + return false; +end + +function StatusTrackingManagerMixin:GetBarPriority(barIndex) + return StatusTrackingBarInfo.BarPriorities[barIndex] or -1; +end + +function StatusTrackingManagerMixin:UpdateBarsShown() + local function onFinishedAnimating(barContainer) + barContainer:UnsubscribeFromOnFinishedAnimating(self); + self:UpdateBarsShown(); + end + + -- If any bar is animating then wait for that animation to end before updating shown bars + for i, barContainer in ipairs(self.barContainers) do + if barContainer:IsAnimating() then + barContainer:SubscribeToOnFinishedAnimating(self, onFinishedAnimating); + return; + end + end + + -- Determine what bars should be shown + local newBarIndicesToShow = {}; + for _, barIndex in pairs(StatusTrackingBarInfo.BarsEnum) do + if self:CanShowBar(barIndex) then + table.insert(newBarIndicesToShow, barIndex); + end + end + table.sort(newBarIndicesToShow, function(left, right) return self:GetBarPriority(left) > self:GetBarPriority(right) end); + + -- We can only show as many bars as we have containers for + while #newBarIndicesToShow > #self.barContainers do + table.remove(newBarIndicesToShow, #newBarIndicesToShow); + end + + -- Assign the bar indices to the bar containers + for i = 1, #self.barContainers do + local barContainer = self.barContainers[i]; + local newBarIndex = newBarIndicesToShow[i] or StatusTrackingBarInfo.BarsEnum.None; + local oldBarIndex = self.shownBarIndices[i]; + + if newBarIndex ~= oldBarIndex then + -- If the bar being shown in this container is already being shown in another container then + -- make both containers fade out fully before actually assigning the new bars. + -- This will lead to the bars fading in together rather than staggering. + if (newBarIndex ~= StatusTrackingBarInfo.BarsEnum.None and tContains(self.shownBarIndices, newBarIndex)) + or (oldBarIndex ~= StatusTrackingBarInfo.BarsEnum.None and tContains(newBarIndicesToShow, oldBarIndex)) then + newBarIndex = StatusTrackingBarInfo.BarsEnum.None; + barContainer:SubscribeToOnFinishedAnimating(self, onFinishedAnimating); + end + end + + barContainer:SetShownBar(newBarIndex); + end + + self.shownBarIndices = newBarIndicesToShow; + + self:UpdateBarVisuals(); +end + +function StatusTrackingManagerMixin:UpdateBarVisuals() + -- Override me! +end + +function StatusTrackingManagerMixin:SetTextLocked(isLocked) + if self.textLocked ~= isLocked then + self.textLocked = isLocked; + self:UpdateBarTextVisibility(); + end +end + +function StatusTrackingManagerMixin:IsTextLocked() + return self.textLocked; +end + +function StatusTrackingManagerMixin:UpdateBarTextVisibility() + for i, barContainer in ipairs(self.barContainers) do + barContainer:UpdateBarTextVisibility(); + end +end + +function StatusTrackingManagerMixin:SetBarAnimation(Animation) + for i, barContainer in ipairs(self.barContainers) do + barContainer:SetBarAnimation(Animation); + end +end + +function StatusTrackingManagerMixin:UpdateBarTicks() + for i, barContainer in ipairs(self.barContainers) do + barContainer:UpdateBarTick(); + end +end + +function StatusTrackingManagerMixin:ShowVisibleBarText() + for i, barContainer in ipairs(self.barContainers) do + barContainer:ShowText(); + end +end + +function StatusTrackingManagerMixin:HideVisibleBarText() + for i, barContainer in ipairs(self.barContainers) do + barContainer:HideText(); + end +end + +function StatusTrackingManagerMixin:GetNumBarsInDefaultPosition() + local count = 0; + for i, barContainer in ipairs(self.barContainers) do + if (barContainer:IsShown() and barContainer:IsInDefaultPosition()) then + count = count + 1; + end + end + + return count; +end + +StatusTrackingBarContainerMixin = {};--- @class StatusTrackingBarContainerMixin + +function StatusTrackingBarContainerMixin:StatusTrackingBarContainer_OnLoad() + self.bars = {}; + + self:InitializeBars() + + for _, bar in pairs(self.bars) do + bar:Hide(); + end + self.shownBarIndex = StatusTrackingBarInfo.BarsEnum.None; +end + +function StatusTrackingBarContainerMixin:InitializeBars() + -- Override me! +end + +function StatusTrackingBarContainerMixin:SetShownBar(barIndex) + if self.shownBarIndex == barIndex then + self.pendingBarToShowIndex = nil; + return; + end + + self.pendingBarToShowIndex = barIndex; + + -- Fade in/out functions will handle applying the new bar to show + if not self:IsVisible() or self:GetAlpha() <= 0 then + if self.pendingBarToShowIndex == StatusTrackingBarInfo.BarsEnum.None then + -- If we don't have a bar to show and we're already not visible then just apply the pending bar to show + -- This will handle hiding the currently shown bar + self:ApplyPendingBarToShow(); + else + -- If you're already not visible and we have a bar to show then fade in + self:FadeIn(); + end + else + self:FadeOut(); + end +end + +function StatusTrackingBarContainerMixin:ApplyPendingBarToShow() + if not self.pendingBarToShowIndex then + return; + end + + if self.shownBarIndex == self.pendingBarToShowIndex then + self.pendingBarToShowIndex = nil; + return; + end + + local oldBar = self:GetShownBar(); + if oldBar then + oldBar:Hide(); + end + + local newBar = self.bars[self.pendingBarToShowIndex]; + if newBar then + newBar:UpdateAll(); + newBar:Show(); + end + + self.shownBarIndex = self.pendingBarToShowIndex; + self.pendingBarToShowIndex = nil; +end + +function StatusTrackingBarContainerMixin:UpdateShownState() + self:SetShown(self.shownBarIndex ~= StatusTrackingBarInfo.BarsEnum.None or self.isInEditMode); + UIParent_ManageFramePositions(); +end + +function StatusTrackingBarContainerMixin:FadeIn() + -- Before fading in make sure to apply any pending bars to show + self:ApplyPendingBarToShow(); + self:UpdateShownState(); + + -- If we aren't showing a bar then don't fade in + if self.shownBarIndex == StatusTrackingBarInfo.BarsEnum.None then + self:CheckIfStillAnimating(); + return; + end + + if self.FadeInAnimation:IsPlaying() or self:GetAlpha() >= 1 then + return; + end + + if self.FadeOutAnimation:IsPlaying() or self.MaxLevelFadeOutAnimation:IsPlaying() then + self.FadeOutAnimation:Stop(); + self.MaxLevelFadeOutAnimation:Stop(); + end + + self.FadeInAnimation:Restart(); +end + +function StatusTrackingBarContainerMixin:FadeOut() + if self.FadeOutAnimation:IsPlaying() or self.MaxLevelFadeOutAnimation:IsPlaying() or self:GetAlpha() <= 0 then + return; + end + + if self.FadeInAnimation:IsPlaying() then + self.FadeInAnimation:Stop(); + end + + self.FadeOutAnimation:Restart(); +end + +function StatusTrackingBarContainerMixin:GetShownBar() + return self.bars[self.shownBarIndex]; +end + +function StatusTrackingBarContainerMixin:IsShownBarAnimating() + local shownBar = self:GetShownBar(); + return shownBar and (shownBar.StatusBar:IsAnimating() or shownBar.StatusBar:IsDirty()); +end + +function StatusTrackingBarContainerMixin:SubscribeToShownBarOnFinishedAnimating() + local shownBar = self:GetShownBar(); + if shownBar then + if shownBar.StatusBar:IsDirty() then + shownBar.StatusBar:SubscribeToOnClean(self, function(bar) + bar:UnsubscribeFromOnClean(self); + self:CheckIfStillAnimating(); + end); + elseif shownBar.StatusBar:IsAnimating() then + shownBar.StatusBar:SubscribeToOnFinishedAnimating(self, function(bar) + bar:UnsubscribeFromOnFinishedAnimating(self); + self:CheckIfStillAnimating(); + end); + end + end +end + +function StatusTrackingBarContainerMixin:IsAnimating() + return self.FadeInAnimation:IsPlaying() + or self.FadeOutAnimation:IsPlaying() + or self.MaxLevelFadeOutAnimation:IsPlaying() + or self:IsShownBarAnimating(); +end + +function StatusTrackingBarContainerMixin:CheckIfStillAnimating() + if self:IsAnimating() then + -- If we're still animating then make sure to subscribe to anything that could let us know when we're done animating + if self:IsShownBarAnimating() then + self:SubscribeToShownBarOnFinishedAnimating(); + end + return; + end + + -- If we finished animating then call our animation callbacks + if self.animationFinishedCallbacks then + for i, callback in pairs(self.animationFinishedCallbacks) do + callback(self); + end + end +end + +function StatusTrackingBarContainerMixin:SubscribeToOnFinishedAnimating(subscribingFrame, onFinishedCallback) + if not self.animationFinishedCallbacks then + self.animationFinishedCallbacks = {}; + end + + self.animationFinishedCallbacks[subscribingFrame] = onFinishedCallback; + + -- Subscribe to anything that could let us know when we're done animating + if self:IsShownBarAnimating() then + self:SubscribeToShownBarOnFinishedAnimating(); + end +end + +function StatusTrackingBarContainerMixin:UnsubscribeFromOnFinishedAnimating(subscribingFrame) + if not self.animationFinishedCallbacks then + return; + end + + self.animationFinishedCallbacks[subscribingFrame] = nil; +end + +function StatusTrackingBarContainerMixin:UpdateShownBarAll() + local shownBar = self:GetShownBar(); + if shownBar then + shownBar:UpdateAll(); + end +end + +function StatusTrackingBarContainerMixin:UpdateBarTextVisibility() + local shownBar = self:GetShownBar(); + if shownBar then + shownBar:UpdateTextVisibility(); + end +end + +function StatusTrackingBarContainerMixin:SetBarAnimation(Animation) + for i, bar in ipairs(self.bars) do + bar.StatusBar:SetDeferAnimationCallback(Animation); + end +end + +function StatusTrackingBarContainerMixin:UpdateBarTick() + local shownBar = self:GetShownBar(); + if shownBar then + shownBar:UpdateTick(); + end +end + +function StatusTrackingBarContainerMixin:ShowText() + local shownBar = self:GetShownBar(); + if shownBar then + shownBar:ShowText(); + end +end + +function StatusTrackingBarContainerMixin:HideText() + local shownBar = self:GetShownBar(); + if shownBar then + shownBar:HideText(); + end +end + +StatusTrackingBarContainerAnimationMixin = {};--- @class StatusTrackingBarContainerAnimationMixin + +function StatusTrackingBarContainerAnimationMixin:OnFinished() + self:GetParent():CheckIfStillAnimating(); +end + +StatusTrackingBarContainerFadeOutAnimationMixin = CreateFromMixins(StatusTrackingBarContainerAnimationMixin);--- @class StatusTrackingBarContainerFadeOutAnimationMixin : StatusTrackingBarContainerAnimationMixin + +function StatusTrackingBarContainerFadeOutAnimationMixin:OnFinished() + local barContainer = self:GetParent(); + + -- If we have a pending bar to show then call fade in which will handle everything + if barContainer.pendingBarToShowIndex then + barContainer:FadeIn(); + return; + end + + barContainer:UpdateShownState(); + + StatusTrackingBarContainerAnimationMixin.OnFinished(self); +end + +EditModeStatusTrackingBarContainerMixin = {};--- @class EditModeStatusTrackingBarContainerMixin + +function EditModeStatusTrackingBarContainerMixin:OnLoad() + self:StatusTrackingBarContainer_OnLoad(); + self:OnSystemLoad(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.lua.annotated.lua new file mode 100644 index 0000000..c4df6bd --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.lua.annotated.lua @@ -0,0 +1,65 @@ + +MainMenuBarVehicleLeaveButtonMixin = {};--- @class MainMenuBarVehicleLeaveButtonMixin + +function MainMenuBarVehicleLeaveButtonMixin:OnLoad() + self:RegisterEvent("UPDATE_BONUS_ACTIONBAR"); + self:RegisterEvent("UPDATE_MULTI_CAST_ACTIONBAR"); + self:RegisterEvent("UNIT_ENTERED_VEHICLE"); + self:RegisterEvent("UNIT_EXITED_VEHICLE"); + self:RegisterEvent("VEHICLE_UPDATE"); +end + +function MainMenuBarVehicleLeaveButtonMixin:OnEnter() + if UnitOnTaxi("player") then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_SetTitle(GameTooltip, TAXI_CANCEL); + GameTooltip:AddLine(TAXI_CANCEL_DESCRIPTION, NORMAL_FONT_COLOR.r, NORMAL_FONT_COLOR.g, NORMAL_FONT_COLOR.b, true); + GameTooltip:Show(); + else + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_SetTitle(GameTooltip, LEAVE_VEHICLE); + GameTooltip:Show(); + end +end + +function MainMenuBarVehicleLeaveButtonMixin:OnEvent(event, ...) + self:Update(); +end + +function MainMenuBarVehicleLeaveButtonMixin:CanExitVehicle() + return CanExitVehicle() and ActionBarController_GetCurrentActionBarState() == LE_ACTIONBAR_STATE_MAIN; +end + +function MainMenuBarVehicleLeaveButtonMixin:UpdateShownState() + self:SetShown(self.isInEditMode or self:CanExitVehicle()); +end + +function MainMenuBarVehicleLeaveButtonMixin:Update() + self:UpdateShownState(); + + if self:CanExitVehicle() then + self:Enable(); + if (PetHasActionBar() and PetActionBar ~= nil) then + PetActionBar:Show(); + end + else + self:SetHighlightTexture([[Interface\Buttons\ButtonHilight-Square]], "ADD"); + self:UnlockHighlight(); + if (PetHasActionBar() and PetActionBar ~= nil) then + PetActionBar:Show(); + end + end +end + +function MainMenuBarVehicleLeaveButtonMixin:OnClicked() + if UnitOnTaxi("player") then + TaxiRequestEarlyLanding(); + + -- Show that the request for landing has been received. + self:Disable(); + self:SetHighlightTexture([[Interface\Buttons\CheckButtonHilight]], "ADD"); + self:LockHighlight(); + else + VehicleExit(); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml new file mode 100644 index 0000000..b62c4ca --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml @@ -0,0 +1,29 @@ + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml.annotated.lua new file mode 100644 index 0000000..7e4004d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml.annotated.lua @@ -0,0 +1,14 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBar/Shared/VehicleLeaveButton.xml#L4) +--- @class MainMenuBarVehicleLeaveButton : Button, EditModeVehicleLeaveButtonSystemTemplate, MainMenuBarVehicleLeaveButtonMixin +--- @field ignoreInLayout boolean # true +--- @field skipAutomaticPositioning any # ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +--- @field Highlight Texture +MainMenuBarVehicleLeaveButton = {} +MainMenuBarVehicleLeaveButton["ignoreInLayout"] = true +MainMenuBarVehicleLeaveButton["skipAutomaticPositioning"] = ACTION_BARS_SKIP_AUTOMATIC_POSITIONING +MainMenuBarVehicleLeaveButton["system"] = Enum.EditModeSystem.VehicleLeaveButton -- inherited +MainMenuBarVehicleLeaveButton["systemNameString"] = HUD_EDIT_MODE_VEHICLE_LEAVE_BUTTON_LABEL -- inherited +MainMenuBarVehicleLeaveButton["defaultHideSelection"] = true -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.lua.annotated.lua new file mode 100644 index 0000000..f3514b3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.lua.annotated.lua @@ -0,0 +1,232 @@ + +local CURRENT_ACTION_BAR_STATE + +function ActionBarController_GetCurrentActionBarState() + return CURRENT_ACTION_BAR_STATE; +end + +function ActionBarController_OnLoad(self) + + --ManyBars + self:RegisterEvent("PLAYER_ENTERING_WORLD"); + self:RegisterEvent("ACTIONBAR_PAGE_CHANGED"); + + -- This is used for shapeshifts/stances + self:RegisterEvent("UPDATE_BONUS_ACTIONBAR"); + + --Vehicle Only + self:RegisterEvent("UNIT_DISPLAYPOWER"); + + --MainBar Only + + --Alternate Only + self:RegisterEvent("UPDATE_VEHICLE_ACTIONBAR"); + self:RegisterEvent("UPDATE_OVERRIDE_ACTIONBAR"); + + --Shapeshift/Stance Only + self:RegisterEvent("UPDATE_SHAPESHIFT_FORM"); + self:RegisterEvent("UPDATE_SHAPESHIFT_FORMS"); + self:RegisterEvent("UPDATE_SHAPESHIFT_USABLE"); + self:RegisterEvent("UPDATE_INVENTORY_ALERTS"); -- Wha?? Still Wha... + + -- Possess Bar + self:RegisterEvent("UPDATE_POSSESS_BAR"); + + --Extra Actionbar Only + self:RegisterEvent("UPDATE_EXTRA_ACTIONBAR"); + + -- MultiBarBottomLeft + self:RegisterEvent("ACTIONBAR_SHOW_BOTTOMLEFT"); + + -- Misc + self:RegisterEvent("PET_BATTLE_CLOSE"); + self:RegisterEvent("PET_BATTLE_OPENING_START") + self:RegisterEvent("SETTINGS_LOADED"); + + CURRENT_ACTION_BAR_STATE = LE_ACTIONBAR_STATE_MAIN; + + -- hack to fix crasy animation on bars when action bar is also animating + StatusTrackingBarManager:SetBarAnimation(ActionBarBusy); + + MainMenuMicroButton_Init(); +end + + +function ActionBarController_OnEvent(self, event, ...) + local arg1, arg2 = ...; + if ( event == "PLAYER_ENTERING_WORLD" ) then + ActionBarController_UpdateAll(); + end + + + if ( event == "UPDATE_BONUS_ACTIONBAR" + or event == "UPDATE_VEHICLE_ACTIONBAR" + or event == "UPDATE_OVERRIDE_ACTIONBAR" + or event == "ACTIONBAR_PAGE_CHANGED" ) then + ActionBarController_UpdateAll(); + end + + if ( event == "UPDATE_BONUS_ACTIONBAR" ) then + IconIntroTracker:ResetAll(); + end + + if ( event == "UNIT_DISPLAYPOWER" ) then + UnitFrameManaBar_Update(OverrideActionBarPowerBar, "vehicle"); + end + + --shapeshift + if ( event == "UPDATE_SHAPESHIFT_FORM" + or event == "UPDATE_SHAPESHIFT_FORMS" + or event == "UPDATE_SHAPESHIFT_USABLE" ) then + StanceBar:Update(); + end + + --possess + if ( event == "UPDATE_POSSESS_BAR" ) then + PossessActionBar:Update(); + StanceBar:Update(); + end + + --Extra Action Bar + if ( event == "UPDATE_EXTRA_ACTIONBAR" ) then + ExtraActionBar_Update(); + end + + -- MultiBarBottomLeft + if ( event == "ACTIONBAR_SHOW_BOTTOMLEFT") then + local function ShowBottomLeftBar() + Settings.SetValue("PROXY_SHOW_ACTIONBAR_2", true); + end + -- If the bottom left bar is requested to be shown before settings are loaded, defer changing the setting until after settings are loaded. + if Settings.GetSetting("PROXY_SHOW_ACTIONBAR_2") then + ShowBottomLeftBar(); + else + EventUtil.ContinueAfterAllEvents(ShowBottomLeftBar, "SETTINGS_LOADED"); + end + end + + if ( event == "PET_BATTLE_CLOSE" ) then + ValidateActionBarTransition(); + end + + -- Override bars should not display within pet battles + if ( event == "PET_BATTLE_OPENING_START" and OverrideActionBar:IsShown()) then + BeginActionBarTransition(OverrideActionBar, nil); + end + + if event == "SETTINGS_LOADED" then + local variables = + { + "PROXY_SHOW_ACTIONBAR_2", + "PROXY_SHOW_ACTIONBAR_3", + "PROXY_SHOW_ACTIONBAR_4", + "PROXY_SHOW_ACTIONBAR_5", + "PROXY_SHOW_ACTIONBAR_6", + "PROXY_SHOW_ACTIONBAR_7", + "PROXY_SHOW_ACTIONBAR_8", + }; + + local function UpdateActionBar() + MultiActionBar_Update(); + StatusTrackingBarManager:UpdateBarTicks(); + EventRegistry:TriggerEvent("ActionBarShownSettingUpdated"); + end + + for index, variable in ipairs(variables) do + Settings.SetOnValueChangedCallback(variable, UpdateActionBar); + end + + UpdateActionBar(); + end +end + +function ActionBarController_UpdateAll(force) + PossessActionBar:Update(); + StanceBar:Update(); + CURRENT_ACTION_BAR_STATE = LE_ACTIONBAR_STATE_MAIN; + + -- If we have a skinned vehicle bar or skinned override bar, display the OverrideActionBar + if ((C_ActionBar.HasVehicleActionBar() and UnitVehicleSkin("player") and UnitVehicleSkin("player") ~= "") + or (C_ActionBar.HasOverrideActionBar() and C_ActionBar.GetOverrideBarSkin() and C_ActionBar.GetOverrideBarSkin() ~= 0)) then + OverrideActionBar:UpdateSkin(); + CURRENT_ACTION_BAR_STATE = LE_ACTIONBAR_STATE_OVERRIDE; + -- If we have a non-skinned override bar of some sort, use the MainActionBar + elseif ( C_ActionBar.HasBonusActionBar() or C_ActionBar.HasOverrideActionBar() or C_ActionBar.HasVehicleActionBar() or C_ActionBar.HasTempShapeshiftActionBar() or C_PetBattles.IsInBattle() ) then + if (C_ActionBar.HasVehicleActionBar()) then + MainActionBar:SetAttribute("actionpage", C_ActionBar.GetVehicleBarIndex()); + elseif (C_ActionBar.HasOverrideActionBar()) then + MainActionBar:SetAttribute("actionpage", C_ActionBar.GetOverrideBarIndex()); + elseif (C_ActionBar.HasTempShapeshiftActionBar()) then + MainActionBar:SetAttribute("actionpage", C_ActionBar.GetTempShapeshiftBarIndex()); + elseif (C_ActionBar.HasBonusActionBar() and C_ActionBar.GetActionBarPage() == 1) then + MainActionBar:SetAttribute("actionpage", C_ActionBar.GetBonusBarIndex()); + else + MainActionBar:SetAttribute("actionpage", C_ActionBar.GetActionBarPage()); + end + + for k, frame in pairs(ActionBarButtonEventsFrame.frames) do + frame:UpdateAction(force); + end + else + -- Otherwise, display the normal action bar + ActionBarController_ResetToDefault(force); + end + + ValidateActionBarTransition(); +end + +function ActionBarController_UpdateAllSpellHighlights() + for k, frame in pairs(ActionBarButtonEventsFrame.frames) do + frame:UpdateSpellHighlightMark(); + end +end + +function ActionBarController_ResetToDefault(force) + MainActionBar:SetAttribute("actionpage", C_ActionBar.GetActionBarPage()); + for k, frame in pairs(ActionBarButtonEventsFrame.frames) do + frame:UpdateAction(force); + end +end + +---------------------------------------------------- +----------------- Animation Code ------------------- +---------------------------------------------------- + +function ActionBarBusy() + return OverrideActionBar.slideOut:IsPlaying() or C_PetBattles.IsInBattle(); +end + +function BeginActionBarTransition(bar, animIn) + bar:Show(); + bar.hideOnFinish = not animIn; + bar.slideOut:Play(animIn); +end + +function ValidateActionBarTransition() + if ActionBarBusy() then + return; --Don't evluate and action bar state durring animations or while in Pet Battles + end + + if CURRENT_ACTION_BAR_STATE == LE_ACTIONBAR_STATE_MAIN then + MainActionBar:Show(); + + if StanceBar:ShouldShow() then + StanceBar:Show(); + end + + if OverrideActionBar:IsShown() then + MicroMenu:ResetMicroMenuPosition(); + BeginActionBarTransition(OverrideActionBar, nil); + end + elseif CURRENT_ACTION_BAR_STATE == LE_ACTIONBAR_STATE_OVERRIDE then + MainActionBar:Hide(); + StanceBar:Hide(); + + if not OverrideActionBar:IsShown() then + BeginActionBarTransition(OverrideActionBar, 1); + end + end + + MultiActionBar_Update(); + UIParent_ManageFramePositions(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml new file mode 100644 index 0000000..096431f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml @@ -0,0 +1,9 @@ + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml.annotated.lua new file mode 100644 index 0000000..d37eb87 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/ActionBarController.xml.annotated.lua @@ -0,0 +1,6 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionBarController/ActionBarController.xml#L3) +--- @class ActionBarController : Frame +ActionBarController = {} + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/Blizzard_ActionBarController.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/Blizzard_ActionBarController.toc new file mode 100644 index 0000000..4ae360d --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionBarController/Blizzard_ActionBarController.toc @@ -0,0 +1,7 @@ +## Title: Blizzard_ActionBarController +## Author: Blizzard Entertainment +## DefaultState: enabled +## Dependencies: Blizzard_ActionBar, Blizzard_OverrideActionBar +## AllowLoad: Game +ActionBarController.lua +ActionBarController.xml diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.lua.annotated.lua new file mode 100644 index 0000000..58b8fa8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.lua.annotated.lua @@ -0,0 +1,96 @@ + +ActionStatusMixin = {};--- @class ActionStatusMixin + +local ACTION_STATUS_FADETIME = 2.0; + +function ActionStatusMixin:OnLoad() + if (InGlue()) then + self:RegisterEvent("GLUE_SCREENSHOT_STARTED"); + self:RegisterEvent("GLUE_SCREENSHOT_SUCCEEDED"); + self:RegisterEvent("GLUE_SCREENSHOT_FAILED"); + else + self:RegisterEvent("SCREENSHOT_STARTED"); + self:RegisterEvent("SCREENSHOT_SUCCEEDED"); + self:RegisterEvent("SCREENSHOT_FAILED"); + end + + self.alternateParentFrame = nil; + self:UpdateParent(); + + EventRegistry:RegisterCallback("UI.AlternateTopLevelParentChanged", self.UpdateParent, self); +end + +function ActionStatusMixin:OnEvent(event, ...) + if ( event == "SCREENSHOT_STARTED" or event == "GLUE_SCREENSHOT_STARTED" ) then + self:Hide(); + else + self.startTime = GetTime(); + self:SetAlpha(1.0); + if ( event == "SCREENSHOT_SUCCEEDED" or event == "GLUE_SCREENSHOT_SUCCEEDED" ) then + self:DisplayMessage(SCREENSHOT_SUCCESS); + end + if ( event == "SCREENSHOT_FAILED" or event == "GLUE_SCREENSHOT_FAILED" ) then + self:DisplayMessage(SCREENSHOT_FAILURE); + end + self:Show(); + end +end + +function ActionStatusMixin:SetAlternateParentFrame(alternateParentFrame) + self.alternateParentFrame = alternateParentFrame; + self:UpdateParent(); +end + +function ActionStatusMixin:ClearAlternateParentFrame() + self.alternateParentFrame = nil; + self:UpdateParent(); +end + +function ActionStatusMixin:DisplayMessage(text) + self.startTime = GetTime(); + self:SetAlpha(1.0); + self.Text:SetText(text); + self:Show(); +end + +function ActionStatusMixin:OnUpdate() + local elapsed = GetTime() - self.startTime; + if ( elapsed < ACTION_STATUS_FADETIME ) then + local alpha = 1.0 - (elapsed / ACTION_STATUS_FADETIME); + self:SetAlpha(alpha); + return; + end + self:Hide(); +end + +function ActionStatusMixin:GetBestParent() + if self.alternateParentFrame then + return self.alternateParentFrame, 1; + else + local parent = GetAppropriateTopLevelParent(); + if parent then + if parent:IsVisible() then + return parent, 1; + end + + if WorldFrame then + return WorldFrame, parent:GetEffectiveScale(); + end + end + end + + return nil, 1; +end + +function ActionStatusMixin:UpdateParent() + self:ClearAllPoints(); + + local parent, scale = self:GetBestParent(); + self:SetParent(parent); + self:SetFrameStrata("TOOLTIP"); + self:SetScale(scale); + + if parent then + self:SetAllPoints(parent); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml new file mode 100644 index 0000000..6dae807 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml.annotated.lua new file mode 100644 index 0000000..90321ee --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/ActionStatus.xml.annotated.lua @@ -0,0 +1,11 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionStatus/ActionStatus.xml#L6) +--- child of ActionStatus +--- @class ActionStatus_Text : FontString, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_ActionStatus/ActionStatus.xml#L3) +--- @class ActionStatus : Frame, ActionStatusMixin +--- @field Text ActionStatus_Text +ActionStatus = {} + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/Blizzard_ActionStatus.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/Blizzard_ActionStatus.toc new file mode 100644 index 0000000..d6266e4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_ActionStatus/Blizzard_ActionStatus.toc @@ -0,0 +1,7 @@ +## Title: Blizzard_ActionStatus +## Author: Blizzard Entertainment +## DefaultState: enabled +## OptionalDep: Blizzard_FrameXML, Blizzard_GlueXML +## AllowLoad: Both +ActionStatus.lua +ActionStatus.xml \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.lua.annotated.lua new file mode 100644 index 0000000..3432161 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.lua.annotated.lua @@ -0,0 +1,1031 @@ +ADDON_BUTTON_HEIGHT = 16; +MAX_ADDONS_DISPLAYED = 19; + +g_addonCategoriesCollapsed = { }; + +local ADDON_ACTIONS_BLOCKED = { }; + +local ALL_CHARACTERS = "All"; +local addonCharacter = ALL_CHARACTERS; + +local function GetAddonCharacter() + if addonCharacter == ALL_CHARACTERS then + return nil; + end + return addonCharacter; +end + +if ( not InGlue() ) then + UIPanelWindows["AddonList"] = { area = "center", pushable = 0, whileDead = 1 }; +end + +-- We use this in the shared XML file +AddonTooltip = nil; +AddonDialog = nil; + +AddonDialogMixin = { };--- @class AddonDialogMixin + +function AddonDialogMixin:OnLoad() + -- Overridden only for Glue +end + +if ( InGlue() ) then + AddonDialogTypes = { }; + HasShownAddonOutOfDateDialog = false; + + AddonDialogTypes["ADDONS_OUT_OF_DATE"] = { + text = ADDONS_OUT_OF_DATE, + button1 = DISABLE_ADDONS, + button2 = LOAD_ADDONS, + OnAccept = function(dialog, data) + AddonDialog_Show("CONFIRM_DISABLE_ADDONS"); + end, + OnCancel = function(dialog, data) + AddonDialog_Show("CONFIRM_LOAD_ADDONS"); + end, + } + + AddonDialogTypes["CONFIRM_LOAD_ADDONS"] = { + text = CONFIRM_LOAD_ADDONS, + button1 = OKAY, + button2 = CANCEL, + OnAccept = function(dialog, data) + C_AddOns.SetAddonVersionCheck(false); + CharacterSelect_CheckDialogStates(); + end, + OnCancel = function(dialog, data) + AddonDialog_Show("ADDONS_OUT_OF_DATE"); + end, + } + + AddonDialogTypes["CONFIRM_DISABLE_ADDONS"] = { + text = CONFIRM_DISABLE_ADDONS, + button1 = OKAY, + button2 = CANCEL, + OnAccept = function(dialog, data) + AddonList_DisableOutOfDate(); + CharacterSelect_CheckDialogStates(); + end, + OnCancel = function(dialog, data) + AddonDialog_Show("ADDONS_OUT_OF_DATE"); + end, + } + + function AddonDialogMixin:OnLoad() + AddonDialogBackground:ClearAllPoints(); + AddonDialogBackground:SetPoint("CENTER"); + + self:SetScript("OnShow", self.OnShow); + self:SetScript("OnKeyDown", self.OnKeyDown); + end + + function AddonDialogMixin:OnShow() + self:Raise(); + end + + function AddonDialogMixin:OnKeyDown() + if ( key == "PRINTSCREEN" ) then + Screenshot(); + return; + end + + if ( key == "ESCAPE" ) then + if ( AddonDialogButton2:IsShown() ) then + AddonDialogButton2:Click(); + else + AddonDialogButton1:Click(); + end + elseif (key == "ENTER" ) then + AddonDialogButton1:Click(); + end + end + + function AddonDialog_Show(which) + -- Set the text of the dialog + AddonDialogText:SetText(AddonDialogTypes[which].text); + + -- Set the buttons of the dialog + if ( AddonDialogTypes[which].button2 ) then + AddonDialogButton1:ClearAllPoints(); + AddonDialogButton1:SetPoint("BOTTOMRIGHT", "AddonDialogBackground", "BOTTOM", -6, 16); + AddonDialogButton2:ClearAllPoints(); + AddonDialogButton2:SetPoint("LEFT", "AddonDialogButton1", "RIGHT", 13, 0); + AddonDialogButton2:SetText(AddonDialogTypes[which].button2); + AddonDialogButton2:Show(); + else + AddonDialogButton1:ClearAllPoints(); + AddonDialogButton1:SetPoint("BOTTOM", "AddonDialogBackground", "BOTTOM", 0, 16); + AddonDialogButton2:Hide(); + end + + AddonDialogButton1:SetText(AddonDialogTypes[which].button1); + + -- Set the miscellaneous variables for the dialog + AddonDialog.which = which; + + -- Finally size and show the dialog + AddonDialogBackground:SetHeight(16 + AddonDialogText:GetHeight() + 8 + AddonDialogButton1:GetHeight() + 16); + AddonDialog:Show(); + end + + function AddonDialog_OnClick(self, button, down) + local index = self:GetID(); + AddonDialog:Hide(); + if ( index == 1 ) then + local OnAccept = AddonDialogTypes[AddonDialog.which].OnAccept; + if ( OnAccept ) then + OnAccept(); + end + else + local OnCancel = AddonDialogTypes[AddonDialog.which].OnCancel; + if ( OnCancel ) then + OnCancel(); + end + end + end + + AddonTooltip = GlueTooltip + + function TryShowAddonDialog() + -- Check to see if any of them are out of date and not disabled + if not GlueAnnouncementDialog:IsShown() and C_AddOns.IsAddonVersionCheckEnabled() and AddonList_HasOutOfDate() and not HasShownAddonOutOfDateDialog then + AddonDialog_Show("ADDONS_OUT_OF_DATE"); + HasShownAddonOutOfDateDialog = true; + return true; + end + + return false; + end + + function UpdateAddonButton() + if CharacterSelectAddonsButton then + if ( C_AddOns.GetNumAddOns() > 0 ) then + CharacterSelectAddonsButton:Show(); + else + CharacterSelectAddonsButton:Hide(); + end + end + end +else + AddonTooltip = GameTooltip +end + +AddonListMixin = { };--- @class AddonListMixin + +function AddonList_ClearCharacterDropdown() + addonCharacter = ALL_CHARACTERS; +end + +function AddonList_HasAnyChanged() + if (AddonList.outOfDate and not C_AddOns.IsAddonVersionCheckEnabled() or (not AddonList.outOfDate and C_AddOns.IsAddonVersionCheckEnabled() and AddonList_HasOutOfDate())) then + return true; + end + for i=1,C_AddOns.GetNumAddOns() do + local character = nil; + if (not InGlue()) then + character = GetAddonCharacter(); + end + local enabled = (C_AddOns.GetAddOnEnableState(i, character) > Enum.AddOnEnableState.None); + local reason = select(5,C_AddOns.GetAddOnInfo(i)) + if ( enabled ~= AddonList.startStatus[i] and reason ~= "DEP_DISABLED" ) then + return true + end + end + return false +end + +local function AddonList_Hide(save) + AddonList.save = save + + if ( InGlue() ) then + AddonList:Hide() + else + HideUIPanel(AddonList); + end +end + +local function AddonList_InitCategory(entry, treeNode) + local category = treeNode:GetData().category; + entry.Title:SetText(category); + + entry.CollapseExpand:SetTreeNode(treeNode); + entry.CollapseExpand:UpdateState(); + + entry.title = category; + entry.treeNode = treeNode; +end + +function AddonListMixin:OnLoad() + self:SetTitle(ADDON_LIST); + ButtonFrameTemplate_HidePortrait(self) + + self.offset = 0; + + if ( InGlue() ) then + self:SetParent(GlueParent) + AddonDialog:SetParent(GlueParent) + AddonDialog:SetFrameStrata("DIALOG") + AddonDialogButton1:SetScript("OnClick", AddonDialog_OnClick); + AddonDialogButton2:SetScript("OnClick", AddonDialog_OnClick); + self:EnableKeyboard(true) + self:SetScript("OnKeyDown", AddonList_OnKeyDown) + self:SetFrameStrata("DIALOG") + else + AddonDialog = nil; + self:SetParent(UIParent); + self:SetFrameStrata("HIGH"); + self.startStatus = {}; + self.shouldReload = false; + self.outOfDate = C_AddOns.IsAddonVersionCheckEnabled() and AddonList_HasOutOfDate(); + self.outOfDateIndexes = {}; + for i=1,C_AddOns.GetNumAddOns() do + local character = GetAddonCharacter(); + self.startStatus[i] = (C_AddOns.GetAddOnEnableState(i, character) > Enum.AddOnEnableState.None); + if (select(5, C_AddOns.GetAddOnInfo(i)) == "INTERFACE_VERSION") then + tinsert(self.outOfDateIndexes, i); + end + end + + -- In Glue this defaults to "All", in-game it should default to the current character at design request. + addonCharacter = UnitGUID("player"); + end + + local indent = 20; + local pad = 5; + local spacing = 8; + local view = CreateScrollBoxListTreeListView(indent, pad, pad, pad, pad, spacing); + + view:SetElementFactory(function(factory, treeNode) + local elementData = treeNode:GetData(); + if elementData.addonIndex then + factory("AddonListEntryTemplate", AddonList_InitAddon); + elseif elementData.category then + factory("AddonListCategoryTemplate", AddonList_InitCategory); + end + end); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); + + self.SearchBox:HookScript("OnTextChanged", AddonList_Update); + + self.Dropdown:SetWidth(140); + + self.ForceLoad:SetScript("OnShow", function(btn) + btn:SetChecked(not C_AddOns.IsAddonVersionCheckEnabled()); + end); + self.ForceLoad:SetScript("OnClick", function(btn) + if ( btn:GetChecked() ) then + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); + C_AddOns.SetAddonVersionCheck(false); + else + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_OFF); + C_AddOns.SetAddonVersionCheck(true); + end + AddonList_Update(); + end); + + self.CancelButton:SetScript("OnClick", AddonList_OnCancel); + self.OkayButton:SetScript("OnClick", AddonList_OnOkay); + self.EnableAllButton:SetScript("OnClick", AddonList_EnableAll); + self.DisableAllButton:SetScript("OnClick", AddonList_DisableAll); +end + +function AddonList_SetStatus(self,lod,status,reload) + local button = self.LoadAddonButton + local string = self.Status + local relstr = self.Reload + + if ( lod ) then + button:Show() + else + button:Hide() + end + + if ( status ) then + string:Show() + else + string:Hide() + end + + if ( reload ) then + relstr:Show() + else + relstr:Hide() + end +end + +local function TriStateCheckbox_SetState(checked, checkButton) + local checkedTexture = checkButton.CheckedTexture; + if ( not checkedTexture ) then + SetBasicMessageDialogText("Can't find checked texture"); + end + if ( not checked or checked == Enum.AddOnEnableState.None ) then + -- nil or Enum.AddOnEnableState.None means not checked + checkButton:SetChecked(false); + elseif ( checked == Enum.AddOnEnableState.All ) then + -- Enum.AddOnEnableState.All is a normal check + checkButton:SetChecked(true); + checkedTexture:SetVertexColor(1, 1, 1); + checkedTexture:SetDesaturated(false); + else + -- Enum.AddOnEnableState.Some is a gray check + checkButton:SetChecked(true); + checkedTexture:SetDesaturated(true); + end + checkButton.state = checked or Enum.AddOnEnableState.None; +end + +function AddonList_InitAddon(entry, treeNode) + local addonIndex = treeNode:GetData().addonIndex; + local name = C_AddOns.GetAddOnName(addonIndex); + local title = C_AddOns.GetAddOnTitle(addonIndex); + local notes = C_AddOns.GetAddOnNotes(addonIndex); + local security = C_AddOns.GetAddOnSecurity(addonIndex); + + -- Get the character from the current list (nil is all characters) + local character = GetAddonCharacter(); + + -- Get loadable state for the selected character, rather than all characters which GetAddOnInfo checks + local loadable, reason = C_AddOns.IsAddOnLoadable(addonIndex, character); + + local checkboxState = C_AddOns.GetAddOnEnableState(addonIndex, character); + local enabled; + if ( not InGlue() ) then + enabled = (C_AddOns.GetAddOnEnableState(addonIndex, character) > Enum.AddOnEnableState.None); + else + enabled = (checkboxState > Enum.AddOnEnableState.None); + end + + TriStateCheckbox_SetState(checkboxState, entry.Enabled); + if (checkboxState == Enum.AddOnEnableState.Some ) then + entry.Enabled.tooltip = ENABLED_FOR_SOME; + else + entry.Enabled.tooltip = nil; + end + + if ( loadable or ( enabled and (reason == "DEP_DEMAND_LOADED" or reason == "DEMAND_LOADED") ) ) then + entry.Title:SetTextColor(1.0, 0.78, 0.0); + elseif ( enabled and reason ~= "DEP_DISABLED" ) then + entry.Title:SetTextColor(1.0, 0.1, 0.1); + else + entry.Title:SetTextColor(0.5, 0.5, 0.5); + end + + local titleText = title or name; + + local iconTexture = C_AddOns.GetAddOnMetadata(addonIndex, "IconTexture"); + local iconAtlas = C_AddOns.GetAddOnMetadata(addonIndex, "IconAtlas"); + + if not iconTexture and not iconAtlas then + iconTexture = [[Interface\ICONS\INV_Misc_QuestionMark]]; + end + + if iconTexture then + titleText = CreateSimpleTextureMarkup(iconTexture, 20, 20) .. " " .. titleText; + elseif iconAtlas then + titleText = CreateAtlasMarkup(iconAtlas, 20, 20) .. " " .. titleText; + end + + if ADDON_ACTIONS_BLOCKED[name] or (AddOnPerformance and AddOnPerformance:AddOnHasPerformanceWarning(name)) then + titleText = titleText .. CreateSimpleTextureMarkup([[Interface\DialogFrame\DialogIcon-AlertNew-16]], 16, 16); + end + entry.Title:SetText(titleText); + + if ( not loadable and reason ) then + entry.Status:SetText(_G["ADDON_"..reason]); + else + entry.Status:SetText(""); + end + + if ( not InGlue() ) then + if ( enabled ~= AddonList.startStatus[addonIndex] and reason ~= "DEP_DISABLED" or + (reason ~= "INTERFACE_VERSION" and tContains(AddonList.outOfDateIndexes, addonIndex)) or + (reason == "INTERFACE_VERSION" and not tContains(AddonList.outOfDateIndexes, addonIndex))) then + if ( enabled ) then + -- special case for loadable on demand addons + if ( AddonList_IsAddOnLoadOnDemand(addonIndex) ) then + AddonList_SetStatus(entry, true, false, false) + else + AddonList_SetStatus(entry, false, false, true) + end + else + AddonList_SetStatus(entry, false, false, true) + end + else + AddonList_SetStatus(entry, false, true, false) + end + else + AddonList_SetStatus(entry, false, true, false) + end + + entry:SetID(addonIndex); + entry.title = title; + entry.treeNode = treeNode; +end + +function AddonList_Update() + local dataProvider = CreateTreeDataProvider(); + + local addonCategoryToTreeNode = {}; + local addonGroupToTreeNode = {}; + local addonGroupPendingChildren = {}; + + local filterText = AddonList.SearchBox:GetText():lower(); + + for i = 1, C_AddOns.GetNumAddOns() do + -- Group is automatically set by C++ for addons with similar names and dependencies, but addons can override for any unusual cases. + -- Every addon gets a group set, if there are no similar addons detected the group is simply the name of the addon. + -- If this value is overriden, the value must EXACTLY match the name of the parent addon that this child addon will be grouped under. + local group = C_AddOns.GetAddOnMetadata(i, "Group"); + + -- Category is an addon defined field that allows for tree view organization of similar addons. + local category = C_AddOns.GetAddOnMetadata(i, "Category"); + + local name = C_AddOns.GetAddOnName(i); + local title = C_AddOns.GetAddOnTitle(i); + local security = C_AddOns.GetAddOnSecurity(i); + + local titleL = title:lower(); + local groupL = group:lower(); + local categoryL = category and category:lower(); + local offset = 1; + local plain = true; + + local match = #filterText == 0 or titleL:find(filterText, offset, plain) or groupL:find(filterText, offset, plain) or (categoryL and categoryL:find(filterText, offset, plain)); + if match then + local groupNode = addonGroupToTreeNode[group]; + + -- If the group was already created, add as a child + if groupNode then + groupNode:Insert({ addonIndex = i }); + + -- If this addon is the parent of a group, create the group node + elseif name == group then + if not category then + -- Default secure addons to an Uncategorized category to separate them from user addons + if security == "SECURE" then + category = "Uncategorized"; + end + end + local categoryNode; + if category then + categoryNode = addonCategoryToTreeNode[category]; + if not categoryNode then + categoryNode = dataProvider:Insert({ category = category }); + categoryNode:SetCollapsed(g_addonCategoriesCollapsed[category]); + addonCategoryToTreeNode[category] = categoryNode; + end + groupNode = categoryNode:Insert({ addonIndex = i }); + else + groupNode = dataProvider:Insert({ addonIndex = i }); + end + + addonGroupToTreeNode[group] = groupNode; + + local pending = addonGroupPendingChildren[group]; + if pending then + for _, child in ipairs(pending) do + groupNode:Insert(child); + end + + addonGroupPendingChildren[group] = nil; + end + + -- If children are sorted before the parent in a group, store the children temporarily until the parent is reached + else + table.insert(GetOrCreateTableEntry(addonGroupPendingChildren, group), { addonIndex = i }); + + end + end + end + + -- Fallback to add any addons with invalid groups to the list so they don't disappear entirely + for group, children in pairs(addonGroupPendingChildren) do + for _, child in ipairs(children) do + dataProvider:Insert(child); + end + end + + local function SortNodes(aNode, bNode) + local a = aNode:GetData(); + local b = bNode:GetData(); + if a.category and b.category then + return strcmputf8i(a.category, b.category) < 0; + elseif a.addonIndex and b.addonIndex then + return a.addonIndex < b.addonIndex + else + return a.category ~= nil; + end + end + + dataProvider:SetSortComparator(SortNodes); + + AddonList.ScrollBox:SetDataProvider(dataProvider, ScrollBoxConstants.RetainScrollPosition); + + if ( not InGlue() ) then + if ( AddonList_HasAnyChanged() ) then + AddonList.OkayButton:SetText(RELOADUI); + AddonList.shouldReload = true; + else + AddonList.OkayButton:SetText(OKAY); + AddonList.shouldReload = false; + end + end +end + +function AddonList_OnKeyDown(self, key) + if ( key == "ESCAPE" ) then + AddonList_OnCancel(); + elseif ( key == "ENTER" ) then + AddonList_OnOkay(); + elseif ( key == "PRINTSCREEN" ) then + Screenshot(); + end +end + +function AddonList_IsAddOnLoadOnDemand(index) + local lod = false + if ( C_AddOns.IsAddOnLoadOnDemand(index) ) then + local deps = C_AddOns.GetAddOnDependencies(index) + local okay = true; + for i = 1, select('#', deps) do + local dep = select(i, deps) + if ( dep and not C_AddOns.IsAddOnLoaded(select(i, deps)) ) then + okay = false; + break; + end + end + lod = okay; + end + return lod; +end + +function AddonList_Enable(index, enabled) + local character = GetAddonCharacter(); + + if ( enabled ) then + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); + C_AddOns.EnableAddOn(index,character); + else + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_OFF); + C_AddOns.DisableAddOn(index,character); + end + AddonList_Update(); +end + +function AddonList_EnableAll(self, button, down) + local character = GetAddonCharacter(); + + C_AddOns.EnableAllAddOns(character); + AddonList_Update(); +end + +function AddonList_DisableAll(self, button, down) + local character = GetAddonCharacter(); + + C_AddOns.DisableAllAddOns(character); + AddonList_Update(); +end + +function AddonList_LoadAddOn(index) + if ( not AddonList_IsAddOnLoadOnDemand(index) ) then return end + C_AddOns.LoadAddOn(index) + if ( C_AddOns.IsAddOnLoaded(index) ) then + AddonList.startStatus[index] = true + end + AddonList_Update() +end + +function AddonList_OnOkay() + PlaySound(SOUNDKIT.GS_LOGIN_CHANGE_REALM_OK); + AddonList_Hide(true); + if ( not InGlue() ) then + if ( AddonList.shouldReload ) then + ReloadUI(); + end + end +end + +function AddonList_OnCancel() + PlaySound(SOUNDKIT.GS_LOGIN_CHANGE_REALM_CANCEL); + AddonList_Hide(false); +end + +local function IsSelected(character) + return addonCharacter == character; +end + +local function SetSelected(character) + addonCharacter = character; + AddonList_Update(); +end + +function AddonListMixin:OnShow() + if ( InGlue() ) then + GlueParent_AddModalFrame(self); + end + + self.Dropdown:SetupMenu(function(dropdown, rootDescription) + rootDescription:SetTag("MENU_ADDON_LIST"); + + rootDescription:CreateRadio(ALL, IsSelected, SetSelected, ALL_CHARACTERS); + + if InGlue() then + local extent = 20; + local maxCharacters = 18; + local maxScrollExtent = extent * maxCharacters; + rootDescription:SetScrollMode(maxScrollExtent); + + local includeEmptySlots = true; + local numCharacters = GetNumCharacters(includeEmptySlots); + for i=1, numCharacters do + local characterInfo = CharacterSelectUtil.GetCharacterInfoTable(i); + + -- Check each entry if it's an empty character. + if characterInfo then + rootDescription:CreateRadio(characterInfo.name, IsSelected, SetSelected, characterInfo.guid); + end + end + else + local text = UnitName("player"); + local guid = UnitGUID("player"); + rootDescription:CreateRadio(text, IsSelected, SetSelected, guid); + end + end); + + AddonList_Update(); + self:UpdatePerformance(); +end + +function AddonListMixin:OnHide() + if ( InGlue() ) then + GlueParent_RemoveModalFrame(self); + end + if ( self.save ) then + C_AddOns.SaveAddOns(); + else + C_AddOns.ResetAddOns(); + end + self.save = false; + + EventRegistry:TriggerEvent("AddonList.FrameHidden"); +end + +function AddonListMixin:OnUpdate() + self:UpdatePerformance(); +end + +local function FormatProfilerPercent(pct) + if pct >= 1 then + return string.format("%.0f%%", pct); + elseif pct >= 0.1 then + return string.format("%.1f%%", pct); + elseif pct >= 0.01 then + return string.format("%.2f%%", pct); + else + return "0%"; + end +end + +function AddonListMixin:GetAddonMetricPercent(addonName, formatString, metric) + local appVal = C_AddOnProfiler.GetApplicationMetric(metric); + local overallVal = C_AddOnProfiler.GetOverallMetric(metric); + local addonVal = C_AddOnProfiler.GetAddOnMetric(addonName, metric); + local relativeTotal = appVal - overallVal + addonVal; + if relativeTotal <= 0 then + return ""; + end + local pct = addonVal / relativeTotal; + local warningPct = GetCVarNumberOrDefault("addonPerformanceMsgWarning"); + local warningPctValid = warningPct > 0.0 and warningPct < 1.0; + local text = formatString:format(FormatProfilerPercent(pct * 100.0), addonName); + + local showWarning = warningPctValid and pct > warningPct; + if showWarning then + text = RED_FONT_COLOR:WrapTextInColorCode(text) .. CreateSimpleTextureMarkup([[Interface\DialogFrame\DialogIcon-AlertNew-16]], 16, 16); + end + + return text, showWarning; +end + +function AddonListMixin:GetOverallMetric(formatString, metric) + local appVal = C_AddOnProfiler.GetApplicationMetric(metric); + if appVal <= 0 then + return ""; + end + + local overallVal = C_AddOnProfiler.GetOverallMetric(metric); + local pct = overallVal / appVal; + local warningPct = GetCVarNumberOrDefault("addonPerformanceMsgWarning"); + local warningPctValid = warningPct > 0.0 and warningPct < 1.0; + local text = formatString:format(FormatProfilerPercent(pct * 100.0)); + local showWarning = warningPctValid and pct > warningPct; + return text, showWarning; +end + +function AddonListMixin:UpdateOverallMetric(fontString, formatString, metric) + local text, showWarning = self:GetOverallMetric(formatString, metric); + + if showWarning then + text = RED_FONT_COLOR:WrapTextInColorCode(text) .. CreateSimpleTextureMarkup([[Interface\DialogFrame\DialogIcon-AlertNew-16]], 16, 16); + fontString:SetScript("OnEnter", function(btn) + AddonTooltip:SetOwner(btn, "ANCHOR_BOTTOM", 0, 0) + AddonTooltip:SetText(ADDON_LIST_PERFORMANCE_WARNING_TOOLTIP); + end); + fontString:SetScript("OnLeave", function(btn) + AddonTooltip:Hide(); + end); + else + fontString:SetScript("OnEnter", nil); + fontString:SetScript("OnLeave", nil); + end + + fontString:SetText(text); +end + +function AddonListMixin:UpdatePerformance() + local enabled = C_AddOnProfiler.IsEnabled(); + local perfUI = self.Performance; + local showPerfUI = enabled and not InGlue(); + perfUI:SetShown(showPerfUI); + + if not showPerfUI then + return; + end + + self:UpdateOverallMetric(perfUI.Current, ADDON_LIST_PERFORMANCE_CURRENT_CPU, Enum.AddOnProfilerMetric.RecentAverageTime); + self:UpdateOverallMetric(perfUI.Average, ADDON_LIST_PERFORMANCE_AVERAGE_CPU, Enum.AddOnProfilerMetric.SessionAverageTime); + self:UpdateOverallMetric(perfUI.Peak, ADDON_LIST_PERFORMANCE_PEAK_CPU, Enum.AddOnProfilerMetric.PeakTime); +end + +function AddonListMixin:UpdateAddOnMemoryUsage() + -- Expensive call - update once when shown, not in OnUpdate, only once per 15 sec + -- For addon performance display, which is not shown in glues + if not InGlue() then + local now = GetTime(); + local SECONDS_BETWEEN_MEMORY_UPDATE = 15; + if not self.lastMemoryUpdate or now > self.lastMemoryUpdate + SECONDS_BETWEEN_MEMORY_UPDATE then + self.lastMemoryUpdate = now; + UpdateAddOnMemoryUsage(); + end + end +end + +function AddonList_HasOutOfDate() + local hasOutOfDate = false; + for i=1, C_AddOns.GetNumAddOns() do + local name, title, notes, loadable, reason = C_AddOns.GetAddOnInfo(i); + local character = nil; + if (not InGlue()) then + character = GetAddonCharacter(); + end + local enabled = (C_AddOns.GetAddOnEnableState(i, character) > Enum.AddOnEnableState.None); + if ( enabled and not loadable and reason == "INTERFACE_VERSION" ) then + hasOutOfDate = true; + break; + end + end + return hasOutOfDate; +end + +function AddonList_SetSecurityIcon(texture, index) + local width = 64; + local height = 16; + local iconWidth = 16; + local increment = iconWidth/width; + local left = (index - 1) * increment; + local right = index * increment; + texture:SetTexCoord( left, right, 0, 1.0); +end + +function AddonList_DisableOutOfDate() + for i=1, C_AddOns.GetNumAddOns() do + local name, title, notes, loadable, reason = C_AddOns.GetAddOnInfo(i); + local character = nil; + if (not InGlue()) then + character = GetAddonCharacter(); + end + local enabled = (C_AddOns.GetAddOnEnableState(i, character) > Enum.AddOnEnableState.None); + if ( enabled and not loadable and reason == "INTERFACE_VERSION" ) then + C_AddOns.DisableAddOn(i); + end + end + C_AddOns.SaveAddOns(); +end + +function AddonTooltip_BuildDeps(...) + local deps = ""; + for i=1, select("#", ...) do + if ( i == 1 ) then + deps = ADDON_DEPENDENCIES .. select(i, ...); + else + deps = deps..", "..select(i, ...); + end + end + return deps; +end + +local function AddonTooltip_AddAddonMetric(tooltip, addon, label, metric, warningOnly) + local text, warning = AddonList:GetAddonMetricPercent(addon, label, metric); + if warning or not warningOnly then + GameTooltip_AddColoredLine(tooltip, text, WHITE_FONT_COLOR); + end +end + +function AddonTooltip_Update(owner) + local id = owner:GetID(); + local name = C_AddOns.GetAddOnName(id); + local title = C_AddOns.GetAddOnTitle(id); + local notes = C_AddOns.GetAddOnNotes(id); + local security = C_AddOns.GetAddOnSecurity(id); + AddonTooltip:ClearLines(); + if ( security == "BANNED" ) then + AddonTooltip:SetText(ADDON_BANNED_TOOLTIP); + else + local tooltipTitle = title or name; + local version = C_AddOns.GetAddOnMetadata(id, "Version"); + AddonTooltip:AddDoubleLine(tooltipTitle, version); + AddonTooltip:AddLine(notes, 1.0, 1.0, 1.0, true); + GameTooltip_AddColoredLine(AddonTooltip, AddonTooltip_BuildDeps(C_AddOns.GetAddOnDependencies(id)), NORMAL_FONT_COLOR, true); + end + if ADDON_ACTIONS_BLOCKED[name] then + AddonTooltip:AddLine(INTERFACE_ACTION_BLOCKED_TOOLTIP:format(ADDON_ACTIONS_BLOCKED[name])); + end + + local loaded = C_AddOns.IsAddOnLoaded(name); + if loaded and C_AddOnProfiler.IsEnabled() and not InGlue() then + GameTooltip_AddBlankLineToTooltip(AddonTooltip); + + AddonTooltip_AddAddonMetric(AddonTooltip, name, ADDON_LIST_PERFORMANCE_AVERAGE_CPU, Enum.AddOnProfilerMetric.SessionAverageTime); + + local showWarningOnly = true; + AddonTooltip_AddAddonMetric(AddonTooltip, name, ADDON_LIST_PERFORMANCE_CURRENT_CPU, Enum.AddOnProfilerMetric.RecentAverageTime, showWarningOnly); + AddonTooltip_AddAddonMetric(AddonTooltip, name, ADDON_LIST_PERFORMANCE_PEAK_CPU, Enum.AddOnProfilerMetric.PeakTime, showWarningOnly); + AddonTooltip_AddAddonMetric(AddonTooltip, name, ADDON_LIST_PERFORMANCE_ENCOUNTER_CPU, Enum.AddOnProfilerMetric.EncounterAverageTime, showWarningOnly); + + local mem = GetAddOnMemoryUsage(name); + if mem > 0 then + if mem > 1024 then + GameTooltip_AddColoredLine(AddonTooltip, ADDON_LIST_PERFORMANCE_MEMORY_MB:format(mem / 1024), WHITE_FONT_COLOR); + else + GameTooltip_AddColoredLine(AddonTooltip, ADDON_LIST_PERFORMANCE_MEMORY_KB:format(mem), WHITE_FONT_COLOR); + end + end + end + + AddonTooltip:Show() +end + +function AddonTooltip_ActionBlocked(addon) + ADDON_ACTIONS_BLOCKED[addon] = (ADDON_ACTIONS_BLOCKED[addon] or 0) + 1; +end + +AddonCategoryCollapseExpandMixin = {};--- @class AddonCategoryCollapseExpandMixin + +function AddonCategoryCollapseExpandMixin:SetTreeNode(treeNode) + self.treeNode = treeNode; +end + +function AddonCategoryCollapseExpandMixin:OnClick(button) + if button == "LeftButton" then + self:ToggleState(); + end +end + +function AddonCategoryCollapseExpandMixin:ToggleState() + local newCollapsed = self.treeNode:ToggleCollapsed(TreeDataProviderConstants.RetainChildCollapse, TreeDataProviderConstants.DoInvalidation); + g_addonCategoriesCollapsed[self.treeNode:GetData().category] = newCollapsed and true or nil; + self:UpdateState(); +end + +function AddonCategoryCollapseExpandMixin:UpdateState() + local isCollapsed = self.treeNode:IsCollapsed(); + + local arrowRotation = isCollapsed and PI or PI / 2.0; + self.Normal:SetRotation(arrowRotation); + self.Highlight:SetRotation(arrowRotation); + self.Pushed:SetRotation(arrowRotation); +end + +AddonListNodeMixin = { };--- @class AddonListNodeMixin + +function AddonListNodeMixin:OnClick(button) + if button == "LeftButton" then + local data = self.treeNode:GetData(); + if data.category then + self.CollapseExpand:ToggleState(); + elseif data.addonIndex then + self.Enabled:Click(); + end + elseif button == "RightButton" then + MenuUtil.CreateContextMenu(nil, function(owner, rootDescription) + rootDescription:SetTag("MENU_ADDON_LIST_ENTRY"); + + rootDescription:CreateTitle(self.title); + + local isAddon = self.treeNode:GetData().addonIndex; + local hasChildren = #self.treeNode.nodes > 0; + + if isAddon then + rootDescription:CreateButton(ADDON_LIST_ENABLE_DEPENDENCIES, function() + self:SetEnabledDependencies(true); + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_OFF); + end); + end + if hasChildren then + rootDescription:CreateButton(isAddon and ADDON_LIST_ENABLE_GROUP or ADDON_LIST_ENABLE_CATEGORY, function() + self:SetEnabledAll(true); + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); + end); + rootDescription:CreateButton(isAddon and ADDON_LIST_DISABLE_GROUP or ADDON_LIST_DISABLE_CATEGORY, function() + self:SetEnabledAll(false); + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_OFF); + end); + end + rootDescription:CreateButton(hasChildren and ADDON_LIST_RESET_ALL_TO_DEFAULT or ADDON_LIST_RESET_TO_DEFAULT, function() + self:SetEnabledAll(nil); + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_OFF); + end); + end); + end +end + +local function AddonListEntry_SetEnabled(index, character, enabled) + if enabled == nil then + enabled = C_AddOns.IsAddOnDefaultEnabled(index); + end + + if enabled then + C_AddOns.EnableAddOn(index, character); + else + C_AddOns.DisableAddOn(index, character); + end +end + +function AddonListNodeMixin:SetEnabledAll(enabled) + local character = GetAddonCharacter(); + + local addonIndex = self.treeNode:GetData().addonIndex; + if addonIndex then + AddonListEntry_SetEnabled(addonIndex, character, enabled); + end + + for _, child in ipairs(self.treeNode.nodes) do + local index = child:GetData().addonIndex; + AddonListEntry_SetEnabled(index, character, enabled); + end + + AddonList_Update(); +end + +AddonListCategoryMixin = CreateFromMixins(AddonListNodeMixin);--- @class AddonListCategoryMixin : AddonListNodeMixin +AddonListEntryMixin = CreateFromMixins(AddonListNodeMixin);--- @class AddonListEntryMixin : AddonListNodeMixin + +function AddonListEntryMixin:OnLoad() + self:SetScript("OnEnter", function() + AddonTooltip:SetOwner(self, "ANCHOR_RIGHT", -270, 0); + + AddonList:UpdateAddOnMemoryUsage() + + AddonTooltip_Update(self); + AddonTooltip:Show(); + + self:SetScript("OnUpdate", function() + AddonTooltip_Update(self); + end); + end); + self:SetScript("OnLeave", function() + AddonTooltip:Hide(); + self:SetScript("OnUpdate", nil); + end); + + self.LoadAddonButton:SetScript("OnClick", function() + AddonList_LoadAddOn(self:GetID()); + end); + + self.Enabled:SetScript("OnClick", function(btn) + AddonList_Enable(self:GetID(), btn:GetChecked()); + end); + self.Enabled:SetScript("OnEnter", function(btn) + if btn.tooltip then + AddonTooltip:SetOwner(btn, "ANCHOR_RIGHT", -270, 0) + AddonTooltip:SetText(btn.tooltip); + AddonTooltip:Show(); + end + end); + self.Enabled:SetScript("OnLeave", function() + AddonTooltip:Hide(); + end); +end + +function AddonListEntryMixin:SetEnabledDependencies(enabled) + local character = GetAddonCharacter(); + + local addonIndex = self.treeNode:GetData().addonIndex; + if addonIndex then + AddOnUtil.SetEnableStateForAddOnAndDependencies(addonIndex, character, enabled); + end + + AddonList_Update(); +end + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml new file mode 100644 index 0000000..9ae0814 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml.annotated.lua new file mode 100644 index 0000000..8fd8440 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/AddonList.xml.annotated.lua @@ -0,0 +1,186 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L4) +--- Template +--- @class AddonListBaseTemplate : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L17) +--- child of AddonListCategoryTemplate +--- @class AddonListCategoryTemplate_CollapseExpand : Button, AddonCategoryCollapseExpandMixin +--- @field Normal Texture +--- @field Highlight Texture +--- @field Pushed Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L32) +--- child of AddonListCategoryTemplate +--- @class AddonListCategoryTemplate_Title : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L14) +--- Template +--- @class AddonListCategoryTemplate : Button, AddonListBaseTemplate, AddonListCategoryMixin +--- @field CollapseExpand AddonListCategoryTemplate_CollapseExpand +--- @field Title AddonListCategoryTemplate_Title + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L73) +--- child of AddonListEntryTemplate +--- @class AddonListEntryTemplate_Enabled : CheckButton, MinimalCheckboxArtTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L82) +--- child of AddonListEntryTemplate +--- @class AddonListEntryTemplate_LoadAddonButton : Button, UIPanelButtonTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L53) +--- child of AddonListEntryTemplate +--- @class AddonListEntryTemplate_Title : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L59) +--- child of AddonListEntryTemplate +--- @class AddonListEntryTemplate_Status : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L64) +--- child of AddonListEntryTemplate +--- @class AddonListEntryTemplate_Reload : FontString, GameFontRed + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L45) +--- Template +--- @class AddonListEntryTemplate : Button, AddonListBaseTemplate, AddonListEntryMixin +--- @field Enabled AddonListEntryTemplate_Enabled +--- @field LoadAddonButton AddonListEntryTemplate_LoadAddonButton +--- @field Title AddonListEntryTemplate_Title +--- @field Status AddonListEntryTemplate_Status +--- @field Reload AddonListEntryTemplate_Reload + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L106) +--- child of AddonDialogBackground +--- @class AddonDialogButton1 : Button, UIPanelButtonTemplate +AddonDialogButton1 = {} +AddonDialogButton1["fitTextCanWidthDecrease"] = true -- inherited +AddonDialogButton1["fitTextWidthPadding"] = 40 -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L109) +--- child of AddonDialogBackground +--- @class AddonDialogButton2 : Button, UIPanelButtonTemplate +AddonDialogButton2 = {} +AddonDialogButton2["fitTextCanWidthDecrease"] = true -- inherited +AddonDialogButton2["fitTextWidthPadding"] = 40 -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L97) +--- child of AddonDialogBackground +--- @class AddonDialogText : FontString, GameFontNormalLarge +AddonDialogText = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L93) +--- child of AddonDialog +--- @class AddonDialogBackground : Frame, DialogBorderTemplate +AddonDialogBackground = {} +AddonDialogBackground["layoutType"] = "Dialog" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L91) +--- @class AddonDialog : Frame, AddonDialogMixin +AddonDialog = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L126) +--- child of AddonList +--- @class AddonList_Dropdown : DropdownButton, WowStyle1DropdownTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L131) +--- child of AddonList +--- @class AddonList_ForceLoad : CheckButton, MinimalCheckboxTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L44) +--- child of AddonList_SearchBox (created in template SearchBoxTemplate) +--- @type SearchBoxTemplate_ClearButton +AddonListClearButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L35) +--- child of AddonList_SearchBox (created in template SearchBoxTemplate) +--- @type Texture +AddonListSearchIcon = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L145) +--- child of AddonList +--- @class AddonList_SearchBox : EditBox, SearchBoxTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L160) +--- child of AddonList_Performance +--- @class AddonList_Performance_Header : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L165) +--- child of AddonList_Performance +--- @class AddonList_Performance_Current : FontString, GameFontWhite + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L170) +--- child of AddonList_Performance +--- @class AddonList_Performance_Average : FontString, GameFontWhite + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L175) +--- child of AddonList_Performance +--- @class AddonList_Performance_Peak : FontString, GameFontWhite + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L151) +--- child of AddonList +--- @class AddonList_Performance : Frame +--- @field Header AddonList_Performance_Header +--- @field Current AddonList_Performance_Current +--- @field Average AddonList_Performance_Average +--- @field Peak AddonList_Performance_Peak +--- @field Divider Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L190) +--- child of AddonList +--- @class AddonList_CancelButton : Button, SharedButtonSmallTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L196) +--- child of AddonList +--- @class AddonList_OkayButton : Button, SharedButtonSmallTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L202) +--- child of AddonList +--- @class AddonList_EnableAllButton : Button, SharedButtonSmallTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L208) +--- child of AddonList +--- @class AddonList_DisableAllButton : Button, SharedButtonSmallTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L214) +--- child of AddonList +--- @class AddonList_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L222) +--- child of AddonList +--- @class AddonList_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L686) +--- child of AddonList (created in template ButtonFrameTemplate) +--- @type ButtonFrameTemplate_Inset +AddonListInset = {} +AddonListInset["layoutType"] = "InsetFrameTemplate" -- inherited + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L680) +--- child of AddonList (created in template ButtonFrameBaseTemplate) +--- @type ButtonFrameBaseTemplate_CloseButton +AddonListCloseButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L663) +--- child of AddonList (created in template ButtonFrameBaseTemplate) +--- @type Texture +AddonListBg = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_AddOnList/AddonList.xml#L120) +--- @class AddonList : Frame, ButtonFrameTemplate, AddonListMixin +--- @field Dropdown AddonList_Dropdown +--- @field ForceLoad AddonList_ForceLoad +--- @field SearchBox AddonList_SearchBox +--- @field Performance AddonList_Performance +--- @field CancelButton AddonList_CancelButton +--- @field OkayButton AddonList_OkayButton +--- @field EnableAllButton AddonList_EnableAllButton +--- @field DisableAllButton AddonList_DisableAllButton +--- @field ScrollBox AddonList_ScrollBox +--- @field ScrollBar AddonList_ScrollBar +AddonList = {} +AddonList["Inset"] = AddonListInset -- inherited +AddonList["CloseButton"] = AddonListCloseButton -- inherited +AddonList["Bg"] = AddonListBg -- inherited +AddonList["layoutType"] = "PortraitFrameTemplate" -- inherited + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Blizzard_AddOnList.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Blizzard_AddOnList.toc new file mode 100644 index 0000000..be88403 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Blizzard_AddOnList.toc @@ -0,0 +1,9 @@ +## Title: Blizzard_AddOnList +## Author: Blizzard Entertainment +## DefaultState: enabled +## Dependencies: Blizzard_SharedXML +## AllowLoad: Both +## SavedVariablesMachine: g_addonCategoriesCollapsed +AddonList.lua +AddonList.xml +Localization.lua diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Localization.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Localization.lua.annotated.lua new file mode 100644 index 0000000..0e89f95 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnList/Localization.lua.annotated.lua @@ -0,0 +1,17 @@ +local l10nTable = { + deDE = {}, + enGB = {}, + enUS = {}, + esES = {}, + esMX = {}, + frFR = {}, + itIT = {}, + koKR = {}, + ptBR = {}, + ptPT = {}, + ruRU = {}, + zhCN = {}, + zhTW = {}, +}; + +SetupLocalization(l10nTable); \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/AddOnPerformance.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/AddOnPerformance.lua.annotated.lua new file mode 100644 index 0000000..b5a7307 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/AddOnPerformance.lua.annotated.lua @@ -0,0 +1,85 @@ + +StaticPopupDialogs["ADDON_PERFORMANCE_SPECIFIC_ERROR"] = { + text = ADDON_PERFORMANCE_SPECIFIC_ERROR_TEXT, + button1 = DISABLE, + button2 = IGNORE_DIALOG, + OnAccept = function(dialog, data) + C_AddOns.DisableAddOn(data); + ReloadUI(); + end, + timeout = 0, + exclusive = 1, + whileDead = 1, + hideOnEscape = 1 +}; + +StaticPopupDialogs["ADDON_PERFORMANCE_OVERALL_ERROR"] = { + text = ADDON_PERFORMANCE_OVERALL_ERROR_TEXT, + button1 = DISABLE, + button2 = IGNORE_DIALOG, + OnAccept = function(dialog, data) + ShowUIPanel(AddonList); + end, + timeout = 0, + exclusive = 1, + whileDead = 1, + hideOnEscape = 1 +}; + +local AddOnPerformanceMixin = { };--- @class AddOnPerformanceMixin + +function AddOnPerformanceMixin:Init() + self.shownPerformanceMessages = { }; + self.addOnHasPerformanceWarning = { }; + + C_Timer.NewTicker(10, function() self:CheckAndDisplayPerformanceMessage() end); +end + +function AddOnPerformanceMixin:DisplayMessage(msg) + if msg.type == Enum.AddOnPerformanceMessageType.SpecificAddOnChatWarning and msg.addOnName then + local message = string.format(ADDON_PERFORMANCE_SPECIFIC_WARNING_TEXT, msg.addOnName); + ChatFrameUtil.AddSystemMessage(message); + elseif msg.type == Enum.AddOnPerformanceMessageType.SpecificAddOnErrorDialog and msg.addOnName then + local textArg2 = nil; + StaticPopup_Show("ADDON_PERFORMANCE_SPECIFIC_ERROR", msg.addOnName, textArg2, msg.addOnName); + elseif msg.type == Enum.AddOnPerformanceMessageType.OverallAddOnErrorDialog then + StaticPopup_Show("ADDON_PERFORMANCE_OVERALL_ERROR"); + else + assertsafe(false, "Invalid addon performance msg."); + end +end + +function AddOnPerformanceMixin:CheckAndDisplayPerformanceMessage() + -- Don't display the message or dialogs while in combat. + if InCombatLockdown() then + return; + end + + local msg = C_AddOnProfiler.CheckForPerformanceMessage(); + if not msg then + return; + end + + if msg.addOnName and not self.addOnHasPerformanceWarning[msg.addOnName] then + self.addOnHasPerformanceWarning[msg.addOnName] = true; + + if AddonList:IsVisible() then + AddonList_Update(); + end + end + + if self.shownPerformanceMessages[msg.type] then + return; + end + + self.shownPerformanceMessages[msg.type] = true; + C_AddOnProfiler.AddPerformanceMessageShown(msg); + + self:DisplayMessage(msg); +end + +function AddOnPerformanceMixin:AddOnHasPerformanceWarning(addOnName) + return self.addOnHasPerformanceWarning[addOnName]; +end + +AddOnPerformance = CreateAndInitFromMixin(AddOnPerformanceMixin); diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/Blizzard_AddOnPerformance.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/Blizzard_AddOnPerformance.toc new file mode 100644 index 0000000..b938675 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AddOnPerformance/Blizzard_AddOnPerformance.toc @@ -0,0 +1,5 @@ +## Title: Blizzard_AddOnPerformance +## Author: Blizzard Entertainment +## DefaultState: enabled +## Dependencies: Blizzard_SharedXML +AddOnPerformance.lua \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.lua.annotated.lua new file mode 100644 index 0000000..d3aa4f6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.lua.annotated.lua @@ -0,0 +1,249 @@ +AdventureMap_QuestChoiceDataProviderMixin = CreateFromMixins(MapCanvasDataProviderMixin);--- @class AdventureMap_QuestChoiceDataProviderMixin : MapCanvasDataProviderMixin + +function AdventureMap_QuestChoiceDataProviderMixin:OnAdded(mapCanvas) + MapCanvasDataProviderMixin.OnAdded(self, mapCanvas); + + self:RegisterEvent("ADVENTURE_MAP_UPDATE_POIS"); + self:RegisterEvent("ADVENTURE_MAP_QUEST_UPDATE"); + self:RegisterEvent("QUEST_ACCEPTED"); +end + +function AdventureMap_QuestChoiceDataProviderMixin:OnEvent(event, ...) + if event == "ADVENTURE_MAP_QUEST_UPDATE" then + self:RefreshAllData(); + elseif event == "ADVENTURE_MAP_UPDATE_POIS" then + self:RefreshAllData(); + elseif event == "QUEST_ACCEPTED" then + if self:GetMap():IsVisible() then + local questID = ...; + for pin in self:GetMap():EnumeratePinsByTemplate("AdventureMap_QuestChoicePinTemplate") do + if pin.questID == questID then + self:OnQuestAccepted(pin); + break; + end + end + end + end +end + +function AdventureMap_QuestChoiceDataProviderMixin:OnHide() + self:SelectQuestID(nil); +end + +function AdventureMap_QuestChoiceDataProviderMixin:RemoveAllData() + self:GetMap():RemoveAllPinsByTemplate("AdventureMap_QuestChoicePinTemplate"); + self:GetMap():RemoveAllPinsByTemplate("AdventureMap_FogPinTemplate"); +end + +function AdventureMap_QuestChoiceDataProviderMixin:RefreshAllData(fromOnShow) + self:RemoveAllData(); + if fromOnShow then + -- We have to wait until the server sends us quest data before we can continue + self.playRevealAnims = true; + return; + end + + self.pinsByQuestID = {}; + local oldSelectedQuestID = self.selectedQuestID; + local newSelectedQuestID = nil; + local newSelectedTextureKit = nil; + self.selectedQuestID = nil; + + for choiceIndex = 1, C_AdventureMap.GetNumZoneChoices() do + local questID, textureKit, name, zoneDescription, normalizedX, normalizedY = C_AdventureMap.GetZoneChoiceInfo(choiceIndex); + if AdventureMap_IsQuestValid(questID, normalizedX, normalizedY) then + self:AddQuest(questID, textureKit, name, zoneDescription, normalizedX, normalizedY); + if oldSelectedQuestID == questID then + newSelectedQuestID = questID; + newSelectedTextureKit = textureKit; + end + end + end + + self:SelectQuestID(newSelectedQuestID, newSelectedTextureKit); + if oldSelectedQuestID and not newSelectedQuestID then + self:GetMap():ZoomOut(); + end + + self.playRevealAnims = false; +end + +function AdventureMap_QuestChoiceDataProviderMixin:AddQuest(questID, textureKit, name, zoneDescription, normalizedX, normalizedY) + local choicePin = self:AddChoicePin(questID, textureKit, name, zoneDescription, normalizedX, normalizedY); + choicePin.fogPin = self:AddFogPin(questID, normalizedX, normalizedY); +end + +function AdventureMap_QuestChoiceDataProviderMixin:AddChoicePin(questID, textureKit, name, zoneDescription, normalizedX, normalizedY) + local pin = self:GetMap():AcquirePin("AdventureMap_QuestChoicePinTemplate", self.playRevealAnims); + pin.questID = questID; + pin.textureKit = textureKit; + pin.Text:SetText(name); + pin.zoneDescription = zoneDescription; + pin:SetPosition(normalizedX, normalizedY); + pin.owner = self; + + if textureKit == "alliance" then + pin.Icon:SetAtlas("QuestPortraitIcon-Alliance-small"); + pin.IconHighlight:SetAtlas("QuestPortraitIcon-Alliance-small"); + + pin.Icon:SetSize(56, 60); + pin.IconHighlight:SetSize(56, 60); + pin.selectedAnimOffset = 0; + elseif textureKit == "horde" then + pin.Icon:SetAtlas("QuestPortraitIcon-Horde-small"); + pin.IconHighlight:SetAtlas("QuestPortraitIcon-Horde-small"); + + pin.Icon:SetSize(58, 66); + pin.IconHighlight:SetSize(58, 66); + pin.selectedAnimOffset = -5; + else + pin.Icon:SetAtlas("QuestPortraitIcon-SandboxQuest", true); + pin.IconHighlight:SetAtlas("QuestPortraitIcon-SandboxQuest", true); + pin.selectedAnimOffset = 0; + end + + self.pinsByQuestID[questID] = pin; + + return pin; +end + +function AdventureMap_QuestChoiceDataProviderMixin:SelectQuestID(questID, textureKit) + if self.selectedQuestID ~= questID then + if self.selectedQuestID then + local pin = self.pinsByQuestID[self.selectedQuestID]; + pin:SetSelected(false); + end + + self.selectedQuestID = questID; + + if self.selectedQuestID then + local pin = self.pinsByQuestID[self.selectedQuestID]; + pin:PanAndZoomTo(); + pin:SetSelected(true); + + local function OnClosedCallback(result) + if self.selectedQuestID then + if result == QUEST_CHOICE_DIALOG_RESULT_ACCEPTED then + self:OnQuestAccepted(self.pinsByQuestID[self.selectedQuestID]); + elseif result == QUEST_CHOICE_DIALOG_RESULT_DECLINED then + self:SelectQuestID(nil); + end + end + end + + AdventureMapQuestChoiceDialog:ShowWithQuest(self:GetMap(), pin, questID, OnClosedCallback, .5); + + if textureKit == "alliance" then + AdventureMapQuestChoiceDialog:SetPortraitAtlas("QuestPortraitIcon-Alliance", 59, 67, 0, 12); + elseif textureKit == "horde" then + AdventureMapQuestChoiceDialog:SetPortraitAtlas("QuestPortraitIcon-Horde", 64, 74, 0, 12); + else + AdventureMapQuestChoiceDialog:SetPortraitAtlas("QuestPortraitIcon-SandboxQuest", 38, 63, 0, 12); + end + + else + AdventureMapQuestChoiceDialog:DeclineQuest(true); + self:GetMap():ZoomOut(); + end + end +end + +function AdventureMap_QuestChoiceDataProviderMixin:AddFogPin(questID, normalizedX, normalizedY) + local pin = self:GetMap():AcquirePin("AdventureMap_FogPinTemplate", self.playRevealAnims); + pin:SetPosition(normalizedX, normalizedY); + return pin; +end + +function AdventureMap_QuestChoiceDataProviderMixin:OnQuestAccepted(pin) + local fogPin = pin.fogPin; + fogPin.OnQuestAcceptedAnim:SetScript("OnFinished", function() + self:GetMap():RemovePin(fogPin); + end); + + fogPin.OnQuestAcceptedAnim:Play(); + + pin.fogPin = nil; + self:GetMap():ZoomOut(); + self:GetMap():RemovePin(pin); +end + +--[[ Quest Choice Pin ]]-- +AdventureMap_QuestChoicePinMixin = CreateFromMixins(MapCanvasPinMixin);--- @class AdventureMap_QuestChoicePinMixin : MapCanvasPinMixin + +function AdventureMap_QuestChoicePinMixin:OnLoad() + self:SetScalingLimits(1.25, 0.825, 1.275); +end + +function AdventureMap_QuestChoicePinMixin:OnAcquired(playAnim) + self.selectedCurrentOffset = nil; + self.selectedTargetOffset = 0; + self.selectedAnimDelay = 0; + + if playAnim then + self.OnAddAnim:Play(); + end +end + +function AdventureMap_QuestChoicePinMixin:OnClick(button) + if button == "LeftButton" then + PlaySound(SOUNDKIT.UI_MISSION_MAP_ZOOM); + self.owner:SelectQuestID(self.questID, self.textureKit); + end +end + +function AdventureMap_QuestChoicePinMixin:OnUpdate(elapsed) + if self.selectedTargetOffset then + self.selectedAnimDelay = self.selectedAnimDelay - elapsed; + if self.selectedAnimDelay > 0 then + return; + end + + self.selectedCurrentOffset = FrameDeltaLerp(self.selectedCurrentOffset or 0, self.selectedTargetOffset, .12); + local percent = -math.cos(math.pi * .5 * (self.selectedCurrentOffset + 1.0)); + self.Icon:SetPoint("CENTER", 0, percent * (132 + self.selectedAnimOffset)); + + if math.abs(self.selectedCurrentOffset - self.selectedTargetOffset) < .001 then + self.selectedTargetOffset = nil; + end + end +end + +function AdventureMap_QuestChoicePinMixin:SetSelected(selected) + self.selectedTargetOffset = selected and 1 or 0; + self.selectedAnimDelay = selected and 0 or .2; +end + +function AdventureMap_QuestChoicePinMixin:OnMouseEnter() + GameTooltip:SetOwner(self, "ANCHOR_PRESERVE"); + GameTooltip:ClearAllPoints(); + GameTooltip:SetPoint("TOPLEFT", self, "TOPRIGHT", 20, 0); + + GameTooltip:AddLine(self.Text:GetText(), 1, 1, 1); + GameTooltip:AddLine(self.zoneDescription, nil, nil, nil, true); + GameTooltip:AddLine(" "); + GameTooltip:AddLine(ADVENTURE_MAP_VIEW_ZONE_TOOLTIP, 0, 1, 0, true); + GameTooltip:Show(); +end + +function AdventureMap_QuestChoicePinMixin:OnMouseLeave() + GameTooltip_Hide(); +end + +--[[ Fog Pin ]]-- +AdventureMap_FogPinMixin = CreateFromMixins(MapCanvasPinMixin);--- @class AdventureMap_FogPinMixin : MapCanvasPinMixin + +function AdventureMap_FogPinMixin:OnLoad() + self:SetAlphaStyle(AM_PIN_ALPHA_STYLE_VISIBLE_WHEN_ZOOMED_IN); + self:SetIgnoreGlobalPinScale(true); + self:SetScale(2.5); +end + +function AdventureMap_FogPinMixin:OnAcquired(playAnim) + if playAnim and not self:GetMap():IsAtMinZoom() then + self.OnAddAnim:Play(); + end +end + +function AdventureMap_FogPinMixin:OnReleased() + self.OnQuestAcceptedAnim:Stop(); +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.xml new file mode 100644 index 0000000..283c85c --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_AdventureMap/AM_QuestChoiceDataProvider.xml @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml.annotated.lua new file mode 100644 index 0000000..22544e0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml.annotated.lua @@ -0,0 +1,247 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L9) +--- Template +--- @class GameFontGreenLarge : Font, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L12) +--- Template +--- @class GameFontNormalHugeBlack : Font, SystemFont_Huge1 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L15) +--- Template +--- @class BossEmoteNormalHuge : Font, SystemFont_Shadow_Huge3 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L18) +--- Template +--- @class NumberFontNormalSmall : Font, NumberFont_OutlineThick_Mono_Small + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L21) +--- Template +--- @class NumberFontNormalSmallGray : Font, NumberFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L25) +--- Template +--- @class NumberFontNormalHuge : Font, NumberFont_Outline_Huge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L29) +--- Template +--- @class Number13FontWhite : Font, Number13Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L36) +--- Template +--- @class Number13FontYellow : Font, Number13Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L43) +--- Template +--- @class Number13FontGray : Font, Number13Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L50) +--- Template +--- @class NumberFontNormalGray : Font, NumberFont_Outline_Med + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L54) +--- Template +--- @class NumberFontNormalLargeYellow : Font, NumberFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L58) +--- Template +--- @class PriceFontWhite : Font, PriceFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L65) +--- Template +--- @class PriceFontGray : Font, PriceFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L72) +--- Template +--- @class PriceFontRed : Font, PriceFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L79) +--- Template +--- @class PriceFontGreen : Font, PriceFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L86) +--- Template +--- @class Number15FontWhite : Font, Number15Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L93) +--- Template +--- @class QuestFontLeft : Font, QuestFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L94) +--- Template +--- @class QuestFontNormalSmall : Font, GameFontBlack + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L98) +--- Template +--- @class ItemTextFontNormal : Font, QuestFont_Large + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L102) +--- Template +--- @class MailTextFontNormal : Font, MailFont_Large + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L106) +--- Template +--- @class SubSpellFont : Font, SpellFont_Small + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L109) +--- Template +--- @class NewSubSpellFont : Font, SubSpellFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L116) +--- Template +--- @class DialogButtonNormalText : Font, SystemFont_Large + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L119) +--- Template +--- @class DialogButtonHighlightText : Font, DialogButtonNormalText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L123) +--- Template +--- @class ZoneTextFont : Font, SystemFont_OutlineThick_WTF + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L126) +--- Template +--- @class SubZoneTextFont : Font, SystemFont_OutlineThick_Huge4 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L127) +--- Template +--- @class PVPInfoTextFont : Font, SystemFont_OutlineThick_Huge2 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L128) +--- Template +--- @class ErrorFont : Font, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L129) +--- Template +--- @class GameNormalNumberFont : Font, NumberFont_GameNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L132) +--- Template +--- @class WhiteNormalNumberFont : Font, NumberFont_GameNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L135) +--- Template +--- @class TextStatusBarTextLarge : Font, SystemFont_Outline + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L138) +--- Template +--- @class WorldMapTextFont : Font, SystemFont_OutlineThick_WTF + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L141) +--- Template +--- @class InvoiceTextFontNormal : Font, InvoiceFont_Med + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L144) +--- Template +--- @class InvoiceTextFontSmall : Font, InvoiceFont_Small + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L147) +--- Template +--- @class CombatTextFont : Font, SystemFont_World + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L150) +--- Template +--- @class CombatTextFontOutline : Font, SystemFont_World_ThickOutline + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L153) +--- Template +--- @class AchievementPointsFont : Font, SystemFont_Shadow_Large + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L156) +--- Template +--- @class AchievementPointsFontSmall : Font, SystemFont_Shadow_Med1 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L159) +--- Template +--- @class AchievementDescriptionFont : Font, SystemFont_Small + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L168) +--- Template +--- @class AchievementCriteriaFont : Font, AchievementDescriptionFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L169) +--- Template +--- @class AchievementDateFont : Font, AchievementFont_Small + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L172) +--- Template +--- @class VehicleMenuBarStatusBarText : Font, SystemFont_Shadow_Med1 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L175) +--- Template +--- @class FocusFontSmall : Font, SystemFont_Shadow_Med2 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L178) +--- Template +--- @class ArtifactAppearanceSetNormalFont : Font, Fancy24Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L181) +--- Template +--- @class ArtifactAppearanceSetHighlightFont : Font, Fancy24Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L185) +--- Template +--- @class CommentatorTeamScoreFont : Font, SystemFont_Shadow_Large + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L190) +--- Template +--- @class CommentatorDampeningFont : Font, CommentatorTeamScoreFont + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L191) +--- Template +--- @class CommentatorTeamNameFont : Font, SystemFont_Large + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L197) +--- Template +--- @class CommentatorCCFont : Font, SystemFont_OutlineThick_WTF + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L201) +--- Template +--- @class CommentatorFontSmall : Font, SystemFont_Med1 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L206) +--- Template +--- @class CommentatorFontMedium : Font, SystemFont_Shadow_Large2 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L211) +--- Template +--- @class CommentatorVictoryFanfare : Font, Game120Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L218) +--- Template +--- @class CommentatorVictoryFanfareTeam : Font, Game72Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L225) +--- Template +--- @class QuestTitleFontBlackShadow : Font, QuestFont_Shadow_Huge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L232) +--- Template +--- @class OptionsFontSmall : Font, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L233) +--- Template +--- @class OptionsFontHighlightSmall : Font, GameFontHighlightSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L234) +--- Template +--- @class OptionsFontHighlight : Font, GameFontHighlight + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L235) +--- Template +--- @class OptionsFontLarge : Font, GameFontNormalLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L236) +--- Template +--- @class OptionsFontLeft : Font, GameFontNormal + + +--- Scripts: +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFontStyles.xml#L3) +do + UNIT_NAME_FONT_KOREAN = "Fonts\\2002B.TTF"; + UNIT_NAME_FONT_CHINESE = "Fonts\\ARKai_T.ttf"; + UNIT_NAME_FONT_CYRILLIC = "Fonts\\FRIZQT___CYR.TTF"; + UNIT_NAME_FONT_ROMAN = "Fonts\\FRIZQT__.TTF"; +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml new file mode 100644 index 0000000..6ee88cb --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml @@ -0,0 +1,1637 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml.annotated.lua new file mode 100644 index 0000000..9cdc7aa --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml.annotated.lua @@ -0,0 +1,286 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L30) +--- Template +--- @class SystemFont_InverseShadow_Small : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L83) +--- Template +--- @class SystemFont_Huge1 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L101) +--- Template +--- @class SystemFont_Huge1_Outline : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L119) +--- Template +--- @class SystemFont_Huge1_Outline_Slug : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L137) +--- Template +--- @class SystemFont_OutlineThick_Huge2 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L155) +--- Template +--- @class SystemFont_OutlineThick_Huge4 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L173) +--- Template +--- @class SystemFont_OutlineThick_WTF : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L191) +--- Template +--- @class SystemFont_NamePlateFixed : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L244) +--- Template +--- @class SystemFont_LargeNamePlateFixed : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L297) +--- Template +--- @class SystemFont_NamePlate : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L315) +--- Template +--- @class SystemFont_NamePlate_Outlined : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L333) +--- Template +--- @class SystemFont_LargeNamePlate : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L371) +--- Template +--- @class SystemFont_NamePlateCastBar : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L390) +--- Template +--- @class NumberFont_GameNormal : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L429) +--- Template +--- @class Number12Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L447) +--- Template +--- @class NumberFont_Outline_Huge : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L466) +--- Template +--- @class QuestFont_Shadow_Small : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L519) +--- Template +--- @class QuestFont_Outline_Huge : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L537) +--- Template +--- @class QuestFont_Super_Huge : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L565) +--- Template +--- @class QuestFont_Super_Huge_Outline : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L593) +--- Template +--- @class QuestFont_Enormous : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L622) +--- Template +--- @class Game11Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L640) +--- Template +--- @class Game12Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L658) +--- Template +--- @class Game13Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L676) +--- Template +--- @class Game13FontShadow : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L729) +--- Template +--- @class Game15Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L747) +--- Template +--- @class Game18Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L765) +--- Template +--- @class Game20Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L783) +--- Template +--- @class Game24Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L801) +--- Template +--- @class Game27Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L819) +--- Template +--- @class Game32Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L837) +--- Template +--- @class Game36Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L855) +--- Template +--- @class Game42Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L873) +--- Template +--- @class Game46Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L891) +--- Template +--- @class Game48Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L909) +--- Template +--- @class Game48FontShadow : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L962) +--- Template +--- @class Game120Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L980) +--- Template +--- @class Game11Font_o1 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L998) +--- Template +--- @class Game12Font_o1 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1016) +--- Template +--- @class Game13Font_o1 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1034) +--- Template +--- @class Game15Font_o1 : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1053) +--- Template +--- @class Fancy12Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1071) +--- Template +--- @class Fancy14Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1089) +--- Template +--- @class Fancy16Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1107) +--- Template +--- @class Fancy18Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1125) +--- Template +--- @class Fancy20Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1143) +--- Template +--- @class Fancy22Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1171) +--- Template +--- @class Fancy24Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1189) +--- Template +--- @class Fancy27Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1207) +--- Template +--- @class Fancy30Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1225) +--- Template +--- @class Fancy32Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1243) +--- Template +--- @class Fancy48Font : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1262) +--- Template +--- @class SplashHeaderFont : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1320) +--- Template +--- @class ChatBubbleFont : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1338) +--- Template +--- @class DestinyFontMed : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1366) +--- Template +--- @class DestinyFontLarge : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1394) +--- Template +--- @class DestinyFontHuge : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1422) +--- Template +--- @class CoreAbilityFont : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1450) +--- Template +--- @class SpellFont_Small : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1468) +--- Template +--- @class InvoiceFont_Med : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1486) +--- Template +--- @class InvoiceFont_Small : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1504) +--- Template +--- @class AchievementFont_Small : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1522) +--- Template +--- @class ReputationDetailFont : Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L1580) +--- Template +--- @class GameFont_Gigantic : Font + + +--- Scripts: +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_Fonts_Shared/Shared/GameFonts.xml#L3) +do + if (LOCALE_koKR) then + STANDARD_TEXT_FONT = "Fonts\\2002.TTF"; + UNIT_NAME_FONT = "Fonts\\2002B.TTF"; + DAMAGE_TEXT_FONT = "Fonts\\K_Damage.TTF"; + elseif (LOCALE_zhCN) then + STANDARD_TEXT_FONT = "Fonts\\ARKai_T.ttf"; + UNIT_NAME_FONT = "Fonts\\ARKai_T.ttf"; + DAMAGE_TEXT_FONT = "Fonts\\ARKai_C.ttf"; + elseif (LOCALE_zhTW) then + STANDARD_TEXT_FONT = "Fonts\\blei00d.TTF"; + UNIT_NAME_FONT = "Fonts\\blei00d.TTF"; + DAMAGE_TEXT_FONT = "Fonts\\bKAI00M.TTF"; + elseif (LOCALE_ruRU) then + STANDARD_TEXT_FONT = "Fonts\\FRIZQT___CYR.TTF"; + UNIT_NAME_FONT = "Fonts\\FRIZQT___CYR.TTF"; + DAMAGE_TEXT_FONT = "Fonts\\FRIZQT___CYR.TTF"; + else + STANDARD_TEXT_FONT = "Fonts\\FRIZQT__.TTF"; + UNIT_NAME_FONT = "Fonts\\FRIZQT__.TTF"; + DAMAGE_TEXT_FONT = "Fonts\\FRIZQT__.TTF"; + end + NAMEPLATE_FONT = "GameFontWhite"; + NAMEPLATE_SPELLCAST_FONT = "GameFontWhiteTiny"; +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/Blizzard_FrameEffects.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/Blizzard_FrameEffects.toc new file mode 100644 index 0000000..20a2a1a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/Blizzard_FrameEffects.toc @@ -0,0 +1,7 @@ +## Author: Blizzard Entertainment +## Title: Blizzard Frame Effects +## AllowLoad: Both + +EffectFactory.lua +GlowEmitter.xml +PowerSwirl.xml \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/EffectFactory.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/EffectFactory.lua.annotated.lua new file mode 100644 index 0000000..e38a74e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/EffectFactory.lua.annotated.lua @@ -0,0 +1,85 @@ +--[[ +Factory for animated frames. + +The template frame must implement Play(animEnum) and forward the Play() call +to the appropriate animation object. + +The derived factory must call Init() with the frame type, template name, +and implement Attach() for any custom position handling. + +See GlowEmitter.lua as an example. +]]-- + +EffectFactoryMixin = {};--- @class EffectFactoryMixin + +-- Derive +function EffectFactoryMixin:Init(frameType, template) + self.pool = CreateFramePool(frameType, nil, template); +end + +-- Derive +function EffectFactoryMixin:Attach(frame, target, offsetX, offsetY, width, height) + frame:SetParent(target); + + local strata = frame:GetFrameStrata(); + frame:SetFrameStrata(strata); + frame:ClearAllPoints(); + + if not frame.originalWidth then + frame.originalWidth = frame:GetWidth(); + end + + if not frame.originalHeight then + frame.originalHeight = frame:GetHeight(); + end + + frame:SetWidth(width or frame.originalWidth); + frame:SetHeight(height or frame.originalHeight); +end + +function EffectFactoryMixin:Show(target, animEnum, offsetX, offsetY, width, height) + assert(animEnum ~= nil, "EffectFactory missing animEnum"); + + if self:HasExisting(target) then + return; + end + + local frame = self.pool:Acquire(); + frame.target = target; + + self:Attach(frame, target, offsetX, offsetY, width, height); + + frame:Show(); + frame:Play(animEnum); +end + +function EffectFactoryMixin:Hide(target) + local frame = self:GetExisting(target); + if not frame then + return; + end + + frame:StopAnimating(); + + self.pool:Release(frame); +end + +function EffectFactoryMixin:SetShown(shown, target, animEnum, offsetX, offsetY, width, height) + if shown then + self:Show(target, animEnum, offsetX, offsetY, width, height); + else + self:Hide(target); + end +end + +function EffectFactoryMixin:GetExisting(target) + for frame in self.pool:EnumerateActive() do + if frame.target == target then + return frame; + end + end +end + +function EffectFactoryMixin:HasExisting(target) + return self:GetExisting(target) ~= nil; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.lua.annotated.lua new file mode 100644 index 0000000..404f0b4 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.lua.annotated.lua @@ -0,0 +1,49 @@ +GlowEmitterMixin = {}--- @class GlowEmitterMixin + +GlowEmitterMixin.Anims = +{ + FadeAnim = 1, + FaintFadeAnim = 2, + NPE_RedButton_GreenGlow = 3, + GreenGlow = 4, +}; + +function GlowEmitterMixin:OnLoad() + self.anims = { + [GlowEmitterMixin.Anims.FadeAnim] = self.FadeAnim, + [GlowEmitterMixin.Anims.FaintFadeAnim] = self.FaintFadeAnim, + [GlowEmitterMixin.Anims.NPE_RedButton_GreenGlow] = self.NPE_RedButton_GreenGlow, + [GlowEmitterMixin.Anims.GreenGlow] = self.GreenGlow, + }; + + self.NineSlice:SetBorderBlendMode("ADD"); +end + +function GlowEmitterMixin:Play(animType) + local anim = self.anims[animType]; + assert(anim, string.format("Missing an animation for animType %d", animType)); + anim:Play(); +end + +GlowEmitterFactory = CreateFromMixins(EffectFactoryMixin); + +function GlowEmitterFactory:Attach(frame, target, offsetX, offsetY, width, height) + EffectFactoryMixin.Attach(self, frame, target, offsetX, offsetY, width, height); + + if offsetX == nil then + offsetX = 12; + end + + if offsetY == nil then + offsetY = 0; + end + + if width then + frame:SetPoint("CENTER"); + else + frame:SetPoint("LEFT", target, -offsetX, offsetY); + frame:SetPoint("RIGHT", target, offsetX, offsetY); + end +end + +GlowEmitterFactory:Init("Frame", "GlowEmitterTemplate"); diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.xml new file mode 100644 index 0000000..a7eb885 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_FrameEffects/GlowEmitter.xml @@ -0,0 +1,70 @@ + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml.annotated.lua new file mode 100644 index 0000000..7c477fa --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml.annotated.lua @@ -0,0 +1,2492 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButtonTemplate +--- @class RaidClassButtonTemplate_Count : FontString, NumberFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L4) +--- Template +--- @class RaidClassButtonTemplate : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L59) +--- Template +--- @class RaidRoleIconTemplate : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButtonTemplate +--- @class RaidGroupButtonTemplate_Rank : Button, RaidRoleIconTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButtonTemplate +--- @class RaidGroupButtonTemplate_Role : Button, RaidRoleIconTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButtonTemplate +--- @class RaidGroupButtonTemplate_ReadyCheck : Frame, ReadyCheckStatusTemplate +--- @field useRaidIcons boolean # true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButtonTemplate +--- @class RaidGroupButtonTemplate_Name : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButtonTemplate +--- @class RaidGroupButtonTemplate_Level : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButtonTemplate +--- @class RaidGroupButtonTemplate_Class : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L76) +--- Explicitly protected +--- Template +--- @class RaidGroupButtonTemplate : Button, SecureUnitButtonTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L212) +--- Template +--- @class RaidGroupSlotTemplate : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroupTemplate +--- @class RaidGroupTemplate_Slot1 : Button, RaidGroupSlotTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroupTemplate +--- @class RaidGroupTemplate_Slot2 : Button, RaidGroupSlotTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroupTemplate +--- @class RaidGroupTemplate_Slot3 : Button, RaidGroupSlotTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroupTemplate +--- @class RaidGroupTemplate_Slot4 : Button, RaidGroupSlotTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroupTemplate +--- @class RaidGroupTemplate_Slot5 : Button, RaidGroupSlotTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L227) +--- Template +--- @class RaidGroupTemplate : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L281) +--- Template +--- @class RaidAuraFrameTemplate : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L354) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_HealthBar : StatusBar, TextStatusBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L384) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_ManaBar : StatusBar, TextStatusBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L429) +--- child of RaidPulloutButtonTemplateTarget +--- @class RaidPulloutButtonTemplate_Target_Name : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L408) +--- Explicitly protected +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_Target : StatusBar, SecureFrameTemplate, TextStatusBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L451) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_TargetTargetFrame : Frame, TooltipBackdropTemplate +--- @field backdropBorderColor any # GRAY_FONT_COLOR + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L479) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_TargetTarget : StatusBar, TextStatusBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L533) +--- Explicitly protected +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_ClearButton : Button, SecureUnitButtonTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L546) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_ReadyCheck : Frame, ReadyCheckStatusTemplate +--- @field useRaidIcons boolean # true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L560) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_Aura1 : Frame, RaidAuraFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L565) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_Aura2 : Frame, RaidAuraFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L570) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_Aura3 : Frame, RaidAuraFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L575) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_Aura4 : Frame, RaidAuraFrameTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L331) +--- child of RaidPulloutButtonTemplate +--- @class RaidPulloutButtonTemplate_Name : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L327) +--- Implicitly protected +--- Template +--- @class RaidPulloutButtonTemplate : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L612) +--- child of RaidPulloutFrameTemplate +--- @class RaidPulloutFrameTemplate_MenuBackdrop : Frame, TooltipBackdropTemplate +--- @field backdropBorderColor any # GRAY_FONT_COLOR + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L604) +--- child of RaidPulloutFrameTemplate +--- @class RaidPulloutFrameTemplate_Name : FontString, GameFontNormalSmall + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L597) +--- Template +--- @class RaidPulloutFrameTemplate : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton16 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton16IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton16 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton16Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L650) +--- @class RaidClassButton16 : Button, RaidClassButtonTemplate +RaidClassButton16 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton15 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton15IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton15 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton15Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L655) +--- @class RaidClassButton15 : Button, RaidClassButtonTemplate +RaidClassButton15 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton14 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton14IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton14 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton14Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L660) +--- @class RaidClassButton14 : Button, RaidClassButtonTemplate +RaidClassButton14 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton13 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton13IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton13 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton13Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L665) +--- @class RaidClassButton13 : Button, RaidClassButtonTemplate +RaidClassButton13 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton12 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton12IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton12 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton12Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L670) +--- @class RaidClassButton12 : Button, RaidClassButtonTemplate +RaidClassButton12 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton11 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton11IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton11 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton11Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L675) +--- @class RaidClassButton11 : Button, RaidClassButtonTemplate +RaidClassButton11 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton10 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton10IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton10 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton10Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L680) +--- @class RaidClassButton10 : Button, RaidClassButtonTemplate +RaidClassButton10 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton9 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton9IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton9 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton9Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L685) +--- @class RaidClassButton9 : Button, RaidClassButtonTemplate +RaidClassButton9 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton8 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton8IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton8 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton8Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L690) +--- @class RaidClassButton8 : Button, RaidClassButtonTemplate +RaidClassButton8 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton7 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton7IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton7 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton7Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L695) +--- @class RaidClassButton7 : Button, RaidClassButtonTemplate +RaidClassButton7 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton6 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton6IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton6 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton6Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L700) +--- @class RaidClassButton6 : Button, RaidClassButtonTemplate +RaidClassButton6 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton5 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton5IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton5 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton5Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L705) +--- @class RaidClassButton5 : Button, RaidClassButtonTemplate +RaidClassButton5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton4 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton4IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton4 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton4Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L710) +--- @class RaidClassButton4 : Button, RaidClassButtonTemplate +RaidClassButton4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton3 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton3IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton3 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton3Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L715) +--- @class RaidClassButton3 : Button, RaidClassButtonTemplate +RaidClassButton3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton2 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton2IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton2 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton2Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L720) +--- @class RaidClassButton2 : Button, RaidClassButtonTemplate +RaidClassButton2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L16) +--- child of RaidClassButton1 (created in template RaidClassButtonTemplate) +--- @type Texture +RaidClassButton1IconTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L25) +--- child of RaidClassButton1 (created in template RaidClassButtonTemplate) +--- @type RaidClassButtonTemplate_Count +RaidClassButton1Count = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L725) +--- @class RaidClassButton1 : Button, RaidClassButtonTemplate +RaidClassButton1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup1 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup1Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup1 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup1Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup1 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup1Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup1 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup1Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup1 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup1Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup1 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup1Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L730) +--- @class RaidGroup1 : Frame, RaidGroupTemplate +RaidGroup1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup2 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup2Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup2 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup2Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup2 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup2Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup2 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup2Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup2 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup2Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup2 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup2Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L735) +--- @class RaidGroup2 : Frame, RaidGroupTemplate +RaidGroup2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup3 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup3Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup3 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup3Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup3 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup3Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup3 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup3Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup3 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup3Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup3 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup3Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L740) +--- @class RaidGroup3 : Frame, RaidGroupTemplate +RaidGroup3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup4 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup4Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup4 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup4Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup4 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup4Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup4 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup4Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup4 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup4Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup4 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup4Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L745) +--- @class RaidGroup4 : Frame, RaidGroupTemplate +RaidGroup4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup5 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup5Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup5 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup5Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup5 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup5Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup5 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup5Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup5 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup5Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup5 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup5Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L750) +--- @class RaidGroup5 : Frame, RaidGroupTemplate +RaidGroup5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup6 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup6Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup6 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup6Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup6 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup6Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup6 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup6Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup6 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup6Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup6 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup6Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L755) +--- @class RaidGroup6 : Frame, RaidGroupTemplate +RaidGroup6 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup7 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup7Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup7 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup7Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup7 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup7Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup7 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup7Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup7 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup7Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup7 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup7Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L760) +--- @class RaidGroup7 : Frame, RaidGroupTemplate +RaidGroup7 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L241) +--- child of RaidGroup8 (created in template RaidGroupTemplate) +--- @type Button +RaidGroup8Label = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L249) +--- child of RaidGroup8 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot1 +RaidGroup8Slot1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L254) +--- child of RaidGroup8 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot2 +RaidGroup8Slot2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L259) +--- child of RaidGroup8 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot3 +RaidGroup8Slot3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L264) +--- child of RaidGroup8 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot4 +RaidGroup8Slot4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L269) +--- child of RaidGroup8 (created in template RaidGroupTemplate) +--- @type RaidGroupTemplate_Slot5 +RaidGroup8Slot5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L765) +--- @class RaidGroup8 : Frame, RaidGroupTemplate +RaidGroup8 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton1Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton1RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton1 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton1Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton1Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton1RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton1 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton1Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton1 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton1ReadyCheck = {} +RaidGroupButton1ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton1 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton1Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton1 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton1Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton1 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton1Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L770) +--- Explicitly protected +--- @class RaidGroupButton1 : Button, RaidGroupButtonTemplate +RaidGroupButton1 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton2Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton2RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton2 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton2Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton2Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton2RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton2 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton2Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton2 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton2ReadyCheck = {} +RaidGroupButton2ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton2 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton2Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton2 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton2Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton2 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton2Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L771) +--- Explicitly protected +--- @class RaidGroupButton2 : Button, RaidGroupButtonTemplate +RaidGroupButton2 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton3Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton3RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton3 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton3Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton3Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton3RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton3 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton3Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton3 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton3ReadyCheck = {} +RaidGroupButton3ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton3 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton3Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton3 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton3Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton3 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton3Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L772) +--- Explicitly protected +--- @class RaidGroupButton3 : Button, RaidGroupButtonTemplate +RaidGroupButton3 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton4Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton4RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton4 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton4Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton4Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton4RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton4 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton4Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton4 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton4ReadyCheck = {} +RaidGroupButton4ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton4 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton4Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton4 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton4Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton4 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton4Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L773) +--- Explicitly protected +--- @class RaidGroupButton4 : Button, RaidGroupButtonTemplate +RaidGroupButton4 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton5Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton5RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton5 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton5Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton5Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton5RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton5 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton5Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton5 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton5ReadyCheck = {} +RaidGroupButton5ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton5 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton5Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton5 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton5Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton5 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton5Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L774) +--- Explicitly protected +--- @class RaidGroupButton5 : Button, RaidGroupButtonTemplate +RaidGroupButton5 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton6Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton6RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton6 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton6Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton6Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton6RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton6 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton6Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton6 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton6ReadyCheck = {} +RaidGroupButton6ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton6 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton6Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton6 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton6Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton6 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton6Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L775) +--- Explicitly protected +--- @class RaidGroupButton6 : Button, RaidGroupButtonTemplate +RaidGroupButton6 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton7Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton7RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton7 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton7Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton7Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton7RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton7 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton7Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton7 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton7ReadyCheck = {} +RaidGroupButton7ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton7 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton7Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton7 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton7Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton7 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton7Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L776) +--- Explicitly protected +--- @class RaidGroupButton7 : Button, RaidGroupButtonTemplate +RaidGroupButton7 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton8Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton8RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton8 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton8Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton8Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton8RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton8 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton8Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton8 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton8ReadyCheck = {} +RaidGroupButton8ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton8 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton8Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton8 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton8Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton8 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton8Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L777) +--- Explicitly protected +--- @class RaidGroupButton8 : Button, RaidGroupButtonTemplate +RaidGroupButton8 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton9Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton9RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton9 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton9Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton9Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton9RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton9 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton9Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton9 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton9ReadyCheck = {} +RaidGroupButton9ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton9 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton9Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton9 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton9Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton9 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton9Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L778) +--- Explicitly protected +--- @class RaidGroupButton9 : Button, RaidGroupButtonTemplate +RaidGroupButton9 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton10Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton10RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton10 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton10Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton10Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton10RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton10 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton10Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton10 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton10ReadyCheck = {} +RaidGroupButton10ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton10 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton10Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton10 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton10Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton10 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton10Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L779) +--- Explicitly protected +--- @class RaidGroupButton10 : Button, RaidGroupButtonTemplate +RaidGroupButton10 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton11Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton11RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton11 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton11Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton11Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton11RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton11 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton11Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton11 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton11ReadyCheck = {} +RaidGroupButton11ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton11 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton11Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton11 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton11Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton11 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton11Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L780) +--- Explicitly protected +--- @class RaidGroupButton11 : Button, RaidGroupButtonTemplate +RaidGroupButton11 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton12Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton12RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton12 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton12Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton12Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton12RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton12 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton12Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton12 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton12ReadyCheck = {} +RaidGroupButton12ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton12 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton12Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton12 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton12Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton12 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton12Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L781) +--- Explicitly protected +--- @class RaidGroupButton12 : Button, RaidGroupButtonTemplate +RaidGroupButton12 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton13Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton13RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton13 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton13Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton13Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton13RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton13 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton13Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton13 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton13ReadyCheck = {} +RaidGroupButton13ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton13 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton13Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton13 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton13Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton13 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton13Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L782) +--- Explicitly protected +--- @class RaidGroupButton13 : Button, RaidGroupButtonTemplate +RaidGroupButton13 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton14Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton14RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton14 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton14Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton14Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton14RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton14 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton14Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton14 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton14ReadyCheck = {} +RaidGroupButton14ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton14 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton14Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton14 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton14Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton14 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton14Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L783) +--- Explicitly protected +--- @class RaidGroupButton14 : Button, RaidGroupButtonTemplate +RaidGroupButton14 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton15Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton15RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton15 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton15Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton15Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton15RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton15 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton15Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton15 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton15ReadyCheck = {} +RaidGroupButton15ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton15 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton15Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton15 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton15Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton15 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton15Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L784) +--- Explicitly protected +--- @class RaidGroupButton15 : Button, RaidGroupButtonTemplate +RaidGroupButton15 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton16Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton16RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton16 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton16Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton16Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton16RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton16 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton16Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton16 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton16ReadyCheck = {} +RaidGroupButton16ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton16 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton16Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton16 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton16Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton16 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton16Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L785) +--- Explicitly protected +--- @class RaidGroupButton16 : Button, RaidGroupButtonTemplate +RaidGroupButton16 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton17Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton17RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton17 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton17Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton17Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton17RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton17 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton17Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton17 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton17ReadyCheck = {} +RaidGroupButton17ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton17 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton17Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton17 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton17Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton17 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton17Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L786) +--- Explicitly protected +--- @class RaidGroupButton17 : Button, RaidGroupButtonTemplate +RaidGroupButton17 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton18Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton18RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton18 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton18Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton18Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton18RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton18 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton18Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton18 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton18ReadyCheck = {} +RaidGroupButton18ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton18 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton18Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton18 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton18Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton18 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton18Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L787) +--- Explicitly protected +--- @class RaidGroupButton18 : Button, RaidGroupButtonTemplate +RaidGroupButton18 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton19Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton19RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton19 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton19Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton19Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton19RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton19 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton19Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton19 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton19ReadyCheck = {} +RaidGroupButton19ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton19 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton19Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton19 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton19Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton19 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton19Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L788) +--- Explicitly protected +--- @class RaidGroupButton19 : Button, RaidGroupButtonTemplate +RaidGroupButton19 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton20Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton20RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton20 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton20Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton20Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton20RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton20 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton20Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton20 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton20ReadyCheck = {} +RaidGroupButton20ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton20 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton20Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton20 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton20Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton20 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton20Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L789) +--- Explicitly protected +--- @class RaidGroupButton20 : Button, RaidGroupButtonTemplate +RaidGroupButton20 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton21Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton21RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton21 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton21Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton21Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton21RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton21 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton21Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton21 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton21ReadyCheck = {} +RaidGroupButton21ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton21 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton21Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton21 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton21Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton21 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton21Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L790) +--- Explicitly protected +--- @class RaidGroupButton21 : Button, RaidGroupButtonTemplate +RaidGroupButton21 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton22Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton22RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton22 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton22Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton22Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton22RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton22 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton22Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton22 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton22ReadyCheck = {} +RaidGroupButton22ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton22 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton22Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton22 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton22Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton22 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton22Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L791) +--- Explicitly protected +--- @class RaidGroupButton22 : Button, RaidGroupButtonTemplate +RaidGroupButton22 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton23Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton23RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton23 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton23Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton23Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton23RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton23 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton23Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton23 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton23ReadyCheck = {} +RaidGroupButton23ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton23 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton23Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton23 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton23Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton23 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton23Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L792) +--- Explicitly protected +--- @class RaidGroupButton23 : Button, RaidGroupButtonTemplate +RaidGroupButton23 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton24Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton24RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton24 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton24Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton24Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton24RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton24 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton24Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton24 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton24ReadyCheck = {} +RaidGroupButton24ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton24 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton24Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton24 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton24Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton24 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton24Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L793) +--- Explicitly protected +--- @class RaidGroupButton24 : Button, RaidGroupButtonTemplate +RaidGroupButton24 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton25Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton25RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton25 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton25Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton25Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton25RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton25 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton25Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton25 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton25ReadyCheck = {} +RaidGroupButton25ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton25 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton25Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton25 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton25Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton25 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton25Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L794) +--- Explicitly protected +--- @class RaidGroupButton25 : Button, RaidGroupButtonTemplate +RaidGroupButton25 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton26Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton26RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton26 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton26Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton26Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton26RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton26 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton26Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton26 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton26ReadyCheck = {} +RaidGroupButton26ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton26 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton26Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton26 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton26Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton26 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton26Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L795) +--- Explicitly protected +--- @class RaidGroupButton26 : Button, RaidGroupButtonTemplate +RaidGroupButton26 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton27Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton27RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton27 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton27Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton27Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton27RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton27 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton27Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton27 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton27ReadyCheck = {} +RaidGroupButton27ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton27 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton27Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton27 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton27Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton27 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton27Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L796) +--- Explicitly protected +--- @class RaidGroupButton27 : Button, RaidGroupButtonTemplate +RaidGroupButton27 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton28Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton28RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton28 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton28Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton28Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton28RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton28 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton28Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton28 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton28ReadyCheck = {} +RaidGroupButton28ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton28 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton28Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton28 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton28Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton28 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton28Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L797) +--- Explicitly protected +--- @class RaidGroupButton28 : Button, RaidGroupButtonTemplate +RaidGroupButton28 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton29Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton29RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton29 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton29Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton29Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton29RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton29 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton29Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton29 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton29ReadyCheck = {} +RaidGroupButton29ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton29 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton29Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton29 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton29Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton29 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton29Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L798) +--- Explicitly protected +--- @class RaidGroupButton29 : Button, RaidGroupButtonTemplate +RaidGroupButton29 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton30Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton30RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton30 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton30Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton30Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton30RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton30 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton30Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton30 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton30ReadyCheck = {} +RaidGroupButton30ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton30 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton30Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton30 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton30Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton30 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton30Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L799) +--- Explicitly protected +--- @class RaidGroupButton30 : Button, RaidGroupButtonTemplate +RaidGroupButton30 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton31Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton31RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton31 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton31Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton31Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton31RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton31 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton31Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton31 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton31ReadyCheck = {} +RaidGroupButton31ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton31 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton31Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton31 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton31Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton31 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton31Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L800) +--- Explicitly protected +--- @class RaidGroupButton31 : Button, RaidGroupButtonTemplate +RaidGroupButton31 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton32Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton32RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton32 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton32Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton32Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton32RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton32 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton32Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton32 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton32ReadyCheck = {} +RaidGroupButton32ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton32 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton32Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton32 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton32Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton32 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton32Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L801) +--- Explicitly protected +--- @class RaidGroupButton32 : Button, RaidGroupButtonTemplate +RaidGroupButton32 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton33Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton33RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton33 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton33Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton33Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton33RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton33 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton33Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton33 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton33ReadyCheck = {} +RaidGroupButton33ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton33 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton33Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton33 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton33Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton33 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton33Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L802) +--- Explicitly protected +--- @class RaidGroupButton33 : Button, RaidGroupButtonTemplate +RaidGroupButton33 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton34Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton34RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton34 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton34Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton34Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton34RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton34 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton34Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton34 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton34ReadyCheck = {} +RaidGroupButton34ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton34 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton34Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton34 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton34Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton34 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton34Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L803) +--- Explicitly protected +--- @class RaidGroupButton34 : Button, RaidGroupButtonTemplate +RaidGroupButton34 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton35Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton35RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton35 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton35Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton35Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton35RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton35 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton35Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton35 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton35ReadyCheck = {} +RaidGroupButton35ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton35 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton35Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton35 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton35Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton35 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton35Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L804) +--- Explicitly protected +--- @class RaidGroupButton35 : Button, RaidGroupButtonTemplate +RaidGroupButton35 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton36Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton36RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton36 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton36Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton36Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton36RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton36 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton36Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton36 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton36ReadyCheck = {} +RaidGroupButton36ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton36 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton36Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton36 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton36Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton36 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton36Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L805) +--- Explicitly protected +--- @class RaidGroupButton36 : Button, RaidGroupButtonTemplate +RaidGroupButton36 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton37Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton37RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton37 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton37Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton37Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton37RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton37 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton37Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton37 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton37ReadyCheck = {} +RaidGroupButton37ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton37 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton37Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton37 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton37Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton37 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton37Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L806) +--- Explicitly protected +--- @class RaidGroupButton37 : Button, RaidGroupButtonTemplate +RaidGroupButton37 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton38Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton38RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton38 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton38Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton38Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton38RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton38 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton38Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton38 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton38ReadyCheck = {} +RaidGroupButton38ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton38 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton38Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton38 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton38Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton38 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton38Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L807) +--- Explicitly protected +--- @class RaidGroupButton38 : Button, RaidGroupButtonTemplate +RaidGroupButton38 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton39Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton39RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton39 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton39Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton39Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton39RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton39 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton39Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton39 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton39ReadyCheck = {} +RaidGroupButton39ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton39 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton39Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton39 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton39Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton39 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton39Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L808) +--- Explicitly protected +--- @class RaidGroupButton39 : Button, RaidGroupButtonTemplate +RaidGroupButton39 = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton40Rank (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton40RankTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L101) +--- child of RaidGroupButton40 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Rank +RaidGroupButton40Rank = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L63) +--- child of RaidGroupButton40Role (created in template RaidRoleIconTemplate) +--- @type Texture +RaidGroupButton40RoleTexture = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L127) +--- child of RaidGroupButton40 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Role +RaidGroupButton40Role = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L149) +--- child of RaidGroupButton40 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_ReadyCheck +RaidGroupButton40ReadyCheck = {} +RaidGroupButton40ReadyCheck["useRaidIcons"] = true + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L80) +--- child of RaidGroupButton40 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Name +RaidGroupButton40Name = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L86) +--- child of RaidGroupButton40 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Level +RaidGroupButton40Level = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L92) +--- child of RaidGroupButton40 (created in template RaidGroupButtonTemplate) +--- @type RaidGroupButtonTemplate_Class +RaidGroupButton40Class = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L809) +--- Explicitly protected +--- @class RaidGroupButton40 : Button, RaidGroupButtonTemplate +RaidGroupButton40 = {} + + +--- Scripts: +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RaidUI/Blizzard_RaidUI.xml#L811) +do + RaidGroupFrame_OnLoad(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Localization.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Localization.lua.annotated.lua new file mode 100644 index 0000000..e7b2086 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RaidUI/Localization.lua.annotated.lua @@ -0,0 +1 @@ +-- This file is executed at the end of addon load diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAllies.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAllies.toc new file mode 100644 index 0000000..2ad8248 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAllies.toc @@ -0,0 +1,7 @@ +## Title: Blizzard Recent Allies +## AllowLoad: both +## AllowLoadGameType: mainline + +Blizzard_RecentAlliesUtil.lua +Blizzard_RecentAlliesTemplates.lua +Blizzard_RecentAlliesTemplates.xml diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.lua.annotated.lua new file mode 100644 index 0000000..9c683b0 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.lua.annotated.lua @@ -0,0 +1,423 @@ +RecentAlliesListMixin = {};--- @class RecentAlliesListMixin + +local RecentAlliesListEvents = { + "RECENT_ALLIES_CACHE_UPDATE", +}; + +function RecentAlliesListMixin:OnLoad() + self:InitializeScrollBox(); +end + +function RecentAlliesListMixin:InitializeScrollBox() + local elementSpacing = 1; + local topPadding, bottomPadding, leftPadding, rightPadding = 0, 0, 0, 0; + local view = CreateScrollBoxListLinearView(topPadding, bottomPadding, leftPadding, rightPadding, elementSpacing); + view:SetElementFactory(function(factory, elementData) + if elementData.isDivider then + factory("RecentAlliesDividerTemplate"); + else + factory("RecentAlliesEntryTemplate", function(button, elementData) + button:Initialize(elementData); + button:SetScript("OnClick", function(button, mouseButtonName) + if mouseButtonName == "LeftButton" then + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); + self.selectionBehavior:ToggleSelect(button); + elseif mouseButtonName == "RightButton" then + button:OpenMenu(); + end + end); + end); + end + end); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.ScrollBox, self.ScrollBar, view); + + self.selectionBehavior = ScrollUtil.AddSelectionBehavior(self.ScrollBox, SelectionBehaviorFlags.Intrusive); + self.selectionBehavior:RegisterCallback(SelectionBehaviorMixin.Event.OnSelectionChanged, function(o, elementData, selected) + local button = self.ScrollBox:FindFrame(elementData); + if button then + button:SetSelected(selected); + end + end, self); +end + +function RecentAlliesListMixin:OnShow() + FrameUtil.RegisterFrameForEvents(self, RecentAlliesListEvents); + + C_RecentAllies.TryRequestRecentAlliesData(); + self:Refresh(ScrollBoxConstants.DiscardScrollPosition); +end + +function RecentAlliesListMixin:SelectFirstRecentAlly() + self.selectionBehavior:SelectFirstElementData(); +end + +function RecentAlliesListMixin:OnHide() + FrameUtil.UnregisterFrameForEvents(self, RecentAlliesListEvents); +end + +function RecentAlliesListMixin:OnEvent(event, ...) + if event == "RECENT_ALLIES_CACHE_UPDATE" then + self:Refresh(ScrollBoxConstants.RetainScrollPosition); + end +end + +function RecentAlliesListMixin:Refresh(retainScrollPosition) + local dataReady = C_RecentAllies.IsRecentAllyDataReady(); + self:SetLoadingSpinnerShown(not dataReady); + if not dataReady then + return; + end + + self.ScrollBox:SetDataProvider(self:BuildRecentAlliesDataProvider(), retainScrollPosition); + if not retainScrollPosition then + self:SelectFirstRecentAlly(); + end +end + +-- Assumes the data provider has pinned recent allies presorted to the front +local function GetBestIndexForPinStateDivider(dataProvider) + local firstUnpinnedAllyIndex = dataProvider:FindIndexByPredicate(function(elementData) return not elementData.stateData.pinExpirationDate end); + + -- If there are no unpinned allies, no divider is needed + if not firstUnpinnedAllyIndex then + return nil; + end + + -- If the first unpinned ally is at the start, there are no pinned allies + if firstUnpinnedAllyIndex == 1 then + return nil; + end + + -- Otherwise, insert the divider before the first unpinned ally + return firstUnpinnedAllyIndex; +end + +local function TryInsertPinStateDividerIntoDataProvider(dataProvider) + local indexForPinStateDivider = GetBestIndexForPinStateDivider(dataProvider); + if indexForPinStateDivider then + dataProvider:InsertAtIndex({ isDivider = true }, indexForPinStateDivider); + end +end + +function RecentAlliesListMixin:BuildRecentAlliesDataProvider() + -- Recent Allies are presorted by pin state, online status, most recently interacted, and then alphabetically + local dataProvider = CreateDataProvider(C_RecentAllies.GetRecentAllies()); + + TryInsertPinStateDividerIntoDataProvider(dataProvider); + + return dataProvider; +end + +function RecentAlliesListMixin:SetLoadingSpinnerShown(shown) + -- We shouldn't show the spinner and the scrolling list at the same time + self.LoadingSpinner:SetShown(shown); + self.ScrollBox:SetShown(not shown); + self.ScrollBar:SetShown(not shown); +end + +RecentAlliesEntryMixin = {};--- @class RecentAlliesEntryMixin + +function RecentAlliesEntryMixin:OnLoad() + self.PartyButton:SetScript("OnClick", function() + local characterData = self.elementData and self.elementData.characterData or nil; + if characterData and characterData.fullName then + C_PartyInfo.InviteUnit(characterData.fullName); + end + end); +end + +function RecentAlliesEntryMixin:Initialize(elementData) + self.elementData = elementData; + self:InitializeCharacterData(); + self:InitializeStateDisplay(); + self:SetMostRecentInteraction(); + + self:SetSelected(SelectionBehaviorMixin.IsElementDataIntrusiveSelected(elementData)); +end + +function RecentAlliesEntryMixin:OnEnter() + self:ShowTooltip(); +end + +function RecentAlliesEntryMixin:OnLeave() + GameTooltip:Hide(); +end + +function RecentAlliesEntryMixin:ShowTooltip() + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + self:BuildRecentAllyTooltip(GameTooltip); + GameTooltip:Show(); +end + +function RecentAlliesEntryMixin:BuildRecentAllyTooltip(tooltip) + self:AddCharacterDataToTooltip(tooltip); + self:AddStateDataToTooltip(tooltip); + self:AddInteractionDataToTooltip(tooltip); +end + +local function AddCharacterNameToTooltip(tooltip, characterData) + GameTooltip_AddNormalLine(tooltip, characterData.fullName); +end + +local function AddCharacterLevelAndRaceToTooltip(tooltip, characterData) + local raceInfo = C_CreatureInfo.GetRaceInfo(characterData.raceID); + local dividerAtlasMarkup = CreateAtlasMarkup("charactercreate-customize-dropdown-linemouseover-middle", 1, 10); + GameTooltip_AddHighlightLine(tooltip, RECENT_ALLY_TOOLTIP_LEVEL_RACE_FORMAT:format(characterData.level, dividerAtlasMarkup, raceInfo and raceInfo.raceName or "")); +end + +local function AddCharacterClassToTooltip(tooltip, characterData) + local classInfo = C_CreatureInfo.GetClassInfo(characterData.classID); + GameTooltip_AddHighlightLine(tooltip, RECENT_ALLY_TOOLTIP_CLASS_FORMAT:format(classInfo and classInfo.className or "")); +end + +local function AddCharacterFactionToTooltip(tooltip, characterData) + local factionInfo = C_CreatureInfo.GetFactionInfo(characterData.raceID); + GameTooltip_AddHighlightLine(tooltip, factionInfo and factionInfo.name or ""); +end + +function RecentAlliesEntryMixin:AddCharacterDataToTooltip(tooltip) + local characterData = self.elementData.characterData; + AddCharacterNameToTooltip(tooltip, characterData); + AddCharacterLevelAndRaceToTooltip(tooltip, characterData); + AddCharacterClassToTooltip(tooltip, characterData); + AddCharacterFactionToTooltip(tooltip, characterData); +end + +local function TryAddCurrentLocationToTooltip(tooltip, stateData) + if stateData.currentLocation then + GameTooltip_AddHighlightLine(tooltip, stateData.currentLocation); + end +end + +function RecentAlliesEntryMixin:AddStateDataToTooltip(tooltip) + TryAddCurrentLocationToTooltip(tooltip, self.elementData.stateData); +end + +function RecentAlliesEntryMixin:AddInteractionsToTooltip(tooltip) + local mostRecentInteraction = self:GetMostRecentInteraction(); + if not mostRecentInteraction then + return; + end + + local leftTooltipText = RECENT_ALLY_RECENT_ACTIVITIES_LABEL; + local timeSinceInteraction = GetServerTime() - mostRecentInteraction.timestamp; + local rightTooltipText = RECENT_ALLY_INTERACTION_TIME_FORMAT:format(RecentAlliesUtil.GetFormattedTime(timeSinceInteraction)); + tooltip:AddDoubleLine(leftTooltipText, rightTooltipText, NORMAL_FONT_COLOR.r, NORMAL_FONT_COLOR.g, NORMAL_FONT_COLOR.b, DISABLED_FONT_COLOR.r, DISABLED_FONT_COLOR.g, DISABLED_FONT_COLOR.b); + + GameTooltip_AddHighlightLine(tooltip, self:ConvertInteractionToTooltipString(mostRecentInteraction)); +end + +local function TryAddNoteToTooltip(tooltip, interactionData) + local note = interactionData.note; + if note and note ~= "" then + GameTooltip_AddNormalLine(tooltip, RECENT_ALLY_NOTE_FORMAT:format(note)); + end +end + +function RecentAlliesEntryMixin:AddInteractionDataToTooltip(tooltip) + TryAddNoteToTooltip(tooltip, self.elementData.interactionData); + + if self:HasInteractions() then + GameTooltip_AddBlankLineToTooltip(tooltip); + self:AddInteractionsToTooltip(tooltip); + end +end + +function RecentAlliesEntryMixin:GetMostRecentInteraction() + if self:HasInteractions() then + -- Assuming the list of interactions is presorted from most recent to least recent + return self.elementData.interactionData.interactions[1]; + end +end + +function RecentAlliesEntryMixin:InitializeStateDisplay() + local stateData = self.elementData.stateData; + self:UpdateOnlineStatusIcon(); + self:UpdateBackgroundForOnlineStatus(stateData.isOnline); + + self.StateIconContainer.PinDisplay:Init(stateData); + self.StateIconContainer.FriendRequestPendingDisplay:SetShown(stateData.hasFriendRequestPending); + self.StateIconContainer.PinDisplay:SetShown(stateData.pinExpirationDate ~= nil); + + self.PartyButton:SetEnabled(stateData.isOnline); + + self:SetCharacterLocation(stateData.currentLocation); +end + +function RecentAlliesEntryMixin:GetBestIconForOnlineStatus() + local stateData = self.elementData.stateData; + if not stateData.isOnline then + return "Interface\\FriendsFrame\\StatusIcon-Offline"; + elseif stateData.isAFK then + return "Interface\\FriendsFrame\\StatusIcon-Away"; + elseif stateData.isDND then + return "Interface\\FriendsFrame\\StatusIcon-DnD"; + else + return "Interface\\FriendsFrame\\StatusIcon-Online"; + end +end + +function RecentAlliesEntryMixin:UpdateOnlineStatusIcon() + self.OnlineStatusIcon:SetTexture(self:GetBestIconForOnlineStatus()); +end + +function RecentAlliesEntryMixin:SetMostRecentInteraction() + local mostRecentInteraction = self:GetMostRecentInteraction(); + self.CharacterData.MostRecentInteraction:SetText(mostRecentInteraction and mostRecentInteraction.description or ""); +end + +function RecentAlliesEntryMixin:ConvertInteractionToTooltipString(interactionData) + if not interactionData then + return ""; + end + + local contextData = interactionData.contextData; + -- If we need item data, ensure it is loaded here before moving on + if contextData and contextData.itemID then + local item = Item:CreateFromItemID(contextData.itemID); + if item and not item:IsItemDataCached() then + item:ContinueOnItemLoad(function() + self:ShowTooltip(); + end); + return; + end + end + + return RecentAlliesUtil.GenerateContextStringForInteraction(interactionData); +end + +function RecentAlliesEntryMixin:HasInteractions() + return #self.elementData.interactionData.interactions > 0; +end + +function RecentAlliesEntryMixin:UpdateBackgroundForOnlineStatus(online) + local bestBackgroundColor = online and FRIENDS_WOW_BACKGROUND_COLOR or FRIENDS_OFFLINE_BACKGROUND_COLOR; + self.NormalTexture:SetColorTexture(bestBackgroundColor:GetRGBA()); +end + +function RecentAlliesEntryMixin:InitializeCharacterData() + self:SetCharacterName(); + self:SetCharacterLevel(); + self:SetCharacterClass(); + self:RefreshCharacterDataDividerColor(); +end + +local function GetBestCharacterDataDisplayColor(stateData) + return stateData and stateData.isOnline and NORMAL_FONT_COLOR or FRIENDS_GRAY_COLOR; +end + +function RecentAlliesEntryMixin:SetCharacterName() + self.CharacterData.Name:SetText(GetBestCharacterDataDisplayColor(self.elementData.stateData):WrapTextInColorCode(self.elementData.characterData.name)); + self.CharacterData.Name:SetWidth(math.min(self.CharacterData.Name:GetUnboundedStringWidth(), self.CharacterData.Name.maxWidth)); +end + +function RecentAlliesEntryMixin:SetCharacterLevel() + self.CharacterData.Level:SetText(GetBestCharacterDataDisplayColor(self.elementData.stateData):WrapTextInColorCode(self.elementData.characterData.level)); + self.CharacterData.Level:SetWidth(self.CharacterData.Level:GetUnboundedStringWidth()); +end + +function RecentAlliesEntryMixin:SetCharacterClass() + local classInfo = C_CreatureInfo.GetClassInfo(self.elementData.characterData.classID); + if not classInfo then + self.CharacterData.Class:SetText(""); + return; + end + + local bestFontColor = self.elementData.stateData.isOnline and GetClassColorObj(classInfo.classFile) or FRIENDS_GRAY_COLOR; + self.CharacterData.Class:SetText(bestFontColor:WrapTextInColorCode(classInfo.className)); +end + +function RecentAlliesEntryMixin:SetCharacterLocation(location) + self.CharacterData.Location:SetText(location or ""); +end + +function RecentAlliesEntryMixin:RefreshCharacterDataDividerColor() + local bestDividerColor = GetBestCharacterDataDisplayColor(self.elementData.stateData) + for index, divider in ipairs(self.CharacterData.Dividers) do + divider:SetVertexColor(bestDividerColor:GetRGB()); + end +end + +function RecentAlliesEntryMixin:SetSelected(selected) + self:SetHighlightLocked(selected); +end + +function RecentAlliesEntryMixin:OpenMenu() + local recentAllyData = self.elementData; + local contextData = { + recentAllyData = recentAllyData, + -- The generic unit popup code expects data in the format below, so we duplicate a couple things for compatibility + name = recentAllyData.characterData.name, + server = recentAllyData.characterData.realmName, + guid = recentAllyData.characterData.guid, + isOffline = not recentAllyData.stateData.isOnline, + }; + + local bestMenu = recentAllyData.stateData.isOnline and "RECENT_ALLY" or "RECENT_ALLY_OFFLINE"; + UnitPopup_OpenMenu(bestMenu, contextData); +end + +RecentAlliesEntryPartyButtonMixin = {};--- @class RecentAlliesEntryPartyButtonMixin + +function RecentAlliesEntryPartyButtonMixin:OnEnter() + self:ShowTooltip(); +end + +function RecentAlliesEntryPartyButtonMixin:ShowTooltip() + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_AddHighlightLine(GameTooltip, RECENT_ALLIES_PARTY_BUTTON_TOOLTIP); + + if not self:IsEnabled() then + GameTooltip_AddErrorLine(GameTooltip, self:GetBestDisabledTooltip()); + end + + GameTooltip:Show(); +end + +function RecentAlliesEntryPartyButtonMixin:GetBestDisabledTooltip() + return RECENT_ALLIES_PARTY_BUTTON_OFFLINE_TOOLTIP; +end + +function RecentAlliesEntryPartyButtonMixin:OnLeave() + GameTooltip:Hide(); +end + +RecentAlliesEntryPinDisplayMixin = {};--- @class RecentAlliesEntryPinDisplayMixin + +function RecentAlliesEntryPinDisplayMixin:Init(stateData) + self.pinExpirationDate = stateData.pinExpirationDate; + self:RefreshPinExpirationIcon(); +end + +local function IsPinNearingExpiration(pinExpirationDate) + if not pinExpirationDate then + return false; + end + + local remainingDays = (pinExpirationDate - GetServerTime()) / SECONDS_PER_DAY; + return remainingDays <= Constants.RecentAlliesConsts.PIN_EXPIRATION_WARNING_DAYS; +end + +function RecentAlliesEntryPinDisplayMixin:RefreshPinExpirationIcon() + self.Icon:SetAtlas(IsPinNearingExpiration(self.pinExpirationDate) and "friendslist-recentallies-pin" or "friendslist-recentallies-pin-yellow", TextureKitConstants.IgnoreAtlasSize); +end + +function RecentAlliesEntryPinDisplayMixin:OnEnter() + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + + local wrapText = false; + if IsPinNearingExpiration(self.pinExpirationDate) then + -- Set to a minimum of 1 second (lowest we should show is "< 1 Hour") + local timeUntilExpiration = math.max(self.pinExpirationDate - GetServerTime(), 1); + GameTooltip_AddHighlightLine(GameTooltip, RECENT_ALLY_PIN_EXPIRING_TOOLTIP:format(RecentAlliesUtil.GetFormattedTime(timeUntilExpiration), wrapText)); + else + GameTooltip_AddHighlightLine(GameTooltip, RECENT_ALLY_PIN_TOOLTIP, wrapText); + end + + GameTooltip:Show(); +end + +function RecentAlliesEntryPinDisplayMixin:OnLeave() + GameTooltip:Hide(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml new file mode 100644 index 0000000..c3eff96 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml @@ -0,0 +1,206 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml.annotated.lua new file mode 100644 index 0000000..b5b49d6 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml.annotated.lua @@ -0,0 +1,100 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L6) +--- child of RecentAlliesListTemplate +--- @class RecentAlliesListTemplate_ScrollBox : Frame, WowScrollBoxList + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L13) +--- child of RecentAlliesListTemplate +--- @class RecentAlliesListTemplate_ScrollBar : EventFrame, MinimalScrollBar + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L20) +--- child of RecentAlliesListTemplate +--- @class RecentAlliesListTemplate_LoadingSpinner : Frame, SpinnerTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L4) +--- Template +--- @class RecentAlliesListTemplate : Frame, RecentAlliesListMixin +--- @field ScrollBox RecentAlliesListTemplate_ScrollBox +--- @field ScrollBar RecentAlliesListTemplate_ScrollBar +--- @field LoadingSpinner RecentAlliesListTemplate_LoadingSpinner + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L35) +--- Template +--- @class RecentAlliesDividerTemplate : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L44) +--- Template +--- @class RecentAlliesEntryPartyButtonTemplate : Button, RecentAlliesEntryPartyButtonMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L64) +--- Template +--- @class RecentAlliesEntryFriendRequestPendingDisplayTemplate : Frame +--- @field Icon Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L73) +--- Template +--- @class RecentAlliesEntryPinDisplayTemplate : Frame, RecentAlliesEntryPinDisplayMixin +--- @field Icon Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L99) +--- child of RecentAlliesEntryTemplate +--- @class RecentAlliesEntryTemplate_PartyButton : Button, RecentAlliesEntryPartyButtonTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L110) +--- child of RecentAlliesEntryTemplate_StateIconContainer +--- @class RecentAlliesEntryTemplate_StateIconContainer_FriendRequestPendingDisplay : Frame, RecentAlliesEntryFriendRequestPendingDisplayTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L115) +--- child of RecentAlliesEntryTemplate_StateIconContainer +--- @class RecentAlliesEntryTemplate_StateIconContainer_PinDisplay : Frame, RecentAlliesEntryPinDisplayTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L104) +--- child of RecentAlliesEntryTemplate +--- @class RecentAlliesEntryTemplate_StateIconContainer : Frame +--- @field FriendRequestPendingDisplay RecentAlliesEntryTemplate_StateIconContainer_FriendRequestPendingDisplay +--- @field PinDisplay RecentAlliesEntryTemplate_StateIconContainer_PinDisplay + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L130) +--- child of RecentAlliesEntryTemplate_CharacterData +--- @class RecentAlliesEntryTemplate_CharacterData_Name : FontString, GameFontNormal +--- @field maxWidth number # 150 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L147) +--- child of RecentAlliesEntryTemplate_CharacterData +--- @class RecentAlliesEntryTemplate_CharacterData_Level : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L160) +--- child of RecentAlliesEntryTemplate_CharacterData +--- @class RecentAlliesEntryTemplate_CharacterData_Class : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L167) +--- child of RecentAlliesEntryTemplate_CharacterData +--- @class RecentAlliesEntryTemplate_CharacterData_MostRecentInteraction : FontString, Game11Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L175) +--- child of RecentAlliesEntryTemplate_CharacterData +--- @class RecentAlliesEntryTemplate_CharacterData_Location : FontString, Game11Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L122) +--- child of RecentAlliesEntryTemplate +--- @class RecentAlliesEntryTemplate_CharacterData : Frame +--- @field Name RecentAlliesEntryTemplate_CharacterData_Name +--- @field NameDivider Texture +--- @field Level RecentAlliesEntryTemplate_CharacterData_Level +--- @field LevelDivider Texture +--- @field Class RecentAlliesEntryTemplate_CharacterData_Class +--- @field MostRecentInteraction RecentAlliesEntryTemplate_CharacterData_MostRecentInteraction +--- @field Location RecentAlliesEntryTemplate_CharacterData_Location +--- @field Dividers table + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesTemplates.xml#L86) +--- Template +--- @class RecentAlliesEntryTemplate : Button, RecentAlliesEntryMixin +--- @field PartyButton RecentAlliesEntryTemplate_PartyButton +--- @field StateIconContainer RecentAlliesEntryTemplate_StateIconContainer +--- @field CharacterData RecentAlliesEntryTemplate_CharacterData +--- @field OnlineStatusIcon Texture +--- @field NormalTexture Texture +--- @field HighlightTexture Texture + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesUtil.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesUtil.lua.annotated.lua new file mode 100644 index 0000000..a7c3958 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecentAllies/Blizzard_RecentAlliesUtil.lua.annotated.lua @@ -0,0 +1,121 @@ +RecentAlliesUtil = {}; + +local recentAlliesTimeFormatter = CreateFromMixins(SecondsFormatterMixin); +recentAlliesTimeFormatter:Init( + SECONDS_PER_HOUR, + SecondsFormatter.Abbreviation.None +); + +function RecentAlliesUtil.GetFormattedTime(time) + if not time then + return ""; + end + + -- Show hours if the time is under a day, otherwise show days + local bestInterval = time < SECONDS_PER_DAY and SecondsFormatter.Interval.Hours or SecondsFormatter.Interval.Days; + recentAlliesTimeFormatter:SetMinInterval(bestInterval); + return recentAlliesTimeFormatter:Format(time); +end + +-- Basic interactions simply display the name of the interaction and the location (if available) +local function GenerateBasicContextString(interactionData) + local contextString = interactionData.description; + if interactionData.contextData.locationName then + contextString = RECENT_ALLY_TOOLTIP_INTERACTION_WITH_CONTEXT_FORMAT:format(contextString, interactionData.contextData.locationName); + end + + return contextString; +end + +local function GetItemNameColored(item) + if not item or not item:GetItemName() then + return ""; + end + + local itemQualityColor = item:GetItemQualityColor(); + return itemQualityColor and itemQualityColor.color:WrapTextInColorCode(item:GetItemName()) or HIGHLIGHT_FONT_COLOR:WrapTextInColorCode(item:GetItemName()); +end + +-- Crafting order interactions try to add the relevant item (if possible) +-- Assumes item data is already loaded +local function GenerateCraftingOrderContextString(interactionData) + local contextString = interactionData.description; + if interactionData.contextData.itemID then + local item = Item:CreateFromItemID(interactionData.contextData.itemID); + contextString = RECENT_ALLY_TOOLTIP_INTERACTION_WITH_CONTEXT_FORMAT:format(contextString, GetItemNameColored(item)); + end + + return contextString; +end + +local function GenerateRaidInteractionContextString(interactionData) + local contextString = interactionData.description; + if interactionData.contextData.locationName and interactionData.contextData.activityDifficultyID then + local raidName = interactionData.contextData.locationName; + local difficultyName = DifficultyUtil.GetDifficultyName(interactionData.contextData.activityDifficultyID); + if difficultyName then + raidName = RECENT_ALLY_RAID_NAME_STRING_FORMAT:format(raidName, difficultyName); + end + + contextString = RECENT_ALLY_TOOLTIP_INTERACTION_WITH_CONTEXT_FORMAT:format(contextString, raidName); + end + + return contextString; +end + +local function GenerateDelveInteractionContextString(interactionData) + local contextString = interactionData.description; + if interactionData.contextData.locationName and interactionData.contextData.activityDifficultyLevel then + local delveName = interactionData.contextData.locationName + local tierString = RECENT_ALLY_DELVE_TIER_LABEL:format(interactionData.contextData.activityDifficultyLevel); + local fullDelveName = RECENT_ALLY_DELVE_NAME_STRING_FORMAT:format(delveName, tierString); + contextString = RECENT_ALLY_TOOLTIP_INTERACTION_WITH_CONTEXT_FORMAT:format(contextString, fullDelveName); + end + + return contextString; +end + +local function GenerateMythicPlusDungeonInteractionContextString(interactionData) + local contextString = interactionData.description; + if interactionData.contextData.locationName and interactionData.contextData.activityDifficultyLevel then + local dungeonName = interactionData.contextData.locationName + local keystoneLevelString = CHALLENGE_MODE_ITEM_POWER_LEVEL:format(interactionData.contextData.activityDifficultyLevel); + local fullDungeonName = RECENT_ALLY_MYTHIC_PLUS_DUNGEON_NAME_STRING_FORMAT:format(dungeonName, keystoneLevelString); + contextString = RECENT_ALLY_TOOLTIP_INTERACTION_WITH_CONTEXT_FORMAT:format(contextString, fullDungeonName); + end + + return contextString; +end + +local InteractionTypeToContextStringGenerator = { + [Enum.RolodexType.None] = GenerateBasicContextString, + [Enum.RolodexType.PartyMember] = GenerateBasicContextString, + [Enum.RolodexType.RaidMember] = GenerateBasicContextString, + [Enum.RolodexType.Trade] = GenerateBasicContextString, + [Enum.RolodexType.Whisper] = GenerateBasicContextString, + [Enum.RolodexType.PublicOrderFilledByOther] = GenerateCraftingOrderContextString, + [Enum.RolodexType.PublicOrderFilledByYou] = GenerateCraftingOrderContextString, + [Enum.RolodexType.PersonalOrderFilledByOther] = GenerateCraftingOrderContextString, + [Enum.RolodexType.PersonalOrderFilledByYou] = GenerateCraftingOrderContextString, + [Enum.RolodexType.GuildOrderFilledByOther] = GenerateCraftingOrderContextString, + [Enum.RolodexType.GuildOrderFilledByYou] = GenerateCraftingOrderContextString, + [Enum.RolodexType.CreatureKill] = GenerateBasicContextString, + [Enum.RolodexType.CompleteDungeon] = GenerateMythicPlusDungeonInteractionContextString, + [Enum.RolodexType.KillRaidBoss] = GenerateRaidInteractionContextString, + [Enum.RolodexType.KillLfrBoss] = GenerateRaidInteractionContextString, + [Enum.RolodexType.CompleteDelve] = GenerateDelveInteractionContextString, + [Enum.RolodexType.CompleteArena] = GenerateBasicContextString, + [Enum.RolodexType.CompleteBg] = GenerateBasicContextString, + [Enum.RolodexType.Duel] = GenerateBasicContextString, + [Enum.RolodexType.PetBattle] = GenerateBasicContextString, + [Enum.RolodexType.PvPKill] = GenerateBasicContextString, +}; + +local function GetContextStringGeneratorForInteractionType(interactionType) + return InteractionTypeToContextStringGenerator[interactionType]; +end + +function RecentAlliesUtil.GenerateContextStringForInteraction(interactionData) + local contextStringGenerator = GetContextStringGeneratorForInteractionType(interactionData.type); + return contextStringGenerator and contextStringGenerator(interactionData) or ""; +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/Blizzard_RecruitAFriend.toc b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/Blizzard_RecruitAFriend.toc new file mode 100644 index 0000000..ab23019 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/Blizzard_RecruitAFriend.toc @@ -0,0 +1,8 @@ +## Title: Blizzard_RecruitAFriend +## Author: Blizzard Entertainment +## DefaultState: enabled +## Dependencies: Blizzard_BNet, Blizzard_FriendsFrame, Blizzard_FrameXMLUtil, Blizzard_TransmogShared +## SuppressLocalTableRef: 1 +## AllowLoad: game +## AllowLoadGameType: mainline +RecruitAFriendFrame.xml \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.lua.annotated.lua new file mode 100644 index 0000000..8a57417 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.lua.annotated.lua @@ -0,0 +1,1530 @@ +local RECRUIT_HEIGHT = 34; +local DIVIDER_HEIGHT = 16; + +RecruitAFriendSystemMixin = {};--- @class RecruitAFriendSystemMixin + +function RecruitAFriendSystemMixin:GetRecruitAFriendFrame() + return RecruitAFriendFrame; +end + +function RecruitAFriendSystemMixin:GetRecruitAFriendRewardsFrame() + return RecruitAFriendRewardsFrame; +end + +RecruitAFriendFrameMixin = CreateFromMixins(CallbackRegistryMixin);--- @class RecruitAFriendFrameMixin : CallbackRegistryMixin + +RecruitAFriendFrameMixin:GenerateCallbackEvents( +{ + "NewRewardTabSelected", + "SelectedRAFVersionChanged", + "RewardsListOpened", + "RewardsListClosed", +}); + +function RecruitAFriendFrameMixin:OnLoad() + self:SetRAFSystemEnabled(C_RecruitAFriend.IsEnabled()); + self:SetRAFRecruitingEnabled(C_RecruitAFriend.IsRecruitingEnabled()); + self:RegisterEvent("RAF_SYSTEM_ENABLED_STATUS"); + self:RegisterEvent("RAF_RECRUITING_ENABLED_STATUS"); + self:RegisterEvent("RAF_SYSTEM_INFO_UPDATED"); + self:RegisterEvent("RAF_INFO_UPDATED"); + self:RegisterEvent("BN_FRIEND_INFO_CHANGED"); + self:RegisterEvent("VARIABLES_LOADED"); + + CallbackRegistryMixin.OnLoad(self); + self:AddDynamicEventMethod(self, RecruitAFriendFrameMixin.Event.NewRewardTabSelected, self.OnNewRewardTabSelected); + self:AddDynamicEventMethod(self, RecruitAFriendFrameMixin.Event.RewardsListOpened, self.OnRewardsListOpened); + self:AddDynamicEventMethod(self, RecruitAFriendFrameMixin.Event.RewardsListClosed, self.OnRewardsListClosed); + + self.RecruitList.NoRecruitsDesc:SetText(RAF_NO_RECRUITS_DESC); + + local view = CreateScrollBoxListLinearView(); + -- SetElementExtentCalculator could be removed if the element initializer is replaced with a factory + -- and the concepts of divider and recruit entry split apart from RecruitListButtonTemplate. + view:SetElementExtentCalculator(function(dataIndex, elementData) + return elementData.isDivider and DIVIDER_HEIGHT or RECRUIT_HEIGHT; + end); + view:SetElementInitializer("RecruitListButtonTemplate", function(button, elementData) + button:Init(elementData); + end); + + ScrollUtil.InitScrollBoxListWithScrollBar(self.RecruitList.ScrollBox, self.RecruitList.ScrollBar, view); + + local rafSystemInfo = C_RecruitAFriend.GetRAFSystemInfo(); + self:UpdateRAFSystemInfo(rafSystemInfo); + + local rafInfo = C_RecruitAFriend.GetRAFInfo(); + self:UpdateRAFInfo(rafInfo); +end + +function RecruitAFriendFrameMixin:OnHide() + RecruitAFriendRewardsFrame:Hide(); + StaticPopupSpecial_Hide(RecruitAFriendRecruitmentFrame); +end + +function RecruitAFriendFrameMixin:OnEvent(event, ...) + if event == "RAF_SYSTEM_ENABLED_STATUS" then + local rafEnabled = ...; + self:SetRAFSystemEnabled(rafEnabled); + if self.rafEnabled then + self:UpdateRAFInfo(C_RecruitAFriend.GetRAFInfo()); + end + elseif event == "RAF_RECRUITING_ENABLED_STATUS" then + local rafRecruitingEnabled = ...; + self:SetRAFRecruitingEnabled(rafRecruitingEnabled); + elseif event == "RAF_SYSTEM_INFO_UPDATED" then + local rafSystemInfo = ...; + self:UpdateRAFSystemInfo(rafSystemInfo); + elseif event == "RAF_INFO_UPDATED" then + local rafInfo = ...; + self:UpdateRAFInfo(rafInfo); + elseif event == "BN_FRIEND_INFO_CHANGED" then + if self.rafInfo then + self:UpdateRecruitList(self.rafInfo.recruits); + end + elseif event == "VARIABLES_LOADED" then + self.varsLoaded = true; + self:UpdateRAFTutorialTips(); + end +end + +local splashFrameTextureKitRegions = { + Watermark = "recruitafriend_%s_iwatermark_big", + Picture = "recruitafriend_%s_splash_picture", +}; +function RecruitAFriendFrameMixin:ShowSplashScreen() + local latestRAFVersion = self:GetLatestRAFVersion(); + local useLegacyArt = RAFUtil.DoesRAFVersionUseLegacyArt(latestRAFVersion); + self.SplashFrame.Background:SetAtlas(useLegacyArt and self.SplashFrame.legacyBackgroundAtlas or self.SplashFrame.backgroundAtlas, TextureKitConstants.UseAtlasSize); + SetupTextureKitOnRegions(RAFUtil.GetTextureKitForRAFVersion(latestRAFVersion), self.SplashFrame, splashFrameTextureKitRegions, TextureKitConstants.SetVisibility, TextureKitConstants.UseAtlasSize); + + self.SplashFrame:Show(); +end + +function RecruitAFriendFrameMixin:SetRAFSystemEnabled(rafEnabled) + self.rafEnabled = rafEnabled; + self:UpdateRAFTutorialTips(); +end + +function RecruitAFriendFrameMixin:UpdateRAFTutorialTips() + local showRewardTutorial = self.varsLoaded and self.rafEnabled and self:ShouldShowRewardTutorial(); + + if showRewardTutorial then + local rewardHelpTipInfo = { + text = RAF_REWARD_TUTORIAL_TEXT, + buttonStyle = HelpTip.ButtonStyle.Close, + targetPoint = HelpTip.Point.RightEdgeCenter, + autoEdgeFlipping = true, + useParentStrata = true, + system = "Chat", + systemPriority = 30, + }; + HelpTip:Show(QuickJoinToastButton, rewardHelpTipInfo); + self.shownRewardTutorial = true; + else + HelpTip:Hide(QuickJoinToastButton, RAF_REWARD_TUTORIAL_TEXT); + end +end + +function RecruitAFriendFrameMixin:SetRAFRecruitingEnabled(rafRecruitingEnabled) + self.RecruitmentButton:SetShown(rafRecruitingEnabled); + + if not rafRecruitingEnabled then + StaticPopupSpecial_Hide(RecruitAFriendRecruitmentFrame); + end + + self.rafRecruitingEnabled = rafRecruitingEnabled; + self:UpdateRAFTutorialTips(); +end + +local maxRecruits = 0; +local maxRecruitMonths = 0; +local maxRecruitLinkUses = 0; +local daysInCycle = 0; + +function RecruitAFriendFrameMixin:UpdateRAFSystemInfo(rafSystemInfo) + if rafSystemInfo then + maxRecruits = rafSystemInfo.maxRecruits; + maxRecruitMonths = rafSystemInfo.maxRecruitMonths; + maxRecruitLinkUses = rafSystemInfo.maxRecruitmentUses; + daysInCycle = rafSystemInfo.daysInCycle; + end +end + +local function SortRecruits(a, b) + if a.isOnline ~= b.isOnline then + return a.isOnline; + else + if a.versionRecruited ~= b.versionRecruited then + return a.versionRecruited > b.versionRecruited; + end + + return a.nameText < b.nameText; + end +end + +local function SortRecruitsByWoWAccount(a, b) + if a.bnetAccountID == b.bnetAccountID then + return a.wowAccountGUID < b.wowAccountGUID; + end +end + +local function ProcessAndSortRecruits(recruits) + local seenAccounts = {}; + + -- First, sort recruits that share a bnetAccountID by wowAccountGUID (so they are in a consistent order) + table.sort(recruits, SortRecruitsByWoWAccount); + + local haveOnlineFriends = false; + local haveOfflineFriends = false; + + -- Get account info for all recruits + for _, recruitInfo in ipairs(recruits) do + local accountInfo = C_BattleNet.GetAccountInfoByID(recruitInfo.bnetAccountID, recruitInfo.wowAccountGUID); + + if accountInfo and accountInfo.gameAccountInfo and not accountInfo.gameAccountInfo.isWowMobile then + recruitInfo.isOnline = accountInfo.gameAccountInfo.isOnline; + recruitInfo.characterName = accountInfo.gameAccountInfo.characterName; + recruitInfo.nameText, recruitInfo.nameColor = FriendsFrame_GetBNetAccountNameAndStatus(accountInfo); + recruitInfo.plainName = BNet_GetBNetAccountName(accountInfo); + else + -- We have no presence info for them yet...we will get an update when we do + recruitInfo.isOnline = false; + recruitInfo.nameText = BNet_GetTruncatedBattleTag(recruitInfo.battleTag); + recruitInfo.plainName = recruitInfo.nameText; + recruitInfo.nameColor = FRIENDS_GRAY_COLOR; + end + + if recruitInfo.nameText == "" and RAF_PENDING_RECRUIT then + recruitInfo.nameText = RAF_PENDING_RECRUIT; + recruitInfo.plainName = RAF_PENDING_RECRUIT; + end + + recruitInfo.accountInfo = accountInfo; + + if not seenAccounts[recruitInfo.bnetAccountID] then + seenAccounts[recruitInfo.bnetAccountID] = 1; + else + seenAccounts[recruitInfo.bnetAccountID] = seenAccounts[recruitInfo.bnetAccountID] + 1; + end + + -- Set an index so we can append it to the name if needed + recruitInfo.recruitIndex = seenAccounts[recruitInfo.bnetAccountID]; + + if recruitInfo.isOnline then + haveOnlineFriends = true; + else + haveOfflineFriends = true; + end + end + + -- Now that we have seen all recruits, loop through again and append the recruitIndex to any recruits that share a bnetAccountID and are not online + for _, recruitInfo in ipairs(recruits) do + if seenAccounts[recruitInfo.bnetAccountID] > 1 and not recruitInfo.characterName then + recruitInfo.nameText = RAF_RECRUIT_NAME_MULTIPLE:format(recruitInfo.nameText, recruitInfo.recruitIndex); + end + end + + -- And then sort them by online status, RAF version, and name + table.sort(recruits, SortRecruits); + + return haveOnlineFriends and haveOfflineFriends; +end + +function RecruitAFriendFrameMixin:UpdateRecruitList(recruits) + local numRecruits = #recruits; + + self.RecruitList.NoRecruitsDesc:SetShown(numRecruits == 0); + self.RecruitList.Header.Count:SetText(RAF_RECRUITED_FRIENDS_COUNT:format(numRecruits, maxRecruits)); + + local needDivider = ProcessAndSortRecruits(recruits); + local dataProvider = CreateDataProvider(); + for index = 1, numRecruits do + local recruit = recruits[index]; + if needDivider and not recruit.isOnline then + dataProvider:Insert({isDivider=true}); + needDivider = false; + end + dataProvider:Insert(recruit); + end + + self.RecruitList.ScrollBox:SetDataProvider(dataProvider, ScrollBoxConstants.RetainScrollPosition); +end + +function RecruitAFriendFrameMixin:SetNextRewardName(rewardName, count, rewardType) + if count > 1 then + self.RewardClaiming.NextRewardName:SetText(RAF_REWARD_NAME_MULTIPLE:format(rewardName, count)); + else + self.RewardClaiming.NextRewardName:SetText(rewardName); + end + self.RewardClaiming.NextRewardName:Show(); + + if rewardType == Enum.RafRewardType.GameTime then + self.RewardClaiming.NextRewardName:SetTextColor(HEIRLOOM_BLUE_COLOR:GetRGBA()); + else + self.RewardClaiming.NextRewardName:SetTextColor(EPIC_PURPLE_COLOR:GetRGBA()); + end +end + +function RecruitAFriendFrameMixin:OnUnwrapFlashBegun() + if self.pendingNextReward then + self:UpdateNextReward(self.pendingNextReward); + end +end + +local rewardClaimTextureKitRegions = { + Watermark = "recruitafriend_%s_watermark_medium", +}; +function RecruitAFriendFrameMixin:UpdateNextReward(nextReward) + if self.RewardClaiming.NextRewardButton:WaitingForFlash() then + -- The next reward button is animating, cache off the next reward and call again when we are done + self.pendingNextReward = nextReward; + return; + else + self.pendingNextReward = nil; + end + + self.RewardClaiming.Background:SetAtlas(RAFUtil.DoesRAFVersionUseLegacyArt(nextReward.rafVersion) and self.RewardClaiming.legacyBackgroundAtlas or self.RewardClaiming.backgroundAtlas, TextureKitConstants.UseAtlasSize); + SetupTextureKitOnRegions(RAFUtil.GetTextureKitForRAFVersion(nextReward.rafVersion), self.RewardClaiming, rewardClaimTextureKitRegions, TextureKitConstants.SetVisibility, TextureKitConstants.UseAtlasSize); + self.RewardClaiming.ClaimOrViewRewardButton:Update(nextReward, self.claimInProgress); + + if not nextReward then + self.RewardClaiming.EarnInfo:Hide(); + self.RewardClaiming.NextRewardButton:Hide(); + self.RewardClaiming.NextRewardName:Hide(); + return; + end + + if nextReward.canClaim then + self.RewardClaiming.EarnInfo:SetText(RAF_YOU_HAVE_EARNED); + elseif nextReward.monthCost > 1 then + self.RewardClaiming.EarnInfo:SetText(RAF_NEXT_REWARD_AFTER:format(nextReward.monthCost - nextReward.availableInMonths, nextReward.monthCost)); + elseif nextReward.monthsRequired == 0 then + self.RewardClaiming.EarnInfo:SetText(RAF_FIRST_REWARD); + else + self.RewardClaiming.EarnInfo:SetText(RAF_NEXT_REWARD); + end + + local rightAlignedTooltip = true; + self.RewardClaiming.NextRewardButton:Setup(nextReward, rightAlignedTooltip); + + if nextReward.petInfo then + self:SetNextRewardName(nextReward.petInfo.speciesName, nextReward.repeatableClaimCount, nextReward.rewardType); + elseif nextReward.mountInfo then + local name = C_MountJournal.GetMountInfoByID(nextReward.mountInfo.mountID); + self:SetNextRewardName(name, nextReward.repeatableClaimCount, nextReward.rewardType); + elseif nextReward.appearanceInfo or nextReward.appearanceSetInfo or nextReward.illusionInfo then + self.RewardClaiming.NextRewardButton.item:ContinueOnItemLoad(function() + self:SetNextRewardName(self.RewardClaiming.NextRewardButton.item:GetItemName(), nextReward.repeatableClaimCount, nextReward.rewardType); + end); + elseif nextReward.titleInfo then + local titleName = TitleUtil.GetNameFromTitleMaskID(nextReward.titleInfo.titleMaskID); + if titleName then + self:SetNextRewardName(RAF_REWARD_TITLE:format(titleName), nextReward.repeatableClaimCount, nextReward.rewardType); + end + else + self:SetNextRewardName(RAF_BENEFIT4, nextReward.repeatableClaimCount, nextReward.rewardType); + end + + self.RewardClaiming.EarnInfo:Show(); +end + +function RecruitAFriendFrameMixin:UpdateRAFInfo(rafInfo) + if self.rafEnabled and rafInfo and #rafInfo.versions > 0 then + self.rafInfo = rafInfo; + + local latestRAFVersionInfo = self:GetLatestRAFVersionInfo(); + if not self:GetSelectedRAFVersionInfo() then + self:SetSelectedRAFVersion(latestRAFVersionInfo.rafVersion); + end + + self:UpdateRecruitList(rafInfo.recruits); + + if (latestRAFVersionInfo.numRecruits == 0) and (latestRAFVersionInfo.monthCount.lifetimeMonths == 0) then + self.RewardClaiming.MonthCount:SetText(RAF_FIRST_MONTH); + else + self.RewardClaiming.MonthCount:SetText(RAF_MONTHS_EARNED:format(latestRAFVersionInfo.monthCount.lifetimeMonths)); + end + + self.claimInProgress = rafInfo.claimInProgress; + if latestRAFVersionInfo.nextReward then + self:UpdateNextReward(latestRAFVersionInfo.nextReward); + end + + RecruitAFriendRewardsFrame:SetUpTabs(rafInfo); + RecruitAFriendRewardsFrame:Refresh(); + + local recruitsAreMaxed = (#rafInfo.recruits >= maxRecruits); + RecruitAFriendRecruitmentFrame:UpdateRecruitmentInfo(rafInfo.recruitmentInfo, recruitsAreMaxed); + end + + self:UpdateRAFTutorialTips(); +end + +function RecruitAFriendFrameMixin:GetRAFInfo() + return self.rafInfo; +end + +function RecruitAFriendFrameMixin:OnRewardsListOpened() + self:SetSelectedRAFVersion(self:GetLatestRAFVersion()); + self.RewardClaiming.ClaimOrViewRewardButton:UpdateUnclaimedRewardsAnim(); +end + +function RecruitAFriendFrameMixin:OnRewardsListClosed() + self.RewardClaiming.ClaimOrViewRewardButton:UpdateUnclaimedRewardsAnim(); +end + +function RecruitAFriendFrameMixin:OnNewRewardTabSelected(tabRAFVersion) + self:SetSelectedRAFVersion(tabRAFVersion); +end + +function RecruitAFriendFrameMixin:SetSelectedRAFVersion(rafVersion) + if self.selectedRAFVersion == rafVersion then + return; + end + + self.selectedRAFVersion = rafVersion; + self:TriggerEvent(RecruitAFriendFrameMixin.Event.SelectedRAFVersionChanged); + RecruitAFriendRewardsFrame.ClaimLegacyRewardsButton:SetAutoClaimRewardsEnabled(false); + RecruitAFriendRewardsFrame:Refresh(); +end + +function RecruitAFriendFrameMixin:GetSelectedRAFVersion() + return self.selectedRAFVersion; +end + +function RecruitAFriendFrameMixin:GetRAFVersionInfo(rafVersion) + for index, versionInfo in ipairs(self.rafInfo.versions) do + if versionInfo.rafVersion == rafVersion then + return versionInfo; + end + end +end + +function RecruitAFriendFrameMixin:GetSelectedRAFVersionInfo() + return self:GetRAFVersionInfo(self.selectedRAFVersion); +end + +function RecruitAFriendFrameMixin:GetLatestRAFVersion() + return self.rafInfo.versions[1].rafVersion; +end + +function RecruitAFriendFrameMixin:GetLatestRAFVersionInfo() + return self.rafInfo.versions[1]; +end + +function RecruitAFriendFrameMixin:IsLegacyRAFVersion(rafVersion) + return rafVersion ~= self:GetLatestRAFVersion(); +end + +function RecruitAFriendFrameMixin:AreAnyRewardsAffordable() + for index, versionInfo in ipairs(self.rafInfo.versions) do + if versionInfo.numAffordableRewards > 0 then + return true; + end + end + + return false; +end + +function RecruitAFriendFrameMixin:HasActivityRewardToClaim() + if self.rafInfo then + for _, recruitInfo in ipairs(self.rafInfo.recruits) do + for _, activityInfo in ipairs(recruitInfo.activities) do + if activityInfo.state == Enum.RafRecruitActivityState.Complete then + return true; + end + end + end + end +end + +function RecruitAFriendFrameMixin:ShouldShowRewardTutorial() + local hasRafRewardToClaim = self.rafInfo and (#self.rafInfo.versions > 0) and self:AreAnyRewardsAffordable(); + return not self:IsShown() and not self.shownRewardTutorial and (hasRafRewardToClaim or self:HasActivityRewardToClaim()); +end + +RecruitActivityButtonMixin = {};--- @class RecruitActivityButtonMixin + +function RecruitActivityButtonMixin:OnLoad() + self.ClaimGlowSpinAnim:Play(); -- Just leave this playing +end + +function RecruitActivityButtonMixin:OnHide() + self.Model:Hide(); +end + +function RecruitActivityButtonMixin:UpdateQuestName() + if not self.questName and self.activityInfo then + -- If we don't have the name now, get it. If it's not in the quest cache this will request it + self.questName = C_QuestLog.GetTitleForQuestID(self.activityInfo.rewardQuestID); + end +end + +function RecruitActivityButtonMixin:OnEnter() + self:GetParent():EnableDrawLayer("HIGHLIGHT"); + + EmbeddedItemTooltip:SetOwner(self, "ANCHOR_RIGHT"); + + local wrap = true; + + self:UpdateQuestName(); + self:UpdateIcon(); + + if not self.questName then + GameTooltip_SetTitle(EmbeddedItemTooltip, RETRIEVING_DATA, RED_FONT_COLOR); + GameTooltip_SetTooltipWaitingForData(EmbeddedItemTooltip, true); + self.UpdateTooltip = self.OnEnter; + else + GameTooltip_SetTitle(EmbeddedItemTooltip, self.questName, nil, wrap); + + EmbeddedItemTooltip:SetMinimumWidth(300); + GameTooltip_AddNormalLine(EmbeddedItemTooltip, RAF_RECRUIT_ACTIVITY_DESCRIPTION:format(self.recruitInfo.nameText), true); + + local reqTextLines = C_RecruitAFriend.GetRecruitActivityRequirementsText(self.activityInfo.activityID, self.recruitInfo.acceptanceID); + for i = 1, #reqTextLines do + local reqText = reqTextLines[i]; + GameTooltip_AddColoredLine(EmbeddedItemTooltip, reqText, HIGHLIGHT_FONT_COLOR, wrap); + end + + GameTooltip_AddBlankLineToTooltip(EmbeddedItemTooltip); + + if self.activityInfo.state == Enum.RafRecruitActivityState.Incomplete then + GameTooltip_AddNormalLine(EmbeddedItemTooltip, QUEST_REWARDS, wrap); + else + GameTooltip_AddNormalLine(EmbeddedItemTooltip, YOU_EARNED_LABEL, wrap); + end + + GameTooltip_AddQuestRewardsToTooltip(EmbeddedItemTooltip, self.activityInfo.rewardQuestID, TOOLTIP_QUEST_REWARDS_STYLE_NONE); + + if self.activityInfo.state == Enum.RafRecruitActivityState.Complete then + GameTooltip_AddBlankLineToTooltip(EmbeddedItemTooltip); + GameTooltip_AddInstructionLine(EmbeddedItemTooltip, CLICK_CHEST_TO_CLAIM_REWARD, wrap); + end + + GameTooltip_SetTooltipWaitingForData(EmbeddedItemTooltip, false); + self.UpdateTooltip = nil; + end + + EmbeddedItemTooltip:Show(); +end + +function RecruitActivityButtonMixin:OnLeave() + self:GetParent():DisableDrawLayer("HIGHLIGHT"); + EmbeddedItemTooltip:Hide(); + self.UpdateTooltip = nil; + self:UpdateIcon(); +end + +function RecruitActivityButtonMixin:PlayClaimRewardFanfare() + self.ModelFadeOutAnim:Stop(); + self.Model:SetAlpha(1); + + -- Intentionaly hiding here before showing because we rely on the OnShow to set the model and kick off the animation, etc. + self.Model:Hide(); + self.Model:Show(); -- This sets the model, which in turn starts the exploding animation, etc. +end + +function RecruitActivityButtonMixin:OnClick() + if self.activityInfo.state == Enum.RafRecruitActivityState.Complete then + if C_RecruitAFriend.ClaimActivityReward(self.activityInfo.activityID, self.recruitInfo.acceptanceID) then + self:PlayClaimRewardFanfare(); + PlaySound(SOUNDKIT.RAF_RECRUIT_REWARD_CLAIM); + + C_Timer.After(0.3, function() + self.activityInfo.state = Enum.RafRecruitActivityState.RewardClaimed; + self:Refresh(); + end) + end + end +end + +function RecruitActivityButtonMixin:UpdateIcon() + local useAtlasSize = true; + if self:IsMouseOver() then + if self.activityInfo.state == Enum.RafRecruitActivityState.RewardClaimed then + self.Icon:SetAtlas("RecruitAFriend_RecruitedFriends_CursorOverChecked", useAtlasSize); + else + self.Icon:SetAtlas("RecruitAFriend_RecruitedFriends_CursorOver", useAtlasSize); + end + else + if self.activityInfo.state == Enum.RafRecruitActivityState.Incomplete then + self.Icon:SetAtlas("RecruitAFriend_RecruitedFriends_ActiveChest", useAtlasSize); + elseif self.activityInfo.state == Enum.RafRecruitActivityState.Complete then + self.Icon:SetAtlas("RecruitAFriend_RecruitedFriends_OpenChest", useAtlasSize); + else + self.Icon:SetAtlas("RecruitAFriend_RecruitedFriends_ClaimedChest", useAtlasSize); + end + end +end + +function RecruitActivityButtonMixin:Setup(activityInfo, recruitInfo) + self.activityInfo = activityInfo; + self.recruitInfo = recruitInfo; + + if not activityInfo then + self:Hide(); + return; + end + + self:UpdateQuestName(); + self:UpdateIcon(); + + local canClaim = (activityInfo.state == Enum.RafRecruitActivityState.Complete); + if self.lastCanClaim == nil then + if canClaim then + self.ClaimGlow:SetAlpha(0.8); + self.ClaimGlowSpin:SetAlpha(0.3); + end + else + if canClaim ~= self.lastCanClaim then + if canClaim then + self.ClaimGlowOutAnim:Stop(); + self.ClaimGlowInAnim:Play(); + else + self.ClaimGlowInAnim:Stop(); + self.ClaimGlowOutAnim:Play(); + end + end + end + + self.lastCanClaim = canClaim; +end + +function RecruitActivityButtonMixin:Refresh() + self:Setup(self.activityInfo, self.recruitInfo); +end + +RecruitActivityButtonModelMixin = {};--- @class RecruitActivityButtonModelMixin + +function RecruitActivityButtonModelMixin:OnLoad() + self.parentButton = self:GetParent(); + self:SetParent(RecruitAFriendFrame); + self:SetFrameLevel(self.parentButton:GetFrameLevel() + 1); +end + +function RecruitActivityButtonModelMixin:OnShow() + self:SetModel(1601381); --7FX_ARGUS_LIGHTFORGED_SIEGEWEAPON_IMPACT_HOLY.m2 +end + +function RecruitActivityButtonModelMixin:OnHide() + self:ClearModel(); +end + +function RecruitActivityButtonModelMixin:OnModelLoaded() + self:MakeCurrentCameraCustom(); + self:SetCameraPosition(0, 0, -25); +end + +function RecruitActivityButtonModelMixin:OnAnimStarted() + self.parentButton.ModelFadeOutAnim:Play(); -- Start a slight alpha fade so the explosion isn't as extreme +end + +function RecruitActivityButtonModelMixin:OnAnimFinished() + self:Hide(); -- Only play the animation once +end + +RecruitListButtonMixin = {};--- @class RecruitListButtonMixin + +function RecruitListButtonMixin:Init(elementData) + if elementData.isDivider then + self:SetupDivider(); + else + self:SetupRecruit(elementData); + end +end + +function RecruitListButtonMixin:OnEnter() + if self.recruitInfo then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + + GameTooltip_SetTitle(GameTooltip, self.recruitInfo.nameText, self.recruitInfo.nameColor); + + local wrap = true; + GameTooltip_AddNormalLine(GameTooltip, RAF_RECRUIT_TOOLTIP_DESC:format(maxRecruitMonths), wrap); + GameTooltip_AddBlankLineToTooltip(GameTooltip); + + local usedMonths = math.max(maxRecruitMonths - self.recruitInfo.monthsRemaining, 0); + GameTooltip_AddColoredLine(GameTooltip, RAF_RECRUIT_TOOLTIP_MONTH_COUNT:format(usedMonths, maxRecruitMonths), HIGHLIGHT_FONT_COLOR, wrap); + GameTooltip:Show(); + end +end + +function RecruitListButtonMixin:OnLeave() + GameTooltip_Hide(); +end + +function RecruitListButtonMixin:OnClick(button) + if button == "RightButton" then + local recruitInfo = self.recruitInfo; + if not recruitInfo then + return; + end + + local contextData = { + name = recruitInfo.plainName, + bnetIDAccount = recruitInfo.bnetAccountID, + wowAccountGUID = recruitInfo.wowAccountGUID, + isRafRecruit = true, + } + + local accountInfo = recruitInfo.accountInfo; + if accountInfo then + contextData.guid = accountInfo.gameAccountInfo.playerGuid; + end + + UnitPopup_OpenMenu("RAF_RECRUIT", contextData); + end +end + +function RecruitListButtonMixin:MakeDivider(isDivider) + self.DividerTexture:SetShown(isDivider); + self.Background:SetShown(not isDivider); + self.Name:SetShown(not isDivider); + self.InfoText:SetShown(not isDivider); + self.Icon:SetShown(not isDivider); + + for i = 1, #self.Activities do + self.Activities[i]:SetShown(not isDivider); + end + + if isDivider then + self:SetHeight(DIVIDER_HEIGHT); + self:Disable(); + else + self:SetHeight(RECRUIT_HEIGHT); + self:Enable(); + end +end + +function RecruitListButtonMixin:SetupDivider() + self:MakeDivider(true); + self.recruitInfo = nil; + self:Show(); +end + +function RecruitListButtonMixin:UpdateActivities(recruitInfo) + for i = 1, #self.Activities do + local activityInfo = recruitInfo.activities[i]; + self.Activities[i]:Setup(activityInfo, recruitInfo); + end +end + +local recruitListButtonTextureKitRegions = { + Icon = "recruitafriend_friendslist_%s_icon", +}; +function RecruitListButtonMixin:SetupRecruit(recruitInfo) + self:MakeDivider(false); + + self.recruitInfo = recruitInfo; + + self.Name:SetText(recruitInfo.nameText); + self.Name:SetTextColor(recruitInfo.nameColor:GetRGB()); + + local versionRecruited = self.recruitInfo.versionRecruited; + SetupTextureKitOnRegions(RAFUtil.GetTextureKitForRAFVersion(versionRecruited), self, recruitListButtonTextureKitRegions, TextureKitConstants.SetVisibility, TextureKitConstants.UseAtlasSize); + if recruitInfo.isOnline then + self.Background:SetColorTexture(RAFUtil.GetColorForRAFVersion(versionRecruited):GetRGBA()); + if recruitInfo.subStatus == Enum.RafRecruitSubStatus.Active then + self.InfoText:SetText(RAF_ACTIVE_RECRUIT); + self.InfoText:SetTextColor(GREEN_FONT_COLOR:GetRGB()); + elseif recruitInfo.subStatus == Enum.RafRecruitSubStatus.Trial then + self.InfoText:SetText(RAF_TRIAL_RECRUIT); + self.InfoText:SetTextColor(NORMAL_FONT_COLOR:GetRGB()); + else + self.InfoText:SetText(RAF_INACTIVE_RECRUIT); + self.InfoText:SetTextColor(GRAY_FONT_COLOR:GetRGB()); + end + else + self.Background:SetColorTexture(FRIENDS_OFFLINE_BACKGROUND_COLOR:GetRGBA()); + self.InfoText:SetTextColor(GRAY_FONT_COLOR:GetRGB()); + + if recruitInfo.subStatus == Enum.RafRecruitSubStatus.Inactive then + self.InfoText:SetText(RAF_INACTIVE_RECRUIT); + else + self.InfoText:SetText(FriendsFrame_GetLastOnlineText(recruitInfo.accountInfo)); + end + end + + local mouseOnMe = (GameTooltip:GetOwner() == self); + if mouseOnMe then + self:OnEnter(); + end + + self:UpdateActivities(recruitInfo); + + self:Show(); +end + +RecruitAFriendNextRewardInfoButtonMixin = CreateFromMixins(RecruitAFriendSystemMixin);--- @class RecruitAFriendNextRewardInfoButtonMixin : RecruitAFriendSystemMixin + +function RecruitAFriendNextRewardInfoButtonMixin:OnEnter() + local xOffset, yOffset = 0, 40; + GameTooltip:SetOwner(self, "ANCHOR_BOTTOMRIGHT", xOffset, yOffset); + GameTooltip_AddNormalLine(GameTooltip, RAF_NEXT_REWARD_HELP_TEXT); + GameTooltip:Show(); +end + +function RecruitAFriendNextRewardInfoButtonMixin:OnLeave() + GameTooltip_Hide(); +end + +RecruitAFriendVersionInfoButtonMixin = CreateFromMixins(RecruitAFriendSystemMixin);--- @class RecruitAFriendVersionInfoButtonMixin : RecruitAFriendSystemMixin + +function RecruitAFriendVersionInfoButtonMixin:OnEnter() + local recruitAFriendFrame = self:GetRecruitAFriendFrame(); + local selectedVersionInfo = recruitAFriendFrame:GetSelectedRAFVersionInfo(); + + local xOffset, yOffset = -5, -46; + GameTooltip:SetOwner(self, "ANCHOR_RIGHT", xOffset, yOffset); + local helpText = recruitAFriendFrame:IsLegacyRAFVersion(selectedVersionInfo.rafVersion) and RAF_LEGACY_REWARDS_HELP_TEXT or RAF_LATEST_REWARDS_HELP_TEXT; + GameTooltip_AddNormalLine(GameTooltip, helpText:format(selectedVersionInfo.numRecruits, selectedVersionInfo.numAffordableRewards)); + GameTooltip:Show(); +end + +function RecruitAFriendVersionInfoButtonMixin:OnLeave() + GameTooltip_Hide(); +end + +RecruitAFriendClaimRewardButtonBaseMixin = CreateFromMixins(RecruitAFriendSystemMixin);--- @class RecruitAFriendClaimRewardButtonBaseMixin : RecruitAFriendSystemMixin + +function RecruitAFriendClaimRewardButtonBaseMixin:OnEnter() + if not self:IsEnabled() then + local wrap = true; + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_SetTitle(GameTooltip, BLIZZARD_STORE_PROCESSING, RED_FONT_COLOR, wrap); + self.disabledTooltipShowing = true; + GameTooltip:Show(); + end +end + +function RecruitAFriendClaimRewardButtonBaseMixin:HideDisabledTooltip() + GameTooltip_Hide(); + self.disabledTooltipShowing = false; +end + +function RecruitAFriendClaimRewardButtonBaseMixin:OnLeave() + self:HideDisabledTooltip(); +end + +function RecruitAFriendClaimRewardButtonBaseMixin:OnHide() + self:HideDisabledTooltip(); +end + +local RecruitAFriendClaimLegacyRewardsButtonEvents = { + "RAF_REWARD_CLAIM_FAILED", +}; + +-- Global function for call from token claim dialog +function RecruitAFriend_TryCancelAutoClaim() + RecruitAFriendRewardsFrame.ClaimLegacyRewardsButton:SetAutoClaimRewardsEnabled(false); + RecruitAFriendRewardsFrame.ClaimLegacyRewardsButton:UpdateUnclaimedRewardsAnim(); +end + +RecruitAFriendClaimLegacyRewardsButtonMixin = {};--- @class RecruitAFriendClaimLegacyRewardsButtonMixin + +function RecruitAFriendClaimLegacyRewardsButtonMixin:OnEvent(event, ...) + if event == "RAF_REWARD_CLAIM_FAILED" then + self:SetAutoClaimRewardsEnabled(false); + self:UpdateUnclaimedRewardsAnim(); + end +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:OnLoad() + FrameUtil.RegisterFrameForEvents(self, RecruitAFriendClaimLegacyRewardsButtonEvents); +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:OnClick() + if self.haveUnclaimedReward then + if self:GetRecruitAFriendFrame().RewardClaiming.NextRewardButton:IsUnwrapAnimating() then + return; + end + + self.autoClaimRewards = true; + self:ClaimNextReward(); + end +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:Update(selectedRAFVersionInfo) + self.nextReward = selectedRAFVersionInfo.nextReward; + self.haveUnclaimedReward = self.nextReward and self.nextReward.canClaim; + self.numAffordableRewards = selectedRAFVersionInfo.numAffordableRewards; + + local isShown = self.haveUnclaimedReward; + + self:SetShown(isShown); + if self.autoClaimRewards and self.numAffordableRewards <= 0 then + self.autoClaimRewards = false; + end + self:UpdateButtonEnabledState(); + self:UpdateUnclaimedRewardsAnim(); + + self:SetText(self.numAffordableRewards == 1 and CLAIM_REWARD or RAF_CLAIM_MULTIPLE_REWARDS:format(self.numAffordableRewards)); + if isShown and self:IsMouseOver() and not self:IsEnabled() and not self.disabledTooltipShowing then + self:OnEnter(); + elseif not isShown or self:IsEnabled() and self.disabledTooltipShowing then + self:HideDisabledTooltip(); + end + + if self.autoClaimRewards and self.haveUnclaimedReward and not self:GetRecruitAFriendFrame().claimInProgress then + C_Timer.After(1.75, function() + if self.autoClaimRewards then + self:ClaimNextReward(); + end + end); + end +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:UpdateButtonEnabledState() + self:SetEnabled(not self.autoClaimRewards and self.haveUnclaimedReward and not self:GetRecruitAFriendFrame().claimInProgress); +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:UpdateUnclaimedRewardsAnim() + if self.numAffordableRewards <= 0 or self:GetRecruitAFriendFrame().claimInProgress then + self.UnclaimedRewardsAnim:Stop(); + return; + end + + self.UnclaimedRewardsAnim:SetPlaying(self:IsEnabled() and self.numAffordableRewards > 0); +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:SetAutoClaimRewardsEnabled(enabled) + self.autoClaimRewards = enabled; + self:UpdateButtonEnabledState(); +end + +function RecruitAFriendClaimLegacyRewardsButtonMixin:ClaimNextReward() + if self.nextReward.rewardType == Enum.RafRewardType.GameTime then + PlaySound(SOUNDKIT.IG_MAINMENU_OPEN); + WowTokenRedemptionFrame_ShowDialog("RAF_GAME_TIME_REDEEM_CONFIRMATION_SUB", self.nextReward.rafVersion); + else + self.autoClaimRewards = C_RecruitAFriend.ClaimNextReward(self.nextReward.rafVersion); + end +end + +RecruitAFriendClaimOrViewRewardButtonMixin = {};--- @class RecruitAFriendClaimOrViewRewardButtonMixin + +function RecruitAFriendClaimOrViewRewardButtonMixin:OnLoad() + self:SetEnabled(false); +end + +function RecruitAFriendClaimOrViewRewardButtonMixin:OnClick() + if self.haveUnclaimedReward then + if RecruitAFriendFrame.RewardClaiming.NextRewardButton:IsUnwrapAnimating() then + return; + end + + if self.nextReward.rewardType == Enum.RafRewardType.GameTime then + PlaySound(SOUNDKIT.IG_MAINMENU_OPEN); + WowTokenRedemptionFrame_ShowDialog("RAF_GAME_TIME_REDEEM_CONFIRMATION_SUB", self.nextReward.rafVersion); + elseif C_RecruitAFriend.ClaimNextReward() then + RecruitAFriendFrame.RewardClaiming.NextRewardButton:PlayClaimRewardFanfare(); + end + else + if RecruitAFriendRewardsFrame:IsShown() then + RecruitAFriendRewardsFrame:Hide(); + else + RecruitAFriendRewardsFrame:Show(); + StaticPopupSpecial_Hide(RecruitAFriendRecruitmentFrame); + end + end +end + +function RecruitAFriendClaimOrViewRewardButtonMixin:Update(nextReward, claimInProgress) + self.nextReward = nextReward; + self.haveUnclaimedReward = nextReward and nextReward.canClaim; + + if self.haveUnclaimedReward then + self:SetEnabled(not claimInProgress); + self:SetText(CLAIM_REWARD); + RecruitAFriendRewardsFrame:Hide(); + else + self:SetEnabled(true); + self:SetText(RAF_VIEW_ALL_REWARDS); + end + + self:UpdateUnclaimedRewardsAnim(); + + if self:IsMouseOver() and not self:IsEnabled() and not self.disabledTooltipShowing then + self:OnEnter(); + elseif self:IsEnabled() and self.disabledTooltipShowing then + self:HideDisabledTooltip(); + end +end + +function RecruitAFriendClaimOrViewRewardButtonMixin:UpdateUnclaimedRewardsAnim() + if not self:IsEnabled() then + self.UnclaimedRewardsAnim:Stop(); + return; + end + + local recruitAFriendFrame = self:GetRecruitAFriendFrame(); + local claimInProgress = recruitAFriendFrame.claimInProgress; + local rewardsListOpen = self:GetRecruitAFriendRewardsFrame():IsShown(); + if claimInProgress or rewardsListOpen then + self.UnclaimedRewardsAnim:Stop(); + return; + end + + self.UnclaimedRewardsAnim:SetPlaying(recruitAFriendFrame:AreAnyRewardsAffordable()); +end + +RecruitAFriendRewardsFrameMixin = CreateFromMixins(RecruitAFriendSystemMixin);--- @class RecruitAFriendRewardsFrameMixin : RecruitAFriendSystemMixin + +function RecruitAFriendRewardsFrameMixin:OnLoad() + self.rewardPool = CreateFramePool("FRAME", self, "RecruitAFriendRewardTemplate"); + self.rewardTabPool = CreateFramePool("CHECKBUTTON", self, "RecruitAFriendRewardTabTemplate"); +end + +function RecruitAFriendRewardsFrameMixin:OnShow() + self:GetRecruitAFriendFrame():TriggerEvent(RecruitAFriendFrameMixin.Event.RewardsListOpened); + + PlaySound(SOUNDKIT.IG_MAINMENU_OPEN); + HideUIPanel(DressUpFrame); +end + +function RecruitAFriendRewardsFrameMixin:OnHide() + self:GetRecruitAFriendFrame():TriggerEvent(RecruitAFriendFrameMixin.Event.RewardsListClosed); + + PlaySound(SOUNDKIT.IG_MAINMENU_CLOSE); + CloseSideDressUpFrame(self); + self.ClaimLegacyRewardsButton:SetAutoClaimRewardsEnabled(false); +end + +local rewardsFrameTextureKitRegions = { + Watermark = "recruitafriend_%s_iwatermark_big", +}; +function RecruitAFriendRewardsFrameMixin:UpdateBackground() + local selectedRAFVersion = self:GetRecruitAFriendFrame():GetSelectedRAFVersion(); + self.Background:SetAtlas(RAFUtil.DoesRAFVersionUseLegacyArt(selectedRAFVersion) and self.legacyBackgroundAtlas or self.backgroundAtlas, TextureKitConstants.UseAtlasSize); + SetupTextureKitOnRegions(RAFUtil.GetTextureKitForRAFVersion(selectedRAFVersion), self, rewardsFrameTextureKitRegions, TextureKitConstants.SetVisibility, TextureKitConstants.UseAtlasSize); +end + +function RecruitAFriendRewardsFrameMixin:UpdateDescription(selectedRAFVersionInfo) + self.Description:SetText((selectedRAFVersionInfo.rafVersion == self:GetRecruitAFriendFrame():GetLatestRAFVersion()) and RAF_REWARDS_DESC or RAF_LEGACY_REWARDS_DESC); +end + +function RecruitAFriendRewardsFrameMixin:SetUpTabs(rafInfo) + self.rewardTabPool:ReleaseAll(); + + local needTabs = #rafInfo.versions > 1; + if not needTabs then + return; + end + + local lastRewardTab; + for index, versionInfo in ipairs(rafInfo.versions) do + local rewardTab = self.rewardTabPool:Acquire(); + + if lastRewardTab == nil then + rewardTab:SetPoint("TOPLEFT", self, "TOPRIGHT", -3, -35); + else + rewardTab:SetPoint("TOPLEFT", lastRewardTab, "BOTTOMLEFT", 0, -17); + end + + rewardTab:Setup(versionInfo.rafVersion); + lastRewardTab = rewardTab; + end +end + +function RecruitAFriendRewardsFrameMixin:UpdateRewards(rewards) + self.rewardPool:ReleaseAll(); + + if not rewards then + return; + end + + local lastRewardFrame; + for index, rewardInfo in ipairs(rewards) do + if index > 13 then + return; + end + + local leftColumnStartIndex = 1; + local rightColumnStartIndex = leftColumnStartIndex + (#rewards - 1) / 2; + local finalRewardIndex = #rewards; + local rewardFrame = self.rewardPool:Acquire(); + if index == leftColumnStartIndex then + rewardFrame:SetPoint("TOPLEFT", self.Background, "TOPLEFT", 69, -98); + elseif index == rightColumnStartIndex then + rewardFrame:SetPoint("TOPLEFT", self.Background, "TOPLEFT", 209, -98); + elseif index == finalRewardIndex then + rewardFrame:SetPoint("BOTTOM", self.Background, "BOTTOM", 0, 44); + else + rewardFrame:SetPoint("TOPLEFT", lastRewardFrame, "BOTTOMLEFT", 0, -9); + end + + local tooltipRightAligned = (index >= rightColumnStartIndex and index < finalRewardIndex); + rewardFrame:Setup(rewardInfo, tooltipRightAligned); + lastRewardFrame = rewardFrame; + end +end + +function RecruitAFriendRewardsFrameMixin:Refresh() + local recruitAFriendFrame = self:GetRecruitAFriendFrame(); + local selectedRAFVersionInfo = recruitAFriendFrame:GetSelectedRAFVersionInfo(); + + local isUsingDressUp = SideDressUpFrame:IsShown() and SideDressUpFrame:GetParent() == self; + CloseSideDressUpFrame(self); + + self:UpdateBackground(); + self:UpdateDescription(selectedRAFVersionInfo); + self:UpdateRewards(selectedRAFVersionInfo.rewards); + self.ClaimLegacyRewardsButton:Update(selectedRAFVersionInfo, recruitAFriendFrame.claimInProgress); + self:Layout(); + + SetUpSideDressUpFrame(self, 500, 682, "TOPLEFT", "TOPRIGHT", -5, -2); + SetUIPanelShown(SideDressUpFrame, isUsingDressUp); +end + +RecruitAFriendRewardMixin = {};--- @class RecruitAFriendRewardMixin + +function RecruitAFriendRewardMixin:Setup(rewardInfo, tooltipRightAligned) + self.Button:Setup(rewardInfo, tooltipRightAligned); + + if rewardInfo.claimed then + self.Months:SetTextColor(GREEN_FONT_COLOR:GetRGB()); + elseif rewardInfo.canClaim or rewardInfo.canAfford then + self.Months:SetTextColor(WHITE_FONT_COLOR:GetRGB()); + else + self.Months:SetTextColor(GRAY_FONT_COLOR:GetRGB()); + end + + if rewardInfo.repeatable then + self.Months:SetText(RAF_REPEATABLE_MONTHS:format(rewardInfo.monthCost)); + else + self.Months:SetText(RAF_MONTHS:format(rewardInfo.monthsRequired + rewardInfo.monthCost)); + end + + self:SetWidth(self.Button:GetWidth() + self.Months:GetWidth() + 7); + self:Show(); +end + +RecruitAFriendRewardButtonMixin = {};--- @class RecruitAFriendRewardButtonMixin + +function RecruitAFriendRewardButtonMixin:OnLoad() + self.tooltipXOffset = 5; +end + +function RecruitAFriendRewardButtonMixin:Setup(rewardInfo, tooltipRightAligned) + self.rewardInfo = rewardInfo; + self.tooltipRightAligned = tooltipRightAligned; + + self.Icon:SetTexture(rewardInfo.iconID); + if not rewardInfo.claimed and not rewardInfo.canClaim and not rewardInfo.canAfford then + self.Icon:SetDesaturated(true); + self.IconOverlay:SetShown(true); + else + self.Icon:SetDesaturated(false); + self.IconOverlay:SetShown(false); + end + + self:SetClaimed(rewardInfo.claimed); + self:SetCanClaim(rewardInfo.canClaim); + + self.dressupReward = false; + self.item = nil; + self.titleName = nil; + + if self.rewardInfo.itemID > 0 then + self.item = Item:CreateFromItemID(self.rewardInfo.itemID); + end + + if self.rewardInfo.petInfo then + self.dressupReward = self.rewardInfo.petInfo.displayID > 0; + elseif self.rewardInfo.mountInfo then + self.dressupReward = self.rewardInfo.mountInfo.mountID > 0; + elseif self.rewardInfo.titleInfo then + self.titleName = TitleUtil.GetNameFromTitleMaskID(self.rewardInfo.titleInfo.titleMaskID); + elseif self.rewardInfo.appearanceInfo or self.rewardInfo.appearanceSetInfo or self.rewardInfo.illusionInfo then + self.dressupReward = true; + end + + self:Show(); +end + +function RecruitAFriendRewardButtonMixin:OnClick() + if IsModifiedClick("DRESSUP") and self.dressupReward then + if self.rewardInfo.petInfo then + DressUpBattlePet(self.rewardInfo.petInfo.creatureID, self.rewardInfo.petInfo.displayID, self.rewardInfo.petInfo.speciesID); + elseif self.rewardInfo.mountInfo then + DressUpMount(self.rewardInfo.mountInfo.mountID); + elseif self.rewardInfo.appearanceInfo then + DressUpVisual(self.rewardInfo.appearanceInfo.appearanceID); + elseif self.rewardInfo.appearanceSetInfo then + DressUpTransmogSet(self.rewardInfo.appearanceSetInfo.appearanceIDs) + elseif self.rewardInfo.illusionInfo then + local weaponSlot, weaponSourceID = TransmogUtil.GetBestWeaponInfoForIllusionDressup(); + DressUpVisual(weaponSourceID, weaponSlot, self.rewardInfo.illusionInfo.spellItemEnchantmentID); + end + elseif IsModifiedClick("CHATLINK") then + local itemID = self.rewardInfo.itemID; + if itemID then + local name, link = C_Item.GetItemInfo(itemID); + if not ChatFrameUtil.InsertLink(link) then + ChatFrameUtil.OpenChat(link); + end + end + end +end + +function RecruitAFriendRewardButtonMixin:SetTooltipOwner() + local anchorPoint, xOffset; + if self.tooltipRightAligned then + anchorPoint = "ANCHOR_RIGHT"; + xOffset = self.tooltipXOffset; + else + anchorPoint = "ANCHOR_LEFT"; + xOffset = -self.tooltipXOffset; + end + GameTooltip:SetOwner(self, anchorPoint, xOffset, -self:GetHeight()); +end + +function RecruitAFriendRewardButtonMixin:OnEnter() + if not self.rewardInfo then + return; + end + + self:SetTooltipOwner(); + + GameTooltip:SetItemByID(self.rewardInfo.itemID); + + if self.dressupReward then + self.UpdateTooltip = function() self:OnEnter(); end; + else + self.UpdateTooltip = nil; + end + + if IsModifiedClick("DRESSUP") and self.dressupReward then + ShowInspectCursor(); + else + ResetCursor(); + end +end + +function RecruitAFriendRewardButtonMixin:OnLeave() + self.UpdateTooltip = nil; + ResetCursor(); + GameTooltip_Hide(); +end + +function RecruitAFriendRewardButtonMixin:SetClaimed(claimed) + --overridden in inherited mixins +end + +function RecruitAFriendRewardButtonMixin:SetCanClaim(canClaim) + --overridden in inherited mixins +end + +RecruitAFriendRewardButtonWithCheckMixin = CreateFromMixins(RecruitAFriendRewardButtonMixin);--- @class RecruitAFriendRewardButtonWithCheckMixin : RecruitAFriendRewardButtonMixin + +function RecruitAFriendRewardButtonWithCheckMixin:SetClaimed(claimed) + self.CheckMark:SetShown(claimed); +end + +function RecruitAFriendRewardButtonWithCheckMixin:Setup(rewardInfo, tooltipRightAligned) + RecruitAFriendRewardButtonMixin.Setup(self, rewardInfo, tooltipRightAligned); + + if not rewardInfo.claimed and not rewardInfo.canClaim and not rewardInfo.canAfford then + self.IconBorder:SetDesaturated(true); + self.IconBorder:SetVertexColor(WHITE_FONT_COLOR:GetRGBA()); + else + self.IconBorder:SetDesaturated(false); + if rewardInfo.rewardType == Enum.RafRewardType.GameTime then + self.IconBorder:SetVertexColor(HEIRLOOM_BLUE_COLOR:GetRGBA()); + else + self.IconBorder:SetVertexColor(EPIC_PURPLE_COLOR:GetRGBA()); + end + end +end + +local RAF_FANFARE_MODEL_SCENE = 253; + +RecruitAFriendRewardButtonWithFanfareMixin = CreateFromMixins(RecruitAFriendRewardButtonMixin);--- @class RecruitAFriendRewardButtonWithFanfareMixin : RecruitAFriendRewardButtonMixin + +function RecruitAFriendRewardButtonWithFanfareMixin:OnLoad() + self.tooltipXOffset = 10; + self.ModelScene:EnableMouse(false); +end + +function RecruitAFriendRewardButtonWithFanfareMixin:Setup(rewardInfo, tooltipRightAligned) + RecruitAFriendRewardButtonMixin.Setup(self, rewardInfo, tooltipRightAligned); + + if not rewardInfo.claimed and not rewardInfo.canClaim then + self.IconBorder:SetAtlas("RecruitAFriend_ClaimPane_SepiaRing", true); + else + self.IconBorder:SetAtlas("RecruitAFriend_ClaimPane_GoldRing", true); + end +end + +function RecruitAFriendRewardButtonWithFanfareMixin:OnClick() + if IsModifiedClick("DRESSUP") and self.dressupReward then + if RecruitAFriendRewardsFrame:IsShown() then + RecruitAFriendRewardsFrame:Hide(); + end + RecruitAFriendRewardButtonMixin.OnClick(self); + end +end + +function RecruitAFriendRewardButtonWithFanfareMixin:WaitingForFlash() + return self.waitingForFlash; +end + +function RecruitAFriendRewardButtonWithFanfareMixin:IsUnwrapAnimating() + return self.ModelScene:IsUnwrapAnimating(); +end + +function RecruitAFriendRewardButtonWithFanfareMixin:SetCanClaim(canClaim) + self.ClaimGlowSpinAnim:Play(); -- Just leave this playing + + if self.lastCanClaim == nil then + -- Initialization..if we start in a claimable state just go to the end of the anim and show the fanfare model scene + if canClaim then + self.ClaimGlow:SetAlpha(0.8); + self.ClaimGlowSpin:SetAlpha(0.3); + self:UpdateFanfareModelScene(canClaim); + end + else + if canClaim ~= self.lastCanClaim then + if canClaim then + self.ClaimGlowOutAnim:Stop(); + self.ClaimGlowInAnim:Play(); + self:UpdateFanfareModelScene(canClaim); + else + self.ClaimGlowInAnim:Stop(); + self.ClaimGlowOutAnim:Play(); + if not self:IsUnwrapAnimating() then + self.ModelScene:Hide(); + end + end + end + end + + self.lastCanClaim = canClaim; +end + +function RecruitAFriendRewardButtonWithFanfareMixin:UpdateFanfareModelScene(canClaim) + if canClaim then + self.ModelScene:TransitionToModelSceneID(RAF_FANFARE_MODEL_SCENE, CAMERA_TRANSITION_TYPE_IMMEDIATE, CAMERA_MODIFICATION_TYPE_MAINTAIN, true); + self.ModelScene:PrepareForFanfare(true); + self.ModelScene:Show(); + else + self.ModelScene:Hide(); + end +end + +-- Global function for call from token claim dialog +function RecruitAFriend_TryPlayClaimRewardFanfare(rewardRAFVersion) + if rewardRAFVersion ~= RecruitAFriendFrame:GetLatestRAFVersion() then + return; + end + + RecruitAFriendFrame.RewardClaiming.NextRewardButton:PlayClaimRewardFanfare(); +end + +function RecruitAFriendRewardButtonWithFanfareMixin:PlayClaimRewardFanfare() + self.waitingForFlash = true; + C_Timer.After(0.8, function() + self.ClaimFlashAnim:Stop(); + self.ClaimFlashAnim:Play(); + self.waitingForFlash = false; + RecruitAFriendFrame:OnUnwrapFlashBegun(); + end) + + local function OnFinishedCallback() + self:UpdateFanfareModelScene(self.lastCanClaim); + end + + self.ModelScene:StartUnwrapAnimation(OnFinishedCallback); +end + +RecruitAFriendRewardTabMixin = CreateFromMixins(RecruitAFriendSystemMixin);--- @class RecruitAFriendRewardTabMixin : RecruitAFriendSystemMixin + +function RecruitAFriendRewardTabMixin:OnLoad() + self:AddDynamicEventMethod(self:GetRecruitAFriendFrame(), RecruitAFriendFrameMixin.Event.SelectedRAFVersionChanged, self.OnSelectedRAFVersionChanged) +end + +function RecruitAFriendRewardTabMixin:OnSelectedRAFVersionChanged() + self:RefreshVisuals(); +end + +function RecruitAFriendRewardTabMixin:Setup(rafVersion) + self.rafVersion = rafVersion; + + self.Icon:SetAtlas(self.IconAtlasFormat:format(RAFUtil.GetTextureKitForRAFVersion(self.rafVersion), TextureKitConstants.UseAtlasSize)); + self:RefreshVisuals(); + + self:Show(); +end + +function RecruitAFriendRewardTabMixin:GetRAFVersion(rafVersion) + return self.rafVersion; +end + +function RecruitAFriendRewardTabMixin:TrySetChecked() + self:SetChecked(self.rafVersion == self:GetRecruitAFriendFrame():GetSelectedRAFVersion()); +end + +function RecruitAFriendRewardTabMixin:TryPlayUnclaimedRewardsAnim() + if self:GetChecked() then + self.UnclaimedRewardsAnim:Stop(); + return; + end + + local recruitAFriendFrame = self:GetRecruitAFriendFrame(); + local isLegacyRewardTab = recruitAFriendFrame:IsLegacyRAFVersion(self.rafVersion); + if not isLegacyRewardTab then + self.UnclaimedRewardsAnim:Stop(); + return; + end + + local versionInfo = recruitAFriendFrame:GetRAFVersionInfo(self.rafVersion); + local canClaimNextReward = versionInfo.nextReward and versionInfo.nextReward.canClaim; + self.UnclaimedRewardsAnim:SetPlaying(canClaimNextReward); +end + +function RecruitAFriendRewardTabMixin:RefreshVisuals() + self:TrySetChecked(); + self:TryPlayUnclaimedRewardsAnim(); +end + +function RecruitAFriendRewardTabMixin:OnClick() + self:GetRecruitAFriendFrame():TriggerEvent(RecruitAFriendFrameMixin.Event.NewRewardTabSelected, self.rafVersion); + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); +end + +RecruitAFriendRecruitmentButtonMixin = {};--- @class RecruitAFriendRecruitmentButtonMixin + +function RecruitAFriendRecruitmentButtonMixin:OnClick() + if RecruitAFriendRecruitmentFrame:IsShown() then + StaticPopupSpecial_Hide(RecruitAFriendRecruitmentFrame); + else + C_RecruitAFriend.RequestUpdatedRecruitmentInfo(); + RecruitAFriendRewardsFrame:Hide(); + StaticPopupSpecial_Show(RecruitAFriendRecruitmentFrame); + end +end + +RecruitAFriendRecruitmentFrameMixin = {};--- @class RecruitAFriendRecruitmentFrameMixin + +function RecruitAFriendRecruitmentFrameMixin:OnLoad() + self.EditBox:Disable(); +end + +function RecruitAFriendRecruitmentFrameMixin:OnShow() + PlaySound(SOUNDKIT.IG_MAINMENU_OPEN); +end + +function RecruitAFriendRecruitmentFrameMixin:OnHide() + PlaySound(SOUNDKIT.IG_MAINMENU_CLOSE); +end + +local PLAYER_REALM_NAME = GetRealmName(); +local _, PLAYER_FACTION_NAME = UnitFactionGroup("player"); + +function RecruitAFriendRecruitmentFrameMixin:UpdateRecruitmentInfo(recruitmentInfo, recruitsAreMaxed) + if recruitmentInfo then + local expireDate = date("*t", recruitmentInfo.expireTime); + recruitmentInfo.expireDateString = FormatShortDate(expireDate.day, expireDate.month, expireDate.year) + + self.Description:SetText(RAF_RECRUITMENT_DESC:format(recruitmentInfo.totalUses, daysInCycle)); + + if recruitmentInfo.sourceFaction ~= "" then + self.FactionAndRealm:SetText(RAF_RECRUITS_FACTION_AND_REALM:format(recruitmentInfo.sourceFaction, recruitmentInfo.sourceRealm)); + self.FactionAndRealm:Show(); + else + self.FactionAndRealm:Hide(); + end + + self.EditBox.Instructions:Hide(); + self.EditBox:SetText(recruitmentInfo.recruitmentURL); + self.EditBox:SetCursorPosition(0); + else + self.Description:SetText(RAF_RECRUITMENT_DESC:format(maxRecruitLinkUses, daysInCycle)); + self.FactionAndRealm:SetText(RAF_RECRUITS_FACTION_AND_REALM:format(PLAYER_FACTION_NAME, PLAYER_REALM_NAME)); + + self.EditBox.Instructions:SetText(RAF_NO_ACTIVE_LINK:format(daysInCycle)); + self.EditBox.Instructions:Show(); + self.EditBox:SetText(""); + end + + if recruitsAreMaxed then + self.InfoText1:SetText(RAF_FULL_RECRUITS:format(maxRecruits, maxRecruits)); + self.InfoText1:SetTextColor(RED_FONT_COLOR:GetRGB()); + self.InfoText1:Show(); + self.InfoText2:Hide(); + elseif recruitmentInfo then + self.InfoText1:SetTextColor(WHITE_FONT_COLOR:GetRGB()); + + if recruitmentInfo.remainingUses > 0 then + self.InfoText1:SetText(RAF_ACTIVE_LINK_EXPIRE_DATE:format(recruitmentInfo.expireDateString)); + else + self.InfoText1:SetText(RAF_EXPENDED_LINK_EXPIRE_DATE:format(recruitmentInfo.expireDateString)); + end + + if recruitmentInfo.remainingUses > 0 then + self.InfoText2:SetTextColor(WHITE_FONT_COLOR:GetRGB()); + else + self.InfoText2:SetTextColor(RED_FONT_COLOR:GetRGB()); + end + + local timesUsed = recruitmentInfo.totalUses - recruitmentInfo.remainingUses; + self.InfoText2:SetText(RAF_LINK_REMAINING_USES:format(timesUsed, recruitmentInfo.totalUses)); + + self.InfoText1:Show(); + self.InfoText2:Show(); + else + self.InfoText1:Hide(); + self.InfoText2:Hide(); + end + + self.GenerateOrCopyLinkButton:Update(recruitmentInfo, recruitsAreMaxed); +end + +RecruitAFriendGenerateOrCopyLinkButtonMixin = {};--- @class RecruitAFriendGenerateOrCopyLinkButtonMixin + +function RecruitAFriendGenerateOrCopyLinkButtonMixin:OnClick() + if self.recruitmentInfo then + CopyToClipboard(self.recruitmentInfo.recruitmentURL); + else + if C_RecruitAFriend.GenerateRecruitmentLink() then + self.waitingForRecruitmentInfo = true; + self:Disable(); + end + end + PlaySound(SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON); +end + +function RecruitAFriendGenerateOrCopyLinkButtonMixin:OnEnter() + if not self:IsEnabled() then + local wrap = true; + + if self.recruitsAreMaxed then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_SetTitle(GameTooltip, RAF_FULL_RECRUITS:format(maxRecruits, maxRecruits), RED_FONT_COLOR, wrap); + GameTooltip:Show(); + elseif not self.waitingForRecruitmentInfo then + GameTooltip:SetOwner(self, "ANCHOR_RIGHT"); + GameTooltip_SetTitle(GameTooltip, RAF_EXPENDED_LINK_EXPIRE_DATE:format(self.recruitmentInfo.expireDateString), RED_FONT_COLOR, wrap); + GameTooltip:Show(); + end + end +end + +function RecruitAFriendGenerateOrCopyLinkButtonMixin:OnLeave() + GameTooltip_Hide(); +end + +function RecruitAFriendGenerateOrCopyLinkButtonMixin:Update(recruitmentInfo, recruitsAreMaxed) + self.recruitmentInfo = recruitmentInfo; + self.recruitsAreMaxed = recruitsAreMaxed; + + if recruitmentInfo then + self.waitingForRecruitmentInfo = false; + self:SetText(RAF_COPY_LINK); + self:SetEnabled(recruitmentInfo.remainingUses > 0 and not recruitsAreMaxed); + else + self:SetText(RAF_GENERATE_LINK); + self:SetEnabled(not self.waitingForRecruitmentInfo and not recruitsAreMaxed); + end +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.xml new file mode 100644 index 0000000..8ec9f6a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_RecruitAFriend/RecruitAFriendFrame.xml @@ -0,0 +1,844 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + self:RegisterForDrag("LeftButton"); + + + self:GetParent().moving = true; + self:GetParent():StartMoving(); + + + self:GetParent().moving = nil; + self:GetParent():StopMovingOrSizing(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedBasicControls.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedBasicControls.xml.annotated.lua new file mode 100644 index 0000000..25292f1 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedBasicControls.xml.annotated.lua @@ -0,0 +1,140 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L9) +--- Template +--- @class DialogButtonNormalTexture : Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L12) +--- Template +--- @class DialogButtonPushedTexture : Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L15) +--- Template +--- @class DialogButtonDisabledTexture : Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L18) +--- Template +--- @class DialogButtonHighlightTexture : Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L29) +--- child of DialogBoxFrame +--- @class DialogBoxFrame_Button : Button + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L21) +--- Template +--- @class DialogBoxFrame : Frame, BackdropTemplate +--- @field backdropInfo any # BACKDROP_DIALOG_32_32 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L136) +--- child of UIPanelDialogTemplate +--- @class UIPanelDialogTemplate_Close : Button, UIPanelCloseButton + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L112) +--- child of UIPanelDialogTemplate +--- @class UIPanelDialogTemplate_Title : FontString, GameFontNormal + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L49) +--- Template +--- @class UIPanelDialogTemplate : Frame +--- @field Title UIPanelDialogTemplate_Title + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L160) +--- child of BasicMessageDialog +--- @class BasicMessageDialog_Border : Frame, DialogBorderTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L161) +--- child of BasicMessageDialog +--- @class BasicMessageDialogButton : Button +BasicMessageDialogButton = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L151) +--- child of BasicMessageDialog +--- @class BasicMessageDialog_Text : FontString, GameFontRedLarge + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L144) +--- @class BasicMessageDialog : Frame +--- @field Border BasicMessageDialog_Border +--- @field Text BasicMessageDialog_Text +BasicMessageDialog = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L181) +--- Template +--- @class TitleDragAreaTemplate : Frame + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L198) +--- Template +--- @class BaseTextTimer : Frame, BaseTextTimerMixin + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L231) +--- child of BaseExpandableDialog +--- @class BaseExpandableDialog_CloseButton : Button, UIPanelCloseButtonNoScripts + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L200) +--- Template +--- @class BaseExpandableDialog : Frame, BaseExpandableDialogMixin +--- @field CloseButton BaseExpandableDialog_CloseButton +--- @field Top Texture +--- @field Bottom Texture +--- @field Middle Texture +--- @field CloseButtonBG Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L260) +--- child of BaseNineSliceDialog +--- @class BaseNineSliceDialog_Underlay : Frame +--- @field ignoreInLayout boolean # true +--- @field Tex Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L326) +--- child of BaseNineSliceDialog_Contents +--- @class BaseNineSliceDialog_Contents_CloseButton : Button, SharedButtonLargeTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L289) +--- child of BaseNineSliceDialog_Contents +--- @class BaseNineSliceDialog_Contents_Title : FontString, Game30Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L301) +--- child of BaseNineSliceDialog_Contents +--- @class BaseNineSliceDialog_Contents_Description : FontString, System15Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L308) +--- child of BaseNineSliceDialog_Contents +--- @class BaseNineSliceDialog_Contents_DescriptionDuplicate : FontString, System15Font + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L276) +--- child of BaseNineSliceDialog +--- @class BaseNineSliceDialog_Contents : Frame +--- @field CloseButton BaseNineSliceDialog_Contents_CloseButton +--- @field ParchmentTop Texture +--- @field ParchmentBottom Texture +--- @field Title BaseNineSliceDialog_Contents_Title +--- @field Line Texture +--- @field Description BaseNineSliceDialog_Contents_Description +--- @field DescriptionDuplicate BaseNineSliceDialog_Contents_DescriptionDuplicate +--- @field ParchmentMiddle Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L242) +--- Template +--- @class BaseNineSliceDialog : Frame, ResizeLayoutFrame, DefaultScaleFrame, BaseNineSliceDialogMixin +--- @field fixedWidth number # 586 +--- @field minimumHeight number # 442 +--- @field showUnderlay boolean # true +--- @field topYOffset number # -65 +--- @field nineSliceTextureKit string # GenericMetal2 +--- @field centerBackgroundTexture string # Glues-AnnouncementPopup-Background +--- @field centerBackgroundXPadding number # 20 +--- @field centerBackgroundYPadding number # 20 +--- @field parchmentTextureKit string # Glues-AnnouncementPopup-Parchment +--- @field parchmentYPaddingTop number # 19 +--- @field parchmentYPaddingBottom number # 27 +--- @field parchmentXOffset number # -1 +--- @field Underlay BaseNineSliceDialog_Underlay +--- @field Border Frame +--- @field Contents BaseNineSliceDialog_Contents +--- @field CenterBackground Texture + + +--- Scripts: +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedBasicControls.xml#L4) +do + --FrameXML_Debug(1); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedColorConstants.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedColorConstants.lua.annotated.lua new file mode 100644 index 0000000..3eb50f3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedColorConstants.lua.annotated.lua @@ -0,0 +1,44 @@ +FONT_COLOR_CODE_CLOSE = "|r"; + +FACTION_BAR_COLORS = +{ + FACTION_RED_COLOR, + FACTION_RED_COLOR, + FACTION_ORANGE_COLOR, + FACTION_YELLOW_COLOR, + FACTION_GREEN_COLOR, + FACTION_GREEN_COLOR, + FACTION_GREEN_COLOR, + FACTION_GREEN_COLOR, +}; + +PLAYER_FACTION_COLORS = +{ + [0] = PLAYER_FACTION_COLOR_HORDE, + [1] = PLAYER_FACTION_COLOR_ALLIANCE, +}; + +PLAYER_FACTION_COLORS_HEX = +{ + [0] = PLAYER_FACTION_COLOR_HORDE:GenerateHexColor(), + [1] = PLAYER_FACTION_COLOR_ALLIANCE:GenerateHexColor(), +}; + +PLAYER_FACTION_BRIGHT_COLORS = +{ + [0] = PVP_SCOREBOARD_HORDE_CELL_COLOR, + [1] = PVP_SCOREBOARD_ALLIANCE_CELL_COLOR, +}; + +COVENANT_COLORS = +{ + [1] = KYRIAN_BLUE_COLOR, + [2] = VENTHYR_RED_COLOR, + [3] = NIGHT_FAE_BLUE_COLOR, + [4] = NECROLORD_GREEN_COLOR, + + Kyrian = KYRIAN_BLUE_COLOR, + Venthyr = VENTHYR_RED_COLOR, + NightFae = NIGHT_FAE_BLUE_COLOR, + Necrolord = NECROLORD_GREEN_COLOR, +} \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedConstants.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedConstants.lua.annotated.lua new file mode 100644 index 0000000..729681f --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedConstants.lua.annotated.lua @@ -0,0 +1,147 @@ +-- +-- New shared constants should be added to this +-- + +local envTable = GetCurrentEnvironment(); + +-- faction +PLAYER_FACTION_GROUP = { [0] = "Horde", [1] = "Alliance", Horde = 0, Alliance = 1 }; + +FACTION_LOGO_TEXTURES = { + [0] = "Interface\\Icons\\Inv_Misc_Tournaments_banner_Orc", + [1] = "Interface\\Icons\\Achievement_PVP_A_A", +}; + +FACTION_LABELS = { + [0] = FACTION_HORDE, + [1] = FACTION_ALLIANCE, +}; + +FACTION_LABELS_FROM_STRING = { + ["Horde"] = FACTION_HORDE, + ["Alliance"] = FACTION_ALLIANCE, +} + +-- If you add a class here, you also need to add it to RAID_CLASS_COLORS, CHARCREATE_CLASS_INFO, CLASS_SORT_ORDER, and maybe to ALT_MANA_BAR_PAIR_DISPLAY_INFO +-- Also add a new RaidButton in Blizzard_RaidUI.xml: name="RaidClassButton###.. +CLASS_ICON_TCOORDS = { + ["WARRIOR"] = {0, 0.25, 0, 0.25}, + ["MAGE"] = {0.25, 0.49609375, 0, 0.25}, + ["ROGUE"] = {0.49609375, 0.7421875, 0, 0.25}, + ["DRUID"] = {0.7421875, 0.98828125, 0, 0.25}, + ["HUNTER"] = {0, 0.25, 0.25, 0.5}, + ["SHAMAN"] = {0.25, 0.49609375, 0.25, 0.5}, + ["PRIEST"] = {0.49609375, 0.7421875, 0.25, 0.5}, + ["WARLOCK"] = {0.7421875, 0.98828125, 0.25, 0.5}, + ["PALADIN"] = {0, 0.25, 0.5, 0.75}, + ["DEATHKNIGHT"] = {0.25, .5, 0.5, .75}, + ["MONK"] = {0.5, 0.73828125, 0.5, .75}, + ["DEMONHUNTER"] = {0.7421875, 0.98828125, 0.5, 0.75}, + ["EVOKER"] = {0, 0.25, 0.75, 1}, + ["TRAVELER"] = {0, 0.25, 0, 0.25}, +}; + +function GetClassAtlas(className) + return ("classicon-%s"):format(className); +end + +function GetBodyTypeAtlases(bodyTypeID) + local genderName = (bodyTypeID == Enum.UnitSex.Male) and "male" or "female"; + local baseAtlas = ("charactercreate-gendericon-%s"):format(genderName); + local selectedAtlas = ("%s-selected"):format(baseAtlas); + return baseAtlas, selectedAtlas; +end + +function SetGamepadBindingStrings(mainBinding, abbrBinding, name, opt_abbrName) + local abbrName = opt_abbrName or name; + envTable[mainBinding] = ("|A:Gamepad_%s_64:24:24|a"):format(name); + envTable[abbrBinding] = ("|A:Gamepad_%s_32:14:14|a"):format(abbrName); +end +-- Generic GamePad button labels +SetGamepadBindingStrings("KEY_PADDUP", "KEY_ABBR_PADDUP", "Gen_Up"); +SetGamepadBindingStrings("KEY_PADDRIGHT", "KEY_ABBR_PADDRIGHT", "Gen_Right"); +SetGamepadBindingStrings("KEY_PADDDOWN", "KEY_ABBR_PADDDOWN", "Gen_Down"); +SetGamepadBindingStrings("KEY_PADDLEFT", "KEY_ABBR_PADDLEFT", "Gen_Left"); +SetGamepadBindingStrings("KEY_PAD1", "KEY_ABBR_PAD1", "Gen_1"); +SetGamepadBindingStrings("KEY_PAD2", "KEY_ABBR_PAD2", "Gen_2"); +SetGamepadBindingStrings("KEY_PAD3", "KEY_ABBR_PAD3", "Gen_3"); +SetGamepadBindingStrings("KEY_PAD4", "KEY_ABBR_PAD4", "Gen_4"); +SetGamepadBindingStrings("KEY_PAD5", "KEY_ABBR_PAD5", "Gen_5"); +SetGamepadBindingStrings("KEY_PAD6", "KEY_ABBR_PAD6", "Gen_6"); +SetGamepadBindingStrings("KEY_PADLSTICK", "KEY_ABBR_PADLSTICK", "Gen_LStickIn"); +SetGamepadBindingStrings("KEY_PADRSTICK", "KEY_ABBR_PADRSTICK", "Gen_RStickIn"); +SetGamepadBindingStrings("KEY_PADLSHOULDER", "KEY_ABBR_PADLSHOULDER", "Gen_LShoulder"); +SetGamepadBindingStrings("KEY_PADRSHOULDER", "KEY_ABBR_PADRSHOULDER", "Gen_RShoulder"); +SetGamepadBindingStrings("KEY_PADLTRIGGER", "KEY_ABBR_PADLTRIGGER", "Gen_LTrigger"); +SetGamepadBindingStrings("KEY_PADRTRIGGER", "KEY_ABBR_PADRTRIGGER", "Gen_RTrigger"); +SetGamepadBindingStrings("KEY_PADLSTICKUP", "KEY_ABBR_PADLSTICKUP", "Gen_LStickUp"); +SetGamepadBindingStrings("KEY_PADLSTICKRIGHT", "KEY_ABBR_PADLSTICKRIGHT", "Gen_LStickRight"); +SetGamepadBindingStrings("KEY_PADLSTICKDOWN", "KEY_ABBR_PADLSTICKDOWN", "Gen_LStickDown"); +SetGamepadBindingStrings("KEY_PADLSTICKLEFT", "KEY_ABBR_PADLSTICKLEFT", "Gen_LStickLeft"); +SetGamepadBindingStrings("KEY_PADRSTICKUP", "KEY_ABBR_PADRSTICKUP", "Gen_RStickUp"); +SetGamepadBindingStrings("KEY_PADRSTICKRIGHT", "KEY_ABBR_PADRSTICKRIGHT", "Gen_RStickRight"); +SetGamepadBindingStrings("KEY_PADRSTICKDOWN", "KEY_ABBR_PADRSTICKDOWN", "Gen_RStickDown"); +SetGamepadBindingStrings("KEY_PADRSTICKLEFT", "KEY_ABBR_PADRSTICKLEFT", "Gen_RStickLeft"); +SetGamepadBindingStrings("KEY_PADPADDLE1", "KEY_ABBR_PADPADDLE1", "Gen_Paddle1"); +SetGamepadBindingStrings("KEY_PADPADDLE2", "KEY_ABBR_PADPADDLE2", "Gen_Paddle2"); +SetGamepadBindingStrings("KEY_PADPADDLE3", "KEY_ABBR_PADPADDLE3", "Gen_Paddle3"); +SetGamepadBindingStrings("KEY_PADPADDLE4", "KEY_ABBR_PADPADDLE4", "Gen_Paddle4"); +SetGamepadBindingStrings("KEY_PADFORWARD", "KEY_ABBR_PADFORWARD", "Gen_Forward"); +SetGamepadBindingStrings("KEY_PADBACK", "KEY_ABBR_PADBACK", "Gen_Back"); +SetGamepadBindingStrings("KEY_PADSYSTEM", "KEY_ABBR_PADSYSTEM", "Gen_System"); +SetGamepadBindingStrings("KEY_PADSOCIAL", "KEY_ABBR_PADSOCIAL", "Gen_Share"); +-- "Letters" label style specializations +SetGamepadBindingStrings("KEY_PADDUP_LTR", "KEY_ABBR_PADDUP_LTR", "Ltr_Up", "Gen_Up"); +SetGamepadBindingStrings("KEY_PADDRIGHT_LTR", "KEY_ABBR_PADDRIGHT_LTR", "Ltr_Right", "Gen_Right"); +SetGamepadBindingStrings("KEY_PADDDOWN_LTR", "KEY_ABBR_PADDDOWN_LTR", "Ltr_Down", "Gen_Down"); +SetGamepadBindingStrings("KEY_PADDLEFT_LTR", "KEY_ABBR_PADDLEFT_LTR", "Ltr_Left", "Gen_Left"); +SetGamepadBindingStrings("KEY_PAD1_LTR", "KEY_ABBR_PAD1_LTR", "Ltr_A"); +SetGamepadBindingStrings("KEY_PAD2_LTR", "KEY_ABBR_PAD2_LTR", "Ltr_B"); +SetGamepadBindingStrings("KEY_PAD3_LTR", "KEY_ABBR_PAD3_LTR", "Ltr_X"); +SetGamepadBindingStrings("KEY_PAD4_LTR", "KEY_ABBR_PAD4_LTR", "Ltr_Y"); +SetGamepadBindingStrings("KEY_PADLSHOULDER_LTR","KEY_ABBR_PADLSHOULDER_LTR","Ltr_LShoulder","Gen_LShoulder"); +SetGamepadBindingStrings("KEY_PADRSHOULDER_LTR","KEY_ABBR_PADRSHOULDER_LTR","Ltr_RShoulder","Gen_RShoulder"); +SetGamepadBindingStrings("KEY_PADLTRIGGER_LTR", "KEY_ABBR_PADLTRIGGER_LTR", "Ltr_LTrigger", "Gen_LTrigger"); +SetGamepadBindingStrings("KEY_PADRTRIGGER_LTR", "KEY_ABBR_PADRTRIGGER_LTR", "Ltr_RTrigger", "Gen_RTrigger"); +SetGamepadBindingStrings("KEY_PADFORWARD_LTR", "KEY_ABBR_PADFORWARD_LTR", "Ltr_Menu"); +SetGamepadBindingStrings("KEY_PADBACK_LTR", "KEY_ABBR_PADBACK_LTR", "Ltr_View"); +SetGamepadBindingStrings("KEY_PADSYSTEM_LTR", "KEY_ABBR_PADSYSTEM_LTR", "Ltr_System"); +SetGamepadBindingStrings("KEY_PADSOCIAL_LTR", "KEY_ABBR_PADSOCIAL_LTR", "Ltr_Share", "Gen_Share"); +-- "Shapes" label style specializations +SetGamepadBindingStrings("KEY_PADDUP_SHP", "KEY_ABBR_PADDUP_SHP", "Shp_Up", "Gen_Up"); +SetGamepadBindingStrings("KEY_PADDRIGHT_SHP", "KEY_ABBR_PADDRIGHT_SHP", "Shp_Right", "Gen_Right"); +SetGamepadBindingStrings("KEY_PADDDOWN_SHP", "KEY_ABBR_PADDDOWN_SHP", "Shp_Down", "Gen_Down"); +SetGamepadBindingStrings("KEY_PADDLEFT_SHP", "KEY_ABBR_PADDLEFT_SHP", "Shp_Left", "Gen_Left"); +SetGamepadBindingStrings("KEY_PAD1_SHP", "KEY_ABBR_PAD1_SHP", "Shp_Cross"); +SetGamepadBindingStrings("KEY_PAD2_SHP", "KEY_ABBR_PAD2_SHP", "Shp_Circle"); +SetGamepadBindingStrings("KEY_PAD3_SHP", "KEY_ABBR_PAD3_SHP", "Shp_Square"); +SetGamepadBindingStrings("KEY_PAD4_SHP", "KEY_ABBR_PAD4_SHP", "Shp_Triangle"); +SetGamepadBindingStrings("KEY_PAD5_SHP", "KEY_ABBR_PAD5_SHP", "Shp_MicMute"); +SetGamepadBindingStrings("KEY_PAD6_SHP", "KEY_ABBR_PAD6_SHP", "Shp_TouchpadR"); +SetGamepadBindingStrings("KEY_PADLSTICK_SHP", "KEY_ABBR_PADLSTICK_SHP", "Shp_LStickIn"); +SetGamepadBindingStrings("KEY_PADRSTICK_SHP", "KEY_ABBR_PADRSTICK_SHP", "Shp_RStickIn"); +SetGamepadBindingStrings("KEY_PADLSHOULDER_SHP","KEY_ABBR_PADLSHOULDER_SHP","Shp_LShoulder"); +SetGamepadBindingStrings("KEY_PADRSHOULDER_SHP","KEY_ABBR_PADRSHOULDER_SHP","Shp_RShoulder"); +SetGamepadBindingStrings("KEY_PADLTRIGGER_SHP", "KEY_ABBR_PADLTRIGGER_SHP", "Shp_LTrigger"); +SetGamepadBindingStrings("KEY_PADRTRIGGER_SHP", "KEY_ABBR_PADRTRIGGER_SHP", "Shp_RTrigger"); +SetGamepadBindingStrings("KEY_PADFORWARD_SHP", "KEY_ABBR_PADFORWARD_SHP", "Shp_Menu"); +SetGamepadBindingStrings("KEY_PADBACK_SHP", "KEY_ABBR_PADBACK_SHP", "Shp_TouchpadL"); +SetGamepadBindingStrings("KEY_PADSYSTEM_SHP", "KEY_ABBR_PADSYSTEM_SHP", "Shp_System"); +SetGamepadBindingStrings("KEY_PADSOCIAL_SHP", "KEY_ABBR_PADSOCIAL_SHP", "Shp_Share"); +-- "Reverse" label style specializations +SetGamepadBindingStrings("KEY_PAD1_REV", "KEY_ABBR_PAD1_REV", "Rev_B"); +SetGamepadBindingStrings("KEY_PAD2_REV", "KEY_ABBR_PAD2_REV", "Rev_A"); +SetGamepadBindingStrings("KEY_PAD3_REV", "KEY_ABBR_PAD3_REV", "Rev_Y"); +SetGamepadBindingStrings("KEY_PAD4_REV", "KEY_ABBR_PAD4_REV", "Rev_X"); +SetGamepadBindingStrings("KEY_PADLSHOULDER_REV","KEY_ABBR_PADLSHOULDER_REV","Rev_LShoulder"); +SetGamepadBindingStrings("KEY_PADRSHOULDER_REV","KEY_ABBR_PADRSHOULDER_REV","Rev_RShoulder"); +SetGamepadBindingStrings("KEY_PADLTRIGGER_REV", "KEY_ABBR_PADLTRIGGER_REV", "Rev_LTrigger"); +SetGamepadBindingStrings("KEY_PADRTRIGGER_REV", "KEY_ABBR_PADRTRIGGER_REV", "Rev_RTrigger"); +SetGamepadBindingStrings("KEY_PADFORWARD_REV", "KEY_ABBR_PADFORWARD_REV", "Rev_Plus"); +SetGamepadBindingStrings("KEY_PADBACK_REV", "KEY_ABBR_PADBACK_REV", "Rev_Minus"); +SetGamepadBindingStrings("KEY_PADSYSTEM_REV", "KEY_ABBR_PADSYSTEM_REV", "Rev_Home", "Gen_Home"); +SetGamepadBindingStrings("KEY_PADSOCIAL_REV", "KEY_ABBR_PADSOCIAL_REV", "Rev_Capture"); + +WOW_GAMES_CATEGORY_ID = 33; +WOW_GAME_TIME_CATEGORY_ID = 37; +WOW_SUBSCRIPTION_CATEGORY_ID = 156; \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.lua.annotated.lua new file mode 100644 index 0000000..1f37df5 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.lua.annotated.lua @@ -0,0 +1,291 @@ +local envTable = GetCurrentEnvironment(); + +local function SetupTextFont(fontString, fontObject) + if fontString and fontObject then + fontString:SetFontObject(fontObject); + end +end + +function SharedTooltip_OnLoad(self) + NineSliceUtil.DisableSharpening(self.NineSlice); + local style = nil; + local isEmbedded = false; + SharedTooltip_SetBackdropStyle(self, style, isEmbedded); + self:SetClampRectInsets(0, 0, 25, 0); + + SetupTextFont(self.TextLeft1, self.textLeft1Font); + SetupTextFont(self.TextRight1, self.textRight1Font); + SetupTextFont(self.TextLeft2, self.textLeft2Font); + SetupTextFont(self.TextRight2, self.textRight2Font); +end + +function SharedTooltip_OnHide(self) + if self.ClearPadding then + self:ClearPadding(); + else + self:SetPadding(0, 0, 0, 0); + end +end + +local DEFAULT_TOOLTIP_OFFSET_X = -17; +local DEFAULT_TOOLTIP_OFFSET_Y = 70; + +function SharedTooltip_SetDefaultAnchor(tooltip, parent) + tooltip:SetOwner(parent or GetAppropriateTopLevelParent(), "ANCHOR_NONE"); + tooltip:SetPoint("BOTTOMRIGHT", GetAppropriateTopLevelParent(), "BOTTOMRIGHT", DEFAULT_TOOLTIP_OFFSET_X, DEFAULT_TOOLTIP_OFFSET_Y); +end + +function SharedTooltip_ClearInsertedFrames(self) + if self.insertedFrames then + for i = 1, #self.insertedFrames do + self.insertedFrames[i]:Hide(); + end + end + self.insertedFrames = nil; +end + +function SharedTooltip_SetBackdropStyle(self, style, embedded) + if embedded or self.IsEmbedded then + self.NineSlice:Hide(); + else + local layoutName = style and style.layoutType or "TooltipDefaultLayout"; + local layout = NineSliceUtil.GetLayout(layoutName); + NineSliceUtil.ApplyLayout(self.NineSlice, layout); + self.NineSlice:Show(); + end + + local bgR, bgG, bgB = TOOLTIP_DEFAULT_BACKGROUND_COLOR:GetRGB(); + self.NineSlice:SetCenterColor(bgR, bgG, bgB, 1); + + if self.TopOverlay then + if style and style.overlayAtlasTop then + self.TopOverlay:SetAtlas(style.overlayAtlasTop, true); + self.TopOverlay:SetScale(style.overlayAtlasTopScale or 1.0); + self.TopOverlay:SetPoint("CENTER", self, "TOP", style.overlayAtlasTopXOffset or 0, style.overlayAtlasTopYOffset or 0); + self.TopOverlay:Show(); + else + self.TopOverlay:Hide(); + end + end + + if self.BottomOverlay then + if style and style.overlayAtlasBottom then + self.BottomOverlay:SetAtlas(style.overlayAtlasBottom, true); + self.BottomOverlay:SetScale(style.overlayAtlasBottomScale or 1.0); + self.BottomOverlay:SetPoint("CENTER", self, "BOTTOM", style.overlayAtlasBottomXOffset or 0, style.overlayAtlasBottomYOffset or 0); + self.BottomOverlay:Show(); + else + self.BottomOverlay:Hide(); + end + end + + if style and style.padding then + self:SetPadding(style.padding.right, style.padding.bottom, style.padding.left, style.padding.top); + end +end + +function GameTooltip_SetDefaultAnchor(tooltip, parent) + tooltip:SetOwner(parent, "ANCHOR_NONE"); + + local point, relativeTo, relativePoint, offsetX, offsetY = SharedTooltipDefaultContainer:GetPoint(1); + --If GameTooltipDefaultContainer exists, use that instead + if GameTooltipDefaultContainer then + point, relativeTo, relativePoint, offsetX, offsetY = GameTooltipDefaultContainer:GetPoint(1); + end + -- If DefaultContainer isn't corner anchored then find the nearest corner to anchor to + if not (point == "BOTTOMRIGHT" or point == "BOTTOMLEFT" or point == "TOPRIGHT" or point == "TOPLEFT") then + if point == "TOP" or point == "BOTTOM" then + point = offsetX > 0 and point.."RIGHT" or point.."LEFT"; + elseif point =="LEFT" or point == "RIGHT" then + point = offsetY > 0 and "TOP"..point or "BOTTOM"..point; + else -- CENTER + local topBottom = offsetY > 0 and "TOP" or "BOTTOM"; + local rightLeft = offsetX > 0 and "RIGHT" or "LEFT"; + point = topBottom..rightLeft; + end + end + + -- Anchor tooltip to corner + if GameTooltipDefaultContainer then + tooltip:SetPoint(point, GameTooltipDefaultContainer); + else + tooltip:SetPoint(point, SharedTooltipDefaultContainer); + end +end + +function GameTooltip_AddBlankLinesToTooltip(tooltip, numLines) + if numLines ~= nil then + for i = 1, numLines do + tooltip:AddLine(" "); + end + end +end + +function GameTooltip_AddBlankLineToTooltip(tooltip) + GameTooltip_AddBlankLinesToTooltip(tooltip, 1); +end + +function GameTooltip_SetTitle(tooltip, text, overrideColor, wrap) + tooltip:ClearLines(); + GameTooltip_AddColoredLine(tooltip, text, overrideColor or HIGHLIGHT_FONT_COLOR, wrap) +end + +function GameTooltip_ShowDisabledTooltip(tooltip, owner, text, tooltipAnchor) + tooltip:SetOwner(owner, tooltipAnchor); + + local wrap = true; + GameTooltip_SetTitle(tooltip, text, RED_FONT_COLOR, wrap); + + tooltip:Show(); +end + +function GameTooltip_AddNormalLine(tooltip, text, wrap, leftOffset) + GameTooltip_AddColoredLine(tooltip, text, NORMAL_FONT_COLOR, wrap, leftOffset); +end + +function GameTooltip_AddBodyLine(...) + GameTooltip_AddNormalLine(...); +end + +function GameTooltip_AddHighlightLine(tooltip, text, wrap, leftOffset) + GameTooltip_AddColoredLine(tooltip, text, HIGHLIGHT_FONT_COLOR, wrap, leftOffset); +end + +function GameTooltip_AddInstructionLine(tooltip, text, wrap, leftOffset) + GameTooltip_AddColoredLine(tooltip, text, GREEN_FONT_COLOR, wrap, leftOffset); +end + +function GameTooltip_AddErrorLine(tooltip, text, wrap, leftOffset) + GameTooltip_AddColoredLine(tooltip, text, RED_FONT_COLOR, wrap, leftOffset); +end + +function GameTooltip_AddDisabledLine(tooltip, text, wrap, leftOffset) + GameTooltip_AddColoredLine(tooltip, text, DISABLED_FONT_COLOR, wrap, leftOffset); +end + +function GameTooltip_AddColoredLine(tooltip, text, color, wrap, leftOffset) + local r, g, b = color:GetRGB(); + if wrap == nil then + wrap = true; + end + tooltip:AddLine(text, r, g, b, wrap, leftOffset); +end + +function GameTooltip_AddColoredDoubleLine(tooltip, leftText, rightText, leftColor, rightColor, wrap, leftOffset) + local leftR, leftG, leftB = leftColor:GetRGB(); + local rightR, rightG, rightB = rightColor:GetRGB(); + if wrap == nil then + wrap = true; + end + tooltip:AddDoubleLine(leftText, rightText, leftR, leftG, leftB, rightR, rightG, rightB, wrap, leftOffset); +end + +-- Common defaults when using GameTooltip_ShowSimpleTooltip +SimpleTooltipConstants = { + NoOverrideColor = nil; + + WrapText = true; + DoNotWrapText = false; +} + +function GameTooltip_ShowSimpleTooltip(tooltip, text, overrideColor, wrap, owner, point, offsetX, offsetY) + tooltip:SetOwner(owner, point, offsetX, offsetY); + GameTooltip_SetTitle(tooltip, text, overrideColor, wrap); + tooltip:Show(); +end + +function GameTooltip_InsertFrame(tooltipFrame, frame, verticalPadding) + verticalPadding = verticalPadding or 0; + + local textSpacing = tooltipFrame:GetCustomLineSpacing() or 2; + local textHeight = Round(tooltipFrame:GetLeftLine(2):GetLineHeight()); + local neededHeight = Round(frame:GetHeight() + verticalPadding); + local numLinesNeeded = math.ceil(neededHeight / (textHeight + textSpacing)); + local currentLine = tooltipFrame:NumLines(); + GameTooltip_AddBlankLinesToTooltip(tooltipFrame, numLinesNeeded); + frame:SetParent(tooltipFrame); + frame:ClearAllPoints(); + frame:SetPoint("TOPLEFT", tooltipFrame:GetLeftLine(currentLine + 1), "TOPLEFT", 0, -verticalPadding); + if not tooltipFrame.insertedFrames then + tooltipFrame.insertedFrames = { }; + end + local frameWidth = frame:GetWidth(); + if tooltipFrame:GetMinimumWidth() < frameWidth then + tooltipFrame:SetMinimumWidth(frameWidth); + end + frame:Show(); + tinsert(tooltipFrame.insertedFrames, frame); + -- return space taken so inserted frame can resize if needed + return (numLinesNeeded * textHeight) + (numLinesNeeded - 1) * textSpacing; +end + +function GameTooltip_AddNewbieTip(frame, normalText, r, g, b, newbieText, noNormalText) + -- Nothing to do, this was added for Glue support. +end + +TooltipBackdropTemplateMixin = {};--- @class TooltipBackdropTemplateMixin + +function TooltipBackdropTemplateMixin:TooltipBackdropOnLoad() + NineSliceUtil.DisableSharpening(self.NineSlice); + + local bgColor = self.backdropColor or TOOLTIP_DEFAULT_BACKGROUND_COLOR; + local bgAlpha = self.backdropColorAlpha or 1; + local bgR, bgG, bgB = bgColor:GetRGB(); + self:SetBackdropColor(bgR, bgG, bgB, bgAlpha); + + if self.backdropBorderColor then + local borderR, borderG, borderB = self.backdropBorderColor:GetRGB(); + local borderAlpha = self.backdropBorderColorAlpha or 1; + self:SetBackdropBorderColor(borderR, borderG, borderB, borderAlpha); + end +end + +function TooltipBackdropTemplateMixin:SetBackdropColor(r, g, b, a) + self.NineSlice:SetCenterColor(r, g, b, a); +end + +function TooltipBackdropTemplateMixin:GetBackdropColor() + return self.NineSlice:GetCenterColor(); +end + +function TooltipBackdropTemplateMixin:SetBackdropBorderColor(r, g, b, a) + self.NineSlice:SetBorderColor(r, g, b, a); +end + +function TooltipBackdropTemplateMixin:GetBackdropBorderColor() + return self.NineSlice:GetBorderColor(); +end + +function TooltipBackdropTemplateMixin:SetBorderBlendMode(blendMode) + self.NineSlice:SetBorderBlendMode(blendMode); +end + +DisabledTooltipButtonMixin = {};--- @class DisabledTooltipButtonMixin + +function DisabledTooltipButtonMixin:OnEnter() + if not self:IsEnabled() then + local disabledTooltip, disabledTooltipAnchor = self:GetDisabledTooltip(); + if disabledTooltip ~= nil then + GameTooltip_ShowDisabledTooltip(GetAppropriateTooltip(), self, disabledTooltip, disabledTooltipAnchor); + end + end +end + +function DisabledTooltipButtonMixin:OnLeave() + local tooltip = GetAppropriateTooltip(); + tooltip:Hide(); +end + +function DisabledTooltipButtonMixin:SetDisabledTooltip(disabledTooltip, disabledTooltipAnchor) + self.disabledTooltip = disabledTooltip; + self.disabledTooltipAnchor = disabledTooltipAnchor; +end + +function DisabledTooltipButtonMixin:GetDisabledTooltip() + return self.disabledTooltip, self.disabledTooltipAnchor; +end + +function DisabledTooltipButtonMixin:SetDisabledState(disabled, disabledTooltip, disabledTooltipAnchor) + self:SetEnabled(not disabled); + self:SetDisabledTooltip(disabledTooltip, disabledTooltipAnchor); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml new file mode 100644 index 0000000..308eda9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml @@ -0,0 +1,134 @@ + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml.annotated.lua new file mode 100644 index 0000000..139c448 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml.annotated.lua @@ -0,0 +1,208 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L3) +--- Template +--- @class TooltipTextLeftTemplate : FontString, GameTooltipText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L4) +--- Template +--- @class TooltipTextRightTemplate : FontString, GameTooltipText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L6) +--- Template +--- @class TooltipTextureTemplate : Texture + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L19) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_NineSlice : Frame, NineSlicePanelTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L35) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_TextLeft1 : FontString, TooltipTextLeftTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L36) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_TextRight1 : FontString, TooltipTextRightTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L41) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_TextLeft2 : FontString, TooltipTextLeftTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L42) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_TextRight2 : FontString, TooltipTextRightTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L47) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture1 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L48) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture2 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L49) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture3 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L50) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture4 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L51) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture5 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L52) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture6 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L53) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture7 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L54) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture8 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L55) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture9 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L56) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture10 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L57) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture11 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L58) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture12 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L59) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture13 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L60) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture14 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L61) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture15 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L62) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture16 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L63) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture17 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L64) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture18 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L65) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture19 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L66) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture20 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L67) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture21 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L68) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture22 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L69) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture23 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L70) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture24 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L71) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture25 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L72) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture26 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L73) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture27 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L74) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture28 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L75) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture29 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L76) +--- child of SharedTooltipArtTemplate +--- @class SharedTooltipArtTemplate_Texture30 : Texture, TooltipTextureTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L10) +--- Template +--- @class SharedTooltipArtTemplate : GameTooltip +--- @field textLeft1Font string # GameTooltipHeaderText +--- @field textRight1Font string # GameTooltipHeaderText +--- @field textLeft2Font string # GameTooltipText +--- @field textRight2Font string # GameTooltipText +--- @field layoutType string # TooltipDefaultLayout +--- @field NineSlice SharedTooltipArtTemplate_NineSlice +--- @field TopOverlay Texture +--- @field BottomOverlay Texture +--- @field TextLeft1 SharedTooltipArtTemplate_TextLeft1 +--- @field TextRight1 SharedTooltipArtTemplate_TextRight1 +--- @field TextLeft2 SharedTooltipArtTemplate_TextLeft2 +--- @field TextRight2 SharedTooltipArtTemplate_TextRight2 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L81) +--- @class SharedTooltipDefaultContainer : GameTooltip +SharedTooltipDefaultContainer = {} + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L88) +--- Template +--- @class SharedTooltipTemplate : GameTooltip, SharedTooltipArtTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L97) +--- Template +--- @class SharedNoHeaderTooltipTemplate : GameTooltip, SharedTooltipTemplate +--- @field textLeft1Font string # GameTooltipText +--- @field textRight1Font string # GameTooltipText + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L109) +--- child of TooltipBackdropTemplate +--- @class TooltipBackdropTemplate_NineSlice : Frame, NineSlicePanelTemplate + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L104) +--- Template +--- @class TooltipBackdropTemplate : Frame, TooltipBackdropTemplateMixin +--- @field layoutType string # TooltipDefaultLayout +--- @field NineSlice TooltipBackdropTemplate_NineSlice + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L116) +--- Template +--- @class TooltipBorderBackdropTemplate : Frame, TooltipBackdropTemplate +--- @field backdropColorAlpha number # 0 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L122) +--- Template +--- @class TooltipBorderedFrameTemplate : Frame, TooltipBackdropTemplate +--- @field backdropColorAlpha number # 0.8 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SharedTooltipTemplates.xml#L128) +--- Template +--- @class DisabledTooltipButtonTemplate : Button, DisabledTooltipButtonMixin + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SmoothStatusBar.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SmoothStatusBar.lua.annotated.lua new file mode 100644 index 0000000..001e45a --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SmoothStatusBar.lua.annotated.lua @@ -0,0 +1,60 @@ +local g_updatingBars = {}; + +local function IsCloseEnough(bar, newValue, targetValue) + local min, max = bar:GetMinMaxValues(); + local range = max - min; + if range > 0.0 then + return math.abs((newValue - targetValue) / range) < .00001; + end + + return true; +end + +local function ProcessSmoothStatusBars() + for bar, targetValue in pairs(g_updatingBars) do + local effectiveTargetValue = Clamp(targetValue, bar:GetMinMaxValues()); + local newValue = FrameDeltaLerp(bar:GetValue(), effectiveTargetValue, .25); + + if IsCloseEnough(bar, newValue, effectiveTargetValue) then + g_updatingBars[bar] = nil; + bar:SetValue(effectiveTargetValue); + else + bar:SetValue(newValue); + end + end +end + +C_Timer.NewTicker(0, ProcessSmoothStatusBars); + +SmoothStatusBarMixin = {};--- @class SmoothStatusBarMixin + +function SmoothStatusBarMixin:ResetSmoothedValue(value) --If nil, tries to set to the last target value + local targetValue = g_updatingBars[self]; + if targetValue then + g_updatingBars[self] = nil; + self:SetValue(value or targetValue); + elseif value then + self:SetValue(value); + end +end + +function SmoothStatusBarMixin:SetSmoothedValue(value) + g_updatingBars[self] = value; +end + +function SmoothStatusBarMixin:SetMinMaxSmoothedValue(min, max) + self:SetMinMaxValues(min, max); + + local targetValue = g_updatingBars[self]; + if targetValue then + local ratio = 1; + if max ~= 0 and self.lastSmoothedMax and self.lastSmoothedMax ~= 0 then + ratio = max / self.lastSmoothedMax; + end + + g_updatingBars[self] = targetValue * ratio; + end + + self.lastSmoothedMin = min; + self.lastSmoothedMax = max; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SortUtil.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SortUtil.lua.annotated.lua new file mode 100644 index 0000000..ef44854 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SortUtil.lua.annotated.lua @@ -0,0 +1,90 @@ +SortUtil = {}; + +function SortUtil.CompareNumeric(lhs, rhs) + return Sign(lhs - rhs); +end + +function SortUtil.CompareUtf8i(lhs, rhs) + return Sign(strcmputf8i(lhs, rhs)); +end + +local SortManagerMixin = {};--- @class SortManagerMixin + +function SortManagerMixin:Init() + self.comparatorsTbls = {}; +end + +function SortManagerMixin:InsertComparator(sortOrder, comparator) + assert(sortOrder, comparator); + table.insert(self.comparatorsTbls, {sortOrder = sortOrder, comparator = comparator, ascending = false}); +end + +function SortManagerMixin:SetDefaultComparator(defaultComparatorFunc) + self.defaultComparatorFunc = defaultComparatorFunc; +end + +function SortManagerMixin:SetSortOrderFunc(sortOrderFunc) + self.sortOrderFunc = sortOrderFunc; +end + +function SortManagerMixin:FindComparatorTbl(sortOrder) + return FindValueInTableIf(self.comparatorsTbls, function(comparatorsTbl) + return comparatorsTbl.sortOrder == sortOrder; + end); +end + +function SortManagerMixin:ToggleSortAscending(sortOrder) + local comparatorTbl = self:FindComparatorTbl(sortOrder); + comparatorTbl.ascending = not comparatorTbl.ascending; +end + +function SortManagerMixin:SetSortAscending(sortOrder, ascending) + local comparatorTbl = self:FindComparatorTbl(sortOrder); + comparatorTbl.ascending = ascending; +end + +function SortManagerMixin:IsSortAscending(sortOrder) + local comparatorTbl = self:FindComparatorTbl(sortOrder); + return comparatorTbl.ascending; +end + +function SortManagerMixin:CreateComparator() + return function(lhs, rhs) + local comparatorsTbls = self.comparatorsTbls; + + local result = 0; + local sortOrder = self.sortOrderFunc(); + if sortOrder then + local comparatorTbl = self:FindComparatorTbl(sortOrder); + if comparatorTbl then + result = NegateIf(comparatorTbl.comparator(lhs, rhs), comparatorTbl.ascending); + end + end + + if result == 0 then + for _, comparatorTbl in ipairs(comparatorsTbls) do + if comparatorTbl.sortOrder ~= sortOrder then + result = NegateIf(comparatorTbl.comparator(lhs, rhs), comparatorTbl.ascending); + if result < 0 then + return true; + elseif result > 0 then + return false; + end + end + end + + if not self.defaultComparatorFunc then + error("Provide a default comparator that guarantees strict ordering."); + end + return self.defaultComparatorFunc(lhs, rhs); + end + + return result < 0; + end; +end + +function SortUtil.CreateSortManager() + local sortManager = CreateFromMixins(SortManagerMixin); + sortManager:Init(); + return sortManager; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.lua.annotated.lua new file mode 100644 index 0000000..4d8c635 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.lua.annotated.lua @@ -0,0 +1,120 @@ + +local DefaultMinBottomSpacing = 20; + + +-- Used when you want to dynamically adjust spacing to the actual space available. For example, +-- when things need to be adjusted based on UI scale and resolution. +SpaceToFitDirectionalLayoutMixin = {};--- @class SpaceToFitDirectionalLayoutMixin + +function SpaceToFitDirectionalLayoutMixin:SetFixedMaxSpace(maxSpace) + self.maxSpace = maxSpace; +end + +function SpaceToFitDirectionalLayoutMixin:GetAvailableSpace() + -- Override in your derived Mixin. + + if self.maxSpace then + return self.maxSpace / self:GetEffectiveScale(); + end +end + +function SpaceToFitDirectionalLayoutMixin:GetChildSpaceRequired(child) + -- Override in your derived Mixin. +end + +function SpaceToFitDirectionalLayoutMixin:UpdateSpacing(children) + children = children or self:GetLayoutChildren(); + + local baseSpacing = self.baseSpacing; + self.spacing = baseSpacing; + + local spaceAvailable = self:GetAvailableSpace(); + if spaceAvailable then + local numChildren = #children; + if numChildren >= 1 then + local childSpaceRequired = self:GetChildSpaceRequired(children[1]); + local spaceRequired = numChildren * childSpaceRequired; + local leftOverSpace = spaceAvailable - spaceRequired; + + if leftOverSpace < (baseSpacing * numChildren) then + self.spacing = math.floor(leftOverSpace / numChildren); + end + + local baseFrameLevel = self:GetFrameLevel(); + for i, child in ipairs(children) do + child:SetFrameLevel(baseFrameLevel + (numChildren - i) + 1); + end + end + end +end + +function SpaceToFitDirectionalLayoutMixin:IsSpacingAdjusted() + return not ApproximatelyEqual(self.spacing, self.baseSpacing); +end + +function SpaceToFitDirectionalLayoutMixin:GetSpacing() + return self.spacing; +end + + +SpaceToFitVerticalLayoutMixin = CreateFromMixins(SpaceToFitDirectionalLayoutMixin);--- @class SpaceToFitVerticalLayoutMixin : SpaceToFitDirectionalLayoutMixin + +function SpaceToFitVerticalLayoutMixin:LayoutChildren(children, expandToWidth) + self:UpdateSpacing(children); + return VerticalLayoutMixin.LayoutChildren(self, children, expandToWidth); +end + +function SpaceToFitVerticalLayoutMixin:GetAvailableSpace() + local baseSpace = SpaceToFitDirectionalLayoutMixin.GetAvailableSpace(self); + if baseSpace then + return baseSpace; + end + + local bottomMin = self.bottomFrame and self.bottomFrame:GetTop(); + if not bottomMin then + return nil; + end + + local topMax = self:GetTopMax(); + if not topMax then + return nil; + end + + return (topMax - bottomMin) - self.minBottomSpacing; +end + +function SpaceToFitVerticalLayoutMixin:GetChildSpaceRequired(child) + -- Overrides SpaceToFitDirectionalLayoutMixin. + + return child:GetHeight(); +end + +-- Used to cap the height and adjust spacing as required by UI scale and resolution. +function SpaceToFitVerticalLayoutMixin:SetBottomFrame(bottomFrame, minBottomSpacing) + self.bottomFrame = bottomFrame; + self.minBottomSpacing = minBottomSpacing or DefaultMinBottomSpacing; +end + +-- Used to cap the height and adjust spacing as required by UI scale and resolution. +function SpaceToFitVerticalLayoutMixin:SetTopFrame(topFrame) + self.topFrame = topFrame; +end + +function SpaceToFitVerticalLayoutMixin:GetTopMax() + return (self.topFrame and self.topFrame:GetBottom()) or self:GetTop(); +end + + +-- Less featured than the Vertical version simply because nothing else was required originally. +SpaceToFitHorizontalLayoutMixin = CreateFromMixins(SpaceToFitDirectionalLayoutMixin);--- @class SpaceToFitHorizontalLayoutMixin : SpaceToFitDirectionalLayoutMixin + +function SpaceToFitHorizontalLayoutMixin:LayoutChildren(children, expandToWidth) + self:UpdateSpacing(children); + return HorizontalLayoutMixin.LayoutChildren(self, children, expandToWidth); +end + +function SpaceToFitHorizontalLayoutMixin:GetChildSpaceRequired(child) + -- Overrides SpaceToFitDirectionalLayoutMixin. + + return child:GetWidth(); +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml new file mode 100644 index 0000000..12dc0d3 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml.annotated.lua new file mode 100644 index 0000000..7971ab8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml.annotated.lua @@ -0,0 +1,12 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml#L3) +--- Template +--- @class SpaceToFitVerticalLayoutFrame : Frame, VerticalLayoutFrame, SpaceToFitVerticalLayoutMixin +--- @field baseSpacing number # 0 + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/SpaceToFitLayoutFrame.xml#L12) +--- Template +--- @class SpaceToFitHorizontalLayoutFrame : Frame, HorizontalLayoutFrame, SpaceToFitHorizontalLayoutMixin +--- @field baseSpacing number # 0 + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.lua.annotated.lua new file mode 100644 index 0000000..87f2c20 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.lua.annotated.lua @@ -0,0 +1,78 @@ + +SpinnerMixin = {};--- @class SpinnerMixin + +function SpinnerMixin:OnShow() + if self.Shadow then + self.Shadow:SetAlpha(self:GetShadowAlpha()); + self:UpdateShadowSize(); + self:SetScript("OnSizeChanged", self.OnSizeChanged); + end + + self.Anim:Restart(); +end + +function SpinnerMixin:OnHide() + self:SetScript("OnSizeChanged", nil); + self.Anim:Stop(); +end + +function SpinnerMixin:OnSizeChanged() + self:UpdateShadowSize(); +end + +function SpinnerMixin:SetDesaturated(desaturated) + self.Ring:SetDesaturated(desaturated); + self.Sparks:SetDesaturated(desaturated); + + if self.Shadow then + self.Shadow:SetDesaturated(desaturated); + end +end + +function SpinnerMixin:GetShadowAlpha() + return self.shadowAlpha or 0.5; +end + +function SpinnerMixin:SetShadowEnabled(enabled) + if self.shadowEnabled ~= enabled then + self.shadowEnabled = enabled; + + if enabled and not self.Shadow then + self.Shadow = self:CreateTexture(nil, "BACKGROUND"); + self.Shadow:SetAtlas("Spinner_Shadow", TextureKitConstants.UseAtlasSize); + self.Shadow:SetAlpha(self:GetShadowAlpha()); + self.Shadow:SetPoint("CENTER"); + end + + self:UpdateShadowSize(); + + if self.Shadow then + self.Shadow:SetShown(enabled); + end + end +end + +function SpinnerMixin:UpdateShadowSize() + if self.Shadow then + if not self.shadowSizeScalar then + local ringAtlas = self.Ring:GetAtlas(); + local shadowAtlas = self.Shadow:GetAtlas(); + local ringAtlasInfo = C_Texture.GetAtlasInfo(ringAtlas); + local shadowAtlasInfo = C_Texture.GetAtlasInfo(shadowAtlas); + self.shadowSizeScalar = shadowAtlasInfo.width / ringAtlasInfo.width; + end + + local width, height = self:GetSize(); + self.Shadow:SetSize(width * self.shadowSizeScalar, height * self.shadowSizeScalar); + end +end + +function SpinnerMixin:UpdateTheme(useDarkMode) + self:SetShadowEnabled(not useDarkMode); +end + +SpinnerWithShadowMixin = {};--- @class SpinnerWithShadowMixin + +function SpinnerWithShadowMixin:SpinnerWithShadow_OnLoad() + self:SetShadowEnabled(true); +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml new file mode 100644 index 0000000..d603f8e --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml.annotated.lua new file mode 100644 index 0000000..51e96d8 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spinner.xml.annotated.lua @@ -0,0 +1,18 @@ +--- @meta _ + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/Spinner.xml#L12) +--- child of SpinnerTemplate +--- @class SpinnerTemplate_Anim : AnimationGroup + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/Spinner.xml#L3) +--- Template +--- @class SpinnerTemplate : Frame, SpinnerMixin +--- @field Ring Texture +--- @field Sparks Texture +--- @field Anim SpinnerTemplate_Anim + +--- [Source](https://github.com/Gethe/wow-ui-source/blob/live/Interface/AddOns/Blizzard_SharedXML/Spinner.xml#L27) +--- Template +--- @class SpinnerWithShadowTemplate : Frame, SpinnerTemplate, SpinnerWithShadowMixin +--- @field shadowAlpha number # 0.5 + diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spline.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spline.lua.annotated.lua new file mode 100644 index 0000000..3731752 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/Spline.lua.annotated.lua @@ -0,0 +1,132 @@ + +local function CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1, p2, p3, p4) + local term1 = 2.0 * p2 + (p3 - p1) * t; + local term2 = (2.0 * p1 - 5.0 * p2 + 4.0 * p3 - p4) * tSquared; + local term3 = (3.0 * p2 - p1 - 3.0 * p3 + p4) * tCubed; + + return 0.5 * (term1 + term2 + term3); +end + +function CatmullRom_CalculatePointOnCurve(t, p1, p2, p3, p4) + local tSquared = t * t; + local tCubed = tSquared * t; + return CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1, p2, p3, p4); +end + +function CatmullRom_Calculate2DPointOnCurve(t, p1x, p1y, p2x, p2y, p3x, p3y, p4x, p4y) + local tSquared = t * t; + local tCubed = tSquared * t; + return + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1x, p2x, p3x, p4x), + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1y, p2y, p3y, p4y); +end + +function CatmullRom_Calculate3DPointOnCurve(t, p1x, p1y, p1z, p2x, p2y, p2z, p3x, p3y, p3z, p4x, p4y, p4z) + local tSquared = t * t; + local tCubed = tSquared * t; + return + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1x, p2x, p3x, p4x), + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1y, p2y, p3y, p4y), + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1z, p2z, p3z, p4z); +end + +function CatmullRom_Calculate4DPointOnCurve(t, p1x, p1y, p1z, p1w, p2x, p2y, p2z, p2w, p3x, p3y, p3z, p3w, p4x, p4y, p4z, p4w) + local tSquared = t * t; + local tCubed = tSquared * t; + return + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1x, p2x, p3x, p4x), + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1y, p2y, p3y, p4y), + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1z, p2z, p3z, p4z), + CatmullRom_CalculatePointOnCurveHelper(t, tSquared, tCubed, p1w, p2w, p3w, p4w); +end + +CatmullRomSplineMixin = {};--- @class CatmullRomSplineMixin + +function CreateCatmullRomSpline(numDimensions) + local spline = CreateFromMixins(CatmullRomSplineMixin); + spline:OnLoad(numDimensions) + return spline; +end + +function CatmullRomSplineMixin:OnLoad(numDimensions) + if numDimensions == 1 then + self.calculateFunction = CatmullRom_CalculatePointOnCurve; + elseif numDimensions == 2 then + self.calculateFunction = CatmullRom_Calculate2DPointOnCurve; + elseif numDimensions == 3 then + self.calculateFunction = CatmullRom_Calculate3DPointOnCurve; + elseif numDimensions == 4 then + self.calculateFunction = CatmullRom_Calculate4DPointOnCurve; + else + -- In the interest of performance, limiting number of dimensions + error("Unsupported number of dimensions"); + end + + self.numDimensions = numDimensions; + self:ClearPoints(); +end + +function CatmullRomSplineMixin:GetNumDimensions() + return self.numDimensions; +end + +local function AddPointHelper(pointData, startIndex, ...) + local pointIndex = 1; + for i = startIndex, startIndex + select("#", ...) do + pointData[i] = select(pointIndex, ...); + pointIndex = pointIndex + 1; + end +end + +function CatmullRomSplineMixin:AddPoint(...) + assert(select("#", ...) == self.numDimensions); + + if #self.pointData == 0 then + -- If first point, put it in the list three times times to simplify the curve calculation, at this time the curve represents a single point + AddPointHelper(self.pointData, 1, ...); + AddPointHelper(self.pointData, 1 + self.numDimensions, ...); + AddPointHelper(self.pointData, 1 + self.numDimensions * 2, ...); + else + -- For each other point, add it to the end twice but replacing the last one that was added twice + AddPointHelper(self.pointData, #self.pointData - self.numDimensions + 1, ...); + AddPointHelper(self.pointData, #self.pointData + 1, ...); + end + + self.numPoints = self.numPoints + 1; +end + +function CatmullRomSplineMixin:GetPoint(pointIndex) + if pointIndex > 0 and pointIndex <= self:GetNumPoints() then + return unpack(self.pointData, (pointIndex + 1) * self.numDimensions + 1, (pointIndex + 2) * self.numDimensions); + end +end + +function CatmullRomSplineMixin:GetNumPoints() + return self.numPoints; +end + +function CatmullRomSplineMixin:ClearPoints() + self.numPoints = 0; + self.pointData = {}; +end + +function CatmullRomSplineMixin:CalculatePointOnGlobalCurve(t) + local startSegmentIndex, localT = self:FindSegmentOnGlobalCurve(t); + if startSegmentIndex then + return self:CalculatePointOnLocalCurveSegment(startSegmentIndex, localT); + end +end + +function CatmullRomSplineMixin:CalculatePointOnLocalCurveSegment(startSegmentIndex, t) + return self.calculateFunction(t, unpack(self.pointData, (startSegmentIndex - 2) * self.numDimensions + 1, (startSegmentIndex + 2) * self.numDimensions)); +end + +function CatmullRomSplineMixin:FindSegmentOnGlobalCurve(t) + local numPoints = self:GetNumPoints(); + if numPoints > 1 then + local numSegments = numPoints - 1; + local segment = numSegments * t; + local segmentIndex = Clamp(math.floor(segment), 0, numSegments - 1) + 2; + return segmentIndex, PercentageBetween(segment + 2, segmentIndex, segmentIndex + 1); + end +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/StringUtil.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/StringUtil.lua.annotated.lua new file mode 100644 index 0000000..91f2dc9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/StringUtil.lua.annotated.lua @@ -0,0 +1,31 @@ +function ConfirmationStringMatches(userInput, expectedText) + return strupper(userInput) == strupper(expectedText); +end + +function ConfirmationEditBoxMatches(editBox, expectedText) + return ConfirmationStringMatches(editBox:GetText(), expectedText); +end + +function UserInputNonEmpty(userInput) + return userInput and strtrim(userInput) ~= ""; +end + +function UserEditBoxNonEmpty(editBox) + return UserInputNonEmpty(editBox:GetText()); +end + +function StringSplitIntoTable(sep, string) + return { strsplit(sep, string) }; +end + +function StringContains(string, substring) + local index = 1; + local plain = true; + return string.find(string, substring, index, plain) ~= nil; +end + +StringUtil = {}; + +function StringUtil.RemoveTrailingSpaces(str) + return str:match("^(.-)%s*$"); +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TabGroup.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TabGroup.lua.annotated.lua new file mode 100644 index 0000000..96a0eaf --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TabGroup.lua.annotated.lua @@ -0,0 +1,78 @@ +TabGroupMixin = {};--- @class TabGroupMixin + +function TabGroupMixin:OnLoad(...) + self.isTabGroup = true; + self.frames = { ... }; +end + +function TabGroupMixin:AddFrame(frame) + table.insert(self.frames, frame); +end + +function TabGroupMixin:HasFocus() + return self:GetFocusIndex() ~= nil; +end + +function TabGroupMixin:SetFocus() + -- focusing the first frame/subgroup for now...actually depends on whether or not we were going backwards or forwards through the groups + local frame = self.frames[1]; + if frame then + frame:SetFocus(); + end +end + +function TabGroupMixin:GetFocusIndex() + return self.focusIndex or self:DiscoverFocusIndex(); +end + +function TabGroupMixin:DiscoverFocusIndex() + self.focusIndex = nil; + + for focusIndex, frame in ipairs(self.frames) do + if frame:HasFocus() then + self.focusIndex = focusIndex; + return focusIndex; + end + end +end + +function TabGroupMixin:IsValidFocusIndex(focusIndex) + return focusIndex > 0 and focusIndex <= #self.frames; +end + +function TabGroupMixin:WrapFocusIndex(focusIndex) + if focusIndex == 0 then + return #self.frames; + elseif focusIndex > #self.frames then + return 1; + end + + return focusIndex; +end + +function TabGroupMixin:OnTabPressed(preventFocusWrap) + local focusIndex = self:GetFocusIndex(); + + local frameAtIndex = self.frames[focusIndex]; + if frameAtIndex.isTabGroup then + if frameAtIndex:OnTabPressed(true) then + return true; + end + end + + local nextFocusIndex = IsShiftKeyDown() and (focusIndex - 1) or (focusIndex + 1); + + if preventFocusWrap and not self:IsValidFocusIndex(nextFocusIndex) then + return false; + end + + nextFocusIndex = Wrap(nextFocusIndex, #self.frames); + self.focusIndex = nextFocusIndex; + self.frames[nextFocusIndex]:SetFocus(); +end + +function CreateTabGroup(...) + local tabGroup = CreateFromMixins(TabGroupMixin); + tabGroup:OnLoad(...); + return tabGroup; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TableBuilder.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TableBuilder.lua.annotated.lua new file mode 100644 index 0000000..4fa7796 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TableBuilder.lua.annotated.lua @@ -0,0 +1,500 @@ +local ColumnFramePoolCollection = CreateFramePoolCollection(); + +local ColumnWidthConstraints = { + Fill = 1, -- Width will be distributed by available space. + Fixed = 2, -- Width is specified when initializing the column. +}; + +-- Any row or cell is expected to initialize itself in terms of the row data. The dataIndex is provided +-- in case the derived mixin needs to make additional CAPI calls involving it's relative index. The row +-- data may also be needed for a tooltip, so it will be assigned to the row and cells on update. +TableBuilderElementMixin = {};--- @class TableBuilderElementMixin + +--Derive +function TableBuilderElementMixin:Init(...) +end + +--Derive +function TableBuilderElementMixin:Populate(rowData, dataProviderKey) +end + +TableBuilderCellMixin = CreateFromMixins(TableBuilderElementMixin);--- @class TableBuilderCellMixin : TableBuilderElementMixin + +--Derive +function TableBuilderCellMixin:OnLineEnter() +end + +--Derive +function TableBuilderCellMixin:OnLineLeave() +end + + +TableBuilderRowMixin = CreateFromMixins(TableBuilderElementMixin);--- @class TableBuilderRowMixin : TableBuilderElementMixin + +--Derive +function TableBuilderRowMixin:OnLineEnter() +end + +--Derive +function TableBuilderRowMixin:OnLineLeave() +end + + +function TableBuilderRowMixin:OnEnter() + self:OnLineEnter(); + for i, cell in ipairs(self.cells) do + cell:OnLineEnter(); + end +end + +function TableBuilderRowMixin:OnLeave() + self:OnLineLeave(); + for i, cell in ipairs(self.cells) do + cell:OnLineLeave(); + end +end + +-- Defines an entire column within the table builder, by default a column's sizing constraints are set to fill. +TableBuilderColumnMixin = {};--- @class TableBuilderColumnMixin +function TableBuilderColumnMixin:Init(table) + self.cells = {}; + self.table = table; + + local fillCoefficient = 1.0; + local padding = 0; + self:SetFillConstraints(fillCoefficient, padding); +end + +-- Constructs the header frame with an optional initializer. +function TableBuilderColumnMixin:ConstructHeader(templateType, template, ...) + local frame = self.table:ConstructHeader(templateType, template); + self.headerFrame = frame; + if frame.Init then + frame:Init(...); + end + frame:Show(); +end + +function TableBuilderColumnMixin:Reset() + for row, cell in pairs(self.cells) do + self.pool:Release(cell); + tDeleteItem(row.cells, cell); + end + self.cells = {}; +end + +function TableBuilderColumnMixin:RemoveRow(row) + local cell = self.cells[row]; + self.cells[row] = nil; + self.pool:Release(cell); +end + +function TableBuilderColumnMixin:ConstructCell(row, rowData, dataProviderKey) + local cell = self.pool:Acquire(); + self.cells[row] = cell; + + if cell.Init then + cell:Init(unpack(self.args)); + end + + if cell.Populate then + cell.rowData = rowData; + cell:Populate(rowData, dataProviderKey); + end + + cell:Show(); + return cell; +end + +-- Constructs cells corresponding to each row with an optional initializer. +function TableBuilderColumnMixin:ConstructCells(templateType, template, ...) + self.args = {...}; + + self.pool = ColumnFramePoolCollection:GetOrCreatePool(templateType, nil, template); +end + +function TableBuilderColumnMixin:GetFillCoefficient() + return self.fillCoefficient; +end + +function TableBuilderColumnMixin:SetFillCoefficient(fillCoefficient) + self.fillCoefficient = fillCoefficient; +end + +function TableBuilderColumnMixin:GetPadding() + return self.padding; +end + +function TableBuilderColumnMixin:SetPadding(padding) + self.padding = padding; +end + +function TableBuilderColumnMixin:GetCellPadding() + return self.leftCellPadding or 0, self.rightCellPadding or 0; +end + +function TableBuilderColumnMixin:SetCellPadding(leftCellPadding, rightCellPadding) + self.leftCellPadding = leftCellPadding; + self.rightCellPadding = rightCellPadding; +end + +function TableBuilderColumnMixin:GetHeaderFrame() + return self.headerFrame; +end + +function TableBuilderColumnMixin:SetHeaderFrame(headerFrame) + self.headerFrame = headerFrame; +end + +function TableBuilderColumnMixin:GetWidthConstraints() + return self.widthConstraints; +end + +function TableBuilderColumnMixin:GetFixedWidth() + return self.fixedWidth; +end + +-- A header frame for the column is expected to be constructed or assigned prior to calling this. +-- See ConstructHeader() or SetHeaderFrame(). +function TableBuilderColumnMixin:ConstrainToHeader(padding) + local header = self:GetHeaderFrame(); + assert(header, "ConstrainToHeader() called with a nil header frame. Use ConstructHeader() or assign one with SetHeaderFrame(), or use SetFixedConstraints to have a headerless column."); + self:SetFixedConstraints(header:GetWidth(), padding or 0); +end + +function TableBuilderColumnMixin:SetFixedConstraints(fixedWidth, padding) + self.widthConstraints = ColumnWidthConstraints.Fixed; + self.fixedWidth = fixedWidth; + self:SetFillCoefficient(0); + self:SetPadding(padding or 0); +end + +function TableBuilderColumnMixin:SetFillConstraints(fillCoefficient, padding) + self.widthConstraints = ColumnWidthConstraints.Fill; + self.fixedWidth = 0; + self:SetFillCoefficient(fillCoefficient); + self:SetPadding(padding or 0); +end + +function TableBuilderColumnMixin:SetCalculatedWidth(calculatedWidth) + self.calculatedWidth = calculatedWidth; +end + +function TableBuilderColumnMixin:GetCalculatedWidth() + return self.calculatedWidth; +end + +function TableBuilderColumnMixin:GetCellWidth() + local leftCellPadding, rightCellPadding = self:GetCellPadding(); + return (self.calculatedWidth - leftCellPadding) - rightCellPadding; +end + +function TableBuilderColumnMixin:GetFullWidth() + return self:GetCalculatedWidth() + self:GetPadding(); +end + +function TableBuilderColumnMixin:SetDisplayUnderPreviousHeader(displayUnderPreviousHeader) + self.displayUnderPreviousHeader = displayUnderPreviousHeader; +end + +function TableBuilderColumnMixin:GetDisplayUnderPreviousHeader() + return self.displayUnderPreviousHeader; +end + +-- Constructs a table of frames within an existing set of row frames. These row frames could originate from +-- a scroll box or statically fixed set. To populate the table, assign a data provider (CAPI or lua function) +-- that can retrieve an object by index (number). +TableBuilderMixin = {};--- @class TableBuilderMixin +function TableBuilderMixin:Init() + self.rows = {}; + self.columns = {}; + self.leftMargin = 0; + self.rightMargin = 0; + self.columnHeaderOverlap = 0; + self.tableWidth = 0; + self.headerPoolCollection = CreateFramePoolCollection(); +end + +function TableBuilderMixin:GetDataProvider() + return self.dataProvider; +end + +function TableBuilderMixin:SetDataProvider(dataProvider) + self.dataProvider = dataProvider; +end + +function TableBuilderMixin:GetDataProviderData(dataProviderKey) + local dataProvider = self:GetDataProvider(); + return dataProvider and dataProvider(dataProviderKey) or nil; +end + +-- Controls the margins of the left-most and right-most columns within the table. +function TableBuilderMixin:SetTableMargins(leftMargin, rightMargin) + rightMargin = rightMargin or leftMargin; -- Use leftMargin as the default for both. + self.leftMargin = leftMargin; + self.rightMargin = rightMargin; +end + +-- Column headers overlap to make a consistent display. +function TableBuilderMixin:SetColumnHeaderOverlap(columnHeaderOverlap) + self.columnHeaderOverlap = columnHeaderOverlap; +end + +-- Can be used to set the table width, particularly if no header frames are involved. +function TableBuilderMixin:SetTableWidth(tableWidth) + self.tableWidth = tableWidth; +end + +function TableBuilderMixin:GetTableWidth() + return self.tableWidth; +end + +function TableBuilderMixin:GetTableMargins() + return self.leftMargin, self.rightMargin; +end + +function TableBuilderMixin:GetColumnHeaderOverlap() + return self.columnHeaderOverlap; +end + +function TableBuilderMixin:GetColumns() + return self.columns; +end + +function TableBuilderMixin:GetHeaderContainer() + return self.headerContainer; +end + +function TableBuilderMixin:SetHeaderContainer(headerContainer) + assert(headerContainer, "SetHeaderContainer() with a nil header container. Use ConstructHeader() or assign one with SetHeaderFrame(), or use SetFixedConstraints to have a headerless column."); + self.headerContainer = headerContainer; + self:SetTableWidth(headerContainer:GetWidth()); +end + +function TableBuilderMixin:GetHeaderPoolCollection() + return self.headerPoolCollection; +end + +function TableBuilderMixin:EnumerateHeaders() + return self.headerPoolCollection:EnumerateActive(); +end + +function TableBuilderMixin:ConstructHeader(templateType, template) + local headerContainer = self:GetHeaderContainer(); + assert(headerContainer ~= nil, "A header container must be set with TableBuilderMixin:SetHeaderContainer before adding column headers.") + local headerPoolCollection = self:GetHeaderPoolCollection(); + local pool = headerPoolCollection:GetOrCreatePool(templateType, headerContainer, template); + return pool:Acquire(template); +end + +function TableBuilderMixin:Arrange() + local columns = self:GetColumns(); + if columns and #columns > 0 then + self:CalculateColumnSpacing(); + self:ArrangeHeaders(); + end + + for columnIndex, column in ipairs(self.columns) do + column:Reset(); + end + + -- Repopulate cells for each row in case the column information changed. + for index, row in ipairs(self.rows) do + assert(TableIsEmpty(row.cells)); + for columnIndex, column in ipairs(self.columns) do + assert(row.rowData); + local cell = column:ConstructCell(row, row.rowData, columnIndex); + table.insert(row.cells, cell); + end + + self:ArrangeCells(row); + end +end + +function TableBuilderMixin:Reset() + self:GetHeaderPoolCollection():ReleaseAll(); + + for columnIndex, column in ipairs(self.columns) do + column:Reset(); + end + self.columns = {}; +end + +function TableBuilderMixin:AddRow(row, dataProviderKey) + local rowData = self:GetDataProviderData(dataProviderKey); + if not rowData then + return; + end + row.rowData = rowData; + table.insert(self.rows, row); + + if row.Populate then + row:Populate(rowData, dataProviderKey); + end + + row.cells = {}; + for columnIndex, column in ipairs(self.columns) do + local cell = column:ConstructCell(row, rowData, columnIndex); + table.insert(row.cells, cell); + end + + self:ArrangeCells(row); +end + +function TableBuilderMixin:RemoveRow(row) + local deleted = tDeleteItem(self.rows, row) > 0; + if not deleted then + return; + end + + for columnIndex, column in ipairs(self.columns) do + column:RemoveRow(row); + end + + row.rowData = nil; +end + +function TableBuilderMixin:ArrangeCells(row) + local columns = self:GetColumns(); + if #columns == 0 then + return; + end + + local height = row:GetHeight(); + local leftMargin, rightMargin = self:GetTableMargins(); + + local column = columns[1]; + local cell = row.cells[1]; + cell:SetParent(row); + cell:SetHeight(height); + local leftCellPadding, rightCellPadding = column:GetCellPadding(); + + self:ArrangeHorizontally(cell, row, column:GetCellWidth(), "TOPLEFT", "TOPLEFT", "BOTTOMLEFT", "BOTTOMLEFT", leftMargin + leftCellPadding); + + local previousCell = cell; + local previousRightCellPadding = rightCellPadding; + for columnIndex = 2, #columns do + column = columns[columnIndex]; + cell = row.cells[columnIndex]; + cell:SetParent(row); + cell:SetHeight(height); + leftCellPadding, rightCellPadding = column:GetCellPadding(); + + self:ArrangeHorizontally(cell, previousCell, column:GetCellWidth(), "TOPLEFT", "TOPRIGHT", "BOTTOMLEFT", "BOTTOMRIGHT", column:GetPadding() + leftCellPadding + previousRightCellPadding); + previousCell = cell; + previousRightCellPadding = rightCellPadding; + end +end + +function TableBuilderMixin:AddColumn() + local column = CreateAndInitFromMixin(TableBuilderColumnMixin, self); + tinsert(self.columns, column); + return column; +end + +function TableBuilderMixin:CalculateColumnSpacing() + -- The arrangement of frames is daisy-chained left to right. The margin on the left side + -- is created by adding the margin to it's anchor offset, and the margin on the right side + -- is created by subtracting space from the remaining fill space. + local columns = self:GetColumns(); + local paddingTotal = 0; + local fillCoefficientTotal = 0; + local fixedWidthTotal = 0; + for columnIndex, column in ipairs(columns) do + if column:GetWidthConstraints() == ColumnWidthConstraints.Fill then + fillCoefficientTotal = fillCoefficientTotal + column:GetFillCoefficient(); + else + fixedWidthTotal = fixedWidthTotal + column:GetFixedWidth(); + end + + paddingTotal = paddingTotal + column:GetPadding(); + end + + local tableWidth = self:GetTableWidth(); + local leftMargin, rightMargin = self:GetTableMargins(); + local fillWidthTotal = tableWidth - paddingTotal - (leftMargin + rightMargin) - fixedWidthTotal; + for k, column in pairs(columns) do + if fillCoefficientTotal > 0 and column:GetWidthConstraints() == ColumnWidthConstraints.Fill then + local fillRatio = column:GetFillCoefficient() / fillCoefficientTotal; + local width = fillRatio * fillWidthTotal; + column:SetCalculatedWidth(width); + else + local width = column:GetFixedWidth(); + column:SetCalculatedWidth(width); + end + end +end + +function TableBuilderMixin:ArrangeHorizontally(frame, relativeTo, width, pointTop, pointRelativeTop, pointBottom, pointRelativeBottom, xOffset) + frame:SetPoint(pointTop, relativeTo, pointRelativeTop, xOffset, 0); + frame:SetPoint(pointBottom, relativeTo, pointRelativeBottom, xOffset, 0); + frame:SetWidth(width); +end + +function TableBuilderMixin:ArrangeHeaders() + local headerOverlap = self:GetColumnHeaderOverlap(); + local leftMargin, rightMargin = self:GetTableMargins(); + local columns = self:GetColumns(); + + -- Any trailing columns without headers should add to the width of the last column with a header. + local numColumns = #columns; + local lastActiveHeaderIndex = numColumns; + local trailingWidth = 0; + for i, column in ipairs(columns) do + if column:GetHeaderFrame() then + trailingWidth = 0; + lastActiveHeaderIndex = i; + else + trailingWidth = trailingWidth + column:GetFullWidth(); + end + end + + local previousHeader = nil; + local accumulatedWidth = 0; + local columnIndex = 1; + + while columnIndex <= numColumns do + local column = columns[columnIndex]; + accumulatedWidth = accumulatedWidth + column:GetCalculatedWidth(); + + local isLastIndex = columnIndex == lastActiveHeaderIndex; + local header = column:GetHeaderFrame(); + if header then + if isLastIndex then + accumulatedWidth = accumulatedWidth + trailingWidth; + else + for j = columnIndex + 1, #columns do + local nextColumn = columns[j]; + if nextColumn:GetDisplayUnderPreviousHeader() then + columnIndex = columnIndex + 1; + accumulatedWidth = accumulatedWidth + nextColumn:GetFullWidth(); + else + break; + end + end + end + + if previousHeader == nil then + self:ArrangeHorizontally(header, header:GetParent(), accumulatedWidth, "TOPLEFT", "TOPLEFT", "BOTTOMLEFT", "BOTTOMLEFT", leftMargin); + else + self:ArrangeHorizontally(header, previousHeader, accumulatedWidth + headerOverlap, "TOPLEFT", "TOPRIGHT", "BOTTOMLEFT", "BOTTOMRIGHT", column:GetPadding() - headerOverlap); + end + + accumulatedWidth = 0; + previousHeader = header; + end + + if isLastIndex then + break; + end + + columnIndex = columnIndex + 1; + end +end + +-- ... are additional mixins +function CreateTableBuilder(rows, ...) + local tableBuilder = CreateAndInitFromMixin(TableBuilderMixin, rows); + Mixin(tableBuilder, ...); + return tableBuilder; +end \ No newline at end of file diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.lua.annotated.lua b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.lua.annotated.lua new file mode 100644 index 0000000..11d7bb9 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.lua.annotated.lua @@ -0,0 +1,263 @@ + +TemplatedListElementMixin = {};--- @class TemplatedListElementMixin + +function TemplatedListElementMixin:InitElement(...) + -- Override in your mixin. +end + +function TemplatedListElementMixin:UpdateDisplay() + -- Override in your mixin. + assert("Your templated list element must define a display method"); +end + +function TemplatedListElementMixin:OnSelected() + -- Override in your mixin. +end + +function TemplatedListElementMixin:OnEnter() + -- Override in your mixin. +end + +function TemplatedListElementMixin:OnLeave() + -- Override in your mixin. +end + +function TemplatedListElementMixin:Populate(listIndex) + self.listIndex = listIndex; + self:UpdateDisplay(); +end + +function TemplatedListElementMixin:OnClick() + self:GetList():SetSelectedListIndex(self.listIndex); + self:OnSelected(); +end + +function TemplatedListElementMixin:IsSelected() + return self:GetListIndex() == self:GetList():GetSelectedListIndex(); +end + +function TemplatedListElementMixin:GetListIndex() + return self.listIndex; +end + +function TemplatedListElementMixin:GetList() + return self:GetParent(); +end + + +TemplatedListMixin = {};--- @class TemplatedListMixin + +function TemplatedListMixin:SetElementTemplate(elementTemplate, ...) + if self.elementTemplate ~= nil then + assert("You cannot change the element template once it is set, as the necessary frames may have already been created from the old template."); + return; + end + + self.elementTemplate = elementTemplate; + self.elementTemplateInitArgs = SafePack(...); +end + +function TemplatedListMixin:SetGetNumResultsFunction(getNumResultsFunction) + self.getNumResultsFunction = getNumResultsFunction; + self:ResetList(); +end + +function TemplatedListMixin:SetSelectionCallback(selectionCallback) + self.selectionCallback = selectionCallback; +end + +function TemplatedListMixin:SetRefreshCallback(refreshCallback) + self.refreshCallback = refreshCallback; +end + +function TemplatedListMixin:GetSelectedHighlight() + return self.ArtOverlay.SelectedHighlight; +end + +function TemplatedListMixin:OnShow() + self:CheckListInitialization(); + self:RefreshListDisplay(); +end + +function TemplatedListMixin:IsInitialized() + return self.isInitialized; +end + +function TemplatedListMixin:CheckListInitialization() + if self.isInitialized or (self:GetElementTemplate() == nil) or not self:CanInitialize() then + return; + end + + self:InitializeList(); + self:InitializeElements(); + + self.isInitialized = true; +end + +function TemplatedListMixin:GetElementTemplate() + return self.elementTemplate; +end + +function TemplatedListMixin:GetElementInitializationArgs() + return SafeUnpack(self.elementTemplateInitArgs); +end + +function TemplatedListMixin:InitializeElements() + -- We use a local sub-function to capture the variadic parameters and avoid unpacking multiple times. + local function InitializeAllElementFrames(...) + for i = 1, self:GetNumElementFrames() do + self:GetElementFrame(i):InitElement(...); + end + end + + InitializeAllElementFrames(self:GetElementInitializationArgs()); +end + +function TemplatedListMixin:UpdatedSelectedHighlight() + local selectedHighlight = self:GetSelectedHighlight(); + selectedHighlight:ClearAllPoints(); + selectedHighlight:Hide(); + + local selectedListIndex = self:GetSelectedListIndex(); + if self.isInitialized and selectedListIndex ~= nil then + local elementOffset = selectedListIndex - self:GetListOffset(); + if elementOffset >= 1 and elementOffset <= self:GetNumElementFrames() then + local elementFrame = self:GetElementFrame(elementOffset); + self:AttachHighlightToElementFrame(selectedHighlight, elementFrame); + end + end +end + +function TemplatedListMixin:AttachHighlightToElementFrame(selectedHighlight, elementFrame) + selectedHighlight:SetPoint("CENTER", elementFrame, "CENTER", 0, 0); + selectedHighlight:Show(); +end + +function TemplatedListMixin:SetSelectedListIndex(listIndex, skipUpdates) + local sameIndex = selectedListIndex == listIndex; + self.selectedListIndex = listIndex; + + if not skipUpdates then + if self.selectionCallback then + self.selectionCallback(listIndex); + end + end + + if sameIndex or skipUpdates then + return; + end + + self:RefreshListDisplay(); +end + +function TemplatedListMixin:GetSelectedListIndex() + return self.selectedListIndex; +end + +function TemplatedListMixin:ResetList() + if self.isInitialized then + self:ResetDisplay(); + end +end + +function TemplatedListMixin:CanDisplay() + if self.elementTemplate == nil then + return false, "Templated list elementTemplate not set. Use TemplatedListMixin:SetElementTemplate."; + end + + if self.getNumResultsFunction == nil then + return false, "Templated list getNumResultsFunction not set. Use TemplatedListMixin:SetGetNumResultsFunction."; + end + + if not self.isInitialized then + return false, "Templated list has not been initialized. This should generally happen in OnShow."; + end + + return true, nil; +end + +function TemplatedListMixin:RefreshListDisplay() + if not self:IsVisible() then + return; + end + + local canDisplay, displayError = self:CanDisplay(); + if not canDisplay then + error(displayError); + return; + end + + local numResults = self.getNumResultsFunction(); + local lastDisplayedOffset = self:DisplayList(numResults); + + self:UpdatedSelectedHighlight(); + + if self.refreshCallback ~= nil then + self.refreshCallback(lastDisplayedOffset); + end +end + +function TemplatedListMixin:DisplayList(numResults) + local listOffset = self:GetListOffset(); + local numElementFrames = self:GetNumElementFrames(); + local lastDisplayedOffset = 0; + + for i = 1, numElementFrames do + local listIndex = listOffset + i; + local elementFrame = self:GetElementFrame(i); + + if listIndex <= numResults then + elementFrame:Populate(listIndex); + elementFrame:Show(); + lastDisplayedOffset = i; + else + elementFrame:Hide(); + end + end + + return lastDisplayedOffset; +end + +function TemplatedListMixin:EnumerateElementFrames() + local numElementFrames = self:GetNumElementFrames(); + local elementFrameIndex = 0; + local function ElementFrameIterator() + elementFrameIndex = elementFrameIndex + 1; + + if elementFrameIndex > numElementFrames then + return nil; + end + + return self:GetElementFrame(elementFrameIndex); + end + + return ElementFrameIterator; +end + +function TemplatedListMixin:CanInitialize() + return true; -- May be implemented by derived mixins. +end + +function TemplatedListMixin:InitializeList() + -- Implemented by derived mixins. + error("This must be implemented for a templated list to function."); +end + +function TemplatedListMixin:GetNumElementFrames() + -- Implemented by derived mixins. + error("This must be implemented for a templated list to function."); +end + +function TemplatedListMixin:GetElementFrame(frameIndex) + -- Implemented by derived mixins. + error("This must be implemented for a templated list to function."); +end + +function TemplatedListMixin:GetListOffset() + -- Implemented by derived mixins. + error("This must be implemented for a templated list to function."); +end + +function TemplatedListMixin:ResetDisplay() + -- Implemented by derived mixins. +end diff --git a/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.xml b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.xml new file mode 100644 index 0000000..ab33d42 --- /dev/null +++ b/docs/annotations/Annotations/FrameXML/Annotations/AddOns/Blizzard_SharedXML/TemplatedList.xml @@ -0,0 +1,31 @@ + +